active_scaffold-sequel 0.3.0

data/lib/active_scaffold/actions/core.rb

@@ -0,0 +1,197 @@
+module ActiveScaffold::Actions
+  module Core
+    def self.included(base)
+      base.class_eval do
+        before_filter :register_constraints_with_action_columns
+        after_filter :clear_flashes
+      end
+      base.helper_method :nested?
+      base.helper_method :beginning_of_chain
+      base.helper_method :new_model
+    end
+    def render_field
+      if params[:in_place_editing]
+        render_field_for_inplace_editing
+      else
+        render_field_for_update_columns
+      end
+    end
+    
+    protected
+
+    def nested?
+      false
+    end
+
+    def render_field_for_inplace_editing
+      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)
+      render :inline => "<%= active_scaffold_input_for(active_scaffold_config.columns[params[:update_column].to_sym]) %>"
+    end
+
+    def render_field_for_update_columns
+      column = active_scaffold_config.columns[params[:column]]
+      unless column.nil?
+        @source_id = params.delete(:source_id)
+        @columns = column.update_columns
+        @scope = params[:scope]
+        
+        if column.send_form_on_update_column
+          hash = if @scope
+            @scope.gsub('[','').split(']').inject(params[:record]) do |hash, index|
+              hash[index]
+            end
+          else
+            params[:record]
+          end
+          @record = hash[:id] ? find_if_allowed(hash[:id], :update) : new_model
+          @record = update_record_from_params(@record, active_scaffold_config.send(@scope ? :subform : (params[:id] ? :update : :create)).columns, hash)
+        else
+          @record = new_model
+          value = column_value_from_param_value(@record, column, params[:value])
+          @record.send "#{column.name}=", value
+        end
+        
+        after_render_field(@record, column)
+      end
+    end
+    
+    # override this method if you want to do something after render_field
+    def after_render_field(record, column); end
+
+    def authorized_for?(options = {})
+      active_scaffold_config.model.authorized_for?(options)
+    end
+
+    def clear_flashes
+      if request.xhr?
+        flash.keys.each do |flash_key|
+          flash[flash_key] = nil
+        end
+      end
+    end
+
+    def marked_records
+      active_scaffold_session_storage[:marked_records] ||= Set.new
+    end
+    
+    def default_formats
+      [:html, :js, :json, :xml, :yaml]
+    end
+    # Returns true if the client accepts one of the MIME types passed to it
+    # ex: accepts? :html, :xml
+    def accepts?(*types)
+      for priority in request.accepts.compact
+        if priority == Mime::ALL
+          # Because IE always sends */* in the accepts header and we assume
+          # that if you really wanted XML or something else you would say so
+          # explicitly, we will assume */* to only ask for :html
+          return types.include?(:html)
+        elsif types.include?(priority.to_sym)
+          return true
+        end
+      end
+      false
+    end
+
+    def response_status
+      if successful?
+        action_name == 'create' ? 201 : 200
+      else
+        422
+      end
+    end
+
+    # API response object that will be converted to XML/YAML/JSON using to_xxx
+    def response_object
+      @response_object = successful? ? (@record || @records) : @record.errors
+    end
+
+    # Success is the existence of certain variables and the absence of errors (when applicable).
+    # Success can also be defined.
+    def successful?
+      if @successful.nil?
+        @records or (@record and @record.errors.count == 0 and @record.no_errors_in_associated?)
+      else
+        @successful
+      end
+    end
+
+    def successful=(val)
+      @successful = (val) ? true : false
+    end
+
+    # Redirect to the main page (override if the ActiveScaffold is used as a component on another controllers page) for Javascript degradation
+    def return_to_main
+      redirect_to main_path_to_return
+    end
+
+    # Override this method on your controller to define conditions to be used when querying a recordset (e.g. for List). The return of this method should be any format compatible with the :conditions clause of Sequel::Model's find.
+    def conditions_for_collection
+    end
+  
+    # Override this method on your controller to define joins to be used when querying a recordset (e.g. for List).  The return of this method should be any format compatible with the :joins clause of Sequel::Model's find.
+    def joins_for_collection
+    end
+  
+    # Override this method on your controller to provide custom finder options to the find() call. The return of this method should be a hash.
+    def custom_finder_options
+      {}
+    end
+  
+    #Overide this method on your controller to provide model with named scopes
+    def beginning_of_chain
+      active_scaffold_config.model
+    end
+        
+    # Builds search conditions by search params for column names. This allows urls like "contacts/list?company_id=5".
+    def conditions_from_params
+      conditions = nil
+      params.reject {|key, value| [:controller, :action, :id, :page, :sort, :sort_direction].include?(key.to_sym)}.each do |key, value|
+        next unless active_scaffold_config.model.columns.include?(key)
+        conditions = merge_conditions(conditions, {"#{active_scaffold_config.model.table_name}__#{key}".to_sym => value})
+      end
+      conditions
+    end
+
+    def new_model
+      model = beginning_of_chain
+      if model.respond_to?(:sti_key)
+        build_options = {model.sti_key => active_scaffold_config.model_id} if nested? && nested.association && nested.association.collection?
+        sti_key = model.sti_key.to_s
+        params = self.params # in new action sti_key must be in params
+        params = params[:record] || {} unless params[sti_key] # in create action must be inside record key
+        model = params.delete(sti_key).camelize.constantize if params[sti_key]
+      end
+      model.respond_to?(:build) ? model.build(build_options || {}) : model.new
+    end
+
+    private
+    def respond_to_action(action)
+      respond_to do |type|
+        action_formats.each do |format|
+          type.send(format){ send("#{action}_respond_to_#{format}") }
+        end
+      end
+    end
+
+    def action_formats
+      @action_formats ||= if respond_to? "#{action_name}_formats", true
+        send("#{action_name}_formats")
+      else
+        (default_formats + active_scaffold_config.formats).uniq
+      end
+    end
+
+    def response_code_for_rescue(exception)
+      case exception
+        when ActiveScaffold::RecordNotAllowed
+          "403 Record Not Allowed"
+        when ActiveScaffold::ActionNotAllowed
+          "403 Action Not Allowed"
+        else
+          super
+      end
+    end
+  end
+end

