dry_crud 1.4.0 → 1.5.0

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

@@ -7,12 +7,8 @@
 class CrudController < ListController
 
   include ERB::Util
-  
-  # Set up entry object to use in the various actions.
-  before_filter :build_entry, :only => [:new, :create]
-  before_filter :set_entry,   :only => [:show, :edit, :update, :destroy]
 
-  helper_method :full_entry_label
+  helper_method :entry, :full_entry_label
 
   delegate :model_identifier, :to => 'self.class'
 
@@ -33,15 +29,15 @@ class CrudController < ListController
   #   GET /entries/1
   #   GET /entries/1.json
   def show
-    respond_with @entry
+    respond_with entry
   end
 
   # Display a form to create a new entry of this model.
   #   GET /entries/new
   #   GET /entries/new.json
   def new
-    @entry.attributes = params[model_identifier]
-    respond_with @entry
+    assign_attributes
+    respond_with entry
   end
 
   # Create a new entry of this model from the passed params.
@@ -51,16 +47,16 @@ class CrudController < ListController
   #   POST /entries
   #   POST /entries.json
   def create(&block)
-    @entry.attributes = params[model_identifier]
-    created = with_callbacks(:create, :save) { @entry.save }
+    assign_attributes
+    created = with_callbacks(:create, :save) { entry.save }
 
     customizable_respond_to(created, block) do |format|
       if created
         format.html { redirect_to_show success_notice }
-        format.json  { render :json => @entry, :status => :created, :location => @entry }
+        format.json  { render :json => entry, :status => :created, :location => path_args(entry) }
       else
         format.html { render_with_callback 'new'  }
-        format.json  { render :json => @entry.errors, :status => :unprocessable_entity }
+        format.json  { render :json => entry.errors, :status => :unprocessable_entity }
       end
     end
   end
@@ -78,8 +74,8 @@ class CrudController < ListController
   #   PUT /entries/1
   #   PUT /entries/1.json
   def update(&block)
-    @entry.attributes = params[model_identifier]
-    updated = with_callbacks(:update, :save) { @entry.save }
+    assign_attributes
+    updated = with_callbacks(:update, :save) { entry.save }
 
     customizable_respond_to(updated, block) do |format|
       if updated
@@ -87,7 +83,7 @@ class CrudController < ListController
         format.json  { head :ok }
       else
         format.html { render_with_callback 'edit'  }
-        format.json  { render :json => @entry.errors, :status => :unprocessable_entity }
+        format.json  { render :json => entry.errors, :status => :unprocessable_entity }
       end
     end
   end
@@ -99,7 +95,7 @@ class CrudController < ListController
   #   DELETE /entries/1
   #   DELETE /entries/1.json
   def destroy(&block)
-    destroyed = run_callbacks(:destroy) { @entry.destroy }
+    destroyed = run_callbacks(:destroy) { entry.destroy }
 
     customizable_respond_to(destroyed, block) do |format|
       if destroyed
@@ -107,10 +103,10 @@ class CrudController < ListController
         format.json  { head :ok }
       else
         format.html { 
-          flash.alert = @entry.errors.full_messages.join('<br/>')
+          flash.alert = entry.errors.full_messages.join('<br/>')
           request.env["HTTP_REFERER"].present? ? redirect_to(:back) : redirect_to_show
         }
-        format.json  { render :json => @entry.errors, :status => :unprocessable_entity }
+        format.json  { render :json => entry.errors, :status => :unprocessable_entity }
       end
     end
   end
@@ -119,29 +115,39 @@ class CrudController < ListController
 
   #############  CUSTOMIZABLE HELPER METHODS  ##############################
 
+  # Main accessor method for the handled model entry.
+  def entry
+    @entry ||= params[:id] ? find_entry : build_entry
+  end
+  
   # Creates a new model entry.
   def build_entry
-    @entry = model_class.new
+    model_scope.new
   end
 
   # Sets an existing model entry from the given id.
-  def set_entry
-    @entry = model_class.find(params[:id])
+  def find_entry
+    model_scope.find(params[:id])
+  end
+  
+  # Assigns the attributes from the params to the model entry.
+  def assign_attributes
+    entry.attributes = params[model_identifier]
   end
 
   # A label for the current entry, including the model name.
   def full_entry_label
-    "#{models_label(false)} <i>#{h(@entry)}</i>".html_safe
+    "#{models_label(false)} <i>#{h(entry)}</i>".html_safe
   end
 
   # Redirects to the show action of a single entry.
   def redirect_to_show(options = {})
