ajax_scaffold_generator 3.1.5 → 3.1.6

data/CHANGELOG

@@ -1,7 +1,14 @@
+3.1.6 =========
 
-3.1.4 =========
+* Added two attributes to scaffold_column
+  :sanitize => Should the output of the column be sanitized of HTML elements (default: true)
+  :class_name => Class added to all TD and TH elements for this column
+* Fixed bug that was causing short circuiting format_column and not doing standard formatting of dates and times
+* Fixed bug with CSS image paths not working when the containing application was deployed in a subdirectory
+
+3.1.5 =========
 
-* Updated the functional and unit tests to patch some variable issues: <%= class_name %> used 
+* Updated the functional and unit tests to patch some variable issues: <%= class_name %> used
   instead of <%= singular_name %>. (Nic Williams)
 
 3.1.4 =========
@@ -31,7 +38,7 @@
 
 3.1.1 =========
 
-* Fixed two bugs with :eval and :sort_sql introspection in ScaffoldColumn. Should fix problems people have been having with 
+* Fixed two bugs with :eval and :sort_sql introspection in ScaffoldColumn. Should fix problems people have been having with
   underscored table names.
 * Made the code that gets the @sort_by for a component more robust so that invalid values in the session doesn't continue
   to hose scaffolds.
@@ -41,20 +48,20 @@
 * Added support for defining your own scaffold columns in models by assigning an array of ScaffoldColumn's to @scaffold_columns.
   If @scaffold_columns is not defined it will be created defaulting to columns for model.content_columns. See more about
   ScaffoldColumns in lib/ajax_scaffold.rb or by reading the documentation on the site. Model classes now must "require 'ajax_scaffold'"
-  to support this new functionality. 
+  to support this new functionality.
 * Added cancel as an action. There was enough inline code in _new_edit.rhtml that I thought, for consistency, it should be
   refactored into a server-side method.
-* Refactoring: All common server side code has been moved into lib/ajax_scaffold.rb. 
+* Refactoring: All common server side code has been moved into lib/ajax_scaffold.rb.
   This replaces the previous helpers/ajax_scaffold_helper.rb with an include in the helpers to AjaxScaffold::Helper
 * Changed CSS styling of sorted columns to a more subtle darker blue from the yellow
 
 3.0.4 =========
 
-* Pagination loading indicator was not being namespaced using the scaffold_id. Caused all pagination loaders to show when 
+* Pagination loading indicator was not being namespaced using the scaffold_id. Caused all pagination loaders to show when
   any pagination links were clicked.
 * Fixed more issues related to controllers in subdirectories. Relative path controller names caused problems as well so
   all url hashes now have a leading / on all controller names
-  
+
 3.0.3 =========
 
 * Fixed a bug where destroy.rjs was throwing element not found errors

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2006 Richard White
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2006 Richard White
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,32 +1,7 @@
-*******************************************************************************************
-** For all documentation see the project website: http://www.ajaxscaffold.com            **
-*******************************************************************************************
+********************************************************************************
+** For all documentation see the project website: http://www.ajaxscaffold.com **
+********************************************************************************
 
-Description:
-    The ajax scaffold generator creates a controller to interact with a model.
-    If the model does not exist, it creates the model as well. Unlike the
-    standard scaffold, the ajax scaffold generator uses AJAX.
-
-    The generator takes a model name, an optional controller name, and a
-    list of views as arguments.  Scaffolded actions and views are created
-    automatically.  Any views left over generate empty stubs.
-
-    If a controller name is not given, the plural form of the model name
-    will be used.  The model and controller names may be given in CamelCase
-    or under_score and should not be suffixed with 'Model' or 'Controller'.
-    Both model and controller names may be prefixed with a module like a
-    file path; see the Modules Example for usage.
-
-Example:
-    ./script/generate ajax_scaffold Account Bank debit credit
-
-    This will generate an Account model and BankController with a full test
-    suite and a basic user interface.  Now create the accounts table in your
-    database and browse to http://localhost/bank/ -- voila, you're on Rails!
-
-Modules Example:
-    ./script/generate ajax_scaffold CreditCard 'admin/credit_card' suspend late_fee
-
-    This will generate a CreditCard model and CreditCardController controller
-    in the admin module.
+Ajax Scaffold generator by Richard White (rrwhite@gmail.com)
 
