Tests and documentation

RobLoach · Mar 24, 2013 · 207b8a7 · 207b8a7
1 parent 4aa53bd
commit 207b8a7
Showing 6 changed files with 55 additions and 11 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -7,4 +7,4 @@ php:
 
 before_script: composer install --dev --prefer-source
 
-script: vendor/bin/phpunit
+script: phpunit
diff --git a/README.md b/README.md
@@ -52,15 +52,18 @@ To set up a Component to be installed with Component Installer, have it
 
 ``` json
 {
-    "name": "components/jquery",
+    "name": "components/bootstrap",
     "type": "component",
     "require": {
         "robloach/component-installer": "*"
     },
     "extra": {
         "component": {
             "scripts": [
-                "jquery.js"
+                "js/bootstrap.js"
+            ],
+            "styles": [
+                "css/bootstrap.css"
             ]
         }
     }
@@ -200,13 +203,13 @@ example, we define use of [html5shiv](https://github.com/aFarkas/html5shiv):
 ```
 
 Todo
-----
+----------
 
 * More [RequireJS Configurations](http://www.requirejs.org/docs/api.html#config)
 * Put together a list of Components that make use of Component Installer
 * Compile all the components into one file (`require.min.js`?)
-* Determine if `scripts` is named correctly, or if it should just use `main`
-* Aggregate all `styles` together into one *require.css*
+* Concatenate all `scripts` into one script file and use that file for `main`
+* Install Components into `vendor-dir` and symlink all scripts/styles instead?
 * Determine if `component-baseurl` is the correct name for it
 * Install to `components/[vendor]-[package]` rather than `components/[package]`?
 

diff --git a/composer.json b/composer.json
@@ -22,8 +22,7 @@
         "kriswallsmith/assetic": "1.1.*"
     },
     "require-dev": {
-        "composer/composer": "1.0.*@dev",
-        "phpunit/phpunit": "3.7.*"
+        "composer/composer": "1.0.*@dev"
     },
     "minimum-stability": "alpha"
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -8,7 +8,7 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
+         syntaxCheck="true"
          bootstrap="tests/bootstrap.php"
 >
     <testsuites>

diff --git a/src/bootstrap.php b/src/bootstrap.php
@@ -15,9 +15,11 @@ function includeIfExists($file)
         return include $file;
     }
 }
+
 if ((!$loader = includeIfExists(__DIR__ . '/../vendor/autoload.php')) && (!$loader = includeIfExists(__DIR__ . '/../../../autoload.php'))) {
     die('You must set up the project dependencies, run the following commands:'.PHP_EOL.
         'curl -s http://getcomposer.org/installer | php'.PHP_EOL.
         'php composer.phar install'.PHP_EOL);
 }
+
 return $loader;
diff --git a/tests/ComponentInstaller/Test/InstallerTest.php b/tests/ComponentInstaller/Test/InstallerTest.php
@@ -145,15 +145,55 @@ public function providerGetConfigOption()
      *
      * @dataProvider providerRequireJs
      */
-    public function testRequireJs(array $packages, array $config, $expected = null)
+    public function testRequireJs(array $json = array(), $expected = '')
+    {
+        $result = Installer::requireJs($json);
+        $this->assertEquals($result, $expected, sprintf('Fail to get proper expected require.js'));
+    }
+
+    public function providerRequireJs()
+    {
+        // Start with a base RequireJS configuration.
+        $js = <<<EOT
+var components = %s;
+if (typeof require !== "undefined" && require.config) {
+    require.config(components);
+} else {
+    var require = components;
+}
+if (typeof exports !== "undefined" && typeof module !== "undefined") {
+    module.exports = components;
+}
+EOT;
+        // Tests an empty config.
+        $tests[] = array(
+            array(),
+            sprintf($js, "[\n\n]"),
+        );
+
+        // Tests a basic configuration.
+        $tests[] = array(
+            array('foo' => 'bar'),
+            sprintf($js, "{\n    \"foo\": \"bar\"\n}"),
+        );
+
+        return $tests;
+    }
+
+    /**
+     * testRequireJson
+     *
+     * @dataProvider providerRequireJson
+     */
+    public function testRequireJson(array $packages, array $config, $expected = null)
     {
         $configObject = new Config();
         $configObject->merge(array('config' => $config));
         $result = Installer::requireJson($packages, $configObject);
         $this->assertEquals($result, $expected, sprintf('Fail to get proper expected require.js configuration'));
     }
 
-    public function providerRequireJs()
+    public function providerRequireJson()
     {
         // Test a package that doesn't have any extra information.
         $packageWithoutExtra = array(
Original file line number	Diff line number	Diff line change
		@@ -7,4 +7,4 @@ php:

		before_script: composer install --dev --prefer-source

		script: vendor/bin/phpunit
		script: phpunit