sudojs-rails 0.2.4 → 0.2.8

data/lib/generators/sudojs/class/USAGE

@@ -5,42 +5,48 @@ 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:
+    will recognize 6 types:
 
       1. 'Base'
-      2. 'Container'
-      3. 'View'
-      4. 'ViewController'
-      5. 'Dataview'
+      2. 'Model'
+      3. 'Container'
+      4. 'View'
+      5. 'ViewController'
+      6. '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
+    Class Object itself.
 
-    If a corresponding views/controller/name.html.* is found, a skeletal instantiation of the newly 
-    created View will be placed there
+    If a corresponding views/controller/name.html* is found, a skeletal instantiation of the newly 
+    created View will be placed there.
 
-    This will create:
+    This will create (or modify):
       app/
         assests/
+          stylesheets/
+            manifests/
+              foo.css
+            views/
+              foo/
+                baz.css(*)
           javascripts/
             manifests/
               foo.js
             views/
               foo/
-                baz.js
+                baz.js(*)
 
     And modify (if found):
       app/
         views/
           foo/
-            baz.html.*
+            baz.html(*)
 
 Note:
     If the `route` is application level (application#baz) the file will be placed

data/lib/generators/sudojs/class/class_generator.rb

@@ -47,42 +47,77 @@ module Sudojs
       # expand the template to <destination>
       def copy_class_template
         if @is_application
-          path = "app/assets/javascripts/application"
+          path = 'app/assets/javascripts/application'
+          css_path = 'app/assets/stylesheets/application'
           @path_to_object = namespace
         else
           path = "app/assets/javascripts/views/#{@c_name}"
+          css_path = "app/assets/stylesheets/views/#{@c_name}"
           @path_to_object = [namespace, '.', @c_camel].join('')
           # make sure the directory is present (create if not)
-          ensure_cname_dir(path)
+          unless skip_css?
+            ensure_cname_dir(path, css_path)
+          else
+            ensure_cname_dir(path)
+          end
         end
 
-        if use_coffee?
+        # js
+        if js_extension == '.js.coffee'
           template 'class.coffee.erb', "#{path}/#{@a_name}.js.coffee"
         else
-          template 'class.js.erb', "#{path}/#{@a_name}.js"
+          template 'class.js.erb', "#{path}/#{@a_name}#{js_extension}"
+        end
+
+        # css
+        unless skip_css?
+          # new, blank file
+          create_file "#{css_path}/#{@a_name}#{css_extension}"
         end
       end
 
       def create_or_modify_manifest
+        js_pre = '//= '
+        css_pre = ' *= '
+        rest_app = "require application/#{@a_name}"
+        rest_view = "require views/#{@c_name}/#{@a_name}"
         filename = "app/assets/javascripts/manifests/#{@c_name}.js"
+        css_filename = "app/assets/stylesheets/manifests/#{@c_name}.css"
         if @is_application
-          line = "//= require application/#{@a_name}"
+          line = js_pre + rest_app
+          css_line = css_pre + rest_app + "\n"
         else
-          line = "//= require views/#{@c_name}/#{@a_name}"
+          line = js_pre + rest_view
+          css_line = css_pre + rest_view + "\n"
         end
 
+        # js
         if File.exist? filename
-          # inject_into_file not needed here unless you were using a require tree
+          # inject_into_file not needed here as we do not use require_tree
           append_to_file filename, line
+          gsub_file filename, /^$\n/, ''
         else
           template 'manifest.js.erb', filename
+          gsub_file filename, /^$\n/, ''
+        end
+
+        # css
+        unless skip_css?
+          if File.exist? css_filename
+            inject_into_file css_filename, css_line, :before => '*/'
+            gsub_file css_filename, /^$\n/, ''
+          else
+            template 'manifest.css.erb', css_filename
+            gsub_file css_filename, /^$\n/, ''
+          end
         end
       end
 
       def modify_view_if_exists
-        filename = "app/views/#{@c_name}/#{@a_name}.html.#{which_markup}"
+        filename = "app/views/#{@c_name}/#{@a_name}.html#{html_extension}"
         if File.exist? filename
-          if use_coffee?
+          # TODO other pre-processors may need entries here
+          if js_extension == '.js.coffee'
             comment = '#'
           else
             comment = '//'
@@ -95,10 +130,11 @@ module Sudojs
 
       private
 
-      def ensure_cname_dir(path)
-        # if exists we will assume a directory
-        unless File.exist? path
-          empty_directory(path)
+      def ensure_cname_dir(*paths)
+        paths.each do |path|
+          unless File.directory? path
+            empty_directory path
+          end
         end
       end 
 

data/lib/generators/sudojs/class/templates/manifest.css.erb

@@ -0,0 +1,9 @@
+/*
+ * This is a css manifest for the <%= @c_name%> controller
+ *
+<% if @is_application %>
+ *= require application/<%= @a_name %>
+<% else %>
+ *= require views/<%= @c_name %>/<%= @a_name %>
+<% end %>
+*/

data/lib/generators/sudojs/class/templates/manifest.js.erb

@@ -1,3 +1,5 @@
+// This is a js manifest for the <%= @c_name%> controller
+//
 <% if @is_application %>
 //= require application/<%= @a_name %>
 <% else %>

data/lib/generators/sudojs/helpers.rb

@@ -14,12 +14,21 @@ module Sudojs
         CFG['which_sudo']
       end
 
-      def which_markup
-        CFG['which_markup']
+      def html_extension
+        CFG['html_extension']
       end
 
-      def use_coffee?
-        CFG['use_coffee']
+      def js_extension
+        CFG['js_extension']
+      end
+
+      # do not create any files for (s)css
+      def skip_css?
+        CFG['skip_css']
+      end
+
+      def css_extension
+        CFG['css_extension']
       end
 
       def camelize(what)

data/lib/generators/sudojs/install/USAGE

@@ -2,7 +2,7 @@ Description:
     Install sudo.js along with it's particular directory hierarchy.
 
 Example:
-    rails g sudojs:install namespace [which_sudo] [which_markup] [use_coffee]
+    rails g sudojs:install namespace [which_sudo] [html_extension] [js_extension] [css_extension] [--skip-css=true/false]
 
     The only mandatory argument is the initial `namespace`.
 
@@ -10,12 +10,19 @@ Example:
       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.
+      2. `html_extension` => Use the full extension, i.e. `.haml`. defaults to `.erb`.
+      3. `js_extension` => defaults to `.js` pass `.js.coffee` if you are of the coffee persuasion.
+      4. `css_extension` => defaults to `.css`. Sass for example would need `.css.scss`
+
+    NOTE: to skip any and all generating of css files pass the option `--skip-css=true` when invoking the install generator.
+    Obviously, you could then leave the `css_extension` argument out. The option defaults to false.
 
     This will create:
     app/
       assets/
+        stylesheets/
+          manifests/
+            application.css
         javascripts/
           application/
             yourNamespace.js

data/lib/generators/sudojs/install/install_generator.rb

@@ -4,29 +4,54 @@ module Sudojs
       source_root File.expand_path('../templates', __FILE__)
 
       argument :which_sudo_arg, :type => :string, :default => 'sudo-x'
-      argument :which_markup_arg, :type => :string, :default => 'erb'
-      argument :use_coffee_arg, :type => :string, :default => 'false'
+      argument :html_extension_arg, :type => :string, :default => '.erb'
+      argument :js_extension_arg, :type => :string, :default => '.js'
+      argument :css_extension_arg, :type => :string, :default => '.css'
+
+      class_option :skip_css_opt, :type => :boolean, :aliases => "--skip-css", :default => false,
+        :desc => 'Skip the generation of any css files along with js'
 
       def create_yaml
+        if options[:skip_css]
+          @skip_css = 'true'
+        else
+          @skip_css = 'false'
+        end
         template 'sudo_js.erb.yml', 'config/sudo_js.yml'
       end
 
       def create_dir_structure
         %W{application manifests views}.each do |dir|
-          empty_directory "app/assets/javascripts/#{dir}" 
+          directory = "app/assets/javascripts/#{dir}"
+          css_directory = "app/assets/stylesheets/#{dir}"
+          unless File.directory? directory
+            empty_directory directory
+          end
+
+          unless options[:skip_css]
+            unless File.directory? css_directory
+              empty_directory css_directory
+            end
+          end
         end
       end
 
       def place_install_files
         template 'app_manifest.js.erb', 'app/assets/javascripts/manifests/application.js'
-        
-        unless use_coffee_arg == 'false'
+        unless options[:skip_css]
+          template 'app_manifest.css.erb', 'app/assets/stylesheets/manifests/application.js'
+        end
+
+        # TODO templates for other javascript pre-processors 
+        if js_extension_arg == '.js.coffee'
           template 'namespace.coffee.erb', "app/assets/javascripts/application/#{name}.js.coffee"
           template 'model.coffee.erb', 'app/assets/javascripts/application/model.js.coffee'
         else
-          template 'namespace.js.erb', "app/assets/javascripts/application/#{name}.js"
-          template 'model.js.erb', 'app/assets/javascripts/application/model.js'
+          # for now any other js flavor gets the baseline .js 
+          template 'namespace.js.erb', "app/assets/javascripts/application/#{name}#{js_extension_arg}"
+          template 'model.js.erb', "app/assets/javascripts/application/model#{js_extension_arg}"
         end
+
       end
 
     end

data/lib/generators/sudojs/install/templates/app_manifest.css.erb

@@ -0,0 +1,5 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ */

data/lib/generators/sudojs/install/templates/app_manifest.js.erb

@@ -1,3 +1,6 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
 //= require jquery_ujs
 //= require <%= which_sudo_arg %>
 //= require application/<%= name %>

data/lib/generators/sudojs/install/templates/sudo_js.erb.yml

@@ -5,7 +5,13 @@ js_namespace: <%= name %>
 which_sudo: <%= which_sudo_arg %>
 
 # erb or haml or ...?
-which_markup: <%= which_markup_arg %>
+html_extension: <%= html_extension_arg %>
 
 # coffee?
-use_coffee: <%= use_coffee_arg %>
+js_extension: <%= js_extension_arg %>
+
+# create (S)css files too?
+skip_css: <%= @skip_css %>
+
+# sass?
+css_extension: <%= css_extension_arg %>

data/lib/sudojs/version.rb

@@ -1,3 +1,3 @@
 module Sudojs
-  VERSION = '0.2.4'
+  VERSION = '0.2.8'
 end

data/vendor/assets/javascripts/sudo-x.js

@@ -487,13 +487,17 @@ sudo.Container.prototype.send = function send(/*args*/) {
 // a shortcut for `this.$el.find(selector)`
 //
 // `param` {string|element|jQuery} `el`. Otional el for the View instance.
-// `param` {Object} `data`. Optional data object which becomes the initial state
-// of a new model located at `this.model`.
+// `param` {Object} `data`. Optional data object-literal which becomes the initial state
+// of a new model located at `this.model`. Also can be a reference to an existing sudo.Model instance
 //
 // `constructor`
 sudo.View = function(el, data) {
 	sudo.Container.call(this);
-	if(data) this.model = new sudo.Model(data);
+	// allow model instance to be passed in as well
+	if(data) {
+		this.model = data.role === 'model' ? data :
+			this.model = new sudo.Model(data);
+	} 
 	this.setEl(el);
 	if(this.role === 'view') this.init();
 };
@@ -1418,7 +1422,7 @@ sudo.delegates.Data.prototype.filter = function(obj) {
 // `private`
 sudo.delegates.Data.prototype.role = 'data';
 
-sudo.version = "0.9.0";
+sudo.version = "0.9.1";
 window.sudo = sudo;
 if(typeof window._ === "undefined") window._ = sudo;
 }).call(this, this);

data/vendor/assets/javascripts/sudo.js

@@ -487,13 +487,17 @@ sudo.Container.prototype.send = function send(/*args*/) {
 // a shortcut for `this.$el.find(selector)`
 //
 // `param` {string|element|jQuery} `el`. Otional el for the View instance.
-// `param` {Object} `data`. Optional data object which becomes the initial state
-// of a new model located at `this.model`.
+// `param` {Object} `data`. Optional data object-literal which becomes the initial state
+// of a new model located at `this.model`. Also can be a reference to an existing sudo.Model instance
 //
 // `constructor`
 sudo.View = function(el, data) {
 	sudo.Container.call(this);
-	if(data) this.model = new sudo.Model(data);
+	// allow model instance to be passed in as well
+	if(data) {
+		this.model = data.role === 'model' ? data :
+			this.model = new sudo.Model(data);
+	} 
 	this.setEl(el);
 	if(this.role === 'view') this.init();
 };
@@ -804,7 +808,7 @@ sudo.ext.observable = {
 		return this.deliverChangeRecords();	
 	}
 };
-sudo.version = "0.9.0";
+sudo.version = "0.9.1";
 window.sudo = sudo;
 if(typeof window._ === "undefined") window._ = sudo;
 }).call(this, this);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sudojs-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-06 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,10 +44,12 @@ files:
 - lib/generators/sudojs/class/class_generator.rb
 - lib/generators/sudojs/class/templates/class.coffee.erb
 - lib/generators/sudojs/class/templates/class.js.erb
+- lib/generators/sudojs/class/templates/manifest.css.erb
 - lib/generators/sudojs/class/templates/manifest.js.erb
 - lib/generators/sudojs/helpers.rb
 - lib/generators/sudojs/install/USAGE
 - lib/generators/sudojs/install/install_generator.rb
+- lib/generators/sudojs/install/templates/app_manifest.css.erb
 - lib/generators/sudojs/install/templates/app_manifest.js.erb
 - lib/generators/sudojs/install/templates/model.coffee.erb
 - lib/generators/sudojs/install/templates/model.js.erb
@@ -76,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4176419229015017956
+      hash: 564744646304978931
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4176419229015017956
+      hash: 564744646304978931
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24