active_scaffold 3.0.0

data/lib/active_scaffold/actions/create.rb

@@ -0,0 +1,152 @@
+module ActiveScaffold::Actions
+  module Create
+    def self.included(base)
+      base.before_filter :create_authorized_filter, :only => [:new, :create]
+      base.verify :method => :post,
+                  :only => :create,
+                  :redirect_to => { :action => :index }
+    end
+
+    def new
+      do_new
+      respond_to_action(:new)
+    end
+
+    def create
+      do_create
+      @insert_row = !(nested? && nested.belongs_to?) && params[:parent_controller].nil?
+      respond_to_action(:create)
+    end
+
+    protected
+    def response_location
+      url_for(params_for(:action => "show", :id => @record.id)) if successful?
+    end
+
+    def new_respond_to_html
+      if successful?
+        render(:action => 'create')
+      else
+        return_to_main
+      end
+    end
+
+    def new_respond_to_js
+      render(:partial => 'create_form')
+    end
+
+    def create_respond_to_html
+      if params[:iframe]=='true' # was this an iframe post ?
+        responds_to_parent do
+          render :action => 'on_create.js', :layout => false
+        end
+      else
+        if successful?
+          flash[:info] = as_(:created_model, :model => @record.to_label)
+          if active_scaffold_config.create.edit_after_create
+            redirect_to params_for(:action => "edit", :id => @record.id)
+          elsif active_scaffold_config.create.persistent
+            redirect_to params_for(:action => "new")
+          else
+            return_to_main
+          end
+        else
+          if !nested? && active_scaffold_config.actions.include?(:list) && active_scaffold_config.list.always_show_create
+            do_list
+            render(:action => 'list')
+          else
+            render(:action => 'create')
+          end
+        end
+      end
+    end
+
+    def create_respond_to_js
+      render :action => 'on_create'
+    end
+
+    def create_respond_to_xml
+      render :xml => response_object.to_xml(:only => active_scaffold_config.create.columns.names), :content_type => Mime::XML, :status => response_status, :location => response_location
+    end
+
+    def create_respond_to_json
+      render :text => response_object.to_json(:only => active_scaffold_config.create.columns.names), :content_type => Mime::JSON, :status => response_status, :location => response_location
+    end
+
+    def create_respond_to_yaml
+      render :text => Hash.from_xml(response_object.to_xml(:only => active_scaffold_config.create.columns.names)).to_yaml, :content_type => Mime::YAML, :status => response_status, :location => response_location
+    end
+
+    # A simple method to find and prepare an example new record for the form
+    # May be overridden to customize the behavior (add default values, for instance)
+    def do_new
+      @record = new_model
+      apply_constraints_to_record(@record)
+      if nested?
+        create_association_with_parent(@record)
+        register_constraints_with_action_columns(nested.constrained_fields)
+      end
+      @record
+    end
+
+    # A somewhat complex method to actually create a new record. The complexity is from support for subforms and associated records.
+    # If you want to customize this behavior, consider using the +before_create_save+ and +after_create_save+ callbacks.
+    def do_create
+      begin
+        active_scaffold_config.model.transaction do
+          @record = update_record_from_params(new_model, active_scaffold_config.create.columns, params[:record])
+          apply_constraints_to_record(@record, :allow_autosave => true)
+          if nested?
+            create_association_with_parent(@record)
+            register_constraints_with_action_columns(nested.constrained_fields)
+          end
+          before_create_save(@record)
+          self.successful = [@record.valid?, @record.associated_valid?].all? {|v| v == true} # this syntax avoids a short-circuit
+          if successful?
+            @record.save! and @record.save_associated!
+            after_create_save(@record)
+          end
+        end
+      rescue ActiveRecord::RecordInvalid
+      end
+    end
+
+    def new_model
+      model = beginning_of_chain
+      if model.columns_hash[model.inheritance_column]
+        params = self.params # in new action inheritance_column must be in params
+        params = params[:record] || {} unless params[model.inheritance_column] # in create action must be inside record key
+        model = params.delete(model.inheritance_column).camelize.constantize if params[model.inheritance_column]
+      end
+      model.new
+    end
+
+    # override this method if you want to inject data in the record (or its associated objects) before the save
+    def before_create_save(record); end
+
+    # override this method if you want to do something after the save
+    def after_create_save(record); end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+
+    def create_ignore?
+      nested? && active_scaffold_config.list.always_show_create
+    end
+
+    def create_authorized?
+      (!nested? || !nested.readonly?) && authorized_for?(:crud_type => :create)
+    end
+    private
+    def create_authorized_filter
+      link = active_scaffold_config.create.link || active_scaffold_config.create.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def new_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+    def create_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.create.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/delete.rb

