active_scaffold 3.0.0

data/lib/active_scaffold/actions/nested.rb

@@ -0,0 +1,241 @@
+module ActiveScaffold::Actions
+  # The Nested module basically handles automatically linking controllers together. It does this by creating column links with the right parameters, and by providing any supporting systems (like a /:controller/nested action for returning associated scaffolds).
+  module Nested
+
+    def self.included(base)
+      super
+      base.module_eval do
+        before_filter :register_constraints_with_action_columns
+        before_filter :set_nested
+        before_filter :configure_nested
+        include ActiveScaffold::Actions::Nested::ChildMethods if active_scaffold_config.model.reflect_on_all_associations.any? {|a| a.macro == :has_and_belongs_to_many}
+      end
+      base.before_filter :include_habtm_actions
+      base.helper_method :nested
+    end
+
+    protected
+    def nested
+      @nested ||= ActiveScaffold::DataStructures::NestedInfo.get(active_scaffold_config.model, active_scaffold_session_storage)
+      if !@nested.nil? && @nested.new_instance?
+        register_constraints_with_action_columns(@nested.constrained_fields)
+        active_scaffold_constraints[:id] = nested.parent_id if @nested.belongs_to?
+      end
+      @nested
+    end
+
+    def nested?
+      !nested.nil?
+    end
+
+    def set_nested
+      if params[:parent_model] && ((params[:association] && params[:assoc_id]) || params[:named_scope])
+        @nested = nil
+        active_scaffold_session_storage[:nested] = {:parent_model => params[:parent_model].camelize.constantize,
+                                                                  :name => (params[:association] || params[:named_scope]).to_sym,
+                                                                  :parent_id => params[:assoc_id]}
+        params.delete_if {|key, value| [:parent_model, :association, :named_scope, :assoc_id].include? key.to_sym}
+      end
+    end
+
+    def configure_nested
+      if nested?
+        active_scaffold_session_storage[:list][:label] =  if nested.belongs_to?
+          as_(:nested_of_model, :nested_model => active_scaffold_config.model.model_name.human, :parent_model => nested_parent_record.to_label)
+        else
+          as_(:nested_for_model, :nested_model => active_scaffold_config.list.label, :parent_model => nested_parent_record.to_label)
+        end
+        if nested.sorted?
+          active_scaffold_config.list.user.nested_default_sorting = {:table_name => active_scaffold_config.model.model_name, :default_sorting => nested.default_sorting}
+        end
+      end
+    end
+
+    def nested_authorized?(record = nil)
+      true
+    end
+
+    def include_habtm_actions
+      if nested?
+        if nested.habtm?
+          # Production mode is ok with adding a link everytime the scaffold is nested - we ar not ok with that.
+          active_scaffold_config.action_links.add('new_existing', :label => :add_existing, :type => :collection, :security_method => :add_existing_authorized?) unless active_scaffold_config.action_links['new_existing']
+          if active_scaffold_config.nested.shallow_delete
+            active_scaffold_config.action_links.add('destroy_existing', :label => :remove, :type => :member, :confirm => :are_you_sure_to_delete, :method => :delete, :position => false, :security_method => :delete_existing_authorized?) unless active_scaffold_config.action_links['destroy_existing']
+            active_scaffold_config.action_links.delete("delete") if active_scaffold_config.action_links['delete']
+          end
+        else
+          # Production mode is caching this link into a non nested scaffold
+          active_scaffold_config.action_links.delete('new_existing') if active_scaffold_config.action_links['new_existing']
+
+          if active_scaffold_config.nested.shallow_delete
+            active_scaffold_config.action_links.delete("destroy_existing") if active_scaffold_config.action_links['destroy_existing']
+            active_scaffold_config.action_links.add(ActiveScaffold::Config::Delete.link) unless active_scaffold_config.action_links['delete']
+          end
+        end
+      end
+    end
+
+    def beginning_of_chain
+      if nested? && nested.association && nested.association.collection?
+        nested.parent_scope.send(nested.association.name)
+      elsif nested? && nested.scope
+        nested.parent_scope.send(nested.scope)
+      else
+        active_scaffold_config.model
+      end
+    end
+
+    def nested_parent_record(crud = :read)
+      find_if_allowed(nested.parent_id, crud, nested.parent_model)
+    end
+
+    def create_association_with_parent(record)
+      if nested? && nested.belongs_to? && nested.child_association
+        parent = nested_parent_record(:read)
+        case nested.child_association.macro
+        when :has_one
+          record.send("#{nested.child_association.name}=", parent)
+        when :has_many
+          record.send("#{nested.child_association.name}").send(:<<, parent)
+        end unless parent.nil?
+      end
+    end
+
+    private
+    def nested_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.nested.formats).uniq
+    end
+  end
+end
+
+module ActiveScaffold::Actions::Nested
+  module ChildMethods
+
+    def self.included(base)
+      super
+      base.verify :method => :post,
+                  :only => :add_existing,
+                  :redirect_to => { :action => :index }
+    end
+
+    def new_existing
+      do_new
+      respond_to_action(:new_existing)
+    end
+
+    def add_existing
+      do_add_existing
+      respond_to_action(:add_existing)
+    end
+
+    def destroy_existing
+      return redirect_to(params.merge(:action => :delete)) if request.get?
+      do_destroy_existing
+      respond_to_action(:destroy_existing)
+    end
+
+    protected
+    def new_existing_respond_to_html
+      if successful?
+        render(:action => 'add_existing_form')
+      else
+        return_to_main
+      end
+    end
+    def new_existing_respond_to_js
+      render(:partial => 'add_existing_form')
+    end
+    def add_existing_respond_to_html
+      if successful?
+        flash[:info] = as_(:created_model, :model => @record.to_label)
+        return_to_main
+      else
+        render(:action => 'add_existing_form')
+      end
+    end
+    def add_existing_respond_to_js
+      if successful?
+        render :action => 'add_existing'
+      else
+        render :action => 'form_messages'
+      end
+    end
+    def add_existing_respond_to_xml
+      render :xml => response_object.to_xml(:only => active_scaffold_config.list.columns.names), :content_type => Mime::XML, :status => response_status
+    end
+    def add_existing_respond_to_json
+      render :text => response_object.to_json(:only => active_scaffold_config.list.columns.names), :content_type => Mime::JSON, :status => response_status
+    end
+    def add_existing_respond_to_yaml
+      render :text => 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_existing_respond_to_html
+      flash[:info] = as_(:deleted_model, :model => @record.to_label)
+      return_to_main
+    end
+
+    def destroy_existing_respond_to_js
+      render(:action => 'destroy')
+    end
+
+    def destroy_existing_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_existing_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_existing_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 add_existing_authorized?(record = nil)
+      true
+    end
+    def delete_existing_authorized?(record = nil)
+      true
+    end
+
+    def after_create_save(record)
+      if params[:association_macro] == :has_and_belongs_to_many
+        params[:associated_id] = record
+        do_add_existing
+      end
+    end
+
+    # The actual "add_existing" algorithm
+    def do_add_existing
+      parent_record = nested_parent_record(:update)
+      @record = active_scaffold_config.model.find(params[:associated_id])
+      if parent_record && @record
+        parent_record.send(nested.association.name) << @record
+        parent_record.save
+      else
+        false
+      end
+    end
+
+    def do_destroy_existing
+      if active_scaffold_config.nested.shallow_delete
+        @record = nested_parent_record(:update)
+        collection = @record.send(nested.association.name)
+        assoc_record = collection.find(params[:id])
+        collection.delete(assoc_record)
+      else
+        do_destroy
+      end
+    end
+    private
+    def new_existing_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+    def add_existing_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+    def destroy_existing_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/search.rb

