active_scaffold_vho 3.0.6

data/lib/active_scaffold/data_structures/sorting.rb

@@ -0,0 +1,168 @@
+module ActiveScaffold::DataStructures
+  # encapsulates the column sorting configuration for the List view
+  class Sorting
+    include Enumerable
+
+    def initialize(columns)
+      @columns = columns
+      @clauses = []
+    end
+    
+    def set_default_sorting(model)
+      model_scope = model.send(:current_scoped_methods)
+      order_clause = model_scope.arel.order_clauses.join(",") if model_scope
+
+      # If an ORDER BY clause is found set default sorting according to it, else
+      # fallback to setting primary key ordering
+      if order_clause
+        set_sorting_from_order_clause(order_clause, model.table_name)
+        @default_sorting = true
+      else
+        set(model.primary_key, 'ASC') if model.column_names.include?(model.primary_key)
+      end
+    end
+
+    def set_nested_sorting(table_name, order_clause)
+      clear
+      set_sorting_from_order_clause(order_clause, table_name)
+    end
+    
+    # add a clause to the sorting, assuming the column is sortable
+    def add(column_name, direction = nil)
+      direction ||= 'ASC'
+      direction = direction.to_s.upcase
+      column = get_column(column_name)
+      raise ArgumentError, "Could not find column #{column_name}" if column.nil?
+      raise ArgumentError, "Sorting direction unknown" unless [:ASC, :DESC].include? direction.to_sym
+      @clauses << [column, direction] if column.sortable?
+      raise ArgumentError, "Can't mix :method- and :sql-based sorting" if mixed_sorting?
+    end
+
+    # an alias for +add+. must accept its arguments in a slightly different form, though.
+    def <<(arg)
+      add(*arg)
+    end
+
+    # clears the sorting before setting to the given column/direction
+    def set(*args)
+      clear
+      add(*args)
+    end
+
+    # clears the sorting
+    def clear
+      @default_sorting = false
+      @clauses = []
+    end
+
+    # checks whether the given column (a Column object or a column name) is in the sorting
+    def sorts_on?(column)
+      !get_clause(column).nil?
+    end
+
+    def direction_of(column)
+      clause = get_clause(column)
+      return if clause.nil?
+      clause[1]
+    end
+
+    # checks whether any column is configured to sort by method (using a proc)
+    def sorts_by_method?
+      @clauses.any? { |sorting| sorting[0].sort.is_a? Hash and sorting[0].sort.has_key? :method }
+    end
+
+    def sorts_by_sql?
+      @clauses.any? { |sorting| sorting[0].sort.is_a? Hash and sorting[0].sort.has_key? :sql }
+    end
+
+    # iterate over the clauses
+    def each
+      @clauses.each { |clause| yield clause }
+    end
+
+    # provides quick access to the first (and sometimes only) clause
+    def first
+      @clauses.first
+    end
+
+    # builds an order-by clause
+    def clause
+      return nil if sorts_by_method? || default_sorting?
+
+      # unless the sorting is by method, create the sql string
+      order = []
+      each do |sort_column, sort_direction|
+        sql = sort_column.sort[:sql]
+        next if sql.nil? or sql.empty?
+
+        order << "#{sql} #{sort_direction}"
+      end
+
+      order.join(', ') unless order.empty?
+    end
+
+    protected
+
+    # retrieves the sorting clause for the given column
+    def get_clause(column)
+      column = get_column(column)
+      @clauses.find{ |clause| clause[0] == column}
+    end
+
+    # possibly converts the given argument into a column object from @columns (if it's not already)
+    def get_column(name_or_column)
+      # it's a column
+      return name_or_column if name_or_column.is_a? ActiveScaffold::DataStructures::Column
+      # it's a name
+      name_or_column = name_or_column.to_s.split('.').last if name_or_column.to_s.include? '.'
+      return @columns[name_or_column]
+    end
+
+    def mixed_sorting?
+      sorts_by_method? and sorts_by_sql?
+    end
+    
+    def default_sorting?
+      @default_sorting
+    end
+
+    def set_sorting_from_order_clause(order_clause, model_table_name = nil)
+      clear
+      order_clause.split(',').each do |criterion|
+        unless criterion.blank?
+          order_parts = extract_order_parts(criterion)
+          add(order_parts[:column_name], order_parts[:direction]) unless different_table?(model_table_name, order_parts[:table_name])
+        end
+      end
+    end
+    
+    def extract_order_parts(criterion_parts)
+      column_name_part, direction_part = criterion_parts.strip.split(' ')
+      column_name_parts = column_name_part.split('.')
+      order = {:direction => extract_direction(direction_part),
+        :column_name => remove_quotes(column_name_parts.last)}
+      order[:table_name] = remove_quotes(column_name_parts[-2]) if column_name_parts.length >= 2
+      order
+    end
+    
+    def different_table?(model_table_name, order_table_name)
+      !order_table_name.nil? && model_table_name != order_table_name
+    end
+    
+    def remove_quotes(sql_name)
+      if sql_name.starts_with?('"') || sql_name.starts_with?('`')
+        sql_name[1, (sql_name.length - 2)]
+      else
+        sql_name
+      end
+    end
+    
+    def extract_direction(direction_part)
+      if direction_part.to_s.upcase == 'DESC'
+        'DESC'
+      else
+        'ASC'
+      end
+    end
+  end
+end