-    redirect_to @entry, options
+    redirect_to path_args(entry), options
   end
 
   # Redirects to the main action of this controller.
   def redirect_to_index(options = {})
-    redirect_to polymorphic_path(model_class, :returning => true), options
+    redirect_to polymorphic_path(path_args(model_class), :returning => true), options
   end
 
   # Helper method the run the given block in between the before and after

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

@@ -6,7 +6,7 @@
 # the user the same list as he left it.
 class ListController < ApplicationController
 
-  helper_method :model_class, :models_label
+  helper_method :model_class, :models_label, :path_args
 
   delegate :model_class, :models_label, :to => 'self.class'
 
@@ -27,8 +27,21 @@ class ListController < ApplicationController
 
   # The entries to be displayed in the current index page.
   def list_entries
+    model_scope
+  end
+  
+  # The scope where model entries will be listed and created.
+  # This is mainly used for nested models to provide the 
+  # required context.
+  def model_scope
     model_class.scoped
   end
+  
+  # The path arguments to link to the given entry.
+  # If the controller is nested, this provides the required context.
+  def path_args(last)
+    last
+  end
 
   # Convenience method to respond to various formats with the given object.
   def respond_with(object)
@@ -57,7 +70,9 @@ class ListController < ApplicationController
     # A human readable plural name of the model.
     def models_label(plural = true)
       opts = {:count => (plural ? 3 : 1)}
-      opts[:default] = model_class.model_name.human.pluralize if plural
+      opts[:default] = model_class.model_name.human.titleize
+      opts[:default] = opts[:default].pluralize if plural
+      
       model_class.model_name.human(opts)
     end
     
@@ -95,10 +110,14 @@ class ListController < ApplicationController
     # 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
+        terms = params[:q].split(/\s+/).collect { |t| "%#{t}%" }
+        clause = search_columns.collect do |f| 
+          col = f.to_s.include?('.') ? f : "#{model_class.table_name}.#{f}"
+          "#{col} LIKE ?"
+        end.join(" OR ")
+        clause = terms.collect {|t| "(#{clause})" }.join(" AND ")
+        
+         ["(#{clause})"] + terms.collect {|t| [t] * search_columns.size }.flatten
       end
     end
 
@@ -171,7 +190,7 @@ class ListController < ApplicationController
     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.remember_params = [:q, :sort, :sort_dir, :page]
 
       controller.before_filter :handle_remember_params, :only => [:index]
     end
@@ -219,4 +238,71 @@ class ListController < ApplicationController
 
   include Memory
 
+  # Provides functionality to nest controllers/resources.
+  # If a controller is nested, the parent classes and namespaces
+  # may be defined as an array in the :nesting class attribute.
+  # For example, a cities controller, nested in country and a admin
+  # namespace, may define this attribute as follows:
+  #   self.nesting = :admin, Country
+  module Nesting
+    
+    # Adds the :nesting class attribute and parent helper methods
+    # to the including controller.
+    def self.included(controller)
+      controller.class_attribute :nesting
+      
+      controller.helper_method :parent, :parents
+      
+      controller.alias_method_chain :model_scope, :nesting
+      controller.alias_method_chain :path_args, :nesting
+    end
+    
+    protected
+    
+    # Returns the direct parent ActiveRecord of the current request, if any.
+    def parent
+      parents.select {|p| p.is_a?(ActiveRecord::Base) }.last
+    end
+    
+    # Returns the parent entries of the current request, if any.
+    # These are ActiveRecords or namespace symbols, corresponding 
+    # to the defined nesting attribute.
+    def parents
+      @parents ||= Array(nesting).collect do |p|
+        if p.is_a?(Class) && p < ActiveRecord::Base
+          parent_entry(p)
+        else
+          p
+        end
+      end
+    end
+    
+    # Loads the parent entry for the given ActiveRecord class.
+    # By default, performs a find with the class_name_id param.
+    def parent_entry(clazz)
+      clazz.find(params["#{clazz.name.underscore}_id"])
+    end
+    
+    # An array of objects used in url_for and related functions.
+    def path_args_with_nesting(last)
+      parents + [last]
+    end
+    
+    # Uses the parent entry (if any) to constrain the model scope.
+    def model_scope_with_nesting
+      if parent.present?
+        parent_scope
+      else
+        model_scope_without_nesting
+      end
+    end
+    
+    # The model scope for the current parent resource.
+    def parent_scope
+      parent.send(model_class.name.underscore.pluralize)
+    end
+  end
+  
+  include Nesting
+  
 end

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

