initial version

Author: masi

.gitignore

@@ -0,0 +1 @@
+/node_modules

LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Martin Kutschker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,3 +1,42 @@
-# inspectreJs
+# inspectreJS
 
-A web layout regression testing tool.
+A web layout regression testing tool for [PhantomJS](http://phantomjs.org/) and [SlimerJS](http://slimerjs.org/).
+
+The code runs directly in PhantomJS or SlimerJS, it is not meant for [Node.js](https://nodejs.org/). 
+
+## Work In Progress
+
+Eventually inspectreJS is to be used with a continuous integration server to compare screenshots, CSS styles and DOM elements.
+Currently it will only make screenshots of given URLs (full page or parts).
+
+## Usage
+
+`phantomjs inspectre.js <config.json>`
+
+## Configuration File Format
+
+``` json
+{
+	"baseUrl": "<url>",
+	"paths": [
+		"<url-path>",
+		{
+			"path": "<url-path>",
+			"selectors": "<css-selector>"
+		},
+		{
+			"path": "<url-path>",
+			"selectors": [
+				"<css-selector>",
+				...
+			]
+		},
+		"<url>",
+		...
+	]
+}
+```
+
+## License
+
+MIT

inspectre.js

@@ -0,0 +1,37 @@
+/**
+ *
+ */
+
+'use strict';
+
+var system = require('system');
+var config = require('./lib/configuration.js');
+var ImageScraper = require('./../inspectre/node_modules/eerie-toolbox/lib/imagescraper.js');
+var configuration, queue;
+
+if (system.args.length !== 2) {
+	console.error("Usage: <phantomjs|slimerjs> inspectre.js config-file");
+	phantom.exit(1);
+} else {
+	try {
+		configuration = config.read(system.args[1]);
+		queue = config.buildImageScraperQueue(configuration);
+
+		ImageScraper.build().processQueue(
+			queue,
+			function (context) {
+				phantom.exit();
+			},
+			function (item, error, context) {
+				console.error('LOAD ERROR: ' + item.url);
+			},
+			function (item, error, context) {
+				console.error('ERROR: ' + error.message);
+				phantom.exit(1);
+			}
+		);
+	} catch (error) {
+		console.error('ERROR: ' + error.message);
+		phantom.exit(1);
+	}
+}

lib/configuration.js

@@ -0,0 +1,64 @@
+/**
+ *
+ */
+
+'use strict';
+
+var fs = require('fs');
+var URI = require('../node_modules/URIjs/src/URI.js');
+
+/**
+ *
+ * @param {string} filename
+ * @returns {object}
+ */
+function read(filename) {
+	var configString, configObject;
+	try {
+		configString = fs.read(filename);
+	} catch (error) {
+		throw new Error('Unable to open configuration file "' + filename + '".');
+	}
+	try {
+		configObject = JSON.parse(configString);
+	} catch (error) {
+		throw new Error('Unable to parse configuration file "' + filename + '".');
+	}
+	configObject.baseUrl = configObject.baseUrl || '';
+	configObject.paths = configObject.paths || [];
+	return configObject;
+}
+
+/**
+ *
+ * @param {object} configuration
+ * @returns {Array}
+ */
+function buildImageScraperQueue(configuration) {
+	var baseUrl = new URI(configuration.baseUrl).normalize(),
+		queue = [],
+		i, path, selectors;
+	for (i = 0; i < configuration.paths.length; i++) {
+		if (typeof configuration.paths[i] === 'string') {
+			path = configuration.paths[i];
+			selectors = [];
+		} else {
+			path = configuration.paths[i].path;
+			if (typeof configuration.paths[i].selectors === 'string') {
+				selectors = [configuration.paths[i].selectors];
+			} else {
+				selectors = configuration.paths[i].selectors;
+			}
+		}
+		queue.push({
+			url: new URI(path).absoluteTo(baseUrl).normalize().toString(),
+			selectors: selectors
+		});
+	}
+	return queue;
+}
+
+module.exports = {
+	read: read,
+	buildImageScraperQueue: buildImageScraperQueue
+};

package.json

@@ -0,0 +1,32 @@
+{
+	"name": "inspectrejs",
+	"version": "0.0.1",
+	"description": "A web layout regression testing tool for PhantomJS and SlimerJS.",
+	"keywords": [
+		"phantomjs",
+		"slimerjs",
+		"screenshot",
+		"cli"
+	],
+	"author": {
+		"name": "Martin Kutschker",
+		"email": "[email protected]"
+	},
+	"homepage": "https://github.com/masi/inspectrejs",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/masi/inspectrejs.git"
+	},
+	"bugs": {
+		"url": "https://github.com/masi/inspectrejs/issues"
+	},
+	"dependencies": {
+		"eerie-toolbox": "*",
+		"URIjs": ">=1.12"
+	},
+	"engines": {
+		"phantomjs": "*",
+		"slimerjs": "*"
+	}
+}