hotfix for recursive failures in the jQuery build. v1.0.2

README.md

@@ -22,7 +22,7 @@ npm install elasticsearch
 
 We also provide builds of the elasticsearch.js client for use in the browser. If your project uses Angular or jQuery we also provide specifc builds for you, simply include the `elasticsearch.{{lib}}.js` files in your project instead.
 
- - v1.0.0: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/1.0.0/elasticsearch-js.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/1.0.0/elasticsearch-js.tar.gz)
+ - v1.0.2: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/1.0.2/elasticsearch-js.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/1.0.2/elasticsearch-js.tar.gz)
  - master: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/master/elasticsearch-js.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/master/elasticsearch-js.tar.gz)
 
 ## Docs

package.json

@@ -7,7 +7,7 @@
   "description": "The official low-level Elasticsearch client for Node.js and the browser.",
   "main": "src/elasticsearch.js",
   "homepage": "http://elasticsearch.github.io/elasticsearch-js/",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "browser": {
     "./src/lib/connectors/index.js": "./src/lib/connectors/browser_index.js",
     "./src/lib/loggers/index.js": "./src/lib/loggers/browser_index.js",

scripts/generate/js_api.js

@@ -15,6 +15,7 @@ module.exports = function (done) {
 
   var files; // populated in readSpecFiles
   var apiSpec; // populated by parseSpecFiles
+  var docVars; // slightly modified clone of apiSpec for the docs
 
   // generate the API
   async.series([
@@ -22,6 +23,7 @@ module.exports = function (done) {
     parseSpecFiles,
     writeApiFile,
     ensureDocsDir,
+    formatDocVars,
     writeMethodList,
     writeMethodDocs
   ], done);
@@ -88,10 +90,21 @@ module.exports = function (done) {
     });
   }
 
+  function formatDocVars(done) {
+    // merge the actions and proxies to make
+    // itteration easir and keep them in order
+    docVars = _.omit(apiSpec, 'proxies');
+    docVars.actions = _.sortBy(
+      [].concat(apiSpec.actions).concat(apiSpec.proxies),
+      'name'
+    );
+    done();
+  }
+
   function writeMethodList(done) {
     fs.writeFile(
       '../../docs/_method_list.jade',
-      templates.apiMethodList(apiSpec),
+      templates.apiMethodList(docVars),
       done
     );
   }
@@ -99,7 +112,7 @@ module.exports = function (done) {
   function writeMethodDocs(done) {
     fs.writeFile(
       '../../docs/_methods.jade',
-      templates.apiMethods(apiSpec),
+      templates.apiMethods(docVars),
       done
     );
   }

scripts/generate/templates/api_methods.tmpl

@@ -4,18 +4,16 @@ var actionId = action.name.toLowerCase().replace(/[^\w]+/g, '-');
 
 %>
 
-h2#<%= actionId %>.fn
-  span.name <%= action.name %>
-  span.args (params, [callback])
+h2#<%= actionId %>.fn <%= action.name %>(params, [callback])
 include _descriptions/<%= action.name %>.jade
-a.esdoc(href="<%= action.docUrl %>", title="<%= action.name %> at elasticsearch.org").
-  <%= action.docUrl %>
-p.tight.
+p.
   The default method is <code><%= action.spec.method || 'GET' %></code> and
   the usual <a href="#api-conventions">params and return values</a> apply.
-
+  See <a href="<%= action.docUrl %>" title="<%= action.name %>
+  at elasticsearch.org"><%= action.docUrl %></a> for more about this method.
+include _examples/<%= action.name %>.jade
 <% if (_.size(action.allParams)) { %>
-h3 Params:
+h3 Params
 dl.params.api
 <% _.each(action.allParams, function (param, paramName) { %>
   dt: dfn: code <%= paramWithDefault(paramName, param.default) %>
@@ -23,7 +21,7 @@ dl.params.api
     <span class="types"><%= paramType(param.type) %></span>
 <%= indent(param.description || '', 4) %><%
 }); %>
-<% } %>
-include _examples/<%= action.name %>.jade<%
+<% }
+
 });
 %>

src/elasticsearch.jquery.js

@@ -11,7 +11,7 @@
     return def;
   }
 
-  $.es = es;
+  $.es = $.extend({}, es);
   $.es.Client = function (config) {
     config = config || {};
     config.defer = defer;