Merge pull request #2 from OpenframeProject/tests

New structure, tests

Author: jmwohl

.eslintrc.yml

@@ -42,8 +42,6 @@ rules:
   no-mixed-spaces-and-tabs: [1]
   # Allow but do not force dangling commas.
   comma-dangle: [0]
-  # prefer object shorthand for new object creation (i.e. var a = {};)
-  object-shorthand: [2, always]
   # use single quotes
   quotes: [2, single]
   # use semicolons to end statements
@@ -73,6 +71,7 @@ env:
   node: true
   # allow commonjs module definition globals (e.g. require, module.exports)
   commonjs: true
+  mocha: true
 
 
 

.travis.yml

@@ -0,0 +1,14 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+
+notifications:
+  slack: openframeproject:wGLUMLh5CTAIOGsPUSU8eMf3
+
+# A bit annoying, but we manually install all npm deps so that the install.sh script doesn't get executed on travis
+install:
+  npm install coveralls@^2.11.9 eslint@^2.8.0 istanbul@^0.4.2 mocha@^2.3.4 sinon@^1.17.2 openframe-extension@^0.1.0 debug@^2.2.0
+
+script:
+  - npm run test-coveralls

README.md

@@ -1,5 +1,7 @@
 # Openframe Website Extension
 
+[![Build Status](https://travis-ci.org/OpenframeProject/Openframe-Website.svg?branch=master)](https://travis-ci.org/OpenframeProject/Openframe-Website) [![Coverage Status](https://coveralls.io/repos/github/OpenframeProject/Openframe-Website/badge.svg?branch=master)](https://coveralls.io/github/OpenframeProject/Openframe-Website?branch=master)
+
 An Openframe format extension which enables display of websites via chromium.
 
 For info on developing your own extensions, see the [Openframe-ExtensionExample](https://github.com/OpenframeProject/Openframe-ExtensionExample) repo.

extension.js

@@ -1,34 +1,19 @@
 var pjson = require('./package.json'),
-    debug = require('debug')('openframe:website'),
-    extension = module.exports = {};
+    Extension = require('openframe-extension');
 
 /**
- * Extension initialization method.
+ * Extensions should expose an instance of the Extension class.
  *
- * Called when the extension (and its dependencies) have been installed.
- *
- * @param  {object} OF An interface provided to extensions giving limitted access to the frame environment
+ * For info on building extensions, see [Openframe-Extension](https://github.com/OpenframeProject/Openframe-Extension).
  */
-extension.init = function(OF) {
-    // do your extension thing
-    debug('=======>   Openframe-Website initialized!   <=======');
-
-    /**
-     * Extensions can add new artwork formats to the frame.
-     *
-     * Each format must have a unique name, which should correspond to the
-     * name of the npm package.
-     */
-    OF.addFormat(
-        {
-            // the name should be the same as the package name
-            'name': pjson.name,
-            // this is what might get displayed to users (not currently used)
-            'display_name': 'Website',
-            'download': false,
-            'start_command': 'xinit /usr/bin/chromium --kiosk $url',
-            'end_command': 'sudo pkill -f chromium'
-        }
-    );
-};
-
+module.exports = new Extension({
+    format: {
+        // the name should be the same as the package name
+        'name': pjson.name,
+        // this is what might get displayed to users (not currently used)
+        'display_name': 'Website',
+        'download': false,
+        'start_command': 'xinit /usr/bin/chromium --kiosk $url',
+        'end_command': 'sudo pkill -f chromium'
+    }
+});

package.json

@@ -7,12 +7,19 @@
     "install": "./install.sh",
     "uninstall": "./uninstall.sh",
     "patch-release": "npm version patch && npm publish && git push --follow-tags",
-    "test": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha"
+    "lint": "./node_modules/.bin/eslint extension.js test/**",
+    "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
+    "test": "npm run lint && ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha",
+    "test-coveralls": "npm run lint && ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly -- -R spec && npm run coveralls"
   },
   "keywords": [
     "openframe",
+    "extension",
+    "format",
+    "website",
+    "openframe-extension",
     "openframe-website",
-    "format"
+    "chromium"
   ],
   "author": {
     "name": "Jonathan Wohl",
@@ -30,6 +37,8 @@
   ],
   "license": "GPL-3.0",
   "devDependencies": {
+    "coveralls": "^2.11.9",
+    "eslint": "^2.8.0",
     "istanbul": "^0.4.2",
     "mocha": "^2.3.4",
     "sinon": "^1.17.2"
@@ -39,6 +48,7 @@
     "url": "https://github.com/OpenframeProject/Openframe-Website"
   },
   "dependencies": {
+    "openframe-extension": "^0.1.0",
     "debug": "^2.2.0"
   }
 }

test/extension.spec.js

@@ -0,0 +1,34 @@
+var assert = require('assert'),
+    Extension = require('openframe-extension'),
+    WebsiteExtension = require('../extension');
+
+describe('instantiation', function() {
+    it('should be an instance of type Extension', function() {
+        assert(WebsiteExtension instanceof Extension);
+    });
+});
+
+describe('properties', function() {
+    it('should include all required format properties', function() {
+        var format = WebsiteExtension.props.format;
+
+        assert(format.name);
+        assert(typeof format.name === 'string');
+
+        assert(format.display_name);
+        assert(typeof format.display_name === 'string');
+
+        assert(format.download !== undefined);
+        assert(typeof format.download === 'boolean');
+
+        assert(format.start_command);
+        assert(typeof format.start_command === 'string' || typeof format.start_command === 'function');
+
+        if (typeof format.start_command === 'function') {
+            assert(typeof format.start_command() === 'string');
+        }
+
+        assert(format.end_command);
+        assert(typeof format.end_command === 'string');
+    });
+});