Merge pull request #32 from texdc/feature-test-config

Reorganize test config

Author: brianjmiller

.gitignore

@@ -1,7 +1,8 @@
-tests/Config.php
+tests/config/config.php
 
 # Third party libraries
 phpdoc.xml
+phpunit.xml
 php.ini
 
 # buildables
@@ -11,15 +12,6 @@ sample/vendor
 sample/composer.lock
 doc/api
 
-# bad.
-.DS_Store
-*.swp
-tmp/
-
 # wild
 todo.md
 
-# eclipse project files
-.buildpath
-.project
-.settings

.travis.yml

@@ -6,5 +6,5 @@ php:
   - 5.4
   - hhvm
 before_script:
-  - cp tests/Config.php.travis-ci tests/Config.php
+  - cp tests/config/config.travis-ci.php tests/config/config.php
   - composer install --dev

README.md

@@ -28,20 +28,20 @@ require 'path/to/TinCan/autoload.php';
 
 ### Testing
 
-Tests are implemented using PHPUnit. Configure the LRS endpoint and credentials by copying the `tests/Config.php.template` to `tests/Config.php` then setting the values for your LRS.
+Tests are implemented using the latest stable version of PHPUnit.  It will be installed when using Composer. Configure the LRS endpoint and credentials by copying the `tests/config/config.dist.php` to `tests/config/config.php` then setting the values for your LRS.
 
 Once configured run:
 
 ```
-phpunit tests
+vendor/bin/phpunit
 ```
 
 ### API Doc Generation
 
 Documentation can be output using [phpDocumentor2](http://phpdoc.org). It will be installed when using Composer. To generate documentation:
 
 ```
-./vendor/bin/phpdoc.php
+vendor/bin/phpdoc
 ```
 
 From the root of the repository after running `php composer.phar update`. Documentation will be output to `doc/api`.

autoload.php

@@ -17,17 +17,29 @@
 
 if (file_exists('vendor/autoload.php')) {
     // prefer the composer autoloader
-    return require_once('vendor/autoload.php');
+    require_once('vendor/autoload.php');
+}
+else if (!class_exists('TinCan\\Version')) {
+    tincan_register_autoloader('TinCan\\', 'src');
 }
 
-spl_autoload_register(function($className) {
-    $namespace = 'TinCan\\';
-    if (stripos($className, $namespace) === false) {
-        return;
-    }
-    $sourceDir = __DIR__ . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR;
-    $fileName  = str_replace([$namespace, '\\'], [$sourceDir, DIRECTORY_SEPARATOR], $className) . '.php';
-    if (is_readable($fileName)) {
-        include $fileName;
-    }
-});
+/**
+ * Register a namespace autoloader for the TinCan library
+ *
+ * A source filepath will be generated based on the current directory.
+ *
+ * @param string $namespace a valid namespace, include trailing backslashes ('\\')
+ * @param string $directory a directory name, not a filepath
+ */
+function tincan_register_autoloader($namespace, $directory) {
+    spl_autoload_register(function($className) use ($namespace, $directory) {
+        if (stripos($className, $namespace) === false) {
+            return;
+        }
+        $sourceDir = __DIR__ . DIRECTORY_SEPARATOR . $directory . DIRECTORY_SEPARATOR;
+        $fileName  = str_replace([$namespace, '\\'], [$sourceDir, DIRECTORY_SEPARATOR], $className) . '.php';
+        if (is_readable($fileName)) {
+            include $fileName;
+        }
+    });
+}

composer.json

@@ -37,5 +37,10 @@
         "psr-4": {
             "TinCan\\": "src/"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "TinCanTest\\": "tests/"
+        }
     }
 }

phpunit.php

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    bootstrap="tests/config/bootstrap.php"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    syntaxCheck="false"
+>
+    <testsuites>
+        <testsuite name="TinCanPHP Test Suite">
+            <directory suffix="Test.php">tests</directory>
+            <exclude>
+                <directory>tests/config</directory>
+                <directory>tests/files</directory>
+                <directory>tests/keys</directory>
+            </exclude>
+        </testsuite>
+    </testsuites>
+    
+    <logging>
+        <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"
+            lowUpperBound="50" highLowerBound="80" />
+    </logging>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+            <exclude>
+                <directory>doc</directory>
+                <directory>sample</directory>
+                <directory>tests</directory>
+                <directory>vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+    
+    <php>
+        <const name="COMMON_NAME"            value="Example User" />
+        <const name="COMMON_EMAIL"           value="tincanphp@tincanapi.com" />
+        <const name="COMMON_GROUP_EMAIL"     value="tincanphp+group@tincanapi.com" />
+        <const name="COMMON_MBOX"            value="mailto:tincanphp@tincanapi.com" />
+        <const name="COMMON_MBOX_SHA1"       value="6a7e95ee6c0e353e1eb71950a7f489c1dafa6065" />
+        <const name="COMMON_GROUP_MBOX"      value="mailto:tincanphp+group@tincanapi.com" />
+        <const name="COMMON_GROUP_MBOX_SHA1" value="cbea4c1e0d11d08e36d4e9823c5be97dd0a8b8f8" />
+        <const name="COMMON_ACCT_HOMEPAGE"   value="http://tincanapi.com" />
+        <const name="COMMON_ACCT_NAME"       value="tincanphp-test" />
+        <const name="COMMON_OPENID"          value="http://tincanapi.com/" />
+        <const name="COMMON_VERB_ID"         value="http://adlnet.gov/expapi/verbs/experienced" />
+        <const name="COMMON_ACTIVITY_ID"     value="http://tincanapi.com/TinCanPHP/Test/Activity" />
+        <const name="COMMON_EXTENSION_ID_1"  value="http://id.tincanapi.com/extension/topic" />
+        <const name="COMMON_EXTENSION_ID_2"  value="http://id.tincanapi.com/extension/location" />
+    </php>
+</phpunit>

phpunit.xml

@@ -15,9 +15,11 @@
     limitations under the License.
 */
 
+namespace TinCanTest;
+
 use TinCan\About;
 
-class AboutTest extends PHPUnit_Framework_TestCase {
+class AboutTest extends \PHPUnit_Framework_TestCase {
     const VERSION_1 = '1.0.0';
 
     public function testInstantiation() {

phpunit.xml.dist

@@ -15,9 +15,11 @@
     limitations under the License.
 */
 
+namespace TinCanTest;
+
 use TinCan\ActivityDefinition;
 
-class ActivityDefinitionTest extends PHPUnit_Framework_TestCase {
+class ActivityDefinitionTest extends \PHPUnit_Framework_TestCase {
     const NAME = 'testName';
 
     private $emptyProperties = array(