diff --git a/.gitattributes b/.gitattributes index 276ed28..8d74c82 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,9 +1,9 @@ +/docs export-ignore /test export-ignore /.coveralls.yml export-ignore /.gitattributes export-ignore /.gitignore export-ignore /.travis.yml export-ignore /composer.lock export-ignore -/mkdocs.yml export-ignore /phpcs.xml export-ignore /phpunit.xml.dist export-ignore diff --git a/.gitignore b/.gitignore index d822fd3..4b5ffeb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -/clover.xml -/coveralls-upload.json -/phpunit.xml -/vendor/ +vendor/ +clover.xml +coveralls-upload.json +phpunit.xml diff --git a/.travis.yml b/.travis.yml index 83a3ee9..31082d7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,7 +11,6 @@ env: global: - COMPOSER_ARGS="--no-interaction" - COVERAGE_DEPS="satooshi/php-coveralls" - - LEGACY_DEPS="phpunit/phpunit" matrix: include: @@ -21,6 +20,7 @@ matrix: - php: 5.6 env: - DEPS=locked + - LEGACY_DEPS="phpunit/phpunit" - php: 5.6 env: - DEPS=latest @@ -30,6 +30,7 @@ matrix: - php: 7.0 env: - DEPS=locked + - LEGACY_DEPS="phpunit/phpunit" - php: 7.0 env: - DEPS=latest @@ -39,8 +40,8 @@ matrix: - php: 7.1 env: - DEPS=locked - - TEST_COVERAGE=true - CS_CHECK=true + - TEST_COVERAGE=true - php: 7.1 env: - DEPS=latest @@ -53,16 +54,13 @@ matrix: - php: 7.2 env: - DEPS=latest - allow_failures: - - php: 7.2 before_install: - if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi - - travis_retry composer self-update install: - travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs - - if [[ $TRAVIS_PHP_VERSION =~ ^5.6 ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi + - if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi - if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi - if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi diff --git a/CHANGELOG.md b/CHANGELOG.md index c051c6e..67e6677 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # Changelog -## 0.1.2 - TBD +All notable changes to this project will be documented in this file, in reverse chronological order by release. + +Versions prior to 0.2.0 were released as the package "webimpress/zend-auradi-config". + +## 0.2.0 - 2017-11-21 ### Added @@ -8,7 +12,7 @@ ### Changed -- Nothing. +- Renames the package to zendframework/zend-auradi-config. ### Deprecated diff --git a/LICENSE.md b/LICENSE.md index 63ab8b2..a7d89dc 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2017, Michał Bundyra +Copyright (c) 2017, Zend Technologies USA, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, @@ -11,6 +11,10 @@ are permitted provided that the following conditions are met: list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +- Neither the name of Zend Technologies USA, Inc. nor the names of its + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE diff --git a/README.md b/README.md index 0a37966..af82de0 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,24 @@ # zend-auradi-config -[![Build Status](https://secure.travis-ci.org/webimpress/zend-auradi-config.svg?branch=master)](https://secure.travis-ci.org/webimpress/zend-auradi-config) -[![Coverage Status](https://coveralls.io/repos/github/webimpress/zend-auradi-config/badge.svg?branch=master)](https://coveralls.io/github/webimpress/zend-auradi-config?branch=master) +[![Build Status](https://secure.travis-ci.org/zendframework/zend-auradi-config.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-auradi-config) +[![Coverage Status](https://coveralls.io/repos/github/zendframework/zend-auradi-config/badge.svg?branch=master)](https://coveralls.io/github/zendframework/zend-auradi-config?branch=master) This library provides utilities to configure -[PSR-11](http://www.php-fig.org/psr/psr-11/) +a [PSR-11](http://www.php-fig.org/psr/psr-11/) compatible [Aura.Di container](https://github.com/auraphp/Aura.Di) -using ZendFramework ServiceManager configuration. +using zend-servicemanager configuration. ## Installation Run the following to install this library: ```bash -$ composer require webimpress/zend-auradi-config +$ composer require zendframework/zend-auradi-config ``` ## Configuration -To get configured [PSR-11 Container](http://www.php-fig.org/psr/psr-11/) -Aura.Di Container do the following: +To get a configured Aura.Di container, do the following: ```php Please note, that the whole configuration is available in the `$container` @@ -65,12 +67,8 @@ The `dependencies` sub associative array can contain the following keys: ## Using with Expressive -First you have to install the library: -```bash -$ composer require webimpress/zend-auradi-config -``` +Replace the contents of `config/container.php` with the following: -Then replace contents of `config/container.php` with the following: ```php =5.4.0" + "php": "^5.6 || ^7.0" }, "require-dev": { - "doctrine/collections": "1.*", - "phpunit/phpunit": "~4.1" + "doctrine/collections": "^1.0", + "doctrine/common": "^2.6", + "phpunit/phpunit": "^4.1" }, "type": "library", "autoload": { "psr-4": { "DeepCopy\\": "src/DeepCopy/" - } + }, + "files": [ + "src/DeepCopy/deep_copy.php" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "description": "Create deep copies (clones) of your objects", - "homepage": "https://github.com/myclabs/DeepCopy", "keywords": [ "clone", "copy", @@ -235,7 +238,7 @@ "object", "object graph" ], - "time": "2017-04-12T18:52:22+00:00" + "time": "2017-10-19T19:58:43+00:00" }, { "name": "phar-io/manifest", @@ -550,16 +553,16 @@ }, { "name": "phpunit/php-code-coverage", - "version": "5.2.2", + "version": "5.2.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "8ed1902a57849e117b5651fc1a5c48110946c06b" + "reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/8ed1902a57849e117b5651fc1a5c48110946c06b", - "reference": "8ed1902a57849e117b5651fc1a5c48110946c06b", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d", + "reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d", "shasum": "" }, "require": { @@ -568,7 +571,7 @@ "php": "^7.0", "phpunit/php-file-iterator": "^1.4.2", "phpunit/php-text-template": "^1.2.1", - "phpunit/php-token-stream": "^1.4.11 || ^2.0", + "phpunit/php-token-stream": "^2.0", "sebastian/code-unit-reverse-lookup": "^1.0.1", "sebastian/environment": "^3.0", "sebastian/version": "^2.0.1", @@ -610,7 +613,7 @@ "testing", "xunit" ], - "time": "2017-08-03T12:40:43+00:00" + "time": "2017-11-03T13:47:33+00:00" }, { "name": "phpunit/php-file-iterator", @@ -800,16 +803,16 @@ }, { "name": "phpunit/phpunit", - "version": "6.3.1", + "version": "6.4.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "c0ff817b36a827e64bf5f57bc72278150cf30a77" + "reference": "06b28548fd2b4a20c3cd6e247dc86331a7d4db13" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/c0ff817b36a827e64bf5f57bc72278150cf30a77", - "reference": "c0ff817b36a827e64bf5f57bc72278150cf30a77", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/06b28548fd2b4a20c3cd6e247dc86331a7d4db13", + "reference": "06b28548fd2b4a20c3cd6e247dc86331a7d4db13", "shasum": "" }, "require": { @@ -854,7 +857,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "6.3.x-dev" + "dev-master": "6.4.x-dev" } }, "autoload": { @@ -880,7 +883,7 @@ "testing", "xunit" ], - "time": "2017-09-24T07:25:54+00:00" + "time": "2017-10-16T13:18:59+00:00" }, { "name": "phpunit/phpunit-mock-objects", @@ -988,30 +991,30 @@ }, { "name": "sebastian/comparator", - "version": "2.0.2", + "version": "2.1.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "ae068fede81d06e7bb9bb46a367210a3d3e1fe6a" + "reference": "1174d9018191e93cb9d719edec01257fc05f8158" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/ae068fede81d06e7bb9bb46a367210a3d3e1fe6a", - "reference": "ae068fede81d06e7bb9bb46a367210a3d3e1fe6a", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/1174d9018191e93cb9d719edec01257fc05f8158", + "reference": "1174d9018191e93cb9d719edec01257fc05f8158", "shasum": "" }, "require": { "php": "^7.0", "sebastian/diff": "^2.0", - "sebastian/exporter": "^3.0" + "sebastian/exporter": "^3.1" }, "require-dev": { - "phpunit/phpunit": "^6.0" + "phpunit/phpunit": "^6.4" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.0.x-dev" + "dev-master": "2.1.x-dev" } }, "autoload": { @@ -1042,13 +1045,13 @@ } ], "description": "Provides the functionality to compare PHP values for equality", - "homepage": "http://www.github.com/sebastianbergmann/comparator", + "homepage": "https://github.com/sebastianbergmann/comparator", "keywords": [ "comparator", "compare", "equality" ], - "time": "2017-08-03T07:14:59+00:00" + "time": "2017-11-03T07:16:52+00:00" }, { "name": "sebastian/diff", diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 90% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 73713a7..57c537d 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -6,10 +6,12 @@ If you wish to contribute to this project, please be sure to read/subscribe to the following resources: - [Coding Standards](https://github.com/zendframework/zend-coding-standard) + - [Forums](https://discourse.zendframework.com/c/contributors) + - [Slack](https://zendframework-slack.herokuapp.com) - [Code of Conduct](CODE_OF_CONDUCT.md) If you are working on new features or refactoring -[create a proposal](https://github.com/webimpress/zend-auradi-config/issues/new). +[create a proposal](https://github.com/zendframework/zend-auradi-config/issues/new). ## RUNNING TESTS @@ -18,7 +20,7 @@ To run tests: - Clone the repository: ```console - $ git clone git://github.com/webimpress/zend-auradi-config.git + $ git clone git://github.com/zendframework/zend-auradi-config.git $ cd zend-auradi-config ``` @@ -70,11 +72,11 @@ pull your work into the master repository. We recommend using [GitHub](https://github.com), as that is where the component is already hosted. 1. Setup a [GitHub account](https://github.com/), if you haven't yet -2. Fork the repository (https://github.com/webimpress/zend-auradi-config) +2. Fork the repository (https://github.com/zendframework/zend-auradi-config) 3. Clone the canonical repository locally and enter it. ```console - $ git clone git://github.com/webimpress/zend-auradi-config.git + $ git clone git://github.com/zendframework/zend-auradi-config.git $ cd zend-auradi-config ``` @@ -154,7 +156,7 @@ To send a pull request, you have two options. If using GitHub, you can do the pull request from there. Navigate to your repository, select the branch you just created, and then select the "Pull Request" button in the upper right. Select the user/organization -"webimpress" (or whatever the upstream organization is) as the recipient. +"zendframework" (or whatever the upstream organization is) as the recipient. #### What branch to issue the pull request against? diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..4ea09b9 --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + - [ ] I was not able to find an [open](https://github.com/zendframework/zend-auradi-config/issues?q=is%3Aopen) or [closed](https://github.com/zendframework/zend-auradi-config/issues?q=is%3Aclosed) issue matching what I'm seeing. + - [ ] This is not a question. (Questions should be asked on [slack](https://zendframework.slack.com/) ([Signup for Slack here](https://zendframework-slack.herokuapp.com/)) or our [forums](https://discourse.zendframework.com/).) + +Provide a narrative description of what you are trying to accomplish. + +### Code to reproduce the issue + + + +```php +``` + +### Expected results + + + +### Actual results + + diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f00d90c --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +Provide a narrative description of what you are trying to accomplish: + +- [ ] Are you fixing a bug? + - [ ] Detail how the bug is invoked currently. + - [ ] Detail the original, incorrect behavior. + - [ ] Detail the new, expected behavior. + - [ ] Base your feature on the `master` branch, and submit against that branch. + - [ ] Add a regression test that demonstrates the bug, and proves the fix. + - [ ] Add a `CHANGELOG.md` entry for the fix. + +- [ ] Are you creating a new feature? + - [ ] Why is the new feature needed? What purpose does it serve? + - [ ] How will users use the new feature? + - [ ] Base your feature on the `develop` branch, and submit against that branch. + - [ ] Add only one feature per pull request; split multiple features over multiple pull requests + - [ ] Add tests for the new feature. + - [ ] Add documentation for the new feature. + - [ ] Add a `CHANGELOG.md` entry for the new feature. + +- [ ] Is this related to quality assurance? + + +- [ ] Is this related to documentation? + + diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 0000000..2fd939e --- /dev/null +++ b/docs/SUPPORT.md @@ -0,0 +1,25 @@ +# Getting Support + +Zend Framework offers three support channels: + +- For real-time questions, use our + [Slack](https://zendframework-slack.herokuapp.com) +- For detailed questions (e.g., those requiring examples) use our + [forums](https://discourse.zendframework.com/c/questions/expressive) +- To report issues, use this repository's + [issue tracker](https://github.com/zendframework/zend-auradi-config/issues/new) + +**DO NOT** use the issue tracker to ask questions; use Slack or the forums for +that. Questions posed to the issue tracker will be closed. + +When reporting an issue, please include the following details: + +- A narrative description of what you are trying to accomplish. +- The minimum code necessary to reproduce the issue. +- The expected results of exercising that code. +- The actual results received. + +We may ask for additional details: what version of the library you are using, +and what PHP version was used to reproduce the issue. + +You may also submit a failing test case as a pull request. diff --git a/src/Config.php b/src/Config.php index af73c0e..511e325 100644 --- a/src/Config.php +++ b/src/Config.php @@ -1,4 +1,9 @@