Compare commits

...

17 Commits
1.8.0 ... 1.9.0

Author SHA1 Message Date
Rowan Manning
fe2630e9cc Version 1.9.0 2016-04-25 22:00:38 +01:00
Rowan Manning
1794e72d0a Update to the latest version of the webservice 2016-04-25 21:59:19 +01:00
Rowan Manning
2ebcafece3 Style up the result selector and context 2016-04-25 21:53:11 +01:00
M Somerville
aadb791d47 Show first context and selector on results page
The message is sometimes specific, so point out it's the first result.
2016-04-25 21:39:52 +01:00
Rowan Manning
73b20f14f0 Remove the fixtures script from the Makefile 2016-04-25 21:37:20 +01:00
M Somerville
eff26a55a4 Add context and selector to CSV output 2016-04-25 21:33:05 +01:00
Rowan Manning
ea48d6a6fd Fix JSCS errors 2016-04-25 21:26:59 +01:00
Rowan Manning
90328cfa39 Fix JSHint errors 2016-04-25 21:17:03 +01:00
Rowan Manning
d766029bbb Switch from Grunt to Make 2016-04-25 21:16:53 +01:00
Rowan Manning
7ea14497d9 Merge pull request #98 from dracos/patch-1
Add SIGINT handler
2016-03-17 00:06:21 +00:00
Rowan Manning
4675d2200c Use the latest version of pa11y-webservice 2016-03-17 00:03:23 +00:00
M Somerville
f00a1ec426 Add SIGINT handler
This is so you can exit with a Ctrl-C.
2016-03-16 23:16:21 +00:00
Rowan Manning
3841c36889 Version 1.8.2 2016-02-10 08:35:30 +00:00
Rowan Manning
f39df5b33e Update the license in the footer 2016-02-10 08:34:56 +00:00
Rowan Manning
6575c7cf6e Version 1.8.1 2016-02-10 08:32:37 +00:00
Rowan Manning
708e4b997e Update repository references to springernature 2016-02-10 08:29:05 +00:00
Alex Kilgour
573b624a32 Version 1.8.0 2016-02-04 11:31:33 +00:00
46 changed files with 677 additions and 686 deletions

88
.jscsrc Normal file
View File

@@ -0,0 +1,88 @@
{
"disallowEmptyBlocks": true,
"disallowImplicitTypeConversion": [
"binary",
"numeric",
"string"
],
"disallowKeywordsOnNewLine": [
"catch",
"else"
],
"disallowMixedSpacesAndTabs": true,
"disallowMultipleSpaces": true,
"disallowMultipleVarDecl": true,
"disallowNewlineBeforeBlockStatements": true,
"disallowQuotedKeysInObjects": true,
"disallowSpaceAfterObjectKeys": true,
"disallowSpaceAfterPrefixUnaryOperators": true,
"disallowSpaceBeforeComma": true,
"disallowSpaceBeforeSemicolon": true,
"disallowSpacesInCallExpression": true,
"disallowSpacesInFunction": {
"beforeOpeningRoundBrace": true
},
"disallowSpacesInsideArrayBrackets": true,
"disallowSpacesInsideBrackets": true,
"disallowSpacesInsideObjectBrackets": true,
"disallowSpacesInsideParentheses": true,
"disallowTrailingComma": true,
"disallowTrailingWhitespace": true,
"disallowYodaConditions": true,
"maximumLineLength": 200,
"requireBlocksOnNewline": true,
"requireCapitalizedConstructors": true,
"requireCommaBeforeLineBreak": true,
"requireCurlyBraces": [
"if",
"else",
"for",
"while",
"do",
"switch",
"try",
"catch"
],
"requireDotNotation": true,
"requireLineBreakAfterVariableAssignment": true,
"requireLineFeedAtFileEnd": true,
"requireObjectKeysOnNewLine": true,
"requireParenthesesAroundIIFE": true,
"requireSemicolons": true,
"requireSpaceAfterBinaryOperators": true,
"requireSpaceAfterKeywords": [
"if",
"else",
"for",
"while",
"do",
"switch",
"try",
"catch"
],
"requireSpaceAfterLineComment": {
"allExcept": [
"="
]
},
"requireSpaceBeforeBinaryOperators": true,
"requireSpaceBeforeBlockStatements": true,
"requireSpaceBeforeObjectValues": true,
"requireSpaceBetweenArguments": true,
"requireSpacesInConditionalExpression": true,
"requireSpacesInForStatement": true,
"requireSpacesInFunction": {
"beforeOpeningCurlyBrace": true
},
"validateIndentation": "\t",
"validateLineBreaks": "LF",
"validateNewlineAfterArrayElements": true,
"validateParameterSeparator": ", ",
"validateQuoteMarks": "'",
"excludeFiles": [
"coverage",
"node_modules",
"public/js"
]
}

3
.jshintignore Normal file
View File

@@ -0,0 +1,3 @@
coverage
node_modules
public/js

29
.jshintrc Normal file
View File

@@ -0,0 +1,29 @@
{
"browser": true,
"curly": true,
"eqeqeq": true,
"forin": true,
"globals": {
"after": true,
"afterEach": true,
"before": true,
"beforeEach": true,
"describe": true,
"it": true
},
"latedef": "nofunc",
"maxcomplexity": 6,
"maxdepth": 2,
"maxparams": 4,
"noarg": true,
"node": true,
"nonew": true,
"nonstandard": true,
"regexp": true,
"shadow": true,
"strict": true,
"sub": true,
"trailing": true,
"undef": true,
"unused": true
}

View File

@@ -1,8 +1,18 @@
# Language/versions
language: node_js
node_js:
- "0.10"
matrix:
include:
# Run tests in Node.js 0.10 (unsupported)
- node_js: '0.10'
# Run tests in Node.js 0.12
- node_js: '0.12'
# Allow Node.js 0.10 to fail it's unsupported
allow_failures:
- node_js: '0.10'
# Build only master (and pull-requests)
branches:
@@ -15,15 +25,7 @@ services:
# Build script
before_script:
- npm install -g grunt-cli
- cp config/test.sample.json config/test.json
- grunt start-test &
- NODE_ENV=test node index.js &
- sleep 5 # give server time to start
script: 'grunt ci'
# Notifications
notifications:
email:
- j.robinson@nature.com
- perry.harlock@nature.com
- rowan.manning@nature.com
script: 'make ci'

View File

