Module: Ransack::Adapters::ActiveRecord::Base
- Defined in:
- lib/ransack/adapters/active_record/base.rb
Class Method Summary collapse
Instance Method Summary collapse
- #ransack(params = {}, options = {}) ⇒ Object
- #ransack!(params = {}, options = {}) ⇒ Object
- #ransack_alias(new_name, old_name) ⇒ Object
-
#ransackable_associations(auth_object = nil) ⇒ Object
Ransackable_associations, by default, returns the names of all associations as an array of strings.
-
#ransackable_attributes(auth_object = nil) ⇒ Object
Ransackable_attributes, by default, returns all column names and any defined ransackers as an array of strings.
-
#ransackable_scopes(auth_object = nil) ⇒ Object
Ransackable_scopes, by default, returns an empty array i.e.
-
#ransackable_scopes_skip_sanitize_args ⇒ Object
ransack_scope_skip_sanitize_args, by default, returns an empty array.
- #ransacker(name, opts = {}, &block) ⇒ Object
-
#ransortable_attributes(auth_object = nil) ⇒ Object
Ransortable_attributes, by default, returns the names of all attributes available for sorting as an array of strings.
Class Method Details
.extended(base) ⇒ Object
6 7 8 9 10 11 12 13 14 |
# File 'lib/ransack/adapters/active_record/base.rb', line 6 def self.extended(base) alias :search :ransack unless base.respond_to? :search base.class_eval do class_attribute :_ransackers class_attribute :_ransack_aliases self._ransackers ||= {} self._ransack_aliases ||= {} end end |
Instance Method Details
#ransack(params = {}, options = {}) ⇒ Object
16 17 18 19 |
# File 'lib/ransack/adapters/active_record/base.rb', line 16 def ransack(params = {}, = {}) ActiveSupport::Deprecation.warn("#search is deprecated and will be removed in 2.3, please use #ransack instead") if __callee__ == :search Search.new(self, params, ) end |
#ransack!(params = {}, options = {}) ⇒ Object
21 22 23 |
# File 'lib/ransack/adapters/active_record/base.rb', line 21 def ransack!(params = {}, = {}) ransack(params, .merge(ignore_unknown_conditions: false)) end |
#ransack_alias(new_name, old_name) ⇒ Object
30 31 32 33 |
# File 'lib/ransack/adapters/active_record/base.rb', line 30 def ransack_alias(new_name, old_name) self._ransack_aliases = _ransack_aliases.merge new_name.to_s => old_name.to_s end |
#ransackable_associations(auth_object = nil) ⇒ Object
Ransackable_associations, by default, returns the names of all associations as an array of strings. For overriding with a whitelist array of strings.
52 53 54 |
# File 'lib/ransack/adapters/active_record/base.rb', line 52 def ransackable_associations(auth_object = nil) @ransackable_associations ||= reflect_on_all_associations.map { |a| a.name.to_s } end |
#ransackable_attributes(auth_object = nil) ⇒ Object
Ransackable_attributes, by default, returns all column names and any defined ransackers as an array of strings. For overriding with a whitelist array of strings.
39 40 41 42 43 44 45 46 |
# File 'lib/ransack/adapters/active_record/base.rb', line 39 def ransackable_attributes(auth_object = nil) @ransackable_attributes ||= if Ransack::SUPPORTS_ATTRIBUTE_ALIAS column_names + _ransackers.keys + _ransack_aliases.keys + attribute_aliases.keys else column_names + _ransackers.keys + _ransack_aliases.keys end end |
#ransackable_scopes(auth_object = nil) ⇒ Object
Ransackable_scopes, by default, returns an empty array i.e. no class methods/scopes are authorized. For overriding with a whitelist array of symbols.
68 69 70 |
# File 'lib/ransack/adapters/active_record/base.rb', line 68 def ransackable_scopes(auth_object = nil) [] end |
#ransackable_scopes_skip_sanitize_args ⇒ Object
ransack_scope_skip_sanitize_args, by default, returns an empty array. i.e. use the sanitize_scope_args setting to determin if args should be converted. For overriding with a list of scopes which should be passed the args as-is.
76 77 78 |
# File 'lib/ransack/adapters/active_record/base.rb', line 76 def ransackable_scopes_skip_sanitize_args [] end |
#ransacker(name, opts = {}, &block) ⇒ Object
25 26 27 28 |
# File 'lib/ransack/adapters/active_record/base.rb', line 25 def ransacker(name, opts = {}, &block) self._ransackers = _ransackers.merge name.to_s => Ransacker .new(self, name, opts, &block) end |
#ransortable_attributes(auth_object = nil) ⇒ Object
Ransortable_attributes, by default, returns the names of all attributes available for sorting as an array of strings. For overriding with a whitelist array of strings.
60 61 62 |
# File 'lib/ransack/adapters/active_record/base.rb', line 60 def ransortable_attributes(auth_object = nil) ransackable_attributes(auth_object) end |