Add file headers + Update readme

paul-thebaud · Feb 15, 2018 · d839793 · d839793
1 parent 82eea49
commit d839793
Show file tree

Hide file tree

Showing 122 changed files with 1,102 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,11 @@
 [![Total Downloads][ico-downloads]][link-downloads]
 
 PhpUnitGen is an open source development tool which will help you writing your unit tests for PHPUnit 6 / 7:
-* Generate unit skeleton for all PHP files.
+* Generate unit skeleton for all PHP files including classes, traits, interfaces and global functions.
 * Automatically generate a few simple unit tests (like getter / setter methods tests, class instantiation).
 
+__Version 2 of PhpUnitGen is now available, but be careful, it breaks the PhpUnitGen 1.x.x API.__
+
 ## Package structure
 
 ```
@@ -34,30 +36,30 @@ $ composer require --dev paulthebaud/phpunit-generator ^2.0
 
 `--dev` option is used to install this package only in development environment.
 
-## Basic usage
+## Basic usages
 
 A detailed documentation is available [here](DOCUMENTATION.md), but here is a simple description of usages.
 
-PhpUnitGen basic usage is from command line with the following command.
+PhpUnitGen basic usage is from command line with the following command. Use this command in project root directory.
 
 ```bash
 $ php ./vendor/bin/phpunitgen
 ```
 
-__Note__: All across your generated tests skeletons, you will find `@todo` PHP annotations to complete them.
+__Note__: All across your generated tests skeletons, you will find `@todo` PHP annotations to complete your unit tests.
 
 For this command, you will need a configuration file written in `Yaml`, `Json` or `Php`.
 
 * `Yaml` example is available [here](examples/phpunitgen.config.yml).
 * `Json` example is available [here](examples/phpunitgen.config.json).
 * `Php` example is available [here](examples/phpunitgen.config.php).
 
-By default, PhpUnitGen search for a configuration file named `./phpunitgen.yml`.
+By default, PhpUnitGen search for a configuration file named `phpunitgen.yml` at the project root.
 
 But if you want to use a custom configuration path, you can use an option:
 
 ```bash
-$ php ./vendor/bin/phpunitgen --config=my/custom/config.json
+$ php ./vendor/bin/phpunitgen --config=my/custom/config.yml
 ```
 
 Use PhpUnitGen on one file only:
@@ -72,16 +74,18 @@ Use PhpUnitGen on one directory only:
 $ php ./vendor/bin/phpunitgen --dir source/dir target/dir
 ```
 
-Use PhpUnitGen with default configuration:
+Use PhpUnitGen with default configuration on a file or on a directory:
 
 ```bash
 $ php ./vendor/bin/phpunitgen --default --file source/file.php target/file.php
 $ php ./vendor/bin/phpunitgen --default --dir source/dir target/dir
 ```
 
-PhpUnitGen can also be used online on [this website](https://phpunitgen.heroku.com)
+__Note__: When parsing a directory, PhpUnitGen will also parse sub-directories.
+
+PhpUnitGen can also be used online on [this website](https://phpunitgen.io)
 
-## Testing
+## Running tests
 
 ```bash
 $ composer test

diff --git a/src/Annotation/AbstractAnnotation.php b/src/Annotation/AbstractAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/AnnotationFactory.php b/src/Annotation/AnnotationFactory.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/AnnotationInterface/AnnotationInterface.php b/src/Annotation/AnnotationInterface/AnnotationInterface.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation\AnnotationInterface;
 
 use PhpUnitGen\Exception\AnnotationParseException;

diff --git a/src/Annotation/AnnotationLexer.php b/src/Annotation/AnnotationLexer.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use Doctrine\Common\Lexer\AbstractLexer;

diff --git a/src/Annotation/AnnotationParser.php b/src/Annotation/AnnotationParser.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Exception\AnnotationParseException;

diff --git a/src/Annotation/AnnotationRegister.php b/src/Annotation/AnnotationRegister.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/AssertAnnotation.php b/src/Annotation/AssertAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/ConstructAnnotation.php b/src/Annotation/ConstructAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/GetAnnotation.php b/src/Annotation/GetAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/MockAnnotation.php b/src/Annotation/MockAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/ParamsAnnotation.php b/src/Annotation/ParamsAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/SetAnnotation.php b/src/Annotation/SetAnnotation.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Annotation/TokenConsumer.php b/src/Annotation/TokenConsumer.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Annotation;
 
 use PhpUnitGen\Annotation\AnnotationInterface\AnnotationInterface;

diff --git a/src/Configuration/AbstractConsoleConfigFactory.php b/src/Configuration/AbstractConsoleConfigFactory.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Configuration\ConfigurationInterface\ConsoleConfigInterface;

diff --git a/src/Configuration/BaseConfig.php b/src/Configuration/BaseConfig.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Configuration\ConfigurationInterface\ConfigInterface;

diff --git a/src/Configuration/ConfigurationInterface/ConfigInterface.php b/src/Configuration/ConfigurationInterface/ConfigInterface.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration\ConfigurationInterface;
 
 /**

diff --git a/src/Configuration/ConfigurationInterface/ConsoleConfigInterface.php b/src/Configuration/ConfigurationInterface/ConsoleConfigInterface.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration\ConfigurationInterface;
 
 /**

diff --git a/src/Configuration/ConsoleConfig.php b/src/Configuration/ConsoleConfig.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Configuration\ConfigurationInterface\ConsoleConfigInterface;

diff --git a/src/Configuration/DefaultConsoleConfigFactory.php b/src/Configuration/DefaultConsoleConfigFactory.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Configuration\ConfigurationInterface\ConsoleConfigInterface;

diff --git a/src/Configuration/JsonConsoleConfigFactory.php b/src/Configuration/JsonConsoleConfigFactory.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Exception\InvalidConfigException;

diff --git a/src/Configuration/PhpConsoleConfigFactory.php b/src/Configuration/PhpConsoleConfigFactory.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPUnit Generator.
+ *
+ * (c) 2017-2018 Paul Thébaud <paul.thebaud29@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
 namespace PhpUnitGen\Configuration;
 
 use PhpUnitGen\Exception\InvalidConfigException;