@@ -0,0 +1,72 @@
+module ActiveScaffold::Actions
+  module Delete
+    def self.included(base)
+      base.before_filter :delete_authorized_filter, :only => [:delete, :destroy]
+    end
+
+    # this method is for html mode. it provides "the missing action" (http://thelucid.com/articles/2006/07/26/simply-restful-the-missing-action).
+    # it also gives us delete confirmation for html mode. woo!
+    def delete
+      destroy_find_record
+      render :action => 'delete'
+    end
+
+    def destroy
+      return redirect_to(params.merge(:action => :delete)) if request.get?
+      do_destroy
+      respond_to_action(:destroy)
+    end
+
+    protected
+    def destroy_respond_to_html
+      flash[:info] = as_(:deleted_model, :model => @record.to_label) if self.successful?
+      return_to_main
+    end
+
+    def destroy_respond_to_js
+      render(:action => 'destroy')
+    end
+
+    def destroy_respond_to_xml
+      render :xml => successful? ? "" : response_object.to_xml(:only => active_scaffold_config.list.columns.names), :content_type => Mime::XML, :status => response_status
+    end
+
+    def destroy_respond_to_json
+      render :text => successful? ? "" : response_object.to_json(:only => active_scaffold_config.list.columns.names), :content_type => Mime::JSON, :status => response_status
+    end
+
+    def destroy_respond_to_yaml
+      render :text => successful? ? "" : Hash.from_xml(response_object.to_xml(:only => active_scaffold_config.list.columns.names)).to_yaml, :content_type => Mime::YAML, :status => response_status
+    end
+
+    def destroy_find_record
+      @record = find_if_allowed(params[:id], :delete)
+    end
+
+    # A simple method to handle the actual destroying of a record
+    # May be overridden to customize the behavior
+    def do_destroy
+      destroy_find_record
+      begin
+        self.successful = @record.destroy
+      rescue
+        flash[:warning] = as_(:cant_destroy_record, :record => @record.to_label)
+        self.successful = false
+      end
+    end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def delete_authorized?(record = nil)
+      (!nested? || !nested.readonly?) && authorized_for?(:crud_type => :delete)
+    end
+    private
+    def delete_authorized_filter
+      link = active_scaffold_config.delete.link || active_scaffold_config.delete.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def destroy_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.delete.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/field_search.rb

