ninjs 0.12.0 → 0.12.1

data/README.textile

@@ -48,23 +48,23 @@ The run method will execute the actions method. Please note that the "run" metho
 	myapplication.hello.execute();
 </pre>
 
-This pattern allows you to write in a literate style while making your intentions clear and methods succinct. However, if you prefer a shorter syntax or make your module completely protable (transplant to any application), Ninjs defines two aliases to work with your application and modules that are more terse. Your application object will be aliased as "_" (underscore). When using either the run or execute methods to call the module's actions, the module will be available through the "__" alias. The previous hello module would look like the following:
+This pattern allows you to write in a literate style while making your intentions clear and methods succinct. However, if you prefer a shorter syntax or make your module completely protable (transplant to any application), Ninjs defines an application alias to make your module code cleaner and your modules portable. Your application object will be aliased as "app". With the app alias we can write the previous module like so:
 
 <pre name="code" class="brush: js;">	
-	_.add_module('hello');
+	app.add_module('hello');
 	
-	_.hello.actions = function() {
-		__.say_hello();
+	app.hello.actions = function() {
+		this.say_hello();
 	};
 	
-	_.hello.say_hello = function() {
+	app.hello.say_hello = function() {
 		alert('Hello World');
 	};
 	
-	_.hello.run();
+	app.hello.run();
 </pre>
 
-This not only makes the module less cumbersome to write, it also allows you to port modules directly into other Ninjs application's and run them without any renaming. Remember one underscore is a reference to the application and two underscores is a reference to the current module.
+This not only makes the module less cumbersome to write, it also allows you to port modules directly into other Ninjs application's and run them without any renaming.
 
 You may ask why we are calling say_hello() in the actions method instead of just alerting the string in actions itself. Let's set aside the fact that this is a trivial example and assume we will be adding many more methods to the module. If we simply added all of our module code inside actions, we'd quickly have a soup of code in there which would be difficult to follow. The Ninjs javascript framework encourages syntactic clarity. It's preferable for the actions method to be a list of methods called in the module. This let's my module tell a consistent story from top to bottom. The actions method serves as a table of contents. Consider a slightly more sophisticated hello module:
 
@@ -203,18 +203,65 @@ This way we don't have to keep redefining the same properties each time we call
 	}
 </pre>
 
-The model provides a default base that we can build from, helping use to keep our code DRY. There's also an opportunity here to illustrate the utility of the "ninja" aliases. Notice that inside the dialog function we are unable to use the this.dialog_settings shorthand. Using "this" in Javascript can be a bit tricky. In this case, "this" is referring to the dialog and not the module. That's why Ninjs defines the double underscore ( __ ) variable to refer to the current module. The previous example can be rewritten more succinctly like so:
+The model provides a default base that we can build from, helping use to keep our code DRY.
+
+
+h1. Reference and Style
+
+Notice the "this" variable used in the module methods. In this context "this" refers to the module itself. You need to be careful here because "this" in javascript is a fickle thing. Once you're inside another function, "this" no longer refers to the module, it refers to the current function. We need a way to refer to the modules without using the full namespace to access our module but that is quite a mouthful and tends to clutter up the methods, making them harder to read. The best way to get a local, private alias to our module is to wrap it in a closure like so:
 
 <pre name="code" class="brush: js;">
-	MyApplciation.hello.create_dialogs = function() {
-  	__.error_dialog.dialog(__.dialog_settings);
-  	__.notice_dialog.dialog($.extend(__.dialog_settings, {
-  		height: 300,
-  		autoOpen: true
-  	}));
-  }
+  (function(){
+      var self = myapplication.add_module('mymodule);
+      
+      myapplication.mymodule.actions = function() {
+          self.observe_some_element_click();
+      };
+      
+      myapplication.mymodule.observe_some_element_click = function() {
+           self.some_element.click(function() {
+               self.make_something_happen();
+           });
+        };
+        
+      myapplication.mymodule.make_something_happen = function() {
+          alert('something happened');
+      };
+
+      ...      
+  })();
 </pre>
 
+Because the add_module method returns the module it just created, we can assign it to "self". This gives us a clear, consistent way to refer to the module. Although the framework is flexible in how you access your application and module objects, my favorite way to define modules looks something like this:
+
+<pre name="code" class="brush: js;">
+    (function(){
+          var self = app.add_module('mymodule);
+
+          app.mymodule.actions = function() {
+             app.setup_some_plugin();
+          };
+          
+          app.mymodule.setup_some_plugin = function() {
+              self.some_element.some_plugin(self.data.some_plugin_config);
+          };
+          
+          app.mymodule.observe_some_element_click = function() {
+             self.some_element.click(function() {
+                 self.make_something_happen();
+             });
+          };
+          
+          app.mymodule.make_something_happen = function() {
+              alert('something happened');
+          };
+
+          app.mymodule.run();      
+      })();
+</pre>
+
+Using the app alias makes your module copy-paste compatible with other ninjs applications, and it also cuts down on the typing. I like to define the methods using the app.module namespace because it helps me remember where I am when I'm in the middle of the file. Inside the methods I only refer to the module as self to be clear.
+
 h1. Compiling the application
 
 Now that we have a complete module including elements and a model, we need to compile these files into one coherent file to use in our html.  To do so we have 2 options.  Open a terminal window (command prompt) and navigate to the root of your Ninjs application. We can compile our application with one of 2 commands. The first choice is the compile command. From the root of your Ninjs application type:

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.12.1

data/ninjs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ninjs}
-  s.version = "0.12.0"
+  s.version = "0.12.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dayton Nolan"]
-  s.date = %q{2011-04-07}
+  s.date = %q{2011-04-08}
   s.default_executable = %q{ninjs}
   s.description = %q{Ninjs is a ruby application and small javascript framework that helps you build clean, modular javascript applications. Ninjs encourages "Good Parts" best practices and the Crockford school Module pattern (http://www.crockford.com/). The ninjs command line application is an automatic compiler, written in ruby, and based on the Sprockets library (http://getsprockets.org/).}
   s.email = %q{daytonn@gmail.com}
@@ -310,7 +310,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{nowarning}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{ninjs is a command line application to help you write clean, modular javascript applications.}
   s.test_files = [
     "spec/ninjs_spec.rb",
@@ -318,7 +318,6 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/repository/ninjs/core/application.js

@@ -42,7 +42,12 @@ NinjsApplication.method('add_module', function(name) {
 		if (is_defined(this[name])) {
 			throw new SyntaxError("NinjsApplication.add_module(name): '" + name + "' already declared");
 		}
-		this[name] = new NinjsModule(name);
+		
+		if (this.name === name) {
+			throw new SyntaxError("NinjsApplication.add_module(name): a module cannot have the same name as the application");
+		}
+		
+		return this[name] = new NinjsModule(name);
 	}
 	catch(error) {
 		alert(error.message);

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ninjs
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 45
+  prerelease: 
   segments: 
   - 0
   - 12
-  - 0
-  version: 0.12.0
+  - 1
+  version: 0.12.1
 platform: ruby
 authors: 
 - Dayton Nolan
@@ -14,208 +15,223 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -05:00
+date: 2011-04-08 00:00:00 -05:00
 default_executable: ninjs
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubikon
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: rubikon
   version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: fssm
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: fssm
   version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: jsmin
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: jsmin
   version_requirements: *id003
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: sprockets
+  type: :runtime
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: sprockets
   version_requirements: *id004
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: metric_fu
+  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: metric_fu
   version_requirements: *id005
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: shoulda
   version_requirements: *id006
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
-  type: :development
-  prerelease: false
+  name: bundler
   version_requirements: *id007
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  type: :development
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 5
         - 2
         version: 1.5.2
-  type: :development
-  prerelease: false
+  name: jeweler
   version_requirements: *id008
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  type: :development
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: rcov
   version_requirements: *id009
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: rspec
   version_requirements: *id010
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rubikon
+  type: :runtime
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: rubikon
   version_requirements: *id011
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: fssm
+  type: :runtime
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: fssm
   version_requirements: *id012
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: jsmin
+  type: :runtime
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: jsmin
   version_requirements: *id013
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: sprockets
+  type: :runtime
   requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: sprockets
   version_requirements: *id014
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: rspec
   version_requirements: *id015
+  prerelease: false
 description: Ninjs is a ruby application and small javascript framework that helps you build clean, modular javascript applications. Ninjs encourages "Good Parts" best practices and the Crockford school Module pattern (http://www.crockford.com/). The ninjs command line application is an automatic compiler, written in ruby, and based on the Sprockets library (http://getsprockets.org/).
 email: daytonn@gmail.com
 executables: 
@@ -526,7 +542,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3857615926705815432
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -535,13 +551,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: ninjs is a command line application to help you write clean, modular javascript applications.