diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..5e92712 --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,55 @@ +# This workflow will build a Java project with Gradle +# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle + +name: Java CI with Gradle +on: [ push, pull_request ] + +jobs: + build: + runs-on: ubuntu-latest + if: "!contains(github.event.commits[0].message, '[ci-skip]')" + steps: + - uses: actions/checkout@v3.0.0 + - uses: gradle/wrapper-validation-action@v1 + - name: Set up JDK 17 + uses: actions/setup-java@v3.0.0 + with: + distribution: temurin + java-version: 17 + cache: gradle + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Test with Gradle + run: ./gradlew test + - name: Build with Gradle + run: ./gradlew build + - name: Upload artifacts + uses: "actions/upload-artifact@v2.2.3" + with: + name: "IridiumColorAPI" + path: "build/libs/IridiumColorAPI-*.jar" + upload: + needs: build + runs-on: ubuntu-latest + if: "contains(github.event.commits[0].message, 'Version Increment')" + steps: + - uses: actions/checkout@v2 + - uses: thecodemonkey/action-get-gradle-version@master + id: version + with: + file: "build.gradle.kts" + - uses: actions/download-artifact@v3.0.2 + with: + name: "IridiumColorAPI" + path: "./" + - name: Publish to Nexus + uses: sonatype-nexus-community/nexus-repo-github-action@master + with: + serverUrl: "https://nexus.iridiumdevelopment.net/" + username: "${{ secrets.NEXUS_USERNAME }}" + password: "${{ secrets.NEXUS_PASSWORD }}" + format: "maven2" + repository: "maven-releases" + coordinates: "groupId=com.iridium artifactId=IridiumColorAPI version=${{steps.version.outputs.version}} generate-pom=on" + assets: "extension=jar" + filename: "IridiumColorAPI-*.jar" \ No newline at end of file diff --git a/.gitignore b/.gitignore index 82e5c63..971df42 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ # Project exclude paths -/target/ -/.idea/ +.gradle/ +.idea/ +build/ +target/ diff --git a/IridiumColorAPI.iml b/IridiumColorAPI.iml deleted file mode 100644 index 78b2cc5..0000000 --- a/IridiumColorAPI.iml +++ /dev/null @@ -1,2 +0,0 @@ - - \ No newline at end of file diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENCE @@ -0,0 +1,674 @@ + 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/README.md b/README.md new file mode 100644 index 0000000..6689b60 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# IridiumColorAPI + +```xml + + iridiumdevelopment + https://nexus.iridiumdevelopment.net/repository/maven-releases/ + +``` +```xml + + com.iridium + IridiumColorAPI + LATEST + +``` +# Usage +To add a gradient simply use the tags +```java +IridiumColorAPI.process("Cool string with a gradient"); +``` +![Gradient Text](https://i.imgur.com/M1l5OM9.png) + +The number after the rainbow represents the saturation +```java +IridiumColorAPI.process("THIS IS A REALLY COOL Rainbow"); +``` + +![Rainbow](https://i.imgur.com/5GhSFo1.png) + +```java +IridiumColorAPI.process("THIS IS A REALLY COOL Rainbow"); +``` +![Rainbow](https://i.imgur.com/Rieftuz.png) +```java +IridiumColorAPI.process("Cool RGB SUPPORT"); +``` +![RGB Text](https://i.imgur.com/IudqIpb.png) + +If your server version is pre 1.16 it will map the color to the nearest supported value(This also works with gradient) +In the example above, it will map to &5 as this is the closest + +![Legacy RGB](https://i.imgur.com/8RMmCAX.png) diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..e167200 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,43 @@ +plugins { + java + `maven-publish` +} + +group = "com.iridium" +version = "1.0.9" +description = "IridiumColorAPI" +java.sourceCompatibility = JavaVersion.VERSION_1_8 + +repositories { + maven("https://repo.rosewooddev.io/repository/public/") + mavenCentral() +} + +dependencies { + implementation("org.spigotmc:spigot:1.17.1") + implementation("org.apache.commons:commons-lang3:3.13.0") + testImplementation("org.junit.jupiter:junit-jupiter:5.8.1") + testImplementation("org.mockito:mockito-inline:4.0.0") + testImplementation("org.mockito:mockito-junit-jupiter:4.0.0") +} + +publishing { + publications.create("maven") { + from(components["java"]) + } +} + +tasks.withType().configureEach { + options.encoding = "UTF-8" +} + +tasks { + build { + dependsOn(test) + } + + test { + useJUnitPlatform() + setForkEvery(1) + } +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ffed3a2 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/pom.xml b/pom.xml deleted file mode 100644 index 92f8124..0000000 --- a/pom.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - 4.0.0 - - com.iridium - IridiumColorAPI - 1.0.0 - - - - nms-repo - https://repo.codemc.org/repository/nms/ - - - - - - org.spigotmc - spigot - LATEST - provided - - - - \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..6afa58a --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "IridiumColorAPI" diff --git a/src/main/java/com/iridium/iridiumcolorapi/IridiumColorAPI.java b/src/main/java/com/iridium/iridiumcolorapi/IridiumColorAPI.java index 9462227..c7228cb 100644 --- a/src/main/java/com/iridium/iridiumcolorapi/IridiumColorAPI.java +++ b/src/main/java/com/iridium/iridiumcolorapi/IridiumColorAPI.java @@ -1,86 +1,104 @@ package com.iridium.iridiumcolorapi; +import com.google.common.collect.ImmutableMap; +import com.iridium.iridiumcolorapi.patterns.GradientPattern; +import com.iridium.iridiumcolorapi.patterns.Pattern; +import com.iridium.iridiumcolorapi.patterns.RainbowPattern; +import com.iridium.iridiumcolorapi.patterns.SolidPattern; import net.md_5.bungee.api.ChatColor; -import org.apache.commons.lang.Validate; +import org.apache.commons.lang3.Validate; import org.bukkit.Bukkit; import javax.annotation.Nonnull; import java.awt.*; -import java.util.HashMap; -import java.util.regex.Matcher; -import java.util.regex.Pattern; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Collection; +import java.util.stream.Collectors; public class IridiumColorAPI { + /** * The current version of the server in the a form of a major version. - * If the static initialization for this fails, you know something's wrong with the server software. + * If the static initialization for this fails, you know something's wrong with + * the server software. * * @since 1.0.0 */ - private static final int VERSION = Integer.parseInt(getMajorVersion(Bukkit.getVersion()).substring(2)); + private static final int VERSION = getVersion(); /** - * Cached result if the server version is after the v1.16 rgb update. + * Cached result if the server version is after the v1.16 RGB update. * * @since 1.0.0 */ - private static final boolean SUPPORTSRGB = supports(16); + private static final boolean SUPPORTS_RGB = VERSION >= 16 || VERSION == -1; + + private static final List SPECIAL_COLORS = Arrays.asList("&l", "&n", "&o", "&k", "&m", "§l", "§n", "§o", "§k", "§m"); /** * Cached result of all legacy colors. * * @since 1.0.0 */ - private static final HashMap colors = new HashMap() {{ - put(new Color(0), ChatColor.getByChar('0')); - put(new Color(170), ChatColor.getByChar('1')); - put(new Color(43520), ChatColor.getByChar('2')); - put(new Color(43690), ChatColor.getByChar('3')); - put(new Color(11141120), ChatColor.getByChar('4')); - put(new Color(11141290), ChatColor.getByChar('5')); - put(new Color(16755200), ChatColor.getByChar('6')); - put(new Color(11184810), ChatColor.getByChar('7')); - put(new Color(5592405), ChatColor.getByChar('8')); - put(new Color(5592575), ChatColor.getByChar('9')); - put(new Color(5635925), ChatColor.getByChar('a')); - put(new Color(5636095), ChatColor.getByChar('b')); - put(new Color(16733525), ChatColor.getByChar('c')); - put(new Color(16733695), ChatColor.getByChar('d')); - put(new Color(16777045), ChatColor.getByChar('e')); - put(new Color(16777215), ChatColor.getByChar('f')); - }}; + private static final Map COLORS = ImmutableMap.builder() + .put(new Color(0), ChatColor.getByChar('0')) + .put(new Color(170), ChatColor.getByChar('1')) + .put(new Color(43520), ChatColor.getByChar('2')) + .put(new Color(43690), ChatColor.getByChar('3')) + .put(new Color(11141120), ChatColor.getByChar('4')) + .put(new Color(11141290), ChatColor.getByChar('5')) + .put(new Color(16755200), ChatColor.getByChar('6')) + .put(new Color(11184810), ChatColor.getByChar('7')) + .put(new Color(5592405), ChatColor.getByChar('8')) + .put(new Color(5592575), ChatColor.getByChar('9')) + .put(new Color(5635925), ChatColor.getByChar('a')) + .put(new Color(5636095), ChatColor.getByChar('b')) + .put(new Color(16733525), ChatColor.getByChar('c')) + .put(new Color(16733695), ChatColor.getByChar('d')) + .put(new Color(16777045), ChatColor.getByChar('e')) + .put(new Color(16777215), ChatColor.getByChar('f')).build(); + + /** + * Cached result of patterns. + * + * @since 1.0.2 + */ + private static final List PATTERNS = Arrays.asList(new GradientPattern(), new SolidPattern(), new RainbowPattern()); /** * Processes a string to add color to it. - * Thanks to Distressing for helping with the regex <3 + * Thanks to Distressing for helping with the regex <3 * * @param string The string we want to process * @since 1.0.0 */ - @Nonnull public static String process(@Nonnull String string) { - string = ChatColor.translateAlternateColorCodes('&', string); - Pattern gradiant = Pattern.compile("(()((.*?)(<\\/GRADIENT:(([0-9]|[A-F]|[a-f]){6})>)))+"); - Matcher gradiantmatcher = gradiant.matcher(string); - while (gradiantmatcher.find()) { - String start = gradiantmatcher.group(3); - String end = gradiantmatcher.group(8); - String content = gradiantmatcher.group(6); - string = string.replace(gradiantmatcher.group(), color(content, new Color(Integer.parseInt(start, 16)), new Color(Integer.parseInt(end, 16)))); - } - Pattern solid = Pattern.compile("()"); - Matcher solidmatcher = solid.matcher(string); - while (solidmatcher.find()) { - String color = solidmatcher.group(2); - string = string.replace(solidmatcher.group(), getColor(color) + ""); + for (Pattern pattern : PATTERNS) { + string = pattern.process(string); } - return string; + return ChatColor.translateAlternateColorCodes('&', string); + } + + /** + * Processes multiple strings in a collection. + * + * @param strings The collection of the strings we are processing + * @return The list of processed strings + * @since 1.0.3 + */ + @Nonnull + public static List process(@Nonnull Collection strings) { + return strings.stream() + .map(IridiumColorAPI::process) + .collect(Collectors.toList()); } /** - * Colors a String + * Colors a String. * * @param string The string we want to color * @param color The color we want to set it to @@ -88,11 +106,11 @@ public static String process(@Nonnull String string) { */ @Nonnull public static String color(@Nonnull String string, @Nonnull Color color) { - return (SUPPORTSRGB ? ChatColor.of(color) : getClosestColor(color)) + string; + return (SUPPORTS_RGB ? ChatColor.of(color) : getClosestColor(color)) + string; } /** - * Colors a String with a gradiant + * Colors a String with a gradiant. * * @param string The string we want to color * @param start The starting gradiant @@ -101,24 +119,106 @@ public static String color(@Nonnull String string, @Nonnull Color color) { */ @Nonnull public static String color(@Nonnull String string, @Nonnull Color start, @Nonnull Color end) { + ChatColor[] colors = createGradient(start, end, withoutSpecialChar(string).length()); + return apply(string, colors); + } + + /** + * Colors a String with rainbow colors. + * + * @param string The string which should have rainbow colors + * @param saturation The saturation of the rainbow colors + * @since 1.0.3 + */ + @Nonnull + public static String rainbow(@Nonnull String string, float saturation) { + ChatColor[] colors = createRainbow(withoutSpecialChar(string).length(), saturation); + return apply(string, colors); + } + + /** + * Gets a color from hex code. + * + * @param string The hex code of the color + * @since 1.0.0 + */ + @Nonnull + public static ChatColor getColor(@Nonnull String string) { + return SUPPORTS_RGB ? ChatColor.of(new Color(Integer.parseInt(string, 16))) + : getClosestColor(new Color(Integer.parseInt(string, 16))); + } + + /** + * Removes all color codes from the provided String, including IridiumColorAPI + * patterns. + * + * @param string The String which should be stripped + * @return The stripped string without color codes + * @since 1.0.5 + */ + @Nonnull + public static String stripColorFormatting(@Nonnull String string) { + return string.replaceAll("<#[0-9A-F]{6}>|[&§][a-f0-9ln-okmr]|<[/]?[A-Z]{5,8}(:[0-9A-F]{6})?[0-9]*>", ""); + } + + @Nonnull + private static String apply(@Nonnull String source, ChatColor[] colors) { + StringBuilder specialColors = new StringBuilder(); StringBuilder stringBuilder = new StringBuilder(); - ChatColor[] colors = createGradient(start, end, string.length()); - String[] characters = string.split(""); - for (int i = 0; i < string.length(); i++) { - stringBuilder.append(colors[i]).append(characters[i]); + int outIndex = 0; + + for (int i = 0; i < source.length(); i++) { + char currentChar = source.charAt(i); + if (('&' != currentChar && '§' != currentChar) || i + 1 >= source.length()) { + stringBuilder.append(colors[outIndex++]).append(specialColors).append(currentChar); + continue; + } + + char nextChar = source.charAt(i + 1); + if ('r' == nextChar || 'R' == nextChar) { + specialColors.setLength(0); + } else { + specialColors.append(currentChar).append(nextChar); + } + i++; } return stringBuilder.toString(); } + @Nonnull + private static String withoutSpecialChar(@Nonnull String source) { + String workingString = source; + for (String color : SPECIAL_COLORS) { + if (workingString.contains(color)) { + workingString = workingString.replace(color, ""); + } + } + return workingString; + } + /** - * Get a color from hex code + * Returns a rainbow array of chat colors. * - * @param string The hex code of the color - * @since 1.0.0 + * @param step How many colors we return + * @param saturation The saturation of the rainbow + * @return The array of colors + * @since 1.0.3 */ @Nonnull - private static ChatColor getColor(@Nonnull String string) { - return SUPPORTSRGB ? ChatColor.of(new Color(Integer.parseInt(string, 16))) : getClosestColor(new Color(Integer.parseInt(string, 16))); + private static ChatColor[] createRainbow(int step, float saturation) { + ChatColor[] colors = new ChatColor[step]; + double colorStep = (1.00 / step); + + for (int i = 0; i < step; i++) { + Color color = Color.getHSBColor((float) (colorStep * i), saturation, saturation); + if (SUPPORTS_RGB) { + colors[i] = ChatColor.of(color); + } else { + colors[i] = getClosestColor(color); + } + } + + return colors; } /** @@ -132,11 +232,12 @@ private static ChatColor getColor(@Nonnull String string) { */ @Nonnull private static ChatColor[] createGradient(@Nonnull Color start, @Nonnull Color end, int step) { + step = Math.max(step,2); ChatColor[] colors = new ChatColor[step]; int stepR = Math.abs(start.getRed() - end.getRed()) / (step - 1); int stepG = Math.abs(start.getGreen() - end.getGreen()) / (step - 1); int stepB = Math.abs(start.getBlue() - end.getBlue()) / (step - 1); - int[] direction = new int[]{ + int[] direction = new int[] { start.getRed() < end.getRed() ? +1 : -1, start.getGreen() < end.getGreen() ? +1 : -1, start.getBlue() < end.getBlue() ? +1 : -1 @@ -144,16 +245,16 @@ private static ChatColor[] createGradient(@Nonnull Color start, @Nonnull Color e for (int i = 0; i < step; i++) { Color color = new Color(start.getRed() + ((stepR * i) * direction[0]), start.getGreen() + ((stepG * i) * direction[1]), start.getBlue() + ((stepB * i) * direction[2])); - if (SUPPORTSRGB) { + if (SUPPORTS_RGB) { colors[i] = ChatColor.of(color); } else { colors[i] = getClosestColor(color); } } + return colors; } - /** * Returns the closest legacy color from an rgb color * @@ -165,38 +266,29 @@ private static ChatColor getClosestColor(Color color) { Color nearestColor = null; double nearestDistance = Integer.MAX_VALUE; - for (Color constantColor : colors.keySet()) { - double distance = Math.sqrt(Math.pow(color.getRed() - constantColor.getRed(), 2) - Math.pow(color.getGreen() - constantColor.getGreen(), 2) - Math.pow(color.getBlue() - constantColor.getBlue(), 2)); + for (Color constantColor : COLORS.keySet()) { + double distance = Math.pow(color.getRed() - constantColor.getRed(), 2) + Math.pow(color.getGreen() - constantColor.getGreen(), 2) + Math.pow(color.getBlue() - constantColor.getBlue(), 2); if (nearestDistance > distance) { nearestColor = constantColor; nearestDistance = distance; } } - return colors.get(nearestColor); - } - - /** - * Checks if the specified version is the same version or higher than the current server version. - * - * @param version the major version to be checked. "1." is ignored. E.g. 1.12 = 12 | 1.9 = 9 - * @return true of the version is equal or higher than the current version. - * @since 1.0.0 - */ - public static boolean supports(int version) { - return VERSION >= version; + return COLORS.get(nearestColor); } /** - * Gets the exact major version (..., 1.9, 1.10, ..., 1.14) + * Gets a simplified major version (..., 9, 10, ..., 14). * In most cases, you shouldn't be using this method. * - * @param version Supports {@link Bukkit#getVersion()}, {@link Bukkit#getBukkitVersion()} and normal formats such as "1.14" - * @return the exact major version. - * @see #supports(int) + * @return the simplified major version, or -1 for bungeecord * @since 1.0.0 */ - @Nonnull - public static String getMajorVersion(@Nonnull String version) { + private static int getVersion() { + if (!classExists("org.bukkit.Bukkit") && classExists("net.md_5.bungee.api.ChatColor")) { + return -1; + } + + String version = Bukkit.getVersion(); Validate.notEmpty(version, "Cannot get major Minecraft version from null or empty string"); // getVersion() @@ -208,11 +300,27 @@ public static String getMajorVersion(@Nonnull String version) { index = version.indexOf('-'); version = version.substring(0, index); } - // 1.13.2, 1.14.4, etc... int lastDot = version.lastIndexOf('.'); if (version.indexOf('.') != lastDot) version = version.substring(0, lastDot); - return version; + return Integer.parseInt(version.substring(2)); } + + /** + * Checks if a class exists in the current server + * + * @param path The path of that class + * @return true if the class exists, false if it doesn't + * @since 1.0.7 + */ + private static boolean classExists(final String path) { + try { + Class.forName(path); + return true; + } catch (ClassNotFoundException e) { + return false; + } + } + } diff --git a/src/main/java/com/iridium/iridiumcolorapi/patterns/GradientPattern.java b/src/main/java/com/iridium/iridiumcolorapi/patterns/GradientPattern.java new file mode 100644 index 0000000..2e46a23 --- /dev/null +++ b/src/main/java/com/iridium/iridiumcolorapi/patterns/GradientPattern.java @@ -0,0 +1,33 @@ +package com.iridium.iridiumcolorapi.patterns; + +import com.iridium.iridiumcolorapi.IridiumColorAPI; + +import java.awt.*; +import java.util.regex.Matcher; + +/** + * Represents a gradient color pattern which can be applied to a String. + */ +public class GradientPattern implements Pattern { + + java.util.regex.Pattern pattern = java.util.regex.Pattern.compile("(.*?)"); + + /** + * Applies a gradient pattern to the provided String. + * Output might me the same as the input if this pattern is not present. + * + * @param string The String to which this pattern should be applied to + * @return The new String with applied pattern + */ + public String process(String string) { + Matcher matcher = pattern.matcher(string); + while (matcher.find()) { + String start = matcher.group(1); + String end = matcher.group(3); + String content = matcher.group(2); + string = string.replace(matcher.group(), IridiumColorAPI.color(content, new Color(Integer.parseInt(start, 16)), new Color(Integer.parseInt(end, 16)))); + } + return string; + } + +} diff --git a/src/main/java/com/iridium/iridiumcolorapi/patterns/Pattern.java b/src/main/java/com/iridium/iridiumcolorapi/patterns/Pattern.java new file mode 100644 index 0000000..2f955af --- /dev/null +++ b/src/main/java/com/iridium/iridiumcolorapi/patterns/Pattern.java @@ -0,0 +1,17 @@ +package com.iridium.iridiumcolorapi.patterns; + +/** + * Represents a color pattern which can be applied to a String. + */ +public interface Pattern { + + /** + * Applies this pattern to the provided String. + * Output might me the same as the input if this pattern is not present. + * + * @param string The String to which this pattern should be applied to + * @return The new String with applied pattern + */ + String process(String string); + +} diff --git a/src/main/java/com/iridium/iridiumcolorapi/patterns/RainbowPattern.java b/src/main/java/com/iridium/iridiumcolorapi/patterns/RainbowPattern.java new file mode 100644 index 0000000..0ef199c --- /dev/null +++ b/src/main/java/com/iridium/iridiumcolorapi/patterns/RainbowPattern.java @@ -0,0 +1,28 @@ +package com.iridium.iridiumcolorapi.patterns; + +import com.iridium.iridiumcolorapi.IridiumColorAPI; + +import java.util.regex.Matcher; + +public class RainbowPattern implements Pattern { + + java.util.regex.Pattern pattern = java.util.regex.Pattern.compile("(.*?)"); + + /** + * Applies a rainbow pattern to the provided String. + * Output might me the same as the input if this pattern is not present. + * + * @param string The String to which this pattern should be applied to + * @return The new String with applied pattern + */ + public String process(String string) { + Matcher matcher = pattern.matcher(string); + while (matcher.find()) { + String saturation = matcher.group(1); + String content = matcher.group(2); + string = string.replace(matcher.group(), IridiumColorAPI.rainbow(content, Float.parseFloat(saturation))); + } + return string; + } + +} diff --git a/src/main/java/com/iridium/iridiumcolorapi/patterns/SolidPattern.java b/src/main/java/com/iridium/iridiumcolorapi/patterns/SolidPattern.java new file mode 100644 index 0000000..1f3a196 --- /dev/null +++ b/src/main/java/com/iridium/iridiumcolorapi/patterns/SolidPattern.java @@ -0,0 +1,29 @@ +package com.iridium.iridiumcolorapi.patterns; + +import com.iridium.iridiumcolorapi.IridiumColorAPI; + +import java.util.regex.Matcher; + +public class SolidPattern implements Pattern { + + java.util.regex.Pattern pattern = java.util.regex.Pattern.compile("|#\\{([0-9A-Fa-f]{6})}"); + + /** + * Applies a solid RGB color to the provided String. + * Output might me the same as the input if this pattern is not present. + * + * @param string The String to which this pattern should be applied to + * @return The new String with applied pattern + */ + public String process(String string) { + Matcher matcher = pattern.matcher(string); + while (matcher.find()) { + String color = matcher.group(1); + if (color == null) color = matcher.group(2); + + string = string.replace(matcher.group(), IridiumColorAPI.getColor(color) + ""); + } + return string; + } + +} diff --git a/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPILegacyTest.java b/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPILegacyTest.java new file mode 100644 index 0000000..c16a352 --- /dev/null +++ b/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPILegacyTest.java @@ -0,0 +1,82 @@ +package com.iridium.iridiumcolorapi; + +import org.bukkit.Bukkit; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.mockito.MockedStatic; +import org.mockito.Mockito; + +import java.awt.Color; +import java.util.Arrays; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class IridiumColorAPILegacyTest { + + static MockedStatic mockedStatic; + + @BeforeAll + static void setup() { + mockedStatic = Mockito.mockStatic(Bukkit.class); + mockedStatic.when(Bukkit::getVersion).thenReturn("1.8.8-R0.3-SNAPSHOT"); + } + + @Test + void process() { + assertEquals("§8Test", IridiumColorAPI.process("Test")); + assertEquals("§1§lT§1§le§3§ls§3§lt", IridiumColorAPI.process("&lTest")); + assertEquals("§4§lT§a§le§b§ls§5§lt", IridiumColorAPI.process("&lTest")); + assertEquals("§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*", IridiumColorAPI.process("******************************************************************************************************************************************************************************************************")); + } + + @Test + void listProcess() { + List list = Arrays.asList("Test", "Test", "******************************************************************************************************************************************************************************************************"); + List result = IridiumColorAPI.process(list); + + assertEquals("§8Test", result.get(0)); + assertEquals("§1T§1e§3s§3t", result.get(1)); + assertEquals("§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*§8*", result.get(2)); + } + + @Test + void color() { + assertEquals("§1Test", IridiumColorAPI.color("Test", Color.BLUE)); + assertEquals("§6Test", IridiumColorAPI.color("Test", Color.YELLOW)); + assertEquals("§0Test", IridiumColorAPI.color("Test", Color.BLACK)); + } + + @Test + void rainbow() { + assertEquals("§4T§ae§bs§5t", IridiumColorAPI.rainbow("Test", 1)); + assertEquals("§fT§fe§es§7t", IridiumColorAPI.rainbow("Test", 100)); + assertEquals("§0T§0e§0s§0t", IridiumColorAPI.rainbow("Test", 0)); + assertEquals("§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§7*§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§e*§f*§7*§e*§7*§6*§7*§e*§f*§e*§6*§e*§e*§7*§c*§f*§e*§f*§7*§e*§f*§6*§d*§e*§f*§e*§6*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§7*§c*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§7*§e*§7*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§f*§6*§f*§e*§7*§6*§e*§f*§e*§f*§e*§f*§6*§e*§f*§e*§f*§e*§f*§e*§7*§6*§e*§f*§e*§f*§e*", IridiumColorAPI.rainbow("**************************************************************************************************************************************************************************", 100)); + } + + @Test + void stripColorFormatting() { + assertEquals("Test", IridiumColorAPI.stripColorFormatting("§8Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("§1T§1e§3s§3t")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("&1T§1e&3s§3t")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("&1T&1e&3s&3t")); + assertEquals("**************************************************************************************************************************************************************************", IridiumColorAPI.stripColorFormatting("§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§7*§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§e*§f*§7*§e*§7*§6*§7*§e*§f*§e*§6*§e*§e*§7*§c*§f*§e*§f*§7*§e*§f*§6*§d*§e*§f*§e*§6*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§7*§c*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§7*§e*§7*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§f*§6*§f*§e*§7*§6*§e*§f*§e*§f*§e*§f*§6*§e*§f*§e*§f*§e*§f*§e*§7*§6*§e*§f*§e*§f*§e*")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + + assertEquals("", IridiumColorAPI.stripColorFormatting("")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("&&&&&Test&&&&&", IridiumColorAPI.stripColorFormatting("&&&&&Test&&&&&")); + } + + @AfterAll + static void tearDown() { + mockedStatic.close(); + } + +} diff --git a/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPITest.java b/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPITest.java new file mode 100644 index 0000000..3111d59 --- /dev/null +++ b/src/test/java/com/iridium/iridiumcolorapi/IridiumColorAPITest.java @@ -0,0 +1,86 @@ +package com.iridium.iridiumcolorapi; + +import org.bukkit.Bukkit; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.mockito.MockedStatic; +import org.mockito.Mockito; + +import java.awt.Color; +import java.util.Arrays; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.*; + +class IridiumColorAPITest { + + static MockedStatic mockedStatic; + + @BeforeAll + static void setup() { + mockedStatic = Mockito.mockStatic(Bukkit.class); + mockedStatic.when(Bukkit::getVersion).thenReturn("1.17.1-R0.1-SNAPSHOT"); + } + + @Test + void process() { + + assertEquals("§x§1§2§3§4§5§6Test", IridiumColorAPI.process("Test")); + assertEquals("§x§1§2§3§4§5§6Te§kst", IridiumColorAPI.process("Te&kst")); + assertEquals("§x§2§c§0§8§b§a§lT§x§1§e§3§3§a§f§le§x§1§0§5§e§a§4§ls§x§0§2§8§9§9§9§lt", IridiumColorAPI.process("&lTest")); + assertEquals("§x§2§c§0§8§b§a§lT§x§1§e§3§3§a§f§le§x§1§0§5§e§a§4§ls§x§0§2§8§9§9§9§l§kt", IridiumColorAPI.process("&lTes§kt")); + assertEquals("§x§f§f§0§0§0§0§lT§x§8§0§f§f§0§0§le§x§0§0§f§f§f§f§ls§x§8§0§0§0§f§f§lt", IridiumColorAPI.process("&lTest")); + assertEquals("§x§f§f§0§0§0§0§lT§x§8§0§f§f§0§0§le§x§0§0§f§f§f§f§ls§x§8§0§0§0§f§f§l§kt", IridiumColorAPI.process("&lTes&kt")); + assertEquals("§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*", IridiumColorAPI.process("******************************************************************************************************************************************************************************************************")); + } + + @Test + void listProcess() { + List list = Arrays.asList("Test", "Test", "******************************************************************************************************************************************************************************************************"); + List result = IridiumColorAPI.process(list); + + assertEquals("§x§1§2§3§4§5§6Test", result.get(0)); + assertEquals("§x§2§c§0§8§b§aT§x§1§e§3§3§a§fe§x§1§0§5§e§a§4s§x§0§2§8§9§9§9t", result.get(1)); + assertEquals("§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*§x§1§2§3§4§5§6*", result.get(2)); + } + + @Test + void color() { + assertEquals("§x§0§0§0§0§f§fTest", IridiumColorAPI.color("Test", Color.BLUE)); + assertEquals("§x§f§f§f§f§0§0Test", IridiumColorAPI.color("Test", Color.YELLOW)); + assertEquals("§x§0§0§0§0§0§0Test", IridiumColorAPI.color("Test", Color.BLACK)); + } + + @Test + void rainbow() { + assertEquals("§x§f§f§0§0§0§0T§x§8§0§f§f§0§0e§x§0§0§f§f§f§fs§x§8§0§0§0§f§ft", IridiumColorAPI.rainbow("Test", 1)); + assertEquals("§x§f§f§f§f§a§dT§x§f§f§f§e§a§de§x§e§f§f§f§9§cs§x§7§f§e§f§9§ct", IridiumColorAPI.rainbow("Test", 100)); + assertEquals("§x§0§0§0§0§0§0T§x§0§0§0§0§0§0e§x§0§0§0§0§0§0s§x§0§0§0§0§0§0t", IridiumColorAPI.rainbow("Test", 0)); + assertEquals("§x§f§f§f§f§a§d*§x§d§f§7§f§a§d*§x§f§d§f§f§a§d*§x§d§d§7§f§a§d*§x§f§d§f§f§a§d*§x§d§d§7§f§a§d*§x§f§d§7§f§a§d*§x§d§f§f§f§a§d*§x§f§f§7§f§a§d*§x§d§f§f§f§a§d*§x§f§f§7§f§a§d*§x§d§d§f§f§a§d*§x§f§d§7§f§a§d*§x§d§d§f§f§a§d*§x§f§d§f§f§a§d*§x§d§d§7§f§a§d*§x§f§f§f§f§a§d*§x§d§f§7§f§a§d*§x§f§f§f§f§a§d*§x§d§f§7§f§a§d*§x§f§d§f§f§a§d*§x§d§d§7§f§a§d*§x§f§d§7§f§a§d*§x§d§d§f§f§a§d*§x§f§d§7§f§a§d*§x§d§f§f§f§a§d*§x§f§f§7§f§a§d*§x§d§f§f§f§a§d*§x§f§f§7§f§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§e§a§d*§x§f§f§f§f§d§d*§x§f§f§d§f§6§d*§x§f§f§b§e§f§d*§x§f§f§9§e§8§d*§x§f§f§f§e§1§d*§x§e§f§d§d§a§d*§x§e§f§b§d§3§d*§x§e§f§9§c§c§d*§x§e§f§f§c§5§d*§x§e§f§d§f§e§d*§x§e§f§b§f§7§d*§x§e§f§9§f§0§d*§x§e§f§f§e§9§d*§x§e§f§d§e§2§d*§x§e§f§b§d§b§d*§x§e§f§9§d§4§d*§x§e§f§f§c§d§d*§x§f§f§d§c§6§d*§x§f§f§b§f§f§d*§x§f§f§9§f§8§d*§x§f§f§f§f§1§d*§x§f§f§d§e§a§d*§x§f§f§b§e§3§d*§x§f§f§9§d§c§d*§x§f§f§f§d§5§d*§x§f§f§d§c§e§d*§x§f§f§b§c§7§d*§x§f§f§9§c§0§d*§x§e§f§f§f§9§c*§x§a§d§6§f§9§c*§x§a§d§7§f§9§c*§x§e§d§e§f§9§c*§x§e§d§7§f§9§c*§x§a§d§e§f§9§c*§x§a§f§7§f§9§c*§x§e§f§e§f§9§c*§x§e§f§7§f§9§c*§x§a§f§e§f§9§c*§x§a§f§f§f§9§c*§x§e§d§6§f§9§c*§x§e§d§f§f§9§c*§x§a§d§6§f§9§c*§x§a§d§f§f§9§c*§x§e§f§6§f§9§c*§x§e§f§f§f§9§c*§x§a§f§6§f§9§c*§x§a§f§7§f§9§c*§x§e§f§e§f§9§c*§x§e§d§7§f§9§c*§x§a§d§e§f§9§c*§x§a§d§7§f§9§c*§x§e§d§e§f§9§c*§x§e§f§7§f§9§c*§x§a§f§e§f§9§c*§x§a§f§f§f§9§c*§x§e§f§6§f§9§c*§x§e§f§f§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§e§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§e§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§e§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§e§e§f§9§c*§x§f§e§e§f§9§c*§x§7§f§e§f§9§c*§x§f§e§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§9§c*§x§7§f§e§f§9§c*§x§f§f§e§f§6§d*§x§f§e§a§f§d§e*§x§f§f§a§f§4§d*§x§f§f§e§f§b§d*§x§f§e§f§d§2§d*§x§f§f§b§d§9§d*§x§f§f§b§d§0§d*§x§f§e§f§d§7§d*§x§f§e§f§d§e§c*§x§f§f§b§f§5§e*§x§f§e§b§f§c§d*§x§f§e§f§f§3§e*§x§f§f§f§f§a§d*§x§f§e§b§d§1§d*§x§f§e§b§d§8§d*§x§f§f§f§d§f§d*§x§f§f§f§d§6§e*§x§f§e§b§d§d§e*§x§f§f§b§f§4§d*§x§f§f§f§f§b§d*§x§f§e§f§f§2§d*§x§f§f§b§f§9§d*§x§f§f§b§d§0§d*§x§f§e§f§d§7§d*§x§f§e§f§d§e§c*§x§f§f§b§d§5§e*§x§f§e§b§d§c§c*§x§f§e§f§f§3§e*", IridiumColorAPI.rainbow("**************************************************************************************************************************************************************************", 100)); + } + + @Test + void stripColorFormatting() { + assertEquals("Test", IridiumColorAPI.stripColorFormatting("§8Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("§1T§1e§3s§3t")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("&1T§1e&3s§3t")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("&1T&1e&3s&3t")); + assertEquals("**************************************************************************************************************************************************************************", IridiumColorAPI.stripColorFormatting("§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§7*§f*§7*§f*§7*§f*§7*§d*§f*§d*§f*§d*§f*§d*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§f*§e*§f*§7*§e*§7*§6*§7*§e*§f*§e*§6*§e*§e*§7*§c*§f*§e*§f*§7*§e*§f*§6*§d*§e*§f*§e*§6*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§7*§c*§e*§7*§7*§e*§7*§7*§7*§e*§7*§7*§7*§c*§e*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§7*§e*§7*§7*§e*§7*§e*§7*§e*§7*§e*§e*§7*§e*§7*§e*§f*§6*§f*§e*§7*§6*§e*§f*§e*§f*§e*§f*§6*§e*§f*§e*§f*§e*§f*§e*§7*§6*§e*§f*§e*§f*§e*")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + + assertEquals("", IridiumColorAPI.stripColorFormatting("")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("Test", IridiumColorAPI.stripColorFormatting("Test")); + assertEquals("&&&&&Test&&&&&", IridiumColorAPI.stripColorFormatting("&&&&&Test&&&&&")); + } + + @AfterAll + static void tearDown() { + mockedStatic.close(); + } + +}