1
0
Fork 0
mirror of https://github.com/activerecord-hackery/ransack.git synced 2022-11-09 13:47:45 -05:00
activerecord-hackery--ransack/lib/ransack/configuration.rb
2015-08-28 00:00:42 +02:00

100 lines
3.1 KiB
Ruby

require 'ransack/constants'
require 'ransack/predicate'
module Ransack
module Configuration
mattr_accessor :predicates, :options
self.predicates = {}
self.options = {
:search_key => :q,
:ignore_unknown_conditions => true,
:hide_sort_order_indicators => false
}
def configure
yield self
end
def add_predicate(name, opts = {})
name = name.to_s
opts[:name] = name
compounds = opts.delete(:compounds)
compounds = true if compounds.nil?
compounds = false if opts[:wants_array]
self.predicates[name] = Predicate.new(opts)
Constants::SUFFIXES.each do |suffix|
compound_name = name + suffix
self.predicates[compound_name] = Predicate.new(
opts.merge(
:name => compound_name,
:arel_predicate => arel_predicate_with_suffix(
opts[:arel_predicate], suffix
),
:compound => true
)
)
end if compounds
end
# The default `search_key` name is `:q`. The default key may be overridden
# in an initializer file like `config/initializers/ransack.rb` as follows:
#
# Ransack.configure do |config|
# # Name the search_key `:query` instead of the default `:q`
# config.search_key = :query
# end
#
# Sometimes there are situations when the default search parameter name
# cannot be used, for instance if there were two searches on one page.
# Another name can be set using the `search_key` option with Ransack
# `ransack`, `search` and `@search_form_for` methods in controllers & views.
#
# In the controller:
# @search = Log.ransack(params[:log_search], search_key: :log_search)
#
# In the view:
# <%= f.search_form_for @search, as: :log_search %>
#
def search_key=(name)
self.options[:search_key] = name
end
# By default Ransack ignores errors if an unknown predicate, condition or
# attribute is passed into a search. The default may be overridden in an
# initializer file like `config/initializers/ransack.rb` as follows:
#
# Ransack.configure do |config|
# # Raise if an unknown predicate, condition or attribute is passed
# config.ignore_unknown_conditions = false
# end
#
def ignore_unknown_conditions=(boolean)
self.options[:ignore_unknown_conditions] = boolean
end
# By default, Ransack displays sort order indicator arrows in sort links.
# The default may be globally overridden in an initializer file like
# `config/initializers/ransack.rb` as follows:
#
# Ransack.configure do |config|
# # Hide sort link order indicators globally across the application
# config.hide_sort_order_indicators = true
# end
#
def hide_sort_order_indicators=(boolean)
self.options[:hide_sort_order_indicators] = boolean
end
def arel_predicate_with_suffix(arel_predicate, suffix)
if arel_predicate === Proc
proc { |v| "#{arel_predicate.call(v)}#{suffix}" }
else
"#{arel_predicate}#{suffix}"
end
end
end
end