sourcey · dependabot · Oct 31, 2017 · Nov 13, 2017 · Nov 13, 2017 · Nov 13, 2017
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@
 *cache
 *.log
 node_modules
+.history
+.idea
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,11 @@
-FROM node:7.5.0-alpine
+FROM node:8-alpine
 MAINTAINER Kam Low <hello@sourcey.com>
 
 USER 0
 WORKDIR /opt
 
-RUN apk update \
- && apk add git vim curl wget \
- && rm -rf /var/cache/apk/* \
- && npm install -g spectacle-docs
+RUN apk add --no-cache \
+  nodejs nodejs-npm g++ \
+  python python-dev
+
+RUN npm install --unsafe-perm -g spectacle-docs
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,5 @@
 Copyright (c) 2015-2017 Kam Low
+Code from bootprint-openapi and bootprint-json-schema Copyright (c) 2015 Nils Knappmeier
 
 MIT License
 

diff --git a/Makefile b/Makefile
@@ -0,0 +1,12 @@
+NAME    := sourcey/spectacle
+VERSION := $$(git describe --tags `git rev-list --tags --max-count=1`)
+
+build:
+	docker build -t ${NAME}:latest -t ${NAME}:v${VERSION} .
+
+push:
+	@echo ${NAME}
+	@docker push ${NAME}
+
+login:
+	@docker log -u ${DOCKER_USER} -p ${DOCKER_PASS}
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ See a demo of Spectacle in action here: [http://cheesestore.github.io](http://ch
 * **OpenAPI/Swagger 2.0 support**: Support for the latest OpenAPI/Swagger specification.
 * **Highly configurable**: Easily configurable Handlebars templates and SCSS styles so you can add your own design and flavour without going bald. See [Custom Builds](#custom-builds)
 * **Markdown support**: Render markdown written in any of your API descriptions.
+* **Remote file references**: Support for swagger specs split across multiple files.
 * **Clean responsive design**: Responsive HTML5 and CSS3 layout built with [Foundation 6](http://foundation.zurb.com/sites.html) that looks great on all devices and screen sizes.
 * **Embed into your existing website**: An embedded option so that generate partial docs without a HTML `<body>` for convenient integration into your existing website.
 * **Live preview developer mode**: Development mode that starts a local HTTP server with a file watcher and live reload so you can preview live changes in your browser as you update your spec.
@@ -40,14 +41,14 @@ Next pass your `swagger.json` document use the CLI to generate your documentatio
 spectacle -d your_swagger_api.json
 
 # Or use the cheese.json example to test it out
-# spectacle -d -l test/fixtures/cheese.png test/fixtures/cheese.json
+# spectacle -d -l test/fixtures/cheese.png test/fixtures/cheese.yml
 ```
 
 Your generated documentation will be located in the `public` directory by default. You can either copy the generated HTML to your web server, or view your docs by pointing your browser to [http://localhost:4400/](http://localhost:4400/).
 
 ### Docker
 
-A basic Docker script is included that allows Spectacle to be run from the inside, not outside. It's useful, for instance, in a Gitlab CI pipeline. Thanks @alexeiaguiar.
+[Docker](https://hub.docker.com/r/sourcey/spectacle/) images are included that allow Spectacle to be run from the inside. It's useful, for instance, in a Gitlab CI pipeline. Thanks @alexeiaguiar.
 
 How to use it: `docker run -it sourcey/spectacle /bin/sh`
 
@@ -62,24 +63,28 @@ $ spectacle -h
 
   Options:
 
-    -h, --help                output usage information
-    -V, --version             output the version number
-    -C, --disable-css         omit CSS generation (default: false)
-    -J, --disable-js          omit JavaScript generation (default: false)
-    -e, --embeddable          omit the HTML <body/> and generate the documentation content only (default: false)
-    -d, --development-mode    start HTTP server with the file watcher and live reload (default: false)
-    -s, --start-server        start the HTTP server without any development features
-    -p, --port <dir>          the port number for the HTTP server to listen on (default: 4400)
-    -t, --target-dir <dir>    the target build directory (default: public)
-    -f, --target-file <file>  the target build HTML file (default: index.html)
-    -a, --app-dir <dir>       the application source directory (default: app)
-    -l, --logo-file <file>    specify a custom logo file (default: null)
-    -c, --config-file <file>  specify a custom configuration file (default: app/lib/config.js)
+    -h, --help                   output usage information
+    -V, --version                output the version number
+    -C, --disable-css            omit CSS generation (default: false)
+    -J, --disable-js             omit JavaScript generation (default: false)
+    -e, --embeddable             omit the HTML <body/> and generate the documentation content only (default: false)
+    -d, --development-mode       start HTTP server with the file watcher (default: false)
+    -D, --development-mode-live  start HTTP server with the file watcher and live reload (default: false)
+    -s, --start-server           start the HTTP server without any development features
+    -p, --port <port>            the port number for the HTTP server to listen on (default: 4400)
+    -P, --port-live <port>       the port number for the live reload to listen on (default: 4401)
+    -t, --target-dir <dir>       the target build directory (default: public)
+    -f, --target-file <file>     the target build HTML file (default: index.html)
+    -a, --app-dir <dir>          the application source directory (default: app)
+    -l, --logo-file <file>       specify a custom logo file (default: null)
+    -c, --config-file <file>     specify a custom configuration file (default: app/lib/config.js)
 ```
 
 Most options are self explanatory, but the following options warrant some further explanation:
 
-* **--development-mode** `-d`: This option starts a development server with a file watcher and live reload, and will automatically regenerate your docs when any of your spec or app files change.
+* **--development-mode** `-d`: This option starts a development server with a file watcher, and will automatically regenerate your docs when any of your spec or app files change.
+
+* **--development-mode-live** `-D`: This option starts a development server with a file watcher and live reload, and will automatically regenerate your docs when any of your spec or app files change.
 
 * **--start-server** `-s`: This option starts a production server without any development options enabled that serves the contents of your `--target-dir`.
 
@@ -131,6 +136,15 @@ Some parts of testing can be configured using environment variables.
 
 Include environment variables before calling `npm test`.  For example, `OFFLINE` mode can be enabled via `OFFLINE=true npm test`.
 
+
+<!-- ## Contributors
+
+Thanks to all the great developers who make Spectacle great!
+
+TODO
+-->
+
+
 ## More Information
 
 More info is available on the [Spectacle homepage](http://sourcey.com/spectacle).

diff --git a/app/helpers/equal.js b/app/helpers/equal.js
@@ -1,3 +1,10 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 /**
  * Checks whether two values a equal as in (==)
  * @param value1

diff --git a/app/helpers/htmlId.js b/app/helpers/htmlId.js
@@ -4,5 +4,5 @@
  * is not addressed by this helper.
  */
 module.exports = function(value) {
-  return value.replace(/[^A-Za-z0-9-_:.]/g, "-")
+  return value.replace(/[^A-Za-z0-9-_.]/g, "-")
 };