@@ -0,0 +1,82 @@
+module ActiveScaffold::Actions
+  module FieldSearch
+    include ActiveScaffold::Actions::CommonSearch
+    def self.included(base)
+      base.before_filter :search_authorized_filter, :only => :show_search
+      base.before_filter :store_search_params_into_session, :only => [:index]
+      base.before_filter :do_search, :only => [:index]
+      base.helper_method :field_search_params
+    end
+
+    # FieldSearch uses params[:search] and not @record because search conditions do not always pass the Model's validations.
+    # This facilitates for example, textual searches against associations via .search_sql
+    def show_search
+      @record = active_scaffold_config.model.new
+      respond_to_action(:field_search)
+    end
+
+    protected
+
+    def store_search_params_into_session
+      set_field_search_default_params(active_scaffold_config.field_search.default_params) unless active_scaffold_config.field_search.default_params.nil?
+      super
+      active_scaffold_session_storage[:search] = nil if search_params.is_a?(String)
+    end
+
+    def set_field_search_default_params(default_params)
+      if (params[:search].nil? && search_params.nil?) || (params[:search].is_a?(String) && params[:search].blank?)
+        params[:search] = default_params.is_a?(Proc) ? self.instance_eval(&default_params) : default_params
+      end
+    end
+
+    def field_search_params
+      search_params || {}
+    end
+
+    def field_search_respond_to_html
+      render(:action => "field_search")
+    end
+
+    def field_search_respond_to_js
+      render(:partial => "field_search")
+    end
+
+    def do_search
+      unless search_params.nil?
+        text_search = active_scaffold_config.field_search.text_search
+        search_conditions = []
+        human_condition_columns = [] if active_scaffold_config.field_search.human_conditions
+        columns = active_scaffold_config.field_search.columns
+        search_params.each do |key, value|
+          next unless columns.include? key
+          search_condition = self.class.condition_for_column(active_scaffold_config.columns[key], value, text_search)
+          unless search_condition.blank?
+            search_conditions << search_condition
+            human_condition_columns << active_scaffold_config.columns[key] unless human_condition_columns.nil?
+          end
+        end
+        self.active_scaffold_conditions = merge_conditions(self.active_scaffold_conditions, *search_conditions)
+        if search_conditions.blank?
+          @filtered = false
+        else
+          @filtered = human_condition_columns.nil? ? true : human_condition_columns
+        end
+
+        includes_for_search_columns = columns.collect{ |column| column.includes}.flatten.uniq.compact
+        self.active_scaffold_includes.concat includes_for_search_columns
+
+        active_scaffold_config.list.user.page = nil
+      end
+    end
+
+    private
+
+    def search_authorized_filter
+      link = active_scaffold_config.field_search.link || active_scaffold_config.field_search.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def field_search_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.field_search.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/list.rb