+Released under the MIT license (included)

data/ajax_scaffold_generator.rb

@@ -1,201 +1,201 @@
-require "rails_generator/generators/components/scaffold/scaffold_generator"
-
-class AjaxScaffoldingSandbox < ScaffoldingSandbox
-  def default_input_block
-    Proc.new { |record, column| "<div class=\"form-element\">\n  <label for=\"#{record}_#{column.name}\">#{column.human_name}</label>\n  #{input(record, column.name)}\n</div>\n" }
-  end
-  
-  def all_input_tags(record, record_name, options) 
-    input_block = options[:input_block] || default_input_block
-    
-    if !options[:exclude].blank?
-      filtered_content_columns = record.class.content_columns.reject { |column| options[:exclude].include?(column.name) }
-    else
-      filtered_content_columns = record.class.content_columns
-    end
-    
-    filtered_content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
-  end
-  
-end
-
-class ActionView::Helpers::InstanceTag
-  alias_method :base_to_input_field_tag, :to_input_field_tag
-
-  def to_input_field_tag(field_type, options={})
-    options[:class] = 'text-input'  
-    base_to_input_field_tag field_type, options
-  end
-  
-  def to_boolean_select_tag(options = {})
-    options = options.stringify_keys
-    add_default_name_and_id(options)
-    tag_text = "<%= select \"#{@object_name}\", \"#{@method_name}\", [[\"True\", true], [\"False\", false]], { :selected => @#{@object_name}.#{@method_name} } %>"
-  end
-  
-end
-
-class AjaxScaffoldGenerator < ScaffoldGenerator
-
-  alias_method :base_controller_file_path, :controller_file_path
-  
-  def controller_file_path
-    "/" + base_controller_file_path
-  end
-
-  def manifest
-  
-    record do |m|
-      
-      # Check for class naming collisions.
-      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
-      m.class_collisions class_path, class_name, "#{singular_name}Test"
-
-      # Model, controller, helper, views, and test directories.
-      m.directory File.join('test/unit', class_path)
-      m.directory File.join('test/fixtures', class_path)
-      m.directory File.join('app/controllers', controller_class_path)
-      m.directory File.join('app/helpers', controller_class_path)
-      m.directory File.join('app/views', controller_class_path, controller_file_name)
-      m.directory File.join('app/views/layouts', controller_class_path)
-      m.directory File.join('public/images')
-      m.directory File.join('test/functional', controller_class_path)
-
-      # Model class, unit test, and fixtures.
-      m.template 'model.rb',      File.join('app/models', "#{singular_name}.rb")
-      m.template 'unit_test.rb',  File.join('test/unit', "#{singular_name}_test.rb")
-      m.template 'fixtures.yml',  File.join('test/fixtures', "#{table_name}.yml")
-      
-      # Scaffolded forms.
-      m.complex_template 'form.rhtml',
-        File.join('app/views',
-                  controller_class_path,
-                  controller_file_name,
-                  '_form.rhtml'),
-        :insert => 'form_scaffolding.rhtml',
-        :sandbox => lambda { create_sandbox },
-        :begin_mark => 'form',
-        :end_mark => 'eoform',
-        :mark_id => singular_name
-
-      # Scaffolded partials.
-      m.template "partial_item.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "_#{singular_name}.rhtml")
-
-      scaffold_partials.each do |name|
-        m.template "partial_#{name}.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "_#{name}.rhtml")
-      end
-
-      # Scaffolded views.
-      scaffold_views.each do |action|
-        m.template "view_#{action}.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "#{action}.rhtml"),
-                    :assigns => { :action => action }
-      end
-      
-      # RJS templates
-      scaffold_rjs_templates.each do |template|
-        m.template "rjs_#{template}.rjs",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "#{template}.rjs")
-      end
-      
-      # Libraries
-      scaffold_lib.each do |filename|
-        m.template "lib_#{filename}.rb",
-                    File.join('lib',
-                              "#{filename}.rb")
-      end
-
-      # Controller class, functional test, helper, and views.
-      m.template 'controller.rb',
-                  File.join('app/controllers',
-                            controller_class_path,
-                            "#{controller_file_name}_controller.rb")
-
-      m.template 'functional_test.rb',
-                  File.join('test/functional',
-                            controller_class_path,
-                            "#{controller_file_name}_controller_test.rb")
-
-      m.template 'helper.rb',
-                  File.join('app/helpers',
-                            controller_class_path,
-                            "#{controller_file_name}_helper.rb")
-
-      # Layout and stylesheet.
-      m.template 'layout.rhtml',
-                  File.join('app/views/layouts', 
-                            controller_class_path, 
-                            "#{controller_file_name}.rhtml")
-      
-      m.template 'ajax_scaffold.css',   "public/stylesheets/ajax_scaffold.css"
-      
-      scaffold_javascripts.each do |javascript|
-        m.template javascript, "public/javascripts/#{javascript}"
-      end
-      
-      scaffold_images.each do |image|
-        m.template image, "public/images/#{image}"
-      end
-
-    end
-  end
-
-  protected
-    # Override with your own usage banner.
-    def banner
-      "Usage: #{$0} ajax_scaffold ModelName [ControllerName]"
-    end
-
-    def scaffold_views
-      %w( list component )
-    end
-    
-    def scaffold_rjs_templates
-      %w( create destroy edit new update cancel )
-    end
-    
-    def scaffold_partials
-      %w( form_messages messages column_headings new_edit pagination_links )
-    end
-    
-    def scaffold_lib
-      %w( ajax_scaffold )
-    end
-
-    def scaffold_images
-      %w( indicator.gif indicator-small.gif add.gif error.gif warning.gif information.gif arrow_down.gif arrow_up.gif )
-    end
-    
-    def scaffold_javascripts
-      %w( ajax_scaffold.js rico_corner.js )
-    end
-    
-    def create_sandbox
-      sandbox = AjaxScaffoldingSandbox.new
-      sandbox.singular_name = singular_name
-      begin
-        sandbox.model_instance = model_instance
-        sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
-      rescue ActiveRecord::StatementInvalid => e
-        logger.error "Before updating scaffolding from new DB schema, try creating a table for your model (#{class_name})"
-        raise SystemExit
-      end
-      sandbox.suffix = suffix
-      sandbox
-    end
-
-end
+require "rails_generator/generators/components/scaffold/scaffold_generator"
+
+class AjaxScaffoldingSandbox < ScaffoldingSandbox
+  def default_input_block
+    Proc.new { |record, column| "<div class=\"form-element\">\n  <label for=\"#{record}_#{column.name}\">#{column.human_name}</label>\n  #{input(record, column.name)}\n</div>\n" }
+  end
+  
+  def all_input_tags(record, record_name, options) 
+    input_block = options[:input_block] || default_input_block
+    
+    if !options[:exclude].blank?
+      filtered_content_columns = record.class.content_columns.reject { |column| options[:exclude].include?(column.name) }
+    else
+      filtered_content_columns = record.class.content_columns
+    end
+    
+    filtered_content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
+  end
+  
+end
+
+class ActionView::Helpers::InstanceTag
+  alias_method :base_to_input_field_tag, :to_input_field_tag
+
+  def to_input_field_tag(field_type, options={})
+    options[:class] = 'text-input'  
+    base_to_input_field_tag field_type, options
+  end
+  
+  def to_boolean_select_tag(options = {})
+    options = options.stringify_keys
+    add_default_name_and_id(options)
+    tag_text = "<%= select \"#{@object_name}\", \"#{@method_name}\", [[\"True\", true], [\"False\", false]], { :selected => @#{@object_name}.#{@method_name} } %>"
+  end
+  
+end
+
+class AjaxScaffoldGenerator < ScaffoldGenerator
+
+  alias_method :base_controller_file_path, :controller_file_path
+  
+  def controller_file_path
+    "/" + base_controller_file_path
+  end
+
+  def manifest
+  
+    record do |m|
+      
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
+      m.class_collisions class_path, class_name, "#{singular_name}Test"
+
+      # Model, controller, helper, views, and test directories.
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/helpers', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('app/views/layouts', controller_class_path)
+      m.directory File.join('public/images')
+      m.directory File.join('test/functional', controller_class_path)
+
+      # Model class, unit test, and fixtures.
+      m.template 'model.rb',      File.join('app/models', "#{singular_name}.rb")
+      m.template 'unit_test.rb',  File.join('test/unit', "#{singular_name}_test.rb")
+      m.template 'fixtures.yml',  File.join('test/fixtures', "#{table_name}.yml")
+      
+      # Scaffolded forms.
+      m.complex_template 'form.rhtml',
+        File.join('app/views',
+                  controller_class_path,
+                  controller_file_name,
+                  '_form.rhtml'),
+        :insert => 'form_scaffolding.rhtml',
+        :sandbox => lambda { create_sandbox },
+        :begin_mark => 'form',
+        :end_mark => 'eoform',
+        :mark_id => singular_name
+
+      # Scaffolded partials.
+      m.template "partial_item.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "_#{singular_name}.rhtml")
+
+      scaffold_partials.each do |name|
+        m.template "partial_#{name}.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "_#{name}.rhtml")
+      end
+
+      # Scaffolded views.
+      scaffold_views.each do |action|
+        m.template "view_#{action}.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "#{action}.rhtml"),
+                    :assigns => { :action => action }
+      end
+      
+      # RJS templates
+      scaffold_rjs_templates.each do |template|
+        m.template "rjs_#{template}.rjs",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "#{template}.rjs")
+      end
+      
+      # Libraries
+      scaffold_lib.each do |filename|
+        m.template "lib_#{filename}.rb",
+                    File.join('lib',
+                              "#{filename}.rb")
+      end
+
+      # Controller class, functional test, helper, and views.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            controller_class_path,
+                            "#{controller_file_name}_controller_test.rb")
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            controller_class_path,
+                            "#{controller_file_name}_helper.rb")
+
+      # Layout and stylesheet.
+      m.template 'layout.rhtml',
+                  File.join('app/views/layouts', 
+                            controller_class_path, 
+                            "#{controller_file_name}.rhtml")
+      
+      m.template 'ajax_scaffold.css',   "public/stylesheets/ajax_scaffold.css"
+      
+      scaffold_javascripts.each do |javascript|
+        m.template javascript, "public/javascripts/#{javascript}"
+      end
+      
+      scaffold_images.each do |image|
+        m.template image, "public/images/#{image}"
+      end
+
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} ajax_scaffold ModelName [ControllerName]"
+    end
+
+    def scaffold_views
+      %w( list component )
+    end
+    
+    def scaffold_rjs_templates
+      %w( create destroy edit new update cancel )
+    end
+    
+    def scaffold_partials
+      %w( form_messages messages column_headings new_edit pagination_links )
+    end
+    
+    def scaffold_lib
+      %w( ajax_scaffold )
+    end
+
+    def scaffold_images
+      %w( indicator.gif indicator-small.gif add.gif error.gif warning.gif information.gif arrow_down.gif arrow_up.gif )
+    end
+    
+    def scaffold_javascripts
+      %w( ajax_scaffold.js rico_corner.js )
+    end
+    
+    def create_sandbox
+      sandbox = AjaxScaffoldingSandbox.new
+      sandbox.singular_name = singular_name
+      begin
+        sandbox.model_instance = model_instance
+        sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
+      rescue ActiveRecord::StatementInvalid => e
+        logger.error "Before updating scaffolding from new DB schema, try creating a table for your model (#{class_name})"
+        raise SystemExit
+      end
+      sandbox.suffix = suffix
+      sandbox
+    end
+
+end