dry_crud 1.5.0 → 1.6.0

data/README.rdoc

@@ -72,17 +72,16 @@ This only displays these three attributes in the table. All other templates, as
 
 ==== Adapt general behavior
 
-Next, let's adapt a part of the general behavior used in all CRUD controllers. As an example, we include pagination with will_paginate[http://wiki.github.com/mislav/will_paginate/] in all our overview tables: 
+Next, let's adapt a part of the general behavior used in all CRUD controllers. As an example, we include pagination with kaminari[https://github.com/amatsuda/kaminari] in all our overview tables: 
 
-In <tt>app/controllers/list_controller.rb</tt>, change the index action to
+In <tt>app/controllers/list_controller.rb</tt>, change the list_entries method to
 
-  def index
-    @entries = list_entries.paginate(:page => params[:page])
-    respond_with @entries   
+  def list_entries
+    model_scope.page(params[:page])
   end
 
 In <tt>app/views/list/index.html.erb</tt>, add the following line for the pagination links:
-   <%= will_paginate @entries %>
+   <%= paginate entries %>
 
 And we are done again. All our controllers inheriting from +ListController+, 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. 
 
@@ -123,7 +122,7 @@ In <tt>app/controllers/people_controller.rb</tt>:
   end
   
   def delete_picture
-    if !perform_delete_picture(@entry.picture)
+    if !perform_delete_picture(entry.picture)
       flash.alert = 'Could not delete picture' 
       false
     end
@@ -135,7 +134,7 @@ In <tt>app/controllers/people_controller.rb</tt>:
   before_render_form :set_hometowns
   
   def set_hometowns
-    @hometowns = City.where(:country => @entry.country)
+    @hometowns = City.where(:country => entry.country)
   end
 
 === Standard Tables and Forms
@@ -181,6 +180,12 @@ Even +belongs_to+ associations are automatically rendered with a select field. B
 
 Yes, it's bad practice to use finder logic in your views! Define the variable <tt>@hometowns</tt> in your controller instead (as shown in the example above), and you do not even have to specify the <tt>:list</tt> option.
 
