dry_crud 1.1.0 → 1.2.0

data/README.rdoc

@@ -20,7 +20,7 @@ To integrate DRY CRUD into your code, only a few additions are required:
 * To use standard formatting, tables and forms throughout your application, add <tt>helper :standard</tt> to your +ApplicationController+ and benefit everywhere from these little helper methods. 
 * Add a <tt>:label</tt> method to your models for a human-friendly representation.
 
-Version 1.0.0 is built for Rails 3. If you need a version for Rails 2.3, please get version 0.6.0 of the gem or go to the rails-2.3 branch on Github.
+Version 1.2.0 is built for Rails 3. If you need a version for Rails 2.3, please get version 0.6.0 of the gem or go to the rails-2.3 branch on Github.
 
 == Overview
 
@@ -57,7 +57,7 @@ Say you want to manage a +Person+ model. Create the following controller and add
     end
   end
 
-That's it. You have an overview of all people, detail pages and forms to edit and create persons. Oh, and of course, you may delete persons as well. By default, all attributes are displayed and formatted according to their column type wherever they appear. This holds for the input fields as well.
+That's it. You have a sortable overview of all people, detail pages and forms to edit and create persons. Oh, and of course, you may delete persons as well. By default, all attributes are displayed and formatted according to their column type wherever they appear. This holds for the input fields as well.
 
 
 ==== Customize single views
@@ -76,7 +76,7 @@ Next, let's adapt a part of the general behavior used in all CRUD controllers. A
 In <tt>app/controllers/crud_controller.rb</tt>, change the index action to
 
   def index
-    @entries = model_class.paginate({:page => params[:page]}.merge(find_all_options)) 
+    @entries = list_entries.paginate(:page => params[:page])
     respond_with @entries   
   end
 
@@ -84,6 +84,9 @@ In <tt>app/views/crud/index.html.erb</tt>, add the following line for the pagina
    <%= will_paginate @entries %>
 
 And we are done again. All our controllers inheriting from +CrudController+, including above +PeopleController+, now have paginated index views. Because our customization for the people table is in the separate <tt> _list</tt> partial, no further modifications are required. 
+If the current page should be remembered while viewing or editing an entry, just add :page to the remembered_params in <tt>CrudController::Memory</tt>:
+  
+  controller.remember_params = [:q, :sort, :sort_dir, :page]
 
 
 ==== Special formatting for selected attributes
@@ -136,16 +139,16 @@ DRY CRUD also provides two builder classes for update/create forms and tables fo
 
 This is the code to define a table with some attribute columns for a list of same-type entries. Columns get a header corresponding to the attribute name:
   <%= table(@people) do |t|
-        t.attrs :lastname, :firstname
+        t.sortable_attrs :lastname, :firstname
       end %>
 
 If entries is empty, a basic 'No entries found' message is rendered instead of the table.
 
 To render custom columns, use the :col method:
   <%= table(@people) do |t|
-        t.attrs :lastname, :firstname
+        t.sortable_attrs :lastname, :firstname
         t.col('', :class => 'center') {|entry| image_tag(entry.picture) }