@@ -1,53 +0,0 @@
How To Contribute
=================
pa11y-dashboard accepts contributions from anyone, as long as you follow the guidelines below. If you'd like to contribute but aren't sure what there is for you to do, check the issue tracker for [things ready to be worked on][ready] and [known bugs][bugs].
It might be an idea to focus efforts on the goal of the [next milestone][milestones] before jumping onto anything too far ahead on the roadmap.
Features
--------
We won't accept features without prior discussion in the [issue tracker][issues]. Two heads are always better than one this blanket rule stops you from spending your valuable time on features which may not make it back into pa11y-dashboard.
If you want to fork the project and build on it by yourself, of course that's absolutely fine! Just don't expect your code to me merged back upstream :)
Refactoring/Rewriting
---------------------
We will accept refactors where it makes an improvement to the maintainability of the code-base or makes code more readable/understandable. If there's an argument about what's readable or not, chat about it in a pull-request.
Coding Guidelines
-----------------
* No trailing whitespace please (except in Markdown)
* Generally follow the style that is currently present in the code consistency is important
* Keep indentation consistent (tabs)
* Don't commit code with lint errors (run `grunt lint` to run JSHint with the correct configurations)
* Don't commit code without passing tests (run `grunt test`).
Versioning
----------
We use [Semantic Versioning][semver] in this project. The process for releasing a new version is as follows; this should only be done by core contributors you don't need to include a tagged version in your pull-requests.
* Switch to `master` and merge the `develop` branch into it
* Update the version number in `package.json` and `README.md`
* Commit the changes with the message: "Version x.x.x" (x.x.x being the new version number)
* Tag the commit with the version number (just the numbers, no "version" or "v"): `git tag x.x.x`
* Push with tags: `git push && git push --tags`
* Check out the `develop` branch, merge `master` into it, and push
* On GitHub, add [release notes][release-notes] for the new version. The title should be "Version x.x.x", and the description should be a list of new features/fixes
[bugs]: https://github.com/nature/pa11y-dashboard/issues?labels=bug&state=open
[ready]: https://github.com/nature/pa11y-dashboard/issues?labels=ready&state=open
[issues]: https://github.com/nature/pa11y-dashboard/issues
[milestones]: https://github.com/nature/pa11y-dashboard/issues/milestones
[release-notes]: https://github.com/nature/pa11y-dashboard/releases
[semver]: http://semver.org/

View File

@@ -1,135 +0,0 @@
// This file is part of pa11y-dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// pa11y-dashboard is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
module.exports = function (grunt) {
grunt.initConfig({
jshint: {
all: [
'**/*.js',
'!node_modules/**/*.js',
'!public/js/vendor/**/*.js',
'!public/js/site.min.js'
],
options: {
es3: false,
indent: 4,
latedef: false,
maxcomplexity: 6,
maxdepth: 2,
maxlen: 100,
maxparams: 4,
maxstatements: false,
node: true,
quotmark: 'single'
}
},
less: {
all: {
options: {
cleancss: true
},
files: {
'public/css/site.min.css': 'public/less/main.less'
}
}
},
mochaTest: {
functional: {
src: ['test/functional/**/*.js'],
options: {
reporter: 'spec',
timeout: 4000
}
}
},
nodemon: {
development: {
options: {
cwd: __dirname,
file: 'index.js',
env: {
NODE_ENV: 'development'
}
}
},
test: {
options: {
cwd: __dirname,
file: 'index.js',
env: {
NODE_ENV: 'test'
}
}
}
},
uglify: {
options: {
mangle: false
},
all: {
files: {
'public/js/site.min.js': [
'public/js/vendor/jquery/jquery.min.js',
'public/js/vendor/bootstrap/js/alert.js',
'public/js/vendor/bootstrap/js/dropdown.js',
'public/js/vendor/bootstrap/js/tooltip.js',
'public/js/vendor/bootstrap/js/transition.js',
'public/js/vendor/bootstrap/js/collapse.js',
'public/js/vendor/flot/jquery.flot.js',
'public/js/vendor/flot/jquery.flot.dashes.js',
'public/js/vendor/flot/jquery.flot.time.js',
'public/js/vendor/flot/jquery.flot.selection.js',
'public/js/vendor/flot/jquery.flot.resize.js',
'public/js/site.js'
]
}
}
},
watch: {
less: {
files: ['public/less/**/*.less'],
tasks: ['less']
},
js: {
files: ['public/js/**/*.js', '!public/js/site.min.js'],
tasks: ['uglify']
}
}
});
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-less');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-mocha-test');
grunt.loadNpmTasks('grunt-nodemon');
grunt.registerTask('lint', ['jshint']);
grunt.registerTask('test', ['mochaTest']);
grunt.registerTask('compile', ['less', 'uglify']);
grunt.registerTask('start', ['nodemon:development']);
grunt.registerTask('start-test', ['nodemon:test']);
grunt.registerTask('default', ['compile', 'lint', 'test']);
grunt.registerTask('ci', ['lint', 'test']);
};

59
Makefile Normal file
View File

