├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── phpunit.xml.dist ├── src └── TestCase.php └── tests ├── includes ├── bootstrap.php ├── docblock-empty.php ├── docblock-missing.php ├── param-array.php ├── param-object.php ├── stub-testcase.php ├── test-classes.php └── testcase.php ├── test-classes.php ├── test-docblock.php ├── test-dogfood.php └── test-params.php /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | /composer.lock 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # run on container environment 2 | sudo: false 3 | 4 | language: php 5 | 6 | notifications: 7 | on_success: change 8 | on_failure: always 9 | 10 | php: 11 | - 8.0 12 | - 7.4 13 | - 7.1 14 | 15 | install: 16 | - composer install --dev --ignore-platform-reqs 17 | 18 | before_script: 19 | - phpenv config-rm xdebug.ini 20 | 21 | script: 22 | - ./vendor/bin/phpunit -v 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License](https://img.shields.io/badge/license-GPL_v2%2B-blue.svg?style=flat-square)](http://opensource.org/licenses/GPL-2.0) 2 | [![Build Status](https://img.shields.io/travis/johnbillion/php-docs-standards/master.svg?style=flat-square)](https://travis-ci.org/johnbillion/php-docs-standards) 3 | 4 | # PHP Documentation Standards Tests 5 | 6 | This abstract PHPUnit test case tests the standards and correctness of the inline documentation of your PHP functions and methods. 7 | 8 | ## What's tested? 9 | 10 | * The docblock should not be missing. 11 | * The docblock description should not be empty. 12 | * The number of `@param` docs should match the actual number of parameters. 13 | * The `@param` description for each parameter should not be empty. 14 | * The `@param` name for each parameter should be correct. 15 | * The `@param` type hint for each parameter should be correct. 16 | * The `@param` description for optional parameters should state that it is optional. 17 | * The `@param` description for required parameters should not state that it is optional. 18 | * The `@param` description for each parameter should state its default value, where appropriate. 19 | 20 | Class-level docblocks are not tested. 21 | 22 | ## Installation 23 | 24 | Requirements: 25 | 26 | * PHP 7 or 8 27 | * PHPUnit 7 or higher 28 | 29 | Add the package to your project's dev dependencies using Composer: 30 | 31 | ```bash 32 | composer require johnbillion/php-docs-standards --dev 33 | ``` 34 | 35 | In your unit test bootstrap file, include the Composer autoloader. This will look something like this: 36 | 37 | ```php 38 | require dirname( dirname( __DIR__ ) ) . '/vendor/autoload.php'; 39 | ``` 40 | 41 | ## Usage 42 | 43 | Add a new test class to your test suite that extends the docs standards test case. The two abstract methods that need to 44 | be implemented are `getTestFunctions()` and `getTestClasses()`. These methods return an array of function names and 45 | class names, respectively, which are to be run through the test suite to test their documentation standards. 46 | 47 | The functions and classes must be loaded (or available for autoloading) in the current request. 48 | 49 | ```php 50 | =7", 13 | "phpdocumentor/reflection-docblock": "~3.0 || ~4.0 || ~5.0" 14 | }, 15 | "require-dev" : { 16 | "phpunit/phpunit": "^7" 17 | }, 18 | "autoload": { 19 | "psr-4": { 20 | "Johnbillion\\DocsStandards\\": "src/" 21 | } 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 11 | 12 | 13 | ./tests/ 14 | 15 | 16 | 17 | 18 | ./ 19 | 20 | ./tests 21 | ./vendor 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/TestCase.php: -------------------------------------------------------------------------------- 1 | function_name = $function[0] . '::' . $function[1] . '()'; 48 | } else { 49 | $ref = new \ReflectionFunction( $function ); 50 | $this->function_name = $function . '()'; 51 | } 52 | 53 | $this->doc_comment = $ref->getDocComment(); 54 | 55 | if ( ! $this->doc_comment ) { 56 | return; 57 | } 58 | 59 | $factory = \phpDocumentor\Reflection\DocBlockFactory::createInstance(); 60 | 61 | $this->docblock = $factory->create( $ref ); 62 | $this->method_params = $ref->getParameters(); 63 | $this->doc_params = $this->docblock->getTagsByName( 'param' ); 64 | 65 | } 66 | 67 | /** 68 | * Test for docblock presence for a function or method. 69 | * 70 | * @dataProvider dataTestFunctions 71 | * 72 | * @param string|array $function The function name, or array of class name and method name. 73 | */ 74 | public function testDocblockIsPresent( $function ) { 75 | 76 | $this->setupFunction( $function ); 77 | 78 | $this->assertNotFalse( $this->doc_comment, sprintf( 79 | self::$docblock_missing, 80 | $this->function_name 81 | ) ); 82 | 83 | } 84 | 85 | /** 86 | * Test for docblock description for a function or method. 87 | * 88 | * @dataProvider dataTestFunctions 89 | * 90 | * @param string|array $function The function name, or array of class name and method name. 91 | */ 92 | public function testDocblockHasDescription( $function ) { 93 | 94 | $this->setupFunction( $function ); 95 | 96 | if ( ! $this->doc_comment ) { 97 | $this->markTestSkipped( 'Missing docblock' ); 98 | } 99 | 100 | $this->assertNotEmpty( $this->docblock->getSummary(), sprintf( 101 | self::$docblock_desc_empty, 102 | $this->function_name 103 | ) ); 104 | 105 | } 106 | 107 | /** 108 | * Test the docblock params list for a function or method. 109 | * 110 | * @dataProvider dataTestFunctions 111 | * 112 | * @param string|array $function The function name, or array of class name and method name. 113 | */ 114 | public function testDocblockParams( $function ) { 115 | 116 | $this->setupFunction( $function ); 117 | 118 | if ( ! $this->docblock->getSummary() ) { 119 | $this->markTestSkipped( 'No docblock' ); 120 | } 121 | 122 | $this->assertSame( count( $this->method_params ), count( $this->doc_params ), sprintf( 123 | self::$param_count_mismatch, 124 | $this->function_name 125 | ) ); 126 | 127 | } 128 | 129 | /** 130 | * A static version of `ReflectionParameter::getName()` that doesn't require the parameter class to be loaded. 131 | * 132 | * This prevents fatal errors when a parameter uses a class name for type hinting but the class is not loaded. 133 | * 134 | * @param \ReflectionParameter $param The parameter reflection object 135 | * @return string The name of the parameter's type hinted object, if there is one. 136 | */ 137 | protected static function getParameterClassName( \ReflectionParameter $param ) { 138 | preg_match( '/\[\s\<\w+?>\s([a-zA-Z0-9_\\\\]+)/s', $param->__toString(), $matches ); 139 | if ( ! isset( $matches[1] ) ) { 140 | return ''; 141 | } 142 | 143 | switch ( $matches[1] ) { 144 | // Allows the shorthand 'bool' type hint: 145 | case 'boolean': 146 | return 'bool'; 147 | break; 148 | // Allows the shorthand 'int' type hint: 149 | case 'integer': 150 | return 'int'; 151 | break; 152 | } 153 | 154 | return $matches[1]; 155 | } 156 | 157 | /** 158 | * Test the params of a function or method. 159 | * 160 | * @dataProvider dataTestFunctions 161 | * 162 | * @param string|array $function The function name, or array of class name and method name. 163 | */ 164 | public function testMethodParams( $function ) { 165 | 166 | $this->setupFunction( $function ); 167 | 168 | if ( ! $this->docblock->getSummary() ) { 169 | $this->markTestSkipped( 'No docblock' ); 170 | } 171 | 172 | if ( empty( $this->method_params ) ) { 173 | $this->assertEmpty( $this->doc_params ); 174 | return; 175 | } 176 | 177 | foreach ( $this->method_params as $i => $param ) { 178 | 179 | $param_doc = $this->doc_params[ $i ]; 180 | $description = $param_doc->getDescription(); 181 | 182 | // @TODO decide how to handle variadic functions 183 | // ReflectionParameter::isVariadic — Checks if the parameter is variadic 184 | 185 | $is_hash = ( ( 0 === strpos( $description, '{' ) ) && ( ( strlen( $description ) - 1 ) === strrpos( $description, '}' ) ) ); 186 | 187 | if ( $is_hash ) { 188 | $lines = explode( "\n", $description ); 189 | $description = $lines[1]; 190 | } 191 | 192 | $this->assertNotEmpty( $description, sprintf( 193 | self::$param_desc_empty, 194 | $param_doc->getVariableName(), 195 | $this->function_name 196 | ) ); 197 | 198 | list( $param_doc_type, $param_doc_name ) = preg_split( '#\s+#', $param_doc->__toString() ); 199 | 200 | $this->assertSame( '$' . $param->getName(), $param_doc_name, sprintf( 201 | self::$param_name_incorrect, 202 | '$' . $param->getName(), 203 | $this->function_name 204 | ) ); 205 | 206 | if ( $param->getType() && $param->getType()->getName() === 'array' ) { 207 | $this->assertRegexp( '/(array|\[\])/', $param_doc_type, sprintf( 208 | self::$param_type_hint_accept_array, 209 | $param_doc->getVariableName(), 210 | $this->function_name 211 | ) ); 212 | } elseif ( ( $param_class = self::getParameterClassName( $param ) ) && ( 'stdClass' !== $param_class ) ) { 213 | $namespaces = explode( '\\', $param_class ); 214 | $param_class = end( $namespaces ); 215 | $this->assertNotFalse( strpos( $param_doc_type, $param_class ), sprintf( 216 | self::$param_type_hint_accept_object, 217 | $param_doc->getVariableName(), 218 | $this->function_name, 219 | $param_class 220 | ) ); 221 | } 222 | 223 | $this->assertFalse( strpos( $param_doc_type, 'callback' ), sprintf( 224 | self::$param_type_hint_disallow_callback, 225 | $param_doc->getVariableName(), 226 | $this->function_name 227 | ) ); 228 | 229 | if ( $param->getType() && $param->getType()->getName() === 'callable' ) { 230 | $this->assertNotFalse( strpos( $param_doc_type, 'callable' ), sprintf( 231 | self::$param_type_hint_accept_callable, 232 | $param_doc->getVariableName(), 233 | $this->function_name 234 | ) ); 235 | } 236 | 237 | if ( $param->isOptional() ) { 238 | $this->assertNotFalse( strpos( $description, 'Optional.' ), sprintf( 239 | self::$param_type_hint_optional, 240 | $param_doc->getVariableName(), 241 | $this->function_name 242 | ) ); 243 | } else { 244 | $this->assertFalse( strpos( $description, 'Optional.' ), sprintf( 245 | self::$param_type_hint_not_optional, 246 | $param_doc->getVariableName(), 247 | $this->function_name 248 | ) ); 249 | } 250 | 251 | if ( $param->isDefaultValueAvailable() && ( array() !== $param->getDefaultValue() ) && ( null !== $param->getDefaultValue() ) ) { 252 | $this->assertNotFalse( strpos( $description, 'Default ' ), sprintf( 253 | self::$param_type_hint_default, 254 | $param_doc->getVariableName(), 255 | $this->function_name 256 | ) ); 257 | } else { 258 | $this->assertFalse( strpos( $description, 'Default ' ), sprintf( 259 | self::$param_type_hint_no_default, 260 | $param_doc->getVariableName(), 261 | $this->function_name 262 | ) ); 263 | } 264 | 265 | } 266 | 267 | } 268 | 269 | public function dataTestFunctions() { 270 | 271 | $data = array(); 272 | 273 | foreach ( $this->getTestFunctions() as $function ) { 274 | 275 | if ( ! function_exists( $function ) ) { 276 | $this->fail( sprintf( 'Function `%s` does not exist.', $function ) ); 277 | } 278 | 279 | $data[] = array( 280 | $function, 281 | ); 282 | 283 | } 284 | 285 | foreach ( $this->getTestClasses() as $class ) { 286 | 287 | if ( ! class_exists( $class, true ) && ! trait_exists( $class, true ) ) { 288 | $this->fail( sprintf( 'Class `%s` does not exist.', $class ) ); 289 | } 290 | 291 | $class_ref = new \ReflectionClass( $class ); 292 | 293 | foreach ( $class_ref->getMethods() as $method_ref ) { 294 | 295 | if ( $method_ref->class !== $class ) { 296 | continue; 297 | } 298 | 299 | $data[] = array( 300 | array( 301 | $class, 302 | $method_ref->getName(), 303 | ), 304 | ); 305 | 306 | } 307 | 308 | } 309 | 310 | return $data; 311 | 312 | } 313 | 314 | } 315 | -------------------------------------------------------------------------------- /tests/includes/bootstrap.php: -------------------------------------------------------------------------------- 1 | markTestSkipped( 'This is a stub test class.' ); 8 | } 9 | 10 | protected function getTestFunctions() { 11 | return array(); 12 | } 13 | 14 | protected function getTestClasses() { 15 | return array(); 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /tests/includes/test-classes.php: -------------------------------------------------------------------------------- 1 | assertContains( $expected, $e->getMessage() ); 33 | 34 | return; 35 | 36 | } 37 | 38 | $this->fail( $fail_message ); 39 | 40 | } 41 | 42 | /** 43 | * Perform a test that is expected to pass. 44 | * 45 | * @param string|array $target_function The function name, or array of class name and method name. 46 | * @param string $test_method The TestCase method to perform the test. 47 | * @param string $fail_message The failure message to use if the test unexpectedly fails. 48 | * @return null 49 | */ 50 | protected function doPassTest( $target_function, $test_method, $fail_message ) { 51 | 52 | $case = new Stub_TestCase; 53 | 54 | try { 55 | 56 | call_user_func( array( $case, $test_method ), $target_function ); 57 | 58 | } catch ( \PHPUnit_Framework_ExpectationFailedException $e ) { 59 | 60 | $this->fail( sprintf( 61 | "%s: Unexpected failure with message '%s'", 62 | $fail_message, 63 | $e->getMessage() 64 | ) ); 65 | 66 | } 67 | 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /tests/test-classes.php: -------------------------------------------------------------------------------- 1 | dataTestFunctions() ); 23 | 24 | $expected = array( 25 | 'private_trait_method', 26 | 'protected_trait_method', 27 | 'public_trait_method', 28 | ); 29 | 30 | $this->assertEquals( $expected, $actual ); 31 | } 32 | 33 | } 34 | -------------------------------------------------------------------------------- /tests/test-docblock.php: -------------------------------------------------------------------------------- 1 | doFailTest( 14 | __NAMESPACE__ . '\docblock_missing', 15 | 'testDocblockIsPresent', 16 | 'Missing docblock passes the test', 17 | \Johnbillion\DocsStandards\TestCase::$docblock_missing 18 | ); 19 | 20 | } 21 | 22 | /** 23 | * Test that non-missing docblocks pass the test. 24 | */ 25 | public function testNonMissingDocblockPasses() { 26 | 27 | require_once __DIR__ . '/includes/docblock-missing.php'; 28 | 29 | $this->doPassTest( 30 | __NAMESPACE__ . '\docblock_not_missing', 31 | 'testDocblockIsPresent', 32 | 'Non-missing docblock fails the test' 33 | ); 34 | 35 | } 36 | 37 | /** 38 | * Test that empty docblocks fail the test. 39 | */ 40 | public function testEmptyDocblockFails() { 41 | 42 | require_once __DIR__ . '/includes/docblock-empty.php'; 43 | 44 | $this->doFailTest( 45 | __NAMESPACE__ . '\docblock_empty', 46 | 'testDocblockHasDescription', 47 | 'Empty docblock passes the test', 48 | \Johnbillion\DocsStandards\TestCase::$docblock_desc_empty 49 | ); 50 | 51 | } 52 | 53 | /** 54 | * Test that non-empty docblocks pass the test. 55 | */ 56 | public function testNonEmptyDocblockPasses() { 57 | 58 | require_once __DIR__ . '/includes/docblock-empty.php'; 59 | 60 | $this->doPassTest( 61 | __NAMESPACE__ . '\docblock_not_empty', 62 | 'testDocblockHasDescription', 63 | 'Non-empty docblock fails the test' 64 | ); 65 | 66 | } 67 | 68 | } 69 | -------------------------------------------------------------------------------- /tests/test-dogfood.php: -------------------------------------------------------------------------------- 1 | doPassTest( 14 | __NAMESPACE__ . '\param_object_class_exists', 15 | 'testMethodParams', 16 | 'Parameter object class not detected' 17 | ); 18 | 19 | $this->doPassTest( 20 | __NAMESPACE__ . '\param_object_class_does_not_exist', 21 | 'testMethodParams', 22 | 'Parameter object class not detected' 23 | ); 24 | 25 | } 26 | 27 | /** 28 | * Test that arrays in parameters are correctly detected. 29 | */ 30 | public function testParameterArrayIsDetected() { 31 | 32 | require_once __DIR__ . '/includes/param-array.php'; 33 | 34 | $this->doPassTest( 35 | __NAMESPACE__ . '\param_array_generic', 36 | 'testMethodParams', 37 | 'Array parameter not detected' 38 | ); 39 | 40 | $this->doPassTest( 41 | __NAMESPACE__ . '\param_array_type', 42 | 'testMethodParams', 43 | 'Array parameter not detected' 44 | ); 45 | 46 | } 47 | 48 | } 49 | --------------------------------------------------------------------------------