diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..56f3b6b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..5c822d7 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,110 @@ +name: CI + +on: + push: + pull_request: + +permissions: + contents: read + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + tests: + name: PHPUnit (PHP ${{ matrix.php }}) + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + php: + - '8.2' + - '8.3' + - '8.4' + - '8.5' + + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: none + tools: composer:v2 + + - name: Validate Composer configuration + run: composer validate --strict + + - name: Install dependencies + run: composer install --no-interaction --no-progress --prefer-dist + + - name: Audit dependencies + run: composer audit + + - name: Run PHPUnit + run: composer test + + quality: + name: Static analysis and formatting + runs-on: ubuntu-latest + + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '8.5' + coverage: none + tools: composer:v2 + + - name: Validate Composer configuration + run: composer validate --strict + + - name: Install dependencies + run: composer install --no-interaction --no-progress --prefer-dist + + - name: Check formatting + run: composer format:check + + - name: Run PHPStan + run: composer analyze:phpstan + + - name: Run Psalm + run: composer analyze:psalm + + coverage: + name: PHPUnit coverage (PHP 8.5) + runs-on: ubuntu-latest + + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up PHP with Xdebug + uses: shivammathur/setup-php@v2 + with: + php-version: '8.5' + coverage: xdebug + tools: composer:v2 + + - name: Validate Composer configuration + run: composer validate --strict + + - name: Install dependencies + run: composer install --no-interaction --no-progress --prefer-dist + + - name: Run PHPUnit with coverage + run: composer test:coverage + + - name: Upload HTML coverage report + uses: actions/upload-artifact@v4 + with: + name: phpunit-coverage-report + path: build/coverage/ + if-no-files-found: error + retention-days: 14 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e66dc72 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/vendor/ +/node_modules/ +/build/ +/.phpunit.cache/ +.php-cs-fixer.cache diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..86b38bd --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,28 @@ +setRiskyAllowed(false) + ->setRules([ + '@PSR12' => true, + 'array_syntax' => ['syntax' => 'short'], + 'ordered_imports' => ['sort_algorithm' => 'alpha'], + 'no_unused_imports' => true, + 'not_operator_with_successor_space' => true, + 'trailing_comma_in_multiline' => ['elements' => ['arrays']], + 'phpdoc_scalar' => true, + 'unary_operator_spaces' => true, + 'binary_operator_spaces' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + ]) + ->setFinder( + (new Finder()) + ->in(__DIR__ . '/src') + ->in(__DIR__ . '/tests') + ); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7659420 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,150 @@ +# Contributing + +TD-PHP is a generic PHP project skeleton focused on test-driven development and a small, explicit quality baseline. + +## Development environment + +Requirements: + +- PHP 8.2+ +- Composer 2.x + +Install dependencies: + +```bash +composer install +``` + +## The development loop + +For behaviour changes, prefer a test-first workflow: + +1. Describe the required behaviour with a test. +2. Run the test and confirm that it fails for the expected reason. +3. Implement the smallest change needed to make it pass. +4. Refactor without changing the behaviour. +5. Run the complete quality gate. + +The important part is not the ceremony. The important part is that the test describes behaviour before the implementation becomes the source of truth. + +## Verification + +Run the complete local check with: + +```bash +composer check-all +``` + +This verifies: + +1. PHP formatting. +2. PHPStan. +3. Psalm. +4. PHPUnit. + +To run individual checks: + +```bash +composer test +composer analyze:phpstan +composer analyze:psalm +composer format:check +``` + +To apply PHP CS Fixer formatting: + +```bash +composer format +``` + +After formatting, run `composer check-all` again. + +## Tests + +Production code belongs in `src/`. Tests belong in `tests/`. + +Use PHPUnit for automated tests. Keep tests deterministic and focused on observable behaviour. + +Prefer: + +- small tests with one clear reason to fail; +- explicit inputs and outputs; +- isolated unit tests where possible; +- integration tests when integration itself is the behaviour under test. + +Avoid coupling tests to implementation details unless the implementation detail is itself part of the contract being verified. + +Coverage is useful for finding untested areas, but TD-PHP does not treat a coverage percentage as a substitute for test quality. + +## Static analysis + +Both PHPStan and Psalm are part of the baseline. + +New production code should pass both analysers. Do not add broad suppressions simply to make the checks green. + +When a warning identifies a real design or typing problem, prefer fixing the underlying code. If a suppression is genuinely necessary, keep it narrow and document why. + +## Formatting + +PHP CS Fixer is the formatting tool for this repository. + +Use: + +```bash +composer format +``` + +to apply formatting, and: + +```bash +composer format:check +``` + +to verify formatting without modifying files. + +Avoid unrelated formatting changes in a functional change. + +## Project structure + +Keep the top-level structure conventional: + +```text +src/ production PHP +tests/ automated tests +``` + +Start with `tests/Unit/` when unit tests are appropriate. Add other test categories only when the project needs them. + +Do not introduce framework-specific directories or infrastructure into the skeleton itself. + +## Dependencies and tooling + +The baseline intentionally contains four development tools: + +- PHPUnit +- PHPStan +- Psalm +- PHP CS Fixer + +Do not add another testing or analysis tool merely because it is popular. Add infrastructure only when the project has a demonstrated need for it. + +Likewise, do not remove one of the baseline tools without an explicit decision to change TD-PHP's purpose. + +## Pull requests + +A good change should: + +- solve one coherent problem; +- keep the change as small as practical; +- include or update tests when behaviour changes; +- preserve compatibility unless a breaking change is intentional; +- keep the skeleton generic; +- update documentation when the development workflow changes. + +Before opening a pull request, run: + +```bash +composer check-all +``` + +Then review the final diff for generated files, accidental dependencies, and unrelated changes. diff --git a/LICENSE b/LICENSE index f288702..36b66a5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - 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 -. +MIT License + +Copyright (c) 2026 Sina Kuhestani + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 5ec528d..994c62d 100644 --- a/README.md +++ b/README.md @@ -1 +1,270 @@ -# Nex \ No newline at end of file +# TD-PHP + +TD-PHP is a **generic PHP project skeleton for test-driven development (TDD)**. + +The goal is simple: start a new PHP project with a conventional structure and the essential development-quality tooling already configured, so you can start writing tests and production code immediately. + +TD-PHP is intentionally **not** a framework, CMS plugin, application, or domain-specific starter. It contains no WordPress integration and no frontend toolchain. + +## What you get + +TD-PHP starts with four development tools: + +- **PHPUnit** — automated tests. +- **PHPStan** — static analysis. +- **Psalm** — a second, independent static-analysis pass. +- **PHP CS Fixer** — deterministic PHP formatting. + +They are already wired into Composer scripts, so the normal workflow is straightforward: + +```bash +composer install +composer check-all +``` + +The skeleton targets **PHP 8.2+**. + +## Why this skeleton exists + +A new PHP project should not have to spend its first day deciding how to install PHPUnit, how to structure tests, how to run static analysis, or how to enforce formatting. + +TD-PHP provides that baseline from the beginning. + +It is designed for a workflow where tests are part of development rather than something added after the implementation: + +1. Write a failing test. +2. Implement the smallest change that makes it pass. +3. Refactor while keeping the test suite green. +4. Run static analysis and formatting checks. +5. Repeat. + +The repository does not try to prescribe an application architecture. It gives you the development foundation and leaves the domain design to the project. + +## Requirements + +- PHP 8.2 or newer. +- Composer 2.x. +- For HTML coverage reports: **Xdebug** or **PCOV** enabled in the PHP environment. + +Install dependencies: + +```bash +composer install +``` + +## Customising the skeleton + +TD-PHP is a starting point, not a fixed architecture. After copying or using the skeleton for a real project, review these configuration points. + +| Area | Where | What you can change | +| --- | --- | --- | +| Project identity | `composer.json` | Package name, description, keywords, homepage, and authors. | +| PHP version | `composer.json` | Change the `php` constraint to the versions your project supports. | +| Namespace | `composer.json` | Replace `App\\` with your project's production namespace. | +| Test namespace | `composer.json` | Replace `Tests\\` if your test namespace follows a different convention. | +| Dependencies | `composer.json` | Add the runtime and development packages your project actually needs. | +| Test layout | `phpunit.xml` | Change the test-suite directories or add additional suites. | +| PHPStan scope/level | `phpstan.neon` | Change analysed paths and the analysis level to match the project. | +| Psalm scope/strictness | `psalm.xml` | Change analysed directories and error level as the project evolves. | +| Formatting rules | `.php-cs-fixer.dist.php` | Adjust the fixer rules and directories to match the project's coding standard. | +| Coverage | `composer.json` / PHPUnit config | Keep coverage diagnostic, or add a project-specific coverage policy if one is justified. | +| CI PHP versions | `.github/workflows/ci.yml` | Change the supported PHP matrix and the PHP version used for quality checks. | +| CI checks | `.github/workflows/ci.yml` | Add, remove, or split jobs when the project's verification requirements change. | + +### Namespace and package identity + +The skeleton uses: + +```text +App\\ => src/ +Tests\\ => tests/ +``` + +For a real project, replace these placeholders with the project's actual namespaces and update the corresponding directories if necessary. + +### Static-analysis strictness + +PHPStan starts at level 8 and analyses `src/`. Psalm analyses both `src/` and `tests/` because PHPUnit discovers test classes at runtime and they are still useful to analyse. + +If a project needs a different balance between adoption effort and strictness, adjust the analyser configuration deliberately. Prefer fixing real findings over adding broad suppressions. + +### Formatting policy + +PHP CS Fixer provides the repository's baseline formatting rules. Projects can change the rule set, allow or forbid risky rules, and change which directories are formatted. + +Keep formatting changes intentional: the skeleton should enforce a consistent policy, not continually rewrite unrelated code. + +### CI matrix and quality gate + +The CI workflow currently tests PHPUnit against PHP 8.2 through 8.5 and runs static analysis and formatting checks on PHP 8.5. + +If your project supports a different PHP range, update the matrix accordingly. If a tool has compatibility requirements that differ from the runtime matrix, keep those concerns explicit rather than silently relying on one PHP version. + +## Development commands + +### Write and run unit tests + +Tests are written with PHPUnit. Before adding tests, read the [official PHPUnit documentation](https://docs.phpunit.de/en/11.5/writing-tests-for-phpunit.html), especially its guidance on writing tests and assertions. + +Add unit tests under `tests/Unit/` and run them with: + +```bash +composer test +``` + +### Run tests with HTML coverage + +```bash +composer test:coverage +``` + +The report is generated under `build/coverage/`. + +This command requires a code-coverage driver. Install and enable either [Xdebug](https://xdebug.org/docs/install) or [PCOV](https://github.com/krakjoe/pcov) for the PHP environment running PHPUnit. The GitHub Actions workflow also runs this command with Xdebug enabled and uploads the HTML report as a workflow artifact. + +Coverage is provided as a diagnostic tool. TD-PHP does not impose an arbitrary coverage percentage: meaningful tests matter more than maximising a number. + +### Run PHPStan + +```bash +composer analyze:phpstan +``` + +PHPStan analyses the production source tree. + +### Run Psalm + +```bash +composer analyze:psalm +``` + +Psalm provides an independent static-analysis pass over the production and test source trees. + +### Check formatting + +Without modifying files: + +```bash +composer format:check +``` + +Apply formatting: + +```bash +composer format +``` + +### Check dependencies for known vulnerabilities + +```bash +composer audit +``` + +The CI workflow runs this check after installing dependencies. It reports known security advisories affecting the resolved dependency versions; it does not guarantee that dependencies are free of all vulnerabilities. + +### Dependency lock file + +This repository is a reusable project template and intentionally does not commit `composer.lock`. When you create a real project from the template, run `composer install` to resolve dependencies, then commit the generated `composer.lock` in that project so its dependency versions are reproducible. + +### Run the complete quality gate + +```bash +composer check-all +``` + +This runs, in order: + +1. PHP CS Fixer verification. +2. PHPStan. +3. Psalm. +4. PHPUnit. + +The verification command does not rewrite source files. + +## Project structure + +```text +. +├── src/ +│ └── Example.php +├── tests/ +│ └── Unit/ +│ └── ExampleTest.php +├── .editorconfig +├── .gitignore +├── .php-cs-fixer.dist.php +├── composer.json +├── phpstan.neon +├── phpunit.xml +├── psalm.xml +├── CONTRIBUTING.md +├── LICENSE +└── README.md +``` + +### Source code + +Production PHP belongs under `src/`. + +The Composer autoloader uses the placeholder namespace: + +```text +App\\ => src/ +``` + +When starting a real project, replace `App\\` with the project's actual namespace and package name. + +### Tests + +Tests belong under `tests/`. + +The example test lives under `tests/Unit/` to establish a conventional starting point. As a project grows, additional test categories can be introduced where they are justified, for example: + +```text +tests/ +├── Unit/ +├── Integration/ +└── Functional/ +``` + +Do not create test categories just for the sake of having directories. The test structure should follow the system being tested. + +## TDD starting point + +The repository includes one deliberately small example: + +- `src/Example.php` contains a minimal class. +- `tests/Unit/ExampleTest.php` tests its observable behaviour. + +The example exists to prove that the skeleton works immediately after installation and to show where production code and tests belong. It is not intended to be an application architecture. + +For a real project, replace or remove the example and begin with the behaviour you actually need. + +## Tooling policy + +TD-PHP deliberately starts with four tools and keeps their responsibilities separate: + +| Tool | Responsibility | +| --- | --- | +| PHPUnit | Tests and test execution | +| PHPStan | Static analysis | +| Psalm | Independent static analysis | +| PHP CS Fixer | Formatting | + +No frontend tooling, WordPress-specific tooling, framework, test runner, mutation-testing system, or additional analysis framework is required by the baseline. + +The purpose is not to maximise the number of tools. The purpose is to make a new PHP codebase testable and maintainable from its first commit. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for the development and verification workflow. + +Before submitting a change: + +```bash +composer check-all +``` + +## License + +TD-PHP is licensed under the MIT License. See [LICENSE](LICENSE). diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..9e8c53f --- /dev/null +++ b/composer.json @@ -0,0 +1,65 @@ +{ + "name": "ephpicman/td-php", + "description": "A test-driven PHP project skeleton with PHPUnit, PHPStan, Psalm, and PHP CS Fixer preconfigured.", + "type": "project", + "license": "MIT", + "keywords": [ + "php", + "skeleton", + "template", + "test-driven-development", + "testing", + "phpunit", + "phpstan", + "psalm", + "php-cs-fixer" + ], + "homepage": "https://github.com/EphpicMan/TD-PHP", + "support": { + "issues": "https://github.com/EphpicMan/TD-PHP/issues", + "source": "https://github.com/EphpicMan/TD-PHP" + }, + "authors": [ + { + "name": "Sina Kuhestani", + "email": "sinakuhestani@gmail.com", + "homepage": "https://github.com/EphpicMan", + "role": "Developer" + } + ], + "autoload": { + "psr-4": { + "App\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Tests\\": "tests/" + } + }, + "require": { + "php": "^8.2" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.95", + "phpstan/phpstan": "^2.2", + "phpunit/phpunit": "^11.5", + "vimeo/psalm": "^6.16" + }, + "scripts": { + "test": "phpunit", + "test:coverage": "phpunit --coverage-html build/coverage", + "analyze:phpstan": "phpstan analyze", + "analyze:psalm": "psalm", + "format": "php-cs-fixer fix", + "format:check": "php-cs-fixer fix --dry-run --diff --verbose", + "check-all": [ + "@format:check", + "@analyze:phpstan", + "@analyze:psalm", + "@test" + ] + }, + "minimum-stability": "stable", + "prefer-stable": true +} diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..1ff472c --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,4 @@ +parameters: + level: 8 + paths: + - src diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..19ecb69 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,20 @@ + + + + + + tests + + + + + + src + + + diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..d88bbc5 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,16 @@ + + + + + + + + + + diff --git a/src/Example.php b/src/Example.php new file mode 100644 index 0000000..bb77aa8 --- /dev/null +++ b/src/Example.php @@ -0,0 +1,13 @@ +greet('TD-PHP')); + } +}