Class: Ransack::Nodes::Condition

Inherits:
Node
  • Object
show all
Defined in:
lib/ransack/nodes/condition.rb,
lib/ransack/adapters/mongoid/ransack/nodes/condition.rb,
lib/ransack/adapters/active_record/ransack/nodes/condition.rb

Instance Attribute Summary collapse

Attributes inherited from Node

#context

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Node

i18n_alias, i18n_word, #initialize, #translate

Constructor Details

This class inherits a constructor from Ransack::Nodes::Node

Instance Attribute Details

#predicate ⇒ Object

Returns the value of attribute predicate.



8
9
10
 
# File 'lib/ransack/nodes/condition.rb', line 8

def predicate
  @predicate
end

Class Method Details

.extract(context, key, values) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/ransack/nodes/condition.rb', line 11

def extract(context, key, values)
  attributes, predicate = extract_attributes_and_predicate(key, context)
  if attributes.size > 0 && predicate
    combinator = key.match(/_(or|and)_/) ? $1 : nil
    condition = self.new(context)
    condition.build(
      :a => attributes,
      :p => predicate.name,
      :m => combinator,
      :v => predicate.wants_array ? Array(values) : [values]
    )
    # TODO: Figure out what to do with multiple types of attributes,
    # if anything. Tempted to go with "garbage in, garbage out" here.
    if predicate.validate(condition.values, condition.default_type)
      condition
    else
      nil
    end
  end
end

Instance Method Details

#arel_predicate ⇒ Object 



179
180
181
 
# File 'lib/ransack/nodes/condition.rb', line 179

def arel_predicate
  raise "not implemented"
end

#arel_predicate_for_attribute(attr) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/ransack/nodes/condition.rb', line 202

def arel_predicate_for_attribute(attr)
  if predicate.arel_predicate === Proc
    values = casted_values_for_attribute(attr)
    predicate.arel_predicate.call(
      predicate.wants_array ? values : values.first
      )
  else
    predicate.arel_predicate
  end
end

#attributes ⇒ Object Also known as: a 



59
60
61
 
# File 'lib/ransack/nodes/condition.rb', line 59

def attributes
  @attributes ||= []
end

#attributes=(args) ⇒ Object Also known as: a= 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ransack/nodes/condition.rb', line 64

def attributes=(args)
  case args
  when Array
    args.each do |attr|
      attr = Attribute.new(@context, attr)
      self.attributes << attr if attr.valid?
    end
  when Hash
    args.each do |index, attrs|
      attr = Attribute.new(@context, attrs[:name], attrs[:ransacker_args])
      self.attributes << attr if attr.valid?
    end
  else
    raise ArgumentError,
      "Invalid argument (#{args.class}) supplied to attributes="
  end
end

#build(params) ⇒ Object 



137
138
139
140
141
142
143
144
145
 
# File 'lib/ransack/nodes/condition.rb', line 137

def build(params)
  params.with_indifferent_access.each do |key, value|
    if key.match(/^(a|v|p|m)$/)
      self.send("#{key}=", value)
    end
  end

  self
end

#build_attribute(name = nil) ⇒ Object 



117
118
119
120
121
 
# File 'lib/ransack/nodes/condition.rb', line 117

def build_attribute(name = nil)
  Attribute.new(@context, name).tap do |attribute|
    self.attributes << attribute
  end
end

#build_value(val = nil) ⇒ Object 



123
124
125
126
127
 
# File 'lib/ransack/nodes/condition.rb', line 123

def build_value(val = nil)
  Value.new(@context, val).tap do |value|
    self.values << value
  end
end

#casted_values_for_attribute(attr) ⇒ Object 



187
188
189
 
# File 'lib/ransack/nodes/condition.rb', line 187

def casted_values_for_attribute(attr)
  validated_values.map { |v| v.cast(predicate.type || attr.type) }
end

#combinator ⇒ Object Also known as: m 



107
108
109
 
# File 'lib/ransack/nodes/condition.rb', line 107

