Merge pull request #1 from chadicus/master

chadicus · web-flow · commit 827d121cc6ef · 2019-02-01T06:29:51.000-05:00
Add library foundation
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,3 @@
+service_name: travis-ci
+coverage_clover: clover.xml
+json_path: coveralls-upload.json
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,12 @@
+# Enforce Unix newlines
+* text=lf
+
+# Exclude unused files
+# see: https://redd.it/2jzp6k
+/.github       export-ignore
+/tests         export-ignore
+.*.yml         export-ignore
+.gitattributes export-ignore
+.gitignore     export-ignore
+*.xml.dist     export-ignore
+README.md      export-ignore
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @subjective-php/maintainers
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contribution Guidelines
+You are welcome 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 I will try to take care of them in my spare time. If you can make sure the build is passing 100%, that would be very useful.
+
+I recommend including details of your particular usecase(s) with any issues or pull requests.
+
+## Questions and Bug Reports
+Submit via [GitHub Issues](/../../issues).
+
+## Pull Requests
+Code changes should be sent through [GitHub Pull Requests](/../../pulls).  Before submitting the pull request, make sure that phpunit reports success:
+
+## Pull Requests
+Code changes should be sent through [GitHub Pull Requests](/../../pulls).  Before submitting the pull request, make sure that phpunit reports success:
+
+### PHPUnit
+While the build does not strictly enforce 100% [PHPUnit](http://www.phpunit.de) code coverage, it will not allow coverage to drop below its current percentage.
+
+```sh
+./vendor/bin/phpunit --coverage-html coverage
+```
+
+### PHP CodeSniffer
+The build will also not allow any errors for the [coding standard](http://chadicus.github.io/coding-standard/)
+
+```sh
+./vendor/bin/phpcs
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,8 @@
+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
@@ -0,0 +1,3 @@
+/vendor/
+composer.lock
+clover.xml
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,23 @@
+filter:
+    excluded_paths:
+        - 'vendor/*'
+before_commands:
+    - 'composer install --prefer-source'
+build:
+    tests:
+        override:
+            - phpcs-run --standard=./vendor/chadicus/coding-standard/Chadicus/ruleset.xml
+tools:
+    php_analyzer: true
+    php_mess_detector: true
+    sensiolabs_security_checker: true
+    php_loc:
+        excluded_dirs:
+            - vendor
+    php_pdepend: true
+    php_sim: true
+build_failure_conditions:
+    - 'elements.rating(< B).new.exists'
+    - 'issues.label("coding-style").new.exists'
+    - 'issues.severity(>= MAJOR).new.exists'
+    - 'project.metric("scrutinizer.quality", < 6)'
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,19 @@
+language: php
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
+  - nightly
+env:
+  - PREFER_LOWEST="--prefer-lowest --prefer-stable"
+  - PREFER_LOWEST=""
+matrix:
+  fast_finish: true
+  allow_failures:
+     - php: nightly
+before_script:
+  - composer update $PREFER_LOWEST
+script:
+  - ./vendor/bin/phpunit
+after_success: ./vendor/bin/php-coveralls -v
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chad Gray
+
+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,2 +1,43 @@
 # durations
+
 Collection of classes to assist with units of time.
+
+[![Build Status](https://travis-ci.org/subjective-php/durations.svg?branch=master)](https://travis-ci.org/subjective-php/durations)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/subjective-php/durations/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/subjective-php/durations/?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/subjective-php/durations/badge.svg?branch=master)](https://coveralls.io/github/subjective-php/durations?branch=master)
+
+[![Latest Stable Version](https://poser.pugx.org/subjective-php/durations/v/stable)](https://packagist.org/packages/subjective-php/durations)
+[![Latest Unstable Version](https://poser.pugx.org/subjective-php/durations/v/unstable)](https://packagist.org/packages/subjective-php/durations)
+[![License](https://poser.pugx.org/subjective-php/durations/license)](https://packagist.org/packages/subjective-php/durations)
+
+[![Total Downloads](https://poser.pugx.org/subjective-php/durations/downloads)](https://packagist.org/packages/subjective-php/durations)
+[![Daily Downloads](https://poser.pugx.org/subjective-php/durations/d/daily)](https://packagist.org/packages/subjective-php/durations)
+[![Monthly Downloads](https://poser.pugx.org/subjective-php/durations/d/monthly)](https://packagist.org/packages/subjective-php/durations)
+
+[![Documentation](https://img.shields.io/badge/reference-phpdoc-blue.svg?style=flat)](http://www.pholiophp.org/subjective-php/durations)
+
+## Requirements
+
+Requires PHP 7.0 (or later).
+
+## Composer
+To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on `subjective-php/durations` to your project's `composer.json` file such as:
+
+```sh
+composer require subjective-php/durations
+```
+
+## Contact
+Developers may be contacted at:
+
+ * [Pull Requests](https://github.com/subjective-php/durations/pulls)
+ * [Issues](https://github.com/subjective-php/durations/issues)
+
+## Project Build
+With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:
+
+```sh
+composer install
+./vendor/bin/phpunit
+./vendor/bin/phpcs
+```
diff --git a/composer.json b/composer.json
@@ -0,0 +1,26 @@
+{
+    "name": "subjective-php/durations",
+    "description": "Collection of classes to assist with units of time.",
+    "license": "MIT",
+    "require": {
+        "php": "^7.0"
+    },
+    "require-dev": {
+        "chadicus/coding-standard": "^1.7",
+        "php-coveralls/php-coveralls": "^2.1",
+        "phpunit/phpunit": "^6.5"
+    },
+    "config" : {
+        "sort-packages": true
+    },
+    "autoload": {
+        "psr-4": {
+            "SubjectivePHP\\Durations\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "SubjectivePHPTest\\Durations\\": "tests"
+        }
+    }
+}
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+    <file>src</file>
+    <file>tests</file>
+    <arg name="colors" />
+    <arg value="p" />
+    <rule ref="./vendor/chadicus/coding-standard/Chadicus" />
+    <arg name="report-full" />
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,15 @@
+<phpunit colors="true" forceCoversAnnotation="true">
+    <testsuites>
+        <testsuite name="PHP Library Test Suite">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-clover" target="./clover.xml"/>
+    </logging>
+</phpunit>
diff --git a/src/Minutes.php b/src/Minutes.php
@@ -0,0 +1,96 @@
+<?php
+
+namespace SubjectivePHP\Durations;
+
+abstract class Minutes
+{
+    /**
+     * @var int
+     */
+    const ONE_MINUTE = 1;
+
+    /**
+     * @var int
+     */
+    const HOUR_IN_MINUTES = self::ONE_MINUTE * 60;
+
+    /**
+     * @var int
+     */
+    const DAY_IN_MINUTES = self::HOUR_IN_MINUTES * 24;
+
+    /**
+     * @var int
+     */
+    const WEEK_IN_MINUTES = self::DAY_IN_MINUTES * 7;
+
+    /**
+     * @var int
+     */
+    const MONTH_IN_MINUTES = self::DAY_IN_MINUTES * 30;
+
+    /**
+     * @var int
+     */
+    const YEAR_IN_MINUTES = self::DAY_IN_MINUTES * 365;
+
+    /**
+     * Returns the given number of hours represented in seconds.
+     *
+     * @param int $hours The value to covert to seconds.
+     *
+     * @return int
+     */
+    public static function inHours(int $hours) : int
+    {
+        return $hours * self::HOUR_IN_MINUTES;
+    }
+
+    /**
+     * Returns the given number of days represented in seconds.
+     *
+     * @param int $days The value to covert to seconds.
+     *
+     * @return int
+     */
+    public static function inDays(int $days) : int
+    {
+        return $days * self::DAY_IN_MINUTES;
+    }
+
+    /**
+     * Returns the given number of weeks represented in seconds.
+     *
+     * @param int $weeks The value to covert to seconds.
+     *
+     * @return int
+     */
+    public static function inWeeks(int $weeks) : int
+    {
+        return $weeks * self::WEEK_IN_MINUTES;
+    }
+
+    /**
+     * Returns the given number of months represented in seconds.
+     *
+     * @param int $months The value to covert to seconds.
+     *
+     * @return int
+     */
+    public static function inMonths(int $months) : int
+    {
+        return $months * self::MONTH_IN_MINUTES;
+    }
+
+    /**
+     * Returns the given number of years represented in seconds.
+     *
+     * @param int $years The value to covert to seconds.
+     *
+     * @return int
+     */
+    public static function inYears(int $years) : int
+    {
+        return $years * self::YEAR_IN_MINUTES;
+    }
+}
diff --git a/src/Seconds.php b/src/Seconds.php
diff --git a/tests/MinutesTest.php b/tests/MinutesTest.php
diff --git a/tests/SecondsTest.php b/tests/SecondsTest.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+service_name: travis-ci`
	`2`	`+coverage_clover: clover.xml`
	`3`	`+json_path: coveralls-upload.json`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/vendor/`
	`2`	`+composer.lock`
	`3`	`+clover.xml`