Add multiple input locations.

DISEINC · May 8, 2015 · 3baedf7 · 3baedf7
1 parent 07ebfda
commit 3baedf7
Show file tree

Hide file tree

Showing 14 changed files with 533 additions and 3 deletions.
diff --git a/.jshintignore b/.jshintignore
@@ -0,0 +1 @@
+test/multi_input_folder/fixtures
diff --git a/bin/apidoc b/bin/apidoc
@@ -23,7 +23,7 @@ var argv = nomnom
     .option('exclude-filters', { abbr: 'e', 'default': '', list: true,
             help: 'RegEx-Filter to select files / dirs that should not be parsed (many -e can be used).', })
 
-    .option('input', { abbr: 'i', 'default': './', help: 'Input / source dirname.' })
+    .option('input', { abbr: 'i', 'default': './', list: true, help: 'Input / source dirname.' })
 
     .option('output', { abbr: 'o', 'default': './doc/', help: 'Output dirname.' })
 

diff --git a/lib/package_info.js b/lib/package_info.js
@@ -60,7 +60,9 @@ PackageInfo.prototype.get = function() {
  */
 PackageInfo.prototype._readPackageData = function(filename) {
     var result = {};
-    var jsonFilename = path.join(app.options.src, filename);
+    //var jsonFilename = path.join(app.options.src, filename);
+    var dir = this._resolveSrcPath();
+    var jsonFilename = path.join(dir, filename);
 
     // read from source dir
     if ( ! fs.existsSync(jsonFilename)) {
@@ -88,10 +90,14 @@ PackageInfo.prototype._readPackageData = function(filename) {
  */
 PackageInfo.prototype._getHeaderFooter = function(json) {
     var result = {};
+    var self = this;
 
     ['header', 'footer'].forEach(function(key) {
         if (json[key] && json[key].filename) {
-            var filename = path.join(app.options.src, json[key].filename);
+//            var filename = path.join(app.options.src, json[key].filename);
+            var dir = self._resolveSrcPath();
+            var filename = path.join(dir, json[key].filename);
+
             if ( ! fs.existsSync(filename))
                 filename = path.join('./', json[key].filename);
 
@@ -110,3 +116,22 @@ PackageInfo.prototype._getHeaderFooter = function(json) {
 
     return result;
 };
+
+/**
+ * Resolve source path.
+ *
+ * If multiple input dirs are given, the current workdir './' will be returned.
+ * On one input dir, the current workdir will be the input dir.
+ *
+ * @returns {string}
+ * @private
+ */
+PackageInfo.prototype._resolveSrcPath = function() {
+    var dir = './';
+
+    if (app.options.src instanceof Array && app.options.src.length === 1)
+        dir = app.options.src[0];
+
+    return dir;
+};
+
diff --git a/test/multi_input_folder/fixtures/api_data.js b/test/multi_input_folder/fixtures/api_data.js
@@ -0,0 +1,144 @@
+define({ "api": [
+  {
+    "type": "post",
+    "url": "/api/authenticate",
+    "title": "",
+    "version": "0.3.0",
+    "group": "Authentication",
+    "name": "Authenticate",
+    "parameter": {
+      "fields": {
+        "Credentials": [
+          {
+            "group": "Credentials",
+            "type": "<p>String</p> ",
+            "optional": false,
+            "field": "username",
+            "description": "<p>Username</p> "
+          },
+          {
+            "group": "Credentials",
+            "type": "<p>String</p> ",
+            "optional": false,
+            "field": "password",
+            "description": "<p>password</p> "
+          }
+        ]
+      }
+    },
+    "filename": "src/test_api.js",
+    "groupTitle": "Authentication",
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  },
+  {
+    "type": "get",
+    "url": "/api/subscriptioninfo",
+    "title": "",
+    "version": "0.3.0",
+    "description": "<p>Get the subscription information from an authenticated user.</p> ",
+    "group": "Authentication",
+    "name": "GetSubscriptionInfo",
+    "filename": "src/test_api.js",
+    "groupTitle": "Authentication",
+    "header": {
+      "fields": {
+        "Header": [
+          {
+            "group": "Header",
+            "type": "String",
+            "optional": false,
+            "field": "Authorization",
+            "description": "<p>Auth header with JWT Token</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "Authorization-Example:",
+          "content": "Authorization: Bearer <jwt-token>",
+          "type": "String"
+        }
+      ]
+    },
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  },
+  {
+    "type": "get",
+    "url": "/api/subscriptioninfo/:userid",
+    "title": "",
+    "version": "0.2.0",
+    "description": "<p>Get the subscription information for a user.</p> ",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "<p>Number</p> ",
+            "optional": false,
+            "field": "userid",
+            "description": "<p>user id</p> "
+          }
+        ]
+      }
+    },
+    "group": "Authentication",
+    "name": "GetSubscriptionInfo",
+    "filename": "folder2/History.js",
+    "groupTitle": "Authentication",
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  }
+] });
diff --git a/test/multi_input_folder/fixtures/api_data.json b/test/multi_input_folder/fixtures/api_data.json
@@ -0,0 +1,144 @@
+[
+  {
+    "type": "post",
+    "url": "/api/authenticate",
+    "title": "",
+    "version": "0.3.0",
+    "group": "Authentication",
+    "name": "Authenticate",
+    "parameter": {
+      "fields": {
+        "Credentials": [
+          {
+            "group": "Credentials",
+            "type": "<p>String</p> ",
+            "optional": false,
+            "field": "username",
+            "description": "<p>Username</p> "
+          },
+          {
+            "group": "Credentials",
+            "type": "<p>String</p> ",
+            "optional": false,
+            "field": "password",
+            "description": "<p>password</p> "
+          }
+        ]
+      }
+    },
+    "filename": "src/test_api.js",
+    "groupTitle": "Authentication",
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  },
+  {
+    "type": "get",
+    "url": "/api/subscriptioninfo",
+    "title": "",
+    "version": "0.3.0",
+    "description": "<p>Get the subscription information from an authenticated user.</p> ",
+    "group": "Authentication",
+    "name": "GetSubscriptionInfo",
+    "filename": "src/test_api.js",
+    "groupTitle": "Authentication",
+    "header": {
+      "fields": {
+        "Header": [
+          {
+            "group": "Header",
+            "type": "String",
+            "optional": false,
+            "field": "Authorization",
+            "description": "<p>Auth header with JWT Token</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "Authorization-Example:",
+          "content": "Authorization: Bearer <jwt-token>",
+          "type": "String"
+        }
+      ]
+    },
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  },
+  {
+    "type": "get",
+    "url": "/api/subscriptioninfo/:userid",
+    "title": "",
+    "version": "0.2.0",
+    "description": "<p>Get the subscription information for a user.</p> ",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "<p>Number</p> ",
+            "optional": false,
+            "field": "userid",
+            "description": "<p>user id</p> "
+          }
+        ]
+      }
+    },
+    "group": "Authentication",
+    "name": "GetSubscriptionInfo",
+    "filename": "folder2/History.js",
+    "groupTitle": "Authentication",
+    "error": {
+      "fields": {
+        "500 Internal Server Error": [
+          {
+            "group": "500 Internal Server Error",
+            "optional": false,
+            "field": "InternalServerError",
+            "description": "<p>The server encountered an internal error</p> "
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "500 Internal Server Error",
+          "content": "HTTP/1.1 500 Internal Server Error\n{\n    \"uri\": \"<api-endpoint>\",\n    \"method\": \"<method used>\",\n    \"type\": \"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n    \"title\": \"Internal Server Error\",\n    \"status\": 500,\n    \"detail\": \"<Detail Message>\"\n}",
+          "type": "json"
+        }
+      ]
+    }
+  }
+]
diff --git a/test/multi_input_folder/fixtures/api_project.js b/test/multi_input_folder/fixtures/api_project.js
@@ -0,0 +1,13 @@
+define({
+  "name": "Multiple Input Folder Test",
+  "version": "1.0.0",
+  "description": "Example of feeding apidoc from multiple input folder locations",
+  "sampleUrl": false,
+  "apidoc": "0.2.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2015-05-08T10:26:38.294Z",
+    "url": "http://apidocjs.com",
+    "version": "0.12.3"
+  }
+});
diff --git a/test/multi_input_folder/fixtures/api_project.json b/test/multi_input_folder/fixtures/api_project.json
@@ -0,0 +1,13 @@
+{
+  "name": "Multiple Input Folder Test",
+  "version": "1.0.0",
+  "description": "Example of feeding apidoc from multiple input folder locations",
+  "sampleUrl": false,
+  "apidoc": "0.2.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2015-05-08T10:26:38.294Z",
+    "url": "http://apidocjs.com",
+    "version": "0.12.3"
+  }
+}
diff --git a/test/multi_input_folder/fixtures/index.html b/test/multi_input_folder/fixtures/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>apiDoc</title>
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+<body>
+
+Empty Test Template.
+
+</body>
+</html>