diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..57872d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/vendor/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..72f1361 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Change Log + +All notable changes to this publication will be documented in this file. + +## 1.0.1 - 2017-??-?? +The validate command returns an evaluable return code. + +## 1.0.0 - 2017-25-01 + +First stable release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ebd1858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index c5a4fae..d8f096a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,10 @@ This publication describes a standard filesystem skeleton suitable for all PHP packages. -Please see for background information. +Please see for background +information. + +Command-line tools for `validating` or `generating` PDS conform packages which are included with this standard are documented [here](./docs/tools.md). The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be @@ -11,53 +14,60 @@ interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119). ## Summary -A package MUST use the following names for the following kinds of directories -and files: - -``` -bin/ # command-line executables -config/ # configuration files -docs/ # documentation and examples -public/ # web server files -src/ # source code -tests/ # test code -vendor/ # reserved for package managers -CHANGELOG # a log of changes between releases -CONTRIBUTING # guidelines for contributors -LICENSE # licensing information -README # information about the package itself -``` +A package MUST use these names for these root-level directories: + +| If a package has a root-level directory for ... | ... then it MUST be named: | +| ----------------------------------------------- | -------------------------- | +| command-line executables | `bin/` | +| configuration files | `config/` | +| documentation files | `docs/` | +| web server files | `public/` | +| other resource files | `resources/` | +| PHP source code | `src/` | +| test code | `tests/` | + +A package MUST use these names for these root-level files: + +| If a package has a root-level file for ... | ... then it MUST be named: | +| ----------------------------------------------- | -------------------------- | +| a log of changes between releases | `CHANGELOG(.*)` | +| guidelines for contributors | `CONTRIBUTING(.*)` | +| licensing information | `LICENSE(.*)` | +| information about the package itself | `README(.*)` | + +A package SHOULD include a root-level file indicating the licensing and +copyright terms of the package contents. ## Root-Level Directories ### bin/ -If the package provides a directory for command-line executable files, it MUST -be named `bin/`. +If the package provides a root-level directory for command-line executable +files, it MUST be named `bin/`. This publication does not otherwise define the structure and contents of the directory. ### config/ -If the package provides a directory for configuration files, it MUST be named -`config/`. +If the package provides a root-level directory for configuration files, it MUST +be named `config/`. This publication does not otherwise define the structure and contents of the directory. ### docs/ -If the package provides a directory for documentation files, it MUST be named -`docs/`. +If the package provides a root-level directory for documentation files, it MUST +be named `docs/`. This publication does not otherwise define the structure and contents of the directory. ### public/ -If the package provides a directory for web server files, it MUST be named -`public/`. +If the package provides a root-level directory for web server files, it MUST be +named `public/`. This publication does not otherwise define the structure and contents of the directory. @@ -67,30 +77,26 @@ directory. > code, copied or symlinked to the "real" document root, or otherwise managed so > that they become publicly available on the web. -### src/ +### resources/ -If the package provides a directory for source code files, it MUST be named -`src/`. +If the package provides a root-level directory for other resource files, it MUST +be named `resources/`. This publication does not otherwise define the structure and contents of the directory. -### tests/ +### src/ -If the package provides a directory for test files, it MUST be named `tests/`. +If the package provides a root-level directory for PHP source code files, it +MUST be named `src/`. This publication does not otherwise define the structure and contents of the directory. -### vendor/ - -The `vendor/` directory MUST be reserved for use by package managers (e.g.: -Composer). - -It MUST be ignored by revision control tools (e.g.: Git, Mercurial, Subversion, -etc.). +### tests/ -It MUST NOT be committed to revision control repositories. +If the package provides a root-level directory for test files, it MUST be named +`tests/`. This publication does not otherwise define the structure and contents of the directory. @@ -100,15 +106,15 @@ directory. The package MAY contain other root-level directories for purposes not described by this publication. -This publication does not define the structure and contents of other root-level -directories. +This publication does not define the structure and contents of the other +root-level directories. ## Root-Level Files ### CHANGELOG -If the package provides a file with a list of changes since the last release or -version, it MUST be named `CHANGELOG`. +If the package provides a root-level file with a list of changes since the last +release or version, it MUST be named `CHANGELOG`. It MAY have a lowercase filename extension indicating the file format. @@ -117,8 +123,8 @@ file. ### CONTRIBUTING -If the package provides a file that describes how to contribute to the package, -it MUST be named `CONTRIBUTING`. +If the package provides a root-level file that describes how to contribute to +the package, it MUST be named `CONTRIBUTING`. It MAY have a lowercase filename extension indicating the file format. @@ -127,8 +133,12 @@ file. ### LICENSE -If the package provides a file with licensing information, it MUST be named -`LICENSE`. +Whereas package consumers might be in violation of copyright law when copying +unlicensed intellectual property, the package SHOULD include a root-level file +indicating the licensing and copyright terms of the package contents. + +If the package provides a root-level file indicating the licensing and copyright +terms of the package contents, it MUST be named `LICENSE`. It MAY have a lowercase filename extension indicating the file format. @@ -137,8 +147,8 @@ file. ### README -If the package provides a file with information about the package itself, it -MUST be named `README`. +If the package provides a root-level file with information about the package +itself, it MUST be named `README`. It MAY have a lowercase filename extension indicating the file format. @@ -150,5 +160,5 @@ file. The package MAY contain other root-level files for purposes not described in this publication. -This publication does not otherwise define the structure and contents of the -other root-level files. +This publication does not define the structure and contents of the other +root-level files. diff --git a/bin/pds-skeleton b/bin/pds-skeleton new file mode 100755 index 0000000..8cd285f --- /dev/null +++ b/bin/pds-skeleton @@ -0,0 +1,26 @@ +#!/usr/bin/env php +execute($argv); +$executeState === true ? exit(0) : exit(1); diff --git a/composer.json b/composer.json index b272835..f065ffa 100644 --- a/composer.json +++ b/composer.json @@ -3,5 +3,16 @@ "type": "standard", "description": "Standard for PHP package skeletons.", "homepage": "https://github.com/php-pds/skeleton", - "license": "CC-BY-SA-4.0" + "license": "CC-BY-SA-4.0", + "autoload": { + "psr-4": { + "Pds\\Skeleton\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Pds\\Skeleton\\": "tests/" + } + }, + "bin": ["bin/pds-skeleton"] } diff --git a/docs/tools.md b/docs/tools.md new file mode 100644 index 0000000..26f1b27 --- /dev/null +++ b/docs/tools.md @@ -0,0 +1,19 @@ +# Command-Line Tools + +## Validator + +Validate your project's compliance by following these steps: + +- Install package in your project: `composer require --dev pds/skeleton` +- Run the validator: `vendor/bin/pds-skeleton validate [path]` + +If no path is specified, the project in which pds-skeleton is installed will be used. + +## Generator + +Generate a compliant package skeleton by following these steps: + +- Install package in your project: `composer require --dev pds/skeleton` +- Run the generator: `vendor/bin/pds-skeleton generate [path]` + +If no path is specified, the project in which pds-skeleton is installed will be used. diff --git a/src/ComplianceValidator.php b/src/ComplianceValidator.php new file mode 100644 index 0000000..b739deb --- /dev/null +++ b/src/ComplianceValidator.php @@ -0,0 +1,329 @@ +getFiles($root); + $results = $this->validate($lines); + $this->outputResults($results); + return $this->getCompliant(); + } + + public function getCompliant() + { + return $this->compliant; + } + + public function validate($lines) + { + $complianceTests = [ + "Command-line executables" => $this->checkBin($lines), + "Configuration files" => $this->checkConfig($lines), + "Documentation files" => $this->checkDocs($lines), + "Web server files" => $this->checkPublic($lines), + "Other resource files" => $this->checkResources($lines), + "PHP source code" => $this->checkSrc($lines), + "Test code" => $this->checkTests($lines), + "Log of changes between releases" => $this->checkChangelog($lines), + "Guidelines for contributors" => $this->checkContributing($lines), + "Licensing information" => $this->checkLicense($lines), + "Information about the package itself" => $this->checkReadme($lines), + ]; + + $results = []; + foreach ($complianceTests as $label => $complianceResult) { + $state = $complianceResult[0]; + $expected = $complianceResult[1]; + $actual = $complianceResult[2]; + + if ($expected !== $actual && ($state == self::STATE_INCORRECT_PRESENT || $state == self::STATE_RECOMMENDED_NOT_PRESENT)) { + $this->compliant = false; + } + + $results[$expected] = [ + 'label' => $label, + 'state' => $state, + 'expected' => $expected, + 'actual' => $actual, + ]; + } + return $results; + } + + /** + * Get list of files and directories previously set, or generate from parent project. + */ + public function getFiles($root = null) + { + $root = $root ?: __DIR__ . '/../../../../'; + $root = realpath($root); + + if ($this->files == null) { + $files = scandir($root); + foreach ($files as $i => $file) { + if (is_dir("$root/$file")) { + $files[$i] .= "/"; + } + } + $this->files = $files; + } + + return $this->files; + } + + public function outputResults($results) + { + foreach ($results as $result) { + $this->outputResultLine($result['label'], $result['state'], $result['expected'], $result['actual']); + } + } + + protected function outputResultLine($label, $complianceState, $expected, $actual) + { + $messages = [ + self::STATE_OPTIONAL_NOT_PRESENT => "Optional {$expected} not present", + self::STATE_CORRECT_PRESENT => "Correct {$actual} present", + self::STATE_INCORRECT_PRESENT => "Incorrect {$actual} present", + self::STATE_RECOMMENDED_NOT_PRESENT => "Recommended {$expected} not present", + ]; + echo $this->colorConsoleText("- " . $label . ": " . $messages[$complianceState], $complianceState) . PHP_EOL; + } + + protected function colorConsoleText($text, $complianceState) + { + $colors = [ + self::STATE_OPTIONAL_NOT_PRESENT => "\033[43;30m", + self::STATE_CORRECT_PRESENT => "\033[42;30m", + self::STATE_INCORRECT_PRESENT => "\033[41m", + self::STATE_RECOMMENDED_NOT_PRESENT => "\033[41m", + ]; + if (!array_key_exists($complianceState, $colors)) { + return $text; + } + return $colors[$complianceState] . " " . $text . " \033[0m"; + } + + protected function checkDir($lines, $pass, array $fail) + { + foreach ($lines as $line) { + $line = trim($line); + if ($line == $pass) { + return [self::STATE_CORRECT_PRESENT, $pass, $line]; + } + if (in_array($line, $fail)) { + return [self::STATE_INCORRECT_PRESENT, $pass, $line]; + } + } + return [self::STATE_OPTIONAL_NOT_PRESENT, $pass, null]; + } + + protected function checkFile($lines, $pass, array $fail, $state = self::STATE_OPTIONAL_NOT_PRESENT) + { + foreach ($lines as $line) { + $line = trim($line); + if (preg_match("/^{$pass}(\.[a-z]+)?$/", $line)) { + return [self::STATE_CORRECT_PRESENT, $pass, $line]; + } + foreach ($fail as $regex) { + if (preg_match($regex, $line)) { + return [self::STATE_INCORRECT_PRESENT, $pass, $line]; + } + } + } + return [$state, $pass, null]; + } + + protected function checkChangelog($lines) + { + return $this->checkFile($lines, 'CHANGELOG', [ + '/^.*CHANGLOG.*$/i', + '/^.*CAHNGELOG.*$/i', + '/^WHATSNEW(\.[a-z]+)?$/i', + '/^RELEASE((_|-)?NOTES)?(\.[a-z]+)?$/i', + '/^RELEASES(\.[a-z]+)?$/i', + '/^CHANGES(\.[a-z]+)?$/i', + '/^CHANGE(\.[a-z]+)?$/i', + '/^HISTORY(\.[a-z]+)?$/i', + ]); + } + + protected function checkContributing($lines) + { + return $this->checkFile($lines, 'CONTRIBUTING', [ + '/^DEVELOPMENT(\.[a-z]+)?$/i', + '/^README\.CONTRIBUTING(\.[a-z]+)?$/i', + '/^DEVELOPMENT_README(\.[a-z]+)?$/i', + '/^CONTRIBUTE(\.[a-z]+)?$/i', + '/^HACKING(\.[a-z]+)?$/i', + ]); + } + + protected function checkLicense($lines) + { + return $this->checkFile( + $lines, + 'LICENSE', + [ + '/^.*EULA.*$/i', + '/^.*(GPL|BSD).*$/i', + '/^([A-Z-]+)?LI(N)?(S|C)(E|A)N(S|C)(E|A)(_[A-Z_]+)?(\.[a-z]+)?$/i', + '/^COPY(I)?NG(\.[a-z]+)?$/i', + '/^COPYRIGHT(\.[a-z]+)?$/i', + ], + self::STATE_RECOMMENDED_NOT_PRESENT + ); + } + + protected function checkReadme($lines) + { + return $this->checkFile($lines, 'README', [ + '/^USAGE(\.[a-z]+)?$/i', + '/^SUMMARY(\.[a-z]+)?$/i', + '/^DESCRIPTION(\.[a-z]+)?$/i', + '/^IMPORTANT(\.[a-z]+)?$/i', + '/^NOTICE(\.[a-z]+)?$/i', + '/^GETTING(_|-)STARTED(\.[a-z]+)?$/i', + ]); + } + + protected function checkBin($lines) + { + return $this->checkDir($lines, 'bin/', [ + 'cli/', + 'scripts/', + 'console/', + 'shell/', + 'script/', + ]); + } + + protected function checkConfig($lines) + { + return $this->checkDir($lines, 'config/', [ + 'etc/', + 'settings/', + 'configuration/', + 'configs/', + '_config/', + 'conf/', + ]); + } + + protected function checkDocs($lines) + { + return $this->checkDir($lines, 'docs/', [ + 'manual/', + 'documentation/', + 'usage/', + 'doc/', + 'guide/', + 'phpdoc/', + 'apidocs/', + 'apidoc/', + 'api-reference/', + 'user_guide/', + 'manuals/', + 'phpdocs/', + ]); + } + + protected function checkPublic($lines) + { + return $this->checkDir($lines, 'public/', [ + 'assets/', + 'static/', + 'html/', + 'httpdocs/', + 'media/', + 'docroot/', + 'css/', + 'fonts/', + 'styles/', + 'style/', + 'js/', + 'javascript/', + 'images/', + 'site/', + 'mysite/', + 'img/', + 'web/', + 'pub/', + 'webroot/', + 'www/', + 'htdocs/', + 'asset/', + 'public_html/', + 'publish/', + 'pages/', + 'javascripts/', + 'icons/', + 'imgs/', + 'wwwroot/', + 'font/', + ]); + } + + protected function checkSrc($lines) + { + return $this->checkDir($lines, 'src/', [ + 'exception/', + 'exceptions/', + 'src-files/', + 'traits/', + 'interfaces/', + 'common/', + 'sources/', + 'php/', + 'inc/', + 'libraries/', + 'autoloads/', + 'autoload/', + 'source/', + 'includes/', + 'include/', + 'lib/', + 'libs/', + 'library/', + 'code/', + 'classes/', + 'func/', + 'src-dev/', + ]); + } + + protected function checkTests($lines) + { + return $this->checkDir($lines, 'tests/', [ + 'test/', + 'unit-tests/', + 'phpunit/', + 'testing/', + 'unittest/', + 'unit_tests/', + 'unit_test/', + 'phpunit-tests/', + ]); + } + + protected function checkResources($lines) + { + return $this->checkDir($lines, 'resources/', [ + 'Resources/', + 'res/', + 'resource/', + 'Resource/', + 'ressources/', + 'Ressources/', + ]); + } +} diff --git a/src/Console.php b/src/Console.php new file mode 100644 index 0000000..a1eeec9 --- /dev/null +++ b/src/Console.php @@ -0,0 +1,44 @@ + 'Pds\Skeleton\ComplianceValidator', + 'generate' => 'Pds\Skeleton\PackageGenerator', + 'test' => 'Pds\Skeleton\TestRunner', + ]; + + public function execute($args) + { + if (count($args) > 1) { + + $executable = array_shift($args); + $commandName = array_shift($args); + + if (array_key_exists($commandName, $this->commandsWhitelist)) { + return $this->executeCommand($this->commandsWhitelist[$commandName], $args); + } + + $this->outputHelp(); + return false; + } + + $this->outputHelp(); + return false; + } + + protected function executeCommand($commandClass, $args) + { + $command = new $commandClass(); + return $command->execute(...$args); + } + + protected function outputHelp() + { + echo 'Available commands:' . PHP_EOL; + foreach ($this->commandsWhitelist as $key => $value) { + echo 'pds-skeleton ' . $key . PHP_EOL; + } + } +} diff --git a/src/PackageGenerator.php b/src/PackageGenerator.php new file mode 100644 index 0000000..29b4451 --- /dev/null +++ b/src/PackageGenerator.php @@ -0,0 +1,61 @@ +getFiles($root); + $validatorResults = $validator->validate($lines); + $files = $this->createFiles($validatorResults, $root); + $this->outputResults($files); + return true; + } + + public function createFiles($validatorResults, $root = null) + { + $root = $root ?: __DIR__ . '/../../../../'; + $root = realpath($root); + + $files = $this->createFileList($validatorResults); + $createdFiles = []; + + foreach ($files as $i => $file) { + $isDir = substr($file, -1, 1) == '/'; + if ($isDir) { + $path = $root . '/' . substr($file, 0, -1); + $createdFiles[$file] = $path; + mkdir($path, 0755); + continue; + } + $path = $root . '/' . $file . '.md'; + $createdFiles[$file] = $file . '.md'; + file_put_contents($path, ''); + chmod($path, 0644); + } + + return $createdFiles; + } + + public function createFileList($validatorResults) + { + $files = []; + foreach ($validatorResults as $label => $complianceResult) { + if (in_array($complianceResult['state'], [ + ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT, + ComplianceValidator::STATE_RECOMMENDED_NOT_PRESENT, + ])) { + $files[$label] = $complianceResult['expected']; + } + } + return $files; + } + + public function outputResults($results) + { + foreach ($results as $file) { + echo "Created {$file}" . PHP_EOL; + } + } +} diff --git a/src/TestRunner.php b/src/TestRunner.php new file mode 100644 index 0000000..f603c3c --- /dev/null +++ b/src/TestRunner.php @@ -0,0 +1,11 @@ +testValidate_WithIncorrectBin_ReturnsIncorrectBin(); + $tester->testValidate_WithNonCompliance_SetsNonCompliantState(); + $tester->testValidate_WithCompliance_SetsCompliantState(); + echo __CLASS__ . " errors: {$tester->numErrors}" . PHP_EOL; + } + + public function testValidate_WithIncorrectBin_ReturnsIncorrectBin() + { + $paths = [ + 'cli/', + 'src/', + ]; + + $validator = new ComplianceValidator(); + $results = $validator->validate($paths); + + foreach ($results as $expected => $result) { + if ($expected == "bin/") { + if ($result['state'] != ComplianceValidator::STATE_INCORRECT_PRESENT) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_INCORRECT_PRESENT" . PHP_EOL; + } + continue; + } + if ($expected == "src/") { + if ($result['state'] != ComplianceValidator::STATE_CORRECT_PRESENT) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_CORRECT_PRESENT" . PHP_EOL; + } + continue; + } + if ($expected == "LICENSE") { + if ($result['state'] != ComplianceValidator::STATE_RECOMMENDED_NOT_PRESENT) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_RECOMMENDED_NOT_PRESENT" . PHP_EOL; + } + continue; + } + if ($result['state'] != ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected state of {$result['expected']} to be STATE_OPTIONAL_NOT_PRESENT" . PHP_EOL; + continue; + } + } + } + + public function testValidate_WithNonCompliance_SetsNonCompliantState() + { + $paths = [ + 'cli/', + 'test/', + ]; + + $validator = new ComplianceValidator(); + $results = $validator->validate($paths); + + if ($validator->getCompliant() == true) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected a non compliant state" . PHP_EOL; + } + } + + public function testValidate_WithCompliance_SetsCompliantState() + { + $paths = [ + 'bin/', + 'tests/', + 'LICENSE.md', + ]; + + $validator = new ComplianceValidator(); + $results = $validator->validate($paths); + + if ($validator->getCompliant() == false) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected a compliant state" . PHP_EOL; + } + } +} diff --git a/tests/PackageGeneratorTest.php b/tests/PackageGeneratorTest.php new file mode 100644 index 0000000..7c1fd25 --- /dev/null +++ b/tests/PackageGeneratorTest.php @@ -0,0 +1,41 @@ +testGenerate_WithMissingBin_ReturnsBin(); + echo __CLASS__ . " errors: {$tester->numErrors}" . PHP_EOL; + } + + public function testGenerate_WithMissingBin_ReturnsBin() + { + $validatorResults = [ + 'bin/' => [ + 'state' => ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT, + 'expected' => 'bin/', + ], + 'config/' => [ + 'state' => ComplianceValidator::STATE_INCORRECT_PRESENT, + 'expected' => 'config/', + ], + ]; + + $generator = new PackageGenerator(); + $files = $generator->createFileList($validatorResults); + + if (!array_key_exists('bin/', $files)) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected bin/ to be present" . PHP_EOL; + } + + if (array_key_exists('config/', $files)) { + $this->numErrors++; + echo __FUNCTION__ . ": Expected config/ to be absent" . PHP_EOL; + } + } +} \ No newline at end of file