+Optionally, +has_and_belongs_to_many+ and +has_many+ associations can be rendered with a multi-select field. Similar to a +belongs_to+ association, all entries from the associated model are used, but can be overwritten using the <tt>:list</tt> option:
+  <%= f.has_many_field :visited_cities, :list => City.where(:is_touristic => true) %>
+
+And yes again, the same advice for where to put finder logic applies here as well.
+
+<b>Note:</b> +has_and_belongs_to_many+ and +has_many+ associations are not automatically rendered in a form, you have to explicitly include these attributes. You might also want to stylize the multi-select widget, for example with a {jQuery UI Multiselect}[http://www.quasipartikel.at/multiselect/].
 
 === Nested Resources
 
@@ -188,7 +193,7 @@ In case you define nested resources, your +CrudController+ subclass should know.
 
   self.nesting = :my_namspace, ParentResource
   
-This declaration is for a controller nested in +parent_resources+ within a +:my_namespace+ scope. +ParentResource+ is the corresponding +ActiveRecord+ model. The request param +:parent_resource_id+ is used to load the parent entry, which in turn is used to filter the entries listed and created in your controller.
+This declaration is for a controller nested in +parent_resources+ within a +:my_namespace+ scope. +ParentResource+ is the corresponding +ActiveRecord+ model. The request param +:parent_resource_id+ is used to load the parent entry, which in turn is used to filter the entries listed and created in your controller. For all parent resources, a corresponding instance variable is created.
 
 The <tt>ListController::Nesting</tt> module defines this basic behaviour. For more complex setups, have a look there and adjust it to your needs.
 
@@ -221,22 +226,22 @@ 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. This class is based on +ListController+.
+{controller/crud_controller.rb}[http://codez.ch/dry_crud/CrudController.html]:: 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. This class is based on +ListController+.
 
-{controller/list_controller.rb}[http://codez.ch/dry_crud/?q=ListController]:: Abstract controller providing a basic list action. Use this controller if you require read-only functionality. There are two sub-modules that provide search and sort functionality for the table displayed in the list action. A third sub-module remembers the list parameters in order to return to an identical list.
+{controller/list_controller.rb}[http://codez.ch/dry_crud/ListController.html]:: Abstract controller providing a basic list action. Use this controller if you require read-only functionality. There are two sub-modules that provide search and sort functionality for the table displayed in the list action. A third sub-module remembers the list parameters in order to return to an identical list.
 
 
 === Helpers:
 
-{helpers/standard_helper.rb}[http://codez.ch/dry_crud/?q=StandardHelper]:: A view helper to standardize often used functions like formatting, tables, forms or action links. This helper is ideally defined in the +ApplicationController+. It is required to use the +StandardTableBuilder+ and the +StandardFormBuilder+.
+{helpers/standard_helper.rb}[http://codez.ch/dry_crud/StandardHelper.html]:: A view helper to standardize often used functions like formatting, tables, forms or action links. This helper is ideally defined in the +ApplicationController+. It is required to use the +StandardTableBuilder+ and the +StandardFormBuilder+.
 
-{helpers/crud_helper.rb}[http://codez.ch/dry_crud/?q=CrudHelper]:: A small helper for +CrudController+ to render tables and forms with a default set of attributes.
+{helpers/crud_helper.rb}[http://codez.ch/dry_crud/CrudHelper.html]:: A small helper for +CrudController+ to render tables and forms with a default set of attributes.
 
-{helpers/list_helper.rb}[http://codez.ch/dry_crud/?q=ListHelper]:: A small helper for +ListController+ to render the list table with a default set of attributes.
+{helpers/list_helper.rb}[http://codez.ch/dry_crud/ListHelper.html]:: A small helper for +ListController+ to render the list table with a default set of attributes.
 
-{helpers/standard_table_builder.rb}[http://codez.ch/dry_crud/?q=StandardTableBuilder]:: A simple helper object to easily define tables listing several rows of the same data type.
+{helpers/standard_table_builder.rb}[http://codez.ch/dry_crud/StandardTableBuilder.html]:: A simple helper object to easily define tables listing several rows of the same data type.
 
-{helpers/standard_form_builder.rb}[http://codez.ch/dry_crud/?q=StandardFormBuilder]:: A form builder that automatically selects the corresponding input type for ActiveRecord columns. Input elements are rendered together with a label by default.
+{helpers/standard_form_builder.rb}[http://codez.ch/dry_crud/StandardFormBuilder.html]:: A form builder that automatically selects the corresponding input type for ActiveRecord columns. Input elements are rendered together with a label by default.
 
 
 === Views:
@@ -290,11 +295,11 @@ app/assets/images/action/*.png:: Some sample action icons from the {Open Icon Li
 
 === Tests:
 
-{test/crud_test_model.rb}[http://codez.ch/dry_crud/?q=CrudTestHelper]:: A dummy model to run CRUD tests against.
+{test/crud_test_model.rb}[http://codez.ch/dry_crud/CrudTestHelper.html]:: A dummy model to run CRUD tests against.
 
-{test/custom_assertions.rb}[http://codez.ch/dry_crud/?q=CustomAssertions]:: A handful of convenient assertions. Include this module into your <tt>test_helper.rb</tt> file.
+{test/custom_assertions.rb}[http://codez.ch/dry_crud/CustomAssertions.html]:: A handful of convenient assertions. Include this module into your <tt>test_helper.rb</tt> file.
 
-{test/functionals/crud_controller_test_helper.rb}[http://codez.ch/dry_crud/?q=CrudControllerTestHelper]:: A module to include into the functional tests for your +CrudController+ subclasses. Contains a handful of CRUD functionality tests for the provided implementation. So for each new CRUD controller, you get 20 tests for free.
+{test/functionals/crud_controller_test_helper.rb}[http://codez.ch/dry_crud/CrudControllerTestHelper.html]:: A module to include into the functional tests for your +CrudController+ subclasses. Contains a handful of CRUD functionality tests for the provided implementation. So for each new CRUD controller, you get 20 tests for free.
 
 test/several other tests:: Testing the provided implementation and a great base to test your adaptions of the CRUD code.
 

data/Rakefile

@@ -85,12 +85,12 @@ namespace :test do
     desc "Adds pagination to the test app"
     task :add_pagination => :generate_crud do
       list_ctrl = File.join(TEST_APP_ROOT, 'app', 'controllers', 'list_controller.rb')
-      file_replace(list_ctrl, "@entries = list_entries", 
-                              "@entries = list_entries.page(params[:page]).per(10)")
+      file_replace(list_ctrl, /def list_entries\n\s+model_scope\s*\n/, 
+                              "def list_entries\n    model_scope.page(params[:page]).per(10)\n")
       file_replace(File.join(TEST_APP_ROOT, 'app', 'views', 'list', 'index.html.erb'), 
-                   "<%= render 'list' %>", "<%= paginate @entries %>\n\n<%= render 'list' %>")
+                   "<%= render 'list' %>", "<%= paginate entries %>\n\n<%= render 'list' %>")
       file_replace(File.join(TEST_APP_ROOT, 'app', 'views', 'list', 'index.html.haml'), 
-                   "= render 'list'", "= paginate @entries\n\n= render 'list'")
+                   "= render 'list'", "= paginate entries\n\n= render 'list'")
     end
     
     desc "Use Boostrap in the test app"
@@ -98,6 +98,14 @@ namespace :test do
        file_replace(File.join(TEST_APP_ROOT, 'app', 'assets', 'stylesheets', 'application.css'), " *= require_self", "*= require twitter/bootstrap\n *= require_self")
        file_replace(File.join(TEST_APP_ROOT, 'app', 'assets', 'javascripts', 'application.js'), "//= require_tree .", "//= require twitter/bootstrap\n//= require_tree .")
        FileUtils.rm(File.join(TEST_APP_ROOT, 'app', 'assets', 'stylesheets', 'sample.scss'))
+       
+       layouts = File.join(TEST_APP_ROOT, 'app', 'views', 'layouts')
+       FileUtils.mv(File.join(layouts, 'bootstrap.html.erb'),
+                    File.join(layouts, 'application.html.erb'), 
+                    :force => true) if File.exists?(File.join(layouts, 'bootstrap.html.erb'))
+       FileUtils.mv(File.join(layouts, 'bootstrap.html.haml'),
+                    File.join(layouts, 'application.html.haml'), 
+                    :force => true) if File.exists?(File.join(layouts, 'bootstrap.html.haml'))
     end
    
   end

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/lib/generators/dry_crud/dry_crud_generator.rb

@@ -3,8 +3,8 @@ require 'rails/generators'
 class DryCrudGenerator < Rails::Generators::Base
 
   class_options %w(templates -t) => 'erb'
-  
-  
+
+
   def self.source_root
      File.join(File.dirname(__FILE__), 'templates')
   end
@@ -12,13 +12,13 @@ class DryCrudGenerator < Rails::Generators::Base
   def install_dry_crud
     # copy everything in template subfolders
     exclude = options[:templates].downcase == 'haml' ? '.erb' : '.haml'
-    
+
     Dir.chdir(self.class.source_root) do
       Dir.glob(File.join('**', '**')).sort.each do |file_source|
-      	if !File.directory?(file_source) && 
-      	   !file_source.ends_with?(exclude) && 
-      	   file_source != 'INSTALL'
-        	copy_file(file_source) 
+        if !File.directory?(file_source) &&
+           !file_source.end_with?(exclude) &&
+           file_source != 'INSTALL'
+          copy_file(file_source)
         end
       end
     end

data/lib/generators/dry_crud/templates/app/assets/stylesheets/crud.scss

@@ -9,7 +9,7 @@
 
 .labeled {
   vertical-align: top;
-  padding-bottom: 5px;
+  padding: 2px 0 2px;
   clear: both;
 }
 
@@ -27,14 +27,25 @@
   margin: 0;
 }
 
+#content {
+  clear: both;
+  padding-top: 5px;
+  width: 100%;
+}
+
+table.table td.action {
+  width: 20px;
+  text-align: center;
+}
+
 .control-group {
   clear: both;
+  padding: 2px 0 2px;
 }
 
 .control-group label {
   float: left;
   width: 120px;
-  padding-top: 5px;
   padding-right: 5px;
 }
 
@@ -42,6 +53,11 @@
   margin-left: 130px;
 }
 
+.cancel {
+  font-size: 80%;
+  margin-left: 7px;
+}
+
 .required {
   font-size: 80%;
   vertical-align: top;
@@ -57,8 +73,3 @@
   margin-bottom: 5px;
 }
 
-.controls div.field_with_errors {
-  background-color: #da9;
-  display: inline-block;
-  padding: 1px 1px;
-}

data/lib/generators/dry_crud/templates/app/assets/stylesheets/sample.scss

@@ -25,11 +25,6 @@ body {
   box-shadow: 0px 0px 5px $theme_color;
 }
 
-#content {
-  clear: both;
-  padding-top: 5px;
-}
-
 h1 {
   font-size: 150%;
   margin: 30px 0 15px 0;
@@ -102,13 +97,9 @@ table.table td {
   padding: 2px 4px;  
 }
 
-table.table td.action {
-  width: 20px;
-  text-align: center;
-}
-
 label {
   font-style: italic;
+  text-align: right;
 }
 
 .form-actions {
@@ -155,16 +146,11 @@ input[type=number] {
   width: 80px;
 }
 
-textarea {
+textarea, select[multiple] {
   width: 180px;
   height: 80px;
 }
 
-.cancel {
-  font-size: 80%;
-  margin-left: 7px;
-}
-
 .alert {
   margin: 15px;
   padding: 5px 10px;
@@ -176,7 +162,7 @@ textarea {
 }
 
 .alert-error {
-  border: solid 2px #da9;
+  border: solid 2px #D88;
   background-color: #fec;
 }
 
@@ -237,8 +223,9 @@ a.brand:hover {
   display: block;
   float: left;
   margin: 0;
-  padding: 8px 12px 8px;
+  padding: 7px 12px 7px;
   text-decoration: none;
+  height: 19px;
 }
 
 .nav a:hover {
@@ -255,4 +242,12 @@ footer {
 
 footer * {
   font-size: 80%;
+}
+
+.error .control-label {
+  color: #D88;
+}
+
+.error .controls input, .error .controls textarea {
+  border-color: #D88;
 }

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

@@ -6,15 +6,8 @@
 # overriding the entire method.
 class CrudController < ListController
 
-  include ERB::Util
-
-  helper_method :entry, :full_entry_label
-
   delegate :model_identifier, :to => 'self.class'
 
-  hide_action :model_identifier, :run_callbacks
-
-
   # Defines before and after callback hooks for create, update, save and destroy actions.
   define_model_callbacks :create, :update, :save, :destroy
 
@@ -22,70 +15,63 @@ class CrudController < ListController
   # unifiying render_new and render_edit, called render_form, is defined further down.
   define_render_callbacks :show, :new, :edit
 
+  after_save :set_success_notice
+  after_destroy :set_success_notice
+
+  helper_method :entry, :full_entry_label
+  
+  hide_action :model_identifier, :run_callbacks
+  
+  # Simple helper object to give access to required view helper methods.
+  @@helper = Object.new.extend(ActionView::Helpers::TranslationHelper).
+                        extend(ActionView::Helpers::OutputSafetyHelper)
+
 
   ##############  ACTIONS  ############################################
 
   # Show one entry of this model.
   #   GET /entries/1
   #   GET /entries/1.json
-  def show
-    respond_with entry
+  def show(&block)
+    respond_with(entry, &block)
   end
 
   # Display a form to create a new entry of this model.
   #   GET /entries/new
   #   GET /entries/new.json
-  def new
+  def new(&block)
     assign_attributes
-    respond_with entry
+    respond_with(entry, &block)
   end
 
   # Create a new entry of this model from the passed params.
   # There are before and after create callbacks to hook into the action.
   # To customize the response, you may overwrite this action and call
-  # super with a block that gets success and format parameters.
+  # super with a block that gets the format parameter.
   #   POST /entries
   #   POST /entries.json
   def create(&block)
     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 => path_args(entry) }
-      else
-        format.html { render_with_callback 'new'  }
-        format.json  { render :json => entry.errors, :status => :unprocessable_entity }
-      end
-    end
+    respond_with(entry, :success => created, &block)
   end
 
   # Display a form to edit an exisiting entry of this model.
   #   GET /entries/1/edit
-  def edit
-    render_with_callback 'edit'
+  def edit(&block)
+    respond_with(entry, &block)
   end
 
   # Update an existing entry of this model from the passed params.
   # There are before and after update callbacks to hook into the action.
   # To customize the response, you may overwrite this action and call
-  # super with a block that gets success and format parameters.
+  # super with a block that gets the format parameter.
   #   PUT /entries/1
   #   PUT /entries/1.json
   def update(&block)
     assign_attributes
     updated = with_callbacks(:update, :save) { entry.save }
-
-    customizable_respond_to(updated, block) do |format|
-      if updated
-        format.html { redirect_to_show success_notice }
-        format.json  { head :ok }
-      else
-        format.html { render_with_callback 'edit'  }
-        format.json  { render :json => entry.errors, :status => :unprocessable_entity }
-      end
-    end
+    respond_with(entry, :success => updated, &block)
   end
 
   # Destroy an existing entry of this model.
@@ -96,19 +82,9 @@ class CrudController < ListController
   #   DELETE /entries/1.json
   def destroy(&block)
     destroyed = run_callbacks(:destroy) { entry.destroy }
-
-    customizable_respond_to(destroyed, block) do |format|
-      if destroyed
-        format.html { redirect_to_index success_notice }
-        format.json  { head :ok }
-      else
-        format.html { 
-          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 }
-      end
-    end
+    flash[:alert] ||= error_messages.presence || flash_message(:failure) if !destroyed && request.format == :html
+    location = !destroyed && request.env["HTTP_REFERER"].presence || index_url
+    respond_with(entry, :success => destroyed, :location => location, &block)
   end
 
   protected
@@ -117,9 +93,9 @@ class CrudController < ListController
 
   # Main accessor method for the handled model entry.
   def entry
-    @entry ||= params[:id] ? find_entry : build_entry
+    get_model_ivar || set_model_ivar(params[:id] ? find_entry : build_entry)
   end
-  
+
   # Creates a new model entry.
   def build_entry
     model_scope.new
@@ -129,7 +105,7 @@ class CrudController < ListController
   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]
@@ -137,52 +113,39 @@ class CrudController < ListController
 
   # 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>#{ERB::Util.h(entry)}</i>".html_safe
   end
 
-  # Redirects to the show action of a single entry.
-  def redirect_to_show(options = {})
-    redirect_to path_args(entry), options
+  # Url of the index page to return to
+  def index_url
+    polymorphic_url(path_args(model_class), :returning => true)
   end
 
-  # Redirects to the main action of this controller.
-  def redirect_to_index(options = {})
-    redirect_to polymorphic_path(path_args(model_class), :returning => true), options
-  end
+  private
 
-  # Helper method the run the given block in between the before and after
-  # callbacks of the given kinds.
-  def with_callbacks(*kinds, &block)
-    kinds.reverse.inject(block) do |b, kind| 
-      lambda { run_callbacks(kind, &b) }
-    end.call
+  # Set a success flash notice when we got a HTML request.
+  def set_success_notice
+    flash[:notice] ||= flash_message(:success) if request.format == :html
   end
-  
-  private
-  
-  # Convenience method to respond to various formats if the performed
-  # action may succeed or fail. It is possible to pass a custom_block and respond
-  # in custom ways for certain cases. If no response is performed in the
-  # given block, the default responses in the main block are executed.
-  def customizable_respond_to(success, custom_block = nil)
-    respond_to do |format|
-      custom_block.call(success, format) if custom_block
-      return if performed?
-      
-      yield format
-    end
+
+  # Get an I18n flash message, considering _html keys as well.
+  # Uses the key {controller_name}.{action_name}.flash.{state}
+  # or crud.{action_name}.flash.{state} as fallback.
+  def flash_message(state)
+    scope = "#{action_name}.flash.#{state}"
+    keys = [:"#{controller_name}.#{scope}_html",
+            :"#{controller_name}.#{scope}",
+            :"crud.#{scope}_html",
+            :"crud.#{scope}"]
+    @@helper.t(keys.shift, :model => full_entry_label, :default => keys)
   end
   
-  # Create an I18n flash notice if the action was successfull.
-  # Uses the key {controller_name}.{action_name}.flash.success
-  # or crud.{action_name}.flash.success as fallback.
-  def success_notice
-    key = "#{action_name}.flash.success"
-    {:notice => t(:"#{controller_name}.#{key}", 
-                  :model => full_entry_label, 
-                  :default => :"crud.#{key}")}
+  # Html safe error messages of the current entry.
+  def error_messages
+    @@helper.safe_join(entry.errors.full_messages, '<br/>'.html_safe)
   end
 
+
   class << self
     # The identifier of the model used for form parameters.
     # I.e., the symbol of the underscored model name.
@@ -197,4 +160,28 @@ class CrudController < ListController
     end
   end
 
+  # Custom Responder that handles the controller's path_args. 
+  # An additional :success option is used to handle action callback chain halts.
+  class Responder < ActionController::Responder
+
+    def initialize(controller, resources, options = {})
+      super(controller, with_path_args(resources, controller), options)
+    end
+
+    protected
+
+    # Check whether the resource has errors. Additionally checks the :success option.
+    def has_errors?
+      options[:success] == false || super
+    end
+
+    # Wraps the resources with the path_args for correct nesting.
+    def with_path_args(resources, controller)
+      resources.size == 1 ? Array(controller.send(:path_args, resources.first)) : resources
+    end
+
+  end
+
+  self.responder = Responder
+
 end