def combinator
  @attributes.size > 1 ? @combinator : nil
end

#combinator=(val) ⇒ Object Also known as: m= 



111
112
113
 
# File 'lib/ransack/nodes/condition.rb', line 111

def combinator=(val)
  @combinator = Constants::AND_OR.detect { |v| v == val.to_s } || nil
end

#default_type ⇒ Object 



214
215
216
 
# File 'lib/ransack/nodes/condition.rb', line 214

def default_type
  predicate.type || (attributes.first && attributes.first.type)
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean) 


156
157
158
159
160
161
162
 
# File 'lib/ransack/nodes/condition.rb', line 156

def eql?(other)
  self.class == other.class &&
  self.attributes == other.attributes &&
  self.predicate == other.predicate &&
  self.values == other.values &&
  self.combinator == other.combinator
end

#formatted_values_for_attribute(attr) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ransack/nodes/condition.rb', line 191

def formatted_values_for_attribute(attr)
  formatted = casted_values_for_attribute(attr).map do |val|
    if attr.ransacker && attr.ransacker.formatter
      val = attr.ransacker.formatter.call(val)
    end
    val = predicate.format(val)
    val
  end
  predicate.wants_array ? formatted : formatted.first
end

#hash ⇒ Object 



165
166
167
 
# File 'lib/ransack/nodes/condition.rb', line 165

def hash
  [attributes, predicate, values, combinator].hash
end

#inspect ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ransack/nodes/condition.rb', line 218

def inspect
  data = [
    ['attributes'.freeze, a.try(:map, &:name)],
    ['predicate'.freeze, p],
    [Constants::COMBINATOR, m],
    ['values'.freeze, v.try(:map, &:value)]
  ]
  .reject { |e| e[1].blank? }
  .map { |v| "#{v[0]}: #{v[1]}" }
  .join(Constants::COMMA_SPACE)
  "Condition <#{data}>"
end

#key ⇒ Object 



151
152
153
154
 
# File 'lib/ransack/nodes/condition.rb', line 151

def key
  @key ||= attributes.map(&:name).join("_#{combinator}_") +
    "_#{predicate.name}"
end

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/ransack/nodes/condition.rb', line 147

def persisted?
  false
end

#predicate_name ⇒ Object Also known as: p 



174
175
176
 
# File 'lib/ransack/nodes/condition.rb', line 174

def predicate_name
  predicate.name if predicate
end

#predicate_name=(name) ⇒ Object Also known as: p= 



169
170
171
 
# File 'lib/ransack/nodes/condition.rb', line 169

def predicate_name=(name)
  self.predicate = Predicate.named(name)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
53
 
# File 'lib/ransack/nodes/condition.rb', line 50

def valid?
  attributes.detect(&:valid?) && predicate && valid_arity? &&
    predicate.validate(values, default_type) && valid_combinator?
end

#valid_arity? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/ransack/nodes/condition.rb', line 55

def valid_arity?
  values.size <= 1 || predicate.wants_array
end

#validated_values ⇒ Object 



183
184
185
 
# File 'lib/ransack/nodes/condition.rb', line 183

def validated_values
  values.select { |v| predicate.validator.call(v.value) }
end

#value ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/ransack/nodes/condition.rb', line 129

def value
  if predicate.wants_array
    values.map { |v| v.cast(default_type) }
  else
    values.first.cast(default_type)
  end
end

#values ⇒ Object Also known as: v 



83
84
85
 
# File 'lib/ransack/nodes/condition.rb', line 83

def values
  @values ||= []
end

#values=(args) ⇒ Object Also known as: v= 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ransack/nodes/condition.rb', line 88

def values=(args)
  case args
  when Array
    args.each do |val|
      val = Value.new(@context, val)
      self.values << val
    end
  when Hash
    args.each do |index, attrs|
      val = Value.new(@context, attrs[:value])
      self.values << val
    end
  else
    raise ArgumentError,
      "Invalid argument (#{args.class}) supplied to values="
  end
end