diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..1f21379b --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +* @theEvilReaper @TheMeinerLP +/.github/CODEOWNERS @theEvilReaper diff --git a/.github/ISSUE_TEMPLATE/behavior-bug.yml b/.github/ISSUE_TEMPLATE/behavior-bug.yml new file mode 100644 index 00000000..8a870e00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/behavior-bug.yml @@ -0,0 +1,42 @@ +name: Behavior Bug +description: Report issues with plugin incompatibility or other behavior related issues. +labels: [ "status: needs triage", "type: bug" ] +body: + - type: textarea + attributes: + label: Expected behavior + description: What you expected to see. + validations: + required: true + + - type: textarea + attributes: + label: Actual behavior + description: What you actually saw. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: This may include a video, or detailed instructions to help reconstruct the issue. + validations: + required: true + + - type: textarea + attributes: + label: Other + description: | + Please include other helpful information below. + The more information we receive, the quicker and more effective we can be at finding the solution to the issue. + validations: + required: false + + - type: markdown + attributes: + value: | + Before submitting this issue, please ensure the following: + + 1. You searched for and ensured there isn't already an open issue regarding this. + 2. Your version of kotlin/java is supported by DartPoet. + 3. You are running the latest version of DartPoet from [our github page](https://github.com/theEvilReaper/DartPoet). diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..0b599f4d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,44 @@ +name: Feature Request +description: Suggest an idea for DartPoet +labels: [ "status: needs triage", "type: feature" ] +body: + - type: markdown + attributes: + value: | + Thank you for filling out a feature request for SolarSystem! Please be as detailed as possible so that we may consider and review the request easier. + We ask that you search all the issues to avoid a duplicate feature request. If one exists, please reply if you have anything to add. + Before requesting a new feature, please make sure you are using the latest version and that the feature you are requesting is not already in DartPoet. + + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: Please give some context for this request. Why do you want it added? + validations: + required: true + + - type: textarea + attributes: + label: Describe the solution you'd like. + description: A clear and concise description of what you want. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: List any alternatives you might have tried to get the feature you want. + validations: + required: true + + - type: textarea + attributes: + label: Other + description: Add any other context or screenshots about the feature request below. + validations: + required: false + + - type: markdown + attributes: + value: | + Before submitting this feature request, please search our issue tracker to ensure your feature has not + already been requested. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..cb16465d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,53 @@ + + +## Proposed changes + +Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. +If it fixes a bug or resolves a feature request, be sure to link to that issue. + +## Types of changes + +What types of changes does your code introduce to this project? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation Update (if none of the other choices apply) + +## Checklist + +_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of +them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before +merging your code._ + +- [ ] I have read the CONTRIBUTING.md +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if appropriate) + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you +did and what alternatives you considered, etc... \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8dd8b04f..a4181002 100644 --- a/.gitignore +++ b/.gitignore @@ -79,3 +79,5 @@ Icon Network Trash Folder Temporary Items .apdisk + +.idea \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 13566b81..00000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/.idea/compiler.xml b/.idea/compiler.xml deleted file mode 100644 index 61a9130c..00000000 --- a/.idea/compiler.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml deleted file mode 100644 index df543e3a..00000000 --- a/.idea/inspectionProfiles/Project_Default.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml deleted file mode 100644 index fdc392fe..00000000 --- a/.idea/jarRepositories.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml deleted file mode 100644 index 0fc31131..00000000 --- a/.idea/kotlinc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index c95b4858..00000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/.idea/sonarlint/issuestore/index.pb b/.idea/sonarlint/issuestore/index.pb deleted file mode 100644 index e69de29b..00000000 diff --git a/.idea/sonarlint/securityhotspotstore/index.pb b/.idea/sonarlint/securityhotspotstore/index.pb deleted file mode 100644 index e69de29b..00000000 diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 94a25f7f..00000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..e67a41ea --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +## [Unreleased] + +### Added + +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..dd3c205a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,136 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +the follwing e-mail address [admin@onelitefeather.net](mailto:admin@onelitefeather.net). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org + +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html + +[Mozilla CoC]: https://github.com/mozilla/diversity + +[FAQ]: https://www.contributor-covenant.org/faq + +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..99c7e976 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ + + +# Contributing + +There are a lot of different ways to contribute to this project. See below for +everything you can do and the processes to follow for each contribution method. +Note that no matter how you contribute, your participation is governed by our +[Code of Conduct](CODE_OF_CONDUCT.md). + +## Make changes to the code or docs + +Fork the project, make a change, and send a pull request! + +Make sure you read and follow the instructions in the [pull request template](.github/pull_request_template.md). And +note +that all participation in this project (including code submissions) is +governed by our [Code of Conduct](CODE_OF_CONDUCT.md). + +## Submit bug reports or feature requests + +Just use the GitHub issue tracker to submit your bug reports and feature +requests. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8de6ae7c --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..97781c1d --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# DartPoet + +# **DartPoet is still in development and not ready for production use.** + +## Description +Helps developers to write dart code in a more fluent way via kotlin api. +## Motivation +Our company uses kotlin for all of our projects. We wanted to write our dart code in a more fluent way. So we decided to write our own library for code generation. +## Focus +Our focus lies within a basic implementation of DartPoet, its core and reaching the goal of stable builds to use it in production later on. + +## Contributing +We are happy to see that you are interested in contributing to our project. Please read our [contributing guidelines](CONTRIBUTING.md) before you start. + +## Maven +```xml + + dev.themeinerlp + dartpoet + 0.0.1-SNAPSHOT + +``` + +## Gradle +```kotlin +implementation("dev.themeinerlp:dartpoet:0.0.1-SNAPSHOT") +``` + +## Usage +```kotlin +`` \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index aab6d72a..bf16450c 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,10 +1,11 @@ plugins { alias(libs.plugins.kotlin.jvm) application + id("org.jetbrains.changelog") version "2.0.0" } group = "net.theevilreaper.dartpoet" -version = "1.0-SNAPSHOT" +version = "0.0.1-SNAPSHOT" repositories { mavenCentral() @@ -15,14 +16,30 @@ dependencies { testImplementation(libs.kotlin.junit) } -tasks.test { - useJUnitPlatform() +tasks { + test { + useJUnitPlatform() + } + compileKotlin { + kotlinOptions { + jvmTarget = "17" + useK2 = true + } + } } kotlin { - jvmToolchain(8) + jvmToolchain(17) } application { mainClass.set("MainKt") +} + +changelog { + path.set("${project.projectDir}/CHANGELOG.md") + itemPrefix.set("-") + keepUnreleasedSection.set(true) + unreleasedTerm.set("[Unreleased]") + groups.set(listOf("Added", "Changed", "Deprecated", "Removed", "Fixed", "Security")) } \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/DartClassType.kt b/src/main/kotlin/net/theevilreaper/dartpoet/DartClassType.kt index 413edb39..f3a348c4 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/DartClassType.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/DartClassType.kt @@ -1,8 +1,10 @@ package net.theevilreaper.dartpoet enum class DartClassType( - val keyWord: String + val keyWord: String, + val defaultModifier: Array ) { - CLASS("class"), - MIXIN("mixin"), + CLASS("class", arrayOf()), + ENUM("enum", arrayOf()), + MIXIN("mixin", arrayOf()), } \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/DartModifier.kt b/src/main/kotlin/net/theevilreaper/dartpoet/DartModifier.kt index a3a48a35..8632944e 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/DartModifier.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/DartModifier.kt @@ -1,10 +1,15 @@ package net.theevilreaper.dartpoet enum class DartModifier( - private val identifier: String, - vararg modifiers: ModifierTarget + internal val identifier: String, + private vararg val modifiers: ModifierTarget ) { - PUBLIC("public", ModifierTarget.CLASS), - FINAL("final", ModifierTarget.CLASS, ModifierTarget.FUNCTION, ModifierTarget.PROPERTY) + PRIVATE("_", ModifierTarget.FUNCTION, ModifierTarget.PROPERTY), + LATE("late", ModifierTarget.PROPERTY), + FINAL("final", ModifierTarget.PROPERTY); + + internal fun containsTarget(modifierTarget: ModifierTarget): Boolean { + return modifiers.contains(modifierTarget) + } } \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/DartProperty.kt b/src/main/kotlin/net/theevilreaper/dartpoet/DartProperty.kt deleted file mode 100644 index eba2342a..00000000 --- a/src/main/kotlin/net/theevilreaper/dartpoet/DartProperty.kt +++ /dev/null @@ -1,72 +0,0 @@ -package net.theevilreaper.dartpoet - -import net.theevilreaper.dartpoet.util.toImmutableSet -import net.theevilreaper.dartpoet.writer.CodeWriter - -class DartProperty( - builder: Builder -) { - - private var name = builder.name - private var type = builder.type - private var modifiers: Set = builder.modifiers.toImmutableSet() - private var nullable = builder.nullable - - internal fun write( - codeWriter: CodeWriter, - implicitModifiers: Set, - withInitializer: Boolean = true, - ) { - } - - class Builder internal constructor( - var name: String, - var type: String, - vararg modifiers: DartModifier - ) { - - internal var nullable = false - internal val modifiers: MutableList = mutableListOf() - - fun nullable(nullable: Boolean): Builder { - this.nullable = nullable - return this - } - - fun addModifier(modifier: DartModifier): Builder { - this.modifiers += modifier - return this - } - - fun addModifier(modifier: () -> DartModifier): Builder { - this.modifiers += modifier() - return this - } - - fun addModifiers(modifiers: Iterable): Builder { - this.modifiers += modifiers; - return this - } - - fun addModifiers(modifier: () -> Iterable): Builder { - this.modifiers += modifier() - return this - } - - fun build(): DartProperty { - return DartProperty(this) - } - - } - - companion object { - - @JvmStatic fun builder( - name: String, - type: String, - vararg modifiers: DartModifier - ): Builder { - return Builder(name, type, *modifiers) - } - } -} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/FileSpec.kt b/src/main/kotlin/net/theevilreaper/dartpoet/FileSpec.kt new file mode 100644 index 00000000..0f991bbb --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/FileSpec.kt @@ -0,0 +1,4 @@ +package net.theevilreaper.dartpoet + +class FileSpec { +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/FileSpecBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/FileSpecBuilder.kt new file mode 100644 index 00000000..b49576c1 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/FileSpecBuilder.kt @@ -0,0 +1,49 @@ +package net.theevilreaper.dartpoet + +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import net.theevilreaper.dartpoet.meta.SpecData +import net.theevilreaper.dartpoet.meta.SpecMethods + +class FileSpecBuilder( + val name: String +): SpecMethods { + + internal val specData = SpecData() + + + override fun annotations(annotations: Iterable) = apply { + this.specData.annotations(annotations) + } + + override fun annotations(annotations: () -> Iterable) = apply { + this.specData.annotations(annotations) + } + + override fun annotation(annotation: () -> AnnotationSpec) = apply { + this.specData.annotation(annotation) + } + + override fun annotation(annotation: AnnotationSpec) = apply { + this.specData.annotation(annotation) + } + + override fun modifier(modifier: DartModifier) = apply { + this.specData.modifier(modifier) + } + + override fun modifier(modifier: () -> DartModifier) = apply { + this.specData.modifier(modifier) + } + + override fun modifiers(modifiers: Iterable) = apply { + this.specData.modifiers(modifiers) + } + + override fun modifiers(modifiers: () -> Iterable) = apply { + this.specData.modifiers(modifiers) + } + + fun build(): FileSpec { + return FileSpec() + } +} diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpec.kt b/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpec.kt new file mode 100644 index 00000000..55f0babe --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpec.kt @@ -0,0 +1,11 @@ +package net.theevilreaper.dartpoet.annotation + + +/** + * @author theEvilReaper + * @version 1.0.0 + * @since + **/ + +class AnnotationSpec { +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpecBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpecBuilder.kt new file mode 100644 index 00000000..482ccbe4 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/annotation/AnnotationSpecBuilder.kt @@ -0,0 +1,15 @@ +package net.theevilreaper.dartpoet.annotation + + +/** + * @author theEvilReaper + * @version 1.0.0 + * @since + **/ + +class AnnotationSpecBuilder { + + fun build(): AnnotationSpec { + return AnnotationSpec() + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassBuilder.kt new file mode 100644 index 00000000..0ec9fb5b --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassBuilder.kt @@ -0,0 +1,65 @@ +package net.theevilreaper.dartpoet.clazz + +import net.theevilreaper.dartpoet.DartClassType +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import net.theevilreaper.dartpoet.meta.SpecData +import net.theevilreaper.dartpoet.meta.SpecMethods +import net.theevilreaper.dartpoet.property.DartPropertySpec + +class DartClassBuilder internal constructor( + internal val name: String?, + internal val classType: DartClassType +): SpecMethods { + + private val classMetaData: SpecData = SpecData() + private val isAnonymousClass get() = name == null && classType == DartClassType.CLASS + private val isEnumClass get() = classType == DartClassType.ENUM + private val isMixinClass get() = classType == DartClassType.MIXIN + + private val propertyStack: MutableList = mutableListOf() + + fun property(dartPropertySpec: DartPropertySpec) = apply { + this.propertyStack += dartPropertySpec + } + + fun property(dartPropertySpec: () -> DartPropertySpec) = apply { + this.propertyStack += dartPropertySpec() + } + + override fun annotations(annotations: Iterable)= apply { + this.classMetaData.annotations(annotations) + } + + override fun annotations(annotations: () -> Iterable) = apply { + this.classMetaData.annotations(annotations) + } + + override fun annotation(annotation: () -> AnnotationSpec) = apply { + this.classMetaData.annotation(annotation) + } + + override fun annotation(annotation: AnnotationSpec) = apply { + this.classMetaData.annotation(annotation) + } + + override fun modifier(modifier: DartModifier) = apply { + this.classMetaData.modifier(modifier) + } + + override fun modifier(modifier: () -> DartModifier) = apply { + this.classMetaData.modifier(modifier) + } + + override fun modifiers(modifiers: Iterable) = apply { + this.classMetaData.modifiers(modifiers) + } + + override fun modifiers(modifiers: () -> Iterable) = apply { + this.classMetaData.modifiers(modifiers) + } + + fun build(): DartClassSpec { + return DartClassSpec(this) + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassSpec.kt b/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassSpec.kt new file mode 100644 index 00000000..0a2959f2 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/clazz/DartClassSpec.kt @@ -0,0 +1,42 @@ +package net.theevilreaper.dartpoet.clazz + +import net.theevilreaper.dartpoet.DartClassType + +class DartClassSpec internal constructor( + builder: DartClassBuilder +) { + + internal val name = builder.name + internal val classType = builder.classType + + + + + + companion object { + + /** + * Create a new [DartClassBuilder] instance for a normal dart class. + * @return the created instance + */ + @JvmStatic fun builder(name: String): DartClassBuilder = DartClassBuilder(name, DartClassType.CLASS) + + /** + * Create a new [DartClassBuilder] instance for an anonymous dart class. + * @return the created instance + */ + @JvmStatic fun anonymousClassBuilder(): DartClassBuilder = DartClassBuilder( null, DartClassType.CLASS) + + /** + * Create a new [DartClassBuilder] instance for a enum dart class. + * @return the created instance + */ + @JvmStatic fun enumClass(name: String): DartClassBuilder = DartClassBuilder(name, DartClassType.ENUM) + + /** + * Create a new [DartClassBuilder] instance for a mixin dart class. + * @return the created instance + */ + @JvmStatic fun mixinClass(name: String): DartClassBuilder = DartClassBuilder(name, DartClassType.MIXIN) + } +} diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragment.kt b/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragment.kt index 35d4c4cd..4d2ae4eb 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragment.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragment.kt @@ -1,8 +1,8 @@ package net.theevilreaper.dartpoet.code class CodeFragment( - var formatParts: List, - var args: List + private var formatParts: List, + private var args: List ) { fun isEmpty() = formatParts.isEmpty() diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragmentBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragmentBuilder.kt index 6d3d8ec5..708ece15 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragmentBuilder.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/code/CodeFragmentBuilder.kt @@ -1,9 +1,194 @@ package net.theevilreaper.dartpoet.code +import net.theevilreaper.dartpoet.util.toImmutableList +import net.theevilreaper.dartpoet.writer.FragmentPart +import java.text.DecimalFormat +import java.text.DecimalFormatSymbols + +/** + * codeblock.add("this.add(%$1T);", object); + * + */ + +private val NO_ARG_PLACEHOLDERS = arrayOf('⇥', '⇤', '«', '»').toCharArray() + class CodeFragmentBuilder( - internal val formatParts: MutableList = mutableListOf(), - internal val args: MutableList = mutableListOf() + internal val formatParts: MutableList = mutableListOf(), // 0 + internal val args: MutableList = mutableListOf(), // 0 ) { + companion object { + @JvmStatic + fun of(format: String, vararg args: Any?): CodeFragment = builder().add(format, args).build() + + @JvmStatic + fun builder(): CodeFragmentBuilder = CodeFragmentBuilder() + internal val Char.isSingleCharNoArgPlaceholder get() = this in NO_ARG_PLACEHOLDERS + internal val Char.isMultiCharNoArgPlaceholder get() = this == '%' + + internal fun String.nextPotentialPlaceholderPosition(startIndex: Int) = + indexOfAny(NO_ARG_PLACEHOLDERS, startIndex) + } + + fun add(format: String, vararg args: Any?): CodeFragmentBuilder = apply { + if (format.trim().isEmpty()) return@apply + + var hasRelative = false + var hasIndexed = false + + var relativeParameterCount = 0 + val indexedParameterCount = IntArray(args.size) + + var counter = 0 + + while (counter < format.length) { + // Checks if the char is a placeholder + if (format[counter].isSingleCharNoArgPlaceholder) { + formatParts += format[counter].toString() + counter++ + continue + } + + if (format[counter] != '%') { + var nextPlaceholder = format.nextPotentialPlaceholderPosition(startIndex = counter + 1) + if (nextPlaceholder == -1) nextPlaceholder = format.length + formatParts += format.substring(counter, nextPlaceholder) + counter = nextPlaceholder + continue + } + + counter++ + + // Consume zero or more digits, leaving 'c' as the first non-digit char after the '%'. + val indexStart = counter + var c: Char + do { + require(counter < format.length) { "dangling format characters in '$format'" } + c = format[counter++] + } while (c in '0'..'9') + val indexEnd = counter - 1 + + // If 'c' doesn't take an argument, we're done. + if (c.isMultiCharNoArgPlaceholder) { + require(indexStart == indexEnd) { "%% may not have an index" } + formatParts += "%$c" + continue + } + + val index: Int + if (indexStart < indexEnd) { + index = Integer.parseInt(format.substring(indexStart, indexEnd)) - 1 + hasIndexed = true + if (args.isNotEmpty()) { + indexedParameterCount[index % args.size]++ // modulo is needed, checked below anyway + } + } else { + index = relativeParameterCount + hasRelative = true + relativeParameterCount++ + } + + require(index >= 0 && index < args.size) { + "index ${index + 1} for '${format.substring( + indexStart - 1, + indexEnd + 1, + )}' not in range (received ${args.size} arguments)" + } + require(!hasIndexed || !hasRelative) { "cannot mix indexed and positional parameters" } + + addArgument(format, c, args[index]) + + formatParts += "%$c" + + } + + if (hasRelative) { + require(relativeParameterCount >= args.size) { + "unused arguments: expected $relativeParameterCount, received ${args.size}" + } + } + if (hasIndexed) { + val unused = mutableListOf() + for (i in args.indices) { + if (indexedParameterCount[i] == 0) { + unused += "%" + (i + 1) + } + } + val s = if (unused.size == 1) "" else "s" + require(unused.isEmpty()) { "unused argument$s: ${unused.joinToString(", ")}" } + } + } + + private fun addArgument(format: String, c: Char, arg: Any?) { + val part: FragmentPart = FragmentPart.mapByIdentifier(c) + ?: throw IllegalArgumentException(String.format("invalid format string: '%s'", format)) + + when (part) { + FragmentPart.NAMED -> this.args += argToName(arg) + FragmentPart.LITERAL -> this.args += argToLiteral(arg) + FragmentPart.STRING -> this.args += argToString(arg) + FragmentPart.STRING_NOT_ESCAPED -> this.args += if (arg is CodeFragment) arg else argToString(arg) + FragmentPart.MEMBER -> this.args += arg + } + } + + private fun argToName(o: Any?) = when (o) { + is CharSequence -> o.toString() + /* is ParameterSpec -> o.name + is PropertySpec -> o.name + is FunSpec -> o.name + is TypeSpec -> o.name!! + is MemberName -> o.simpleName*/ + else -> throw IllegalArgumentException("expected name but was $o") + } + + private fun argToLiteral(o: Any?) = if (o is Number) formatNumericValue(o) else o + + private fun argToString(o: Any?) = o?.toString() + + private fun formatNumericValue(o: Number): Any? { + val format = DecimalFormatSymbols().apply { + decimalSeparator = '.' + groupingSeparator = '_' + } + + val precision = if (o is Float || o is Double) o.toString().split(".").last().length else 0 + + val pattern = when (o) { + is Float, is Double -> "###,##0.0" + "#".repeat(precision - 1) + else -> "###,##0" + } + + return DecimalFormat(pattern, format).format(o) + } + + /*private fun argToType(o: Any?) = when (o) { + *//*is TypeName -> o + is TypeMirror -> { + logDeprecationWarning(o) + o.asTypeName() + } + is Element -> { + logDeprecationWarning(o) + o.asType().asTypeName() + } + is Type -> o.asTypeName() + is KClass<*> -> o.asTypeName()*//* + else -> throw IllegalArgumentException("expected type but was $o") + }*/ + + fun indent(): CodeFragmentBuilder = apply { + formatParts += "⇥" + } + + fun unindent(): CodeFragmentBuilder = apply { + formatParts += "⇤" + } + + fun clear(): CodeFragmentBuilder = apply { + formatParts.clear() + args.clear() + } -} \ No newline at end of file + fun build(): CodeFragment = CodeFragment(formatParts.toImmutableList(), args.toImmutableList()) +} diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/import/DartImport.kt b/src/main/kotlin/net/theevilreaper/dartpoet/import/DartImport.kt index 160de49e..7d2da2a9 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/import/DartImport.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/import/DartImport.kt @@ -1,12 +1,56 @@ package net.theevilreaper.dartpoet.import +import net.theevilreaper.dartpoet.util.IMPORT +import java.lang.IllegalStateException + /** - * Example Import - * - * + * The class represents a normal import from dart. + * An import statement can look like this in dart: + *
    + *
  1. 'package:flutter/material.dart'
    2. + *
  2. '../../model/item_model.dart'
  3. + *