@@ -0,0 +1,47 @@
+module ActiveScaffold::Actions
+  module Search
+    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 :search_params
+    end
+
+    def show_search
+      respond_to_action(:search)
+    end
+
+    protected
+    def search_respond_to_html
+      render(:action => "search")
+    end
+    def search_respond_to_js
+      render(:partial => "search")
+    end
+    def do_search
+      query = search_params.to_s.strip rescue ''
+      unless query.empty?
+        columns = active_scaffold_config.search.columns
+        text_search = active_scaffold_config.search.text_search
+        search_conditions = self.class.create_conditions_for_columns(query.split(' '), columns, text_search)
+        self.active_scaffold_conditions = merge_conditions(self.active_scaffold_conditions, search_conditions)
+        @filtered = !search_conditions.blank?
+
+        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.search.link || active_scaffold_config.search.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def search_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.search.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/show.rb

@@ -0,0 +1,54 @@
+module ActiveScaffold::Actions
+  module Show
+    def self.included(base)
+      base.before_filter :show_authorized_filter, :only => :show
+    end
+
+    def show
+      do_show
+      successful?
+      respond_to_action(:show)
+    end
+
+    protected
+
+    def show_respond_to_json
+      render :text => response_object.to_json(:only => active_scaffold_config.show.columns.names), :content_type => Mime::JSON, :status => response_status
+    end
+
+    def show_respond_to_yaml
+      render :text => Hash.from_xml(response_object.to_xml(:only => active_scaffold_config.show.columns.names)).to_yaml, :content_type => Mime::YAML, :status => response_status
+    end
+
+    def show_respond_to_xml
+      render :xml => response_object.to_xml(:only => active_scaffold_config.show.columns.names), :content_type => Mime::XML, :status => response_status
+    end
+
+    def show_respond_to_js
+      render :partial => 'show'
+    end
+
+    def show_respond_to_html
+      render :action => 'show'
+    end
+    # A simple method to retrieve and prepare a record for showing.
+    # May be overridden to customize show routine
+    def do_show
+      @record = find_if_allowed(params[:id], :read)
+    end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def show_authorized?(record = nil)
+      authorized_for?(:crud_type => :read)
+    end
+    private
+    def show_authorized_filter
+      link = active_scaffold_config.show.link || active_scaffold_config.show.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def show_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.show.formats).uniq
+    end
+  end
+end