@@ -9,7 +9,7 @@ module CrudHelper
   # If a block is given, a custom form may be rendered and attrs is ignored.
   def crud_form(*attrs, &block)
     attrs = attrs_or_default(attrs) { default_attrs - [:created_at, :updated_at] }
-    standard_form(@entry, *attrs, &block)
+    standard_form(path_args(entry), *attrs, &block)
   end
 
   # Create a table of the @entries variable with the default or
@@ -28,40 +28,94 @@ module CrudHelper
 
   # Adds a set of standard action link column (show, edit, destroy) to the given table.
   def add_table_actions(table)
-    action_col(table) { |e| link_table_action_show(e) }
-    action_col(table) { |e| link_table_action_edit(e) }
-    action_col(table) { |e| link_table_action_destroy(e) }
+    action_col_show(table)
+    action_col_edit(table)
+    action_col_destroy(table)
   end
 
-  # Action link to show inside a table.
-  def link_table_action_show(record)
-    link_table_action('show', record)
+  # Action link to show the row entry inside a table.
+  # A block may be given to define the link path for the row entry.
+  def action_col_show(table, &block)
+    action_col(table) { |e| link_table_action('zoom-in', action_path(e, &block)) }
   end
 
   # Action link to edit inside a table.
-  def link_table_action_edit(record)
-    link_table_action('edit', edit_polymorphic_path(record))
+  # A block may be given to define the link path for the row entry.
+  def action_col_edit(table, &block)
+    action_col(table) do |e| 
+      path = action_path(e, &block)
+      link_table_action('pencil', path.is_a?(String) ? path : edit_polymorphic_path(path))
+    end
   end
 
   # Action link to destroy inside a table.
-  def link_table_action_destroy(record)
-    link_table_action('delete', record,
-                      :confirm => ti(:confirm_delete),
-                      :method => :delete)
+  # A block may be given to define the link path for the row entry.
+  def action_col_destroy(table, &block)
+    action_col(table) do |e|
+      link_table_action('remove', action_path(e, &block),
+                        :confirm => ti(:confirm_delete),
+                        :method => :delete)
+    end
   end
 
   # Generic action link inside a table.
-  def link_table_action(image, url, html_options = {})
-  	link_to(action_icon(image), url, html_options)
+  def link_table_action(icon, url, html_options = {})
+    add_css_class html_options, "icon-#{icon}"
+  	link_to('', url, html_options)
   end
 
   # Defines a column with an action link.
   def action_col(table, &block)
-  	table.col('', :class => 'center', &block)
+  	table.col('', :class => 'action', &block)
+  end
+  
+  ######## ACTION LINKS ###################################################### :nodoc:
+
+  # Standard link action to the show page of a given record.
+  # Uses the current record if none is given.
+  def link_action_show(path = nil)
+    path ||= path_args(entry)
+    link_action ti(:"link.show"), 'zoom-in', path
+  end
+
+  # Standard link action to the edit page of a given record.
+  # Uses the current record if none is given.
+  def link_action_edit(path = nil)
+    path ||= path_args(entry)
+    link_action ti(:"link.edit"), 'pencil', path.is_a?(String) ? path : edit_polymorphic_path(path)
+  end
+
+  # Standard link action to the destroy action of a given record.
+  # Uses the current record if none is given.
+  def link_action_destroy(path = nil)
+    path ||= path_args(entry)
+    link_action ti(:"link.delete"), 'remove', path,
+                :confirm => ti(:confirm_delete),
+                :method => :delete
+  end
+
+  # Standard link action to the list page.
+  # Links to the current model_class if no path is given.
+  def link_action_index(path = nil, url_options = {:returning => true})
+    path ||= path_args(model_class)
+    link_action ti(:"link.list"), 'list', path.is_a?(String) ? path : polymorphic_path(path, url_options)
+  end
+
+  # Standard link action to the new page.
+  # Links to the current model_class if no path is given.
+  def link_action_add(path = nil, url_options = {})
+    path ||= path_args(model_class)
+    link_action ti(:"link.add"), 'plus', path.is_a?(String) ? path : new_polymorphic_path(path, url_options)
   end
   
   private
 
+  # If a block is given, call it to get the path for the current row entry.
+  # Otherwise, return the standard path args.
+  def action_path(e, &block)
+    block_given? ? yield(e) : path_args(e)
+  end
+  
   # Returns default attrs for a crud table if no others are passed.
   def attrs_or_default(attrs)
   	options = attrs.extract_options!

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