data/lib/active_scaffold/actions/create.rb

@@ -0,0 +1,148 @@
+module ActiveScaffold::Actions
+  module Create
+    def self.included(base)
+      base.before_filter :create_authorized_filter, :only => [:new, :create]
+    end
+
+    def new
+      do_new
+      respond_to_action(:new)
+    end
+
+    def create
+      do_create
+      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 action = active_scaffold_config.create.action_after_create
+            redirect_to params_for(:action => action, :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
+      if successful? && active_scaffold_config.create.refresh_list && !render_parent?
+        do_search if respond_to? :do_search
+        do_list
+      end
+      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.db.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
+          create_save
+        end
+      rescue ActiveRecord::RecordInvalid
+        flash[:error] = $!.message
+        self.successful = false
+      end
+    end
+
+    def create_save
+      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
+
+    # 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 ModelPermissions.
+    # You may override the method to customize.
+    
+    def create_ignore?
+      nested? && active_scaffold_config.list.always_show_create
+    end
+    
+    def create_authorized?
+      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,76 @@
+module ActiveScaffold::Actions
+  module Delete
+    def self.included(base)
+      base.before_filter :delete_authorized_filter, :only => [:destroy]
+    end
+
+    def destroy
+      params.delete :destroy_action
+      process_action_link_action(:destroy) do |record|
+        do_destroy
+      end
+    end
+
+    protected
+    def destroy_respond_to_html
+      if self.successful?
+        flash[:info] = as_(:deleted_model, :model => @record.to_label)
+      else
+        #error_message_for not available in controller...
+        #flash[:error] = active_scaffold_error_messages_for(@record, :object_name => "#{@record.class.model_name.human.downcase}#{@record.new? ? '' : ": #{@record.to_label}"}", :header_message => '', :message => "#{@record.class.model_name.human.downcase}#{@record.new? ? '' : ": #{@record.to_label}"}", :container_tag => nil, :list_type => :br)
+      end
+      return_to_main
+    end
+
+    def destroy_respond_to_js
+      if successful? && active_scaffold_config.delete.refresh_list && !render_parent?
+        do_search if respond_to? :do_search
+        do_list
+      end
+      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
+      @record ||= destroy_find_record
+      begin
+        self.successful = @record.destroy
+        marked_records.delete @record.id.to_s if successful?
+      rescue
+        flash[:warning] = as_(:cant_destroy_record, :record => @record.to_label)
+        self.successful = false
+      end
+    end
+
+    # The default security delegates to ModelPermissions.
+    # You may override the method to customize.
+    def delete_authorized?(record = nil)
+      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 = new_model
+      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.blank?
+        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,196 @@
+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
+      @record = find_if_allowed(params[:id], :read)
+      respond_to_action(:row)
+    end
+
+    def list
+      do_list
+      @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 => 'refresh_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
+    
+    def row_respond_to_html
+      render(:partial => 'row', :locals => {:record => @record})
+    end
+
+    # The actual algorithm to prepare for the list view
+    def set_includes_for_list_columns
+      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
+    end
+
+    # The actual algorithm to prepare for the list view
+    def do_list
+      set_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_page
+      _page = active_scaffold_config.list.user.page
+      do_search if respond_to? :do_search
+      active_scaffold_config.list.user.page = _page
+      do_list
+      @page.items.each {|record| yield record}
+    end
+
+    def each_record_in_scope
+      do_search if respond_to? :do_search
+      finder_options = { :order => "#{active_scaffold_config.model.connection.quote_table_name(active_scaffold_config.model.table_name)}.#{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 ModelPermissions.
+    # You may override the method to customize.
+    def list_authorized?
+      authorized_for?(:crud_type => :read)
+    end
+
+    # call this method in your action_link action to simplify processing of actions
+    # eg for member action_link :fire
+    # process_action_link_action do |record|
+    #   record.update_attributes(:fired => true)
+    #   self.successful = true
+    #   flash[:info] = 'Player fired'
+    # end
+    def process_action_link_action(render_action = :action_update, crud_type = nil)
+      if request.get?
+        # someone has disabled javascript, we have to show confirmation form first
+        @record = find_if_allowed(params[:id], :read) if params[:id] && params[:id] && params[:id].to_i > 0
+        respond_to_action(:action_confirmation)
+      else
+        if params[:id] && params[:id] && params[:id].to_i > 0
+          crud_type ||= (request.post? || request.put?) ? :update : :delete
+          @record = find_if_allowed(params[:id], crud_type)
+          unless @record.nil?
+            yield @record
+          else
+            self.successful = false
+            flash[:error] = as_(:no_authorization_for_action, :action => action_name)
+          end
+        else
+          yield
+        end
+        respond_to_action(render_action)
+      end
+    end
+
+    def action_confirmation_respond_to_html(confirm_action = action_name.to_sym)
+      link = active_scaffold_config.action_links[confirm_action]
+      render :action => 'action_confirmation', :locals => {:record => @record, :link => link}
+    end
+
+    def action_update_respond_to_html
+      do_search if respond_to? :do_search
+      do_list
+      redirect_to :action => 'index'
+    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
+    alias_method :index_formats, :list_formats
+
+    def row_formats
+      ([:html] + active_scaffold_config.formats + active_scaffold_config.list.formats).uniq
+    end
+
+    def action_update_formats
+      (default_formats + active_scaffold_config.formats).uniq
+    end
+
+    def action_confirmation_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