├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json ├── laravel-package ├── phpunit.xml ├── src ├── ConsoleApplication.php ├── Exceptions │ ├── DirectoryAlreadyExistsException.php │ └── InvalidPackageNameException.php ├── GeneratePackageCommand.php ├── PackageGenerator.php └── Process.php ├── template ├── .gitignore.stub ├── CHANGELOG.md.stub ├── LICENSE.stub ├── README.md.stub ├── composer.json.stub ├── config │ └── config.php.stub ├── license │ ├── apache20.stub │ ├── gnu_gpl_v3.stub │ └── mit.stub ├── phpunit.xml.stub ├── src │ └── PackageServiceProvider.php.stub └── tests │ └── TestCase.php.stub └── tests ├── GenerateLicenseTest.php ├── GeneratePackageCommandTest.php ├── PackageGeneratorTest.php └── __snapshots__ ├── GenerateLicenseTest__it_creates_apache_2_0_license__1.php ├── GenerateLicenseTest__it_creates_gnu_gpl_v_3_license__1.php ├── GenerateLicenseTest__it_creates_mit_license__1.php ├── GenerateLicenseTest__it_generates_empty_file_if_no_option_set__1.php ├── PackageGeneratorTest__it_generates_composer_json__1.json └── PackageGeneratorTest__it_generates_config_file__1.php /.gitignore: -------------------------------------------------------------------------------- 1 | vendor/ 2 | .idea/ 3 | composer.lock 4 | .php_cs.cache 5 | build/ 6 | dummy-package -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | CHANGELOG 2 | === 3 | 4 | This changelog contains all notable change of this project 5 | 6 | 1.2.0 7 | --- 8 | 9 | ### Changes 10 | 11 | - the template drops support for Laravel 5.4 and adds support for Laravel 5.6 12 | - the components are now running with Symfony 4 components 13 | 14 | 1.1.0 15 | --- 16 | 17 | ### New features 18 | 19 | - **Pass a path:** You can now pass a path as an argument. The generator will then use this path as the base path for generating the package. 20 | - **Adds `--no-config` flag**: You can now add this flag to prevent generating config directory. If you do not pass that flag, a `config.php` file will be created that returns an empty array. 21 | - **Generate a LICENSE**: Previously an empty `LICENSE` file was created. Now you can choose between `MIT`, `Apache 2.0` & `GNU GPL v3` by adding the `--license` option. If you don't pass that option the LICENSE file will still be empty. 22 | 23 | ### Bugfixes 24 | 25 | - Fixes the bug that the `composer.json` was missing a comma between two dependencies, so that running `composer install` was impossible 26 | 27 | 1.0.4: Small fixes 28 | --- 29 | This release fixes 30 | - that the wrong version was shown on `laravel-package --version` 31 | - that `illuminate/support` was missing as a dependency in the composer file 32 | - that Aheenam was still references in the README file 33 | 34 | 1.0.3 Fixes composer bug 35 | --- 36 | Fixes that composer returns following error 37 | 38 | `Error while installing aheenam/laravel-package-cli, composer-plugin packages should have a class defined in their extra key to be usable.` 39 | 40 | 1.0.1 41 | --- 42 | Fixes some little issues of first release: 43 | 44 | 1. Fixes wrong installation instruction 45 | 2. Fixes typo in composer.json 46 | 47 | 1.0.0 48 | --- 49 | The first release containing following featuers: 50 | 51 | 1. Generate a new package with `laravel-package generate` 52 | 2. Adds a `--force` flag to ignore existing files -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Aheenam 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Laravel Package CLI 2 | === 3 | 4 | This project delivers a simple set of Console Commands to generate a directory structure for laravel package development. 5 | 6 | For example simply create the complete directory structure for a new package by calling `laravel-package generate vendor/package-name` 7 | 8 | Installation 9 | --- 10 | Install this command as a global composer package 11 | 12 | ```bash 13 | $ composer global require aheenam/laravel-package-cli 14 | ``` 15 | 16 | Usage 17 | --- 18 | 19 | You can then create a new repository by calling the following command: 20 | 21 | ```bash 22 | $ laravel-package generate vendor/package-name 23 | ``` 24 | 25 | This command will create a directory named `package-name` and will setup a basic setup for creating a Laravel package. 26 | 27 | The directory structure will look like following: 28 | 29 | ```bash 30 | ├── database/ 31 | │ ├── .gitkeep 32 | ├── config/ 33 | │ ├── package-name.php 34 | ├── src/ 35 | │ ├── PackageNameServiceProvider.php 36 | ├── tests/ 37 | │ ├── TestCase.php 38 | ├── .gitignore 39 | ├── CHANGELOG.md 40 | ├── composer.json 41 | ├── LICENSE 42 | ├── phpunit.xml 43 | ├── README.md 44 | 45 | ``` 46 | 47 | All the files and classes will have set the correct names and namespaces, but remember that the generator is just creating a starting point. You should go through the files and add stuff that is missing. 48 | 49 | ### Pass a custom path 50 | 51 | You can also pass an second argument specifying the path where the packages should be generated. 52 | 53 | ```bash 54 | $ laravel-package generate vendor/package-name packages/aheenam/ 55 | ``` 56 | 57 | Above example would generate the package at `./packages/aheenam/packages-name`. This can be handy if you want to use this generator within an existing Laravel project. 58 | 59 | ### The `--force` option 60 | 61 | By default you will get an error notice if a directory with given package name already exists. You can ignore existing directories by using the `--force` flag: 62 | 63 | ```bash 64 | $ laravel-package generate vendor/package-name --force 65 | ``` 66 | 67 | ### Install composer dependecies 68 | 69 | Using the `--install` flag, you can enforce that, after the generation of the package is done, the command changes into the new directory and runs `composer install` to install the dependecies. 70 | 71 | ### Generate a LICENSE 72 | 73 | You can pass an option to not only create an empty LICENSE file, but also populate it with the appropriate LICENSE content. 74 | 75 | ```bash 76 | $ laravel-package generate vendor/package-name --license=MIT 77 | ``` 78 | 79 | Currently there are 3 LICENSE types implemented: `MIT`, `Apache 2.0` and `GNU GPL v3`. Just pass the names and you should get your LICENSE generated. 80 | 81 | Changelog 82 | --- 83 | Check [CHANGELOG](CHANGELOG.md) for the changelog 84 | 85 | Testing 86 | --- 87 | To run tests use 88 | 89 | ```bash 90 | $ composer test 91 | ``` 92 | 93 | If you are working on a windows machine use 94 | 95 | ```bash 96 | vendor\bin\phpunit 97 | ``` 98 | 99 | Contributing 100 | --- 101 | *Information will follow soon* 102 | 103 | 104 | Security 105 | --- 106 | If you discover any security related issues, please email rathes@aheenam.com or use the issue tracker of GitHub. 107 | 108 | About 109 | --- 110 | Aheenam is a small company from NRW, Germany creating custom digital solutions. Visit [our website](https://aheenam.com) to find out more about us. 111 | 112 | License 113 | --- 114 | The MIT License (MIT). Please see [License File](https://github.com/Aheenam/laravel-translatable/blob/master/LICENSE) 115 | for more information. -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "aheenam/laravel-package-cli", 3 | "description": "A small CLI to scaffold packages for Laravel framework", 4 | "require": { 5 | "php": "^7.0", 6 | "symfony/console": "^4.0", 7 | "symfony/var-dumper": "^4.0", 8 | "league/flysystem": "^1.0", 9 | "nesbot/carbon": "^1.22", 10 | "symfony/process": "^4.1" 11 | }, 12 | "require-dev": { 13 | "phpunit/phpunit": "^7.0", 14 | "league/flysystem-memory": "^1.0", 15 | "spatie/phpunit-snapshot-assertions": "^1.1" 16 | }, 17 | "autoload": { 18 | "psr-4": { 19 | "Aheenam\\LaravelPackageCli\\": "src" 20 | } 21 | }, 22 | "autoload-dev": { 23 | "psr-4": { 24 | "Aheenam\\LaravelPackageCli\\Test\\": "tests" 25 | } 26 | }, 27 | "scripts": { 28 | "test": "vendor/bin/phpunit" 29 | }, 30 | "bin": [ 31 | "laravel-package" 32 | ], 33 | "license": "MIT", 34 | "authors": [ 35 | { 36 | "name": "Rathes Sachchithananthan", 37 | "email": "rathes@aheenam.com" 38 | } 39 | ], 40 | "minimum-stability": "stable" 41 | } 42 | -------------------------------------------------------------------------------- /laravel-package: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | 3 | run(); 14 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 12 | 13 | 14 | tests 15 | 16 | 17 | 18 | 19 | src/ 20 | 21 | 22 | -------------------------------------------------------------------------------- /src/ConsoleApplication.php: -------------------------------------------------------------------------------- 1 | add(new GeneratePackageCommand()); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/Exceptions/DirectoryAlreadyExistsException.php: -------------------------------------------------------------------------------- 1 | setName('generate') 27 | ->setDescription('Generate a structure for your Laravel package') 28 | ->addArgument('name', InputArgument::REQUIRED, 'The name of the package.') 29 | ->addArgument('path', InputArgument::OPTIONAL, 'Path where the package should be created.') 30 | ->addOption('license', null, InputOption::VALUE_OPTIONAL, 'License that should be generated') 31 | ->addOption('force', 'f', InputOption::VALUE_NONE, 'Overrides existing directories') 32 | ->addOption('no-config', null, InputOption::VALUE_NONE, 'Prevents from creating a config directory.') 33 | ->addOption('install', null, InputOption::VALUE_NONE, 'Run composer install after generating the package.'); 34 | } 35 | 36 | /** 37 | * @param InputInterface $input 38 | * @param OutputInterface $output 39 | * 40 | * @return int|null|void 41 | */ 42 | protected function execute(InputInterface $input, OutputInterface $output) 43 | { 44 | $io = new SymfonyStyle($input, $output); 45 | 46 | $packageName = $input->getArgument('name'); 47 | $path = $input->hasArgument('path') ? $input->getArgument('path') : '/'; 48 | 49 | $projectName = explode('/', $packageName)[1]; 50 | 51 | try { 52 | $filesystem = new Filesystem(new Local(getcwd())); 53 | $generator = new PackageGenerator($filesystem, $path, $packageName, [ 54 | 'force' => $input->getOption('force'), 55 | 'no-config' => $input->getOption('no-config'), 56 | 'license' => $input->getOption('license'), 57 | ]); 58 | } catch (InvalidPackageNameException $e) { 59 | $io->error("$packageName is not a valid package name"); 60 | 61 | return; 62 | } catch (DirectoryAlreadyExistsException $e) { 63 | $io->error($projectName.' already exists.'); 64 | 65 | return; 66 | } 67 | 68 | $io->title('Generating Laravel Package'); 69 | if ($input->getOption('license') !== null) { 70 | $license = $input->getOption('license'); 71 | $io->writeln("Added LICENSE $license"); 72 | } 73 | $generator->generate(); 74 | 75 | if ($input->getOption('install')) { 76 | (new Process())->run("cd $path/$projectName; composer install"); 77 | } 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /src/PackageGenerator.php: -------------------------------------------------------------------------------- 1 | filesystem = $filesystem; 97 | $this->path = $path; 98 | $this->options = $options; 99 | 100 | list($this->vendorName, $this->packageName) = $this->resolvePackageName($packageName); 101 | 102 | if ($this->filesystem->has($this->path.$this->packageName) && 103 | (isset($this->options['force']) && !$this->options['force'] || !isset($this->options['force']))) { 104 | throw new DirectoryAlreadyExistsException(); 105 | } 106 | 107 | $this->packagePath = $this->path.$this->packageName.'/'; 108 | 109 | $this->template = new Filesystem(new Local(__DIR__.'/../template/')); 110 | 111 | $this->manager = new MountManager([ 112 | 'template' => $this->template, 113 | 'package' => $filesystem, 114 | ]); 115 | 116 | $this->baseFiles = [ 117 | '.gitignore', 118 | 'CHANGELOG.md', 119 | 'README.md', 120 | ]; 121 | 122 | // create package info 123 | $this->packageInformation = $this->buildPackageInformation(); 124 | } 125 | 126 | /** 127 | * runs all needed generation methods. 128 | * 129 | * @return void 130 | */ 131 | public function generate() 132 | { 133 | // create package directory 134 | $this->filesystem->createDir($this->path.$this->packageName); 135 | 136 | // generate the base files 137 | $this->generateBaseFiles(); 138 | 139 | // generate config file 140 | $this->generateConfigFile(); 141 | 142 | // generate ServiceProvider 143 | $this->generateServiceProvider(); 144 | 145 | // generate the LICENSE 146 | $this->generateLicense(); 147 | 148 | // generate test based files 149 | $this->generateTestFiles(); 150 | 151 | // generate composer.json 152 | $this->generateComposerJson(); 153 | } 154 | 155 | /** 156 | * generates the base files by copying, name replacing 157 | * and renaming them. 158 | * 159 | * @return void 160 | */ 161 | public function generateBaseFiles() 162 | { 163 | 164 | // copy base files stubs and edit them properly 165 | foreach ($this->baseFiles as $fileName) { 166 | // copy the stub 167 | $this->manager->copy("template://$fileName.stub", "package://$this->packagePath/$fileName.stub"); 168 | 169 | // update files content 170 | $this->updateFileContent($this->packagePath.$fileName.'.stub'); 171 | 172 | // rename 173 | $this->filesystem->rename($this->packagePath.$fileName.'.stub', $this->packagePath.$fileName); 174 | } 175 | 176 | // generate directories 177 | $this->filesystem->write($this->packagePath.'database/.gitkeep', ''); 178 | } 179 | 180 | /** 181 | * generates the config file. 182 | * 183 | * @return void 184 | */ 185 | public function generateConfigFile() 186 | { 187 | 188 | // check --no-config flag 189 | if (isset($this->options['no-config']) && $this->options['no-config']) { 190 | return; 191 | } 192 | 193 | // copy the stub 194 | $this->manager->copy( 195 | 'template://config/config.php.stub', 196 | "package://$this->packagePath/config/config.php.stub" 197 | ); 198 | 199 | // rename file 200 | $this->filesystem->rename( 201 | $this->packagePath.'config/config.php.stub', 202 | $this->packagePath.'config/'.$this->packageName.'.php' 203 | ); 204 | } 205 | 206 | /** 207 | * Generates the content of the LICENSE if one is selected. 208 | */ 209 | public function generateLicense() 210 | { 211 | // check if license is set 212 | if (!isset($this->options['license']) || $this->options['license'] === '') { 213 | $this->filesystem->write($this->packagePath.'LICENSE', ''); 214 | 215 | return; 216 | } 217 | 218 | switch (strtolower($this->options['license'])) { 219 | case 'mit': 220 | $this->manager->copy( 221 | 'template://license/mit.stub', 222 | "package://$this->packagePath/LICENSE.stub" 223 | ); 224 | break; 225 | case 'apache 2.0': 226 | $this->manager->copy( 227 | 'template://license/apache20.stub', 228 | "package://$this->packagePath/LICENSE.stub" 229 | ); 230 | break; 231 | case 'gnu gpl v3': 232 | $this->manager->copy( 233 | 'template://license/gnu_gpl_v3.stub', 234 | "package://$this->packagePath/LICENSE.stub" 235 | ); 236 | break; 237 | default: 238 | return; 239 | } 240 | 241 | // update files content 242 | $this->updateFileContent($this->packagePath.'LICENSE.stub'); 243 | 244 | // rename file 245 | $this->filesystem->rename( 246 | $this->packagePath.'LICENSE.stub', 247 | $this->packagePath.'LICENSE' 248 | ); 249 | } 250 | 251 | /** 252 | * Creates the service provider. 253 | * 254 | * @return void 255 | */ 256 | public function generateServiceProvider() 257 | { 258 | // copy the stub 259 | $this->manager->copy( 260 | 'template://src/PackageServiceProvider.php.stub', 261 | "package://$this->packagePath/src/PackageServiceProvider.php.stub" 262 | ); 263 | 264 | // update files content 265 | $this->updateFileContent("{$this->packagePath}/src/PackageServiceProvider.php.stub"); 266 | 267 | // rename file 268 | $this->filesystem->rename( 269 | $this->packagePath.'src/PackageServiceProvider.php.stub', 270 | $this->packagePath.'src/'.$this->packageInformation['serviceProvider'].'.php' 271 | ); 272 | } 273 | 274 | /** 275 | * Creates the files for testing purposes. 276 | * 277 | * @return void 278 | */ 279 | public function generateTestFiles() 280 | { 281 | $this->filesystem->createDir($this->packagePath.'tests'); 282 | 283 | // copy the stubs 284 | $this->manager->copy( 285 | 'template://tests/TestCase.php.stub', 286 | "package://$this->packagePath/tests/TestCase.php.stub" 287 | ); 288 | $this->manager->copy( 289 | 'template://phpunit.xml.stub', 290 | "package://$this->packagePath/phpunit.xml.stub" 291 | ); 292 | 293 | // update file contents 294 | $this->updateFileContent("{$this->packagePath}/tests/TestCase.php.stub"); 295 | $this->updateFileContent("{$this->packagePath}/phpunit.xml.stub"); 296 | 297 | // rename files 298 | $this->filesystem->rename( 299 | $this->packagePath.'tests/TestCase.php.stub', 300 | $this->packagePath.'tests/TestCase.php' 301 | ); 302 | 303 | $this->filesystem->rename( 304 | $this->packagePath.'phpunit.xml.stub', 305 | $this->packagePath.'phpunit.xml' 306 | ); 307 | } 308 | 309 | /** 310 | * Create the composer.json file. 311 | * 312 | * @return void 313 | */ 314 | public function generateComposerJson() 315 | { 316 | // copy the stub 317 | $this->manager->copy( 318 | 'template://composer.json.stub', 319 | "package://$this->packagePath/composer.json.stub" 320 | ); 321 | 322 | // update file contents 323 | $this->updateFileContent("{$this->packagePath}/composer.json.stub"); 324 | 325 | // rename files 326 | $this->filesystem->rename( 327 | $this->packagePath.'composer.json.stub', 328 | $this->packagePath.'composer.json' 329 | ); 330 | } 331 | 332 | /** 333 | * replaces the names in the given file. 334 | * 335 | * @param $file 336 | * 337 | * @return void 338 | */ 339 | protected function updateFileContent($file) 340 | { 341 | $contents = $this->filesystem->read($file); 342 | 343 | foreach ($this->packageInformation as $field => $info) { 344 | $contents = str_replace('${'.$field.'}', $info, $contents); 345 | } 346 | 347 | $this->filesystem->update($file, $contents); 348 | } 349 | 350 | /** 351 | * builds information about package that is written in 352 | * the stubs. 353 | * 354 | * @return array 355 | */ 356 | protected function buildPackageInformation() 357 | { 358 | $serviceProviderName = $this->kebabToCapitalize($this->packageName).'ServiceProvider'; 359 | 360 | return [ 361 | 'namespace' => ucfirst($this->vendorName).'\\'.$this->kebabToCapitalize($this->packageName), 362 | 'serviceProvider' => $serviceProviderName, 363 | 'packageName' => $this->packageName, 364 | 'vendorName' => ucfirst($this->vendorName), 365 | 'fullPackageName' => strtolower($this->vendorName).'/'.strtolower($this->packageName), 366 | 'composerNamespace' => ucfirst($this->vendorName).'\\\\'.$this->kebabToCapitalize($this->packageName), 367 | 'currentYear' => Carbon::now()->year, 368 | ]; 369 | } 370 | 371 | /** 372 | * @param $string 373 | * 374 | * @return string 375 | */ 376 | protected function kebabToCapitalize($string) 377 | { 378 | return str_replace( 379 | ' ', 380 | '', 381 | ucwords( 382 | str_replace( 383 | '-', 384 | ' ', 385 | $string 386 | ) 387 | ) 388 | ); 389 | } 390 | 391 | /** 392 | * @param string $packageName 393 | * 394 | * @return array 395 | */ 396 | protected function resolvePackageName($packageName) 397 | { 398 | $packageParts = explode('/', $packageName); 399 | 400 | if (count($packageParts) !== 2) { 401 | throw new InvalidPackageNameException(); 402 | } 403 | 404 | return $packageParts; 405 | } 406 | } 407 | -------------------------------------------------------------------------------- /src/Process.php: -------------------------------------------------------------------------------- 1 | run(function ($type, $buffer) { 13 | echo $buffer; 14 | }); 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /template/.gitignore.stub: -------------------------------------------------------------------------------- 1 | vendor/ 2 | .idea/ 3 | composer.lock 4 | .php_cs.cache 5 | build/ -------------------------------------------------------------------------------- /template/CHANGELOG.md.stub: -------------------------------------------------------------------------------- 1 | CHANGELOG 2 | === 3 | 4 | This changelog contains all notable change of the ${packageName} package -------------------------------------------------------------------------------- /template/LICENSE.stub: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aheenam/laravel-package-cli/32e4bf11f26a9e613d0579fdaa3f0adec82ba6d3/template/LICENSE.stub -------------------------------------------------------------------------------- /template/README.md.stub: -------------------------------------------------------------------------------- 1 | ${packageName} 2 | === 3 | 4 | Installation 5 | --- 6 | You can install the package via composer: 7 | 8 | ```bash 9 | composer require // add code here 10 | ``` 11 | 12 | If you are using Laravel in a version < 5.5, the service provider must be registered as a next step: 13 | 14 | ```php 15 | // config/app.php 16 | 'providers' => [ 17 | ... 18 | // add code here 19 | ]; 20 | ``` 21 | 22 | Usage 23 | --- 24 | 25 | 26 | Changelog 27 | --- 28 | Check [CHANGELOG](CHANGELOG.md) for the changelog 29 | 30 | Testing 31 | --- 32 | To run tests use 33 | 34 | $ composer test 35 | 36 | Contributing 37 | --- 38 | 39 | 40 | Security 41 | --- 42 | If you discover any security related issues, please email or use the issue tracker of GitHub. 43 | 44 | About 45 | --- 46 | 47 | License 48 | --- 49 | The MIT License (MIT). Please see [License File](LICENSE) for more information. -------------------------------------------------------------------------------- /template/composer.json.stub: -------------------------------------------------------------------------------- 1 | { 2 | "name": "${fullPackageName}", 3 | "description": "A Laravel Package", 4 | "license": "MIT", 5 | "authors": [ 6 | ], 7 | "minimum-stability": "stable", 8 | "require": { 9 | "php" : "^7.1", 10 | "illuminate/support": "~5.6.0|~5.7.0" 11 | }, 12 | "require-dev": { 13 | "phpunit/phpunit": "^6.3|^7.0", 14 | "orchestra/testbench": "~3.6.0|~3.7.0" 15 | }, 16 | "autoload": { 17 | "psr-4": { 18 | "${composerNamespace}\\": "src" 19 | } 20 | }, 21 | "autoload-dev": { 22 | "psr-4": { 23 | "${composerNamespace}\\Test\\": "tests" 24 | } 25 | }, 26 | "extra": { 27 | "laravel": { 28 | "providers": [ 29 | "${composerNamespace}\\${serviceProvider}" 30 | ] 31 | } 32 | }, 33 | "scripts": { 34 | "test": "vendor/bin/phpunit", 35 | "test:windows": "vendor\\bin\\phpunit" 36 | } 37 | } -------------------------------------------------------------------------------- /template/config/config.php.stub: -------------------------------------------------------------------------------- 1 | 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /template/license/mit.stub: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) ${currentYear} ${vendorName} 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /template/phpunit.xml.stub: -------------------------------------------------------------------------------- 1 | 2 | 12 | 13 | 14 | tests 15 | 16 | 17 | 18 | 19 | src/ 20 | 21 | 22 | -------------------------------------------------------------------------------- /template/src/PackageServiceProvider.php.stub: -------------------------------------------------------------------------------- 1 | loadMigrationsFrom(__DIR__ . '/../database/migrations/'); 24 | } 25 | 26 | 27 | /** 28 | * Register the service provider. 29 | * 30 | * @return void 31 | */ 32 | public function register() 33 | { 34 | } 35 | } -------------------------------------------------------------------------------- /template/tests/TestCase.php.stub: -------------------------------------------------------------------------------- 1 | set('database.default', 'testing'); 40 | $app['config']->set('database.connections.testing', [ 41 | 'driver' => 'sqlite', 42 | 'database' => ':memory:', 43 | 'prefix' => '', 44 | ]); 45 | } 46 | } -------------------------------------------------------------------------------- /tests/GenerateLicenseTest.php: -------------------------------------------------------------------------------- 1 | deleteDir('dummy-package'); 21 | } 22 | 23 | /** @test */ 24 | public function it_generates_empty_file_if_no_option_set() 25 | { 26 | $filesystem = new Filesystem(new MemoryAdapter()); 27 | 28 | (new PackageGenerator($filesystem, './', 'dummy/dummy-package')) 29 | ->generate(); 30 | 31 | $this->assertTrue($filesystem->has('/dummy-package')); 32 | $this->assertTrue($filesystem->has('/dummy-package/LICENSE')); 33 | $this->assertMatchesSnapshot($filesystem->read('/dummy-package/LICENSE')); 34 | } 35 | 36 | /** @test */ 37 | public function it_creates_mit_license() 38 | { 39 | $filesystem = new Filesystem(new MemoryAdapter()); 40 | Carbon::setTestNow(Carbon::create(2002, 5, 21, 12)); 41 | 42 | (new PackageGenerator($filesystem, './', 'dummy/dummy-package', ['license' => 'MIT'])) 43 | ->generateLicense(); 44 | 45 | $this->assertTrue($filesystem->has('/dummy-package/LICENSE')); 46 | 47 | $licenseContent = $filesystem->read('/dummy-package/LICENSE'); 48 | $this->assertMatchesSnapshot($licenseContent); 49 | $this->assertContains('Copyright (c) 2002 Dummy', $licenseContent); 50 | } 51 | 52 | /** @test */ 53 | public function it_creates_apache_2_0_license() 54 | { 55 | $filesystem = new Filesystem(new MemoryAdapter()); 56 | Carbon::setTestNow(Carbon::create(2002, 5, 21, 12)); 57 | 58 | (new PackageGenerator($filesystem, './', 'dummy/dummy-package', ['license' => 'Apache 2.0'])) 59 | ->generateLicense(); 60 | 61 | $this->assertTrue($filesystem->has('/dummy-package/LICENSE')); 62 | 63 | $licenseContent = $filesystem->read('/dummy-package/LICENSE'); 64 | $this->assertMatchesSnapshot($licenseContent); 65 | } 66 | 67 | /** @test */ 68 | public function it_creates_gnu_gpl_v_3_license() 69 | { 70 | $filesystem = new Filesystem(new MemoryAdapter()); 71 | Carbon::setTestNow(Carbon::create(2002, 5, 21, 12)); 72 | 73 | (new PackageGenerator($filesystem, './', 'dummy/dummy-package', ['license' => 'GNU GPL v3'])) 74 | ->generateLicense(); 75 | 76 | $this->assertTrue($filesystem->has('/dummy-package/LICENSE')); 77 | 78 | $licenseContent = $filesystem->read('/dummy-package/LICENSE'); 79 | $this->assertMatchesSnapshot($licenseContent); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /tests/GeneratePackageCommandTest.php: -------------------------------------------------------------------------------- 1 | deleteDir('dummy-package'); 20 | 21 | (new Filesystem(new Local(__DIR__.'/../'))) 22 | ->deleteDir('packages'); 23 | } 24 | 25 | /** @test */ 26 | public function it_executes_command() 27 | { 28 | $commandTester = $this->executeCommand([ 29 | 'name' => 'dummy/dummy-package', 30 | ]); 31 | 32 | // the output of the command in the console 33 | $output = $commandTester->getDisplay(); 34 | $this->assertContains('Generating Laravel Package', $output); 35 | } 36 | 37 | /** @test */ 38 | public function command_fails_if_no_name_was_provided() 39 | { 40 | $this->expectException(RuntimeException::class); 41 | $this->executeCommand([]); 42 | } 43 | 44 | /** @test */ 45 | public function command_fails_if_directory_already_exists() 46 | { 47 | 48 | // fake dir 49 | (new Filesystem(new Local(__DIR__.'/../'))) 50 | ->createDir('dummy-package'); 51 | 52 | $commandTester = $this->executeCommand([ 53 | 'name' => 'dummy/dummy-package', 54 | ]); 55 | 56 | // the output of the command in the console 57 | $output = $commandTester->getDisplay(); 58 | $this->assertContains('dummy-package already exists', $output); 59 | $this->assertNotContains('Generating Laravel Package', $output); 60 | } 61 | 62 | /** @test */ 63 | public function command_overrides_if_force_is_set_true() 64 | { 65 | 66 | // fake dir 67 | (new Filesystem(new Local(__DIR__.'/../'))) 68 | ->createDir('dummy-package'); 69 | 70 | $commandTester = $this->executeCommand([ 71 | 'name' => 'dummy/dummy-package', 72 | '--force' => true, 73 | ]); 74 | 75 | // the output of the command in the console 76 | $output = $commandTester->getDisplay(); 77 | $this->assertNotContains('dummy-package already exists', $output); 78 | $this->assertContains('Generating Laravel Package', $output); 79 | } 80 | 81 | /** @test */ 82 | public function command_fails_if_name_not_valid() 83 | { 84 | $commandTester = $this->executeCommand([ 85 | 'name' => 'dummy/dummy-package/test', 86 | ]); 87 | 88 | $output = $commandTester->getDisplay(); 89 | $this->assertContains('dummy/dummy-package/test is not a valid package name', $output); 90 | $this->assertNotContains('Generating Laravel Package', $output); 91 | } 92 | 93 | /** @test */ 94 | public function command_passes_path_to_generator() 95 | { 96 | $commandTester = $this->executeCommand([ 97 | 'name' => 'dummy/dummy-package', 98 | 'path' => './packages/aheenam/', 99 | '--force' => true, 100 | ]); 101 | 102 | $output = $commandTester->getDisplay(); 103 | $this->assertContains('Generating Laravel Package', $output); 104 | $this->assertTrue( 105 | (new Filesystem(new Local(__DIR__.'/../'))) 106 | ->has('/packages/aheenam/dummy-package/composer.json') 107 | ); 108 | } 109 | 110 | /** @test */ 111 | public function command_does_not_create_config_dir_if_flag_set() 112 | { 113 | $commandTester = $this->executeCommand([ 114 | 'name' => 'dummy/dummy-package', 115 | '--no-config' => true, 116 | ]); 117 | 118 | $output = $commandTester->getDisplay(); 119 | $this->assertContains('Generating Laravel Package', $output); 120 | $this->assertFalse( 121 | (new Filesystem(new Local(__DIR__.'/../'))) 122 | ->has('/dummy-package/config/dummy-package.php') 123 | ); 124 | } 125 | 126 | /** @test */ 127 | public function command_passes_license_option() 128 | { 129 | Carbon::setTestNow(Carbon::create(2002, 5, 21, 12)); 130 | 131 | $commandTester = $this->executeCommand([ 132 | 'name' => 'dummy/dummy-package', 133 | '--license' => 'MIT', 134 | ]); 135 | 136 | $output = $commandTester->getDisplay(); 137 | $this->assertContains('Generating Laravel Package', $output); 138 | $this->assertContains('Added LICENSE MIT', $output); 139 | 140 | $filesystem = new Filesystem(new Local(__DIR__.'/../')); 141 | 142 | $this->assertTrue($filesystem->has('/dummy-package/LICENSE')); 143 | $this->assertContains('Copyright (c) 2002 Dummy', $filesystem->read('./dummy-package/LICENSE')); 144 | } 145 | 146 | /** @test */ 147 | public function command_runs_install_process_when_flag_passed() 148 | { 149 | $commandTester = $this->executeCommand([ 150 | 'name' => 'dummy/dummy-package', 151 | 'path' => './packages/aheenam/', 152 | '--install' => true, 153 | ]); 154 | 155 | $this->assertTrue( 156 | (new Filesystem(new Local(__DIR__.'/../'))) 157 | ->has('/packages/aheenam/dummy-package/vendor/') 158 | ); 159 | } 160 | 161 | /** @test */ 162 | public function command_does_not_run_install_process_when_flag_not_passed() 163 | { 164 | $commandTester = $this->executeCommand([ 165 | 'name' => 'dummy/dummy-package', 166 | 'path' => './packages/aheenam/', 167 | ]); 168 | 169 | $this->assertFalse( 170 | (new Filesystem(new Local(__DIR__.'/../'))) 171 | ->has('/packages/aheenam/dummy-package/vendor/') 172 | ); 173 | } 174 | 175 | /** 176 | * helper to execute the command for given options. 177 | * 178 | * @param $options array 179 | * 180 | * @return CommandTester 181 | */ 182 | protected function executeCommand($options) 183 | { 184 | $application = new Application(); 185 | $application->add(new GeneratePackageCommand()); 186 | 187 | $command = $application->find('generate'); 188 | $commandTester = new CommandTester($command); 189 | $commandTester->execute(array_merge([ 190 | 'command' => $command->getName(), 191 | ], $options)); 192 | 193 | return $commandTester; 194 | } 195 | } 196 | -------------------------------------------------------------------------------- /tests/PackageGeneratorTest.php: -------------------------------------------------------------------------------- 1 | deleteDir('dummy-package'); 22 | } 23 | 24 | /** @test */ 25 | public function it_throws_exception_on_name_validation_fail() 26 | { 27 | $this->expectException(InvalidPackageNameException::class); 28 | $filesystem = new Filesystem(new MemoryAdapter()); 29 | 30 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package/asdf')) 31 | ->generate(); 32 | } 33 | 34 | /** @test */ 35 | public function it_throws_exception_if_directory_exists() 36 | { 37 | $this->expectException(DirectoryAlreadyExistsException::class); 38 | $filesystem = new Filesystem(new MemoryAdapter()); 39 | $filesystem->createDir('/dummy-package'); 40 | 41 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 42 | ->generate(); 43 | } 44 | 45 | /** @test */ 46 | public function it_overrides_directory_if_force_flag_set() 47 | { 48 | $filesystem = new Filesystem(new MemoryAdapter()); 49 | $filesystem->createDir('/dummy-package'); 50 | 51 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package', ['force' => true])) 52 | ->generate(); 53 | 54 | $this->assertTrue($filesystem->has('/dummy-package/composer.json')); 55 | } 56 | 57 | /** @test */ 58 | public function it_generates_package_on_given_path() 59 | { 60 | $filesystem = new Filesystem(new MemoryAdapter()); 61 | 62 | (new PackageGenerator($filesystem, './packages/aheenam/', 'dummy/dummy-package')) 63 | ->generate(); 64 | 65 | $this->assertTrue($filesystem->has('/packages/aheenam/dummy-package/composer.json')); 66 | } 67 | 68 | /** @test */ 69 | public function it_generates_base_files() 70 | { 71 | $filesystem = new Filesystem(new MemoryAdapter()); 72 | 73 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 74 | ->generateBaseFiles(); 75 | 76 | $this->assertHasFile($filesystem, 'dummy-package'); 77 | $this->assertHasFile($filesystem, 'dummy-package/.gitignore'); 78 | $this->assertHasFile($filesystem, 'dummy-package/CHANGELOG.md'); 79 | $this->assertHasFile($filesystem, 'dummy-package/README.md'); 80 | 81 | $contents = $filesystem->read('dummy-package/README.md'); 82 | $templateContent = file_get_contents(__DIR__.'/../template/README.md.stub'); 83 | $templateContent = str_replace('${packageName}', 'dummy-package', $templateContent); 84 | $this->assertEquals($templateContent, $contents); 85 | 86 | $this->assertHasFile($filesystem, 'dummy-package/database/.gitkeep'); 87 | } 88 | 89 | /** @test */ 90 | public function it_generates_config_file() 91 | { 92 | $filesystem = new Filesystem(new MemoryAdapter()); 93 | 94 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 95 | ->generateConfigFile(); 96 | 97 | $this->assertHasFile($filesystem, 'dummy-package/config/dummy-package.php'); 98 | 99 | $contents = $filesystem->read('dummy-package/config/dummy-package.php'); 100 | $this->assertMatchesSnapshot($contents); 101 | } 102 | 103 | /** @test */ 104 | public function it_does_not_generate_config_file_if_flag_is_set() 105 | { 106 | $filesystem = new Filesystem(new MemoryAdapter()); 107 | 108 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package', ['no-config' => true])) 109 | ->generateConfigFile(); 110 | 111 | $this->assertFalse($filesystem->has('dummy-package/config/dummy-package.php')); 112 | } 113 | 114 | /** @test */ 115 | public function it_generates_service_provider() 116 | { 117 | $filesystem = new Filesystem(new MemoryAdapter()); 118 | 119 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 120 | ->generateServiceProvider(); 121 | 122 | $this->assertHasFile($filesystem, 'dummy-package/src/DummyPackageServiceProvider.php'); 123 | 124 | $contents = $filesystem->read('/dummy-package/src/DummyPackageServiceProvider.php'); 125 | $this->assertContains('DummyPackageServiceProvider', $contents); 126 | } 127 | 128 | /** @test */ 129 | public function it_generates_test_files() 130 | { 131 | $filesystem = new Filesystem(new MemoryAdapter()); 132 | 133 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 134 | ->generateTestFiles(); 135 | 136 | $this->assertHasFile($filesystem, 'dummy-package/tests'); 137 | $this->assertHasFile($filesystem, 'dummy-package/tests/TestCase.php'); 138 | $this->assertHasFile($filesystem, 'dummy-package/phpunit.xml'); 139 | 140 | $contents = $filesystem->read('dummy-package/phpunit.xml'); 141 | $this->assertContains('Dummy Test Suite', $contents); 142 | 143 | $contents = $filesystem->read('dummy-package/tests/TestCase.php'); 144 | $this->assertContains('use Dummy\DummyPackage\DummyPackageServiceProvider;', $contents); 145 | $this->assertContains('namespace Dummy\DummyPackage\Test;', $contents); 146 | } 147 | 148 | /** @test */ 149 | public function it_generates_composer_json() 150 | { 151 | $filesystem = new Filesystem(new MemoryAdapter()); 152 | 153 | (new PackageGenerator($filesystem, '/', 'dummy/dummy-package')) 154 | ->generateComposerJson(); 155 | 156 | $this->assertHasFile($filesystem, 'dummy-package/composer.json'); 157 | 158 | $contents = $filesystem->read('dummy-package/composer.json'); 159 | $this->assertMatchesJsonSnapshot($contents); 160 | 161 | $this->assertContains('"name": "dummy/dummy-package"', $contents); 162 | $this->assertContains('"Dummy\\\\DummyPackage\\\\Test\\\\":', $contents); 163 | $this->assertContains('"Dummy\\\\DummyPackage\\\\":', $contents); 164 | $this->assertContains('"Dummy\\\\DummyPackage\\\\DummyPackageServiceProvider"', $contents); 165 | } 166 | 167 | /** 168 | * @param Filesystem $filesystem 169 | * @param string $file 170 | */ 171 | protected function assertHasFile(Filesystem $filesystem, $file) 172 | { 173 | $this->assertTrue($filesystem->has($file), "$file does not exists"); 174 | } 175 | } 176 | -------------------------------------------------------------------------------- /tests/__snapshots__/GenerateLicenseTest__it_creates_apache_2_0_license__1.php: -------------------------------------------------------------------------------- 1 | 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for 13 | software and other kinds of works. 14 | 15 | The licenses for most software and other practical works are designed 16 | to take away your freedom to share and change the works. By contrast, 17 | the GNU General Public License is intended to guarantee your freedom to 18 | share and change all versions of a program--to make sure it remains free 19 | software for all its users. We, the Free Software Foundation, use the 20 | GNU General Public License for most of our software; it applies also to 21 | any other work released this way by its authors. You can apply it to 22 | your programs, too. 23 | 24 | When we speak of free software, we are referring to freedom, not 25 | price. Our General Public Licenses are designed to make sure that you 26 | have the freedom to distribute copies of free software (and charge for 27 | them if you wish), that you receive source code or can get it if you 28 | want it, that you can change the software or use pieces of it in new 29 | free programs, and that you know you can do these things. 30 | 31 | To protect your rights, we need to prevent others from denying you 32 | these rights or asking you to surrender the rights. Therefore, you have 33 | certain responsibilities if you distribute copies of the software, or if 34 | you modify it: responsibilities to respect the freedom of others. 35 | 36 | For example, if you distribute copies of such a program, whether 37 | gratis or for a fee, you must pass on to the recipients the same 38 | freedoms that you received. You must make sure that they, too, receive 39 | or can get the source code. And you must show them these terms so they 40 | know their rights. 41 | 42 | Developers that use the GNU GPL protect your rights with two steps: 43 | (1) assert copyright on the software, and (2) offer you this License 44 | giving you legal permission to copy, distribute and/or modify it. 45 | 46 | For the developers\' and authors\' protection, the GPL clearly explains 47 | that there is no warranty for this free software. For both users\' and 48 | authors\' sake, the GPL requires that modified versions be marked as 49 | changed, so that their problems will not be attributed erroneously to 50 | authors of previous versions. 51 | 52 | Some devices are designed to deny users access to install or run 53 | modified versions of the software inside them, although the manufacturer 54 | can do so. This is fundamentally incompatible with the aim of 55 | protecting users\' freedom to change the software. The systematic 56 | pattern of such abuse occurs in the area of products for individuals to 57 | use, which is precisely where it is most unacceptable. Therefore, we 58 | have designed this version of the GPL to prohibit the practice for those 59 | products. If such problems arise substantially in other domains, we 60 | stand ready to extend this provision to those domains in future versions 61 | of the GPL, as needed to protect the freedom of users. 62 | 63 | Finally, every program is threatened constantly by software patents. 64 | States should not allow patents to restrict development and use of 65 | software on general-purpose computers, but in those that do, we wish to 66 | avoid the special danger that patents applied to a free program could 67 | make it effectively proprietary. To prevent this, the GPL assures that 68 | patents cannot be used to render the program non-free. 69 | 70 | The precise terms and conditions for copying, distribution and 71 | modification follow. 72 | 73 | TERMS AND CONDITIONS 74 | 75 | 0. Definitions. 76 | 77 | "This License" refers to version 3 of the GNU General Public License. 78 | 79 | "Copyright" also means copyright-like laws that apply to other kinds of 80 | works, such as semiconductor masks. 81 | 82 | "The Program" refers to any copyrightable work licensed under this 83 | License. Each licensee is addressed as "you". "Licensees" and 84 | "recipients" may be individuals or organizations. 85 | 86 | To "modify" a work means to copy from or adapt all or part of the work 87 | in a fashion requiring copyright permission, other than the making of an 88 | exact copy. The resulting work is called a "modified version" of the 89 | earlier work or a work "based on" the earlier work. 90 | 91 | A "covered work" means either the unmodified Program or a work based 92 | on the Program. 93 | 94 | To "propagate" a work means to do anything with it that, without 95 | permission, would make you directly or secondarily liable for 96 | infringement under applicable copyright law, except executing it on a 97 | computer or modifying a private copy. Propagation includes copying, 98 | distribution (with or without modification), making available to the 99 | public, and in some countries other activities as well. 100 | 101 | To "convey" a work means any kind of propagation that enables other 102 | parties to make or receive copies. Mere interaction with a user through 103 | a computer network, with no transfer of a copy, is not conveying. 104 | 105 | An interactive user interface displays "Appropriate Legal Notices" 106 | to the extent that it includes a convenient and prominently visible 107 | feature that (1) displays an appropriate copyright notice, and (2) 108 | tells the user that there is no warranty for the work (except to the 109 | extent that warranties are provided), that licensees may convey the 110 | work under this License, and how to view a copy of this License. If 111 | the interface presents a list of user commands or options, such as a 112 | menu, a prominent item in the list meets this criterion. 113 | 114 | 1. Source Code. 115 | 116 | The "source code" for a work means the preferred form of the work 117 | for making modifications to it. "Object code" means any non-source 118 | form of a work. 119 | 120 | A "Standard Interface" means an interface that either is an official 121 | standard defined by a recognized standards body, or, in the case of 122 | interfaces specified for a particular programming language, one that 123 | is widely used among developers working in that language. 124 | 125 | The "System Libraries" of an executable work include anything, other 126 | than the work as a whole, that (a) is included in the normal form of 127 | packaging a Major Component, but which is not part of that Major 128 | Component, and (b) serves only to enable use of the work with that 129 | Major Component, or to implement a Standard Interface for which an 130 | implementation is available to the public in source code form. A 131 | "Major Component", in this context, means a major essential component 132 | (kernel, window system, and so on) of the specific operating system 133 | (if any) on which the executable work runs, or a compiler used to 134 | produce the work, or an object code interpreter used to run it. 135 | 136 | The "Corresponding Source" for a work in object code form means all 137 | the source code needed to generate, install, and (for an executable 138 | work) run the object code and to modify the work, including scripts to 139 | control those activities. However, it does not include the work\'s 140 | System Libraries, or general-purpose tools or generally available free 141 | programs which are used unmodified in performing those activities but 142 | which are not part of the work. For example, Corresponding Source 143 | includes interface definition files associated with source files for 144 | the work, and the source code for shared libraries and dynamically 145 | linked subprograms that the work is specifically designed to require, 146 | such as by intimate data communication or control flow between those 147 | subprograms and other parts of the work. 148 | 149 | The Corresponding Source need not include anything that users 150 | can regenerate automatically from other parts of the Corresponding 151 | Source. 152 | 153 | The Corresponding Source for a work in source code form is that 154 | same work. 155 | 156 | 2. Basic Permissions. 157 | 158 | All rights granted under this License are granted for the term of 159 | copyright on the Program, and are irrevocable provided the stated 160 | conditions are met. This License explicitly affirms your unlimited 161 | permission to run the unmodified Program. The output from running a 162 | covered work is covered by this License only if the output, given its 163 | content, constitutes a covered work. This License acknowledges your 164 | rights of fair use or other equivalent, as provided by copyright law. 165 | 166 | You may make, run and propagate covered works that you do not 167 | convey, without conditions so long as your license otherwise remains 168 | in force. You may convey covered works to others for the sole purpose 169 | of having them make modifications exclusively for you, or provide you 170 | with facilities for running those works, provided that you comply with 171 | the terms of this License in conveying all material for which you do 172 | not control copyright. Those thus making or running the covered works 173 | for you must do so exclusively on your behalf, under your direction 174 | and control, on terms that prohibit them from making any copies of 175 | your copyrighted material outside their relationship with you. 176 | 177 | Conveying under any other circumstances is permitted solely under 178 | the conditions stated below. Sublicensing is not allowed; section 10 179 | makes it unnecessary. 180 | 181 | 3. Protecting Users\' Legal Rights From Anti-Circumvention Law. 182 | 183 | No covered work shall be deemed part of an effective technological 184 | measure under any applicable law fulfilling obligations under article 185 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 186 | similar laws prohibiting or restricting circumvention of such 187 | measures. 188 | 189 | When you convey a covered work, you waive any legal power to forbid 190 | circumvention of technological measures to the extent such circumvention 191 | is effected by exercising rights under this License with respect to 192 | the covered work, and you disclaim any intention to limit operation or 193 | modification of the work as a means of enforcing, against the work\'s 194 | users, your or third parties\' legal rights to forbid circumvention of 195 | technological measures. 196 | 197 | 4. Conveying Verbatim Copies. 198 | 199 | You may convey verbatim copies of the Program\'s source code as you 200 | receive it, in any medium, provided that you conspicuously and 201 | appropriately publish on each copy an appropriate copyright notice; 202 | keep intact all notices stating that this License and any 203 | non-permissive terms added in accord with section 7 apply to the code; 204 | keep intact all notices of the absence of any warranty; and give all 205 | recipients a copy of this License along with the Program. 206 | 207 | You may charge any price or no price for each copy that you convey, 208 | and you may offer support or warranty protection for a fee. 209 | 210 | 5. Conveying Modified Source Versions. 211 | 212 | You may convey a work based on the Program, or the modifications to 213 | produce it from the Program, in the form of source code under the 214 | terms of section 4, provided that you also meet all of these conditions: 215 | 216 | a) The work must carry prominent notices stating that you modified 217 | it, and giving a relevant date. 218 | 219 | b) The work must carry prominent notices stating that it is 220 | released under this License and any conditions added under section 221 | 7. This requirement modifies the requirement in section 4 to 222 | "keep intact all notices". 223 | 224 | c) You must license the entire work, as a whole, under this 225 | License to anyone who comes into possession of a copy. This 226 | License will therefore apply, along with any applicable section 7 227 | additional terms, to the whole of the work, and all its parts, 228 | regardless of how they are packaged. This License gives no 229 | permission to license the work in any other way, but it does not 230 | invalidate such permission if you have separately received it. 231 | 232 | d) If the work has interactive user interfaces, each must display 233 | Appropriate Legal Notices; however, if the Program has interactive 234 | interfaces that do not display Appropriate Legal Notices, your 235 | work need not make them do so. 236 | 237 | A compilation of a covered work with other separate and independent 238 | works, which are not by their nature extensions of the covered work, 239 | and which are not combined with it such as to form a larger program, 240 | in or on a volume of a storage or distribution medium, is called an 241 | "aggregate" if the compilation and its resulting copyright are not 242 | used to limit the access or legal rights of the compilation\'s users 243 | beyond what the individual works permit. Inclusion of a covered work 244 | in an aggregate does not cause this License to apply to the other 245 | parts of the aggregate. 246 | 247 | 6. Conveying Non-Source Forms. 248 | 249 | You may convey a covered work in object code form under the terms 250 | of sections 4 and 5, provided that you also convey the 251 | machine-readable Corresponding Source under the terms of this License, 252 | in one of these ways: 253 | 254 | a) Convey the object code in, or embodied in, a physical product 255 | (including a physical distribution medium), accompanied by the 256 | Corresponding Source fixed on a durable physical medium 257 | customarily used for software interchange. 258 | 259 | b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the 269 | Corresponding Source from a network server at no charge. 270 | 271 | c) Convey individual copies of the object code with a copy of the 272 | written offer to provide the Corresponding Source. This 273 | alternative is allowed only occasionally and noncommercially, and 274 | only if you received the object code with such an offer, in accord 275 | with subsection 6b. 276 | 277 | d) Convey the object code by offering access from a designated 278 | place (gratis or for a charge), and offer equivalent access to the 279 | Corresponding Source in the same way through the same place at no 280 | further charge. You need not require recipients to copy the 281 | Corresponding Source along with the object code. If the place to 282 | copy the object code is a network server, the Corresponding Source 283 | may be on a different server (operated by you or a third party) 284 | that supports equivalent copying facilities, provided you maintain 285 | clear directions next to the object code saying where to find the 286 | Corresponding Source. Regardless of what server hosts the 287 | Corresponding Source, you remain obligated to ensure that it is 288 | available for as long as needed to satisfy these requirements. 289 | 290 | e) Convey the object code using peer-to-peer transmission, provided 291 | you inform other peers where the object code and Corresponding 292 | Source of the work are being offered to the general public at no 293 | charge under subsection 6d. 294 | 295 | A separable portion of the object code, whose source code is excluded 296 | from the Corresponding Source as a System Library, need not be 297 | included in conveying the object code work. 298 | 299 | A "User Product" is either (1) a "consumer product", which means any 300 | tangible personal property which is normally used for personal, family, 301 | or household purposes, or (2) anything designed or sold for incorporation 302 | into a dwelling. In determining whether a product is a consumer product, 303 | doubtful cases shall be resolved in favor of coverage. For a particular 304 | product received by a particular user, "normally used" refers to a 305 | typical or common use of that class of product, regardless of the status 306 | of the particular user or of the way in which the particular user 307 | actually uses, or expects or is expected to use, the product. A product 308 | is a consumer product regardless of whether the product has substantial 309 | commercial, industrial or non-consumer uses, unless such uses represent 310 | the only significant mode of use of the product. 311 | 312 | "Installation Information" for a User Product means any methods, 313 | procedures, authorization keys, or other information required to install 314 | and execute modified versions of a covered work in that User Product from 315 | a modified version of its Corresponding Source. The information must 316 | suffice to ensure that the continued functioning of the modified object 317 | code is in no case prevented or interfered with solely because 318 | modification has been made. 319 | 320 | If you convey an object code work under this section in, or with, or 321 | specifically for use in, a User Product, and the conveying occurs as 322 | part of a transaction in which the right of possession and use of the 323 | User Product is transferred to the recipient in perpetuity or for a 324 | fixed term (regardless of how the transaction is characterized), the 325 | Corresponding Source conveyed under this section must be accompanied 326 | by the Installation Information. But this requirement does not apply 327 | if neither you nor any third party retains the ability to install 328 | modified object code on the User Product (for example, the work has 329 | been installed in ROM). 330 | 331 | The requirement to provide Installation Information does not include a 332 | requirement to continue to provide support service, warranty, or updates 333 | for a work that has been modified or installed by the recipient, or for 334 | the User Product in which it has been modified or installed. Access to a 335 | network may be denied when the modification itself materially and 336 | adversely affects the operation of the network or violates the rules and 337 | protocols for communication across the network. 338 | 339 | Corresponding Source conveyed, and Installation Information provided, 340 | in accord with this section must be in a format that is publicly 341 | documented (and with an implementation available to the public in 342 | source code form), and must require no special password or key for 343 | unpacking, reading or copying. 344 | 345 | 7. Additional Terms. 346 | 347 | "Additional permissions" are terms that supplement the terms of this 348 | License by making exceptions from one or more of its conditions. 349 | Additional permissions that are applicable to the entire Program shall 350 | be treated as though they were included in this License, to the extent 351 | that they are valid under applicable law. If additional permissions 352 | apply only to part of the Program, that part may be used separately 353 | under those permissions, but the entire Program remains governed by 354 | this License without regard to the additional permissions. 355 | 356 | When you convey a copy of a covered work, you may at your option 357 | remove any additional permissions from that copy, or from any part of 358 | it. (Additional permissions may be written to require their own 359 | removal in certain cases when you modify the work.) You may place 360 | additional permissions on material, added by you to a covered work, 361 | for which you have or can give appropriate copyright permission. 362 | 363 | Notwithstanding any other provision of this License, for material you 364 | add to a covered work, you may (if authorized by the copyright holders of 365 | that material) supplement the terms of this License with terms: 366 | 367 | a) Disclaiming warranty or limiting liability differently from the 368 | terms of sections 15 and 16 of this License; or 369 | 370 | b) Requiring preservation of specified reasonable legal notices or 371 | author attributions in that material or in the Appropriate Legal 372 | Notices displayed by works containing it; or 373 | 374 | c) Prohibiting misrepresentation of the origin of that material, or 375 | requiring that modified versions of such material be marked in 376 | reasonable ways as different from the original version; or 377 | 378 | d) Limiting the use for publicity purposes of names of licensors or 379 | authors of the material; or 380 | 381 | e) Declining to grant rights under trademark law for use of some 382 | trade names, trademarks, or service marks; or 383 | 384 | f) Requiring indemnification of licensors and authors of that 385 | material by anyone who conveys the material (or modified versions of 386 | it) with contractual assumptions of liability to the recipient, for 387 | any liability that these contractual assumptions directly impose on 388 | those licensors and authors. 389 | 390 | All other non-permissive additional terms are considered "further 391 | restrictions" within the meaning of section 10. If the Program as you 392 | received it, or any part of it, contains a notice stating that it is 393 | governed by this License along with a term that is a further 394 | restriction, you may remove that term. If a license document contains 395 | a further restriction but permits relicensing or conveying under this 396 | License, you may add to a covered work material governed by the terms 397 | of that license document, provided that the further restriction does 398 | not survive such relicensing or conveying. 399 | 400 | If you add terms to a covered work in accord with this section, you 401 | must place, in the relevant source files, a statement of the 402 | additional terms that apply to those files, or a notice indicating 403 | where to find the applicable terms. 404 | 405 | Additional terms, permissive or non-permissive, may be stated in the 406 | form of a separately written license, or stated as exceptions; 407 | the above requirements apply either way. 408 | 409 | 8. Termination. 410 | 411 | You may not propagate or modify a covered work except as expressly 412 | provided under this License. Any attempt otherwise to propagate or 413 | modify it is void, and will automatically terminate your rights under 414 | this License (including any patent licenses granted under the third 415 | paragraph of section 11). 416 | 417 | However, if you cease all violation of this License, then your 418 | license from a particular copyright holder is reinstated (a) 419 | provisionally, unless and until the copyright holder explicitly and 420 | finally terminates your license, and (b) permanently, if the copyright 421 | holder fails to notify you of the violation by some reasonable means 422 | prior to 60 days after the cessation. 423 | 424 | Moreover, your license from a particular copyright holder is 425 | reinstated permanently if the copyright holder notifies you of the 426 | violation by some reasonable means, this is the first time you have 427 | received notice of violation of this License (for any work) from that 428 | copyright holder, and you cure the violation prior to 30 days after 429 | your receipt of the notice. 430 | 431 | Termination of your rights under this section does not terminate the 432 | licenses of parties who have received copies or rights from you under 433 | this License. If your rights have been terminated and not permanently 434 | reinstated, you do not qualify to receive new licenses for the same 435 | material under section 10. 436 | 437 | 9. Acceptance Not Required for Having Copies. 438 | 439 | You are not required to accept this License in order to receive or 440 | run a copy of the Program. Ancillary propagation of a covered work 441 | occurring solely as a consequence of using peer-to-peer transmission 442 | to receive a copy likewise does not require acceptance. However, 443 | nothing other than this License grants you permission to propagate or 444 | modify any covered work. These actions infringe copyright if you do 445 | not accept this License. Therefore, by modifying or propagating a 446 | covered work, you indicate your acceptance of this License to do so. 447 | 448 | 10. Automatic Licensing of Downstream Recipients. 449 | 450 | Each time you convey a covered work, the recipient automatically 451 | receives a license from the original licensors, to run, modify and 452 | propagate that work, subject to this License. You are not responsible 453 | for enforcing compliance by third parties with this License. 454 | 455 | An "entity transaction" is a transaction transferring control of an 456 | organization, or substantially all assets of one, or subdividing an 457 | organization, or merging organizations. If propagation of a covered 458 | work results from an entity transaction, each party to that 459 | transaction who receives a copy of the work also receives whatever 460 | licenses to the work the party\'s predecessor in interest had or could 461 | give under the previous paragraph, plus a right to possession of the 462 | Corresponding Source of the work from the predecessor in interest, if 463 | the predecessor has it or can get it with reasonable efforts. 464 | 465 | You may not impose any further restrictions on the exercise of the 466 | rights granted or affirmed under this License. For example, you may 467 | not impose a license fee, royalty, or other charge for exercise of 468 | rights granted under this License, and you may not initiate litigation 469 | (including a cross-claim or counterclaim in a lawsuit) alleging that 470 | any patent claim is infringed by making, using, selling, offering for 471 | sale, or importing the Program or any portion of it. 472 | 473 | 11. Patents. 474 | 475 | A "contributor" is a copyright holder who authorizes use under this 476 | License of the Program or a work on which the Program is based. The 477 | work thus licensed is called the contributor\'s "contributor version". 478 | 479 | A contributor\'s "essential patent claims" are all patent claims 480 | owned or controlled by the contributor, whether already acquired or 481 | hereafter acquired, that would be infringed by some manner, permitted 482 | by this License, of making, using, or selling its contributor version, 483 | but do not include claims that would be infringed only as a 484 | consequence of further modification of the contributor version. For 485 | purposes of this definition, "control" includes the right to grant 486 | patent sublicenses in a manner consistent with the requirements of 487 | this License. 488 | 489 | Each contributor grants you a non-exclusive, worldwide, royalty-free 490 | patent license under the contributor\'s essential patent claims, to 491 | make, use, sell, offer for sale, import and otherwise run, modify and 492 | propagate the contents of its contributor version. 493 | 494 | In the following three paragraphs, a "patent license" is any express 495 | agreement or commitment, however denominated, not to enforce a patent 496 | (such as an express permission to practice a patent or covenant not to 497 | sue for patent infringement). To "grant" such a patent license to a 498 | party means to make such an agreement or commitment not to enforce a 499 | patent against the party. 500 | 501 | If you convey a covered work, knowingly relying on a patent license, 502 | and the Corresponding Source of the work is not available for anyone 503 | to copy, free of charge and under the terms of this License, through a 504 | publicly available network server or other readily accessible means, 505 | then you must either (1) cause the Corresponding Source to be so 506 | available, or (2) arrange to deprive yourself of the benefit of the 507 | patent license for this particular work, or (3) arrange, in a manner 508 | consistent with the requirements of this License, to extend the patent 509 | license to downstream recipients. "Knowingly relying" means you have 510 | actual knowledge that, but for the patent license, your conveying the 511 | covered work in a country, or your recipient\'s use of the covered work 512 | in a country, would infringe one or more identifiable patents in that 513 | country that you have reason to believe are valid. 514 | 515 | If, pursuant to or in connection with a single transaction or 516 | arrangement, you convey, or propagate by procuring conveyance of, a 517 | covered work, and grant a patent license to some of the parties 518 | receiving the covered work authorizing them to use, propagate, modify 519 | or convey a specific copy of the covered work, then the patent license 520 | you grant is automatically extended to all recipients of the covered 521 | work and works based on it. 522 | 523 | A patent license is "discriminatory" if it does not include within 524 | the scope of its coverage, prohibits the exercise of, or is 525 | conditioned on the non-exercise of one or more of the rights that are 526 | specifically granted under this License. You may not convey a covered 527 | work if you are a party to an arrangement with a third party that is 528 | in the business of distributing software, under which you make payment 529 | to the third party based on the extent of your activity of conveying 530 | the work, and under which the third party grants, to any of the 531 | parties who would receive the covered work from you, a discriminatory 532 | patent license (a) in connection with copies of the covered work 533 | conveyed by you (or copies made from those copies), or (b) primarily 534 | for and in connection with specific products or compilations that 535 | contain the covered work, unless you entered into that arrangement, 536 | or that patent license was granted, prior to 28 March 2007. 537 | 538 | Nothing in this License shall be construed as excluding or limiting 539 | any implied license or other defenses to infringement that may 540 | otherwise be available to you under applicable patent law. 541 | 542 | 12. No Surrender of Others\' Freedom. 543 | 544 | If conditions are imposed on you (whether by court order, agreement or 545 | otherwise) that contradict the conditions of this License, they do not 546 | excuse you from the conditions of this License. If you cannot convey a 547 | covered work so as to satisfy simultaneously your obligations under this 548 | License and any other pertinent obligations, then as a consequence you may 549 | not convey it at all. For example, if you agree to terms that obligate you 550 | to collect a royalty for further conveying from those to whom you convey 551 | the Program, the only way you could satisfy both those terms and this 552 | License would be to refrain entirely from conveying the Program. 553 | 554 | 13. Use with the GNU Affero General Public License. 555 | 556 | Notwithstanding any other provision of this License, you have 557 | permission to link or combine any covered work with a work licensed 558 | under version 3 of the GNU Affero General Public License into a single 559 | combined work, and to convey the resulting work. The terms of this 560 | License will continue to apply to the part which is the covered work, 561 | but the special requirements of the GNU Affero General Public License, 562 | section 13, concerning interaction through a network will apply to the 563 | combination as such. 564 | 565 | 14. Revised Versions of this License. 566 | 567 | The Free Software Foundation may publish revised and/or new versions of 568 | the GNU General Public License from time to time. Such new versions will 569 | be similar in spirit to the present version, but may differ in detail to 570 | address new problems or concerns. 571 | 572 | Each version is given a distinguishing version number. If the 573 | Program specifies that a certain numbered version of the GNU General 574 | Public License "or any later version" applies to it, you have the 575 | option of following the terms and conditions either of that numbered 576 | version or of any later version published by the Free Software 577 | Foundation. If the Program does not specify a version number of the 578 | GNU General Public License, you may choose any version ever published 579 | by the Free Software Foundation. 580 | 581 | If the Program specifies that a proxy can decide which future 582 | versions of the GNU General Public License can be used, that proxy\'s 583 | public statement of acceptance of a version permanently authorizes you 584 | to choose that version for the Program. 585 | 586 | Later license versions may give you additional or different 587 | permissions. However, no additional obligations are imposed on any 588 | author or copyright holder as a result of your choosing to follow a 589 | later version. 590 | 591 | 15. Disclaimer of Warranty. 592 | 593 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 594 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 595 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 596 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 597 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 598 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 599 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 600 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 601 | 602 | 16. Limitation of Liability. 603 | 604 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 605 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 606 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 607 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 608 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 609 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 610 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 611 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 612 | SUCH DAMAGES. 613 | 614 | 17. Interpretation of Sections 15 and 16. 615 | 616 | If the disclaimer of warranty and limitation of liability provided 617 | above cannot be given local legal effect according to their terms, 618 | reviewing courts shall apply local law that most closely approximates 619 | an absolute waiver of all civil liability in connection with the 620 | Program, unless a warranty or assumption of liability accompanies a 621 | copy of the Program in return for a fee. 622 | 623 | END OF TERMS AND CONDITIONS 624 | 625 | How to Apply These Terms to Your New Programs 626 | 627 | If you develop a new program, and you want it to be of the greatest 628 | possible use to the public, the best way to achieve this is to make it 629 | free software which everyone can redistribute and change under these terms. 630 | 631 | To do so, attach the following notices to the program. It is safest 632 | to attach them to the start of each source file to most effectively 633 | state the exclusion of warranty; and each file should have at least 634 | the "copyright" line and a pointer to where the full notice is found. 635 | 636 | 637 | Copyright (C) 638 | 639 | This program is free software: you can redistribute it and/or modify 640 | it under the terms of the GNU General Public License as published by 641 | the Free Software Foundation, either version 3 of the License, or 642 | (at your option) any later version. 643 | 644 | This program is distributed in the hope that it will be useful, 645 | but WITHOUT ANY WARRANTY; without even the implied warranty of 646 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 647 | GNU General Public License for more details. 648 | 649 | You should have received a copy of the GNU General Public License 650 | along with this program. If not, see . 651 | 652 | Also add information on how to contact you by electronic and paper mail. 653 | 654 | If the program does terminal interaction, make it output a short 655 | notice like this when it starts in an interactive mode: 656 | 657 | Copyright (C) 658 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w\'. 659 | This is free software, and you are welcome to redistribute it 660 | under certain conditions; type `show c\' for details. 661 | 662 | The hypothetical commands `show w\' and `show c\' should show the appropriate 663 | parts of the General Public License. Of course, your program\'s commands 664 | might be different; for a GUI interface, you would use an "about box". 665 | 666 | You should also get your employer (if you work as a programmer) or school, 667 | if any, to sign a "copyright disclaimer" for the program, if necessary. 668 | For more information on this, and how to apply and follow the GNU GPL, see 669 | . 670 | 671 | The GNU General Public License does not permit incorporating your program 672 | into proprietary programs. If your program is a subroutine library, you 673 | may consider it more useful to permit linking proprietary applications with 674 | the library. If this is what you want to do, use the GNU Lesser General 675 | Public License instead of this License. But first, please read 676 | .'; 677 | -------------------------------------------------------------------------------- /tests/__snapshots__/GenerateLicenseTest__it_creates_mit_license__1.php: -------------------------------------------------------------------------------- 1 |