Add rendrApp to the Handlebars object

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 npm-debug.log
+*.sw?

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "0.10"
+notifications:
+  email: false

HISTORY.md

@@ -0,0 +1,50 @@
+# 2.0.2
+* bugfix for the forEach / else helper
+* bugfix for parital -> view nesting
+
+# 2.0.1
+* Bug fix for the peerDependency of rendr to be at 1.1.0 instead of 1.2.0.
+
+# 2.0.0
+* handlebars is no longer included here, it needs to be installed at the app level.
+
+# 1.0.1
+## 2015-03-26
+* allow instance of templateFinder to be passed in
+* only ship handlbars runtime, greatly reduces client bundle size
+
+# 1.0.0
+## 2015-02-24
+* update to handlebars 2.0.0
+* update to underscore 1.8.2
+* add serverToClientJson for an example of how to escape JSON between the client and server
+* omit anything in the fetch params that as a data attribute
+
+# 0.2.4
+## 2015-02-03
+* invoke block views with the parent scope
+
+# 0.2.3
+## 2015-02-03
+* stringify objects
+* added view tests
+* fixed missing require for underscore
+
+# 0.2.2
+## 2015-01-08
+* Changed the shared/helpers to follow a CommonJS pattern of requiring each helper separately
+* added tests for the helpers
+* added a `forEach` helper
+* added documentation for all the helpers
+* added ability to pass blocks into partials / views
+* upgrade to [email protected]
+
+# 0.2.1
+## 2014-12-11
+* Removed need to initialize the view twice on the client-side. This fixed leaking listeners and makes the code perform as expected
+
+# 0.2.0
+## 2014-02-25
+* Add support for AMD modules.
+* Upgraded to [email protected].
+* Upgraded to [email protected].

LICENSE

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

README.md

