commit efb1d75ca7f27b0c6f7e86461ae3531a36788251 Author: Brian Long Date: Mon Apr 5 17:16:01 2021 -0400 initial checkin diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..620a11b --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Maven +target +pom.xml.versionsBackup + +# Eclipse +.settings +.project +.classpath + diff --git a/COPYING.LESSER.md b/COPYING.LESSER.md new file mode 100644 index 0000000..0927556 --- /dev/null +++ b/COPYING.LESSER.md @@ -0,0 +1,157 @@ +### GNU LESSER GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +This version of the GNU Lesser General Public License incorporates the +terms and conditions of version 3 of the GNU General Public License, +supplemented by the additional permissions listed below. + +#### 0. Additional Definitions. + +As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the +GNU General Public License. + +"The Library" refers to a covered work governed by this License, other +than an Application or a Combined Work as defined below. + +An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + +A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + +The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + +The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + +#### 1. Exception to Section 3 of the GNU GPL. + +You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + +#### 2. Conveying Modified Versions. + +If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + +- a) under this License, provided that you make a good faith effort + to ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or +- b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + +#### 3. Object Code Incorporating Material from Library Header Files. + +The object code form of an Application may incorporate material from a +header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + +- a) Give prominent notice with each copy of the object code that + the Library is used in it and that the Library and its use are + covered by this License. +- b) Accompany the object code with a copy of the GNU GPL and this + license document. + +#### 4. Combined Works. + +You may convey a Combined Work under terms of your choice that, taken +together, effectively do not restrict modification of the portions of +the Library contained in the Combined Work and reverse engineering for +debugging such modifications, if you also do each of the following: + +- a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. +- b) Accompany the Combined Work with a copy of the GNU GPL and this + license document. +- c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. +- d) Do one of the following: + - 0) Convey the Minimal Corresponding Source under the terms of + this License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + - 1) Use a suitable shared library mechanism for linking with + the Library. A suitable mechanism is one that (a) uses at run + time a copy of the Library already present on the user's + computer system, and (b) will operate properly with a modified + version of the Library that is interface-compatible with the + Linked Version. +- e) Provide Installation Information, but only if you would + otherwise be required to provide such information under section 6 + of the GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the Application + with a modified version of the Linked Version. (If you use option + 4d0, the Installation Information must accompany the Minimal + Corresponding Source and Corresponding Application Code. If you + use option 4d1, you must provide the Installation Information in + the manner specified by section 6 of the GNU GPL for conveying + Corresponding Source.) + +#### 5. Combined Libraries. + +You may place library facilities that are a work based on the Library +side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + +- a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities, conveyed under the terms of this License. +- b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + +#### 6. Revised Versions of the GNU Lesser General Public License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +as you received it specifies that a certain numbered version of the +GNU Lesser General Public License "or any later version" applies to +it, you have the option of following the terms and conditions either +of that published version or of any later version published by the +Free Software Foundation. If the Library as you received it does not +specify a version number of the GNU Lesser General Public License, you +may choose any version of the GNU Lesser General Public License ever +published by the Free Software Foundation. + +If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/COPYING.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..a8144ce --- /dev/null +++ b/pom.xml @@ -0,0 +1,202 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin + 1.0-SNAPSHOT + maven-plugin + + A Maven plugin for regex operations + + + https://bitbucket.org/inteligr8/regex-maven-plugin + + + Inteligr8 + https://www.inteligr8.com + + + + brian.long + Brian Long + brian@inteligr8.com + https://twitter.com/brianmlong + + + + + UTF-8 + 1.8 + 1.8 + 3.6.3 + + + + + org.apache.commons + commons-lang3 + 3.4 + + + org.apache.maven.shared + file-management + 3.0.0 + + + org.apache.maven + maven-plugin-api + ${maven.version} + provided + + + org.apache.maven.plugin-tools + maven-plugin-annotations + 3.6.0 + provided + + + org.apache.maven + maven-core + ${maven.version} + provided + + + org.apache.maven.plugin-testing + maven-plugin-testing-harness + 3.3.0 + test + + + org.apache.maven + maven-compat + ${maven.version} + test + + + junit + junit + 4.12 + test + + + + + + + maven-plugin-plugin + 3.6.0 + + regex + + + + default-descriptor + + descriptor + + + + help-descriptor + + helpmojo + + + + + + org.codehaus.plexus + plexus-component-metadata + 2.0.0 + + + + generate-metadata + + + + + + maven-invoker-plugin + 3.2.2 + + ${basedir}/src/it + ${project.build.directory}/it + ${project.build.directory}/it-repo + ${env.MAVEN_HOME} + true + + ${basedir} + + + + + run-its + + install + run + + + + + + maven-javadoc-plugin + + + javadoc + package + jar + + public + + + + + + + + + + run-it-1 + + + run-it + + + + + + maven-invoker-plugin + 3.2.2 + + + run-its + + install + run + + + + ${run-it}/pom.xml + + + + + + + + + + + + + inteligr8-releases + Inteligr8 Releases + http://repos.inteligr8.com/nexus/repository/inteligr8-public + + + + diff --git a/src/it/copy-file/file1.txt b/src/it/copy-file/file1.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/copy-file/file1.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/copy-file/folder1/file11.txt b/src/it/copy-file/folder1/file11.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/copy-file/folder1/file11.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/copy-file/pom.xml b/src/it/copy-file/pom.xml new file mode 100644 index 0000000..ad7a099 --- /dev/null +++ b/src/it/copy-file/pom.xml @@ -0,0 +1,62 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-copy-file + @pom.version@ + pom + + Copy File Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + copy-all + validate + + copy-file + + + + + (.*)file1.txt + $1file2.txt + + + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + file1.txt + file2.txt + + + + + + + + + + + diff --git a/src/it/match-file-content/file1.txt b/src/it/match-file-content/file1.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/match-file-content/file1.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/match-file-content/folder1/file11.txt b/src/it/match-file-content/folder1/file11.txt new file mode 100644 index 0000000..2a67f8c --- /dev/null +++ b/src/it/match-file-content/folder1/file11.txt @@ -0,0 +1 @@ +another test file \ No newline at end of file diff --git a/src/it/match-file-content/folder1/file12.txt b/src/it/match-file-content/folder1/file12.txt new file mode 100644 index 0000000..ffe73c8 --- /dev/null +++ b/src/it/match-file-content/folder1/file12.txt @@ -0,0 +1,6 @@ + +this is a multi line test file. + +it is supposed to emulate larger files and multiline pattern matching. + +good luck! \ No newline at end of file diff --git a/src/it/match-file-content/pom.xml b/src/it/match-file-content/pom.xml new file mode 100644 index 0000000..ed3f9b7 --- /dev/null +++ b/src/it/match-file-content/pom.xml @@ -0,0 +1,131 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-match-file + @pom.version@ + pom + + Move File Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + + ${basedir} + + **/* + + + pom.xml + *.log + + + + + + + match-one + validate + + match-file + + + + + + file1.txt + + + + + test + + match.1 + + + + nomatch-one + validate + + match-file + + + + blah + + nomatch.1 + + + + match-multiline + validate + + match-file + + + true + + file\.\n\nit is + + match.multi + + + + nomatch-multiline + validate + + match-file + + + + file\.\n\nit is + + nomatch.multi + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + match.1 + true + + + nomatch.1 + false + + + match.multi + true + + + nomatch.multi + false + + + + + + + + + + diff --git a/src/it/match-filename/pom.xml b/src/it/match-filename/pom.xml new file mode 100644 index 0000000..51dfe10 --- /dev/null +++ b/src/it/match-filename/pom.xml @@ -0,0 +1,94 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-match-filename + @pom.version@ + pom + + Match Filename Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + match-all + validate + + match-filename + + + + .+ + + prop.1-regex + + + + match-part + validate + + match-filename + + + + pom.xml + + ${project.main.basedir} + prop.2-regex + + + + match-most + validate + + match-filename + + + + .*\.java + + ${project.main.basedir} + prop.3-regex + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1-regex + true + + + prop.2-regex + true + + + prop.3-regex + true + + + + + + + + + + diff --git a/src/it/match-properties/pom.xml b/src/it/match-properties/pom.xml new file mode 100644 index 0000000..04260db --- /dev/null +++ b/src/it/match-properties/pom.xml @@ -0,0 +1,122 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-match-properties + @pom.version@ + pom + + Match Properties Plugin Tests + + + property #1 + property #2 + property #3 + + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + match-all + validate + + match-properties + + + + .+ + + + prop.1 + + + + + match-part + validate + + match-properties + + + + #2 + + + prop.2 + prop.3 + + + + + match-most + validate + + match-properties + + + -regex2 + + (property|attribute) + + + prop.1 + + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1 + property #1 + + + prop.2 + property #2 + + + prop.3 + property #3 + + + prop.1-regex + true + + + prop.2-regex + true + + + prop.3-regex + false + + + prop.1-regex2 + true + + + + + + + + + + diff --git a/src/it/match-property/pom.xml b/src/it/match-property/pom.xml new file mode 100644 index 0000000..5f4da36 --- /dev/null +++ b/src/it/match-property/pom.xml @@ -0,0 +1,113 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-match-property + @pom.version@ + pom + + Match Property Plugin Tests + + + property #1 + property #2 + property #3 + + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + match-all + validate + + match-property + + + + .+ + + prop.1 + prop.1-regex + + + + match-part + validate + + match-property + + + + #3 + + prop.2 + prop.2-regex + + + + match-most + validate + + match-property + + + + (property|attribute) + + prop.3 + prop.3-regex + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1 + property #1 + + + prop.2 + property #2 + + + prop.3 + property #3 + + + prop.1-regex + true + + + prop.2-regex + false + + + prop.3-regex + true + + + + + + + + + + diff --git a/src/it/match-text/pom.xml b/src/it/match-text/pom.xml new file mode 100644 index 0000000..4232291 --- /dev/null +++ b/src/it/match-text/pom.xml @@ -0,0 +1,95 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-match-text + @pom.version@ + pom + + Match Text Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + match-all + validate + + match-text + + + prop.1-regex + + .+ + + general text #1 + + + + match-part + validate + + match-text + + + prop.2-regex + + nothere + + general text #2 + + + + match-most + validate + + match-text + + + prop.3-regex + + (property|attribute|text) + + general text #3 + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1-regex + true + + + prop.2-regex + false + + + prop.3-regex + true + + + + + + + + + + diff --git a/src/it/move-file/file1.txt b/src/it/move-file/file1.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/move-file/file1.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/move-file/folder1/file11.txt b/src/it/move-file/folder1/file11.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/move-file/folder1/file11.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/move-file/pom.xml b/src/it/move-file/pom.xml new file mode 100644 index 0000000..bdaf7c2 --- /dev/null +++ b/src/it/move-file/pom.xml @@ -0,0 +1,66 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-move-file + @pom.version@ + pom + + Move File Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + move-all + validate + + move-file + + + + + (.*)file1.txt + $1file2.txt + + + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + file2.txt + + + + + file1.txt + + + + + + + + + + + diff --git a/src/it/replace-file-content/file1.txt b/src/it/replace-file-content/file1.txt new file mode 100644 index 0000000..30d74d2 --- /dev/null +++ b/src/it/replace-file-content/file1.txt @@ -0,0 +1 @@ +test \ No newline at end of file diff --git a/src/it/replace-file-content/folder1/file11.txt b/src/it/replace-file-content/folder1/file11.txt new file mode 100644 index 0000000..2a67f8c --- /dev/null +++ b/src/it/replace-file-content/folder1/file11.txt @@ -0,0 +1 @@ +another test file \ No newline at end of file diff --git a/src/it/replace-file-content/folder1/file12.txt b/src/it/replace-file-content/folder1/file12.txt new file mode 100644 index 0000000..ffe73c8 --- /dev/null +++ b/src/it/replace-file-content/folder1/file12.txt @@ -0,0 +1,6 @@ + +this is a multi line test file. + +it is supposed to emulate larger files and multiline pattern matching. + +good luck! \ No newline at end of file diff --git a/src/it/replace-file-content/pom.xml b/src/it/replace-file-content/pom.xml new file mode 100644 index 0000000..24676ec --- /dev/null +++ b/src/it/replace-file-content/pom.xml @@ -0,0 +1,111 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-replace-file + @pom.version@ + pom + + Replace File Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + replace-one + validate + + replace-file + + + + + ${basedir} + + file1.txt + + + target + + ${project.build.directory}/replace-one + + + + + test + blah + + + + + + noreplace-one + validate + + replace-file + + + + + ${basedir} + + **/* + + + pom.xml + *.log + target + + ${project.build.directory}/noreplace-one + + + + + test + blah + + + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + ${project.build.directory}/replace-one/file1.txt + ${project.build.directory}/noreplace-one/file1.txt + ${project.build.directory}/noreplace-one/folder1/file11.txt + ${project.build.directory}/noreplace-one/folder1/file12.txt + + + + + ${project.build.directory}/replace-one/folder1/file11.txt + ${project.build.directory}/replace-one/folder1/file12.txt + + + + + + + + + + + diff --git a/src/it/replace-properties/pom.xml b/src/it/replace-properties/pom.xml new file mode 100644 index 0000000..0e749e7 --- /dev/null +++ b/src/it/replace-properties/pom.xml @@ -0,0 +1,131 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-replace-properties + @pom.version@ + pom + + Replace Properties Plugin Tests + + + property #1 + property #2 + property #3 + + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + replace-all + validate + + replace-properties + + + + + .+ + replaced + + + + prop.1 + + + + + replace-part + validate + + replace-properties + + + + + prop + replaced + + + + prop.2 + prop.3 + + + + + replace-most + validate + + replace-properties + + + -regex2 + + + (property|attribute) + attribute + + + + prop.1 + + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1 + property #1 + + + prop.2 + property #2 + + + prop.3 + property #3 + + + prop.1-regex + replaced + + + prop.2-regex + replacederty #2 + + + prop.3-regex + replacederty #3 + + + prop.1-regex2 + attribute #1 + + + + + + + + + + diff --git a/src/it/replace-property/pom.xml b/src/it/replace-property/pom.xml new file mode 100644 index 0000000..b179130 --- /dev/null +++ b/src/it/replace-property/pom.xml @@ -0,0 +1,120 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-replace-property + @pom.version@ + pom + + Replace Property Plugin Tests + + + property #1 + property #2 + property #3 + + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + replace-all + validate + + replace-property + + + + + .+ + replaced + + + prop.1 + + + + replace-part + validate + + replace-property + + + + + prop + replaced + + + prop.2 + + + + replace-most + validate + + replace-property + + + prop.3-regex2 + + + (property|attribute) + attribute + + + prop.3 + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1 + property #1 + + + prop.2 + property #2 + + + prop.3 + property #3 + + + prop.1-regex + replaced + + + prop.2-regex + replacederty #2 + + + prop.3-regex2 + attribute #3 + + + + + + + + + + diff --git a/src/it/replace-text/pom.xml b/src/it/replace-text/pom.xml new file mode 100644 index 0000000..677e52c --- /dev/null +++ b/src/it/replace-text/pom.xml @@ -0,0 +1,104 @@ + + + + 4.0.0 + + com.inteligr8 + regex-maven-plugin-replace-text + @pom.version@ + pom + + Replace Text Plugin Tests + + + + + ${project.groupId} + regex-maven-plugin + @pom.version@ + + + replace-all + validate + + replace-text + + + prop.1 + + + .+ + replaced + + + property #1 + + + + replace-part + validate + + replace-text + + + prop.2-regex + + + prop + replaced + + + property #2 + + + + replace-most + validate + + replace-text + + + prop.3-regex2 + + + (property|attribute) + attribute + + + property #3 + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + prop.1 + replaced + + + prop.2-regex + replacederty #2 + + + prop.3-regex2 + attribute #3 + + + + + + + + + + diff --git a/src/main/java/com/inteligr8/maven/ProjectPropertyResolver.java b/src/main/java/com/inteligr8/maven/ProjectPropertyResolver.java new file mode 100644 index 0000000..36e9c76 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/ProjectPropertyResolver.java @@ -0,0 +1,27 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven; + +import java.util.Properties; + +public interface ProjectPropertyResolver { + + Properties resolveScope(String propertyName); + + String resolve(String propertyName); + + String resolve(String propertyName, String defaultValue); + +} diff --git a/src/main/java/com/inteligr8/maven/StandardProjectPropertyResolver.java b/src/main/java/com/inteligr8/maven/StandardProjectPropertyResolver.java new file mode 100644 index 0000000..8e95447 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/StandardProjectPropertyResolver.java @@ -0,0 +1,86 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven; + +import java.util.Properties; + +import org.apache.maven.execution.MavenSession; +import org.apache.maven.model.Profile; +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; + +@Component(role = ProjectPropertyResolver.class) +public class StandardProjectPropertyResolver implements ProjectPropertyResolver { + + @Requirement + private MavenSession session; + + @Requirement + private MavenProject project; + + @Override + public String resolve(String propertyName) { + Properties props = this.findPropertiesObject(propertyName); + return props == null ? null : props.getProperty(propertyName); + } + + @Override + public String resolve(String propertyName, String defaultValue) { + Properties props = this.findPropertiesObject(propertyName); + return props == null ? null : props.getProperty(propertyName, defaultValue); + } + + @Override + public Properties resolveScope(String propertyName) { + return this.findPropertiesObject(propertyName); + } + + private Properties findPropertiesObject(String key) { + // search the user/cli properties first + Properties props = this.session.getUserProperties(); + if (props.containsKey(key)) + return props; + + // search the profiles next; in order (FIXME maybe we should go backwards?) + for (Profile profile : this.project.getActiveProfiles()) { + props = profile.getProperties(); + if (props.containsKey(key)) + return props; + } + + // now look at the project props + props = this.project.getProperties(); + if (props.containsKey(key)) + return props; + + // now recursively look up the parent project props + MavenProject ancestor = this.project.getParent(); + while (ancestor != null) { + props = ancestor.getProperties(); + if (props.containsKey(key)) + return props; + ancestor = ancestor.getParent(); + } + + // search the system properties last (FIXME is this right?) + props = this.session.getSystemProperties(); + if (props.containsKey(key)) + return props; + + return null; + } + +} diff --git a/src/main/java/com/inteligr8/maven/model/Normalizable.java b/src/main/java/com/inteligr8/maven/model/Normalizable.java new file mode 100644 index 0000000..22a7282 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/model/Normalizable.java @@ -0,0 +1,21 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.model; + +public interface Normalizable { + + void normalize(); + +} diff --git a/src/main/java/com/inteligr8/maven/model/Regex.java b/src/main/java/com/inteligr8/maven/model/Regex.java new file mode 100644 index 0000000..4356da2 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/model/Regex.java @@ -0,0 +1,48 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.model; + +import org.apache.commons.lang3.StringUtils; + +public class Regex implements Normalizable { + + private String pattern; + private String replacement; + + public String getPattern() { + return this.pattern; + } + + public String getReplacement() { + return this.replacement; + } + + public Regex setPattern(String pattern) { + this.pattern = pattern; + return this; + } + + public Regex setReplacement(String replacement) { + this.replacement = replacement; + return this; + } + + @Override + public void normalize() { + this.pattern = StringUtils.trimToNull(this.pattern); + this.replacement = StringUtils.trimToNull(this.replacement); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/AbstractFileMojo.java b/src/main/java/com/inteligr8/maven/regex/AbstractFileMojo.java new file mode 100644 index 0000000..ad2e90e --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/AbstractFileMojo.java @@ -0,0 +1,102 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.File; +import java.io.IOException; +import java.nio.file.FileVisitResult; +import java.nio.file.FileVisitor; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.attribute.BasicFileAttributes; + +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Parameter; + +public abstract class AbstractFileMojo extends AbstractReplaceMojo { + + @Parameter( property = "sourceDirectory", required = false ) + protected File sourceDirectory; + + @Parameter( property = "targetDirectory", required = false ) + protected File targetDirectory; + + @Parameter( property = "overwrite", required = true, defaultValue = "true" ) + protected boolean overwrite = true; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing file regex"); + + final Path sourcePath = this.sourceDirectory.toPath(); + final Path targetPath = this.targetDirectory.toPath(); + try { + Files.walkFileTree(sourcePath, new FileVisitor() { + + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { + if (exc != null) + throw exc; + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + if (!Files.isDirectory(file)) { + String relativePath = sourcePath.relativize(file).toString(); + String replacedRelativePath = replaceFirst(relativePath); + if (!relativePath.equals(replacedRelativePath)) { + Path newFile = targetPath.resolve(replacedRelativePath); + if (file.equals(newFile)) { + AbstractFileMojo.this.getLog().error("Relative paths are different, but the resultant paths are the same??"); + throw new RuntimeException("This should never happen"); + } + + AbstractFileMojo.this.executeOnFile(file, newFile); + } + } + + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException { + throw exc; + } + }); + } catch (IOException ie) { + throw new MojoExecutionException(ie.getMessage(), ie); + } + } + + protected abstract void executeOnFile(Path sourcePath, Path targetPath) throws IOException; + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + if (this.sourceDirectory == null) + this.sourceDirectory = this.project.getBasedir(); + if (this.targetDirectory == null) + this.targetDirectory = this.project.getBasedir(); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/AbstractMatchMojo.java b/src/main/java/com/inteligr8/maven/regex/AbstractMatchMojo.java new file mode 100644 index 0000000..2749459 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/AbstractMatchMojo.java @@ -0,0 +1,147 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.util.LinkedList; +import java.util.List; +import java.util.ListIterator; +import java.util.Properties; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; + +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Parameter; + +import com.inteligr8.nio.DelimitedReadableByteChannel; + +public abstract class AbstractMatchMojo extends AbstractRegexMojo { + + @Parameter( property = "allowPartialMatch", required = true, defaultValue = "true" ) + protected boolean allowPartialMatch = true; + + @Parameter( property = "patterns", required = true ) + protected List patterns; + + private List compiledPatterns; + + @Override + protected void executeOnText(Properties props, String text, String newPropertyName) { + boolean matches = this.matches(text); + if (matches) + this.getLog().debug("Matches!"); + props.setProperty(newPropertyName, String.valueOf(matches)); + } + + protected boolean matches(Path file, int chunkSize) throws IOException { + Charset charset = Charset.forName(this.charsetName); + StringBuilder strbuilder = new StringBuilder(); + + FileChannel sourceChannel = FileChannel.open(file, StandardOpenOption.READ); + try { + DelimitedReadableByteChannel rbchannel = new DelimitedReadableByteChannel(chunkSize, sourceChannel, charset, "\r\n", "\n"); + try { + while (rbchannel.read(strbuilder) >= 0) { + if (this.allowMultiLineMatch) { + // we have to load the whole file into memory + // this is the problem with the multiline match option + if (rbchannel.getLastDelimiterRead() != null) + strbuilder.append(rbchannel.getLastDelimiterRead()); + } else { + String line = strbuilder.toString(); + if (this.matches(line)) + return true; + } + } + } finally { + rbchannel.close(); + } + } finally { + sourceChannel.close(); + } + + if (this.allowMultiLineMatch) + return this.matches(strbuilder.toString()); + return false; + } + + protected boolean matches(String text) { + for (Pattern pattern : this.compiledPatterns) { + this.getLog().debug("Applying regex pattern: " + pattern); + + if (text == null) { + // TODO we want to capture this somehow + } else { + this.getLog().debug("Operating on value: " + text); + + Matcher matcher = pattern.matcher(text); + if (this.allowPartialMatch) { + if (matcher.find()) + return true; + } else { + if (matcher.matches()) + return true; + } + } + } + + return false; + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.patterns == null) + throw new MojoFailureException("A 'patterns' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + ListIterator p = this.patterns.listIterator(); + while (p.hasNext()) { + String pattern = p.next(); + if (pattern == null) { + p.remove(); + } + } + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.patterns.isEmpty()) + throw new MojoFailureException("At least one 'patterns' element is required"); + + this.compiledPatterns = new LinkedList<>(); + for (String pattern : this.patterns) { + this.getLog().debug("Compiling regex pattern: " + pattern); + try { + this.compiledPatterns.add(Pattern.compile(pattern)); + } catch (PatternSyntaxException pse) { + throw new MojoFailureException("'" + pattern + "' is not a valid regular expression: " + pse.getMessage()); + } + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/AbstractRegexMojo.java b/src/main/java/com/inteligr8/maven/regex/AbstractRegexMojo.java new file mode 100644 index 0000000..302d583 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/AbstractRegexMojo.java @@ -0,0 +1,96 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.util.Properties; + +import javax.annotation.OverridingMethodsMustInvokeSuper; + +import org.apache.maven.execution.MavenSession; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Requirement; + +import com.inteligr8.maven.ProjectPropertyResolver; + +public abstract class AbstractRegexMojo extends AbstractMojo { + + @Parameter( defaultValue = "${project}", readonly = true ) + protected MavenProject project; + + @Parameter( defaultValue = "${session}", readonly = true ) + protected MavenSession session; + + @Requirement + private ProjectPropertyResolver propResolver; + + @Parameter( property = "allowMultiLineMatch", required = true, defaultValue = "false" ) + protected boolean allowMultiLineMatch = false; + + @Parameter( property = "charset", required = true, defaultValue = "utf-8" ) + protected String charsetName = "utf-8"; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + public final void execute() throws MojoExecutionException, MojoFailureException { + if (this.skip) { + this.getLog().debug("Skipped execution"); + return; + } + + this.validateParamsPreNormalization(); + this.normalizeParameters(); + this.validateParamsPostNormalization(); + + this.go(); + } + + protected abstract void go() throws MojoExecutionException, MojoFailureException; + + @OverridingMethodsMustInvokeSuper + protected void validateParamsPreNormalization() throws MojoFailureException { + this.getLog().debug("Validating parameters before their normalization"); + } + + @OverridingMethodsMustInvokeSuper + protected void normalizeParameters() throws MojoFailureException { + this.getLog().debug("Normalizing parameters"); + } + + @OverridingMethodsMustInvokeSuper + protected void validateParamsPostNormalization() throws MojoFailureException { + this.getLog().debug("Validating parameters after their normalization"); + } + + protected final void executeOnProperty(String propertyName, String newPropertyName) { + this.getLog().debug("Finding property: " + propertyName); + + Properties props = this.propResolver.resolveScope(propertyName); + if (props == null) { + this.getLog().info("Property not found: " + propertyName); + return; + } + + String propertyValue = props.getProperty(propertyName); + this.executeOnText(props, propertyValue, newPropertyName); + } + + protected abstract void executeOnText(Properties props, String text, String newPropertyName); + +} diff --git a/src/main/java/com/inteligr8/maven/regex/AbstractReplaceMojo.java b/src/main/java/com/inteligr8/maven/regex/AbstractReplaceMojo.java new file mode 100644 index 0000000..3f0fd2f --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/AbstractReplaceMojo.java @@ -0,0 +1,244 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.util.LinkedList; +import java.util.List; +import java.util.ListIterator; +import java.util.Properties; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; + +import org.apache.commons.lang3.tuple.ImmutablePair; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Parameter; + +import com.inteligr8.maven.model.Regex; +import com.inteligr8.nio.DelimitedReadableByteChannel; + +public abstract class AbstractReplaceMojo extends AbstractRegexMojo { + + @Parameter( property = "regexes", required = true ) + protected List regexes; + + // Pattern does not implement hashCode, so not using a Map + private List> compiledRegexes; + + @Override + protected void executeOnText(Properties props, String text, String newPropertyName) { + String originalText = text; + text = this.replaceAll(text); + + if (this.getLog().isDebugEnabled() && !text.equals(originalText)) + this.getLog().debug("Manipulated value: " + text); + props.setProperty(newPropertyName, text); + } + + protected boolean replaceFirst(Path file, Path tofile, int chunkSize) throws IOException { + if (this.getLog().isDebugEnabled()) + this.getLog().debug("replace first: " + file + " => " + tofile); + + boolean didReplace = false; + Charset charset = Charset.forName(this.charsetName); + StringBuilder strbuilder = new StringBuilder(); + + FileChannel targetChannel = FileChannel.open(tofile, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING); + try { + FileChannel sourceChannel = FileChannel.open(file, StandardOpenOption.READ); + try { + DelimitedReadableByteChannel rbchannel = new DelimitedReadableByteChannel(chunkSize, sourceChannel, charset, "\r\n", "\n"); + try { + while (rbchannel.read(strbuilder) >= 0) { + if (this.allowMultiLineMatch) { + // we have to load the whole file into memory + // this is the problem with the multiline match option + if (rbchannel.getLastDelimiterRead() != null) + strbuilder.append(rbchannel.getLastDelimiterRead()); + } else { + String line = strbuilder.toString(); + if (!didReplace) { + String processedLine = this.replaceFirst(line); + if (!line.equals(processedLine)) + didReplace = true; + line = processedLine; + } + + targetChannel.write(charset.encode(line)); + if (rbchannel.getLastDelimiterRead() != null) + targetChannel.write(charset.encode(rbchannel.getLastDelimiterRead())); + } + } + } finally { + rbchannel.close(); + } + } finally { + sourceChannel.close(); + } + + if (this.allowMultiLineMatch) { + String processedText = this.replaceFirst(strbuilder.toString()); + targetChannel.write(charset.encode(processedText)); + } + } finally { + targetChannel.close(); + } + + return didReplace; + } + + protected String replaceFirst(String text) { + if (this.getLog().isDebugEnabled()) + this.getLog().debug("replace first: " + text.length()); + + for (Pair regex : this.compiledRegexes) { + this.getLog().debug("Applying regex pattern: " + regex.getLeft()); + + if (text == null) { + // TODO we want to capture this somehow + } else { + this.getLog().debug("Operating on value: " + text); + + Matcher matcher = regex.getLeft().matcher(text); + text = matcher.replaceFirst(regex.getRight()); + } + } + + return text; + } + + protected boolean replaceAll(Path file, Path tofile, int chunkSize) throws IOException { + if (this.getLog().isDebugEnabled()) + this.getLog().debug("replace all: " + file + " => " + tofile); + + boolean didReplace = false; + Charset charset = Charset.forName(this.charsetName); + StringBuilder strbuilder = new StringBuilder(); + + FileChannel targetChannel = FileChannel.open(tofile, StandardOpenOption.WRITE, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING); + try { + FileChannel sourceChannel = FileChannel.open(file, StandardOpenOption.READ); + try { + DelimitedReadableByteChannel rbchannel = new DelimitedReadableByteChannel(chunkSize, sourceChannel, charset, "\r\n", "\n"); + try { + while (rbchannel.read(strbuilder) >= 0) { + if (this.allowMultiLineMatch) { + // we have to load the whole file into memory + // this is the problem with the multiline match option + if (rbchannel.getLastDelimiterRead() != null) + strbuilder.append(rbchannel.getLastDelimiterRead()); + } else { + String line = strbuilder.toString(); + this.getLog().debug("line: " + line); + String processedLine = this.replaceAll(line); + if (!didReplace || (this.getLog().isDebugEnabled() && !line.equals(processedLine))) { + this.getLog().debug("replaced line: " + processedLine); + didReplace = true; + } + + targetChannel.write(charset.encode(processedLine)); + if (rbchannel.getLastDelimiterRead() != null) + targetChannel.write(charset.encode(rbchannel.getLastDelimiterRead())); + + strbuilder = new StringBuilder(256); + } + } + } finally { + rbchannel.close(); + } + } finally { + sourceChannel.close(); + } + + if (this.allowMultiLineMatch) { + String processedText = this.replaceAll(strbuilder.toString()); + targetChannel.write(charset.encode(processedText)); + } + } finally { + targetChannel.close(); + } + + return didReplace; + } + + protected String replaceAll(String text) { + if (this.getLog().isDebugEnabled()) + this.getLog().debug("replace all: " + text.length()); + + for (Pair regex : this.compiledRegexes) { + this.getLog().debug("Applying regex pattern: " + regex.getLeft()); + + if (text == null) { + // TODO we want to capture this somehow + } else { + this.getLog().debug("Operating on value: " + text); + + Matcher matcher = regex.getLeft().matcher(text); + text = matcher.replaceAll(regex.getRight()); + } + } + + return text; + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.regexes == null) + throw new MojoFailureException("A 'regexes' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + ListIterator r = this.regexes.listIterator(); + while (r.hasNext()) { + Regex regex = r.next(); + if (regex == null) { + r.remove(); + } else { + regex.normalize(); + } + } + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.regexes.isEmpty()) + throw new MojoFailureException("At least one 'regexes' element is required"); + + this.compiledRegexes = new LinkedList<>(); + for (Regex regex : this.regexes) { + this.getLog().debug("Compiling regex pattern: " + regex.getPattern()); + try { + Pattern pattern = Pattern.compile(regex.getPattern()); + this.compiledRegexes.add(new ImmutablePair(pattern, regex.getReplacement())); + } catch (PatternSyntaxException pse) { + throw new MojoFailureException("'" + regex.getPattern() + "' is not a valid regular expression: " + pse.getMessage()); + } + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/CopyFileMojo.java b/src/main/java/com/inteligr8/maven/regex/CopyFileMojo.java new file mode 100644 index 0000000..438eaaf --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/CopyFileMojo.java @@ -0,0 +1,38 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; + +import org.apache.maven.plugins.annotations.Mojo; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "copy-file", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class CopyFileMojo extends AbstractFileMojo { + + @Override + protected void executeOnFile(Path sourcePath, Path targetPath) throws IOException { + if (CopyFileMojo.this.overwrite) { + Files.copy(sourcePath, targetPath, StandardCopyOption.REPLACE_EXISTING); + } else { + Files.copy(sourcePath, targetPath); + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MatchFileContentMojo.java b/src/main/java/com/inteligr8/maven/regex/MatchFileContentMojo.java new file mode 100644 index 0000000..8e7c0c4 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MatchFileContentMojo.java @@ -0,0 +1,92 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.shared.model.fileset.FileSet; +import org.apache.maven.shared.model.fileset.util.FileSetManager; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "match-file", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MatchFileContentMojo extends AbstractMatchMojo { + + @Parameter( property = "chunkSize", required = true, defaultValue = "1024" ) + protected int chunkSize = 1024; + + @Parameter( property = "filesets", required = true ) + protected List filesets; + + @Parameter( property = "newProperty", required = true ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing file regex match"); + + boolean matches = this.matchesContentInFileSet(); + if (matches) + this.getLog().info("Matches!"); + this.project.getProperties().setProperty(this.newProperty, String.valueOf(matches)); + } + + private boolean matchesContentInFileSet() throws MojoExecutionException { + FileSetManager fsman = new FileSetManager(this.getLog()); + Path basepath = this.project.getBasedir().toPath(); + + try { + for (FileSet fileSet : this.filesets) { + String[] filePathsAndNames = fsman.getIncludedFiles(fileSet); + for (String filePathAndName : filePathsAndNames) { + Path file = basepath.resolve(filePathAndName); + if (!Files.isDirectory(file)) + if (this.matches(file, this.chunkSize)) + return true; + } + } + } catch (IOException ie) { + throw new MojoExecutionException("Execution failed due to an I/O related issue", ie); + } + + return false; + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + this.newProperty = StringUtils.trimToNull(this.newProperty); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.filesets == null || this.filesets.isEmpty()) + throw new MojoFailureException("At least one 'fileset' is required"); + if (this.newProperty == null) + throw new MojoFailureException("The 'newProperty' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MatchFilenameMojo.java b/src/main/java/com/inteligr8/maven/regex/MatchFilenameMojo.java new file mode 100644 index 0000000..c201a0f --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MatchFilenameMojo.java @@ -0,0 +1,107 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.File; +import java.io.IOException; +import java.nio.file.FileVisitResult; +import java.nio.file.FileVisitor; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.attribute.BasicFileAttributes; + +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.mutable.MutableBoolean; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "match-filename", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MatchFilenameMojo extends AbstractMatchMojo { + + @Parameter( property = "sourceDirectory", required = false ) + protected File sourceDirectory; + + @Parameter( property = "newProperty", required = true ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing file regex match"); + + final MutableBoolean matches = new MutableBoolean(false); + final Path basepath = this.sourceDirectory.toPath(); + + try { + Files.walkFileTree(basepath, new FileVisitor() { + + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { + if (exc != null) + throw exc; + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + if (!Files.isDirectory(file)) { + getLog().debug("Visiting file: " + file); + + if (matches(basepath.relativize(file).toString())) + matches.setTrue(); + } + return matches.isTrue() ? FileVisitResult.TERMINATE : FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException { + throw exc; + } + }); + } catch (IOException ie) { + throw new MojoExecutionException(ie.getMessage(), ie); + } + + if (matches.booleanValue()) + this.getLog().info("Matches!"); + this.project.getProperties().setProperty(this.newProperty, matches.toString()); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + if (this.sourceDirectory == null) + this.sourceDirectory = this.project.getBasedir(); + this.newProperty = StringUtils.trimToNull(this.newProperty); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.newProperty == null) + throw new MojoFailureException("The 'newProperty' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MatchPropertiesMojo.java b/src/main/java/com/inteligr8/maven/regex/MatchPropertiesMojo.java new file mode 100644 index 0000000..5bf2ac5 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MatchPropertiesMojo.java @@ -0,0 +1,86 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.util.List; +import java.util.ListIterator; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "match-properties", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MatchPropertiesMojo extends AbstractMatchMojo { + + @Parameter( property = "properties", required = true ) + protected List properties; + + @Parameter( property = "newPropertySuffix", required = true, defaultValue = "-regex" ) + protected String propertySuffix; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing properties regex match"); + + for (String propertyName : this.properties) { + this.executeOnProperty(propertyName, propertyName + this.propertySuffix); + } + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.properties == null) + throw new MojoFailureException("A 'properties' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + // make sure we have a list and it is nice and neat + ListIterator p = this.properties.listIterator(); + while (p.hasNext()) { + String propValue = p.next(); + String trimmedValue = StringUtils.trimToNull(propValue); + if (propValue == null || trimmedValue == null) { + p.remove(); + } else if (propValue.length() != trimmedValue.length()) { + p.remove(); + p.add(trimmedValue); + } else { + // nothing to change in the property name + } + } + + this.propertySuffix = StringUtils.trimToNull(this.propertySuffix); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.propertySuffix == null) + throw new MojoFailureException("The 'propertySuffix' element is required"); + if (this.properties.isEmpty()) + throw new MojoFailureException("At least one 'property' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MatchPropertyMojo.java b/src/main/java/com/inteligr8/maven/regex/MatchPropertyMojo.java new file mode 100644 index 0000000..3aef8bd --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MatchPropertyMojo.java @@ -0,0 +1,59 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "match-property", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MatchPropertyMojo extends AbstractMatchMojo { + + @Parameter( property = "property", required = true ) + protected String property; + + @Parameter( property = "newProperty", required = false ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing property regex match"); + + this.executeOnProperty(this.property, this.newProperty); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + this.property = StringUtils.trimToNull(this.property); + this.newProperty = StringUtils.trimToNull(this.newProperty); + if (this.newProperty == null) + this.newProperty = this.property + "-regex"; + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.property == null) + throw new MojoFailureException("The 'property' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MatchTextMojo.java b/src/main/java/com/inteligr8/maven/regex/MatchTextMojo.java new file mode 100644 index 0000000..490a754 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MatchTextMojo.java @@ -0,0 +1,64 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "match-text", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MatchTextMojo extends AbstractMatchMojo { + + @Parameter( property = "text", required = true ) + protected String text; + + @Parameter( property = "newProperty", required = false ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing property regex match"); + + this.executeOnText(this.project.getProperties(), this.text, this.newProperty); + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.text == null) + throw new MojoFailureException("The 'text' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + this.newProperty = StringUtils.trimToNull(this.newProperty); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.newProperty == null) + throw new MojoFailureException("The 'newProperty' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/MoveFileMojo.java b/src/main/java/com/inteligr8/maven/regex/MoveFileMojo.java new file mode 100644 index 0000000..e00273b --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/MoveFileMojo.java @@ -0,0 +1,38 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; + +import org.apache.maven.plugins.annotations.Mojo; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "move-file", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class MoveFileMojo extends AbstractFileMojo { + + @Override + protected void executeOnFile(Path sourcePath, Path targetPath) throws IOException { + if (MoveFileMojo.this.overwrite) { + Files.move(sourcePath, targetPath, StandardCopyOption.REPLACE_EXISTING); + } else { + Files.move(sourcePath, targetPath); + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/ReplaceFileContentMojo.java b/src/main/java/com/inteligr8/maven/regex/ReplaceFileContentMojo.java new file mode 100644 index 0000000..99a00e1 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/ReplaceFileContentMojo.java @@ -0,0 +1,96 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; + +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.shared.model.fileset.FileSet; +import org.apache.maven.shared.model.fileset.util.FileSetManager; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "replace-file", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class ReplaceFileContentMojo extends AbstractReplaceMojo { + + @Parameter( property = "chunkSize", required = true, defaultValue = "1024" ) + protected int chunkSize = 1024; + + @Parameter( property = "filesets", required = true ) + protected List filesets; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing file regex replace"); + + this.replaceContentInFileSet(); + } + + private boolean replaceContentInFileSet() throws MojoExecutionException { + boolean didReplace = false; + FileSetManager fsman = new FileSetManager(this.getLog()); + Path basepath = this.project.getBasedir().toPath(); + + try { + for (FileSet fileSet : this.filesets) { + String outputDir = fileSet.getOutputDirectory(); + Path baseOutputPath = new File(outputDir).toPath(); + if (!Files.exists(baseOutputPath)) + Files.createDirectories(baseOutputPath); + if (!Files.isDirectory(baseOutputPath)) + throw new MojoExecutionException("A fileset output directory does not reference a directory: " + outputDir); + + String[] filePathsAndNames = fsman.getIncludedFiles(fileSet); + for (String filePathAndName : filePathsAndNames) { + Path file = basepath.resolve(filePathAndName); + Path tofile = baseOutputPath.resolve(filePathAndName); + if (!Files.exists(tofile.getParent())) + Files.createDirectories(tofile.getParent()); + + if (!Files.isDirectory(file)) + didReplace = this.replaceAll(file, tofile, this.chunkSize) || didReplace; + } + } + } catch (IOException ie) { + throw new MojoExecutionException("Execution failed due to an I/O related issue", ie); + } + + return didReplace; + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.filesets == null || this.filesets.isEmpty()) + throw new MojoFailureException("At least one 'fileset' is required"); + for (FileSet fileset : this.filesets) + if (fileset.getOutputDirectory() == null) + throw new MojoFailureException("All 'fileset' must have an 'outputDirectory'"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/ReplacePropertiesMojo.java b/src/main/java/com/inteligr8/maven/regex/ReplacePropertiesMojo.java new file mode 100644 index 0000000..33e60c1 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/ReplacePropertiesMojo.java @@ -0,0 +1,86 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import java.util.List; +import java.util.ListIterator; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "replace-properties", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class ReplacePropertiesMojo extends AbstractReplaceMojo { + + @Parameter( property = "properties", required = true ) + protected List properties; + + @Parameter( property = "newPropertySuffix", required = true, defaultValue = "-regex" ) + protected String propertySuffix; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing properties regex replacement"); + + for (String propertyName : this.properties) { + this.executeOnProperty(propertyName, propertyName + this.propertySuffix); + } + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.properties == null) + throw new MojoFailureException("A 'properties' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + // make sure we have a list and it is nice and neat + ListIterator p = this.properties.listIterator(); + while (p.hasNext()) { + String propValue = p.next(); + String trimmedValue = StringUtils.trimToNull(propValue); + if (propValue == null || trimmedValue == null) { + p.remove(); + } else if (propValue.length() != trimmedValue.length()) { + p.remove(); + p.add(trimmedValue); + } else { + // nothing to change in the property name + } + } + + this.propertySuffix = StringUtils.trimToNull(this.propertySuffix); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.propertySuffix == null) + throw new MojoFailureException("The 'propertySuffix' element is required"); + if (this.properties.isEmpty()) + throw new MojoFailureException("At least one 'property' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/ReplacePropertyMojo.java b/src/main/java/com/inteligr8/maven/regex/ReplacePropertyMojo.java new file mode 100644 index 0000000..1103d92 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/ReplacePropertyMojo.java @@ -0,0 +1,59 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "replace-property", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class ReplacePropertyMojo extends AbstractReplaceMojo { + + @Parameter( property = "property", required = true ) + protected String property; + + @Parameter( property = "newProperty", required = false ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing property regex replacement"); + + this.executeOnProperty(this.property, this.newProperty); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + this.property = StringUtils.trimToNull(this.property); + this.newProperty = StringUtils.trimToNull(this.newProperty); + if (this.newProperty == null) + this.newProperty = this.property + "-regex"; + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.property == null) + throw new MojoFailureException("The 'property' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/maven/regex/ReplaceTextMojo.java b/src/main/java/com/inteligr8/maven/regex/ReplaceTextMojo.java new file mode 100644 index 0000000..b4d2b4b --- /dev/null +++ b/src/main/java/com/inteligr8/maven/regex/ReplaceTextMojo.java @@ -0,0 +1,64 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.maven.regex; + +import org.apache.commons.lang3.StringUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "replace-text", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class ReplaceTextMojo extends AbstractReplaceMojo { + + @Parameter( property = "text", required = true ) + protected String text; + + @Parameter( property = "newProperty", required = false ) + protected String newProperty; + + @Override + public void go() throws MojoExecutionException { + this.getLog().debug("Executing property regex replacement"); + + this.executeOnText(this.project.getProperties(), this.text, this.newProperty); + } + + @Override + protected void validateParamsPreNormalization() throws MojoFailureException { + super.validateParamsPreNormalization(); + + if (this.text == null) + throw new MojoFailureException("The 'text' element is required"); + } + + @Override + protected void normalizeParameters() throws MojoFailureException { + super.normalizeParameters(); + + this.newProperty = StringUtils.trimToNull(this.newProperty); + } + + @Override + protected void validateParamsPostNormalization() throws MojoFailureException { + super.validateParamsPostNormalization(); + + if (this.newProperty == null) + throw new MojoFailureException("The 'newProperty' element is required"); + } + +} diff --git a/src/main/java/com/inteligr8/nio/DelimitedReadableByteChannel.java b/src/main/java/com/inteligr8/nio/DelimitedReadableByteChannel.java new file mode 100644 index 0000000..7f90068 --- /dev/null +++ b/src/main/java/com/inteligr8/nio/DelimitedReadableByteChannel.java @@ -0,0 +1,131 @@ +/* + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ +package com.inteligr8.nio; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.CharBuffer; +import java.nio.channels.ReadableByteChannel; +import java.nio.charset.Charset; +import java.nio.charset.CharsetDecoder; +import java.util.HashSet; +import java.util.Set; + +import javax.annotation.OverridingMethodsMustInvokeSuper; + +public class DelimitedReadableByteChannel implements ReadableByteChannel { + + private final CharBuffer buffer; + private final ReadableByteChannel rbchannel; + private final Charset charset; + private final Set delimiters; + private String lastDelimiter; + + public DelimitedReadableByteChannel(ReadableByteChannel rbchannel, Charset charset, String... delimiters) { + this(128, rbchannel, charset, delimiters); + } + + public DelimitedReadableByteChannel(int bufferSize, ReadableByteChannel rbchannel, Charset charset, String... delimiters) { + this.buffer = CharBuffer.allocate(bufferSize); + this.buffer.flip(); + + this.rbchannel = rbchannel; + this.charset = charset; + + this.delimiters = new HashSet(delimiters.length+2); + for (String delimiter : delimiters) + this.delimiters.add(delimiter); + } + + @Override + @OverridingMethodsMustInvokeSuper + public void close() throws IOException { + this.rbchannel.close(); + } + + @Override + public boolean isOpen() { + return this.rbchannel.isOpen(); + } + + @Override + public int read(ByteBuffer dst) throws IOException { + return this.rbchannel.read(dst); + } + + public int read(Appendable output, String... additionalDelimiters) throws IOException { + Set delimiters = this.delimiters; + if (additionalDelimiters != null && additionalDelimiters.length > 0) { + delimiters = new HashSet<>(this.delimiters); + for (String delimiter : additionalDelimiters) + delimiters.add(delimiter); + } + + int bytesReadFromBuffer = 0; + int bytesReadFromChannel = 0; + this.lastDelimiter = null; + CharsetDecoder cdecoder = this.charset.newDecoder(); + + while (bytesReadFromChannel >= 0 && this.lastDelimiter == null) { + // buffer should always be left in the ready-to-read state + int bytesToReadFromBuffer = this.buffer.remaining(); + this.readToDelimiter(output); + bytesReadFromBuffer += bytesToReadFromBuffer - this.buffer.remaining(); + + // switch buffer to ready-to-write state + this.buffer.compact(); + + ByteBuffer bbuffer = ByteBuffer.allocate(this.buffer.remaining()); + bytesReadFromChannel = this.rbchannel.read(bbuffer); + + bbuffer.flip(); + cdecoder.decode(bbuffer, this.buffer, false); + + // switch buffer to ready-to-read state + this.buffer.flip(); + } + + if (this.lastDelimiter != null || bytesReadFromBuffer > 0) { + return bytesReadFromBuffer; + } else { + return bytesReadFromChannel; + } + } + + private void readToDelimiter(Appendable output) throws IOException { + String sbuffer = this.buffer.toString(); + int pos = -1; + + for (String delimiter : this.delimiters) { + pos = sbuffer.indexOf(delimiter); + if (pos >= 0) { + this.lastDelimiter = delimiter; + this.buffer.position(pos + delimiter.length()); + break; + } + } + + if (this.lastDelimiter == null) { + pos = sbuffer.length(); + this.buffer.position(pos); + } + output.append(sbuffer, 0, pos); + } + + public String getLastDelimiterRead() { + return this.lastDelimiter; + } + +} diff --git a/src/test/java/com/inteligr8/nio/DelimitedReadableByteChannelUnitTest.java b/src/test/java/com/inteligr8/nio/DelimitedReadableByteChannelUnitTest.java new file mode 100644 index 0000000..cc2523e --- /dev/null +++ b/src/test/java/com/inteligr8/nio/DelimitedReadableByteChannelUnitTest.java @@ -0,0 +1,130 @@ +package com.inteligr8.nio; + +import java.io.File; +import java.io.IOException; +import java.io.StringWriter; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.channels.FileChannel; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.nio.file.Paths; + +import org.junit.Assert; +import org.junit.Test; + +public class DelimitedReadableByteChannelUnitTest { + + @Test + public void empty() throws IOException, URISyntaxException { + URL resource = this.getClass().getResource("/empty.file"); + Path path = Paths.get(resource.toURI()); + FileChannel fchannel = FileChannel.open(path); + try { + DelimitedReadableByteChannel drbchannel = new DelimitedReadableByteChannel(fchannel, Charset.defaultCharset(), "\n"); + try { + StringBuilder strbuilder = new StringBuilder(); + Assert.assertEquals(-1L, drbchannel.read(strbuilder)); + Assert.assertEquals(0, strbuilder.length()); + Assert.assertNull(drbchannel.getLastDelimiterRead()); + } finally { + drbchannel.close(); + } + } finally { + fchannel.close(); + } + } + + @Test + public void blankFirstLastLines() throws IOException, URISyntaxException { + URL resource = this.getClass().getResource("/blank-first-last-lines.file"); + Path path = Paths.get(resource.toURI()); + FileChannel fchannel = FileChannel.open(path); + try { + DelimitedReadableByteChannel drbchannel = new DelimitedReadableByteChannel(fchannel, Charset.defaultCharset(), "\r\n", "\n"); + try { + StringWriter writer = new StringWriter(1024); + Assert.assertNotEquals(-1L, drbchannel.read(writer)); + Assert.assertEquals("", writer.toString()); + Assert.assertNotNull(drbchannel.getLastDelimiterRead()); + + writer = new StringWriter(1024); + Assert.assertNotEquals(-1L, drbchannel.read(writer)); + Assert.assertEquals("here is a line", writer.toString()); + Assert.assertNotNull(drbchannel.getLastDelimiterRead()); + + writer = new StringWriter(1024); + Assert.assertEquals(-1L, drbchannel.read(writer)); + Assert.assertNull(drbchannel.getLastDelimiterRead()); + } finally { + drbchannel.close(); + } + } finally { + fchannel.close(); + } + } + + @Test + public void usedFirstLastLines() throws IOException, URISyntaxException { + URL resource = this.getClass().getResource("/used-first-last-lines.file"); + Path path = Paths.get(resource.toURI()); + FileChannel fchannel = FileChannel.open(path); + try { + DelimitedReadableByteChannel drbchannel = new DelimitedReadableByteChannel(fchannel, Charset.defaultCharset(), "\r\n", "\n"); + try { + StringWriter writer = new StringWriter(1024); + Assert.assertNotEquals(-1L, drbchannel.read(writer)); + Assert.assertEquals("the first line", writer.toString()); + Assert.assertNotNull(drbchannel.getLastDelimiterRead()); + + writer = new StringWriter(1024); + Assert.assertNotEquals(-1L, drbchannel.read(writer)); + Assert.assertEquals("the last line", writer.toString()); + Assert.assertNull(drbchannel.getLastDelimiterRead()); + + writer = new StringWriter(1024); + Assert.assertEquals(-1L, drbchannel.read(writer)); + Assert.assertNull(drbchannel.getLastDelimiterRead()); + } finally { + drbchannel.close(); + } + } finally { + fchannel.close(); + } + } + + @Test + public void pomXmlBigChunk() throws IOException, URISyntaxException { + this.pomXml(1024); + } + + @Test + public void pomXmlSmallChunk() throws IOException, URISyntaxException { + this.pomXml(16); + } + + public void pomXml(int chunkSize) throws IOException, URISyntaxException { + File file = new File("pom.xml"); + Path path = file.toPath(); + FileChannel fchannel = FileChannel.open(path); + try { + DelimitedReadableByteChannel drbchannel = new DelimitedReadableByteChannel(chunkSize, fchannel, Charset.defaultCharset(), "\n"); + try { + StringWriter writer = new StringWriter(1024); + Assert.assertNotEquals(-1L, drbchannel.read(writer)); + Assert.assertEquals("", writer.toString()); + Assert.assertEquals("\n", drbchannel.getLastDelimiterRead()); + + writer = new StringWriter(1024); + Assert.assertEquals(1, drbchannel.read(writer)); + Assert.assertEquals("", writer.toString()); + Assert.assertEquals("\n", drbchannel.getLastDelimiterRead()); + } finally { + drbchannel.close(); + } + } finally { + fchannel.close(); + } + } + +} diff --git a/src/test/resources/blank-first-last-lines.file b/src/test/resources/blank-first-last-lines.file new file mode 100644 index 0000000..fb49678 --- /dev/null +++ b/src/test/resources/blank-first-last-lines.file @@ -0,0 +1,2 @@ + +here is a line diff --git a/src/test/resources/empty.file b/src/test/resources/empty.file new file mode 100644 index 0000000..e69de29 diff --git a/src/test/resources/used-first-last-lines.file b/src/test/resources/used-first-last-lines.file new file mode 100644 index 0000000..76a3fac --- /dev/null +++ b/src/test/resources/used-first-last-lines.file @@ -0,0 +1,2 @@ +the first line +the last line \ No newline at end of file