@@ -23,4 +23,5 @@ module ListHelper
     attrs - [:id, :position, :password]
   end
   
+  
 end

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

@@ -9,8 +9,8 @@ class StandardFormBuilder < ActionView::Helpers::FormBuilder
 
   attr_reader :template
 
-  delegate :association, :column_type, :column_property, :captionize, :ta,
-           :to => :template
+  delegate :association, :column_type, :column_property, :captionize, 
+           :content_tag, :ta, :add_css_class, :to => :template
 
   # Render multiple input fields together with a label for the given attributes.
   def labeled_input_fields(*attrs)
@@ -43,6 +43,7 @@ class StandardFormBuilder < ActionView::Helpers::FormBuilder
 
   # Render a number field.
   def number_field(attr, html_options = {})
+    add_css_class html_options, 'span1'
     html_options[:size] ||= 10
     super(attr, html_options)
   end
@@ -79,16 +80,19 @@ class StandardFormBuilder < ActionView::Helpers::FormBuilder
 
   # Render a field to select a date. You might want to customize this.
   def date_field(attr, html_options = {})
+    add_css_class html_options, 'span1'
     date_select(attr, {}, html_options)
   end
 
   # Render a field to enter a time. You might want to customize this.
   def time_field(attr, html_options = {})
+    add_css_class html_options, 'span1'
     time_select(attr, {}, html_options)
   end
   
   # Render a field to enter a date and time. You might want to customize this.
   def datetime_field(attr, html_options = {})
+    add_css_class html_options, 'span1'
     datetime_select(attr, {}, html_options)
   end
   
@@ -112,7 +116,11 @@ class StandardFormBuilder < ActionView::Helpers::FormBuilder
 
   # Render a label for the given attribute with the passed field html section.
   def labeled(attr, field_html = nil, &block)
-    template.labeled(label(attr), field_html, &block)
+    field_html = capture(&block) if block_given?
+    content_tag(:div, 
+                label(attr, :class => 'control-label') + 
+                content_tag(:div, field_html, :class => 'controls'), 
+                :class => 'control-group')
   end
 
   # Depending if the given attribute must be present, return

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

@@ -81,7 +81,7 @@ module StandardHelper
         yield t if block_given?
       end
     else
-      content_tag(:div, ti(:no_list_entries), :class => 'list')
+      content_tag(:div, ti(:no_list_entries), :class => 'table')
     end
   end
 
@@ -91,8 +91,14 @@ module StandardHelper
   # If a block is given, custom input fields may be rendered and attrs is ignored.
   # An options hash may be given as the last argument.
   def standard_form(object, *attrs, &block)
-    form_for(object, {:builder => StandardFormBuilder}.merge(attrs.extract_options!)) do |form|
-      content = render('shared/error_messages', :errors => object.errors, :object => object)
+    options = attrs.extract_options!
+    options[:builder] ||= StandardFormBuilder
+    options[:html] ||= {}
+    add_css_class options[:html], 'form-horizontal'
+    
+    form_for(object, options) do |form|
+      record = object.is_a?(Array) ? object.last : object
+      content = render('shared/error_messages', :errors => record.errors, :object => record)
 
       content << if block_given?
         capture(form, &block)
@@ -100,7 +106,11 @@ module StandardHelper
         form.labeled_input_fields(*attrs)
       end
 
-      content << labeled(nil, form.submit(ti(:"button.save")) + cancel_link(object))
+      content << content_tag(:div, 
+                             form.button(ti(:"button.save"), :class => 'btn btn-primary') + 
+                             ' ' + 
+                             cancel_link(object),
+                             :class => 'form-actions')
       content.html_safe
     end
   end
@@ -109,61 +119,24 @@ module StandardHelper
     link_to(ti(:"button.cancel"), polymorphic_path(object), :class => 'cancel')
   end
 
-  # Alternate table row
-  def tr_alt(cycle_name = 'row_class', &block)
-    content_tag(:tr, :class => cycle("even", "odd", :name => cycle_name), &block)
-  end
-  
-  # Renders a div with clear:both style.
-  def clear
-    content_tag(:div, '', :class => 'clear')
-  end
-
 
   ######## ACTION LINKS ###################################################### :nodoc:
 
