modjs-architecture 0.3.5 → 0.4.0

data/lib/modjs-architecture/core/module.js

@@ -1,5 +1,15 @@
+//## Mod.Module
+
+// Modules are responsible for defining the specific behavior
+// of pieces of your application. All the functionality of your 
+// application will be defined in modules.
 Mod.Module = (function() {
 
+    // Each module contains a `dom` property which is a [Mod.DOM](dom.html) 
+    // instance to act as the module's API to the DOM. The `data` attribute 
+    // is a simple object literal that serves to store module-wide configuration 
+    // and properties (which prevents polluting the modules namespace and collision with public methods). 
+    // The `name` property is a convenience to be able to ask a module it's name.
     function Module(name) {
         if (is_undefined(name)) {
             throw new Error("Mod.Module(name): name is undefined");
@@ -10,19 +20,20 @@ Mod.Module = (function() {
         this.name = name;
     }
 
-    Module.prototype.actions = function() {};
+    //### init
+    // The init method is a placholder to be overwritten in each instance
+    Module.prototype.init = function() {};
 
-    Module.prototype.run = function() {
+    //### init_when_ready
+    // Wait for the DOM to be ready and execute the actions
+    Module.prototype.init_when_ready = function() {
         var mod = this;
-        this.dom.call_when_ready(function() {
-            mod.execute();
-        });
-    };
-
-    Module.prototype.execute = function() {
-        this.actions();
+        this.dom.call_when_ready(mod.init);
     };
 
+    //### elements
+    // Serves as an api to set and get elements from the module's `dom` property.
+    // passing a string retrieves an element, passing an object sets elements
     Module.prototype.elements = function(elements) {
         if (is_undefined(elements)) {
             return this.dom.cache;
@@ -39,6 +50,8 @@ Mod.Module = (function() {
         }
     };
 
+    //### set_data
+    // Convenience method to add properties to the `data` property of the module
     Module.prototype.set_data = function(key, value) {
         if (is_undefined(key)) {
             throw new Error(this.name + '.set_data(key, value): key is undefined');

data/lib/modjs-architecture/extensions/events.js

@@ -1,3 +1,7 @@
+//## Events
+
+// Standardizes events accross all browsers and adds W3C events if not present.
+// Taken directly form [Mozilla Docs](https://developer.mozilla.org/en/DOM/element.removeEventListener)
 if (!Element.prototype.addEventListener) {
     var oListeners = {};
 

data/lib/modjs-architecture/helpers/existence.js

@@ -1,11 +1,21 @@
+//## Existence
+// Provides convenience methods to determine the existence and
+// identity of variables.
+
+//### is_defined
+// Convenience method to detect defined status
 is_defined = function(suspect) {
   return typeof suspect == "undefined" ? false : true;
 };
 
+//### is_undefined
+// Convenience function to detect undefined status
 is_undefined = function(suspect) {
   return typeof suspect == "undefined" ? true : false;
 };
 
+//### is_typeof
+// Strict type checking against the `suspect`'s constructor
 is_typeof = function(type, suspect) {
   if (is_undefined(type)) {
     throw new Error("is_typeof(Type, suspect): type is undefined");
@@ -18,6 +28,8 @@ is_typeof = function(type, suspect) {
   return suspect.constructor == type ? true : false;
 };
 
+//### is_numeric
+// Determines `suspect` holds a numeric value
 is_numeric = function(suspect) {
   if (isNaN(suspect)) {
     return false;
@@ -25,30 +37,44 @@ is_numeric = function(suspect) {
   return !isNaN(parseFloat(suspect)) && isFinite(suspect);
 };
 
+//### is_string
+// Alias method for String detection
 is_string = function(suspect) {
   return is_typeof(String, suspect);
 };
 
+//### is_array
+// Alias method for Array detection
 is_array = function(suspect) {
   return is_typeof(Array, suspect);
 };
 
+//### is_number
+// Alias method for Number detection
 is_number = function(suspect) {
   return is_typeof(Number, suspect);
 };
 
+//### is_date
+// Alias method for Date detection
 is_date = function(suspect) {
   return is_typeof(Date, suspect);
 };
 
+//### is_bool
+// Alias method for Boolean detection
 is_bool = function(suspect) {
   return is_typeof(Boolean, suspect);
 };
 
+//### is_regex
+// Alias method for RegExp detection
 is_regex = function(suspect) {
   return is_typeof(RegExp, suspect);
 };
 
+//### is_empty
+// Convenience method to detect whether the `suspect` is empty
 is_empty = function(suspect) {
   if (is_undefined(suspect)) {
     return true;
@@ -57,6 +83,8 @@ is_empty = function(suspect) {
   return suspect.length === 0;
 };
 
+//### is_not_empty
+// Convenience method to detect whether the `suspect` is not empty
 is_not_empty = function(suspect) {
   return suspect.length >= 1;
 };

data/lib/modjs-architecture/lib/mod.js

@@ -239,19 +239,15 @@ Mod.Module = (function() {
         this.name = name;
     }
 
-    Module.prototype.actions = function() {};
+    Module.prototype.init = function() {};
 
-    Module.prototype.run = function() {
+    Module.prototype.init_when_ready = function() {
         var mod = this;
         this.dom.call_when_ready(function() {
-            mod.execute();
+            mod.init();
         });
     };
 
-    Module.prototype.execute = function() {
-        this.actions();
-    };
-
     Module.prototype.elements = function(elements) {
         if (is_undefined(elements)) {
             return this.dom.cache;
@@ -297,8 +293,8 @@ Mod.Application = (function() {
             throw new Error("new Mod.Application(name): name is undefined");
         }
 
-        this.name = name
-    };
+        this.name = name;
+    }
 
     Application.prototype.add_module = function(name) {
         if (is_undefined(name)) {

data/modjs-architecture.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "modjs-architecture"
-  s.version = "0.3.5"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dayton Nolan"]
-  s.date = "2012-04-14"
+  s.date = "2012-05-11"
   s.description = "Mod.js is a modular javascript library that provides a base application strucure to build large javascript applications. Mod.js is designed to work with architecture.js."
   s.email = "daytonn@gmail.com"
   s.extra_rdoc_files = [
@@ -26,7 +26,12 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
-    "foo.js",
+    "docs/application.html",
+    "docs/docco.css",
+    "docs/dom.html",
+    "docs/events.html",
+    "docs/existence.html",
+    "docs/module.html",
     "lib/modjs-architecture.rb",
     "lib/modjs-architecture/core/application.js",
     "lib/modjs-architecture/core/dom.js",

data/spec/fixtures/foo-elements.js

@@ -3,9 +3,10 @@
 
     //= require "../elements/foo-elements.elements"
 
-    m.actions = function() {
+    m.init = function() {
         
-    }
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(myapp);

data/spec/fixtures/foo.js

@@ -1,9 +1,10 @@
 (function(app) {
     var m = app.add_module("foo");
 
-    m.actions = function() {
-        
-    }
+    m.init = function() {
+        return this;
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(myapp);

data/spec/fixtures/foo_all.js

@@ -5,9 +5,10 @@
 
     //= require "../models/foo_all.model"
 
-    m.actions = function() {
-        
-    }
+    m.init = function() {
+        return this;
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(myapp);

data/spec/fixtures/foo_elements.js

@@ -3,9 +3,10 @@
 
     //= require "../elements/foo_elements.elements"
 
-    m.actions = function() {
-        
-    }
+    m.init = function() {
+        return this;
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(myapp);

data/spec/fixtures/foo_model.js

@@ -3,9 +3,10 @@
 
     //= require "../models/foo_model.model"
 
-    m.actions = function() {
-        
-    }
+    m.init = function() {
+        return this;
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(myapp);

data/spec/fixtures/myapp.js

@@ -239,17 +239,11 @@ Mod.Module = (function() {
         this.name = name;
     }
 
-    Module.prototype.actions = function() {};
+    Module.prototype.init = function() {};
 
-    Module.prototype.run = function() {
+    Module.prototype.init_when_ready = function() {
         var mod = this;
-        this.dom.call_when_ready(function() {
-            mod.execute();
-        });
-    };
-
-    Module.prototype.execute = function() {
-        this.actions();
+        this.dom.call_when_ready(mod.init);
     };
 
     Module.prototype.elements = function(elements) {
@@ -297,8 +291,8 @@ Mod.Application = (function() {
             throw new Error("new Mod.Application(name): name is undefined");
         }
 
-        this.name = name
-    };
+        this.name = name;
+    }
 
     Application.prototype.add_module = function(name) {
         if (is_undefined(name)) {

data/spec/fixtures/update.js

@@ -243,17 +243,11 @@ Mod.Module = (function() {
         this.name = name;
     }
 
-    Module.prototype.actions = function() {};
+    Module.prototype.init = function() {};
 
-    Module.prototype.run = function() {
+    Module.prototype.init_when_ready = function() {
         var mod = this;
-        this.dom.call_when_ready(function() {
-            mod.execute();
-        });
-    };
-
-    Module.prototype.execute = function() {
-        this.actions();
+        this.dom.call_when_ready(mod.init);
     };
 
     Module.prototype.elements = function(elements) {
@@ -301,8 +295,8 @@ Mod.Application = (function() {
             throw new Error("new Mod.Application(name): name is undefined");
         }
 
-        this.name = name
-    };
+        this.name = name;
+    }
 
     Application.prototype.add_module = function(name) {
         if (is_undefined(name)) {

data/spec/javascripts/module_spec.js

@@ -34,16 +34,8 @@ describe("Mod.Module", function() {
         expect(module.data.three).toEqual('three');
     });
 
-    it("should have an actions method", function() {
-        expect(module.actions).toBeTruthy();
-    });
-
-    it("should have an execute method to call the actions", function() {
-        module.actions = function() {
-            this.set_data('actions_did_run', true);
-        };
-        module.execute();
-        expect(module.data.actions_did_run).toBeTruthy();
+    it("should have an init method", function() {
+        expect(module.init).toBeTruthy();
     });
 
     it("should have an elements method to cache DOM elements", function() {
@@ -67,10 +59,11 @@ describe("Mod.Module", function() {
     });
 
     it("should run the execute method when the dom is ready", function() {
-        module.actions = function() {
-            this.set_data('actions_did_run', true);
-            expect(module.data.actions_did_run).toBeTruthy();
+        module.init = function() {
+            this.set_data('init_did_run', true);
+            expect(module.data.init_did_run).toBeTruthy();
         };
-        module.run();
+
+        module.init_when_ready();
     });
 });

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+
 SimpleCov.start
 
 $: << File.join(File.dirname(__FILE__), "../lib")

data/templates/module.js

@@ -9,9 +9,10 @@
     //= require "../models/<%= arguments[1] %>.model"
 <% end %>
 
-    m.actions = function() {
+    m.init = function() {
         
-    }
+    };
+
+    m.init_when_ready();
 
-    m.run();
 })(<%= blueprint[:name] %>);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modjs-architecture
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-14 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: architecture-js
@@ -126,7 +126,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- foo.js
+- docs/application.html
+- docs/docco.css
+- docs/dom.html
+- docs/events.html
+- docs/existence.html
+- docs/module.html
 - lib/modjs-architecture.rb
 - lib/modjs-architecture/core/application.js
 - lib/modjs-architecture/core/dom.js
@@ -186,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4571541150195370455
+      hash: 3899685420511106559
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/foo.js

@@ -1,9 +0,0 @@
-(function(app) {
-    var m = myapp.add_module(foo);
-
-    m.actions = function() {
-        
-    }
-
-    m.run();
-})(myapp);