exoskeleton 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODU4NGM1YjI0YTBjNDI4Y2M3MDFjOTQyY2U0MmNhNTljOTk1MjEzNg==
+    NTllOTFjMDk4Y2Y4ZmZkNGZlZjMzNzIxZTBhNDAxNTU2NDU0MmY3ZQ==
   data.tar.gz: !binary |-
-    YzA5OTAwYWIyNzMyOWNhODNkZTgyZDNkYzcwMmRkZDkyNjk3OTZjNQ==
+    NzVmNDA0NzExZDE1OGFlMjA2ZWNkN2E2MGFkMWNhZmNiZDEyZWQ0Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDczOWU1ZDQ0NmMwMDE2MDI4NDU1NGYxOTg3ODkwNzMyYmQ1NmE0ZjFjZDYy
-    MzQ3MzI0ZWFjY2ZhYTQ1OGFkZTI3NzEyMjYyNDRmYzY3YjJlYmZkMmQ2MmJj
-    NTg5NjJiMWMyZGJiODAzMzY2NTUyMThkZmEyMDcxNWNkZmM3MDY=
+    ZWI4NTQxNTZhZTRlYmFhNTYxMzdjMzQ0ZmM3OTIxZmE1ZTllNzJhOTYwNjZm
+    ZDFiNWFjN2NkYjU3Y2ZkMmFhNDQ1MDU0NWMzOGIwOTE3MGNhZGNmNWY5MTk4
+    YjEzMWM5ZDI2Y2RiMDI0YWQ2M2ZmZDA5NWIyYzY3Njk1MzBjNWE=
   data.tar.gz: !binary |-
-    MDc1ODY5YTNiNmRmMjZmZmNlZThiZWJiNWE1MjFhY2MxMGRiNzE4M2I1YjMw
-    MTg0OWIwMmI3MmQ2YmVlOWY1ZjY1MGFkYTVmNzljMmQzYzgxNjEzMDhhNmY1
-    MmI3M2RkOTU0MjE5YjdiZGRkNzhjNmUyMzkwY2EwOGMxZjIxZmU=
+    Mzc1ZWZjOTU4OGRmZmI2MmJkNmIyZmQ3YmM4ZmZiMmY2YTQ1N2ExNWFlZGE0
+    OGJiNzc1YWVjZjg2MjM5NTE2ZjBhODc3ODNiOTJkMmJhMmUxOGIyOTE2OTU1
+    NWJlMzI4MDlhNzY4NTg2YjMzMDZhNTk2YTlkZmM5MTAyZDc3YjI=

data/README.md

