sudojs-rails 0.1.7 → 0.1.9

data/README.md

@@ -70,12 +70,92 @@ Before use, a few steps need to be followed to prepare your project for our pref
 ### In Practice
 
 running the command `rails g` would reveal that a single `sudojs:install` command can be made. Execute the command 
-`rails g sudojs:install -h` to see the USAGE directives. Running `rails g sudojs:install Spam` will install the correct files 
+`rails g sudojs:install -h` (or see below) to see the USAGE directives. Running `rails g sudojs:install Spam` will install the correct files 
 and directories (with your shiny new `Spam` namespace).
 
+#### sudojs:install USAGE
+
+		Description:
+			Install sudo.js along with it's particular directory hierarchy.
+
+		Example:
+			rails g sudojs:install namespace [which_sudo] [which_markup] [use_coffee]
+
+			The only mandatory argument is the initial `namespace`.
+
+			The install generator uses these optional arguments to expand the values in the sudo_js.yml file:
+				1. `which_sudo` => which version of sudo.js are you loading? As sudo.js can be rebuilt into any number
+					 of custom configurations, indicate here what name should be placed into the application manifest.
+					 Defaults to 'sudo-x' if omitted.
+				2. `which_markup` => defaults to `erb`.
+				3. `use_coffee` => defaults to `false` pass `true` if you are of the coffee persuasion.
+
+			This will create:
+			app/
+				assets/
+					javascripts/
+						application/
+							yourNamespace.js
+							model.js
+						manifests/
+							application.js
+						views/
+			config/
+				sudo_js.yml
+
+#### sudojs:class USAGE
+
 After installing a second generator becomes available, run `rails g` again and `sudojs:class` should now be an option.
-The reason for this is that `:class` depends on a yaml file to be placed in `config/` to function. Execute the command
-`rails g sudojs:class -h` for the directives there.
+The reason for this is that `:class` depends on a yaml file to be placed in `config/` to function. Executing the command
+`rails g sudojs:class -h` would reveal this:
+
+		Description:
+			Create a skeletal sudo.js Class and place the files correctly for a given controller#name.
+
+		Example:
+			`rails g sudojs:class View foo#baz`
+
+			Where `View` is a Class Object that this new Object will inherit from. Sudo.js itself
+			will recognize 5 types:
+
+				1. 'Base'
+				2. 'Container'
+				3. 'View'
+				4. 'ViewController'
+				5. 'Dataview'
+
+			The inheritance for any of these will be set as `_.<Name>` as we assume sudo has taken the 
+			global `_` char as an alias. If the argument is any other string we assume you are inheriting
+			from a custom class and pass it through as is.
+
+
+			Where `foo#baz` *can* match a controller#action (like `home#show`) it does not
+			have to. The controller argument (`foo`) allows the generator to place the file correctly and 
+			create/modify the correct manifest file. The name argument will be the proper name of the 
+			Class Object itself
+
+			If a corresponding views/controller/name.html.* is found, a skeletal instantiation of the newly 
+			created View will be placed there
+
+			This will create:
+				app/
+					assests/
+						javascripts/
+							manifests/
+								foo.js
+							views/
+								foo/
+									baz.js
+
+			And modify (if found):
+				app/
+					views/
+						foo/
+							baz.html.*
+
+		Note:
+			If the `route` is application level (application#baz) the file will be placed
+			in the application level directory and the manifests/application file will be modified
 
 ## Contributing
 

data/Rakefile

@@ -8,11 +8,13 @@ end
 require 'bundler/gem_tasks'
 
 namespace :sudojs do
-  desc "Download the latest released versions sudo.js"
+  desc "Download the latest released versions sudo.js as well as Ecmascript-5 shims for non-standard browsers"
   task :download_latest do
     files = {
-      'sudo.js'=>'https://raw.github.com/robrobbins/sudo-js/jquery/build/debug/sudo.js',
-      'sudo-x.js' => 'https://raw.github.com/robrobbins/sudo-js/jquery/build/debug/sudo-x.js'
+      'sudo.js'=>'https://raw.github.com/robrobbins/sudo-js/master/build/debug/sudo.js',
+      'sudo-x.js' => 'https://raw.github.com/robrobbins/sudo-js/master/build/debug/sudo-x.js',
+      'es5-shim' => 'https://raw.github.com/robrobbins/sudo-js/master/lib/es5-shim/es5-shim.js',
+      'es5-sham' => 'https://raw.github.com/robrobbins/sudo-js/master/lib/es5-shim/es5-sham.js'
     }
     
     vendor_dir = "vendor/assets/javascripts"

data/lib/sudojs/version.rb

@@ -1,3 +1,3 @@
 module Sudojs
-  VERSION = '0.1.7'
+  VERSION = '0.1.9'
 end

data/vendor/assets/javascripts/es5-sham

@@ -0,0 +1,25 @@
+// Polyfills for non-std browsers that, while not attaining ES5 spec
+// (hence `sham`), function correctly on a limited scope.
+(function() {
+	if(!Object.create) {
+		Object.create = function(obj) {
+			var ret;
+			if (arguments.length > 1 ) {
+				// cannot support the multiple argument scenario for legacy browsers
+				throw new Error('This Object.create implementation only accepts a single argument');
+			}
+			function F(){}
+			F.prototype = obj;
+			ret = new F();
+			// Allows Object.getPrototypeOf to work in non-std browsers
+			ret.__proto__ = obj;
+			return ret;
+		};
+	}
+	// Will return the expected Object for all Objects created using the above `create` method
+	if(!Object.getPrototypeOf) {
+		Object.getPrototypeOf = function(object) {
+			return object.__proto__;
+		};
+	}
+}());