scaffolding_extensions 1.0.0

data/lib/scaffolding_extensions/overridable.rb

@@ -0,0 +1,67 @@
+module ScaffoldingExtensions
+  module Overridable
+    private
+      # If a method exists matches scaffold_#{action}_#{m}, return a proc that calls it.
+      # If not and the instance variable @scaffold_#{action}_#{m} is defined, return a
+      # proc that gives that value.  Otherwise, return nil.
+      def scaffold_method_iv_override(m, action)
+        return nil unless action
+        meth = "scaffold_#{action}_#{m}"
+        if respond_to?(meth)
+          Proc.new{send(meth)}
+        elsif instance_variable_defined?(meth = "@#{meth}")
+          Proc.new{instance_variable_get(meth)}
+        end 
+      end 
+      
+      # If a method exists matches scaffold_#{action}_#{m}, return a proc that calls it with
+      # the other provided arguments, otherwise return nil.
+      def scaffold_method_override(m, action, *args)
+        return nil unless action
+        meth = "scaffold_#{action}_#{m}"
+        Proc.new{send(meth, *args)} if respond_to?(meth)
+      end
+  end
+
+  module MetaOverridable
+    private
+      def scaffold_override_alias_method(meth)
+        pub_meth = "scaffold_#{meth}".to_sym
+        priv_meth = "_#{pub_meth}".to_sym
+        @scaffold_aliased_methods ||= Set.new
+        return false if @scaffold_aliased_methods.include?(pub_meth)
+        alias_method(priv_meth, pub_meth)
+        private(priv_meth)
+        @scaffold_aliased_methods.add(pub_meth)
+        [pub_meth, priv_meth]
+      end
+
+      def scaffold_override_iv_methods(*meths)
+        meths.each do |meth|
+          pub_meth, priv_meth = scaffold_override_alias_method(meth)
+          return unless pub_meth && priv_meth
+          define_method(pub_meth) do |arg|
+            if m = scaffold_method_iv_override(meth, arg)
+              m.call
+            else
+              send(priv_meth, arg)
+            end
+          end
+        end
+      end
+
+      def scaffold_override_methods(*meths)
+        meths.each do |meth|
+          pub_meth, priv_meth = scaffold_override_alias_method(meth)
+          return unless pub_meth && priv_meth
+          define_method(pub_meth) do |*args|
+            if m = scaffold_method_override(meth, *args)
+              m.call
+            else
+              send(priv_meth, *args)
+            end
+          end
+        end
+      end
+  end
+end

data/lib/scaffolding_extensions/prototype_helper.rb