-        t.attrs :street
+        t.attr :street
         t.col('Map') {|entry| link_to(entry.city, "http://maps.google.com/?q=#{entry.city}" }
       end %>
 
@@ -177,7 +180,7 @@ All generated files are supposed to provide a reasonable foundation for the CRUD
 
 === Controller:
 
-{controller/crud_controller.rb}[http://codez.ch/dry_crud/?q=CrudController]:: Abstract controller providing basic CRUD actions. This implementation mainly follows the one of the Rails scaffolding controller and responses to HTML and XML requests. Some enhancements were made to ease extendability. Several protected helper methods are there to be (optionally) overriden by subclasses. With the help of additional callbacks, it is possible to hook into the action procedures without overriding the entire method.
+{controller/crud_controller.rb}[http://codez.ch/dry_crud/?q=CrudController]:: Abstract controller providing basic CRUD actions. This implementation mainly follows the one of the Rails scaffolding controller and responses to HTML and XML requests. Some enhancements were made to ease extendability. Several protected helper methods are there to be (optionally) overriden by subclasses. There are two modules included that provide search and sort functionality for the table displayed in the index action. With the help of additional callbacks, it is possible to hook into the action procedures without overriding the entire method.
 
 {controller/render_inheritable.rb}[http://codez.ch/dry_crud/?q=RenderInheritable]:: A controller enhancement that allows one to render inheritable views and partials. If no view file is found for the current controller, the corresponding file is looked up in its superclass hierarchy. Thus, only views or partials that look differently have to be overwritten.
 

data/Rakefile

@@ -112,7 +112,7 @@ desc "Outputs the commands required for a release. Does not perform any other ac
 task :release do
   version = File.read('VERSION').strip
   puts "Issue the following commands to perform a release:"
-  puts " $ git tag version-#{version}"
+  puts " $ git tag version-#{version} -m \"Version tag for dry_crud-#{version}.gem\""
   puts " $ git push --tags"
   puts " $ rake repackage"
   puts " $ gem push pkg/dry_crud-#{version}.gem"

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/generators/dry_crud/templates/app/controllers/crud_controller.rb

@@ -13,15 +13,12 @@ class CrudController < ApplicationController
   before_filter :set_entry,   :only => [:show, :edit, :update, :destroy]
   
   helper :standard
-  helper_method :model_class, :models_label, :full_entry_label, :search_support?
+  helper_method :model_class, :models_label, :full_entry_label
   
   delegate :model_class, :model_identifier, :models_label, :to => 'self.class'  
   
   hide_action :model_class, :models_label, :model_identifier, :run_callbacks, :inheritable_root_controller
   
-  # Define an array of searchable columns in your subclassing controllers.
-  class_attribute :search_columns
-  self.search_columns = []
   
   # Callbacks
   extend ActiveModel::Callbacks
@@ -51,7 +48,7 @@ class CrudController < ApplicationController
   #   GET /entries
   #   GET /entries.xml
   def index
-    @entries = model_class.all find_all_options
+    @entries = list_entries
     respond_with @entries
   end
   
@@ -141,7 +138,7 @@ class CrudController < ApplicationController
   end
   
   # Creates a new model entry from the given params.
-  def build_entry        
+  def build_entry
     @entry = model_class.new(params[model_identifier])
   end
   
@@ -155,21 +152,9 @@ class CrudController < ApplicationController
     "#{models_label.singularize} '#{@entry.label}'"
   end
   
-  # Find options used in the index action.
-  def find_all_options
-    { :conditions => search_condition }
-  end
-  
-  def search_condition
-    if search_support? && params[:q].present?
-      clause = search_columns.collect {|f| "#{f} LIKE ?" }.join(" OR ")
-      param = "%#{params[:q]}%"
-      ["(#{clause})"] + [param] * search_columns.size
-    end
-  end
-  
-  def search_support?
-    search_columns.present?
+  # The entries to be displayed in the current index page.
+  def list_entries
+    model_class.scoped
   end
   
   # Redirects to the show action of a single entry.
@@ -179,7 +164,7 @@ class CrudController < ApplicationController
   
   # Redirects to the main action of this controller.
   def redirect_to_index
-    redirect_to polymorphic_path(model_class)
+    redirect_to polymorphic_path(model_class, :returning => true)
   end
    
   # Helper method to run before_render callbacks and render the action.
@@ -218,4 +203,134 @@ class CrudController < ApplicationController
     end   
   end
   
+  # The search functionality for the index table.
+  # Extracted into an own module for convenience.
+  module Search
+    # Adds a :search_columns class attribute.
+    def self.included(controller)    
+      # Define an array of searchable columns in your subclassing controllers.
+      controller.class_attribute :search_columns
+      controller.search_columns = []
+      
+      controller.helper_method :search_support?
+      
+      controller.alias_method_chain :list_entries, :search
+    end
+    
+    protected
+    
+    # Enhance the list entries with an optional search criteria
+    def list_entries_with_search
+      list_entries_without_search.where(search_condition)
+    end
+    
+    # Compose the search condition with a basic SQL OR query.
+    def search_condition
+      if search_support? && params[:q].present?
+        clause = search_columns.collect {|f| "#{model_class.table_name}.#{f} LIKE ?" }.
+                                join(" OR ")
+        param = "%#{params[:q]}%"
+         ["(#{clause})"] + [param] * search_columns.size
+      end
+    end
+  
+    # Returns true if this controller has searchable columns.
+    def search_support?
+      search_columns.present?
+    end
+       
+  end
+  
+  include Search
+  
+  # Sort functionality for the index table.
+  # Extracted into an own module for convenience.
+  module Sorting
+    # Adds a :sort_mappings class attribute.
+  	def self.included(controller)
+  	  # Define a map of (virtual) attributes to SQL order expressions.
+  	  # May be used for sorting table columns that do not appear directly
+  	  # in the database table. E.g., map :city_id => 'cities.name' to
+  	  # sort the displayed city names.
+  	  controller.class_attribute :sort_mappings
+  	  controller.sort_mappings = {}
+  	  
+  	  controller.helper_method :sortable?
+  	
+  	  controller.alias_method_chain :list_entries, :sort
+  	end
+  	
+  	protected
+  	
+  	# Enhance the list entries with an optional sort order.
+  	def list_entries_with_sort
+  	  if params[:sort].present? && sortable?(params[:sort])
+  	    list_entries_without_sort.except(:order).order(sort_expression)
+  	  else
+  	  	list_entries_without_sort
+  	  end
+  	end
+  	
+  	# Return the sort expression to be used in the list query.
+  	def sort_expression
+  	  col = sort_mappings[params[:sort].to_sym] || 
+  	        "#{model_class.table_name}.#{params[:sort]}"
+  	  "#{col} #{sort_dir}"
+  	end
+  	
+  	# The sort direction, either 'asc' or 'desc'.
+  	def sort_dir
+      params[:sort_dir] == 'desc' ? 'desc' : 'asc'
+    end
+  	
+  	# Returns true if the passed attribute is sortable.
+  	def sortable?(attr)
+  	  model_class.column_names.include?(attr.to_s) || 
+  	  sort_mappings.include?(attr.to_sym)
+  	end
+  end
+  
+  include Sorting
+  
+  # Remembers certain params of the index action in order to return
+  # to the same list after an entry was viewed or edited.
+  # If the index is called with a param :returning, the remembered params
+  # will be re-used.
+  # Extracted into an own module for convenience.
+  module Memory
+  
+    # Adds the :remember_paramas class attribute and a before filter to the index action.
+    def self.included(controller)  	  
+      # Define a list of param keys that should be remembered for the list action.
+  	  controller.class_attribute :remember_params
+  	  controller.remember_params = [:q, :sort, :sort_dir]
+  	  
+      controller.before_filter :handle_remember_params, :only => [:index]
+    end
+    
+    private
+    
+    # Store and restore the corresponding params.
+    def handle_remember_params
+      remembered = remembered_params
+      if params[:returning]
+        # restore params
+        remember_params.each {|p| params[p] ||= remembered[p] }
+      end
+      
+      # store current params
+      remember_params.each {|p| remembered[p] = params[p].presence }
+    end
+    
+    # Get the params stored in the session.
+    # Params are stored by request path to play nice when a controller
+    # is used in different routes.
+    def remembered_params
+    	session[:list_params] ||= {}
+    	session[:list_params][request.path] ||= {}
+    end
+  end
+  
+  include Memory
+  
 end

data/lib/generators/dry_crud/templates/app/helpers/crud_helper.rb

@@ -6,13 +6,15 @@ module CrudHelper
   # Create a table of the @entries variable with the default or 
   # the passed attributes in its columns.
   def crud_table(*attrs, &block)
-    if block_given?
-      table(@entries, *attrs, &block)
-    else
-      attributes = attrs.present? ? attrs : default_attrs
-      table(@entries, *attributes) do |t|
-        add_list_actions(t)
-      end
+    # only use default attrs if no attrs and no block are given
+    attributes = (block_given? || attrs.present?) ? attrs : default_attrs
+    table(@entries) do |t|
+	  t.sortable_attrs(*attributes)
+	  if block_given? 
+	    yield t
+	  else
+	    add_list_actions(t)
+	  end
     end
   end
   
@@ -41,5 +43,5 @@ module CrudHelper
     [:id, :position].each {|a| attrs.delete(a) }
     attrs
   end
-  
+    
 end

data/lib/generators/dry_crud/templates/app/helpers/standard_helper.rb

@@ -109,6 +109,7 @@ module StandardHelper
       end
       
       content << labeled(nil, form.submit("Save"))
+      content.html_safe
     end
   end
   
@@ -136,7 +137,7 @@ module StandardHelper
   end
   
   # Standard link action to the list page.
-  def link_action_index(url_options = {:action => 'index'})
+  def link_action_index(url_options = {:action => 'index', :returning => true})
     link_action 'List', url_options
   end
   
@@ -158,16 +159,16 @@ module StandardHelper
   # Formats an active record association
   def format_assoc(obj, assoc)
     if assoc_val = obj.send(assoc.name)
-      link_to_unless(no_assoc_link?(assoc), assoc_val.label, assoc_val)
+      link_to_unless(no_assoc_link?(assoc, assoc_val), assoc_val.label, assoc_val)
     else
       '(none)'
     end
   end
   
   # Returns true if no link should be created when formatting the given association.
-  def no_assoc_link?(assoc)
+  def no_assoc_link?(assoc, val)
     (respond_to?(:no_assoc_links) && no_assoc_links.to_a.include?(assoc.name.to_sym)) || 
-    !respond_to?("#{assoc.klass.name.underscore}_path".to_sym)
+    !respond_to?("#{val.class.name.underscore}_path".to_sym)
   end
   
   # Formats an arbitrary attribute of the given object depending on its data type.

data/lib/generators/dry_crud/templates/app/helpers/standard_table_builder.rb

@@ -25,7 +25,7 @@ class StandardTableBuilder
   def self.table(entries, template)
     t = new(entries, template)
     yield t
-    t.to_html    
+    t.to_html
   end
 
   # Define a column for the table with the given header, the html_options used for
@@ -42,23 +42,23 @@ class StandardTableBuilder
     attrs.each do |a|
       attr(a)
     end
-  end  
+  end
   
   # Define a column for the given attribute and an optional header.
   # If no header is given, the attribute name is used. The cell will
   # contain the formatted attribute value for the current entry.
   def attr(a, header = nil)
-      header ||= captionize(a, entry_class)
-      col(header, :class => align_class(a)) { |e| format_attr(e, a) }
+    header ||= attr_header(a)
+    col(header, :class => align_class(a)) { |e| format_attr(e, a) }
   end
   
   # Renders the table as HTML.
   def to_html
     content_tag :table, :class => 'list' do
-        html_header + entries.collect { |e| html_row(e) }.join.html_safe
+      html_header + entries.collect { |e| html_row(e) }.join.html_safe
     end
   end
-    
+  
   # Returns css classes used for alignment of the cell data.
   # Based on the column type of the attribute.
   def align_class(attr)
@@ -71,17 +71,21 @@ class StandardTableBuilder
     end
   end
   
+  def attr_header(attr)
+    captionize(attr, entry_class)
+  end
+  
   private 
   
   def html_header
     content_tag :tr do
-      cols.collect { |c| c.html_header }.join
+      cols.collect { |c| c.html_header }.join.html_safe
     end
   end
 
   def html_row(entry)
     tr_alt do
-      cols.collect { |c| c.html_cell(entry) }.join
+      cols.collect { |c| c.html_cell(entry) }.join.html_safe
     end
   end
 
@@ -107,5 +111,62 @@ class StandardTableBuilder
     end
 
   end
+  
+  # Provides headers with sort links. Expects a method :sortable?(attr) 
+  # in the template/controller to tell if an attribute is sortable or not.
+  # Extracted into an own module for convenience.
+  module Sorting
+    # Create a header with sort links and a mark for the current sort direction.
+    def sort_header(attr, label = nil)
+      label ||= attr_header(attr)
+      template.link_to(label, sort_params(attr)) + current_mark(attr)
+    end
+    
+    # Same as :attrs, except that it renders a sort link in the header
+    # if an attr is sortable.
+    def sortable_attrs(*attrs)
+      attrs.each do |a|
+        template.sortable?(a) ? sortable_attr(a) : attr(a)
+      end
+    end
+    
+    # Renders a sort link header, otherwise similar to :attr.
+    def sortable_attr(a, header = nil)
+      attr(a, sort_header(a, header))
+    end
+    
+    private
+    
+    # Request params for the sort link.
+    def sort_params(attr)
+      params.merge({:sort => attr, :sort_dir => sort_dir(attr)})
+    end
+    
+    # The sort mark, if any, for the given attribute.
+    def current_mark(attr)
+      if current_sort?(attr) 
+        (sort_dir(attr) == 'asc' ? ' ↑' : ' ↓').html_safe
+      else
+        ''
+      end
+    end
+    
+    # Returns true if the given attribute is the current sort column.
+    def current_sort?(attr)
+      params[:sort] == attr.to_s
+    end
+    
+    # The sort direction to use in the sort link for the given attribute.
+    def sort_dir(attr)
+      current_sort?(attr) && params[:sort_dir] == 'asc' ? 'desc' : 'asc'
+    end
+    
+    # Delegate to template.
+    def params
+      template.params
+    end
+  end
+  
+  include Sorting
 
 end

data/lib/generators/dry_crud/templates/app/views/crud/_actions_edit.html.erb

@@ -0,0 +1,2 @@
+<%= link_action_show @entry %>
+<%= link_action_destroy @entry %>

data/lib/generators/dry_crud/templates/app/views/crud/_actions_index.html.erb

@@ -0,0 +1 @@
+<%= link_action_add %>

data/lib/generators/dry_crud/templates/app/views/crud/_actions_show.html.erb

@@ -0,0 +1,3 @@
+<%= link_action_index %>
+<%= link_action_edit(@entry) %>
+<%= link_action_destroy(@entry) %>

data/lib/generators/dry_crud/templates/app/views/crud/_search.html.erb

@@ -1,4 +1,6 @@
 <%= form_tag(polymorphic_path(model_class), {:method => :get}) do %>
+  <%= hidden_field_tag :sort, params[:sort] %>
+  <%= hidden_field_tag :sort_dir, params[:sort_dir] %>
   <%= text_field_tag :q, params[:q] %>
   <%= submit_tag 'Search' %>
 <% end %>

data/lib/generators/dry_crud/templates/app/views/crud/edit.html.erb

@@ -4,5 +4,4 @@
 
 <br/>
 
-<%= link_action_show @entry %>
-<%= link_action_destroy @entry %>
+<%= render :partial => 'actions_edit' %>

data/lib/generators/dry_crud/templates/app/views/crud/index.html.erb

@@ -6,11 +6,4 @@
 
 <br/>
 
-<%= link_action_add %>
-
-
-
-
-
-
-
+<%= render :partial => 'actions_index' %>

data/lib/generators/dry_crud/templates/app/views/crud/show.html.erb

@@ -4,6 +4,4 @@
 
 <br/>
 
-<%= link_action_index %>
-<%= link_action_edit(@entry) %>
-<%= link_action_destroy	(@entry) %>
+<%= render :partial => 'actions_show' %>

data/lib/generators/dry_crud/templates/public/stylesheets/crud.css

@@ -1,5 +1,5 @@
 body, div, p, td, th {
-	font-family: Verdana, Geneva, Arial, Helvetica, sans-serif;
+	font-family: Verdana, Geneva, Helvetica, Arial, sans-serif;
 	font-size: 11pt;
 }
 
@@ -7,18 +7,26 @@ td {
 	vertical-align: top;
 }
 
+table.list {}
+
+/* div rendered if no entries available for list */
+div.list {}
+
+table.list th a {
+     color: darkblue;
+}
+
 tr.even {
-	background-color: #DDD;
+	background-color: #F0F0F0;
 }
 
 tr.odd { 
-	background-color: #EEE;
+	background-color: #F8F8F8;
 }
 
-table.list {}
-
-/* div rendered if no entries available for list */
-div.list {}
+td p {
+    margin: 0;
+}
 
 .right_align {
 	text-align: right;

data/lib/generators/dry_crud/templates/test/crud_test_model.rb

@@ -3,19 +3,24 @@ class CrudTestModel < ActiveRecord::Base #:nodoc:
   validates :name, :presence => true
   validates :rating, :inclusion => { :in => 1..10 }
   
-  default_scope order('name')
+  #default_scope :order => 'name' 
   
   belongs_to :companion, :class_name => 'CrudTestModel'
   
   def label
     name
   end
+  
+  def chatty
+  	remarks.size
+  end
 end
 
 class CrudTestModelsController < CrudController #:nodoc:
   HANDLE_PREFIX = 'handle_'
   
   self.search_columns = [:name, :whatever, :remarks]
+  self.sort_mappings = {:chatty => 'length(remarks)'}
   
   before_create :possibly_redirect
   before_create :handle_name
@@ -32,6 +37,16 @@ class CrudTestModelsController < CrudController #:nodoc:
   # than just the test route for this controller
   layout nil
   
+  protected
+  
+  def list_entries
+    entries = super
+  	if params[:filter]
+  	  entries = entries.where(['rating < ?', 3]).order('children DESC')
+    end
+    entries
+  end
+  
   private
   
   # custom callback
@@ -126,15 +141,28 @@ module CrudTestHelper
   private
   
   def create(index, companion)
-    c = (index + 64).chr * 5
+    c = str(index)
     CrudTestModel.create!(:name => c, 
-                          :children => index, 
+                          :children => 10 - index, 
                           :companion => companion,
                           :rating => "#{index}.#{index}".to_f, 
                           :income => 10000000 * index + 0.1 * index, 
                           :birthdate => "#{1900 + 10 * index}-#{index}-#{index}", 
                           :human => index % 2 == 0,
-                          :remarks => "#{c} #{c} #{c}\n" * 3)
+                          :remarks => "#{c} #{str(index + 1)} #{str(index + 2)}\n" * (index % 3 + 1))
+  end
+  
+  def str(index)
+     (index + 64).chr * 5
+  end
+  
+  def with_test_routing
+    with_routing do |set|
+      set.draw { resources :crud_test_models }
+      # used to define a controller in these tests
+      set.default_url_options = {:controller => 'crud_test_models'}
+      yield
+    end
   end
   
 end

data/lib/generators/dry_crud/templates/test/functional/crud_controller_test_helper.rb

@@ -29,6 +29,24 @@ module CrudControllerTestHelper
     assert assigns(:entries).include?(test_entry)
   end
   
+  def test_index_sort_asc
+    col = model_class.column_names.first
+    get :index, :sort => col, :sort_dir => 'asc'
+    assert_response :success
+    assert_present assigns(:entries)
+    sorted = assigns(:entries).sort_by &(col.to_sym)
+    assert sorted, assigns(:entries)
+  end
+    
+  def test_index_sort_desc
+    col = model_class.column_names.first
+    get :index, :sort => col, :sort_dir => 'desc'
+    assert_response :success
+    assert_present assigns(:entries)
+    sorted = assigns(:entries).sort_by &(col.to_sym)
+    assert sorted.reverse, assigns(:entries)
+  end
+  
   def test_show
     get :show, :id => test_entry.id
     assert_response :success
@@ -156,7 +174,7 @@ module CrudControllerTestHelper
   protected 
   
   def assert_redirected_to_index
-    assert_redirected_to :action => 'index'
+    assert_redirected_to :action => 'index', :returning => true
   end
   
   def assert_test_attrs_equal

data/lib/generators/dry_crud/templates/test/functional/crud_test_models_controller_test.rb

@@ -26,7 +26,7 @@ class CrudTestModelsControllerTest < ActionController::TestCase
   def test_index
     super
     assert_equal 6, assigns(:entries).size
-    assert_equal assigns(:entries).sort_by {|a| a.name }, assigns(:entries)
+    assert_equal assigns(:entries).sort_by(&:name), assigns(:entries)
   end
   
   def test_index_search
@@ -34,6 +34,52 @@ class CrudTestModelsControllerTest < ActionController::TestCase
   	assert_equal 1, assigns(:entries).size
   end
   
+  def test_index_with_custom_options
+    get :index, :filter => true
+    assert_response :success
+    assert_template 'index'
+    assert_present assigns(:entries)
+    assert_equal 2, assigns(:entries).size
+    assert_equal assigns(:entries).sort_by(&:children).reverse, assigns(:entries)
+  end
+    
+  def test_index_search_with_custom_options
+    get :index, :q => 'DDD', :filter => true
+    assert_response :success
+    assert_template 'index'
+    assert_present assigns(:entries)
+    assert_equal 1, assigns(:entries).size
+    assert_equal [CrudTestModel.find_by_name('BBBBB')], assigns(:entries)
+  end
+  
+  def test_sort_given_column
+  	get :index, :sort => 'children', :sort_dir => 'asc'
+    assert_response :success
+    assert_template 'index'
+    assert_present assigns(:entries)
+    assert_equal 6, assigns(:entries).size
+    assert_equal CrudTestModel.order(:children).all, assigns(:entries)
+  end
+  
+  def test_sort_virtual_column
+    get :index, :sort => 'chatty', :sort_dir => 'desc'
+    assert_response :success
+    assert_template 'index'
+    assert_present assigns(:entries)
+    assert_equal 6, assigns(:entries).size
+    sorted = CrudTestModel.all.sort_by &:chatty
+    assert_equal sorted.reverse.collect(&:name), assigns(:entries).collect(&:name)
+  end
+  
+  def test_sort_with_search
+    get :index, :q => 'DDD', :sort => 'chatty', :sort_dir => 'asc'
+    assert_response :success
+    assert_template 'index'
+    assert_present assigns(:entries)
+    assert_equal 3, assigns(:entries).size
+    assert_equal ['CCCCC', 'DDDDD', 'BBBBB'], assigns(:entries).collect(&:name)
+  end
+  
   def test_new
     super
     assert assigns(:companions)

data/lib/generators/dry_crud/templates/test/unit/helpers/crud_helper_test.rb

@@ -9,10 +9,6 @@ class CrudHelperTest < ActionView::TestCase
   setup :reset_db, :setup_db, :create_test_data
   teardown :reset_db
   
-  def model_class
-    CrudTestModel
-  end
-  
   test "standard crud table" do
     @entries = CrudTestModel.all
     
@@ -21,8 +17,8 @@ class CrudHelperTest < ActionView::TestCase
     end
     
     assert_match /(<tr.+?<\/tr>){7}/m, t
-    assert_match /(<th.+?<\/th>){14}/m, t
-    assert_match /(<a href.+?<\/a>.*?){18}/m, t
+    assert_match /(<th><a .*asc.*>.*<\/a><\/th>){4}/m, t
+    assert_match /(<td><a href.+?<\/a><\/td>.*?){18}/m, t  # show, edit, delete links
   end
   
   test "custom crud table with attributes" do
@@ -34,7 +30,7 @@ class CrudHelperTest < ActionView::TestCase
         
     assert_match /(<tr.+?<\/tr>){7}/m, t
     assert_match /(<th.+?<\/th>){4}/m, t
-    assert_match /(<a href.+?<\/a>.*?){18}/m, t
+    assert_match /(<td><a href.+?<\/a><\/td>.*?){18}/m, t  # show, edit, delete links
   end
     
   test "custom crud table with block" do
@@ -50,7 +46,7 @@ class CrudHelperTest < ActionView::TestCase
     assert_match /(<tr.+?<\/tr>){7}/m, t
     assert_match /(<th.+?<\/th>){4}/m, t
     assert_match /(<span>.+?<\/span>.*?){6}/m, t
-    assert_no_match /(<a href.+?<\/a>.*?)/m, t
+    assert_no_match /(<td><a href.+?<\/a><\/td>.*?)/m, t
   end
   
   test "custom crud table with attributes and block" do
@@ -65,7 +61,58 @@ class CrudHelperTest < ActionView::TestCase
     assert_match /(<tr.+?<\/tr>){7}/m, t
     assert_match /(<th.+?<\/th>){4}/m, t
     assert_match /(<span>.+?<\/span>.*?){6}/m, t
-    assert_no_match /(<a href.+?<\/a>.*?)/m, t
+    assert_no_match /(<td><a href.+?<\/a><\/td>.*?)/m, t
+  end
+    
+  test "standard crud table with ascending sort params" do
+    def params
+      {:sort => 'children', :sort_dir => 'asc'}
+    end
+  
+    @entries = CrudTestModel.all
+    
+    t = with_test_routing do 
+      crud_table
+    end
+    
+    assert_match /(<tr.+?<\/tr>){7}/m, t
+    assert_match /(<th><a .*desc.*>Children<\/a> &darr;<\/th>){1}/m, t
+    assert_match /(<th><a .*asc.*>.*<\/a><\/th>){3}/m, t
+    assert_match /(<td><a href.+?<\/a><\/td>.*?){18}/m, t
+  end
+  
+  test "standard crud table with descending sort params" do
+    def params
+      {:sort => 'children', :sort_dir => 'desc'}
+    end
+  
+    @entries = CrudTestModel.all
+    
+    t = with_test_routing do 
+      crud_table
+    end
+    
+    assert_match /(<tr.+?<\/tr>){7}/m, t
+    assert_match /(<th><a .*asc.*>Children<\/a> &uarr;<\/th>){1}/m, t
+    assert_match /(<th><a .*asc.*>.*<\/a><\/th>){4}/m, t
+    assert_match /(<td><a href.+?<\/a><\/td>.*?){18}/m, t
+  end
+    
+  test "crud table with custom column sort params" do
+    def params
+      {:sort => 'chatty', :sort_dir => 'asc'}
+    end
+  
+    @entries = CrudTestModel.all
+    
+    t = with_test_routing do 
+      crud_table :name, :children, :chatty
+    end
+    
+    assert_match /(<tr.+?<\/tr>){7}/m, t
+    assert_match /(<th><a .*desc.*>Chatty<\/a> &darr;<\/th>){1}/m, t
+    assert_match /(<th><a .*asc.*>.*<\/a><\/th>){2}/m, t
+    assert_match /(<td><a href.+?<\/a><\/td>.*?){18}/m, t
   end
   
   test "crud form" do
@@ -90,12 +137,29 @@ class CrudHelperTest < ActionView::TestCase
     assert_equal [:name, :whatever, :children, :companion_id, :rating, :income, 
                   :birthdate, :human, :remarks, :created_at, :updated_at], default_attrs
   end
+  
+  # Controller helper methods for the tests
+  
+  def model_class
+    CrudTestModel
+  end
+  
+  def params
+  	{}
+  end
+  
+  def sortable?(attr)
+  	true
+  end
+
     
   private
   
   def with_test_routing
     with_routing do |set|
       set.draw { resources :crud_test_models }
+      # used to define a controller in these tests
+      set.default_url_options = {:controller => 'crud_test_models'}
       yield
     end
   end

data/lib/generators/dry_crud/templates/test/unit/helpers/standard_helper_test.rb

@@ -101,7 +101,7 @@ class StandardHelperTest < ActionView::TestCase
   
   test "format integer column" do
     m = crud_test_models(:AAAAA)
-    assert_equal '1', format_type(m, :children)
+    assert_equal '9', format_type(m, :children)
     
     m.children = 10000
     assert_equal '10,000', format_type(m, :children)
@@ -127,7 +127,7 @@ class StandardHelperTest < ActionView::TestCase
   
   test "format text column" do
     m = crud_test_models(:AAAAA)
-    assert_equal "<p>AAAAA AAAAA AAAAA\n<br />AAAAA AAAAA AAAAA\n<br />AAAAA AAAAA AAAAA\n</p>", format_type(m, :remarks)
+    assert_equal "<p>AAAAA BBBBB CCCCC\n<br />AAAAA BBBBB CCCCC\n</p>", format_type(m, :remarks)
     assert format_type(m, :remarks).html_safe?
   end
   
@@ -170,7 +170,7 @@ class StandardHelperTest < ActionView::TestCase
     assert_match /option selected="selected" value="1910">1910<\/option>/, f 
     assert_match /option selected="selected" value="1">January<\/option>/, f
     assert_match /option selected="selected" value="1">1<\/option>/, f
-    assert_match /input .*?name="crud_test_model\[children\]" .*?type="text" .*?value=\"1\"/, f
+    assert_match /input .*?name="crud_test_model\[children\]" .*?type="text" .*?value=\"9\"/, f
     assert_match /input .*?name="crud_test_model\[human\]" .*?type="checkbox"/, f
     assert_match /input .*?type="submit" .*?value="Save"/, f
   end
@@ -207,7 +207,7 @@ class StandardHelperTest < ActionView::TestCase
     assert_match /option selected="selected" value="1910">1910<\/option>/, f
     assert_match /option selected="selected" value="1">January<\/option>/, f
     assert_match /option selected="selected" value="1">1<\/option>/, f
-    assert_match /input .*?name="crud_test_model\[children\]" .*?type="text" .*?value=\"1\"/, f
+    assert_match /input .*?name="crud_test_model\[children\]" .*?type="text" .*?value=\"9\"/, f
     assert_match /input .*?name="crud_test_model\[human\]" .*?type="checkbox"/, f
     assert_match /input .*?type="submit" .*?value="Save"/, f
   end

data/test/templates/app/controllers/cities_controller.rb

@@ -3,8 +3,8 @@ class CitiesController < AjaxController
   def show
     respond_to do |format|
       format.html do
-        flash[:notice] = flash[:notice]
-        redirect_to :action => 'index'
+        flash.keep
+        redirect_to_index
       end
       format.xml  { render :xml => @entry }
     end

data/test/templates/app/controllers/people_controller.rb

@@ -1,11 +1,12 @@
 class PeopleController < AjaxController
   
   self.search_columns = [:name, :children, :rating, :income, :birthdate, :remarks]
+  self.sort_mappings = {:city_id => 'cities.name'}
   
   protected
   
-  def fetch_all_options
-    {:include => :city, :order => 'people.name, cities.country_code, cities.name'}
+  def list_entries
+    super.includes(:city).order('people.name, cities.country_code, cities.name')
   end
   
 end

data/test/templates/app/models/city.rb

@@ -4,7 +4,7 @@ class City < ActiveRecord::Base
 
   validates_presence_of :name, :country_code
   
-  default_scope :order => 'country_code, name'
+  default_scope order('country_code, name')
   
   def label
     "#{name} (#{country_code})"

data/test/templates/app/views/ajax/_actions_index.html.erb

@@ -0,0 +1,4 @@
+<%= render :partial => 'crud/actions_index' %> 
+
+<%= link_action 'Ajahx', {:action => 'ajax'}, :method => :get, :remote => true %>
+<div id="response"></div>

data/test/templates/db/seeds.rb

@@ -0,0 +1,55 @@
+be = City.create!(:name => 'Bern', :country_code => 'CH')
+ny = City.create!(:name => 'New York', :country_code => 'USA')
+sf = City.create!(:name => 'San Francisco', :country_code => 'USA')
+lon = City.create!(:name => 'London', :country_code => 'GB')
+br = City.create!(:name => 'Berlin', :country_code => 'DE')
+
+Person.create!(:name => 'Albert Einstein', 
+			   :city => be, 
+			   :children => 2, 
+			   :rating => 9.8,  
+			   :income => 84000,
+			   :birthdate => '1904-10-18',
+			   :remarks => "Great physician\n Good cyclist")
+Person.create!(:name => 'Adolf Ogi', 
+			   :city => be, 
+			   :children => 3, 
+			   :rating => 4.2,  
+			   :income => 264000,
+			   :birthdate => '1938-01-22',
+			   :remarks => 'Freude herrscht!')
+Person.create!(:name => 'Jay Z', 
+			   :city => ny, 
+			   :children => 0, 
+			   :rating => 7.2,  
+			   :income => 868345,
+			   :birthdate => '1976-05-02',
+			   :remarks => "If got 99 problems\nbut you bitch ain't one\nTschie")
+Person.create!(:name => 'Queen Elisabeth', 
+			   :city => lon, 
+			   :children => 1, 
+			   :rating => 1.56,  
+			   :income => 345622,
+			   :birthdate => '1927-08-11',
+			   :remarks => '')
+Person.create!(:name => 'Schopenhauer', 
+			   :city => br, 
+			   :children => 7, 
+			   :rating => 6.9,  
+			   :income => 14000,
+			   :birthdate => '1788-10-18',
+			   :remarks => 'Neminem laede, immo omnes, quantum potes, iuva.')
+Person.create!(:name => 'ZZ Top', 
+			   :city => ny, 
+			   :children => 185, 
+			   :rating => 1.8,  
+			   :income => 84000,
+			   :birthdate => '1948-03-18',
+			   :remarks => 'zzz..')
+Person.create!(:name => 'Andy Warhol', 
+			   :city => ny, 
+			   :children => 0, 
+			   :rating => 7.5,  
+			   :income => 123000,
+			   :birthdate => '1938-09-08',
+			   :remarks => 'Tomato Soup')

data/test/templates/test/functional/cities_controller_test.rb

@@ -14,7 +14,7 @@ class CitiesControllerTest < ActionController::TestCase
   def test_index
     super
     assert_equal 3, assigns(:entries).size
-    assert_equal City.all(:order => 'country_code, name'), assigns(:entries)
+    assert_equal City.order('country_code, name').all, assigns(:entries)
   end
   
   def test_show

data/test/templates/test/functional/people_controller_test.rb

@@ -14,7 +14,12 @@ class PeopleControllerTest < ActionController::TestCase
   def test_index
     super
     assert_equal 2, assigns(:entries).size
-    assert_equal Person.all(:include => :city, :order => 'people.name, cities.country_code, cities.name'), assigns(:entries)
+    assert_equal Person.includes(:city).order('people.name, cities.country_code, cities.name').all, assigns(:entries)
+  end
+  
+  def test_index_search
+    super
+  	assert_equal 1, assigns(:entries).size
   end
   
   protected 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dry_crud
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Pascal Zumkehr
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 +02:00
+date: 2010-11-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,9 @@ files:
 - lib/generators/dry_crud/templates/app/helpers/standard_form_builder.rb
 - lib/generators/dry_crud/templates/app/helpers/standard_helper.rb
 - lib/generators/dry_crud/templates/app/helpers/standard_table_builder.rb
+- lib/generators/dry_crud/templates/app/views/crud/_actions_edit.html.erb
+- lib/generators/dry_crud/templates/app/views/crud/_actions_index.html.erb
+- lib/generators/dry_crud/templates/app/views/crud/_actions_show.html.erb
 - lib/generators/dry_crud/templates/app/views/crud/_attrs.html.erb
 - lib/generators/dry_crud/templates/app/views/crud/_form.html.erb
 - lib/generators/dry_crud/templates/app/views/crud/_list.html.erb
@@ -84,9 +87,9 @@ files:
 - test/templates/app/helpers/people_helper.rb
 - test/templates/app/models/city.rb
 - test/templates/app/models/person.rb
+- test/templates/app/views/ajax/_actions_index.html.erb
 - test/templates/app/views/ajax/_hello.html.erb
 - test/templates/app/views/ajax/ajax.js.rjs
-- test/templates/app/views/ajax/index.html.erb
 - test/templates/app/views/cities/_form.html.erb
 - test/templates/app/views/cities/_hello.html.erb
 - test/templates/app/views/cities/_list.html.erb
@@ -94,6 +97,7 @@ files:
 - test/templates/app/views/people/_attrs.html.erb
 - test/templates/config/routes.rb
 - test/templates/db/migrate/20100511174904_create_people_and_cities.rb
+- test/templates/db/seeds.rb
 - test/templates/test/fixtures/cities.yml
 - test/templates/test/fixtures/people.yml
 - test/templates/test/functional/cities_controller_test.rb

data/test/templates/app/views/ajax/index.html.erb

@@ -1,4 +0,0 @@
-<%= render :file => 'crud/index' %> 
-
-<%= link_to 'Ajahx', {:action => 'ajax'}, :method => :get, :remote => true %>
-<div id="response"></div>