data/lib/active_scaffold/actions/subform.rb

@@ -0,0 +1,17 @@
+module ActiveScaffold::Actions
+  module Subform
+    def edit_associated
+      @parent_record = params[:id].nil? ? active_scaffold_config.model.new : find_if_allowed(params[:id], :update)
+      @column = active_scaffold_config.columns[params[:association]]
+
+      # NOTE: we don't check whether the user is allowed to update this record, because if not, we'll still let them associate the record. we'll just refuse to do more than associate, is all.
+      @record = @column.association.klass.find(params[:associated_id]) if params[:associated_id]
+      @record ||= @column.association.klass.new
+
+      @scope = "[#{@column.name}]"
+      @scope += (@record.new_record?) ? "[#{(Time.now.to_f*1000).to_i.to_s}]" : "[#{@record.id}]" if @column.plural_association?
+
+      render :action => 'edit_associated'
+    end
+  end
+end

data/lib/active_scaffold/actions/update.rb

@@ -0,0 +1,134 @@
+module ActiveScaffold::Actions
+  module Update
+    def self.included(base)
+      base.before_filter :update_authorized_filter, :only => [:edit, :update]
+      base.verify :method => [:post, :put],
+                  :only => :update,
+                  :redirect_to => { :action => :index }
+    end
+
+    def edit
+      do_edit
+      respond_to_action(:edit)
+    end
+
+    def update
+      do_update
+      respond_to_action(:update)
+    end
+
+    # for inline (inlist) editing
+    def update_column
+      do_update_column
+      render :action => 'update_column', :locals => {:column_span_id => params[:editor_id] || params[:editorId]}
+    end
+
+    protected
+    def edit_respond_to_html
+      if successful?
+        render(:action => 'update')
+      else
+        return_to_main
+      end
+    end
+    def edit_respond_to_js
+      render(:partial => 'update_form')
+    end
+    def update_respond_to_html
+      if params[:iframe]=='true' # was this an iframe post ?
+        responds_to_parent do
+          render :action => 'on_update.js', :layout => false
+        end
+      else # just a regular post
+        if successful?
+          flash[:info] = as_(:updated_model, :model => @record.to_label)
+          return_to_main
+        else
+          render(:action => 'update')
+        end
+      end
+    end
+    def update_respond_to_js
+      render :action => 'on_update'
+    end
+    def update_respond_to_xml
+      render :xml => response_object.to_xml(:only => active_scaffold_config.update.columns.names), :content_type => Mime::XML, :status => response_status
+    end
+    def update_respond_to_json
+      render :text => response_object.to_json(:only => active_scaffold_config.update.columns.names), :content_type => Mime::JSON, :status => response_status
+    end
+    def update_respond_to_yaml
+      render :text => Hash.from_xml(response_object.to_xml(:only => active_scaffold_config.update.columns.names)).to_yaml, :content_type => Mime::YAML, :status => response_status
+    end
+    # A simple method to find and prepare a record for editing
+    # May be overridden to customize the record (set default values, etc.)
+    def do_edit
+      register_constraints_with_action_columns(nested.constrained_fields, active_scaffold_config.update.hide_nested_column ? [] : [:update]) if nested?
+      @record = find_if_allowed(params[:id], :update)
+    end
+
+    # A complex method to update a record. The complexity comes from the support for subforms, and saving associated records.
+    # If you want to customize this algorithm, consider using the +before_update_save+ callback
+    def do_update
+      do_edit
+      @record = update_record_from_params(@record, active_scaffold_config.update.columns, params[:record])
+      update_save
+    end
+
+    def update_save
+      begin
+        active_scaffold_config.model.transaction do
+          before_update_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_update_save(@record)
+          end
+        end
+      rescue ActiveRecord::RecordInvalid
+      rescue ActiveRecord::StaleObjectError
+        @record.errors.add_to_base as_(:version_inconsistency)
+        self.successful=false
+      rescue ActiveRecord::RecordNotSaved
+        @record.errors.add_to_base as_(:record_not_saved) if @record.errors.empty?
+        self.successful = false
+      end
+    end
+
+    def do_update_column
+      @record = active_scaffold_config.model.find(params[:id])
+      if @record.authorized_for?(:crud_type => :update, :column => params[:column])
+        column = active_scaffold_config.columns[params[:column].to_sym]
+        params[:value] ||= @record.column_for_attribute(params[:column]).default unless @record.column_for_attribute(params[:column]).nil? || @record.column_for_attribute(params[:column]).null
+        params[:value] = column_value_from_param_value(@record, column, params[:value]) unless column.nil?
+        @record.send("#{params[:column]}=", params[:value])
+        before_update_save(@record)
+        @record.save
+        after_update_save(@record)
+      end
+    end
+
+    # override this method if you want to inject data in the record (or its associated objects) before the save
+    def before_update_save(record); end
+
+    # override this method if you want to do something after the save
+    def after_update_save(record); end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def update_authorized?(record = nil)
+      (!nested? || !nested.readonly?) && authorized_for?(:crud_type => :update)
+    end
+    private
+    def update_authorized_filter
+      link = active_scaffold_config.update.link || active_scaffold_config.update.class.link
+      raise ActiveScaffold::ActionNotAllowed unless self.send(link.security_method)
+    end
+    def edit_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+    def update_formats
+      (default_formats + active_scaffold_config.formats + active_scaffold_config.update.formats).uniq
+    end
+  end
+end