@@ -1,4 +1,160 @@
+[![travis-ci status](https://secure.travis-ci.org/rendrjs/rendr-handlebars.png)](http://travis-ci.org/#!/rendrjs/rendr-handlebars/builds)
+[![Dependency Status](https://david-dm.org/rendrjs/rendr-handlebars.png)](https://david-dm.org/rendrjs/rendr-handlebars)
+
 rendr-handlebars
 ================
 
-[Handlebars](http://handlebarsjs.com/) template adapter for [Rendr](https://github.com/airbnb/rendr) apps.
+[Handlebars](http://handlebarsjs.com/) template adapter for [Rendr](https://github.com/rendrjs/rendr) apps.
+This library has been tested using [Handlebars 2.0.0](https://github.com/wycats/handlebars.js/tree/v2.0.0).
+
+If you'd like to use a more recent version number of `Handlebars` for your app, just specify it in the [package.json](https://github.com/rendrjs/rendr/blame/master/README.md#L315) of your app and start testing it.
+
+
+## Configuration options
+
+- `entryPath` *optional* - change the location of the application for the given rendr-app.
+- `templateFinder` *optional* - allows the ability to require a different template finder.  Commonly used to make a non-dynamic version of `require` to make build systems more efficient.
+
+## Helpers
+
+There are a number of variables that are set by default to these helpers and are passed in the context.  Those variables include:
+- `_app` -  The instance of the Rendr application
+- `_model` - when setting the `model` attribute, the `_model` variable will be set as the instance of a Rendr model.
+- `_collection` - when using a `collection` attribute, the `_collection` variable will be set to the instance of the Rendr collection.
+- `_block` - when passing a block to the `view` or `partial` helper, the `_block` variable will be available.  This `_block` variable will be the HTML passed in.
+
+
+#### view
+------
+The view helper is used to insert a new Rendr view.  This is done on the server-side by generating the html and inserting it inline.  On the client-side it creates a placeholder, and then in Rendr it will call the `attach` function to create a view instance and insert the HTML.  If you don't pass any attributes to the helper, it sets the context (or scope) of the helper to the same as the parents.
+
+You can also pass a block into the helper and it will be available inside of the created view as `_block`.  This is helpful when you want to have a chunk of HTML differ in a view, but have the majority of it stay the same.
+
+Example:
+```
+// no attributes
+{{ view "viewName" }}
+
+{{ view "viewName" model=_model an_option="my option" }}
+
+// with a block
+{{ view "viewName" }}
+  <div class="test">My Block</div>
+{{/view}}
+```
+
+
+#### partial
+------
+A partial is HTML only, and it is inserted at compile time of the templates, making them more performant than a view.  These are good to use in cases where you don't have any view interaction and just want to reduce the amount of copied HTML.  This will inherit the parents context if no attributes are passed into the helper.
+
+Again, you can pass a block into the partial and access the `_block` variable inside of the partial.  This is helpful when you want to set a variable chunk of HTML inside of a partial
+
+Example:
+```
+// no attributes
+{{ partial "partialName" }}
+
+{{ partial "partialName" attr="example" }}
+
+// with block
+{{ partial "partialName" }}
+  <div class="test">My Block</div>
+{{/partial}}
+```
+
+
+#### json
+------
+This helper simply takes an object and runs `JSON.stringify` on the object.  You can also pass the [spacing](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#space_argument) into the helper.
+
+Example:
+```
+{{json myObject}}
+
+// with spacing
+{{ json myObject " " }}
+```
+
+
+#### each
+------
+Iterates an array setting the context to the value of the array element.  Works as you would expect the Handlebars [each](http://handlebarsjs.com/builtin_helpers.html#iteration) helper to work, but this adds Rendr specific options set in the context (`_app`, `_model`, `_collection`, `_block`)
+
+Example:
+```html
+<ul>
+  {{ each arr }}
+    <li>{{this}}<li>
+  {{/each}}
+</ul>
+```
+
+
+#### forEach
+------
+Another helper to iterate items in the template, this has a bit more included though.  You can iterate objects, arrays, or Collections with this, setting the value and the key attributes in the scope.
+
+Always available in the `forEach` helper
+- `key` - The key on the object, or the index in the array
+- `value` - The value of the item being iterated.
+
+If iterating arrays or collections there is extra data included: 
+- `_isFirst` - Boolean, is true if it's the first item in the array / collection
+- `_isLast` - Boolean, is true if it's the last item in the array / collection
+- `_total` - The number of items in the array / collection
+
+If iterating an instance of a collection, you can set the `toJSON` attribute to convert the model being iterated into JSON instead of an instance of the model.  By default the `value` will be set to a Backbone model when iterating a collection.
+
+Example:
+```html
+<!-- iterating an object -->
+<h1>for each obj test</h1>
+{{forEach obj}}
+  <div>{{ key }} :::: {{ value }}</div>
+{{/forEach}}
+
+<!-- inverse available -->
+{{forEach arr}}
+  <div>{{ value }}</div>
+{{else}}
+  <div>Array is empty</div>
+{{/forEach}}
+
+<!-- pass variables into the scope -->
+{{forEach arr attribute="test"}}
+   <div>{{attribute}}</div>
+{{/forEach}}
+
+<!-- where value is what is stored in the array, can also store an array of objects
+and access them on the value with the dot operator -->
+<h1>for each array of objs test</h1>
+{{forEach arr}}
+  {{if _isFirst}}
+    <div>Will only display for first element in array and collection</div>
+  {{/if}}
+
+  {{if _isLast}}
+    <div>Will only display for last element in array and collection</div>
+  {{/if}}
+  <span>{{ value }}</span>
+{{/forEach}}
+
+<!-- array of a collection which returns a model -->
+<h1>for each array of objs test</h1>
+{{forEach myCollection}}
+  <span>{{ key }} :::: {{ value.attributes.someAttr }}</span>
+{{/forEach}}
+
+<!-- array of collection which turns models into json -->
+<h1>for each array of objs test toJSON</h1>
+{{forEach myCollection toJSON=true}}
+  <span>{{ key }} :::: {{ value.someAttr }}</span>
+{{/forEach}}
+
+<!-- can be used in conjunction with the view operator to pass the model to child views -->
+<h1>forEach collection -> subview</h1>
+{{forEach myCollection }}
+  {{view model=value model_name="ExampleModel"}}
+{{/forEach}}
+```

index.js

@@ -1,6 +1,68 @@
-require('./shared/globals');
+module.exports = function(options, Handlebars) {
 
-exports.templateFinder = require('./shared/templateFinder');
-if(!this.window) {
-  exports.layoutFinder = require('./server/layoutFinder');
-}
+  if (Handlebars['default']) {
+    // If we only have the Handlebars runtime available, use that here.
+    // Until Handlebars 3, we have to use 'default' instead of just requiring 'handlebars'.
+    Handlebars = Handlebars['default'];
+  }
+
+  var localExports = {},
+    templateFinder = options.templateFinder || require('./shared/templateFinder')(Handlebars);
+
+  /**
+   * Export the `Handlebars` object, so other modules can add helpers, partials, etc.
+   */
+  localExports.Handlebars = Handlebars;
+
+  /**
+   * `getTemplate` is available on both client and server.
+   */
+  localExports.getTemplate = templateFinder.getTemplate;
+
+  /**
+   * Expose `templatePatterns` for manipulating how `getTemplate` finds templates.
+   */
+  localExports.templatePatterns = templateFinder.templatePatterns;
+
+  /**
+   * The default pattern `/.+/` is very greedy; it matches anything, including nested paths.
+   * To add rules that should match before this default rule, `unshift` them from this array.
+   */
+  localExports.templatePatterns.push({pattern: /.+/, src: options.entryPath + 'app/templates/compiledTemplates'})
+
+  /**
+   * `getLayout` should only be used on the server.
+   */
+  if (typeof window === 'undefined') {
+    // server only, "hide" it from r.js compiler
+    // by having require statement with variable
+    var serverOnlyLayoutFinderPath = './server/layoutFinder';
+    localExports.getLayout = require(serverOnlyLayoutFinderPath)(Handlebars).getLayout;
+  } else {
+    localExports.getLayout = function() {
+      throw new Error('getLayout is only available on the server.');
+    };
+  }
+
+  /**
+   * Register helpers, available on both client and server.
+   *
+   * Export it so other modules can register helpers as well.
+   */
+  localExports.registerHelpers = function registerHelpers(helpersModule) {
+    var helpers = helpersModule(Handlebars, localExports.getTemplate);
+
+    for (var key in helpers) {
+      if (!helpers.hasOwnProperty(key)) continue;
+      Handlebars.registerHelper(key, helpers[key]);
+    }
+  };
+
+  /**
+   * Register the pre-bundled Rendr helpers.
+   */
+  var rendrHelpers = require('./shared/helpers');
+  localExports.registerHelpers(rendrHelpers);
+
+  return localExports;
+}

lib/getOptions.js

@@ -0,0 +1,25 @@
+/**
+ * Grab important underscored properties from the current context.
+ * These properties come from BaseView::decorateTemplateData().
+ */
+module.exports = function (obj) {
+  var options, keys, value;
+
+  keys = [
+    '_app',
+    '_view',
+    '_model',
+    '_collection',
+    '_block'
+  ];
+
+  options = keys.reduce(function(memo, key) {
+    value = obj[key];
+    if (value) {
+      memo[key] = value;
+    }
+    return memo;
+  }, {});
+
+  return options;
+};

lib/getProperty.js

@@ -0,0 +1,9 @@
+/**
+ * Get a property that is being passed down through helpers, such as `_app`
+ * or `_view`. It can either live on the context, i.e. `this._app`, or in the
+ * `options.data` object passed to the helper, i.e. `options.data._app`, in the
+ * case of a block helper like `each`.
+ */
+module.exports = function (key, context, options) {
+  return context[key] || (options.data || {})[key];
+}