Module: Ransack::Configuration

Included in:
Ransack
Defined in:
lib/ransack/configuration.rb

Instance Method Summary collapse

Instance Method Details

#add_predicate(name, opts = {}) ⇒ Object


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/ransack/configuration.rb', line 23

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

#arel_predicate_with_suffix(arel_predicate, suffix) ⇒ Object


137
138
139
140
141
142
143
# File 'lib/ransack/configuration.rb', line 137

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

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:


19
20
21
# File 'lib/ransack/configuration.rb', line 19

def configure
  yield self
end

#custom_arrows=(opts = {}) ⇒ Object

By default, Ransack displays sort order indicator arrows with HTML codes:

up_arrow:   '▼'
down_arrow: '▲'

There is also a default arrow which is displayed if a column is not sorted. By default this is nil so nothing will be displayed.

Any of the defaults may be globally overridden in an initializer file like `config/initializers/ransack.rb` as follows:

Ransack.configure do |config|

# Globally set the up arrow to an icon, and the down and default arrows to unicode.
config.custom_arrows = {
  up_arrow:   '<i class="fa fa-long-arrow-up"></i>',
  down_arrow: 'U+02193',
  default_arrow: 'U+11047'
}

end


102
103
104
105
106
# File 'lib/ransack/configuration.rb', line 102

def custom_arrows=(opts = {})
  self.options[:up_arrow] = opts[:up_arrow].freeze if opts[:up_arrow]
  self.options[:down_arrow] = opts[:down_arrow].freeze if opts[:down_arrow]
  self.options[:default_arrow] = opts[:default_arrow].freeze if opts[:default_arrow]
end

#hide_sort_order_indicators=(boolean) ⇒ Object

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


133
134
135
# File 'lib/ransack/configuration.rb', line 133

def hide_sort_order_indicators=(boolean)
  self.options[:hide_sort_order_indicators] = boolean
end

#ignore_unknown_conditions=(boolean) ⇒ Object

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


78
79
80
# File 'lib/ransack/configuration.rb', line 78

def ignore_unknown_conditions=(boolean)
  self.options[:ignore_unknown_conditions] = boolean
end

#sanitize_custom_scope_booleans=(boolean) ⇒ Object

Ransack sanitizes many values in your custom scopes into booleans.

1, '1', 't', 'T', 'true', 'TRUE'

all evaluate to true.

0, '0', 'f', 'F', 'false', 'FALSE'

all evaluate to false.

This default may be globally overridden in an initializer file like `config/initializers/ransack.rb` as follows:

Ransack.configure do |config|

# Accept my custom scope values as what they are.
config.sanitize_custom_scope_booleans = false

end


120
121
122
# File 'lib/ransack/configuration.rb', line 120

def sanitize_custom_scope_booleans=(boolean)
  self.options[:sanitize_scope_args] = boolean
end

#search_key=(name) ⇒ Object

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: In the view: <%= f.search_form_for @search, as: :log_search %>


65
66
67
# File 'lib/ransack/configuration.rb', line 65

def search_key=(name)
  self.options[:search_key] = name
end