@@ -0,0 +1,59 @@
# Color helpers
C_CYAN=\x1b[34;01m
C_RESET=\x1b[0m
# Group targets
all: deps lint test
ci: lint test
# Install dependencies
deps:
@echo "$(C_CYAN)> installing dependencies$(C_RESET)"
@npm install
# Lint JavaScript
lint: jshint jscs
# Run JSHint
jshint:
@echo "$(C_CYAN)> linting javascript$(C_RESET)"
@./node_modules/.bin/jshint .
# Run JavaScript Code Style
jscs:
@echo "$(C_CYAN)> checking javascript code style$(C_RESET)"
@./node_modules/.bin/jscs .
# Run all tests
test: test-integration
# Run integration tests
test-integration:
@echo "$(C_CYAN)> running integration tests$(C_RESET)"
@./node_modules/.bin/mocha ./test/integration --reporter spec --recursive --timeout 5000 --slow 50
# Compile LESS
less:
@echo "$(C_CYAN)> compiling less$(C_RESET)"
@./node_modules/.bin/lessc -x ./public/less/main.less ./public/css/site.min.css
# Compile client-side JavaScript
uglify:
@echo "$(C_CYAN)> compiling client-side JavaScript$(C_RESET)"
@./node_modules/.bin/uglifyjs \
public/js/vendor/jquery/jquery.min.js \
public/js/vendor/bootstrap/js/alert.js \
public/js/vendor/bootstrap/js/dropdown.js \
public/js/vendor/bootstrap/js/tooltip.js \
public/js/vendor/bootstrap/js/transition.js \
public/js/vendor/bootstrap/js/collapse.js \
public/js/vendor/flot/jquery.flot.js \
public/js/vendor/flot/jquery.flot.dashes.js \
public/js/vendor/flot/jquery.flot.time.js \
public/js/vendor/flot/jquery.flot.selection.js \
public/js/vendor/flot/jquery.flot.resize.js \
public/js/site.js \
-o ./public/js/site.min.js
.PHONY: test

View File

@@ -3,7 +3,7 @@ pa11y-dashboard
pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
**Current Version:** *1.7.0*
**Current Version:** *1.9.0*
**Build Status:** [![Build Status][travis-img]][travis]
**Node Version Support:** *0.10*
@@ -22,9 +22,9 @@ You'll then need to clone this repo locally and install dependencies with `npm i
Once you have a local clone, you'll need to copy some sample configuration files in order to run the application. From within the repo, run the following commands:
```sh
$ cp config/development.sample.json config/development.json
$ cp config/production.sample.json config/production.json
$ cp config/test.sample.json config/test.json
cp config/development.sample.json config/development.json
cp config/production.sample.json config/production.json
cp config/test.sample.json config/test.json
```
Each of these files defines configurations for a different environment. If you're just running the application locally, then you should be OK with just development configurations. The [available configurations are documented here](#configurations).
@@ -32,9 +32,9 @@ Each of these files defines configurations for a different environment. If you'r
Now that you've got your application configured, you can run in each mode with the following commands:
```sh
$ NODE_ENV=production node . # Run in production
$ NODE_ENV=development node . # Run in development
$ NODE_ENV=test node . # Run in test
NODE_ENV=production node index.js # Run in production
NODE_ENV=development node index.js # Run in development
NODE_ENV=test node index.js # Run in test
```
Check the [development instructions](#development) for more information about running locally (and restarting automatically when files change).
@@ -64,46 +64,46 @@ This can either be an object containing [pa11y-webservice configurations][pa11y-
Development
-----------
To develop pa11y-dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup). You'll also need [Grunt][grunt] to be installed globally in order to run tests, you can do this with `npm install -g grunt-cli`.
To develop pa11y-dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
Once you've done this, you'll need to start the application in test mode with:
You'll need to start the application in test mode with:
```sh
$ grunt start-test
NODE_ENV=test node index.js
```
Now you'll be able to run the following commands:
```sh
$ grunt # Run the lint and test tasks together
$ grunt lint # Run JSHint with the correct config
$ grunt compile # Compile front-end assets
$ grunt start # Run app in development mode, restarting if files change
$ grunt start-test # Run app in test mode, restarting if files change
$ grunt test # Run functional tests
$ grunt watch # Watch for file changes and compile assets
make # Run the lint and test tasks together
make lint # Run linters with the correct config
make test # Run integration tests
```
Code with lint errors or failing tests will not be accepted, please use the build tools outlined above.
For users with push-access, don't commit to the master branch. Code should be in `develop` until it's ready to be released.
To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.
```sh
make css # Compile the site CSS from LESS files
make uglify # Compile and uglify the client-side JavaScript
```
License
-------
[Copyright 2013 Nature Publishing Group](LICENSE.txt).
[Copyright 2013 Springer Nature](LICENSE.txt).
pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
[grunt]: http://gruntjs.com/
[mongo]: http://www.mongodb.org/
[node]: http://nodejs.org/
[pa11y]: https://github.com/nature/pa11y
[pa11y-webservice]: https://github.com/nature/pa11y-webservice
[pa11y-webservice-config]: https://github.com/nature/pa11y-webservice#configurations
[pa11y]: https://github.com/springernature/pa11y
[pa11y-webservice]: https://github.com/springernature/pa11y-webservice
[pa11y-webservice-config]: https://github.com/springernature/pa11y-webservice#configurations
[phantom]: http://phantomjs.org/
[travis]: https://travis-ci.org/nature/pa11y-dashboard
[travis-img]: https://travis-ci.org/nature/pa11y-dashboard.png?branch=master
[travis]: https://travis-ci.org/springernature/pa11y-dashboard
[travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master

16
app.js
View File

@@ -25,11 +25,11 @@ var pkg = require('./package.json');
module.exports = initApp;
// Initialise the application
function initApp (config, callback) {
function initApp(config, callback) {
config = defaultConfig(config);
var webserviceUrl = config.webservice;
if (typeof webserviceUrl == 'object') {
if (typeof webserviceUrl === 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
}
@@ -58,7 +58,7 @@ function initApp (config, callback) {
contentHelperName: 'content',
layoutsDir: __dirname + '/view/layout',
partialsDir: __dirname + '/view/partial',
defaultLayout: __dirname + '/view/layout/default',
defaultLayout: __dirname + '/view/layout/default'
}));
app.express.set('view engine', 'html');
@@ -79,7 +79,7 @@ function initApp (config, callback) {
siteMessage: config.siteMessage
});
app.express.use(function (req, res, next) {
app.express.use(function(req, res, next) {
res.locals.isHomePage = (req.path === '/');
res.locals.host = req.host;
next();
@@ -100,11 +100,11 @@ function initApp (config, callback) {
}
// Error handling
app.express.get('*', function (req, res) {
app.express.get('*', function(req, res) {
res.status(404);
res.render('404');
});
app.express.use(function (err, req, res, next) {
app.express.use(function(err, req, res, next) {
/* jshint unused: false */
if (err.code === 'ECONNREFUSED') {
err = new Error('Could not connect to pa11y-webservice');
@@ -117,7 +117,7 @@ function initApp (config, callback) {
res.render('500');
});
app.server.listen(config.port, function (err) {
app.server.listen(config.port, function(err) {
var address = app.server.address();
app.address = 'http://' + address.address + ':' + address.port;
callback(err, app);
@@ -126,7 +126,7 @@ function initApp (config, callback) {
}
// Get default configurations
function defaultConfig (config) {
function defaultConfig(config) {
if (typeof config.noindex !== 'boolean') {
config.noindex = true;
}

View File

@@ -13,12 +13,12 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* jshint maxlen: false */
// jscs:disable maximumLineLength
'use strict';
module.exports = getStandards;
function getStandards () {
function getStandards() {
return [
{
title: 'Section508',
@@ -656,10 +656,12 @@ function getStandards () {
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2',
description: 'Img element is the only content of the link, but is missing alt text. The alt text should describe the purpose of the link.'
}, {
},
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H37',
description: 'Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.'
}, {
},
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H67.1',
description: 'Img element with empty alt text must have absent or empty title attribute.'
},

View File

@@ -18,14 +18,19 @@
var chalk = require('chalk');
var config = require('./config/' + (process.env.NODE_ENV || 'development') + '.json');
require('./app')(config, function (err, app) {
process.on('SIGINT', function() {
console.log('\nGracefully shutting down from SIGINT (Ctrl-C)');
process.exit();
});
require('./app')(config, function(err, app) {
console.log('');
console.log(chalk.underline.magenta('pa11y-dashboard started'));
console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);
console.log(chalk.grey('uri: %s'), app.address);
app.on('route-error', function (err) {
app.on('route-error', function(err) {
var stack = (err.stack ? err.stack.split('\n') : [err.message]);
var msg = chalk.red(stack.shift());
console.error('');
@@ -35,7 +40,7 @@ require('./app')(config, function (err, app) {
// Start the webservice if required
if (typeof config.webservice === 'object') {
require('pa11y-webservice')(config.webservice, function (err, webservice) {
require('pa11y-webservice')(config.webservice, function(err, webservice) {
console.log('');
console.log(chalk.underline.cyan('pa11y-webservice started'));
console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);

View File

@@ -1,6 +1,6 @@
{
"name": "pa11y-dashboard",
"version": "1.7.0",
"version": "1.9.0",
"private": true,
"description": "pa11y-dashboard is a visual web interface to the pa11y accessibility reporter",
@@ -12,10 +12,10 @@
"repository": {
"type": "git",
"url": "https://github.com/nature/pa11y-dashboard.git"
"url": "https://github.com/springernature/pa11y-dashboard.git"
},
"homepage": "https://github.com/nature/pa11y-dashboard",
"bugs": "https://github.com/nature/pa11y-dashboard/issues",
"homepage": "https://github.com/springernature/pa11y-dashboard",
"bugs": "https://github.com/springernature/pa11y-dashboard/issues",
"engines": {
"node": ">=0.10"
@@ -25,25 +25,24 @@
"express": "~3.4",
"express-hbs": "~0.2",
"moment": "~2.2",
"pa11y-webservice": "~1.6",
"pa11y-webservice": "~1.8",
"pa11y-webservice-client-node": "~1.1",
"underscore": "~1.5"
},
"devDependencies": {
"bower": "~1.2",
"grunt": "~0.4",
"grunt-contrib-jshint": "~0.7",
"grunt-contrib-less": "~0.8",
"grunt-contrib-uglify": "~0.2",
"grunt-contrib-watch": "~0.5",
"grunt-mocha-test": "~0.7",
"grunt-nodemon": "~0.1",
"jsdom": "~0.8",
"proclaim": "~2.0",
"request": "~2.27"
"jscs": "^2",
"jsdom": "^3",
"jshint": "^2",
"less": "~1.5",
"mocha": "^2",
"proclaim": "^3",
"request": "~2.27",
"uglify-js": "~2.4"
},
"scripts": {
"start": "node ."
"start": "node index.js",
"test": "make ci"
}
}

File diff suppressed because one or more lines are too long

View File

@@ -17,7 +17,6 @@ code {
font-size: 90%;
color: @code-color;
background-color: @code-bg;
white-space: nowrap;
border-radius: @border-radius-base;
}

View File

@@ -20,9 +20,9 @@ var presentTask = require('../view/presenter/task');
module.exports = route;
// Route definition
function route (app) {
app.express.get('/', function (req, res, next) {
app.webservice.tasks.get({lastres: true}, function (err, tasks) {
function route(app) {
app.express.get('/', function(req, res, next) {
app.webservice.tasks.get({lastres: true}, function(err, tasks) {
if (err) {
return next(err);
}

View File

@@ -20,10 +20,10 @@ var getStandards = require('../data/standards');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/new', function (req, res) {
var standards = getStandards().map(function (standard) {
app.express.get('/new', function(req, res) {
var standards = getStandards().map(function(standard) {
if (standard.title === 'WCAG2AA') {
standard.selected = true;
}
@@ -35,7 +35,7 @@ function route (app) {
});
});
app.express.post('/new', function (req, res) {
app.express.post('/new', function(req, res) {
var newTask = {
name: req.body.name,
url: req.body.url,
@@ -45,13 +45,13 @@ function route (app) {
username: req.body.username,
password: req.body.password
};
app.webservice.tasks.create(newTask, function (err, task) {
app.webservice.tasks.create(newTask, function(err, task) {
if (err) {
var standards = getStandards().map(function (standard) {
var standards = getStandards().map(function(standard) {
if (standard.title === newTask.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function (rule) {
standard.rules = standard.rules.map(function(rule) {
if (newTask.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}

View File

@@ -20,67 +20,69 @@ var moment = require('moment');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
function getTaskAndResult (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
if (err) {
return next('route');
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function (err, result) {
if (err) {
return next('route');
}
res.locals.task = task;
res.locals.result = result;
next();
});
});
}
function getTaskAndResult(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next('route');
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function(err, result) {
if (err) {
return next('route');
}
res.locals.task = task;
res.locals.result = result;
next();
});
});
}
function getDownloadFileName (task, result, extension) {
return [
'pa11y',
'--',
task.url
.replace(/^https?:\/\//i, '')
.replace(/\/$/, '')
.replace(/[^a-z0-9\.\-\_]+/gi, '-'),
'--',
task.standard.toLowerCase(),
'--',
moment(result.date).format('YYYY-MM-DD'),
'.',
extension
].join('');
}
function getDownloadFileName(task, result, extension) {
return [
'pa11y',
'--',
task.url
.replace(/^https?:\/\//i, '')
.replace(/\/$/, '')
.replace(/[^a-z0-9\.\-\_]+/gi, '-'),
'--',
task.standard.toLowerCase(),
'--',
moment(result.date).format('YYYY-MM-DD'),
'.',
extension
].join('');
}
app.express.get('/:id/:rid.csv', getTaskAndResult, function (req, res) {
var task = res.locals.task;
var result = res.locals.result;
var rows = ['"code","message","type"'];
result.results.forEach(function (msg) {
rows.push([
JSON.stringify(msg.code),
JSON.stringify(msg.message),
JSON.stringify(msg.type)
].join(','));
});
res.attachment(getDownloadFileName(task, result, 'csv'));
res.send(rows.join('\n'));
});
app.express.get('/:id/:rid.csv', getTaskAndResult, function(req, res) {
var task = res.locals.task;
var result = res.locals.result;
var rows = ['"code","message","type","context","selector"'];
result.results.forEach(function(msg) {
rows.push([
JSON.stringify(msg.code),
JSON.stringify(msg.message),
JSON.stringify(msg.type),
JSON.stringify(msg.context),
JSON.stringify(msg.selector)
].join(','));
});
res.attachment(getDownloadFileName(task, result, 'csv'));
res.send(rows.join('\n'));
});
app.express.get('/:id/:rid.json', getTaskAndResult, function (req, res) {
var task = res.locals.task;
var result = res.locals.result;
res.attachment(getDownloadFileName(task, result, 'json'));
delete task.id;
delete result.id;
result.task = task;
res.send(result);
});
app.express.get('/:id/:rid.json', getTaskAndResult, function(req, res) {
var task = res.locals.task;
var result = res.locals.result;
res.attachment(getDownloadFileName(task, result, 'json'));
delete task.id;
delete result.id;
result.task = task;
res.send(result);
});
}

View File

@@ -21,27 +21,27 @@ var presentResult = require('../../view/presenter/result');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/:id/:rid', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
if (err) {
return next();
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function (err, result) {
if (err) {
return next();
}
res.render('result', {
task: presentTask(task),
mainResult: presentResult(result),
isResultPage: true
});
});
});
});
app.express.get('/:id/:rid', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function(err, result) {
if (err) {
return next();
}
res.render('result', {
task: presentTask(task),
mainResult: presentResult(result),
isResultPage: true
});
});
});
});
}

View File

@@ -15,16 +15,15 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/:id/delete', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
app.express.get('/:id/delete', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
@@ -35,8 +34,8 @@ function route (app) {
});
});
app.express.post('/:id/delete', function (req, res, next) {
app.webservice.task(req.params.id).remove(function (err) {
app.express.post('/:id/delete', function(req, res, next) {
app.webservice.task(req.params.id).remove(function(err) {
if (err) {
return next();
}

View File

@@ -15,25 +15,24 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/:id/edit', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
app.express.get('/:id/edit', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
var standards = getStandards().map(function (standard) {
var standards = getStandards().map(function(standard) {
if (standard.title === task.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function (rule) {
standard.rules = standard.rules.map(function(rule) {
if (task.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}
@@ -50,24 +49,24 @@ function route (app) {
});
});
app.express.post('/:id/edit', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
app.express.post('/:id/edit', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
req.body.ignore = req.body.ignore || [];
app.webservice.task(req.params.id).edit(req.body, function (err) {
app.webservice.task(req.params.id).edit(req.body, function(err) {
if (err) {
task.name = req.body.name;
task.ignore = req.body.ignore;
task.timeout = req.body.timeout;
task.username = req.body.username;
task.password = req.body.password;
var standards = getStandards().map(function (standard) {
var standards = getStandards().map(function(standard) {
if (standard.title === task.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function (rule) {
standard.rules = standard.rules.map(function(rule) {
if (task.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}

View File

@@ -1,16 +1,12 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.post('/:id/ignore', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
app.express.post('/:id/ignore', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
@@ -21,7 +17,7 @@ function route (app) {
if (typeof req.body.rule === 'string') {
edit.ignore.push(req.body.rule);
}
app.webservice.task(req.params.id).edit(edit, function () {
app.webservice.task(req.params.id).edit(edit, function() {
res.redirect('/' + req.params.id + '?rule-ignored');
});
});

View File

@@ -22,14 +22,14 @@ var presentResultList = require('../../view/presenter/result-list');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/:id', function (req, res, next) {
app.webservice.task(req.params.id).get({lastres: true}, function (err, task) {
app.express.get('/:id', function(req, res, next) {
app.webservice.task(req.params.id).get({lastres: true}, function(err, task) {
if (err) {
return next();
}
app.webservice.task(req.params.id).results({}, function (err, results) {
app.webservice.task(req.params.id).results({}, function(err, results) {
if (err) {
return next(err);
}

View File

@@ -18,10 +18,10 @@
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.get('/:id/run', function (req, res, next) {
app.webservice.task(req.params.id).run(function (err, task) {
app.express.get('/:id/run', function(req, res, next) {
app.webservice.task(req.params.id).run(function(err) {
if (err) {
return next();
}

View File

@@ -1,16 +1,12 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
module.exports = route;
// Route definition
function route (app) {
function route(app) {
app.express.post('/:id/unignore', function (req, res, next) {
app.webservice.task(req.params.id).get({}, function (err, task) {
app.express.post('/:id/unignore', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
return next();
}
@@ -22,7 +18,7 @@ function route (app) {
if (typeof req.body.rule === 'string' && indexOfRule !== -1) {
edit.ignore.splice(indexOfRule, 1);
}
app.webservice.task(req.params.id).edit(edit, function () {
app.webservice.task(req.params.id).edit(edit, function() {
res.redirect('/' + req.params.id + '?rule-unignored');
});
});

View File

@@ -21,8 +21,8 @@ var request = require('request');
module.exports = createNavigator;
// Create a navigate function
function createNavigator (baseUrl, store) {
return function (opts, callback) {
function createNavigator(baseUrl, store) {
return function(opts, callback) {
store.body = null;
store.dom = null;
@@ -38,7 +38,7 @@ function createNavigator (baseUrl, store) {
json: true,
qs: opts.query,
followAllRedirects: true
}, function (err, res, body) {
}, function(err, res, body) {
store.body = body;
store.request = res.request;
@@ -52,7 +52,7 @@ function createNavigator (baseUrl, store) {
} else {
jsdom.env(
store.body,
function (err, window) {
function(err, window) {
store.window = window;
store.dom = window.document;
callback();

View File

@@ -20,9 +20,9 @@ var createClient = require('pa11y-webservice-client-node');
module.exports = createWebserviceClient;
// Create a webservice client
function createWebserviceClient (config) {
function createWebserviceClient(config) {
var webserviceUrl = config.webservice;
if (typeof webserviceUrl == 'object') {
if (typeof webserviceUrl === 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
}
return createClient(webserviceUrl);

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /', function () {
describe('GET /', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/'
@@ -29,17 +27,17 @@ describe('GET /', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Add new URL" button', function () {
it('should display an "Add new URL" button', function() {
var elem = this.last.dom.querySelectorAll('[data-test=add-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/new');
});
it('should display all of the expected tasks', function () {
it('should display all of the expected tasks', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks.length, 3);
assert.match(tasks[0].textContent, /npg home\s+\(wcag2aa\)/i);
@@ -47,47 +45,47 @@ describe('GET /', function () {
assert.match(tasks[2].textContent, /nature news\s+\(section508\)/i);
});
it('should have links to each task', function () {
it('should have links to each task', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003"]').length, 1);
});
it('should display an "Edit" button for each task', function () {
it('should display an "Edit" button for each task', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/edit"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/edit"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/edit"]').length, 1);
});
it('should display a "Delete" button for each task', function () {
it('should display a "Delete" button for each task', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/delete"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/delete"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/delete"]').length, 1);
});
it('should display a "Run" button for each task', function () {
it('should display a "Run" button for each task', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/run"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/run"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/run"]').length, 1);
});
it('should display the task result counts if the task has been run', function () {
it('should display the task result counts if the task has been run', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.match(tasks[0].textContent, /1\s*errors/i);
assert.match(tasks[0].textContent, /2\s*warnings/i);
assert.match(tasks[0].textContent, /3\s*notices/i);
});
it('should display a message indicating that there are no results if the task has not been run', function () {
it('should display a message indicating that there are no results if the task has not been run', function() {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.match(tasks[2].textContent, /no results/i);
});
it('should not display an alert message', function () {
it('should not display an alert message', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=alert]').length, 0);
});

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /new', function () {
describe('GET /new', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/new'
@@ -29,62 +27,62 @@ describe('GET /new', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should not display an error message', function () {
it('should not display an error message', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 0);
});
it('should have an "Add new URL" form', function () {
it('should have an "Add new URL" form', function() {
var form = this.last.dom.querySelectorAll('[data-test=new-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/new');
assert.strictEqual(form.getAttribute('method'), 'post');
});
describe('"Add New URL" form', function () {
describe('"Add New URL" form', function() {
beforeEach(function () {
beforeEach(function() {
this.form = this.last.dom.querySelectorAll('[data-test=new-url-form]')[0];
});
it('should have a "name" field', function () {
it('should have a "name" field', function() {
var field = this.form.querySelectorAll('input[name=name]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "url" field', function () {
it('should have a "url" field', function() {
var field = this.form.querySelectorAll('input[name=url]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'url');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "username" field', function () {
it('should have a "username" field', function() {
var field = this.form.querySelectorAll('input[name=username]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "password" field', function () {
it('should have a "password" field', function() {
var field = this.form.querySelectorAll('input[name=password]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "standard" field', function () {
it('should have a "standard" field', function() {
var field = this.form.querySelectorAll('select[name=standard]')[0];
assert.isDefined(field);
assert.strictEqual(field.querySelectorAll('option').length, 4);
});
it('should have "ignore" fields', function () {
it('should have "ignore" fields', function() {
var fields = this.form.querySelectorAll('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
@@ -94,11 +92,11 @@ describe('GET /new', function () {
});
describe('POST /new', function () {
describe('POST /new', function() {
describe('with invalid query', function () {
describe('with invalid query', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'POST',
endpoint: '/new',
@@ -110,19 +108,19 @@ describe('POST /new', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display an error message', function () {
it('should display an error message', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 1);
});
});
describe('with valid query', function () {
describe('with valid query', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'POST',
endpoint: '/new',
@@ -135,26 +133,26 @@ describe('POST /new', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should create the task', function (done) {
this.webservice.tasks.get({}, function (err, tasks) {
it('should create the task', function(done) {
this.webservice.tasks.get({}, function(err, tasks) {
assert.strictEqual(tasks.length, 4);
done();
});
});
it('should redirect me to the new URL page', function () {
it('should redirect me to the new URL page', function() {
assert.match(this.last.request.uri.pathname, /^\/[a-z0-9]{24}$/i);
});
it('should not display an error message', function () {
it('should not display an error message', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 0);
});
it('should display a success message', function () {
it('should display a success message', function() {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /url has been added/i);

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/<result-id>.csv', function () {
describe('GET /<task-id>/<result-id>.csv', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001.csv',
@@ -30,19 +28,19 @@ describe('GET /<task-id>/<result-id>.csv', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should output CSV results', function () {
it('should output CSV results', function() {
assert.match(this.last.body, /^"code","message","type"/);
});
});
describe('GET /<task-id>/<result-id>.json', function () {
describe('GET /<task-id>/<result-id>.json', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001.json',
@@ -51,11 +49,11 @@ describe('GET /<task-id>/<result-id>.json', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should output JSON results', function () {
it('should output JSON results', function() {
var json = this.last.body;
assert.strictEqual(json.task.name, 'NPG Home');
assert.strictEqual(json.task.url, 'nature.com');

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/<result-id>', function () {
describe('GET /<task-id>/<result-id>', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001'
@@ -29,39 +27,39 @@ describe('GET /<task-id>/<result-id>', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display a "Download CSV" button', function () {
it('should display a "Download CSV" button', function() {
var elem = this.last.dom.querySelectorAll('[data-test=download-csv]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000001/def000000000000000000001.csv');
});
it('should display a "Download JSON" button', function () {
it('should display a "Download JSON" button', function() {
var elem = this.last.dom.querySelectorAll('[data-test=download-json]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000001/def000000000000000000001.json');
});
it('should display a link back to the task', function () {
it('should display a link back to the task', function() {
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]')[0]);
});
it('should display errors', function () {
it('should display errors', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-errors]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /errors \( 1 \)/i);
});
it('should display warnings', function () {
it('should display warnings', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-warnings]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /warnings \( 2 \)/i);
});
it('should display notices', function () {
it('should display notices', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-notices]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /notices \( 3 \)/i);

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/delete', function () {
describe('GET /<task-id>/delete', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/delete'
@@ -29,26 +27,26 @@ describe('GET /<task-id>/delete', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should have a "Delete URL" form', function () {
it('should have a "Delete URL" form', function() {
var form = this.last.dom.querySelectorAll('[data-test=delete-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/abc000000000000000000001/delete');
assert.strictEqual(form.getAttribute('method'), 'post');
});
it('should display a link back to the task page', function () {
it('should display a link back to the task page', function() {
assert.greaterThan(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]').length, 0);
});
});
describe('POST /<task-id>/delete', function () {
describe('POST /<task-id>/delete', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'POST',
endpoint: '/abc000000000000000000001/delete'
@@ -56,22 +54,22 @@ describe('POST /<task-id>/delete', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should delete the task', function (done) {
this.webservice.task('abc000000000000000000001').get({}, function (err) {
it('should delete the task', function(done) {
this.webservice.task('abc000000000000000000001').get({}, function(err) {
assert.strictEqual(err.message, 'Error 404');
done();
});
});
it('should redirect me to the home page', function () {
it('should redirect me to the home page', function() {
assert.strictEqual(this.last.request.uri.pathname, '/');
});
it('should display a success message', function () {
it('should display a success message', function() {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /been deleted/i);

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/edit', function () {
describe('GET /<task-id>/edit', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/edit'
@@ -29,35 +27,35 @@ describe('GET /<task-id>/edit', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should have an "Edit URL" form', function () {
it('should have an "Edit URL" form', function() {
var form = this.last.dom.querySelectorAll('[data-test=edit-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/abc000000000000000000001/edit');
assert.strictEqual(form.getAttribute('method'), 'post');
});
it('should display a link back to the task page', function () {
it('should display a link back to the task page', function() {
assert.greaterThan(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]').length, 0);
});
describe('"Edit URL" form', function () {
describe('"Edit URL" form', function() {
beforeEach(function () {
beforeEach(function() {
this.form = this.last.dom.querySelectorAll('[data-test=edit-url-form]')[0];
});
it('should have a "name" field', function () {
it('should have a "name" field', function() {
var field = this.form.querySelectorAll('input[name=name]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'NPG Home');
});
it('should have a disabled "url" field', function () {
it('should have a disabled "url" field', function() {
var field = this.form.querySelectorAll('input[name=url]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'url');
@@ -65,27 +63,27 @@ describe('GET /<task-id>/edit', function () {
assert.isDefined(field.getAttribute('disabled'));
});
it('should have a disabled "standard" field', function () {
it('should have a disabled "standard" field', function() {
var field = this.form.querySelectorAll('select[name=standard]')[0];
assert.isDefined(field);
assert.isDefined(field.getAttribute('disabled'));
});
it('should have a "username" field', function () {
it('should have a "username" field', function() {
var field = this.form.querySelectorAll('input[name=username]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'user');
});
it('should have a "password" field', function () {
it('should have a "password" field', function() {
var field = this.form.querySelectorAll('input[name=password]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'access');
});
it('should have "ignore" fields', function () {
it('should have "ignore" fields', function() {
var fields = this.form.querySelectorAll('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
@@ -95,9 +93,9 @@ describe('GET /<task-id>/edit', function () {
});
describe('POST /<task-id>/edit', function () {
describe('POST /<task-id>/edit', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'POST',
endpoint: '/abc000000000000000000001/edit',
@@ -111,12 +109,12 @@ describe('POST /<task-id>/edit', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should edit the task', function (done) {
this.webservice.task('abc000000000000000000001').get({}, function (err, task) {
it('should edit the task', function(done) {
this.webservice.task('abc000000000000000000001').get({}, function(err, task) {
assert.strictEqual(task.name, 'foo');
assert.strictEqual(task.username, 'newuser');
assert.strictEqual(task.password, 'secure');
@@ -125,11 +123,10 @@ describe('POST /<task-id>/edit', function () {
});
});
it('should display a success message', function () {
it('should display a success message', function() {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /been saved/i);
});
});

View File

@@ -13,17 +13,15 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>', function () {
describe('GET /<task-id>', function() {
describe('when task has results', function () {
describe('when task has results', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001'
@@ -31,48 +29,48 @@ describe('GET /<task-id>', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Edit" button', function () {
it('should display an "Edit" button', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/edit"]').length, 1);
});
it('should display a "Delete" button', function () {
it('should display a "Delete" button', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/delete"]').length, 1);
});
it('should display a "Run" button', function () {
it('should display a "Run" button', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/run"]').length, 1);
});
it('should display a "Download CSV" button for the latest result', function () {
it('should display a "Download CSV" button for the latest result', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001.csv"]').length, 1);
});
it('should display a "Download JSON" button for the latest result', function () {
it('should display a "Download JSON" button for the latest result', function() {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001.json"]').length, 1);
});
it('should display links to all results', function () {
it('should display links to all results', function() {
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001"]')[0]);
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000003"]')[0]);
});
it('should display errors', function () {
it('should display errors', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-errors]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /errors \( 1 \)/i);
});
it('should display warnings', function () {
it('should display warnings', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-warnings]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /warnings \( 2 \)/i);
});
it('should display notices', function () {
it('should display notices', function() {
var elem = this.last.dom.querySelectorAll('[data-test=task-notices]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /notices \( 3 \)/i);
@@ -80,9 +78,9 @@ describe('GET /<task-id>', function () {
});
describe('when task has no results', function () {
describe('when task has no results', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000003'
@@ -90,17 +88,17 @@ describe('GET /<task-id>', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display a "Run" button', function () {
it('should display a "Run" button', function() {
var elem = this.last.dom.querySelectorAll('[data-test=run-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000003/run');
});
it('should display a message indicating that there are no results', function () {
it('should display a message indicating that there are no results', function() {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /there are no results to show/i);

View File

@@ -13,15 +13,13 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/run', function () {
describe('GET /<task-id>/run', function() {
beforeEach(function (done) {
beforeEach(function(done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/run'
@@ -29,15 +27,15 @@ describe('GET /<task-id>/run', function () {
this.navigate(req, done);
});
it('should send a 200 status', function () {
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should redirect me to the task page', function () {
it('should redirect me to the task page', function() {
assert.strictEqual(this.last.request.uri.pathname, '/abc000000000000000000001');
});
it('should display a success message', function () {
it('should display a success message', function() {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /new results are being generated/i);

View File

@@ -13,8 +13,6 @@
// You should have received a copy of the GNU General Public License
// along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global afterEach, before */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var config = require('../../config/test.json');
@@ -24,26 +22,26 @@ var loadFixtures = require('pa11y-webservice/data/fixture/load');
var request = require('request');
// Run before all tests
before(function (done) {
before(function(done) {
this.baseUrl = 'http://localhost:' + config.port;
this.last = {};
this.navigate = createNavigator(this.baseUrl, this.last);
this.webservice = createWebserviceClient(config);
assertTestAppIsRunning(this.baseUrl, function () {
assertTestAppIsRunning(this.baseUrl, function() {
loadFixtures('test', config.webservice, done);
});
});
// Run after each test
afterEach(function (done) {
afterEach(function(done) {
loadFixtures('test', config.webservice, done);
});
// Check that the test application is running, and exit if not
function assertTestAppIsRunning (url, done) {
request(url, function (err) {
function assertTestAppIsRunning(url, done) {
request(url, function(err) {
if (err) {
console.error('Error: Test app not started; run with `grunt start-test`');
console.error('Error: Test app not started; run with `NODE_ENV=test node index.js`');
process.exit(1);
}
done();

View File

@@ -19,20 +19,20 @@ var moment = require('moment');
module.exports = helper;
function helper (register) {
function helper(register) {
// Format a date with Moment
register('date-format', function (context, block) {
register('date-format', function(context, block) {
var format = block.hash.format || 'YYYY-MM-DD HH:mm:ss';
return moment(context).format(format);
});
// Get a relative date
register('date-relative', function (context) {
register('date-relative', function(context) {
return moment(context).fromNow();
});
register('date-timestamp', function (context) {
register('date-timestamp', function(context) {
return moment(context).valueOf();
});

View File

@@ -2,10 +2,10 @@
module.exports = helper;
function helper (register) {
function helper(register) {
// Convert a string to lower-case
register('lowercase', function (context) {
register('lowercase', function(context) {
return context.toLowerCase();
});

View File

@@ -17,10 +17,10 @@
module.exports = helper;
function helper (register) {
function helper(register) {
// Simplify url by removing (eg http://, https://, trailing slashes) from url
register('simplify-url', function (context) {
register('simplify-url', function(context) {
return context.replace(/^https?:\/\//i, '').replace(/\/$/, '').toLowerCase();
});

View File

@@ -92,7 +92,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/nature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/springernature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<div class="standards-lists">
{{#standards}}

View File

@@ -18,7 +18,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="footer" role="contentinfo">
<div class="container">
<div class="col-md-5">
<small>&copy; {{year}} Nature Publishing Group.<br/>pa11y dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small>
<small>&copy; {{year}} Springer Nature.<br/>pa11y dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small>
</div>
<div class="col-md-7 clearfix">
<ul class="crunch-bottom floated-list nav">

View File

@@ -82,7 +82,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.errors}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">
@@ -110,7 +117,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.warnings}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">
@@ -139,7 +153,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.notices}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">

View File

@@ -20,21 +20,21 @@ var rules = createStandardDescriptionMap(standardsArray);
module.exports = presentIgnoreRules;
function presentIgnoreRules (ignore) {
return ignore.map(function (name) {
return {
name: name,
description: rules[name]
};
});
function presentIgnoreRules(ignore) {
return ignore.map(function(name) {
return {
name: name,
description: rules[name]
};
});
}
function createStandardDescriptionMap (standards) {
var map = {};
standards.forEach(function (standard) {
standard.rules.forEach(function (rule) {
map[rule.name] = rule.description;
});
});
return map;
function createStandardDescriptionMap(standards) {
var map = {};
standards.forEach(function(standard) {
standard.rules.forEach(function(rule) {
map[rule.name] = rule.description;
});
});
return map;
}

View File

@@ -20,13 +20,13 @@ var moment = require('moment');
module.exports = presentResultList;
function presentResultList (results) {
var resultsByDay = _.groupBy(results, function (result) {
return moment(result.date).format('YYYY-MM-DD');
});
var uniqueDayResults = [];
_.keys(resultsByDay).forEach(function (day) {
uniqueDayResults.push(resultsByDay[day][0]);
});
return uniqueDayResults;
function presentResultList(results) {
var resultsByDay = _.groupBy(results, function(result) {
return moment(result.date).format('YYYY-MM-DD');
});
var uniqueDayResults = [];
_.keys(resultsByDay).forEach(function(day) {
uniqueDayResults.push(resultsByDay[day][0]);
});
return uniqueDayResults;
}

View File

@@ -20,33 +20,33 @@ var presentIgnoreRules = require('./ignore');
module.exports = presentResult;
function presentResult (result) {
function presentResult(result) {
// Add additional info
result.href = '/' + result.task + '/' + result.id;
result.hrefCsv = '/' + result.task + '/' + result.id + '.csv';
result.hrefJson = '/' + result.task + '/' + result.id + '.json';
// Add additional info
result.href = '/' + result.task + '/' + result.id;
result.hrefCsv = '/' + result.task + '/' + result.id + '.csv';
result.hrefJson = '/' + result.task + '/' + result.id + '.json';
// Parse date
result.date = new Date(result.date);
// Parse date
result.date = new Date(result.date);
// Enhance the ignored rules
result.ignore = presentIgnoreRules(result.ignore);
// Enhance the ignored rules
result.ignore = presentIgnoreRules(result.ignore);
// Split out message types
if (result.results) {
var groupedByType = _.groupBy(result.results, 'type');
['error', 'warning', 'notice'].forEach(function (type) {
var pluralType = type + 's';
var results = groupedByType[type] || [];
var groupedByCode = _.groupBy(results, 'code');
result[pluralType] = _.keys(groupedByCode).map(function (group) {
var firstMessage = groupedByCode[group][0];
firstMessage.count = groupedByCode[group].length;
return firstMessage;
});
});
}
// Split out message types
if (result.results) {
var groupedByType = _.groupBy(result.results, 'type');
['error', 'warning', 'notice'].forEach(function(type) {
var pluralType = type + 's';
var results = groupedByType[type] || [];
var groupedByCode = _.groupBy(results, 'code');
result[pluralType] = _.keys(groupedByCode).map(function(group) {
var firstMessage = groupedByCode[group][0];
firstMessage.count = groupedByCode[group].length;
return firstMessage;
});
});
}
return result;
return result;
}

View File

@@ -15,31 +15,30 @@
'use strict';
var _ = require('underscore');
var presentIgnoreRules = require('./ignore');
var presentResult = require('./result');
module.exports = presentTask;
function presentTask (task) {
function presentTask(task) {
// Add additional info
task.href = '/' + task.id;
task.hrefDelete = '/' + task.id + '/delete';
task.hrefRun = '/' + task.id + '/run';
task.hrefJson = '/' + task.id + '.json';
task.hrefEdit = '/' + task.id + '/edit';
task.hrefIgnore = '/' + task.id + '/ignore';
task.hrefUnignore = '/' + task.id + '/unignore';
// Add additional info
task.href = '/' + task.id;
task.hrefDelete = '/' + task.id + '/delete';
task.hrefRun = '/' + task.id + '/run';
task.hrefJson = '/' + task.id + '.json';
task.hrefEdit = '/' + task.id + '/edit';
task.hrefIgnore = '/' + task.id + '/ignore';
task.hrefUnignore = '/' + task.id + '/unignore';
// Enhance the ignored rules
task.ignore = presentIgnoreRules(task.ignore);
// Enhance the ignored rules
task.ignore = presentIgnoreRules(task.ignore);
// Present the last result if present
if (task.last_result) {
task.lastResult = presentResult(task.last_result);
delete task.last_result;
}
// Present the last result if present
if (task.last_result) {
task.lastResult = presentResult(task.last_result);
delete task.last_result;
}
return task;
return task;
}

View File

@@ -104,7 +104,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/nature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/springernature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<div class="standards-lists">
{{#standards}}