-  # Standard link action to the show page of a given record.
-  def link_action_show(record)
-    link_action ti(:"link.show"), 'show', record
-  end
-
-  # Standard link action to the edit page of a given record.
-  def link_action_edit(record)
-    link_action ti(:"link.edit"), 'edit', edit_polymorphic_path(record)
-  end
-
-  # Standard link action to the destroy action of a given record.
-  def link_action_destroy(record)
-    link_action ti(:"link.delete"), 'delete', record,
-                :confirm => ti(:confirm_delete),
-                :method => :delete
-  end
-
-  # Standard link action to the list page.
-  def link_action_index(url_options = {:action => 'index', :returning => true})
-    link_action ti(:"link.list"), 'list', url_options
-  end
-
-  # Standard link action to the new page.
-  def link_action_add(url_options = {:action => 'new'})
-    link_action ti(:"link.add"), 'add', url_options
-  end
-
   # A generic helper method to create action links.
   # These link could be styled to look like buttons, for example.
   def link_action(label, icon = nil, url = {}, html_options = {})
+    add_css_class html_options, 'action btn'
     link_to(icon ? action_icon(icon, label) : label,
-            url,
-            {:class => 'action'}.merge(html_options))
+            url, html_options)
   end
 
   # Outputs an icon for an action with an optional label.
   def action_icon(icon, label = nil)
-    html = image_tag("actions/#{icon}.png", :size => '16x16')
+    html = content_tag(:i, "", :class => "icon-#{icon}")
     html << ' ' << label if label
     html
   end
-
+  
   # Translates the passed key by looking it up over the controller hierarchy. 
   # The key is searched in the following order:
   #  - {controller}.{current_partial}.{key}
@@ -216,6 +189,24 @@ module StandardHelper
   alias_method :ta, :translate_association
   
   
+  # Returns the css class for the given flash level.
+  def flash_class(level)
+    case level
+    when :notice then 'success'
+    when :error then 'error'
+    when :alert then 'error'
+    end
+  end
+  
+  # Adds a class to the given options, even if there are already classes.
+  def add_css_class(options, classes)
+    if options[:class]
+      options[:class] += ' ' + classes
+    else
+      options[:class] = classes
+    end
+  end
+  
   protected
 
   # Helper methods that are not directly called from templates.

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

@@ -11,7 +11,7 @@ class StandardTableBuilder
   # Delegate called methods to template.
   # including StandardHelper would lead to problems with indirectly called methods.
   delegate :content_tag, :format_attr, :column_type, :association,
-           :captionize, :tr_alt, :to => :template
+           :captionize, :add_css_class, :to => :template
 
   def initialize(entries, template, options = {})
     @entries = entries
@@ -55,7 +55,8 @@ class StandardTableBuilder
 
   # Renders the table as HTML.
   def to_html
-    content_tag :table, :class => 'list' do
+    add_css_class options, 'table'
+    content_tag :table, options do
       content_tag(:thead, html_header) + 
       content_tag(:tbody, safe_join(entries) { |e| html_row(e) })
     end
@@ -86,7 +87,7 @@ class StandardTableBuilder
   end
 
   def html_row(entry)
-    tr_alt do
+    content_tag :tr do
       safe_join(cols) { |c| c.html_cell(entry) }
     end
   end

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

@@ -1,3 +1,3 @@
 <%= link_action_index %>
-<%= link_action_show @entry %>
-<%= link_action_destroy @entry %>
+<%= link_action_show %>
+<%= link_action_destroy %>

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

@@ -0,0 +1,3 @@
+= link_action_index
+= link_action_show
+= link_action_destroy

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

@@ -0,0 +1 @@
+= link_action_add

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

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

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

@@ -0,0 +1,3 @@
+= link_action_index
+= link_action_edit
+= link_action_destroy

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

@@ -1 +1 @@
-<%= render_attrs @entry, *default_attrs %>
+<%= render_attrs entry, *default_attrs %>

data/lib/generators/dry_crud/templates/app/views/crud/_attrs.html.haml

@@ -0,0 +1 @@
+= render_attrs entry, *default_attrs

data/lib/generators/dry_crud/templates/app/views/crud/_form.html.haml

@@ -0,0 +1 @@
+= crud_form

data/lib/generators/dry_crud/templates/app/views/crud/_list.html.haml

@@ -0,0 +1 @@
+= crud_table

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

@@ -2,6 +2,4 @@
 
 <% content_for(:actions, render('actions_edit')) %>
 
-<%= clear %>
-
 <%= render 'form' %>

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

@@ -0,0 +1,5 @@
+- @title ||= ti(:title, :model => full_entry_label).html_safe
+
+- content_for(:actions, render('actions_edit'))
+
+= render 'form'