+ * Dart also allows to add a prefix to an import which means that an import can look like that: + * -> import ../../model/item_model.dart as itemModel; * + * @author theEvilReaper + * @since 1.0.0 */ -data class DartImport( - val name: String, +class DartImport internal constructor( + private val path: String, + private val importCastType: ImportCastType? = null, + private val importCast: String? = null +) : Import { + + private val importString = buildString { + append("$IMPORT ") + if (importCast == null && importCastType == null) { + append("'package:$path';") + } else if (importCast != null && importCastType != null) { + append("'$path' ${importCastType.identifier} $importCast;") + } else { + throw IllegalStateException("NOPE") + } + } + + /** + * Checks if the importCast string is null or empty. + * It used to determine if the import statement should include the 'as name' in the generation + * @return true when the string is null or empty otherwise false + */ + private fun includePrefix(): Boolean { + return !importCast.isNullOrEmpty() + } + + /** + * Checks if the given name starts with a dot. + * @return true when the import starts with a dot otherwise false + */ + private fun startWithDot(): Boolean { + return this.path.startsWith(".") + } + + override fun compareTo(other: Import): Int = importString.compareTo(other.toString()) -) \ No newline at end of file + override fun toString(): String = importString +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/import/Import.kt b/src/main/kotlin/net/theevilreaper/dartpoet/import/Import.kt new file mode 100644 index 00000000..a5424475 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/import/Import.kt @@ -0,0 +1,3 @@ +package net.theevilreaper.dartpoet.import + +sealed interface Import: Comparable \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/import/ImportCastType.kt b/src/main/kotlin/net/theevilreaper/dartpoet/import/ImportCastType.kt new file mode 100644 index 00000000..4c174698 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/import/ImportCastType.kt @@ -0,0 +1,15 @@ +package net.theevilreaper.dartpoet.import + +/** + * Represent all available import casts from flutter. + * @author theEvilReaper + * @since 1.0.0 + */ +enum class ImportCastType( + val identifier: String +){ + AS("as"), + SHOW("show"), + HIDE("hide"), + DEFERRED("deferred as") +} diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/import/PartImport.kt b/src/main/kotlin/net/theevilreaper/dartpoet/import/PartImport.kt new file mode 100644 index 00000000..0a4fb5b0 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/import/PartImport.kt @@ -0,0 +1,17 @@ +package net.theevilreaper.dartpoet.import + +class PartImport internal constructor( + private val path: String +): Import { + + private val partImport: String = buildString { + append("part ") + append("'") + append(path) + append("';") + } + + override fun toString(): String = partImport + + override fun compareTo(other: Import): Int = partImport.compareTo(other.toString()) +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecData.kt b/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecData.kt new file mode 100644 index 00000000..111ac51c --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecData.kt @@ -0,0 +1,74 @@ +package net.theevilreaper.dartpoet.meta + +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec + +class SpecData : SpecMethods { + + internal val modifiers: MutableList = mutableListOf() + internal val annotations: MutableList = mutableListOf() + + /** + * Add a [Iterable] of [DartModifier]. + * @param modifiers the modifiers to add + */ + override fun modifiers(modifiers: Iterable) { + this.modifiers += modifiers; + } + + /** + * Add a [Iterable] of [AnnotationSpec]. + * @param annotations the annotations to add + */ + override fun annotations(annotations: Iterable) { + this.annotations += annotations + } + + /** + * Add a [Iterable] of [AnnotationSpec]. + * @param annotations the annotations to add + */ + override fun annotations(annotations: () -> Iterable) { + this.annotations += annotations() + } + + /** + * Add a single [AnnotationSpec]. + * @param annotation the annotation to add + */ + override fun annotation(annotation: () -> AnnotationSpec) { + this.annotations += annotation() + } + + /** + * Add a single [AnnotationSpec]. + * @param annotation the annotation to add + */ + override fun annotation(annotation: AnnotationSpec) { + this.annotations += annotation + } + + /** + * Add a new [DartModifier]. + * @param modifier the modifier to add + */ + override fun modifier(modifier: DartModifier) { + this.modifiers += modifier + } + + /** + * Add a new [DartModifier]. + * @param modifier the modifier to add + */ + override fun modifier(modifier: () -> DartModifier) { + this.modifiers += modifier() + } + + /** + * Add a [Iterable] of [DartModifier]. + * @param modifiers the modifiers to add + */ + override fun modifiers(modifiers: () -> Iterable) { + this.modifiers += modifiers() + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecMethods.kt b/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecMethods.kt new file mode 100644 index 00000000..26d7b158 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/meta/SpecMethods.kt @@ -0,0 +1,60 @@ +package net.theevilreaper.dartpoet.meta + +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec + +/** + * The interface defines some method to add [AnnotationSpec] and [DartModifier] to a class which implements the interface. + * @author theEvilReaper + * @since 1.0.0 + */ +internal interface SpecMethods { + + /** + * Add a [Iterable] of [AnnotationSpec]. + * @param annotations the annotations to add + */ + fun annotations(annotations: Iterable): T + + /** + * Add a [Iterable] of [AnnotationSpec]. + * @param annotations the annotations to add + */ + fun annotations(annotations: () -> Iterable): T + + /** + * Add a single [AnnotationSpec]. + * @param annotation the annotation to add + */ + fun annotation(annotation: () -> AnnotationSpec): T + + /** + * Add a single [AnnotationSpec]. + * @param annotation the annotation to add + */ + fun annotation(annotation: AnnotationSpec): T + + /** + * Add a new [DartModifier]. + * @param modifier the modifier to add + */ + fun modifier(modifier: DartModifier): T + + /** + * Add a new [DartModifier]. + * @param modifier the modifier to add + */ + fun modifier(modifier: () -> DartModifier): T + + /** + * Add a [Iterable] of [DartModifier]. + * @param modifiers the modifiers to add + */ + fun modifiers(modifiers: Iterable): T + + /** + * Add a [Iterable] of [DartModifier]. + * @param modifiers the modifiers to add + */ + fun modifiers(modifiers: () -> Iterable): T +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodBuilder.kt new file mode 100644 index 00000000..2de33956 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodBuilder.kt @@ -0,0 +1,6 @@ +package net.theevilreaper.dartpoet.method + +class DartMethodBuilder internal constructor( + name: String +) { +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodSpec.kt b/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodSpec.kt new file mode 100644 index 00000000..989f6ba9 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/method/DartMethodSpec.kt @@ -0,0 +1,19 @@ +package net.theevilreaper.dartpoet.method + +class DartMethodSpec( + builder: DartMethodBuilder +) { + + companion object { + + @JvmStatic fun builder(name: String) = DartMethodBuilder(name) + + @JvmStatic fun constructor(name: String, const: Boolean) { + + } + + @JvmStatic fun namedConstructor(name: String) { + + } + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertyBuilder.kt b/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertyBuilder.kt new file mode 100644 index 00000000..a9c3dc17 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertyBuilder.kt @@ -0,0 +1,111 @@ +package net.theevilreaper.dartpoet.property + +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import net.theevilreaper.dartpoet.code.CodeFragment +import net.theevilreaper.dartpoet.code.CodeFragmentBuilder + + +/** + * @author theEvilReaper + * @version 1.0.0 + * @since + **/ + +class DartPropertyBuilder internal constructor( + var name: String, + var type: String, + vararg modifiers: DartModifier +) { + + internal var nullable = false + internal val modifiers: MutableList = mutableListOf() + internal val annotations: MutableList = mutableListOf() + internal var initBlock: CodeFragment? = null + + fun initWith(format: String, vararg args: Any?): DartPropertyBuilder = apply { + this.initWith(CodeFragmentBuilder.of(format, args)) + } + + fun initWith(codeFragment: CodeFragment?): DartPropertyBuilder = apply { + this.initBlock = codeFragment + } + + /** + * Set if the property should be nullable or not. A property which is nullable in Dart contains a '?' after the type. + * @param nullable if the property should be nullable or not + */ + fun nullable(nullable: Boolean): DartPropertyBuilder { + this.nullable = nullable + return this + } + + /** + * Add a [Iterable] of [AnnotationSpec] to the property. + * @param annotations the annotations to add + */ + fun annotations(annotations: Iterable): DartPropertyBuilder = apply { + this.annotations += annotations + } + + /** + * Add a [Iterable] of [AnnotationSpec] to the property. + * @param annotations the annotations to add + */ + fun annotations(annotations: () -> Iterable): DartPropertyBuilder = apply { + this.annotations += annotations() + } + + /** + * Add a single [AnnotationSpec] to the property. + * @param annotation the annotation to add + */ + fun annotation(annotation: () -> AnnotationSpec): DartPropertyBuilder = apply { + this.annotations += annotation() + } + + /** + * Add a single [AnnotationSpec] to the property. + * @param annotation the annotation to add + */ + fun annotation(annotation: AnnotationSpec): DartPropertyBuilder = apply { + this.annotations += annotation + } + + /** + * Add a new [DartModifier] to the property. + * @param modifier the modifier to add + */ + fun modifier(modifier: DartModifier): DartPropertyBuilder = apply { + this.modifiers += modifier + } + + /** + * Add a new [DartModifier] to the property. + * @param modifier the modifier to add + */ + fun modifier(modifier: () -> DartModifier): DartPropertyBuilder = apply { + this.modifiers += modifier() + } + + /** + * Add a [Iterable] of [DartModifier] to the property. + * @param modifiers the modifiers to add + */ + fun modifiers(modifiers: Iterable): DartPropertyBuilder = apply { + this.modifiers += modifiers; + } + + /** + * Add a [Iterable] of [DartModifier] to the property. + * @param modifiers the modifiers to add + */ + fun modifiers(modifiers: () -> Iterable): DartPropertyBuilder = apply { + this.modifiers += modifiers() + } + + fun build(): DartPropertySpec { + return DartPropertySpec(this) + } + +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertySpec.kt b/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertySpec.kt new file mode 100644 index 00000000..b163a843 --- /dev/null +++ b/src/main/kotlin/net/theevilreaper/dartpoet/property/DartPropertySpec.kt @@ -0,0 +1,37 @@ +package net.theevilreaper.dartpoet.property + +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import net.theevilreaper.dartpoet.util.toImmutableSet +import net.theevilreaper.dartpoet.writer.CodeWriter + +class DartPropertySpec( + builder: DartPropertyBuilder +) { + + private var name = builder.name + private var type = builder.type + private var modifiers: Set = builder.modifiers.toImmutableSet() + private var annotations: Set = builder.annotations.toImmutableSet() + private var nullable = builder.nullable + private var initBlock = builder.initBlock + + internal fun write( + codeWriter: CodeWriter, + implicitModifiers: Set, + withInitializer: Boolean = true, + ) { + } + + companion object { + + @JvmStatic + fun builder( + name: String, + type: String, + vararg modifiers: DartModifier + ): DartPropertyBuilder { + return DartPropertyBuilder(name, type, *modifiers) + } + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/util/Constants.kt b/src/main/kotlin/net/theevilreaper/dartpoet/util/Constants.kt index d3c9095a..4df13bd0 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/util/Constants.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/util/Constants.kt @@ -8,4 +8,7 @@ internal const val NULL_STRING = "null" internal const val NEW_LINE = "\n" internal const val SEMICONLON = ";" +internal const val AS_PART = "as" +internal const val IMPORT = "import" + internal val NEW_LINE_SPLIT: Pattern = Pattern.compile(NEW_LINE) diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/util/Util.kt b/src/main/kotlin/net/theevilreaper/dartpoet/util/Util.kt index 4b8d0998..d57c57fc 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/util/Util.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/util/Util.kt @@ -1,7 +1,11 @@ package net.theevilreaper.dartpoet.util import java.util.* +import kotlin.collections.ArrayList import kotlin.collections.LinkedHashSet internal fun Collection.toImmutableSet(): Set = Collections.unmodifiableSet(LinkedHashSet(this)) + +internal fun Collection.toImmutableList(): List = + Collections.unmodifiableList(ArrayList(this)) diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/writer/CodeWriter.kt b/src/main/kotlin/net/theevilreaper/dartpoet/writer/CodeWriter.kt index 81c3c7e8..f8cae5f5 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/writer/CodeWriter.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/writer/CodeWriter.kt @@ -1,6 +1,12 @@ package net.theevilreaper.dartpoet.writer +import java.io.Closeable + class CodeWriter( out: Appendable -) { +) : Closeable { + override fun close() { + } + + } \ No newline at end of file diff --git a/src/main/kotlin/net/theevilreaper/dartpoet/writer/FragmentPart.kt b/src/main/kotlin/net/theevilreaper/dartpoet/writer/FragmentPart.kt index 8dcc3c94..e9b4f429 100644 --- a/src/main/kotlin/net/theevilreaper/dartpoet/writer/FragmentPart.kt +++ b/src/main/kotlin/net/theevilreaper/dartpoet/writer/FragmentPart.kt @@ -1,14 +1,15 @@ package net.theevilreaper.dartpoet.writer enum class FragmentPart( - val part: String + val part: String, + val identifier: Char ) { - LITERAL("%L"), - STRING("%S"), - STRING_NOT_ESCAPED("%P"), - TYPE("%T"); - + NAMED("%N", 'N'), + LITERAL("%L", 'L'), + STRING("%S", 'S'), + STRING_NOT_ESCAPED("%P", 'P'), + MEMBER("%M", 'M'); companion object { /** @@ -18,5 +19,9 @@ enum class FragmentPart( fun mapToFragmentPart(partString: String): FragmentPart? { return values().firstOrNull { it.part === partString } } + + fun mapByIdentifier(identifier: Char): FragmentPart? { + return values().firstOrNull { it.identifier == identifier } + } } } \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/DartClassBuilderTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/DartClassBuilderTest.kt new file mode 100644 index 00000000..ec41f0f1 --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/DartClassBuilderTest.kt @@ -0,0 +1,63 @@ +package net.theevilreaper.dartpoet + +import com.google.common.truth.Truth.assertThat +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import net.theevilreaper.dartpoet.clazz.DartClassSpec +import net.theevilreaper.dartpoet.property.DartPropertySpec +import org.junit.Test + +class DartClassBuilderTest { + + private val className: String = "DartClass" + + @Test + fun `test simple class creation`() { + val clazz = + DartClassSpec.builder(className).annotation(AnnotationSpec()).modifier { DartModifier.FINAL }.build() + + assertThat(clazz.toString()).isEqualTo(""" + public class $className { + } + """.trimIndent()) + } + + @Test + fun `test enum class`() { + val clazz = DartClassSpec.enumClass(className).build() + assertThat(clazz.toString()).isEqualTo(""" + enum $className { + } + """.trimIndent()) + } + + @Test + fun `test mixin class`() { + val clazz = DartClassSpec.mixinClass(className).build() + assertThat(clazz.toString()).isEqualTo(""" + mixin $className { + } + """.trimIndent() + ) + } + + @Test + fun `test class with a parameter`() { + val clazz = DartClassSpec.builder(className) + .property(DartPropertySpec + .builder("name", "String") + .nullable(false) + .build() + ) + .build() + + assertThat(clazz.toString()).isEqualTo( + """ + public class $className { + + String name; + } + + """.trimIndent() + ) + } +} \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/DartImportTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/DartImportTest.kt new file mode 100644 index 00000000..dc357012 --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/DartImportTest.kt @@ -0,0 +1,48 @@ +package net.theevilreaper.dartpoet + +import junit.framework.TestCase.assertEquals +import net.theevilreaper.dartpoet.import.DartImport +import net.theevilreaper.dartpoet.import.ImportCastType +import org.junit.Test + +class DartImportTest { + + private val packageImport = "import 'package:flutter/material.dart';" + private val modelImport = "import '../../model/item_model.dart' as item;" + private val lazyCastImport = "import '../../model/item_model.dart' deferred as item;" + private val hideCastImport = "import '../../model/item_model.dart' hide item;" + private val showCastImport = "import '../../model/item_model.dart' show item;" + + private val castValue = "item" + private val testImport = "../../model/item_model.dart" + + @Test + fun `test package import`() { + val import = DartImport("flutter/material.dart") + assertEquals(packageImport, import.toString()) + } + + @Test + fun `test package with cast`() { + val import = DartImport(testImport, ImportCastType.AS,castValue) + assertEquals(modelImport, import.toString()) + } + + @Test + fun `test lazy import`() { + val import = DartImport(testImport, ImportCastType.DEFERRED,castValue) + assertEquals(lazyCastImport, import.toString()) + } + + @Test + fun `test import with hide`() { + val import = DartImport(testImport, ImportCastType.HIDE, castValue) + assertEquals(hideCastImport, import.toString()) + } + + @Test + fun `test import with show`() { + val import = DartImport(testImport, ImportCastType.SHOW, castValue) + assertEquals(showCastImport, import.toString()) + } +} diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/DartModifierTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/DartModifierTest.kt new file mode 100644 index 00000000..6453e5ca --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/DartModifierTest.kt @@ -0,0 +1,14 @@ +package net.theevilreaper.dartpoet + +import org.junit.Test +import kotlin.test.assertFalse +import kotlin.test.assertTrue + +class DartModifierTest { + + @Test + fun `test private modifier`() { + assertTrue { DartModifier.FINAL.containsTarget(ModifierTarget.PROPERTY) } + assertFalse { DartModifier.FINAL.containsTarget(ModifierTarget.FUNCTION) } + } +} \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertySpecTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertySpecTest.kt new file mode 100644 index 00000000..025ca2b3 --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertySpecTest.kt @@ -0,0 +1,14 @@ +package net.theevilreaper.dartpoet + +import com.google.common.truth.Truth.assertThat +import net.theevilreaper.dartpoet.property.DartPropertySpec +import org.junit.Test + +class DartPropertySpecTest { + + @Test + fun `test logic`() { + val property = DartPropertySpec.builder("test", "String").nullable(true).build() + assertThat(property.toString()).isEqualTo("String? test;") + } +} \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertyTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertyTest.kt deleted file mode 100644 index 5ee3a1b8..00000000 --- a/src/test/kotlin/net/theevilreaper/dartpoet/DartPropertyTest.kt +++ /dev/null @@ -1,13 +0,0 @@ -package net.theevilreaper.dartpoet - -import com.google.common.truth.Truth.assertThat -import org.junit.jupiter.api.Test - -class DartPropertyTest { - - @Test - fun `test logic`() { - val property = DartProperty.builder("test", "String").nullable(true).build() - assertThat(property.toString()).isEqualTo("String? test;") - } -} \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/PartImportTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/PartImportTest.kt new file mode 100644 index 00000000..a74b709f --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/PartImportTest.kt @@ -0,0 +1,16 @@ +package net.theevilreaper.dartpoet + +import net.theevilreaper.dartpoet.import.PartImport +import org.junit.Test +import org.junit.jupiter.api.Assertions.* + +class PartImportTest { + + private val expectedImport = "part 'item_model.freezed.dart';" + + @Test + fun `create part import`() { + val partImport = PartImport("item_model.freezed.dart") + assertEquals(expectedImport, partImport.toString()) + } +} \ No newline at end of file diff --git a/src/test/kotlin/net/theevilreaper/dartpoet/meta/SpecDataTest.kt b/src/test/kotlin/net/theevilreaper/dartpoet/meta/SpecDataTest.kt new file mode 100644 index 00000000..7b6a7af8 --- /dev/null +++ b/src/test/kotlin/net/theevilreaper/dartpoet/meta/SpecDataTest.kt @@ -0,0 +1,25 @@ +package net.theevilreaper.dartpoet.meta + +import net.theevilreaper.dartpoet.DartModifier +import net.theevilreaper.dartpoet.annotation.AnnotationSpec +import org.junit.Test +import kotlin.test.assertEquals + +class SpecDataTest { + + private var specData: SpecData = SpecData() + + @Test + fun `test annotation add`() { + this.specData.annotation(AnnotationSpec()) + this.specData.annotation { AnnotationSpec() } + assertEquals(2, this.specData.annotations.size) + } + + @Test + fun `test modifier add`() { + this.specData.modifier(DartModifier.LATE) + this.specData.modifier { DartModifier.FINAL } + assertEquals(2, this.specData.modifiers.size) + } +} \ No newline at end of file