Merge pull request #7 from frastel/composer

Introducing Composer and PHPUnit support

Author: mihai-vlc

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+composer.lock

Example.php

@@ -5,7 +5,7 @@
  * 22.July.2013
  */
 
-require_once 'VerbalExpressions.php';
+$loader = require __DIR__ . '/vendor/autoload.php';
 
 $regex = new \VerbalExpressions\PHPVerbalExpressions\VerbalExpressions();
 

README.md

@@ -10,24 +10,24 @@ VerbalExpressions is a PHP library that helps to construct hard regular expressi
 
 $regex = new VerbalExpressions;
 
-$regex 	->startOfLine()
-		->then("http")
-		->maybe("s")
-		->then("://")
-		->maybe("www.")
-		->anythingBut(" ")
-		->endOfLine();
+$regex     ->startOfLine()
+        ->then("http")
+        ->maybe("s")
+        ->then("://")
+        ->maybe("www.")
+        ->anythingBut(" ")
+        ->endOfLine();
 
 
 if($regex->test("http://github.com"))
-	echo "valid url";
+    echo "valid url";
 else
-	echo "invalid url";
+    echo "invalid url";
 
 if (preg_match($regex, 'http://github.com')) {
-	echo 'valid url';
+    echo 'valid url';
 } else {
-	echo 'invalud url';
+    echo 'invalud url';
 }
 
 
@@ -36,8 +36,8 @@ echo "<pre>". $regex->getRegex() ."</pre>";
 
 
 echo $regex ->clean(array("modifiers" => "m", "replaceLimit" => 4))
-			->find(' ')
-			->replace("This is a small test http://somesite.com and some more text.", "-");
+            ->find(' ')
+            ->replace("This is a small test http://somesite.com and some more text.", "-");
 
 ```
 
@@ -49,3 +49,13 @@ You can see an up to date list of all ports on [VerbalExpressions.github.io](htt
 - [Python](https://github.com/VerbalExpressions/PythonVerbalExpressions)
 - [Java](https://github.com/VerbalExpressions/JavaVerbalExpressions)
 - [C++](https://github.com/VerbalExpressions/CppVerbalExpressions)
+
+## Building the project and running the tests
+The project supports Composer so you have to install [Composer](http://getcomposer.org/doc/00-intro.md#installation-nix) first before project setup.
+
+    curl -sS https://getcomposer.org/installer | php
+    php composer.phar install --dev
+    ln -s vendor/phpunit/phpunit/phpunit.php phpunit
+    ./phpunit
+    
+

composer.json

@@ -0,0 +1,17 @@
+{
+    "name": "VerbalExpressions/PHPVerbalExpressions",
+    "license": "MIT",
+    "type": "project",
+    "description": "PHP Regular expressions made easy",
+    "require": {
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~3.7"
+    },
+    "minimum-stability": "stable",
+    "autoload": {
+        "psr-0": {
+            "VerbalExpressions": "src/"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    convertErrorsToExceptions="false"
+    convertNoticesToExceptions="false"
+    convertWarningsToExceptions="false"
+    processIsolation="false"
+    stopOnFailure="false"
+    stopOnError="false"
+    stopOnIncomplete="false"
+    stopOnSkipped="false"
+    syntaxCheck="false"
+    bootstrap="tests/bootstrap.php">
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

VerbalExpressions.php renamed to src/VerbalExpressions/PHPVerbalExpressions/VerbalExpressions.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace VerbalExpressions\PHPVerbalExpressions;
+
 /**
  * Verbal Expressions v0.1 (https://github.com/jehna/VerbalExpressions) ported in PHP
  * @author Mihai Ionut Vilcu ([email protected])
@@ -475,7 +476,7 @@ public function test($value)
             return preg_match_all($this->getRegex(), $value);
         }
 
-        return preg_match($this->getRegex(), $value);
+        return (bool) preg_match($this->getRegex(), $value);
     }
 
     /**

tests/VerbalExpressions/PHPVerbalExpressions/VerbalExpressionsTest.php

@@ -0,0 +1,64 @@
+<?php
+
+use VerbalExpressions\PHPVerbalExpressions\VerbalExpressions;
+
+class VerbalExpressionsTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider provideValidUrls
+     * @group        functional
+     */
+    public function testShouldPassWhenValidUrlGiven($url)
+    {
+        $regex = new VerbalExpressions();
+        $this->buildUrlPattern($regex);
+
+        $this->assertTrue($regex->test($url));
+    }
+
+    static public function provideValidUrls()
+    {
+        return array(
+            array('http://github.com'),
+            array('http://www.github.com'),
+            array('https://github.com'),
+            array('https://github.com'),
+            array('https://github.com/blog'),
+            array('https://foobar.github.com')
+        );
+    }
+
+    /**
+     * @dataProvider provideInvalidUrls
+     * @group        functional
+     */
+    public function testShouldFailWithInvalidUrls($url)
+    {
+        $regex = new VerbalExpressions();
+        $this->buildUrlPattern($regex);
+
+        $this->assertFalse($regex->test($url));
+    }
+
+    static public function provideInvalidUrls()
+    {
+        return array(
+            array(' http://github.com'),
+            array('foo'),
+            array('htps://github.com'),
+            array('http:/github.com'),
+            array('https://github.com /blog'),
+        );
+    }
+
+    protected function buildUrlPattern(VerbalExpressions $regex)
+    {
+        return $regex->startOfLine()
+            ->then("http")
+            ->maybe("s")
+            ->then("://")
+            ->maybe("www.")
+            ->anythingBut(" ")
+            ->endOfLine();
+    }
+}

tests/bootstrap.php

@@ -0,0 +1,4 @@
+<?php
+
+$loader = require __DIR__ . '/../vendor/autoload.php';
+//$loader->add('PHPVerbalExpressions\Tests', __DIR__);