diff --git a/app/helpers/httpResponseCode.js b/app/helpers/httpResponseCode.js
@@ -1,3 +1,10 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 module.exports = function(code) {
   // Comments refer to the section number in rfc2616
   // If an rfc number is specified, the code is

diff --git a/app/helpers/md.js b/app/helpers/md.js
@@ -10,6 +10,7 @@ var common = require('../lib/common')
  *      markdown, rendered as HTML.
  */
 module.exports = function(value, options) {
+  value = value + ''
   var html = common.markdown(value, options.hash ? options.hash.stripParagraph : false)
   return new Handlebars.SafeString(html)
 };
diff --git a/app/helpers/printExample.js b/app/helpers/printExample.js
@@ -1,10 +1,10 @@
 var Handlebars = require('handlebars')
 var common = require('../lib/common')
 
-module.exports = function(value, options) {
+module.exports = function(value, options) { 
   var cloned = common.formatExample(value, options.data.root, options.hash)
   if (!cloned)
   	return '';
-  var html = common.printSchema(cloned)
+  var html = common.printSchema(cloned, options.hash.yaml === true)
   return new Handlebars.SafeString(html)
 };
diff --git a/app/helpers/schemaDatatype.js b/app/helpers/schemaDatatype.js
@@ -1,33 +1,40 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 /**
  * Returns a descriptive string for a datatype
  * @param value
  * @returns {String} a string like <code>string[]</code> or <code>object[][]</code>
  */
 module.exports = function (value) {
   return dataType(value)
-};
+}
 
 function dataType(value) {
   // console.log('dataType', value)
-  if (!value) return null;
+  if (!value) return null
   if (typeof value === 'string') {
     throw 'invalid value'
   }
   if (value['anyOf'] || value['allOf'] || value['oneOf']) {
-    return '';
+    return ''
   }
   if (!value.type) {
-    return 'object';
+    return 'object'
   }
   if (value.type === 'array') {
     if (!value.items) {
-      return 'array';
+      return 'array'
     }
     if (value.items.type) {
-      return dataType(value.items) + '[]';
+      return dataType(value.items) + '[]'
     } else {
-      return 'object[]';
+      return 'object[]'
     }
   }
-  return value.type;
+  return value.type
 }
diff --git a/app/helpers/schemaRange.js b/app/helpers/schemaRange.js
@@ -1,4 +1,10 @@
 var util = require('util')
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
 
 /**
  *
@@ -10,12 +16,12 @@ var util = require('util')
  * @param {Handlebars} engine the current handlebars engine
  */
 module.exports = function(range, options) {
-  var hasMinimum = range.minimum || range.minimum === 0;
-  var hasMaximum = range.maximum || range.maximum === 0;
+  var hasMinimum = range.minimum || range.minimum === 0
+  var hasMaximum = range.maximum || range.maximum === 0
 
   if (!hasMinimum && !hasMaximum) {
     // There is no range
-    return "";
+    return ""
   }
 
   if (hasMinimum && !hasMaximum) {
@@ -41,7 +47,7 @@ module.exports = function(range, options) {
         range.maximum)
   }
 
-  // var numberSet = "";
+  // var numberSet = ""
   // if (range.type === "integer") {
   //   numberSet = "\u2208 \u2124" // ELEMENT OF - DOUBLE-STRUCK CAPITAL Z
   // } else if (range.type === "number") {
@@ -67,4 +73,4 @@ module.exports = function(range, options) {
   //       range.maximumExclusive ? "<" : "\u2264",
   //       range.maximum)
   // }
-};
+}
diff --git a/app/helpers/schemaReferenceContext.js b/app/helpers/schemaReferenceContext.js
@@ -0,0 +1,10 @@
+var common = require('../lib/common');
+
+/**
+ * Resolve a (local) json schema $ref and replace context to referenced object.
+ * @param reference
+ * @param options
+ */
+module.exports = function(reference, options) {
+  return options.fn(reference ? common.resolveSchemaReference(reference, options.data.root) : this);
+};
diff --git a/app/helpers/schemaReferenceHref.js b/app/helpers/schemaReferenceHref.js
@@ -0,0 +1,18 @@
+var common = require('../lib/common')
+
+/**
+ * Build href links for local and remote references.
+ * @param reference
+ */
+module.exports = function(reference, options) {
+  if (reference.indexOf('#') === 0) {
+    // local references
+    return reference
+  }
+  else {
+    // remote references
+    var path = ' #definition-'
+    path += require('./htmlId')(reference)
+    return path
+  }
+};
diff --git a/app/helpers/swaggerCollectionFormat.js b/app/helpers/swaggerCollectionFormat.js
@@ -1,9 +1,16 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 module.exports = function(value, paramName) {
   return {
-    'csv': 'comma separated (`' + paramName + '=aaa,bbb`)',
-    'ssv': 'space separated (`' + paramName + '=aaa bbb`)',
-    'tsv': 'tab separated (`' + paramName + '=aaa\\tbbb`)',
-    'pipes': 'pipe separated (`' + paramName + '=aaa|bbb`)',
-    'multi': 'multiple parameters (`' + paramName + '=aaa&' + paramName + '=bbb`)'
+    'csv': 'Array values passed separated by comma: `?' + paramName + '=aaa,bbb`',
+    'ssv': 'Array values passed separated by space: `?' + paramName + '=aaa bbb`',
+    'tsv': 'Array values passed separated by tab: `?' + paramName + '=aaa\\tbbb`',
+    'pipes': 'Array values passed separated by pipe: `?' + paramName + '=aaa|bbb`',
+    'multi': 'Array values passed as multiple parameters: `?' + paramName + '=aaa&' + paramName + '=bbb`'
   }[value]
 };
diff --git a/app/helpers/swaggerEndpoint.js b/app/helpers/swaggerEndpoint.js
@@ -1,3 +1,10 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 module.exports = function(options) {
   var data = options.data.root;
   var endpoint = 'http';

diff --git a/app/javascripts/traverse.js b/app/javascripts/traverse.js
@@ -121,7 +121,7 @@ Traverse.prototype._events = function() {
 
   this.$element.on('click', 'a[href^="#"]', function(e) { //'click.zf.traverse'
       e.preventDefault();
-      var arrival   = this.getAttribute('href').replace(".", "\\."),
+      var arrival   = this.getAttribute('href').replace(/\./g, "\\."),
           scrollPos = $(arrival).offset().top - _this.options.barOffset; // - _this.options.threshold / 2 - _this.options.barOffset;
 
       $body.stop(true).animate({
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,5 @@ @@
     *cache
     *.log
     node_modules
+    .history
+    .idea