Class: Ransack::Context
- Inherits:
-
Object
show all
- Defined in:
- lib/ransack/context.rb
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(object, options = {}) ⇒ Context
Returns a new instance of Context.
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# File 'lib/ransack/context.rb', line 33
def initialize(object, options = {})
@object = relation_for(object)
@klass = @object.klass
@join_dependency = join_dependency(@object)
@join_type = options[:join_type] || Polyamorous::OuterJoin
@search_key = options[:search_key] || Ransack.options[:search_key]
if ::ActiveRecord::VERSION::STRING >= "4.1".freeze
@base = @join_dependency.join_root
@engine = @base.base_klass.arel_engine
else
@base = @join_dependency.join_base
@engine = @base.arel_engine
end
@default_table = Arel::Table.new(
@base.table_name, :as => @base.aliased_table_name, :engine => @engine
)
@bind_pairs = Hash.new do |hash, key|
parent, attr_name = get_parent_and_attribute_name(key.to_s)
if parent && attr_name
hash[key] = [parent, attr_name]
end
end
end
|
Instance Attribute Details
#arel_visitor ⇒ Object
Returns the value of attribute arel_visitor.
5
6
7
|
# File 'lib/ransack/context.rb', line 5
def arel_visitor
@arel_visitor
end
|
#auth_object ⇒ Object
Returns the value of attribute auth_object.
6
7
8
|
# File 'lib/ransack/context.rb', line 6
def auth_object
@auth_object
end
|
#base ⇒ Object
Returns the value of attribute base.
5
6
7
|
# File 'lib/ransack/context.rb', line 5
def base
@base
end
|
#engine ⇒ Object
Returns the value of attribute engine.
5
6
7
|
# File 'lib/ransack/context.rb', line 5
def engine
@engine
end
|
#klass ⇒ Object
Returns the value of attribute klass.
5
6
7
|
# File 'lib/ransack/context.rb', line 5
def klass
@klass
end
|
#object ⇒ Object
Returns the value of attribute object.
5
6
7
|
# File 'lib/ransack/context.rb', line 5
def object
@object
end
|
#search_key ⇒ Object
Returns the value of attribute search_key.
6
7
8
|
# File 'lib/ransack/context.rb', line 6
def search_key
@search_key
end
|
Class Method Details
.for(object, options = {}) ⇒ Object
10
11
12
13
14
15
16
|
# File 'lib/ransack/context.rb', line 10
def for(object, options = {})
context = Class === object ?
for_class(object, options) :
for_object(object, options)
context or raise ArgumentError,
"Don't know what context to use for #{object}"
end
|
.for_class(klass, options = {}) ⇒ Object
18
19
20
21
22
|
# File 'lib/ransack/context.rb', line 18
def for_class(klass, options = {})
if klass < ActiveRecord::Base
Adapters::ActiveRecord::Context.new(klass, options)
end
end
|
.for_object(object, options = {}) ⇒ Object
24
25
26
27
28
29
|
# File 'lib/ransack/context.rb', line 24
def for_object(object, options = {})
case object
when ActiveRecord::Relation
Adapters::ActiveRecord::Context.new(object.klass, options)
end
end
|
Instance Method Details
#association_path(str, base = @base) ⇒ Object
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
# File 'lib/ransack/context.rb', line 124
def association_path(str, base = @base)
base = klassify(base)
str ||= Ransack::Constants::EMPTY
path = []
segments = str.split(/_/)
association_parts = []
if (segments = str.split(/_/)).size > 0
while segments.size > 0 &&
!base.columns_hash[segments.join(Ransack::Constants::UNDERSCORE)] &&
association_parts << segments.shift do
assoc, klass = unpolymorphize_association(
association_parts.join(Ransack::Constants::UNDERSCORE)
)
if found_assoc = get_association(assoc, base)
path += association_parts
association_parts = []
base = klassify(klass || found_assoc)
end
end
end
path.join(Ransack::Constants::UNDERSCORE)
end
|
#bind(object, str) ⇒ Object
93
94
95
|
# File 'lib/ransack/context.rb', line 93
def bind(object, str)
object.parent, object.attr_name = @bind_pairs[str]
end
|
#chain_scope(scope, args) ⇒ Object
80
81
82
83
84
85
86
87
|
# File 'lib/ransack/context.rb', line 80
def chain_scope(scope, args)
return unless @klass.method(scope) && args != false
@object = if scope_arity(scope) < 1 && args == true
@object.public_send(scope)
else
@object.public_send(scope, *args)
end
end
|
#contextualize(str) ⇒ Object
Convert a string representing a chain of associations and an attribute into the attribute itself
75
76
77
78
|
# File 'lib/ransack/context.rb', line 75
def contextualize(str)
parent, attr_name = @bind_pairs[str]
table_for(parent)[attr_name]
end
|
#klassify(obj) ⇒ Object
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# File 'lib/ransack/context.rb', line 59
def klassify(obj)
if Class === obj && ::ActiveRecord::Base > obj
obj
elsif obj.respond_to? :klass
obj.klass
elsif obj.respond_to? :active_record obj.active_record
elsif obj.respond_to? :base_klass obj.base_klass
else
raise ArgumentError, "Don't know how to klassify #{obj.inspect}"
end
end
|
#ransackable_association?(str, klass) ⇒ Boolean
161
162
163
|
# File 'lib/ransack/context.rb', line 161
def ransackable_association?(str, klass)
klass.ransackable_associations(auth_object).include? str
end
|
#ransackable_attribute?(str, klass) ⇒ Boolean
156
157
158
159
|
# File 'lib/ransack/context.rb', line 156
def ransackable_attribute?(str, klass)
klass.ransackable_attributes(auth_object).include?(str) ||
klass.ransortable_attributes(auth_object).include?(str)
end
|
#ransackable_scope?(str, klass) ⇒ Boolean
165
166
167
|
# File 'lib/ransack/context.rb', line 165
def ransackable_scope?(str, klass)
klass.ransackable_scopes(auth_object).any? { |s| s.to_s == str }
end
|
#scope_arity(scope) ⇒ Object
89
90
91
|
# File 'lib/ransack/context.rb', line 89
def scope_arity(scope)
@klass.method(scope).arity
end
|
#searchable_associations(str = Ransack::Constants::EMPTY) ⇒ Object
177
178
179
|
# File 'lib/ransack/context.rb', line 177
def searchable_associations(str = Ransack::Constants::EMPTY)
traverse(str).ransackable_associations(auth_object)
end
|
#searchable_attributes(str = Ransack::Constants::EMPTY) ⇒ Object
169
170
171
|
# File 'lib/ransack/context.rb', line 169
def searchable_attributes(str = Ransack::Constants::EMPTY)
traverse(str).ransackable_attributes(auth_object)
end
|
#sortable_attributes(str = Ransack::Constants::EMPTY) ⇒ Object
173
174
175
|
# File 'lib/ransack/context.rb', line 173
def sortable_attributes(str = Ransack::Constants::EMPTY)
traverse(str).ransortable_attributes(auth_object)
end
|
#traverse(str, base = @base) ⇒ Object
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
# File 'lib/ransack/context.rb', line 97
def traverse(str, base = @base)
str ||= Ransack::Constants::EMPTY
if (segments = str.split(/_/)).size > 0
remainder = []
found_assoc = nil
while !found_assoc && segments.size > 0 do
assoc, klass = unpolymorphize_association(segments
.join(Ransack::Constants::UNDERSCORE))
if found_assoc = get_association(assoc, base)
base = traverse(
remainder.join(
Ransack::Constants::UNDERSCORE), klass || found_assoc.klass
)
end
remainder.unshift segments.pop
end
raise UntraversableAssociationError,
"No association matches #{str}" unless found_assoc
end
klassify(base)
end
|
#unpolymorphize_association(str) ⇒ Object
148
149
150
151
152
153
154
|
# File 'lib/ransack/context.rb', line 148
def unpolymorphize_association(str)
if (match = str.match(/_of_([^_]+?)_type$/))
[match.pre_match, Kernel.const_get(match.captures.first)]
else
[str, nil]
end
end
|