Update code documentation and docblocks

rougin · Dec 7, 2018 · 9d5a981 · 9d5a981
1 parent 0382019
commit 9d5a981
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 66 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,6 +5,8 @@ php:
   - 5.5
   - 5.6
   - 7.0
+  - 7.1
+  - 7.2
   - hhvm
 
 # This triggers builds to run on the new TravisCI infrastructure.

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,4 +80,4 @@ All notable changes to `Spark Plug` will be documented in this file.
 ## 0.1.0 - 2015-06-25
 
 ### Added
-- `Spark Plug` library
+- `Spark Plug` library
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Rougin Royce Gutib
+Copyright (c) 2018 Rougin Gutib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,23 +1,23 @@
 # Spark Plug
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
-[![Software License][ico-license]](LICENSE.md)
+[![Software License][ico-license]][link-license]
 [![Build Status][ico-travis]][link-travis]
 [![Coverage Status][ico-scrutinizer]][link-scrutinizer]
 [![Quality Score][ico-code-quality]][link-code-quality]
 [![Total Downloads][ico-downloads]][link-downloads]
 
 Spark Plug returns [Codeigniter](https://codeigniter.com/) applications as single variables. Might be useful for testing frameworks such as [PHPUnit](https://phpunit.de/).
 
-## Install
+## Installation
 
-Via Composer
+Install `Spark Plug` via [Composer](https://getcomposer.org/):
 
 ``` bash
 $ composer require rougin/spark-plug
 ```
 
-## Usage
+## Basic Usage
 
 ### Using the `Instance` helper
 
@@ -81,40 +81,36 @@ class SampleTest extends \PHPUnit_Framework_TestCase
 }
 ```
 
-## Change log
+## Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+Please see [CHANGELOG][link-changelog] for more information what has changed recently.
 
 ## Testing
 
 ``` bash
 $ composer test
 ```
 
-## Security
-
-If you discover any security related issues, please email rougingutib@gmail.com instead of using the issue tracker.
-
 ## Credits
 
-- [Rougin Royce Gutib][link-author]
-- [All Contributors][link-contributors]
+- [All contributors][link-contributors]
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [LICENSE][link-license] for more information.
 
-[ico-version]: https://img.shields.io/packagist/v/rougin/spark-plug.svg?style=flat-square
-[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/rougin/spark-plug/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/rougin/spark-plug.svg?style=flat-square
 [ico-code-quality]: https://img.shields.io/scrutinizer/g/rougin/spark-plug.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/packagist/dt/rougin/spark-plug.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/rougin/spark-plug.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/rougin/spark-plug/master.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/rougin/spark-plug.svg?style=flat-square
 
-[link-packagist]: https://packagist.org/packages/rougin/spark-plug
-[link-travis]: https://travis-ci.org/rougin/spark-plug
-[link-scrutinizer]: https://scrutinizer-ci.com/g/rougin/spark-plug/code-structure
+[link-changelog]: https://github.com/rougin/spark-plug/blob/master/CHANGELOG.md
 [link-code-quality]: https://scrutinizer-ci.com/g/rougin/spark-plug
+[link-contributors]: https://github.com/rougin/spark-plug/contributors
 [link-downloads]: https://packagist.org/packages/rougin/spark-plug
-[link-author]: https://github.com/rougin
-[link-contributors]: ../../contributors
+[link-license]: https://github.com/rougin/spark-plug/blob/master/LICENSE.md
+[link-packagist]: https://packagist.org/packages/rougin/spark-plug
+[link-scrutinizer]: https://scrutinizer-ci.com/g/rougin/spark-plug/code-structure
+[link-travis]: https://travis-ci.org/rougin/spark-plug
diff --git a/composer.json b/composer.json
@@ -1,46 +1,57 @@
 {
     "name": "rougin/spark-plug",
-    "description": "Returns Codeigniter applications as single variables.",
+    "description": "Codeigniter applications as single variables.",
     "keywords": ["codeigniter", "instance", "php", "spark-plug"],
-    "homepage": "https://github.com/rougin/spark-plug",
+    "homepage": "https://rougin.github.io/spark-plug/",
     "license": "MIT",
-    "authors": [
+    "authors":
+    [
         {
-            "name": "Rougin Royce Gutib",
+            "name": "Rougin Gutib",
             "email": "rougingutib@gmail.com",
-            "homepage": "https://rougin.github.io",
+            "homepage": "https://rougin.github.io/",
             "role": "Developer"
         }
     ],
-    "require": {
-        "php" : ">=5.4.0"
+    "require":
+    {
+        "php": ">=5.4.0"
     },
-    "require-dev": {
-        "phpunit/phpunit" : "4.*",
-        "scrutinizer/ocular": "~1.1",
-        "rougin/codeigniter": "~3.0"
+    "require-dev":
+    {
+        "phpunit/phpunit": "~4.2|~5.7",
+        "rougin/codeigniter": "~3.0",
+        "scrutinizer/ocular": "~1.1.0"
     },
-    "autoload": {
-        "psr-4": {
+    "autoload":
+    {
+        "psr-4":
+        {
             "Rougin\\SparkPlug\\": "src"
         }
     },
-    "autoload-dev": {
-        "psr-4": {
+    "autoload-dev":
+    {
+        "psr-4":
+        {
             "Rougin\\SparkPlug\\": "tests"
         }
     },
-    "scripts": {
+    "scripts":
+    {
         "test": "phpunit"
     },
-    "extra": {
-        "branch-alias": {
+    "extra":
+    {
+        "branch-alias":
+        {
             "dev-master": "1.0-dev"
         }
     },
-    "suggest": {
+    "suggest":
+    {
         "rougin/codeigniter": "A package that installs Codeigniter's core via Composer.",
         "rougin/combustor": "Generates MVC code for Codeigniter using database tables.",
         "rougin/refinery": "\"Ready-to-eat\" migrations for the Codeigniter framework."
     }
-}
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php" colors="true" verbose="true">
-    <testsuites>
-        <testsuite name="Sparkplug Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
+<phpunit bootstrap="vendor/autoload.php" colors="true" stderr="true">
+  <testsuites>
+    <testsuite name="Spark Plug Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <filter>
+    <whitelist>
+      <directory suffix=".php">src/</directory>
+    </whitelist>
+  </filter>
+  <logging>
+    <log type="tap" target="build/report.tap"/>
+    <log type="junit" target="build/report.junit.xml"/>
+    <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+    <log type="coverage-text" target="build/coverage.txt"/>
+    <log type="coverage-clover" target="build/logs/clover.xml"/>
+  </logging>
 </phpunit>
diff --git a/src/Instance.php b/src/Instance.php
@@ -8,7 +8,7 @@
  * A static helper for the SparkPlug::instance method.
  *
  * @package SparkPlug
- * @author  Rougin Royce Gutib <rougingutib@gmail.com>
+ * @author  Rougin Gutib <rougingutib@gmail.com>
  */
 class Instance
 {

diff --git a/src/SparkPlug.php b/src/SparkPlug.php
@@ -8,7 +8,7 @@
  * Returns Codeigniter applications as single variables.
  *
  * @package SparkPlug
- * @author  Rougin Royce Gutib <rougingutib@gmail.com>
+ * @author  Rougin Gutib <rougingutib@gmail.com>
  */
 class SparkPlug
 {

diff --git a/tests/InstanceTest.php b/tests/InstanceTest.php
@@ -6,7 +6,7 @@
  * Instance Test
  *
  * @package SparkPlug
- * @author  Rougin Royce Gutib <rougingutib@gmail.com>
+ * @author  Rougin Gutib <rougingutib@gmail.com>
  */
 class InstanceTest extends SparkPlugTest
 {

diff --git a/tests/SparkPlugTest.php b/tests/SparkPlugTest.php
@@ -6,7 +6,7 @@
  * Spark Plug Test
  *
  * @package SparkPlug
- * @author  Rougin Royce Gutib <rougingutib@gmail.com>
+ * @author  Rougin Gutib <rougingutib@gmail.com>
  */
 class SparkPlugTest extends \PHPUnit_Framework_TestCase
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,8 @@ php: @@
       - 5.5
       - 5.6
       - 7.0
+      - 7.1
+      - 7.2
       - hhvm
     # This triggers builds to run on the new TravisCI infrastructure.
@@ Expand Down @@