Added is(), taken from Laravel.

Author: Brad Jones

couscous.yml

@@ -75,6 +75,9 @@ menu:
                 toSlugCase:
                     text: toSlugCase
                     relativeUrl: docs/Methods/toslugcase.html
+                is:
+                    text: is
+                    relativeUrl: docs/Methods/is.html
                 isLowerCase:
                     text: isLowerCase
                     relativeUrl: docs/Methods/islowercase.html

docs/Methods/is.md

@@ -0,0 +1,18 @@
+# is
+Poor mans WildCard regular expression.
+
+## Description
+`bool is(string $pattern)`
+
+Asterisks are translated into zero-or-more regular expression wildcards
+to make it convenient to check if the strings starts with the given
+pattern such as "library/*", making any string check convenient.
+
+### Parameters
+* _string_ __$pattern__  
+The string or pattern to match against.
+
+
+### Return Value
+_bool_  
+Whether or not we match the provided pattern.

src/Methods/Is.php

@@ -15,6 +15,27 @@
 
 trait Is
 {
+    /**
+     * Poor mans WildCard regular expression.
+     *
+     * Asterisks are translated into zero-or-more regular expression wildcards
+     * to make it convenient to check if the strings starts with the given
+     * pattern such as "library/*", making any string check convenient.
+     *
+     * @credit Originally from Laravel, thanks Taylor.
+     * 
+     * @param string $pattern The string or pattern to match against.
+     * 
+     * @return bool Whether or not we match the provided pattern.
+     */
+    public function is($pattern)
+    {
+        if ($this->toString() === $pattern) return true;
+        $quotedPattern = preg_quote($pattern, $this->regexDelimiter);
+        $replaceWildCards = str_replace('\*', '.*', $quotedPattern);
+        return $this->regexMatch('^'.$replaceWildCards.'\z');
+    }
+    
     /**
      * Is the entire string lower case?
      *

tests/IsTest.php

@@ -4,6 +4,29 @@
 
 class IsTest extends PHPUnit_Framework_TestCase
 {
+    /**
+     * @dataProvider isProvider()
+     */
+    public function testIs($expected, $string, $pattern, $encoding = null)
+    {
+        $str = new Str($string, $encoding);
+        $result = $str->is($pattern);
+        $this->assertInternalType('boolean', $result);
+        $this->assertEquals($expected, $result);
+        $this->assertEquals($string, $str);
+    }
+
+    public function isProvider()
+    {
+        return array
+        (
+            [true, 'Gears\\String\\Str', 'Gears\\String\\Str'],
+            [true, 'Gears\\String\\Str', 'Gears\\*\\Str'],
+            [true, 'Gears\\String\\Str', 'Gears\\*\\*'],
+            [false, 'Gears\\String\\Str', 'Gears-*-*']
+        );
+    }
+    
     /**
      * @dataProvider isLowerCaseProvider()
      */