Class: Ransack::Context
- Inherits:
-
Object
show all
- Defined in:
- lib/ransack/context.rb,
lib/ransack/adapters/mongoid/ransack/context.rb,
lib/ransack/adapters/active_record/ransack/context.rb
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(object, options = {}) ⇒ Context
36
37
38
|
# File 'lib/ransack/context.rb', line 36
def initialize(object, options = {})
raise "not implemented"
end
|
Instance Attribute Details
#arel_visitor ⇒ Object
Returns the value of attribute arel_visitor.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def arel_visitor
@arel_visitor
end
|
#auth_object ⇒ Object
Returns the value of attribute auth_object.
14
15
16
|
# File 'lib/ransack/context.rb', line 14
def auth_object
@auth_object
end
|
#base ⇒ Object
Returns the value of attribute base.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def base
@base
end
|
#engine ⇒ Object
Returns the value of attribute engine.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def engine
@engine
end
|
#klass ⇒ Object
Returns the value of attribute klass.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def klass
@klass
end
|
#object ⇒ Object
Returns the value of attribute object.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def object
@object
end
|
#search ⇒ Object
Returns the value of attribute search.
13
14
15
|
# File 'lib/ransack/context.rb', line 13
def search
@search
end
|
#search_key ⇒ Object
Returns the value of attribute search_key.
14
15
16
|
# File 'lib/ransack/context.rb', line 14
def search_key
@search_key
end
|
Class Method Details
.for(object, options = {}) ⇒ Object
26
27
28
29
30
31
32
|
# File 'lib/ransack/context.rb', line 26
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
|
# File 'lib/ransack/context.rb', line 18
def for_class(klass, options = {})
raise "not implemented"
end
|
.for_object(object, options = {}) ⇒ Object
22
23
24
|
# File 'lib/ransack/context.rb', line 22
def for_object(object, options = {})
raise "not implemented"
end
|
Instance Method Details
#association_path(str, base = @base) ⇒ Object
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
# File 'lib/ransack/context.rb', line 96
def association_path(str, base = @base)
base = klassify(base)
str ||= Constants::EMPTY
path = []
segments = str.split(/_/)
association_parts = []
if (segments = str.split(/_/)).size > 0
while segments.size > 0 &&
!base.columns_hash[segments.join(Constants::UNDERSCORE)] &&
association_parts << segments.shift do
assoc, klass = unpolymorphize_association(
association_parts.join(Constants::UNDERSCORE)
)
if found_assoc = get_association(assoc, base)
path += association_parts
association_parts = []
base = klassify(klass || found_assoc)
end
end
end
path.join(Constants::UNDERSCORE)
end
|
#bind(object, str) ⇒ Object
64
65
66
|
# File 'lib/ransack/context.rb', line 64
def bind(object, str)
object.parent, object.attr_name = @bind_pairs[str]
end
|
#chain_scope(scope, args) ⇒ Object
51
52
53
54
55
56
57
58
|
# File 'lib/ransack/context.rb', line 51
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
46
47
48
49
|
# File 'lib/ransack/context.rb', line 46
def contextualize(str)
parent, attr_name = @bind_pairs[str]
table_for(parent)[attr_name]
end
|
#klassify(obj) ⇒ Object
40
41
42
|
# File 'lib/ransack/context.rb', line 40
def klassify(obj)
raise "not implemented"
end
|
#ransackable_association?(str, klass) ⇒ Boolean
133
134
135
|
# File 'lib/ransack/context.rb', line 133
def ransackable_association?(str, klass)
klass.ransackable_associations(auth_object).include? str
end
|
#ransackable_attribute?(str, klass) ⇒ Boolean
128
129
130
131
|
# File 'lib/ransack/context.rb', line 128
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
137
138
139
|
# File 'lib/ransack/context.rb', line 137
def ransackable_scope?(str, klass)
klass.ransackable_scopes(auth_object).any? { |s| s.to_s == str }
end
|
#scope_arity(scope) ⇒ Object
60
61
62
|
# File 'lib/ransack/context.rb', line 60
def scope_arity(scope)
@klass.method(scope).arity
end
|
#searchable_associations(str = Constants::EMPTY) ⇒ Object
149
150
151
|
# File 'lib/ransack/context.rb', line 149
def searchable_associations(str = Constants::EMPTY)
traverse(str).ransackable_associations(auth_object)
end
|
#searchable_attributes(str = Constants::EMPTY) ⇒ Object
141
142
143
|
# File 'lib/ransack/context.rb', line 141
def searchable_attributes(str = Constants::EMPTY)
traverse(str).ransackable_attributes(auth_object)
end
|
#sortable_attributes(str = Constants::EMPTY) ⇒ Object
145
146
147
|
# File 'lib/ransack/context.rb', line 145
def sortable_attributes(str = Constants::EMPTY)
traverse(str).ransortable_attributes(auth_object)
end
|
#traverse(str, base = @base) ⇒ Object
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# File 'lib/ransack/context.rb', line 68
def traverse(str, base = @base)
str ||= 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(Constants::UNDERSCORE)
)
if found_assoc = get_association(assoc, base)
base = traverse(
remainder.join(
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
120
121
122
123
124
125
126
|
# File 'lib/ransack/context.rb', line 120
def unpolymorphize_association(str)
if (match = str.match(/_of_([^_]+?)_type$/))
[match.pre_match, Kernel.const_get(match.captures.first)]
else
[str, nil]
end
end
|