@@ -2,6 +2,10 @@
 
 This gem builds out the basic framework to use [Backbone.js](http://backbonejs.org/) along with templating abilities
 
+# Controller Prerequisite
+
+Please review the required format for data responses coming from your controllers which can be found [here](https://github.com/agapered/exoskeleton/wiki/Using-Backbone-Collections-and-Models)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -80,7 +84,9 @@ Navigate to the awesomness
 
     http://localhost:3000/home/index
 
-    
+## More Detailed Usage
+
+There are a few things to learn to use the full functionality of this gem. These items can be found on the [wiki](https://github.com/agapered/exoskeleton/wiki).
 
 ## Contributing
 

data/app/assets/javascripts/exoskeleton/collections/base_collection.js

@@ -1,5 +1,45 @@
 exoskeleton.collections.base_collection = Backbone.Collection.extend({
 
+  __fetchStatus: new exoskeleton.models.load_status,
 
+  fetchStatus: function(){
+    return this.__fetchStatus
+  },
+
+  fetch: function(options){
+    var _this = this ;
+    this.__fetchStatus = new exoskeleton.models.load_status()
+    Backbone.Collection.prototype.fetch.call(this,{
+      success: function(collection, response){
+        if(response.success == undefined){
+          _this.trigger('fetch:unsuccessful', collection, null, null)
+          alert("Response did not come back in appropriate json format needed: {success: [true/false], data: [Your Data], message: [Custom Message]")
+          return
+        }
+        _this.__fetchStatus.set_completed()
+        _this.__fetchStatus.set_message(response.message)
+        if(response.success){
+          _this.__fetchStatus.set_successful()
+          _this.trigger('fetch:successful', collection, response.data, response.message)
+        } else {
+          _this.trigger('fetch:unsuccessful', collection, response.data, response.message)
+        }
+        if(options && options.success){
+          options.success(collection, response)
+        }
+        _this.trigger('fetch:complete', collection, response.data, response.message)
+      },
+      error: function(collection, response) {
+        _this.__fetchStatus.set_completed()
+        _this.__fetchStatus.set_message(response.message)
+        _this.__fetchStatus.set_system_error()
+        _this.trigger('fetch:error', collection, response.data, response.message)
+        if(options && options.error){
+          options.error(collection, response)
+        }
+        _this.trigger('fetch:complete', collection, response.data, response.message)
+      }
+    })
+  }
 
 })

data/app/assets/javascripts/exoskeleton/index.js

@@ -1,6 +1,8 @@
 //= require ./vendor/underscore-min
 //= require ./vendor/backbone-min
 //= require ./main
+//= require ./models/load_status
 //= require_tree ./models
 //= require_tree ./collections
+//= require_tree ./views/mixins
 //= require_tree ./views

data/app/assets/javascripts/exoskeleton/main.js

@@ -3,5 +3,6 @@
 exoskeleton = {
   collections: {},
   models: {},
-  views: {}
+  views: {},
+  mixins: {}
 }

data/app/assets/javascripts/exoskeleton/models/base_model.js

@@ -1,5 +1,47 @@
 exoskeleton.models.base_model = Backbone.Model.extend({
 
+  __fetchStatus: new exoskeleton.models.load_status,
+
+  fetchStatus: function(){
+    return this.__fetchStatus
+  },
+
+  parse: function(response){
+    var data = _.isUndefined(response.data) ? response : response.data
+    return data
+  },
+
+  fetch: function(options){
+    var _this = this ;
+    this.__fetchStatus = new exoskeleton.models.load_status()
+    Backbone.Model.prototype.fetch.call(this,{
+      success: function(model, response){
+        _this.__fetchStatus.set_completed()
+        _this.__fetchStatus.set_message(response.message)
+        if(response.success){
+          _this.__fetchStatus.set_successful()
+          _this._original_attributes = _.clone(model.attributes);
+          _this.trigger('fetch:successful', model, response.data, response.message)
+        } else {
+          _this.trigger('fetch:unsuccessful', model, response.data, response.message)
+        }
+        if(options && options.success){
+          options.success(model, response)
+        }
+        _this.trigger('fetch:complete', model, response.data, response.message)
+      },
+      error: function(model, response) {
+        _this.__fetchStatus.set_completed()
+        _this.__fetchStatus.set_message(response.message)
+        _this.__fetchStatus.set_system_error()
+        _this.trigger('fetch:error', model, response.data, response.message)
+        if(options && options.error){
+          options.error(model, response)
+        }
+        _this.trigger('fetch:complete', model, response.data, response.message)
+      }
+    })
+  },
 
 
 })

data/app/assets/javascripts/exoskeleton/models/load_status.js

@@ -0,0 +1,40 @@
+exoskeleton.models.load_status = Backbone.Model.extend( {
+  initialize: function(){
+    this.is_complete = false
+    this.is_successful = false
+    this.status_message = null
+    this.is_error = false
+  },
+
+  set_completed: function(){
+    this.is_complete = true
+  },
+
+  set_successful: function(){
+    this.is_successful = true
+  },
+
+  set_message: function(message){
+    this.status_message = message
+  },
+
+  set_system_error: function(){
+    this.is_error = true
+  },
+
+  complete: function(){
+    return this.is_complete
+  },
+
+  successful: function(){
+    return this.is_successful
+  },
+
+  message: function(){
+    return this.status_message
+  },
+
+  system_error: function(){
+    return this.is_error
+  }
+})

data/app/assets/javascripts/exoskeleton/views/base_view.js

@@ -1,4 +1,67 @@
 exoskeleton.views.base_view = Backbone.View.extend({
 
+  remove: function(){
+
+    if (_.isFunction(this.clean_up)){
+      this.clean_up()
+    }
+
+    _.each(this.child_views, function(child_view){
+      child_view.remove()
+    })
+
+    this.child_views = []
+
+    this.$el.children().remove()
+
+    this.undelegateEvents()
+    Backbone.View.prototype.remove.call(this);
+  },
+
+  add_subview: function(view_to_append){
+    if (_.isUndefined(this.child_views))
+    {
+      this.child_views = []
+    }
+    this.child_views.push(view_to_append)
+  },
+
+  append_view: function(view, target){
+    this.$(target).append(view.render().el)
+    this.add_subview(view)
+  },
+
+  set_html: function(view, target){
+    this.$(target).html(view.render().el)
+    this.add_subview(view)
+  },
+
+  /*postAttachment
+   This function executes the supplied function after the view has been attached to the DOM.
+   If the view is already attached to the DOM the function is executed immediately.  If the
+   view is not attached to the DOM, it will check every eighth second for up to 30 seconds
+   and execute the function as soon as it is attached.  If the view is not attached to the
+   DOM within 30 seconds, the function will never be executed.  The view itself will be
+   passed into the function as an argument.
+   */
+  post_attachment: function(fn, count){
+    if ( count ){
+      count++
+    } else {
+      count = 0
+    }
+    if( count > 240 ){
+      return
+    }
+    if( $(this.el).parents('body').length > 0 ){
+      fn(this)
+    } else {
+      var _this = this
+      setTimeout(function(){
+        _this.post_attachment(fn, count)
+      }, 125)
+    }
+
+  }
 
 })

data/app/assets/javascripts/exoskeleton/views/mixins/required_elements_mixin.js

@@ -0,0 +1,80 @@
+exoskeleton.mixins.required_elements = {
+  add_required_element: function(element){
+    if(!this.required_elements){
+      this.required_elements = []
+    }
+    if(_.isUndefined(this.required_element_error_shown)){
+      this.required_element_error_shown = false
+    }
+    var _this = this;
+    element.bind('fetch:complete', function(event_element){
+      // Prevent triggering render on sub-models and sub-collections.
+      if( event_element === element ){
+        _this.render();
+      }
+    }, this);
+    this.required_elements.push(element)
+  },
+  required_elements_loaded: function(){
+    if(!this.required_elements){
+      this.required_elements = []
+    }
+    var loaded = true
+    var successful = true
+    var system_error = false
+
+    for(var i=0; i<this.required_elements.length; i++){
+      var element = this.required_elements[i]
+      if(!(element.fetchStatus().is_complete)){
+        loaded = false
+        break;
+      }
+      if(!(element.fetchStatus().successful())){
+        successful = false
+        if(element.fetchStatus().system_error()){
+          system_error = true
+        }
+        break;
+      }
+    }
+
+    var status = {
+      loaded: loaded,
+      successful: successful,
+      system_error: system_error
+    }
+
+    return status
+  },
+  render: function(){
+    if(this.required_element_error_shown){
+       return this
+    }
+    var load_status = this.required_elements_loaded()
+    if(!load_status.loaded){
+     this.render_progress()
+     return this
+    }
+
+    if(!load_status.successful){
+     if(load_status.system_error){
+       this.system_error()
+       return this
+     }
+     this.required_element_error_shown = true
+     this.render_error()
+     return this
+    }
+
+    this.render_successful()
+    return this
+  },
+  system_error: function(){
+    //Blank method incase it is not implemented on older views
+  },
+  render_error: function(){
+    //Blank method incase it is not implemented on older views
+  }
+
+
+}

data/lib/exoskeleton/version.rb

@@ -1,3 +1,3 @@
 module Exoskeleton
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exoskeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - David Hopp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -194,9 +194,11 @@ files:
 - app/assets/javascripts/exoskeleton/index.js
 - app/assets/javascripts/exoskeleton/main.js
 - app/assets/javascripts/exoskeleton/models/base_model.js
+- app/assets/javascripts/exoskeleton/models/load_status.js
 - app/assets/javascripts/exoskeleton/vendor/backbone-min.js
 - app/assets/javascripts/exoskeleton/vendor/underscore-min.js
 - app/assets/javascripts/exoskeleton/views/base_view.js
+- app/assets/javascripts/exoskeleton/views/mixins/required_elements_mixin.js
 - exoskeleton.gemspec
 - lib/exoskeleton.rb
 - lib/exoskeleton/engine.rb