data/lib/active_scaffold/finder.rb

@@ -0,0 +1,333 @@
+module ActiveScaffold
+  module Finder
+    module ClassMethods
+      # Takes a collection of search terms (the tokens) and creates SQL that
+      # searches all specified ActiveScaffold columns. A row will match if each
+      # token is found in at least one of the columns.
+      def create_conditions_for_columns(tokens, columns, text_search = :full)
+        # if there aren't any columns, then just return a nil condition
+        return unless columns.length > 0
+        like_pattern = like_pattern(text_search)
+
+        tokens = [tokens] if tokens.is_a? String
+
+        where_clauses = []
+        columns.each do |column|
+          where_clauses << ((column.column.nil? || column.column.text?) ? "LOWER(#{column.search_sql}) LIKE ?" : "#{column.search_sql} = ?")
+        end
+        phrase = "(#{where_clauses.join(' OR ')})"
+
+        sql = ([phrase] * tokens.length).join(' AND ')
+        tokens = tokens.collect do |value|
+          columns.collect {|column| (column.column.nil? || column.column.text?) ? like_pattern.sub('?', value.downcase) : column.column.type_cast(value)}
+        end.flatten
+
+        [sql, *tokens]
+      end
+
+      # Generates an SQL condition for the given ActiveScaffold column based on
+      # that column's database type (or form_ui ... for virtual columns?).
+      # TODO: this should reside on the column, not the controller
+      def condition_for_column(column, value, text_search = :full)
+        like_pattern = like_pattern(text_search)
+        return unless column and column.search_sql and not value.blank?
+        search_ui = column.search_ui || column.column.type
+        begin
+          if self.respond_to?("condition_for_#{column.name}_column")
+            self.send("condition_for_#{column.name}_column", column, value, like_pattern)
+          elsif self.respond_to?("condition_for_#{search_ui}_type")
+            self.send("condition_for_#{search_ui}_type", column, value, like_pattern)
+          else
+            unless column.search_sql.instance_of? Proc
+              case search_ui
+                when :boolean, :checkbox
+                  ["#{column.search_sql} = ?", column.column.type_cast(value)]
+                when :integer, :decimal, :float
+                  condition_for_numeric(column, value)
+                when :string, :range
+                  condition_for_range(column, value, like_pattern)
+                when :date, :time, :datetime, :timestamp
+                  condition_for_datetime(column, value)
+                when :select, :multi_select, :country, :usa_state
+                ["#{column.search_sql} in (?)", Array(value)]
+                else
+                  if column.column.nil? || column.column.text?
+                    ["LOWER(#{column.search_sql}) LIKE ?", like_pattern.sub('?', value.downcase)]
+                  else
+                    ["#{column.search_sql} = ?", column.column.type_cast(value)]
+                  end
+              end
+            else
+              column.search_sql.call(value)
+            end
+          end
+        rescue Exception => e
+          logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column :#{column.name}, search_ui = #{search_ui} in #{@controller.class}"
+          raise e
+        end
+      end
+
+      def condition_for_numeric(column, value)
+        if !value.is_a?(Hash)
+          ["#{column.search_sql} = ?", condition_value_for_numeric(column, value)]
+        elsif value[:from].blank? or not ActiveScaffold::Finder::NumericComparators.include?(value[:opt])
+          nil
+        elsif value[:opt] == 'BETWEEN'
+          ["#{column.search_sql} BETWEEN ? AND ?", condition_value_for_numeric(column, value[:from]), condition_value_for_numeric(column, value[:to])]
+         else
+          ["#{column.search_sql} #{value[:opt]} ?", condition_value_for_numeric(column, value[:from])]
+        end
+      end
+
+      def condition_for_range(column, value, like_pattern = nil)
+        if !value.is_a?(Hash)
+          if column.column.nil? || column.column.text?
+            ["LOWER(#{column.search_sql}) LIKE ?", like_pattern.sub('?', value.downcase)]
+          else
+            ["#{column.search_sql} = ?", column.column.type_cast(value)]
+          end
+        elsif value[:from].blank?
+          nil
+        elsif ActiveScaffold::Finder::StringComparators.values.include?(value[:opt])
+          ["#{column.search_sql} LIKE ?", value[:opt].sub('?', value[:from])]
+        elsif value[:opt] == 'BETWEEN'
+          ["#{column.search_sql} BETWEEN ? AND ?", value[:from], value[:to]]
+        elsif ActiveScaffold::Finder::NumericComparators.include?(value[:opt])
+          ["#{column.search_sql} #{value[:opt]} ?", value[:from]]
+        else
+          nil
+        end
+      end
+      
+      def condition_value_for_datetime(value, conversion = :to_time)
+        if value.is_a? Hash
+          Time.zone.local(*[:year, :month, :day, :hour, :minute, :second].collect {|part| value[field][part].to_i}) rescue nil
+        elsif value.respond_to?(:strftime)
+          value.send(conversion)
+        else
+          Time.zone.parse(value).in_time_zone.send(conversion) rescue nil
+        end unless value.nil? || value.blank?
+      end
+
+      def condition_value_for_numeric(column, value)
+        return value if value.nil?
+        value = i18n_number_to_native_format(value) if [:i18n_number, :currency].include?(column.options[:format])
+        case (column.search_ui || column.column.type)
+        when :integer   then value.to_i rescue value ? 1 : 0
+        when :float     then value.to_f
+        when :decimal   then ActiveRecord::ConnectionAdapters::Column.value_to_decimal(value)
+        else
+          value
+        end
+      end
+
+      def i18n_number_to_native_format(value)
+        native = '.'
+        delimiter = I18n.t('number.format.delimiter')
+        separator = I18n.t('number.format.separator')
+        return value if value.blank? || !value.is_a?(String)
+        unless delimiter == native && !value.include?(separator) && value !~ /\.\d{3}$/
+          value.gsub(/[^0-9\-#{I18n.t('number.format.separator')}]/, '').gsub(I18n.t('number.format.separator'), native)
+        else
+          value
+        end
+      end
+            
+      def condition_for_datetime(column, value, like_pattern = nil)
+        conversion = column.column.type == :date ? :to_date : :to_time
+        from_value = condition_value_for_datetime(value[:from], conversion)
+        to_value = condition_value_for_datetime(value[:to], conversion)
+
+        if from_value.nil? and to_value.nil?
+          nil
+        elsif !from_value
+          ["#{column.search_sql} <= ?", to_value.to_s(:db)]
+        elsif !to_value
+          ["#{column.search_sql} >= ?", from_value.to_s(:db)]
+        else
+          ["#{column.search_sql} BETWEEN ? AND ?", from_value.to_s(:db), to_value.to_s(:db)]
+        end
+      end
+
+      def condition_for_record_select_type(column, value, like_pattern = nil)
+        if value.is_a?(Array)
+          ["#{column.search_sql} IN (?)", value]
+        else
+          ["#{column.search_sql} = ?", value]
+        end
+      end
+      
+      def condition_for_null_type(column, value, like_pattern = nil)
+        case value.to_sym
+        when :null
+          ["#{column.search_sql} is null"]
+        when :not_null
+          ["#{column.search_sql} is not null"]
+        else
+          nil
+        end
+      end
+
+      def like_pattern(text_search)
+        case text_search
+          when :full then '%?%'
+          when :start then '?%'
+          when :end then '%?'
+          else '?'
+        end
+      end
+    end
+
+    NumericComparators = [
+      '=',
+      '>=',
+      '<=',
+      '>',
+      '<',
+      '!=',
+      'BETWEEN'
+    ]
+    StringComparators = {
+      :contains    => '%?%',
+      :begins_with => '?%',
+      :ends_with   => '%?'
+    }
+    NullComparators = [
+      :null,
+      :not_null
+    ]
+    
+    
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    protected
+
+    attr_writer :active_scaffold_conditions
+    def active_scaffold_conditions
+      @active_scaffold_conditions ||= []
+    end
+
+    attr_writer :active_scaffold_includes
+    def active_scaffold_includes
+      @active_scaffold_includes ||= []
+    end
+
+    attr_writer :active_scaffold_habtm_joins
+    def active_scaffold_habtm_joins
+      @active_scaffold_habtm_joins ||= []
+    end
+    
+    def all_conditions
+      merge_conditions(
+        active_scaffold_conditions,                   # from the search modules
+        conditions_for_collection,                    # from the dev
+        conditions_from_params,                       # from the parameters (e.g. /users/list?first_name=Fred)
+        conditions_from_constraints,                  # from any constraints (embedded scaffolds)
+        active_scaffold_session_storage[:conditions] # embedding conditions (weaker constraints)
+      )
+    end
+    
+    # returns a single record (the given id) but only if it's allowed for the specified action.
+    # accomplishes this by checking model.#{action}_authorized?
+    # TODO: this should reside on the model, not the controller
+    def find_if_allowed(id, crud_type, klass = beginning_of_chain)
+      record = klass.find(id)
+      raise ActiveScaffold::RecordNotAllowed, "#{klass} with id = #{id}" unless record.authorized_for?(:crud_type => crud_type.to_sym)
+      return record
+    end
+
+    # returns a Paginator::Page (not from ActiveRecord::Paginator) for the given parameters
+    # options may include:
+    # * :sorting - a Sorting DataStructure (basically an array of hashes of field => direction, e.g. [{:field1 => 'asc'}, {:field2 => 'desc'}]). please note that multi-column sorting has some limitations: if any column in a multi-field sort uses method-based sorting, it will be ignored. method sorting only works for single-column sorting.
+    # * :per_page
+    # * :page
+    # TODO: this should reside on the model, not the controller
+    def find_page(options = {})
+      options.assert_valid_keys :sorting, :per_page, :page, :count_includes, :pagination
+
+      search_conditions = all_conditions
+      full_includes = (active_scaffold_includes.blank? ? nil : active_scaffold_includes)
+      options[:per_page] ||= 999999999
+      options[:page] ||= 1
+      options[:count_includes] ||= full_includes unless search_conditions.nil?
+
+      klass = beginning_of_chain
+      
+      # create a general-use options array that's compatible with Rails finders
+      finder_options = { :order => options[:sorting].try(:clause),
+                         :where => search_conditions,
+                         :joins => joins_for_finder,
+                         :includes => options[:count_includes]}
+                         
+      finder_options.merge! custom_finder_options
+
+      # NOTE: we must use :include in the count query, because some conditions may reference other tables
+      count_query = append_to_query(klass, finder_options.reject{|k, v| [:select, :order].include?(k)})
+      count = count_query.count unless options[:pagination] == :infinite
+  
+      # Converts count to an integer if ActiveRecord returned an OrderedHash
+      # that happens when finder_options contains a :group key
+      count = count.length if count.is_a? ActiveSupport::OrderedHash
+      finder_options.merge! :includes => full_includes
+
+      # we build the paginator differently for method- and sql-based sorting
+      if options[:sorting] and options[:sorting].sorts_by_method?
+        pager = ::Paginator.new(count, options[:per_page]) do |offset, per_page|
+          sorted_collection = sort_collection_by_column(append_to_query(klass, finder_options).all, *options[:sorting].first)
+          sorted_collection = sorted_collection.slice(offset, per_page) if options[:pagination]
+          sorted_collection
+        end
+      else
+        pager = ::Paginator.new(count, options[:per_page]) do |offset, per_page|
+          finder_options.merge!(:offset => offset, :limit => per_page) if options[:pagination]
+          append_to_query(klass, finder_options).all
+        end
+      end
+      pager.page(options[:page])
+    end
+    
+    def append_to_query(query, options)
+      options.assert_valid_keys :where, :select, :group, :order, :limit, :offset, :joins, :includes, :lock, :readonly, :from
+      options.reject{|k, v| v.blank?}.inject(query) do |query, (k, v)|
+        query.send((k.to_sym), v) 
+      end
+    end
+
+    def joins_for_finder
+      case joins_for_collection
+        when String
+          [ joins_for_collection ]
+        when Array
+          joins_for_collection
+        else
+          []
+      end + active_scaffold_habtm_joins
+    end
+    
+    def merge_conditions(*conditions)
+      segments = []
+      conditions.each do |condition|
+        unless condition.blank?
+          sql = active_scaffold_config.model.send(:sanitize_sql, condition)
+          segments << sql unless sql.blank?
+        end
+      end
+      "(#{segments.join(') AND (')})" unless segments.empty?
+    end
+
+    # TODO: this should reside on the column, not the controller
+    def sort_collection_by_column(collection, column, order)
+      sorter = column.sort[:method]
+      collection = collection.sort_by { |record|
+        value = (sorter.is_a? Proc) ? record.instance_eval(&sorter) : record.instance_eval(sorter)
+        value = '' if value.nil?
+        value
+      }
+      collection.reverse! if order.downcase == 'desc'
+      collection
+    end
+  end
+end

data/lib/active_scaffold/helpers/association_helpers.rb

@@ -0,0 +1,40 @@
+module ActiveScaffold
+  module Helpers
+    module AssociationHelpers
+      # Provides a way to honor the :conditions on an association while searching the association's klass
+      def association_options_find(association, conditions = nil)
+        association.klass.where(conditions).where(association.options[:conditions]).all
+      end
+
+      def association_options_count(association, conditions = nil)
+        association.klass.where(conditions).where(association.options[:conditions]).count
+      end
+
+      # returns options for the given association as a collection of [id, label] pairs intended for the +options_for_select+ helper.
+      def options_for_association(association, include_all = false)
+        available_records = association_options_find(association, include_all ? nil : options_for_association_conditions(association))
+        available_records ||= []
+        available_records.sort{|a,b| a.to_label <=> b.to_label}.collect { |model| [ model.to_label, model.id ] }
+      end
+
+      def options_for_association_count(association)
+        association_options_count(association, options_for_association_conditions(association))
+      end
+
+      # A useful override for customizing the records present in an association dropdown.
+      # Should work in both the subform and form_ui=>:select modes.
+      # Check association.name to specialize the conditions per-column.
+      def options_for_association_conditions(association)
+        return nil if association.options[:through]
+        case association.macro
+          when :has_one, :has_many
+            # Find only orphaned objects
+            "#{association.primary_key_name} IS NULL"
+          when :belongs_to, :has_and_belongs_to_many
+            # Find all
+            nil
+        end
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/controller_helpers.rb

@@ -0,0 +1,82 @@
+module ActiveScaffold
+  module Helpers
+    module ControllerHelpers
+      def self.included(controller)
+        controller.class_eval { helper_method :params_for, :main_path_to_return, :render_parent?, :render_parent_options, :render_parent_action}
+      end
+      
+      include ActiveScaffold::Helpers::IdHelpers
+      
+      def params_for(options = {})
+        # :adapter and :position are one-use rendering arguments. they should not propagate.
+        # :sort, :sort_direction, and :page are arguments that stored in the session. they need not propagate.
+        # and wow. no we don't want to propagate :record.
+        # :commit is a special rails variable for form buttons
+        blacklist = [:adapter, :position, :sort, :sort_direction, :page, :record, :commit, :_method, :authenticity_token, :iframe]
+        unless @params_for
+          @params_for = {}
+          params.select { |key, value| blacklist.exclude? key.to_sym if key }.each {|key, value| @params_for[key.to_sym] = value.duplicable? ? value.clone : value}
+          @params_for[:controller] = '/' + @params_for[:controller].to_s unless @params_for[:controller].to_s.first(1) == '/' # for namespaced controllers
+          @params_for.delete(:id) if @params_for[:id].nil?
+        end
+        @params_for.merge(options)
+      end
+
+      # Parameters to generate url to the main page (override if the ActiveScaffold is used as a component on another controllers page)
+      def main_path_to_return
+        if params[:return_to]
+          params[:return_to]
+        else
+          parameters = {}
+          if params[:parent_controller]
+            parameters[:controller] = params[:parent_controller]
+            parameters[:eid] = params[:parent_controller]
+          end
+          if nested?
+            parameters[:controller] = nested.parent_scaffold.controller_path
+            parameters[:eid] = nil
+          end
+          if params[:parent_sti]
+            parameters[:controller] = params[:parent_sti]
+            parameters[:eid] = nil
+          end
+          parameters[:parent_column] = nil
+          parameters[:parent_id] = nil
+          parameters[:action] = "index"
+          parameters[:id] = nil
+          parameters[:associated_id] = nil
+          parameters[:utf8] = nil
+          params_for(parameters)
+        end
+      end
+
+      def render_parent?
+        (nested? && (nested.belongs_to? || nested.has_one?) || params[:parent_sti])
+      end
+
+      def render_parent_options
+        if nested?
+          {:controller => nested.parent_scaffold.controller_path, :action => :row, :id => nested.parent_id}
+        elsif params[:parent_sti]
+          options = {:controller => params[:parent_sti], :action => render_parent_action(params[:parent_sti])}
+          if render_parent_action(params[:parent_sti]) == :index
+            options
+          else
+            options.merge({:id => @record.id})
+          end
+        end
+      end
+
+      def render_parent_action(controller_path = nil)
+        begin
+          @parent_action = :row
+          parent_controller = "#{controller_path.to_s.camelize}Controller".constantize
+          @parent_action = :index if action_name == 'create' && parent_controller.active_scaffold_config.actions.include?(:create) && parent_controller.active_scaffold_config.create.refresh_list == true
+          @parent_action = :index if action_name == 'update' && parent_controller.active_scaffold_config.actions.include?(:update) && parent_controller.active_scaffold_config.update.refresh_list == true
+        rescue ActiveScaffold::ControllerNotFound
+        end if @parent_action.nil?
+        @parent_action
+      end
+    end
+  end
+end