jenkins-bot has submitted this change and it was merged. Change subject: Initial commit ......................................................................
Initial commit This is the initial commit of a Yeoman generator for PHP libraries that conform to Wikimedia specifications, as affirmed by the RFC process and described in <https://www.mediawiki.org/wiki/Manual:Developing_libraries>. Known bug: if PSR-2 code style standard is selected, the generated project does not pass its own lint check, because the autogenerated PHP files use the MediaWiki style. I plan to solve this issue in a follow-up commit. Bug: T104685 Change-Id: Ic8962b0f37dd68a7dc1bcce916bf946774cf74b0 --- A .gitignore A .jshintrc A .travis.yml A LICENSE A NOTICE A README.md A generators/app/index.js A generators/app/licenses.js A generators/app/packagist.js A generators/app/templates/_Doxyfile A generators/app/templates/_Library.php A generators/app/templates/_LibraryTest.php A generators/app/templates/_composer.json A generators/app/templates/_editorconfig A generators/app/templates/_gitreview A generators/app/templates/_phpcs.xml A generators/app/templates/_phpunit.xml.dist A generators/app/templates/gitignore A generators/app/templates/licenses/Apache/LICENSE A generators/app/templates/licenses/Apache/_NOTICE A generators/app/templates/licenses/Apache/_header A generators/app/templates/licenses/GPLv2/COPYING A generators/app/templates/licenses/GPLv2/_header A generators/app/templates/licenses/MIT/_LICENSE A generators/app/templates/licenses/MIT/_header A generators/app/templates/travis.yml A package.json A test/test-app.js 28 files changed, 1,323 insertions(+), 0 deletions(-) Approvals: Legoktm: Looks good to me, approved jenkins-bot: Verified diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2658d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules/ diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..e1ea67d --- /dev/null +++ b/.jshintrc @@ -0,0 +1,13 @@ +{ + // Enforcing + "bitwise": true, + "eqeqeq": true, + "freeze": true, + "latedef": true, + "noarg": true, + "nonew": true, + "undef": true, + "unused": true, + "strict": false, + "node": true +} diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..dedfc07 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +sudo: false +language: node_js +node_js: + - 'iojs' + - '0.12' + - '0.10' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..90bad22 --- /dev/null +++ b/NOTICE @@ -0,0 +1,2 @@ +generator-wikimedia-php-library +Copyright 2015 Ori Livneh <o...@wikimedia.org> diff --git a/README.md b/README.md new file mode 100644 index 0000000..12b80a2 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +[](https://travis-ci.org/wikimedia/generator-wikimedia-php) + +# generator-wikimedia-php + +This tool will help you start a PHP library that conforms to Wikimedia +specifications. + +## Installation + +First, you'll need to make sure you have [Composer](https://getcomposer.org/) +and [Yeoman](http://yeoman.io/). Yeoman is distributed as an +[npm](https://npmjs.org) package. To install it, run: + + +``` +npm install -g yo +``` + +For instructions on obtaining Composer, see [Download +Composer](https://getcomposer.org/download/) in the Composer documentation. + +Once you have installed Yeoman and Composer, you are ready to install +generator-wikimedia-php. To do that, run: + +``` +npm install -g generator-wikimedia-php-library +``` + +## Getting Started + +* Create a new directory or a bare git repository and `cd` into it. +* Run `yo generator-wikimedia-library`. + +Interactive prompts will guide you the rest of the way. + +## License + +Apache-2.0 diff --git a/generators/app/index.js b/generators/app/index.js new file mode 100644 index 0000000..7d370c7 --- /dev/null +++ b/generators/app/index.js @@ -0,0 +1,124 @@ +'use strict'; + +var yeoman = require( 'yeoman-generator' ), + slugify = require( 'underscore.string/slugify' ), + packagist = require( './packagist' ), + licenses = require( './licenses.js' ); + + +module.exports = yeoman.generators.Base.extend( { + prompting: function () { + var self = this, done = self.async(), prompts = [ { + name : 'author_name', + message : 'What is your name?' + }, { + name : 'author_email', + message : 'What is your e-mail address?' + }, { + name : 'name', + message : 'What is the name of your library, in CamelCase?' + }, { + name : 'description', + message : 'Provide a one-sentence summary of your library.' + }, { + type : 'list', + name : 'style', + message : 'Choose a PHP coding style standard.', + choices : [ 'MediaWiki', 'PSR-2' ] + }, { + type : 'list', + name : 'license', + message : 'Choose a license.', + choices : Object.keys( licenses ) + } ]; + + this.log( '' ); + this.log( require( 'wikimedia-logo' ) ); + this.log( '' ); + this.log( "Welcome! I'll help you create a new PHP library." ); + this.log( '' ); + + this.prompt( prompts, function ( props ) { + this.log( '' ); + this.log( 'Resolving Composer dependencies...' ); + this.log( '' ); + packagist.resolveDependencies( [ + 'jakub-onderka/php-parallel-lint', + 'phpunit/phpunit', + props.style === 'MediaWiki' + ? 'mediawiki/mediawiki-codesniffer' + : 'squizlabs/php_codesniffer' + ], '^' ).then( function ( deps ) { + props.deps = deps; + done(); + } ); + this.props = props; + }.bind ( this ) ); + }, + + writing: function () { + this.props.slug = slugify( this.props.name ); + licenses[ this.props.license ]( this ); + + [ + 'gitignore', + 'travis.yml' + ].forEach( function ( fileName ) { + this.fs.copy( + this.templatePath( fileName ), + this.destinationPath( '.' + fileName ) + ); + }.bind( this ) ); + + [ + '_Doxyfile', + '_composer.json', + '_phpcs.xml', + '_phpunit.xml.dist' + ].forEach( function ( templateName ) { + this.fs.copyTpl( + this.templatePath( templateName ), + this.destinationPath( templateName.slice( 1 ) ), + this.props, + this.tplSettings + ); + }.bind( this ) ); + + this.fs.copyTpl( + this.templatePath( '_gitreview' ), + this.destinationPath( '.gitreview' ), + this.props, + this.tplSettings + ); + + this.fs.copyTpl( + this.templatePath( '_Library.php' ), + this.destinationPath( 'src/' + this.props.name + '.php' ), + this.props, + this.tplSettings + ); + + this.fs.copyTpl( + this.templatePath( '_LibraryTest.php' ), + this.destinationPath( 'tests/' + this.props.name + 'Test.php' ), + this.props, + this.tplSettings + ); + + this.fs.copyTpl( + this.templatePath( '_editorconfig' ), + this.destinationPath( '.editorconfig' ), + this.props, + this.tplSettings + ); + }, + + tplSettings: { rmWhitespace: true }, + + install: function () { + if ( this.options[ 'skip-install' ] ) { + return; + } + this.spawnCommand( 'composer', [ 'install' ] ); + } +} ); diff --git a/generators/app/licenses.js b/generators/app/licenses.js new file mode 100644 index 0000000..192c418 --- /dev/null +++ b/generators/app/licenses.js @@ -0,0 +1,53 @@ +'use strict'; + +module.exports = { + 'Apache-2.0': function ( generator ) { + generator.props.header = generator.engine( + generator.fs.read( generator.templatePath( 'licenses/Apache/_header' ) ), + generator.props, + generator.tplSettings + ).slice( 0, -1 ); + + generator.fs.copyTpl( + generator.templatePath( 'licenses/Apache/_NOTICE' ), + generator.destinationPath( 'NOTICE' ), + generator.props, + generator.tplSettings + ); + generator.fs.copy( + generator.templatePath( 'licenses/Apache/LICENSE' ), + generator.destinationPath( 'LICENSE' ) + ); + }, + 'GPL-2.0+': function ( generator ) { + generator.props.header = generator.engine( + generator.fs.read( generator.templatePath( 'licenses/GPLv2/_header' ) ), + generator.props, + generator.tplSettings + ).slice( 0, -1 ); + + generator.fs.copy( + generator.templatePath( 'licenses/GPLv2/COPYING' ), + generator.destinationPath( 'COPYING' ) + ); + }, + 'MIT': function ( generator ) { + generator.props.header = generator.engine( + generator.fs.read( generator.templatePath( 'licenses/MIT/_header' ) ), + generator.props, + generator.tplSettings + ).slice( 0, -1 ); + + generator.fs.copyTpl( + generator.templatePath( 'licenses/MIT/_LICENSE' ), + generator.destinationPath( 'LICENSE' ), + generator.props, + generator.tplSettings + ); + + generator.fs.copy( + generator.templatePath( 'licenses/GPLv2/COPYING' ), + generator.destinationPath( 'COPYING' ) + ); + } +}; diff --git a/generators/app/packagist.js b/generators/app/packagist.js new file mode 100644 index 0000000..82dcc27 --- /dev/null +++ b/generators/app/packagist.js @@ -0,0 +1,48 @@ +var https = require( 'https' ), + when = require( 'when' ), + packagist = module.exports = {}; + +packagist.lookUp = function ( packageName ) { + return when.promise( function ( resolve, reject ) { + var req = https.get( { + host: 'packagist.org', + path: '/packages/' + packageName + '.json' + } ); + req.on ( 'response', function ( res ) { + var body = ''; + res.setEncoding( 'utf8' ); + res.on( 'data', function ( chunk ) { + body += chunk; + } ); + res.on( 'end', function () { + var data = JSON.parse( body ); + resolve( data.package ); + } ); + } ); + req.on( 'error', reject ); + } ); +}; + +packagist.getLatest = function ( packageName ) { + return packagist.lookUp( packageName ).then( function ( package ) { + var version = Object.keys( package.versions ).filter( function ( v ) { + // Ignore version strings which cannot be normalized + // to numeric form (like 'dev-master'). + return /^[\d.]+$/.test( package.versions[ v ].version_normalized ); + } ).reduce( function ( a, b ) { + // Compare versions by publication date. + var aDate = new Date( package.versions[ a ].time ), + bDate = new Date( package.versions[ b ].time ); + return ( aDate > bDate ) ? a : b; + } ); + return package.versions[ version ].version_normalized; + } ); +}; + +packagist.resolveDependencies = function ( packageNames, prefix ) { + prefix = prefix || ''; + return when.reduce( packageNames.map( packagist.getLatest ), function ( deps, version, i ) { + deps.push( { name: packageNames[ i ], version: prefix + version } ); + return deps; + }, [] ); +}; diff --git a/generators/app/templates/_Doxyfile b/generators/app/templates/_Doxyfile new file mode 100644 index 0000000..ca50558 --- /dev/null +++ b/generators/app/templates/_Doxyfile @@ -0,0 +1,26 @@ +# Doxyfile for <%= name %> +# +# See <http://www.stack.nl/~dimitri/doxygen/manual/config.html> +# for help on how to use this file to configure Doxygen. + +PROJECT_NAME = "<%= name %>" +PROJECT_BRIEF = "<%= description %>" +OUTPUT_DIRECTORY = doc +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = YES +WARN_NO_PARAMDOC = YES +INPUT = README.md src/ +FILE_PATTERNS = *.php +RECURSIVE = YES +USE_MDFILE_AS_MAINPAGE = README.md +HTML_DYNAMIC_SECTIONS = YES +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +GENERATE_LATEX = NO +HAVE_DOT = YES +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +TEMPLATE_RELATIONS = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +DOT_MULTI_TARGETS = YES diff --git a/generators/app/templates/_Library.php b/generators/app/templates/_Library.php new file mode 100644 index 0000000..4f77a69 --- /dev/null +++ b/generators/app/templates/_Library.php @@ -0,0 +1,9 @@ +<?php +/** +<%= header %> + * + * @file + * @author <%= author_name %> <<%= author_email %>> + */ + +namespace <%= name %>; diff --git a/generators/app/templates/_LibraryTest.php b/generators/app/templates/_LibraryTest.php new file mode 100644 index 0000000..adf1e42 --- /dev/null +++ b/generators/app/templates/_LibraryTest.php @@ -0,0 +1,30 @@ +<?php +/** +<%= header %> + * + * @file + * @author <%= author_name %> <<%= author_email %>> + */ + +namespace <%= name %>\Test; + +use <%= name %>\<%= name %>; + +/** + * @covers <%= name %>\<%= name %> + */ +class <%= name %>Test extends \PHPUnit_Framework_TestCase { + + public function testCaseProvider() { + return array( + array( true ), + array( 1 ), + array( 'yes' ), + ); + } + + /** @dataProvider testCaseProvider */ + public function test<%= name %>Method( $someValue ) { + $this->assertNotNull( $someValue ); + } +} diff --git a/generators/app/templates/_composer.json b/generators/app/templates/_composer.json new file mode 100644 index 0000000..0bb445d --- /dev/null +++ b/generators/app/templates/_composer.json @@ -0,0 +1,28 @@ +{ + "name": "mediawiki/<%= slug %>", + "description": "<%= description %>", + "license": "<%= license %>", + "homepage": "https://www.mediawiki.org/wiki/<%= name[0].toUpperCase() + name.slice( 1 ).replace( ' ', '_' ) %>", + "authors": [ + { + "name": "<%= author_name %>", + "email": "<%= author_email %>" + } + ], + "autoload": { + "classmap": ["src/"] + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + <%= deps.map( function ( dep ) { return '"' + dep.name + '": "' + dep.version + '"'; } ).join( ',\n\t\t' ) %> + }, + "scripts": { + "test": [ + "parallel-lint . --exclude vendor", + "phpunit $PHPUNIT_ARGS", + "phpcs -p" + ] + } +} diff --git a/generators/app/templates/_editorconfig b/generators/app/templates/_editorconfig new file mode 100644 index 0000000..e3e2ba0 --- /dev/null +++ b/generators/app/templates/_editorconfig @@ -0,0 +1,7 @@ +# http://editorconfig.org +root = true + +[*] +<% if ( style === 'MediaWiki' ) { %>indent_style = tab +<% } else { %>indent_style = space +indent_size = 4<% } %> diff --git a/generators/app/templates/_gitreview b/generators/app/templates/_gitreview new file mode 100644 index 0000000..4ced937 --- /dev/null +++ b/generators/app/templates/_gitreview @@ -0,0 +1,6 @@ +[gerrit] +host=gerrit.wikimedia.org +port=29418 +project=<%= name %>.git +defaultbranch=master +defaultrebase=0 diff --git a/generators/app/templates/_phpcs.xml b/generators/app/templates/_phpcs.xml new file mode 100644 index 0000000..682d42e --- /dev/null +++ b/generators/app/templates/_phpcs.xml @@ -0,0 +1,11 @@ +<?xml version="1.0"?> +<ruleset> +<% if ( style === 'MediaWiki' ) { %> <rule ref="vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/> +<% } else { %> <rule ref="PSR2"/><% } %> + <file>.</file> + <arg name="encoding" value="UTF-8"/> + <arg name="extensions" value="php"/> + <exclude-pattern>coverage</exclude-pattern> + <exclude-pattern>vendor</exclude-pattern> + <exclude-pattern>doc/html</exclude-pattern> +</ruleset> diff --git a/generators/app/templates/_phpunit.xml.dist b/generators/app/templates/_phpunit.xml.dist new file mode 100644 index 0000000..7484970 --- /dev/null +++ b/generators/app/templates/_phpunit.xml.dist @@ -0,0 +1,14 @@ +<phpunit colors="true" + beStrictAboutTestsThatDoNotTestAnything="true" + beStrictAboutOutputDuringTests="true"> + <testsuites> + <testsuite name="<%= name %> Tests"> + <directory>./tests</directory> + </testsuite> + </testsuites> + <filter> + <whitelist addUncoveredFilesFromWhitelist="true"> + <directory suffix=".php">./src</directory> + </whitelist> + </filter> +</phpunit> diff --git a/generators/app/templates/gitignore b/generators/app/templates/gitignore new file mode 100644 index 0000000..c760786 --- /dev/null +++ b/generators/app/templates/gitignore @@ -0,0 +1,4 @@ +/coverage +/doc +/vendor +/composer.lock diff --git a/generators/app/templates/licenses/Apache/LICENSE b/generators/app/templates/licenses/Apache/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/generators/app/templates/licenses/Apache/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/generators/app/templates/licenses/Apache/_NOTICE b/generators/app/templates/licenses/Apache/_NOTICE new file mode 100644 index 0000000..5b7dc8f --- /dev/null +++ b/generators/app/templates/licenses/Apache/_NOTICE @@ -0,0 +1,2 @@ +<%= name %> +Copyright <%= new Date().getUTCFullYear() %> <%= author_name %> <<%= author_email %>> diff --git a/generators/app/templates/licenses/Apache/_header b/generators/app/templates/licenses/Apache/_header new file mode 100644 index 0000000..a34fa99 --- /dev/null +++ b/generators/app/templates/licenses/Apache/_header @@ -0,0 +1,18 @@ + * <%= name %> + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License diff --git a/generators/app/templates/licenses/GPLv2/COPYING b/generators/app/templates/licenses/GPLv2/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/generators/app/templates/licenses/GPLv2/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/generators/app/templates/licenses/GPLv2/_header b/generators/app/templates/licenses/GPLv2/_header new file mode 100644 index 0000000..4041260 --- /dev/null +++ b/generators/app/templates/licenses/GPLv2/_header @@ -0,0 +1,18 @@ + * <%= name %> + * + * Copyright (C) <%= new Date().getUTCFullYear() %> <%= author_name %> <<%= author_email %>> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html diff --git a/generators/app/templates/licenses/MIT/_LICENSE b/generators/app/templates/licenses/MIT/_LICENSE new file mode 100644 index 0000000..e2d05a9 --- /dev/null +++ b/generators/app/templates/licenses/MIT/_LICENSE @@ -0,0 +1,19 @@ +Copyright (c) <%= new Date().getUTCFullYear() %> <%= author_name %> <<%= author_email %>> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/generators/app/templates/licenses/MIT/_header b/generators/app/templates/licenses/MIT/_header new file mode 100644 index 0000000..780622b --- /dev/null +++ b/generators/app/templates/licenses/MIT/_header @@ -0,0 +1,20 @@ + * Copyright (c) <%= new Date().getUTCFullYear() %> <%= author_name %> <<%= author_email %>> + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/generators/app/templates/travis.yml b/generators/app/templates/travis.yml new file mode 100644 index 0000000..c25a516 --- /dev/null +++ b/generators/app/templates/travis.yml @@ -0,0 +1,13 @@ +sudo: false +language: php +php: + - "5.3.3" + - "5.3" + - "5.4" + - "5.5" + - "5.6" + - "hhvm" +install: + - composer install +script: + - composer test diff --git a/package.json b/package.json new file mode 100644 index 0000000..da96b89 --- /dev/null +++ b/package.json @@ -0,0 +1,31 @@ +{ + "name": "generator-wikimedia-php-library", + "version": "0.0.1", + "description": "Yeoman generator for standalone PHP libraries, following Wikimedia standards", + "license": "Apache-2.0", + "main": "app/index.js", + "repository": "wikimedia/generator-wikimedia-php-library", + "author": { + "name": "Ori Livneh", + "email": "o...@wikimedia.org", + "url": "https://github.com/atdt"; + }, + "scripts": { + "test": "mocha" + }, + "files": [ + "generators" + ], + "keywords": [ + "yeoman-generator" + ], + "dependencies": { + "underscore.string": "^3.1.1", + "when": "^3.7.3", + "wikimedia-logo": "0.0.1", + "yeoman-generator": "^0.19.0" + }, + "devDependencies": { + "mocha": "^2.2.5" + } +} diff --git a/test/test-app.js b/test/test-app.js new file mode 100644 index 0000000..9fa10f0 --- /dev/null +++ b/test/test-app.js @@ -0,0 +1,39 @@ +/* global it, before, describe */ +'use strict'; + +var path = require( 'path' ); +var assert = require( 'yeoman-generator' ).assert; +var helpers = require( 'yeoman-generator' ).test; + +describe( 'generator wikimedia php lib:app', function () { + this.timeout( 10 * 1000 ); + + before( function ( done ) { + helpers.run( path.join( __dirname, '../generators/app' ) ) + .withOptions( { skipInstall: true } ) + .withPrompts( { + author_name: 'Ada Lovelace', + author_email: 'alovel...@adacore.com', + name: 'BernoulliNumbers', + description: 'A PHP library for computing Bernoulli numbers.', + style: 'PSR-2', + license: 'MIT' + } ) + .on( 'end', done ); + } ); + + it( 'creates files', function () { + assert.file( [ + '.editorconfig', + '.gitignore', + '.gitreview', + '.travis.yml', + 'Doxyfile', + 'composer.json', + 'phpcs.xml', + 'phpunit.xml.dist', + 'src', + 'tests' + ] ); + } ); +} ); -- To view, visit https://gerrit.wikimedia.org/r/222874 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ic8962b0f37dd68a7dc1bcce916bf946774cf74b0 Gerrit-PatchSet: 7 Gerrit-Project: generator-wikimedia-php-library Gerrit-Branch: master Gerrit-Owner: Ori.livneh <o...@wikimedia.org> Gerrit-Reviewer: Brian Wolff <bawolff...@gmail.com> Gerrit-Reviewer: BryanDavis <bda...@wikimedia.org> Gerrit-Reviewer: Jackmcbarn <jackmcb...@gmail.com> Gerrit-Reviewer: Krinkle <krinklem...@gmail.com> Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com> Gerrit-Reviewer: Ori.livneh <o...@wikimedia.org> Gerrit-Reviewer: TheDJ <hartman.w...@gmail.com> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
