Merge pull request #57 from hotline-emu/imp/de-trader

chadicus · web-flow · commit 041fcd60861e · 2018-03-07T09:48:10.000-05:00
Version 3.0
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -1,4 +1,3 @@
 service_name: travis-ci
-src_dir: .
 coverage_clover: clover.xml
 json_path: coveralls-upload.json
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,14 @@
+# Enforce Unix newlines
+* text=lf
+
+# Exclude unused files
+# see: https://redd.it/2jzp6k
+/tests              export-ignore
+/.github            export-ignore
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.*.yml             export-ignore
+/phpcs.xml          export-ignore
+/phpunit.xml.dist   export-ignore
+/README.md          export-ignore
+
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @traderinteractive/opensource
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# Contribution Guidelines
+We welcome you to report [issues](/../../issues) or submit [pull requests](/../../pulls).  While the below guidelines are necessary to get code merged, you can
+submit pull requests that do not adhere to them and we will try to take care of them in our spare time.  We are a smallish group of developers,
+though, so if you can make sure the build is passing 100%, that would be very useful.
+
+We recommend including details of your particular usecase(s) with any issues or pull requests.  We love to hear how our libraries are being used
+and we can get things merged in quicker when we understand its expected usage.
+
+## Pull Requests
+Code changes should be sent through [GitHub Pull Requests](/../../pulls).  Before submitting the pull request, make sure that phpunit reports success
+by running:
+```sh
+./vendor/bin/phpunit
+```
+And there are not coding standard violations by running
+```sh
+./vendor/bin/phpcs
+```
+
+## Builds
+Our [Travis build](https://travis-ci.org/traderinteractive/util-php) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
+While the build does not strictly enforce 100% code coverage, it will not allow coverage to drop below its current percentage.
+[Scrutinizer](https://scrutinizer-ci.com/) is used to ensure code quality and enforce the [coding standard](http://www.php-fig.org/psr/psr-2/).
+
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,6 @@
+## Expected Behavior
+
+## Actual Behavior
+
+## Steps to reproduce the behavior
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+Fixes # .
+
+#### What does this PR do?
+
+#### Checklist
+- [  ] Pull request contains a clear definition of changes
+- [  ] Tests (either unit, integration, or acceptance) written and passing
+- [  ] Relevant documentation produced and/or updated
+
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 /coverage/
 /vendor/
 /clover.xml
+composer.lock
+phpunit.xml
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,7 +1,6 @@
 filter:
     excluded_paths:
         - 'vendor/*'
-        - 'tests/*'
 before_commands:
     - 'composer install'
 tools:
@@ -14,10 +13,10 @@ tools:
     php_loc:
         excluded_dirs:
             - vendor
-            - tests
     php_pdepend: true
     php_sim: true
 build_failure_conditions:
-    - 'elements.rating(<= D).new.exists'
+    - 'elements.rating(< B).new.exists'
     - 'issues.label("coding-style").new.exists'
     - 'issues.severity(>= MAJOR).new.exists'
+    - 'project.metric("scrutinizer.quality", < 9)'
diff --git a/.travis.yml b/.travis.yml
@@ -1,14 +1,18 @@
 sudo: false
 language: php
 php:
-  - 5.6
-  - 7
-  - hhvm
-install: composer install 
-script: ./vendor/bin/phpunit --coverage-clover clover.xml
-after_success: sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then ./vendor/bin/coveralls -v; fi'
+  - 7.0
+  - 7.1
+  - 7.2
+  - nightly
+env:
+  - PREFER_LOWEST="--prefer-lowest --prefer-stable"
+  - PREFER_LOWEST=""
 matrix:
   fast_finish: true
   allow_failures:
-     - php: 7
-     - php: hhvm
+    - php: nightly
+before_script:
+  - composer update $PREFER_LOWEST
+script: ./vendor/bin/phpunit --coverage-clover clover.xml
+after_success: ./vendor/bin/coveralls -v
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Trader Interactive
+
+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/README.md b/README.md
@@ -1,49 +1,51 @@
 # util-php
-[![Build Status](http://img.shields.io/travis/dominionenterprises/util-php.svg?style=flat)](https://travis-ci.org/dominionenterprises/util-php)
-[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/dominionenterprises/util-php.svg?style=flat)](https://scrutinizer-ci.com/g/dominionenterprises/util-php/)
-[![Code Coverage](http://img.shields.io/coveralls/dominionenterprises/util-php.svg?style=flat)](https://coveralls.io/r/dominionenterprises/util-php)
 
-[![Latest Stable Version](http://img.shields.io/packagist/v/dominionenterprises/util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util)
-[![Total Downloads](http://img.shields.io/packagist/dt/dominionenterprises/util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util)
-[![License](http://img.shields.io/packagist/l/dominionenterprises/util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util)
+[![Build Status](https://travis-ci.org/traderinteractive/util-php.svg?branch=master)](https://travis-ci.org/traderinteractive/util-php)
+[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/traderinteractive/util-php.svg?style=flat)](https://scrutinizer-ci.com/g/traderinteractive/util-php/)
+[![Coverage Status](https://coveralls.io/repos/traderinteractive/util-php/badge.svg?branch=master&service=github)](https://coveralls.io/github/traderinteractive/util-php?branch=master)
+
+[![Latest Stable Version](http://img.shields.io/packagist/v/traderinteractive/util-http.svg?style=flat)](https://packagist.org/packages/traderinteractive/util-http)
+[![Total Downloads](http://img.shields.io/packagist/dt/traderinteractive/util-http.svg?style=flat)](https://packagist.org/packages/traderinteractive/util-http)
+[![License](http://img.shields.io/packagist/l/traderinteractive/util-http.svg?style=flat)](https://packagist.org/packages/traderinteractive/util-http)
 
 A collection of general utilities for making common programming tasks easier.
 
 ## Requirements
 
-util-php requires PHP 5.4 (or later).
+util-php requires PHP 7.0 (or later).
+
+## Composer
 
-##Composer
 To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on
-`dominionenterprises/util` to your project's `composer.json` file such as:
-
-```json
-{
-    "require": {
-        "dominionenterprises/util": "~1.0"
-    }
-}
+`traderinteractive/util` to your project's `composer.json` file such as:
+
+```sh
+composer require traderinteractive/util-php
 ```
+
 ## Components
 
 This package is a partial metapackage aggregating the following components:
 
-* [dominionenterprises/util-arrays](https://github.com/dominionenterprises/util-arrays-php)
-* [dominionenterprises/util-file](https://github.com/dominionenterprises/util-file-php)
-* [dominionenterprises/util-http](https://github.com/dominionenterprises/util-http-php)
-* [dominionenterprises/util-time](https://github.com/dominionenterprises/util-time-php)
-* [dominionenterprises/util-string](https://github.com/dominionenterprises/util-string-php)
+* [traderinteractive/util-arrays](https://github.com/traderinteractive/util-arrays-php)
+* [traderinteractive/util-file](https://github.com/traderinteractive/util-file-php)
+* [traderinteractive/util-http](https://github.com/traderinteractive/util-http-php)
+* [traderinteractive/util-time](https://github.com/traderinteractive/util-time-php)
+* [traderinteractive/util-string](https://github.com/traderinteractive/util-string-php)
+
+## Documentation
 
-##Documentation
 Found in the [source](src) itself, take a look!
 
-##Contact
+## Contact
+
 Developers may be contacted at:
 
- * [Pull Requests](https://github.com/dominionenterprises/util-php/pulls)
- * [Issues](https://github.com/dominionenterprises/util-php/issues)
+ * [Pull Requests](https://github.com/traderinteractive/util-php/pulls)
+ * [Issues](https://github.com/traderinteractive/util-php/issues)
+
+## Project Build
 
-##Project Build
 With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:
 
 ```sh
@@ -53,6 +55,7 @@ With a checkout of the code get [Composer](http://getcomposer.org) in your PATH
 There is also a [docker](http://www.docker.com/)-based
 [fig](http://www.fig.sh/) configuration that will execute the build inside a
 docker container.  This is an easy way to build the application:
+
 ```sh
 fig run build
 ```
diff --git a/composer.json b/composer.json
@@ -1,5 +1,5 @@
 {
-    "name": "dominionenterprises/util",
+    "name": "traderinteractive/util",
     "description": "A collection of utility classes",
     "keywords": ["utility"],
     "authors": [
@@ -20,20 +20,23 @@
         }
     ],
     "license": "MIT",
+    "config": {
+        "sort-packages": true
+    },
     "require": {
-        "php": "~5.6 || ~7.0",
-        "dominionenterprises/util-arrays": "~2.0",
-        "dominionenterprises/util-file": "~2.0",
-        "dominionenterprises/util-http": "~2.0",
-        "dominionenterprises/util-time": "~2.0",
-        "dominionenterprises/util-string": "~2.0"
+        "php": "^7.0",
+        "traderinteractive/util-arrays": "^3.0",
+        "traderinteractive/util-file": "^3.0",
+        "traderinteractive/util-http": "^3.0",
+        "traderinteractive/util-time": "^3.0",
+        "traderinteractive/util-string": "^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~5.0",
-        "satooshi/php-coveralls": "~0.6.1",
-        "squizlabs/php_codesniffer": "~2.0"
+        "php-coveralls/php-coveralls": "^1.0",
+        "phpunit/phpunit": "^6.0",
+        "squizlabs/php_codesniffer": "^3.2"
     },
     "autoload": {
-        "psr-4": { "DominionEnterprises\\": "src" }
+        "psr-4": { "TraderInteractive\\": "src" }
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/phpcs.xml b/phpcs.xml
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
diff --git a/src/Util.php b/src/Util.php
diff --git a/tests/UtilTest.php b/tests/UtilTest.php