@@ -0,0 +1,59 @@
+module ScaffoldingExtensions
+  # Helper methods that require the Prototype Javascript library to work
+  module PrototypeHelper
+    JS_CHAR_FILTER = {'<'=>'\u003C', '>'=>'\u003E', '"'=>'\\"', "\n"=>'\n'}
+    
+    private
+      # Javascript for adding an element to the top of the list of associated records,
+      # and setting the autocomplete text box value to blank (if using autocompleting),
+      # or removing the item from the select box and showing the blank record instead
+      # (if not using autocompleting).
+      def scaffold_add_habtm_element
+        content = "new Insertion.Top('#{@records_list}', \"#{scaffold_javascript_character_filter(scaffold_habtm_association_line_item(@klass, @association, @record, @associated_record))}\");\n"
+        if @auto_complete
+          content << "$('#{@element_id}').value = '';\n"
+        else
+          content << "Element.remove('#{@element_id}_#{@associated_record.scaffold_id}');\n"
+          content << "$('#{@element_id}').selectedIndex = 0;\n"
+        end
+        content
+      end
+      
+      # A form tag with an onsubmit attribute that submits the form to the given url via Ajax
+      def scaffold_form_remote_tag(url, options)
+        u = scaffold_url(url, options)
+        "<form method='post' action='#{u}' onsubmit=\"new Ajax.Request('#{u}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\">\n#{scaffold_token_tag}\n"
+      end
+      
+      # Javascript that takes the given id as the text box to autocomplete for, 
+      # submitting the autocomplete request to scaffold_auto_complete_for_#{model_name}
+      # (with the association if one is given), using the get method, and displaying values
+      # in #{id}_scaffold_auto_complete.
+      def scaffold_javascript_autocompleter(id, model_name, association)
+        "\n<div class='auto_complete' id='#{id}_scaffold_auto_complete'></div>\n" <<
+        scaffold_javascript_tag("var #{id}_auto_completer = new Ajax.Autocompleter('#{id}', '#{"#{id}_scaffold_auto_complete"}', '#{scaffold_url("scaffold_auto_complete_for_#{model_name}")}', {paramName:'id', method:'get'#{", parameters:'association=#{association}'" if association}})")
+      end
+      
+      # Filters some html entities and replaces them with their javascript equivalents
+      # suitable for use inside a javascript quoted string.
+      def scaffold_javascript_character_filter(string)
+        string.gsub(/[<>"\n]/){|x| JS_CHAR_FILTER[x]}
+      end
+      
+      # Div with link inside that requests the associations html for the @scaffold_object
+      # via Ajax and replaces the link with the html returned by the request
+      def scaffold_load_associations_with_ajax_link
+        soid = @scaffold_object.scaffold_id
+        divid = "scaffold_ajax_content_#{soid}"
+        "<div id='#{divid}'><a href='#{scaffold_url("edit#{@scaffold_suffix}", :id=>soid, :associations=>:show)}' onclick=\"new Ajax.Updater('#{divid}', '#{scaffold_url("associations#{@scaffold_suffix}", :id=>soid)}', {method:'get', asynchronous:true, evalScripts:true}); return false;\">Modify Associations</a></div>"
+      end
+      
+      # Javascript that removes @remove_element_id from the page and inserts
+      # an option into the appropriate select box (unless @auto_complete).
+      def scaffold_remove_existing_habtm_element
+        content = "Element.remove('#{@remove_element_id}');\n"
+        content << "new Insertion.Bottom('#{@select_id}', \"\\u003Coption value='#{@select_value}' id='#{@select_id}_#{@select_value}'\\u003E#{@select_text}\\u003C/option\\u003E\");\n" unless @auto_complete
+        content
+      end
+  end
+end

data/scaffolds/edit.rhtml

@@ -0,0 +1,12 @@
+<% @scaffold_title = "Editing #{@scaffold_options[:singular_lc_human_name]}" %>
+
+<%= scaffold_model_form('update', @scaffold_class.scaffold_fields(:edit)) %>
+
+<% if @scaffold_class.scaffold_load_associations_with_ajax && !@scaffold_show_associations %>
+  <%= scaffold_load_associations_with_ajax_link %>
+<% else %>
+  <%= scaffold_habtm_ajax_associations %>
+  <%= scaffold_association_links %>
+<% end %>
+
+<%= scaffold_manage_link %>

data/scaffolds/habtm.rhtml

@@ -0,0 +1,24 @@
+<% @scaffold_title = "Update #{sn = h(@scaffold_object.scaffold_name)}'s #{mpn = (so = @scaffold_options )[:aplch_name]}" %>
+
+<%= scaffold_form(scaffold_url("update#{@scaffold_suffix}", :id=>(soid=@scaffold_object.scaffold_id))) %>
+
+<% if @scaffold_class.scaffold_association_use_auto_complete(assoc = so[:association]) %>
+  <h4>Add this <%= so[:aslhc_name] %></h4>
+  <%= scaffold_text_field_tag_with_auto_complete('add', so[:singular_name], assoc) %>
+<% elsif @items_to_add.length > 0 %>
+  <h4>Add these <%= mpn %></h4>
+  <%= scaffold_select_tag('add', @items_to_add, true) %>
+<% end %>
+
+<% if @items_to_remove.length > 0 %> 
+  <h4>Remove these <%= mpn %></h4>
+  <%= scaffold_select_tag('remove', @items_to_remove, true) %>
+<% end %>
+
+<br /><br />
+<input type='submit' value="Update <%= sn %>'s <%= mpn %>" />
+</form>
+
+<% if '' != (edit_link = scaffold_check_link("Edit #{sn}", true, "edit_#{@scaffold_options[:singular_name]}", :id=>soid)) %>
+  <h2><%= edit_link %></h2>
+<% end %>

data/scaffolds/index.rhtml

@@ -0,0 +1,6 @@
+<% @scaffold_title = 'Manage Models' %>
+<ul>
+<% @links.each do |link, human_name| -%>
+  <li><a href="<%= scaffold_url(link) %>"><%= human_name %></a></li>
+<% end %>
+</ul>

data/scaffolds/layout.rhtml

@@ -0,0 +1,82 @@
+<html>
+<head>
+  <title>Scaffolding Extensions<%= " - #{@scaffold_title}" if @scaffold_title %></title>
+  <style type="text/css">
+    body { background-color: #fff; color: #333; }
+
+    body, p, ol, ul, td {
+      font-family: verdana, arial, helvetica, sans-serif;
+      font-size:   13px;
+      line-height: 18px;
+    }
+    
+    h4 { font-size: 16px; }
+
+    pre {
+      background-color: #eee;
+      padding: 10px;
+      font-size: 11px;
+    }
+
+    a { color: #000; }
+    a:visited { color: #666; }
+    a:hover { color: #fff; background-color:#000; }
+    
+    div.habtm_ajax_remove_associations form { display: inline; }
+    
+    div.auto_complete {
+      width: 350px;
+      background: #fff;
+    }
+    div.auto_complete ul {
+      border:1px solid #888;
+      margin:0;
+      padding:0;
+      width:100%;
+      list-style-type:none;
+    }
+    div.auto_complete ul li {
+      margin:0;
+      padding:3px;
+    }
+    div.auto_complete ul li.selected { 
+      background-color: #ffb; 
+    }
+    div.auto_complete ul strong.highlight { 
+      color: #800; 
+      margin:0;
+      padding:0;
+    }
+    
+    ul.se_autocomplete {
+        position: absolute;
+        overflow: hidden;
+        background-color: #fff;
+        border: 1px solid #aaa;
+        margin: 0px;
+        padding: 0;
+        list-style: none;
+        font: normal .75em/.75em Verdana, Arial, sans-serif;
+        color: #333;
+    }
+    ul.se_autocomplete li {
+      display: block;
+      padding: .3em .5em .3em .3em;
+      overflow: hidden;
+      width: 100%;
+    }
+
+    ul.se_autocomplete li.active {
+      background-color: #3875d7;
+      color: #fff;
+    }
+  </style>
+</head>
+<body>
+<%= "<h1>#{@scaffold_title}</h1>" if @scaffold_title %>
+<%= "<h4>#{scaffold_flash[:notice]}</h4>" if scaffold_flash[:notice] %>
+
+<%= @content %>
+
+</body>
+</html>

data/scaffolds/list.rhtml

@@ -0,0 +1,13 @@
+<% @scaffold_title = "Choose #{hn = @scaffold_options[:singular_lc_human_name]} to #{(haction = (action = @scaffold_action).to_s.humanize).downcase}" %>
+
+<%= scaffold_form(scaffold_url("#{action}#{@scaffold_suffix}"), :method=>(action == :destroy ? :post : :get)) %>
+<% if @scaffold_class.scaffold_use_auto_complete %>
+  <%= scaffold_text_field_tag_with_auto_complete('id', @scaffold_options[:singular_name]) %>
+<% else %>
+  <%= scaffold_select_tag('id', @scaffold_objects) %>
+<% end %>
+<br /><br />
+<input type="submit" value="<%= haction %> <%= hn %>" />
+</form>
+
+<%= scaffold_manage_link %>

data/scaffolds/listtable.rhtml

@@ -0,0 +1,46 @@
+<% @scaffold_title = "Listing #{@scaffold_options[:plural_lc_human_name]}" %>
+
+<table id="scaffolded" class="<%= @scaffold_class.scaffold_table_class(:list) %>">
+  <thead><tr>
+  <% @scaffold_class.scaffold_fields(@scaffold_listtable_type).each do |column| -%>
+    <th><%=h @scaffold_class.scaffold_column_name(column) %></th>
+  <% end %>
+  <%= "<th>#{s = 'Show'}</th>" if show = scaffolded_method?(ss = "show#{@scaffold_suffix}") %>
+  <%= "<th>#{e = 'Edit'}</th>" if edit = scaffolded_method?(es = "edit#{@scaffold_suffix}") %>
+  <%= "<th>#{d = 'Delete'}</th>" if delete = scaffolded_method?(ds = "destroy#{@scaffold_suffix}") %>
+  </tr></thead><tbody>
+<% @scaffold_objects.each do |entry| eid = entry.scaffold_id  %>
+  <tr>
+  <% @scaffold_class.scaffold_fields(@scaffold_listtable_type).each do |column| %>
+    <td><%=h entry.scaffold_value(column).to_s %></td>
+  <% end %>
+  <%= "<td>#{scaffold_button_to(s, scaffold_url(ss, :id=>eid), :method=>:get)}</td>" if show %>
+  <%= "<td>#{scaffold_button_to(e, scaffold_url(es, :id=>eid), :method=>:get)}</td>" if edit %>
+  <%= "<td>#{scaffold_button_to(d, scaffold_url(ds, :id=>eid))}</td>" if delete %>
+  </tr>
+<% end %>
+</tbody></table>
+
+<% if @scaffold_listtable_type == :browse %>
+  <%= "<a href='#{scaffold_url("browse#{@scaffold_suffix}", :page=>(@page-1))}'>Previous Page</a>" if @page > 1 %>
+  <%= "<a href='#{scaffold_url("browse#{@scaffold_suffix}", :page=>(@page+1))}'>Next Page</a>" if @next_page %>
+<% end %>
+
+<% if @scaffold_listtable_type == :search && @scaffold_search_results_form_params && (@scaffold_search_results_form_params[:page] > 1 || @scaffold_search_results_form_params[:next_page]) %>
+  <%= scaffold_form(scaffold_url("results#{@scaffold_suffix}")) %>
+  <%= scaffold_field_tag(:hidden, :value=>@scaffold_search_results_form_params[:page], :id=>'page') %>
+  <% @scaffold_search_results_form_params[:model].each do |key, value| -%>
+    <%= scaffold_field_tag(:hidden, :value=>value, :id=>"#{@scaffold_singular_name}_#{key}", :name=>"#{@scaffold_singular_name}[#{key}]") %>
+  <% end %>
+  <% @scaffold_search_results_form_params[:notnull].each do |field| -%>
+    <%= scaffold_field_tag(:hidden, :value=>field, :name=>"notnull#{scaffold_param_list_suffix}") %>
+  <% end %>
+  <% @scaffold_search_results_form_params[:null].each do |field| -%>
+    <%= scaffold_field_tag(:hidden, :value=>field, :name=>"null#{scaffold_param_list_suffix}") %>
+  <% end %>
+  <%= '<input type="submit" name="page_previous" value="Previous Page" >' if @scaffold_search_results_form_params[:page] > 1 %>
+  <%= '<input type="submit" name="page_next" value="Next Page" >' if @scaffold_search_results_form_params[:next_page] %>
+  </form>
+<% end %>
+
+<%= scaffold_manage_link %>

data/scaffolds/manage.rhtml

@@ -0,0 +1,15 @@
+<% @scaffold_title = "Manage #{plural_name = @scaffold_options[:plural_lc_human_name]}" %>
+<ul>
+<% [["Browse #{plural_name}", :browse],
+["Create #{singular_name = @scaffold_options[:singular_lc_human_name]}", :new],
+["Delete #{singular_name}", :delete],
+["Edit #{singular_name}", :edit],
+["Merge #{plural_name}", :merge],
+["Search #{plural_name}", :search],
+["Show #{singular_name}", :show]].each do |text, action| -%>
+  <% link = scaffold_check_link(text, true, "#{action}#{@scaffold_suffix}") -%>
+  <%= "<li>#{link}</li>" unless link == '' %>
+<% end %>
+</ul>
+
+<%= scaffold_check_link('Manage Models', true, 'index') %>

data/scaffolds/merge.rhtml

@@ -0,0 +1,23 @@
+<% @scaffold_title = "Merge two #{@scaffold_options[:plural_lc_human_name]}" %>
+
+<%= scaffold_form(scaffold_url("merge_update#{@scaffold_suffix}")) %>
+<p>Merge:
+<% if @scaffold_class.scaffold_use_auto_complete %>
+  <%= scaffold_text_field_tag_with_auto_complete('from', @scaffold_options[:singular_name]) %>
+<% else %>
+  <%= scaffold_select_tag('from', @scaffold_objects) %>
+<% end %>
+</p>
+
+<p>into: 
+<% if @scaffold_class.scaffold_use_auto_complete %>
+  <%= scaffold_text_field_tag_with_auto_complete('to', @scaffold_options[:singular_name]) %>
+<% else %>
+  <%= scaffold_select_tag('to', @scaffold_objects) %>
+<% end %>
+</p>
+
+<input type="submit" value="Merge <%= @scaffold_options[:plural_lc_human_name] %>" />
+</form>
+
+<%= scaffold_manage_link %>

data/scaffolds/new.rhtml

@@ -0,0 +1,5 @@
+<% @scaffold_title = "Create new #{@scaffold_options[:singular_lc_human_name]}" %>
+
+<%= scaffold_model_form('create', @scaffold_class.scaffold_fields(:new)) %>
+
+<%= scaffold_manage_link %>

data/scaffolds/search.rhtml

@@ -0,0 +1,11 @@
+<% @scaffold_title = "Search #{@scaffold_options[:plural_lc_human_name]}" %>
+
+<%= scaffold_model_form('results', @scaffold_class.scaffold_fields(:search)) do |form|
+  form << "<table class='#{@scaffold_class.scaffold_table_class(:form)}'><tbody>"
+  form << "<tr><td><label for='null'>Null Fields</label>:</td><td><select name='null#{scaffold_param_list_suffix}' id='null' multiple='multiple'>#{@scaffold_class.scaffold_search_null_options.collect{|name, i| "<option value='#{i}'>#{name}</option>"}.join("\n")}</select></td></tr>\n"
+  form << "<tr><td><label for='notnull'>Not Null Fields</label>:</td><td><select name='notnull#{scaffold_param_list_suffix}' id='notnull' multiple='multiple'>#{@scaffold_class.scaffold_search_null_options.collect{|name, i| "<option value='#{i}'>#{name}</option>"}.join("\n")}</select></td></tr>\n"
+  form << '</tbody></table>'
+  @scaffold_submit_value = @scaffold_title
+end %>
+
+<%= scaffold_manage_link %>

data/scaffolds/show.rhtml

@@ -0,0 +1,19 @@
+<% @scaffold_title = "Showing #{@scaffold_options[:singular_lc_human_name]}" %>
+<% if '' != (edit_link = scaffold_check_link('Edit', true, "edit_#{@scaffold_options[:singular_name]}", :id=>@scaffold_object.scaffold_id)) %>
+  <h2><%= edit_link %></h2>
+<% end %>
+
+<table id="scaffolded" class="<%= @scaffold_class.scaffold_table_class(:show) %>">
+<thead><tr><th>Attribute</th><th>Value</th></tr></thead>
+<tbody>
+<% @scaffold_class.scaffold_fields(:show).each do |column| %>
+  <tr>
+    <td><%= @scaffold_class.scaffold_column_name(column) %></td>
+    <td><%=h @scaffold_object.scaffold_value(column).to_s %></td>
+  </tr>
+<% end %>
+</tbody></table>
+
+<%= scaffold_association_links %>
+
+<%= scaffold_manage_link %>

data/test/scaffolding_extensions_test.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+
+# Simple test framework to check that public facing pages without an id respond successfully
+#
+# This is only a basic check, it does not check that all form submittals work, as that
+# requires that you choose an object to test.  If you want to be sure that all parts of
+# Scaffolding Extensions work with your applications, you should extend the tests here to do so.
+class Test::Unit::TestCase
+  # Test the scaffold_all_models method using the same arguments as the method
+  def self.test_scaffold_all_models(options = {})
+    ActionController::Base.send(:scaffold_all_models_parse_options, options).each{|model, options| test_scaffold(model, options)}
+  end
+  
+  # Test the scaffold method using the same arguments as the method
+  def self.test_scaffold(model, options = {})
+    define_method("test_scaffold_#{model.scaffold_name}"){scaffold_test(model, options)}
+  end
+
+  # Test that getting all display actions for the scaffold returns success
+  def scaffold_test(model, options = {})
+    klass = @controller.class
+    methods = options[:only] ? klass.scaffold_normalize_options(options[:only]) : ScaffoldingExtensions::DEFAULT_METHODS
+    methods -= klass.scaffold_normalize_options(options[:except]) if options[:except]
+    methods.each do |action|
+      assert_nothing_raised("Error requesting scaffolded action #{action} for model #{model.name}") do
+        get "#{action}_#{model.scaffold_name}"
+      end
+      assert_response :success, "Response for scaffolded action #{action} for model #{model.name} not :success"
+      # # The habtm scaffolds can't be tested without an id.  If the fixture for the
+      # # main scaffolded class is loaded and it has id = 1, you may want to enable
+      # # the following code for testing those scaffolds.
+      # model.scaffold_habtm_associations.each do |association|
+      #   scaffold_habtm_test(model, association, 1)
+      # end
+    end
+  end
+  
+  # Test the habtm scaffold for singular class, many class, and the specific id
+  def scaffold_habtm_test(model, association, id)
+    action = "edit_#{model.scaffold_name}_#{association}", {:id=>id}
+    assert_nothing_raised("Error requesting habtm scaffold #{action}"){get action}
+    assert_response :success, "Response for habtm scaffold #{action} not :success"
+  end
+end