added documentation for the model-utils class

Author: Josh Callender

Gemfile.lock

@@ -16,13 +16,13 @@ GEM
     coffee-script (2.3.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.8.0)
+    coffee-script-source (1.9.0)
     colorator (0.1)
-    execjs (2.2.2)
+    execjs (2.3.0)
     fast-stemmer (1.0.2)
     ffi (1.9.6)
     gemoji (2.1.0)
-    github-pages (32)
+    github-pages (33)
       RedCloth (= 4.2.9)
       github-pages-health-check (~> 0.2)
       jekyll (= 2.4.0)
@@ -36,7 +36,7 @@ GEM
       liquid (= 2.6.1)
       maruku (= 0.7.0)
       mercenary (~> 0.3)
-      pygments.rb (= 0.6.0)
+      pygments.rb (= 0.6.1)
       rdiscount (= 2.1.7)
       redcarpet (= 3.1.2)
       terminal-table (~> 1.4)
@@ -75,7 +75,7 @@ GEM
     jekyll-sass-converter (1.2.0)
       sass (~> 3.2)
     jekyll-sitemap (0.6.3)
-    jekyll-watch (1.2.0)
+    jekyll-watch (1.2.1)
       listen (~> 2.7)
     jemoji (0.4.0)
       gemoji (~> 2.0)
@@ -93,22 +93,22 @@ GEM
     mini_portile (0.6.2)
     minitest (5.5.1)
     net-dns (0.8.0)
-    nokogiri (1.6.6.1)
+    nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     parslet (1.5.0)
       blankslate (~> 2.0)
-    posix-spawn (0.3.9)
+    posix-spawn (0.3.10)
     public_suffix (1.4.6)
-    pygments.rb (0.6.0)
+    pygments.rb (0.6.1)
       posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.1.0)
+      yajl-ruby (~> 1.2.0)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
     rdiscount (2.1.7)
     redcarpet (3.1.2)
     safe_yaml (1.0.4)
-    sass (3.4.10)
+    sass (3.4.12)
     terminal-table (1.4.5)
     thread_safe (0.3.4)
     timers (4.0.1)
@@ -117,10 +117,10 @@ GEM
       parslet (~> 1.5.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    yajl-ruby (1.1.0)
+    yajl-ruby (1.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages (= 32)
+  github-pages (= 33)

_app/constructor.md

@@ -3,4 +3,4 @@ header: constructor
 example: new App([attributes], [options])
 ---
 
-Creates an instance of the application, setting the modelUtils, [fetcher](/fetcher), and [router](/router) to the app object.  The attributes are attributes you wish to set on the application.  See the [configuration](#config) object for more details about options that can be passed into the constructor.
+Creates an instance of the application, setting the [modelUtils](/model-utils), [fetcher](/fetcher), and [router](/router) to the app object.  The attributes are attributes you wish to set on the application.  See the [configuration](#config) object for more details about options that can be passed into the constructor.

_model-utils/getCollection.md

@@ -0,0 +1,14 @@
+---
+header: getCollection
+example: ModelUtils.getCollection(path, [models], [options], [callback])
+---
+
+Factory method for collections. Given the path of a collection, will return an instance of that collection. This will also add the `models` to that collection, and set any `options` to the collection.  `callback` allows the method to be called asynchronously. 
+
+**path** The path to the collection, for example: `my_collection`, would return an instance of a collection stored in `app/collections/my_collection.js`
+
+**models** _optional_ An array of models to store in the collection.
+
+**options** _optional_ Options for the [collection constructor](/collection#constructor).
+
+**callback** _optional_ Callback function to be invoked once the instance is created.  If it's not defined, this will return the instance instead.

_model-utils/getModel.md

@@ -0,0 +1,12 @@
+---
+header: getModel
+example: ModelUtils.getModel(path, [attributes], [options], [callback])
+---
+
+Factory method for models, given the models path this will return an instance of that model.  Sets the given `attributes` and `options` on the model. 
+
+**attributes** _optional_ The attributes for the [constructor](/model#constructor).
+
+**options** _optional_ The options to set in a constructor method.
+
+**callback** _optional_ Allows the constructor to be called with a callback method instead.

_model-utils/isCollection.md

@@ -0,0 +1,6 @@
+---
+header: isCollection
+example: ModelUtils.isCollection(obj)
+---
+
+Returns a boolean if the `obj` is an instance of a [Collection](/collection).

_model-utils/isModel.md

@@ -0,0 +1,6 @@
+---
+header: isModel
+example: ModelUtils.isModel(obj)
+---
+
+Returns a boolean if the `obj` is an instance of a [Model](/model).

_model-utils/underscorize.md

@@ -0,0 +1,6 @@
+---
+header: underscorize
+example: ModelUtils.underscorize(name)
+---
+
+Return a snake case version of the model or collection name. For example: `MyModel` would return `my_model`.

app/index.md

@@ -10,7 +10,7 @@ The App is a specialized [Model](/model).  A lot of the choices between client /
 - Defines the template adapter
 - Initializes the client / server [router](/router)
 - Initializes the [fetcher](/fetcher)
-- Initializes modelUtils
+- Initializes [modelUtils](/model-utils)
 - Initializes the app view, which in turn will initialize all views in use
 - [Starts](#start) the client-side [router](/router)
 - [Bootstraps the data](#bootstrapData) from the server into the client

model-utils/index.md

@@ -5,4 +5,6 @@ title: "Model Utils - RendrJS"
 
 # Model Utils
 
+This class gives utility functions for models and collections.  Some functionality includes; an `instanceof` wrappers, factory methods, and getters for constructors based on the name.  The ModelUtils class is initialized in the [app initialization](/app#constructor) process, and is attached to the [app](/app) object.
+
 {% include pageDoc.html name="model-utils" %}