@@ -0,0 +1,128 @@
+module ActiveScaffold::Actions
+  module List
+    def self.included(base)
+      base.before_filter :list_authorized_filter, :only => [:index, :row]
+      base.helper_method :list_columns
+    end
+
+    def index
+      list
+    end
+
+    # get just a single row
+    def row
+      render :partial => 'row', :locals => {:record => find_if_allowed(params[:id], :read)}
+    end
+
+    def list
+      do_list
+      do_new if active_scaffold_config.list.always_show_create
+      @record ||= active_scaffold_config.model.new if active_scaffold_config.list.always_show_search
+      @nested_auto_open = active_scaffold_config.list.nested_auto_open
+      respond_to_action(:list)
+    end
+
+    protected
+    def list_respond_to_html
+      if params.delete(:embedded)
+        render :action => 'list', :layout => false
+      else
+        render :action => 'list'
+      end
+    end
+    def list_respond_to_js
+      if params[:adapter]
+        render(:partial => 'list_with_header')
+      elsif params[:embedded]
+        params.delete(:embedded)
+        render(:partial => 'list_with_header')
+      else
+        render :action => 'list.js'
+      end
+    end
+    def list_respond_to_xml
+      render :xml => response_object.to_xml(:only => list_columns_names), :content_type => Mime::XML, :status => response_status
+    end
+    def list_respond_to_json
+      render :text => response_object.to_json(:only => list_columns_names), :content_type => Mime::JSON, :status => response_status
+    end
+    def list_respond_to_yaml
+      render :text => Hash.from_xml(response_object.to_xml(:only => list_columns_names)).to_yaml, :content_type => Mime::YAML, :status => response_status
+    end
+    # The actual algorithm to prepare for the list view
+    def do_list
+      includes_for_list_columns = active_scaffold_config.list.columns.collect{ |c| c.includes }.flatten.uniq.compact
+      self.active_scaffold_includes.concat includes_for_list_columns
+
+      options = { :sorting => active_scaffold_config.list.user.sorting,
+                  :count_includes => active_scaffold_config.list.user.count_includes }
+      paginate = (params[:format].nil?) ? (accepts? :html, :js) : ['html', 'js'].include?(params[:format])
+      if paginate
+        options.merge!({
+          :per_page => active_scaffold_config.list.user.per_page,
+          :page => active_scaffold_config.list.user.page,
+          :pagination => active_scaffold_config.list.pagination
+        })
+      end
+
+      page = find_page(options);
+      if page.items.blank? && !page.pager.infinite?
+        page = page.pager.last
+        active_scaffold_config.list.user.page = page.number
+      end
+      @page, @records = page, page.items
+    end
+
+    def each_record_in_scope
+      do_search if respond_to? :do_search
+      finder_options = { :order => "#{active_scaffold_config.model.primary_key} ASC",
+                         :conditions => all_conditions,
+                         :joins => joins_for_finder}
+      finder_options.merge! custom_finder_options
+      finder_options.merge! :include => (active_scaffold_includes.blank? ? nil : active_scaffold_includes)
+      klass = beginning_of_chain
+      klass.all(finder_options).each {|record| yield record}
+    end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def list_authorized?
+      authorized_for?(:crud_type => :read)
+    end
+
+    def action_update_respond_to_js
+      render(:action => 'on_action_update')
+    end
+
+    def action_update_respond_to_xml
+      render :xml => successful? ? "" : response_object.to_xml(:only => list_columns_names), :content_type => Mime::XML, :status => response_status
+    end
+
+    def action_update_respond_to_json
+      render :text => successful? ? "" : response_object.to_json(:only => list_columns_names), :content_type => Mime::JSON, :status => response_status
+    end
+
+    def action_update_respond_to_yaml
+      render :text => successful? ? "" : Hash.from_xml(response_object.to_xml(:only => list_columns_names)).to_yaml, :content_type => Mime::YAML, :status => response_status
+    end
+
+    private
+    def list_authorized_filter
+      raise ActiveScaffold::ActionNotAllowed unless list_authorized?
+    end
+    def list_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.list.formats).uniq
+    end
+    def action_update_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+
+    def list_columns
+      active_scaffold_config.list.columns.collect_visible
+    end
+
+    def list_columns_names
+      list_columns.collect(&:name)
+    end
+  end
+end

data/lib/active_scaffold/actions/mark.rb

@@ -0,0 +1,50 @@
+module ActiveScaffold::Actions
+  module Mark
+
+    def self.included(base)
+      base.before_filter :mark_authorized?, :only => [:mark_all]
+      base.prepend_before_filter :assign_marked_records_to_model
+      base.helper_method :marked_records
+    end
+
+    def mark_all
+      if mark_all?
+        do_mark_all
+      else
+        do_demark_all
+      end
+      do_list
+      respond_to_action(:list)
+    end
+ protected
+
+    # We need to give the ActiveRecord classes a handle to currently marked records. We don't want to just pass the object,
+    # because the object may change. So we give ActiveRecord a proc that ties to the
+    # marked_records_method on this ApplicationController.
+    def assign_marked_records_to_model
+      active_scaffold_config.model.marked_records_proc = proc {send(:marked_records)}
+    end
+
+    def marked_records
+      active_scaffold_session_storage[:marked_records] ||= Set.new
+    end
+
+    def mark_all?
+      @mark_all ||= [true, 'true', 1, '1', 'T', 't'].include?(params[:value].class == String ? params[:value].downcase : params[:value])
+    end
+
+    def do_mark_all
+      each_record_in_scope {|record| marked_records << record.id}
+    end
+
+    def do_demark_all
+      each_record_in_scope {|record| marked_records.delete(record.id)}
+    end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def mark_authorized?
+      authorized_for?(:action => :read)
+    end
+  end
+end