Merge pull request #4 from ker0x/master

Fix Travis build, README informations, PHPDoc Block

.travis.yml

@@ -1,4 +1,5 @@
 language: php
+
 php:
   - 7.1
   - 7.0
@@ -9,11 +10,11 @@ php:
 
 sudo: false
 
-install: travis_retry composer install --no-interaction --prefer-source
+before_install:
+  - composer self-update
 
-before_script:
-  - travis_retry composer self-update
-  - travis_retry composer install --no-interaction --prefer-source
+install:
+  - composer install --prefer-dist --no-interaction
 
 script:
   - vendor/bin/phpunit

README.md

@@ -36,8 +36,8 @@ in your composer.json file:
         }
     ],
     "require": {
-    	"danielstjules/Stringy": "dev-master",
-        "tcb13/SubStringy": "dev-master"
+        "danielstjules/stringy": "^3.1",
+        "tcb13/substringy": "dev-master"
     }
 }
 ```

composer.json

@@ -1,36 +1,50 @@
 {
-    "name": "tcb13/substringy",
-    "description": "A sub string manipulation library with multibyte support that extends Stringy",
-    "keywords": [
-        "multibyte", "string", "substring", "manipulation", "utility", "methods", "utf-8",
-        "helpers", "utils", "utf"
-    ],
-    "homepage": "https://github.com/tcb13/SubStringy",
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Tadeu Bento",
-            "email": "[email protected]",
-            "homepage": "http://www.iklive.org"
-        }
-    ],
-    "require": {
-        "php": ">=5.4.0",
-        "ext-mbstring": "*",
-        "danielstjules/Stringy": "dev-master"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "~4.0"
-    },
-    "support": {
-        "issues": "https://github.com/tcb13/SubStringy/issues",
-        "source": "https://github.com/tcb13/SubStringy/SubStringy"
-    },
-    "autoload": {
-        "psr-4": { "SubStringy\\": "src/" },
-        "files": ["src/Create.php"]
-    },
-    "autoload-dev": {
-        "classmap": [ "tests" ]
+  "name": "tcb13/substringy",
+  "description": "A sub string manipulation library with multibyte support that extends Stringy",
+  "keywords": [
+    "multibyte",
+    "string",
+    "substring",
+    "manipulation",
+    "utility",
+    "methods",
+    "utf-8",
+    "helpers",
+    "utils",
+    "utf"
+  ],
+  "homepage": "https://github.com/tcb13/SubStringy",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Tadeu Bento",
+      "email": "[email protected]",
+      "homepage": "http://www.iklive.org"
     }
+  ],
+  "require": {
+    "php": ">=5.4.0",
+    "ext-mbstring": "*",
+    "danielstjules/stringy": "^3.1"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "~4.0"
+  },
+  "support": {
+    "issues": "https://github.com/tcb13/SubStringy/issues",
+    "source": "https://github.com/tcb13/SubStringy/SubStringy"
+  },
+  "autoload": {
+    "psr-4": {
+      "SubStringy\\": "src/"
+    },
+    "files": [
+      "src/Create.php"
+    ]
+  },
+  "autoload-dev": {
+    "classmap": [
+      "tests"
+    ]
+  }
 }

phpunit.xml.dist

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit processIsolation="false"
+<phpunit bootstrap="vendor/autoload.php"
+         processIsolation="false"
          stopOnFailure="false"
          syntaxCheck="false">
     <testsuites>

src/Create.php

@@ -4,11 +4,12 @@
 
 if (!function_exists('SubStringy\create')) {
     /**
-     * Creates a Stringy object and returns it on success.
+     * Creates a SubStringy object and returns it on success.
      *
-     * @param  mixed   $str      Value to modify, after being cast to string
-     * @param  string  $encoding The character encoding
-     * @return Stringy A Stringy object
+     * @param  mixed $str Value to modify, after being cast to string
+     * @param  string $encoding The character encoding
+     *
+     * @return SubStringy A SubStringy object
      * @throws \InvalidArgumentException if an array or object without a
      *         __toString method is passed as the first argument
      */

src/SubStringy.php

@@ -4,7 +4,7 @@
 
 use Stringy\Stringy;
 
-class SubStringy extends Stringy implements \Countable, \IteratorAggregate, \ArrayAccess 
+class SubStringy extends Stringy implements \Countable, \IteratorAggregate, \ArrayAccess
 {
 
     use SubStringyTrait;

src/SubStringyTrait.php

@@ -8,88 +8,106 @@
  */
 trait SubStringyTrait
 {
+
     /**
      * Gets the substring after the first occurrence of a separator.
      * If no match is found returns false.
-     * 
+     *
      * @param string $separator
+     *
      * @return string|bool
      */
     public function substringAfterFirst($separator)
     {
-        if (($offset = $this->indexOf($separator)) === false)
+        if (($offset = $this->indexOf($separator)) === false) {
             return false;
-        return static::create(mb_substr($this->str, $offset + mb_strlen($separator, $this->encoding), null, $this->encoding), $this->encoding); 
+        }
+
+        return static::create(mb_substr($this->str, $offset + mb_strlen($separator, $this->encoding), null, $this->encoding), $this->encoding);
     }
 
     /**
      * Gets the substring after the last occurrence of a separator.
      * If no match is found returns false.
-     * 
+     *
      * @param string $separator
+     *
      * @return string|bool
      */
     public function substringAfterLast($separator)
     {
-        if (($offset = $this->indexOfLast($separator)) === false)
+        if (($offset = $this->indexOfLast($separator)) === false) {
             return false;
+        }
+
         return static::create(mb_substr($this->str, $offset + mb_strlen($separator, $this->encoding), null, $this->encoding), $this->encoding);
     }
 
     /**
      * Gets the substring before the first occurrence of a separator.
      * If no match is found returns false.
-     * 
+     *
      * @param string $separator
+     *
      * @return string|bool
      */
     public function substringBeforeFirst($separator)
     {
-        if (($offset = $this->indexOf($separator)) === false)
+        if (($offset = $this->indexOf($separator)) === false) {
             return false;
+        }
+
         return static::create(mb_substr($this->str, 0, $offset, $this->encoding), $this->encoding);
     }
 
     /**
      * Gets the substring before the last occurrence of a separator.
      * If no match is found returns false.
-     * 
+     *
      * @param string $separator
+     *
      * @return string|bool
      */
     public function substringBeforeLast($separator)
     {
-        if (($offset = $this->indexOfLast($separator)) === false)
+        if (($offset = $this->indexOfLast($separator)) === false) {
             return false;
+        }
+
         return static::create(mb_substr($this->str, 0, $offset, $this->encoding), $this->encoding);
     }
 
     /**
      * Extracts a string from between two substrings present on the current string
-     * @param  string $start 
-     * @param  staing $end 
+     *
+     * @param  string $start
+     * @param  string $end
+     *
      * @return string
      */
     public function substringBetween($start, $end)
     {
-        //$this->str = " " . $this->str;
         $ini = mb_stripos($this->str, $start, 0, $this->encoding);
-        
-        if ($ini == 0)
+
+        if ($ini === 0) {
             return "";
-
+        }
+
         $ini += mb_strlen($start, $this->encoding);
         $len = mb_stripos($this->str, $end, $ini, $this->encoding) - $ini;
+
         return static::create(mb_substr($this->str, $ini, $len, $this->encoding), $this->encoding);
     }
 
     /**
-     * Count the number of substring occurrences on the current string 
-     * @param  string $substr 
+     * Count the number of substring occurrences on the current string
+     *
+     * @param  string $substr
+     *
      * @return int
      */
     public function substringCount($substr)
     {
-    	return mb_substr_count($this->str , $substr, $this->encoding);
+        return mb_substr_count($this->str, $substr, $this->encoding);
     }
 }

tests/CommonTest.php

@@ -1,7 +1,5 @@
 <?php
 
-use SubStringy\SubStringy;
-
 abstract class CommonTest extends PHPUnit_Framework_TestCase
 {
     /**
@@ -21,7 +19,7 @@ public function substringAfterFirstProvider()
             array(' now, me is also here', 'find me now, me is also here', 'me', 'UTF-8'),
         );
     }
-    
+
     public function substringAfterLastProvider()
     {
         return array(
@@ -48,14 +46,14 @@ public function substringBeforeLastProvider()
 
     public function substringBetweenProvider()
     {
-        return array( 
+        return array(
             array(' nice ', 'hello this is a nice string', 'a', 'string', 'UTF-8'),
         );
     }
 
     public function substringCountProvider()
     {
-    	 return array( 
+    	 return array(
             array(2, 'hello how are you? are you ok?', '?', 'UTF-8'),
             array(1, 'hello how are you? are you ok?', 'hello', 'UTF-8'),
         );

tests/CreateTest.php

@@ -1,7 +1,5 @@
 <?php
 
-require __DIR__ . '/../src/Create.php';
-
 use function SubStringy\create as s;
 
 class CreateTestCase extends PHPUnit_Framework_TestCase

tests/SubStringyTest.php

@@ -1,8 +1,5 @@
 <?php
 
-require_once __DIR__ . "/../vendor/autoload.php";
-require __DIR__ . '/../src/SubStringy.php';
-
 use SubStringy\SubStringy as S;
 
 class SubStringyTestCase extends CommonTest