# File lib/active_scaffold/finder.rb, line 281 def active_scaffold_conditions @active_scaffold_conditions ||= [] end
# File lib/active_scaffold/finder.rb, line 291 def active_scaffold_habtm_joins @active_scaffold_habtm_joins ||= [] end
# File lib/active_scaffold/finder.rb, line 286 def active_scaffold_includes @active_scaffold_includes ||= [] end
# File lib/active_scaffold/finder.rb, line 296 def active_scaffold_outer_joins @active_scaffold_outer_joins ||= [] end
# File lib/active_scaffold/finder.rb, line 300 def all_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) ].reject(&:blank?) end
# File lib/active_scaffold/finder.rb, line 401 def append_to_query(query, options) options.assert_valid_keys :where, :select, :group, :reorder, :limit, :offset, :joins, :outer_joins, :includes, :lock, :readonly, :from, :conditions query = apply_conditions(query, *options[:conditions]) if options[:conditions] options.reject{|k, v| k == :conditions || v.blank?}.inject(query) do |query, (k, v)| query.send((k.to_sym), v) end end
# File lib/active_scaffold/finder.rb, line 420 def apply_conditions(query, *conditions) conditions.reject(&:blank?).inject(query) do |query, condition| if condition.is_a?(Array) && !condition.first.is_a?(String) # multiple conditions apply_conditions(query, *condition) else query.where(condition) end end end
# File lib/active_scaffold/finder.rb, line 387 def calculate_query conditions = all_conditions includes = active_scaffold_config.list.count_includes includes ||= active_scaffold_includes unless conditions.blank? primary_key = active_scaffold_config.model.primary_key subquery = append_to_query(beginning_of_chain, :conditions => conditions, :joins => joins_for_finder, :outer_joins => active_scaffold_outer_joins) subquery = subquery.select(active_scaffold_config.columns[primary_key].field) if includes includes_relation = beginning_of_chain.includes(includes) subquery = subquery.send(:apply_join_dependency, subquery, includes_relation.send(:construct_join_dependency_for_association_find)) end active_scaffold_config.model.where(primary_key => subquery) end
# File lib/active_scaffold/finder.rb, line 340 def count_items(find_options = {}, count_includes = nil) count_includes ||= find_options[:includes] unless find_options[:conditions].blank? options = find_options.reject{|k,v| [:select, :reorder].include? k} options[:includes] = count_includes # NOTE: we must use :include in the count query, because some conditions may reference other tables count_query = append_to_query(beginning_of_chain, options) count = count_query.count(:distinct => true) # Converts count to an integer if ActiveRecord returned an OrderedHash # that happens when find_options contains a :group key count = count.length if count.is_a? ActiveSupport::OrderedHash count end
returns a single record (the given id) but only if it's allowed for the specified security options. security options can be a hash for authorized_for? method or a value to check as a :crud_type accomplishes this by checking model.#{action}_authorized? TODO: this should reside on the model, not the controller
# File lib/active_scaffold/finder.rb, line 314 def find_if_allowed(id, security_options, klass = beginning_of_chain) record = klass.find(id) security_options = {:crud_type => security_options.to_sym} unless security_options.is_a? Hash raise ActiveScaffold::RecordNotAllowed, "#{klass} with id = #{id}" unless record.authorized_for? security_options return record end
returns a Paginator::Page (not from ActiveRecord::Paginator) for the given parameters See finder_options for valid options
# File lib/active_scaffold/finder.rb, line 357 def find_page(options = {}) options.assert_valid_keys :sorting, :per_page, :page, :count_includes, :pagination, :select options[:per_page] ||= 999999999 options[:page] ||= 1 find_options = finder_options(options) # NOTE: we must use :include in the count query, because some conditions may reference other tables if options[:pagination] && options[:pagination] != :infinite count = count_items(find_options, options[:count_includes]) end klass = beginning_of_chain klass = klass.uniq if find_options[:outer_joins].present? # 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, find_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| find_options.merge!(:offset => offset, :limit => per_page) if options[:pagination] append_to_query(klass, find_options) end end pager.page(options[:page]) end
valid 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
# File lib/active_scaffold/finder.rb, line 324 def finder_options(options = {}) search_conditions = all_conditions full_includes = (active_scaffold_includes.blank? ? nil : active_scaffold_includes) # create a general-use options array that's compatible with Rails finders finder_options = { :reorder => options[:sorting].try(:clause), :conditions => search_conditions, :joins => joins_for_finder, :outer_joins => active_scaffold_outer_joins, :includes => full_includes, :select => options[:select]} finder_options.merge! custom_finder_options finder_options end
# File lib/active_scaffold/finder.rb, line 409 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
TODO: this should reside on the column, not the controller
# File lib/active_scaffold/finder.rb, line 431 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.to_s) value = '' if value.nil? value } collection.reverse! if order.downcase == 'desc' collection end
Generated with the Darkfish Rdoc Generator 2.