Module: Effective::Resources::Relation

Included in:
Effective::Resource
Defined in:
app/models/effective/resources/relation.rb

Constant Summary collapse

TARGET_LIST_LIMIT = 
1500
TARGET_KEYS_LIMIT = 
30000
DO_NOT_SEARCH_EQUALS = 
['unconfirmed_email', 'provider', 'secret', 'crypt', 'salt', 'uid', 'certificate', 'otp', 'ssn']
DO_NOT_SEARCH_INCLUDE = 
['password']
DO_NOT_SEARCH_END_WITH = 
['_url', '_param', '_token', '_type', '_id', '_key', '_ip']

Instance Method Summary collapse

Instance Method Details

#order(name, direction = :asc, as: nil, sort: nil, sql_column: nil, limit: nil, reorder: false) ⇒ Object

name: sort by this column, or this relation sort: when a symbol or boolean, this is the relation’s column to sort by



25
26
27
28
29
30
31
32
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'app/models/effective/resources/relation.rb', line 25

def order(name, direction = :asc, as: nil, sort: nil, sql_column: nil, limit: nil, reorder: false)
  raise 'expected relation to be present' unless relation

  sql_column ||= sql_column(name)
  sql_type = (as || sql_type(name))

  association = associated(name)
  sql_direction = sql_direction(direction)
  @relation = relation.reorder(nil) if reorder

  case sql_type
  when :belongs_to
    relation
      .order(order_by_associated_conditions(association, sort: sort, direction: direction, limit: limit))
  when :belongs_to_polymorphic
    relation
      .order(Arel.sql("#{sql_column}_type #{sql_direction}"))
      .order(Arel.sql("#{sql_column}_id #{sql_direction}"))
  when :has_and_belongs_to_many, :has_many, :has_one
    relation
      .order(order_by_associated_conditions(association, sort: sort, direction: direction, limit: limit))
      .order(Arel.sql("#{sql_column(klass.primary_key)} #{sql_direction}"))
  when :effective_addresses
    relation
      .order(order_by_associated_conditions(associated(:addresses), sort: sort, direction: direction, limit: limit))
      .order(Arel.sql("#{sql_column(klass.primary_key)} #{sql_direction}"))
  when :active_storage
    relation
      .send("with_attached_#{name}")
      .references("#{name}_attachment")
      .order(Arel.sql("active_storage_blobs.filename #{sql_direction}"))
  when :effective_roles
    relation
      .order(Arel.sql("#{sql_column(:roles_mask)} #{sql_direction}"))
  when :time
    relation
      .order(Arel.sql("EXTRACT(hour from #{sql_column}) #{sql_direction}, EXTRACT(minute from #{sql_column}) #{sql_direction}"))
  when :string, :text
    relation
      .order(Arel.sql(("ISNULL(#{sql_column}), " if mysql?).to_s + "#{sql_column}='' ASC, #{sql_column} #{sql_direction}" + (" NULLS LAST" if postgres?).to_s))
  when :date, :datetime
    relation
      .order(Arel.sql(("ISNULL(#{sql_column}), " if mysql?).to_s + "#{sql_column} #{sql_direction}" + (" NULLS LAST" if postgres?).to_s))
  else
    relation
      .order(Arel.sql("#{sql_column} #{sql_direction}"))
  end
end

#relation ⇒ Object

This could be active_model? in which we just return the klass itself here This value ends up being crud_controller resource_scope()



15
16
17
 
# File 'app/models/effective/resources/relation.rb', line 15

def relation
  @relation ||= (klass.respond_to?(:where) ? klass.where(nil) : klass)
end

#search(name, value, as: nil, column: nil, operation: nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'app/models/effective/resources/relation.rb', line 74

def search(name, value, as: nil, column: nil, operation: nil)
  raise 'expected relation to be present' unless relation

  sql_as = (as || sql_type(name))
  sql_column = (column || sql_column(name))
  sql_operation = (operation || sql_operation(name, as: sql_as)).to_sym

  if ['SUM(', 'COUNT(', 'MAX(', 'MIN(', 'AVG('].any? { |str| sql_column.to_s.include?(str) }
    return relation.having("#{sql_column} = ?", value)
  end

  case sql_as
  when :belongs_to, :belongs_to_polymorphic, :has_and_belongs_to_many, :has_many, :has_one
    search_associated(name, value, as: sql_as, operation: sql_operation)
  else
    return relation.where(is_null(sql_column)) if value.to_s == 'nil'
    search_attribute(name, value, as: sql_as, operation: sql_operation, sql_column: sql_column)
  end
end

#search_any(value, columns: nil, fuzzy: nil) ⇒ Object 



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'app/models/effective/resources/relation.rb', line 382

def search_any(value, columns: nil, fuzzy: nil)
  raise 'expected relation to be present' unless relation

  # Assume this is a set of IDs
  if value.kind_of?(Integer) || value.kind_of?(Array) || (value.to_i.to_s == value)
    return relation.where(klass.primary_key => value)
  end

  # If the user specifies columns. Filter out invalid ones for this klass
  if columns.present?
    columns = Array(columns).map(&:to_s) - [nil, '']
    columns = (columns & search_columns)
  end

  # Otherwise, we fall back to a string/text search of all columns
  columns = Array(columns || search_columns).reject do |column|
    DO_NOT_SEARCH_EQUALS.any? { |value| column == value } ||
    DO_NOT_SEARCH_INCLUDE.any? { |value| column.include?(value) } ||
    DO_NOT_SEARCH_END_WITH.any? { |value| column.end_with?(value) }
  end

  return relation.none() if columns.blank?

  search_columns_by_ilike_term(relation, value, columns: columns, fuzzy: fuzzy)
end

#search_associated(name, value, as:, operation:) ⇒ Object 



94
95
96
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'app/models/effective/resources/relation.rb', line 94

def search_associated(name, value, as:, operation:)
  reflection = associated(name)

  raise("expected to find #{relation.klass.name} #{name} reflection") unless reflection
  raise("unexpected search_associated operation #{operation || 'nil'}") unless [:eq, :matches, :does_not_match, :sql].include?(operation)

  # Parse values
  value_ids = value.kind_of?(Array) ? value : (value.to_s.split(/,|\s|\|/) - [nil, '', ' '])
  value_sql = Arel.sql(value) if value.kind_of?(String)

  # Foreign id and type
  foreign_id = reflection.foreign_key
  foreign_type = reflection.foreign_key.to_s.chomp('_id') + '_type'

  # belongs_to polymorphic
  retval = if as == :belongs_to_polymorphic
    (type, id) = value.to_s.split('_')

    if type.present? && id.present?  # This was from a polymorphic select
      case operation
      when :eq
        relation.where(foreign_type => type, foreign_id => id)
      when :matches
        relation.where(foreign_type => type, foreign_id => id)
      when :does_not_match
        relation.where.not(foreign_type => type, foreign_id => id)
      when :sql
        if (relation.where(value_sql).present? rescue :invalid) != :invalid
          relation.where(value_sql)
        else
          relation
        end
      end
    else # Maybe from a string field
      associated = relation.none

      value_ids_integer_array = (value_ids.kind_of?(Array) && value_ids.length > 0 && value_ids.all? { |value| (value.to_i rescue nil).to_s == value })

      relation.unscoped.distinct(foreign_type).pluck(foreign_type).each do |klass_name|
        next if klass_name.nil?

        resource = Effective::Resource.new(klass_name)
        next unless resource.klass.present?

        associated = associated.or(relation.where(foreign_id => (value_ids_integer_array ? value_ids : resource.search_any(value)), foreign_type => klass_name))
      end

      case operation
      when :eq
        relation.where(id: associated.select(:id))
      when :matches
        relation.where(id: associated.select(:id))
      when :does_not_match
        relation.where.not(id: associated.select(:id))
      when :sql
        if (relation.where(value_sql).present? rescue :invalid) != :invalid
          relation.where(value_sql)
        else
          relation
        end
      end
    end

  # belongs_to non-polymorphic
  elsif as == :belongs_to
    foreign_collection = reflection.klass.all
    foreign_collection = reflection.klass.where(foreign_type => relation.klass.name) if reflection.klass.new.respond_to?(foreign_type)

    case operation
    when :eq
      associated = foreign_collection.where(id: value_ids)
      relation.where(foreign_id => associated.select(:id))
    when :matches
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where(foreign_id => associated.select(:id))
    when :does_not_match
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where.not(foreign_id => associated.select(:id))
    when :sql
      if (foreign_collection.where(value_sql).present? rescue :invalid) != :invalid
        associated = foreign_collection.where(value_sql)
        relation.where(foreign_id => associated.select(:id))
      else
        relation
      end
    end

  # has_and_belongs_to_many
  elsif as == :has_and_belongs_to_many
    foreign_collection = reflection.source_reflection.klass.all

    habtm = foreign_collection.klass.reflect_on_all_associations.find { |ass| ass.macro == :has_and_belongs_to_many && ass.join_table == reflection.join_table }
    raise("expected a matching HABTM reflection") unless habtm

    case operation
    when :eq
      associated = foreign_collection.where(id: value_ids)
      relation.where(id: associated.joins(habtm.name).select(foreign_id))
    when :matches
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where(id: associated.joins(habtm.name).select(foreign_id))
    when :does_not_match
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where.not(id: associated.joins(habtm.name).select(foreign_id))
    when :sql
      if (foreign_collection.where(value_sql).present? rescue :invalid) != :invalid
        associated = foreign_collection.where(value_sql)
        relation.where(id: associated.joins(habtm.name).select(foreign_id))
      else
        relation
      end
    end

  # has_many through
  elsif reflection.options[:through].present?
    reflected_klass = if reflection.source_reflection.options[:polymorphic]
      reflection.klass
    else
      reflection.source_reflection.klass
    end

    reflected_id = if reflection.source_reflection.macro == :belongs_to
      reflection.source_reflection.foreign_key # to do check this
    else
      reflection.source_reflection.klass.primary_key # group_id
    end

    foreign_id = if reflection.through_reflection.macro == :belongs_to
      reflection.through_reflection.klass.primary_key # to do check this
    else
      reflection.through_reflection.foreign_key # user_id
    end

    # Build the through collection
    through = reflection.through_reflection.klass.all  # group mates

    if reflection.source_reflection.options[:polymorphic]
      through = through.where(reflection.source_reflection.foreign_type => reflected_klass.name)
    end

    # Search the associated class
    case operation
    when :eq
      associated = through.where(reflected_id => value_ids)
      relation.where(id: associated.select(foreign_id))
    when :matches
      reflected = Resource.new(reflected_klass).search_any(value)
      associated = through.where(reflected_id => reflected)
      relation.where(id: associated.select(foreign_id))
    when :does_not_match
      reflected = Resource.new(reflected_klass).search_any(value)
      associated = through.where(reflected_id => reflected)
      relation.where.not(id: associated.select(foreign_id))
    when :sql
      if (reflected_klass.where(value_sql).present? rescue :invalid) != :invalid
        reflected = reflected_klass.where(value_sql)
        associated = through.where(reflected_id => reflected)
        relation.where(id: associated.select(foreign_id))
      else
        relation
      end
    end

  # has_many and has_one
  elsif (as == :has_many || as == :has_one)
    foreign_collection = reflection.klass.all
    foreign_collection = reflection.klass.where(foreign_type => relation.klass.name) if reflection.klass.new.respond_to?(foreign_type)

    case operation
    when :eq
      associated = foreign_collection.where(id: value_ids)
      relation.where(id: associated.select(foreign_id))
    when :matches
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where(id: associated.select(foreign_id))
    when :does_not_match
      associated = Resource.new(foreign_collection).search_any(value)
      relation.where.not(id: associated.select(foreign_id))
    when :sql
      if (foreign_collection.where(value_sql).present? rescue :invalid) != :invalid
        associated = foreign_collection.where(value_sql)
        relation.where(id: associated.select(foreign_id))
      else
        relation
      end
    end
  end

  retval || raise("unable to search associated #{as} #{operation} #{name} for #{value}")
end

#search_attribute(name, value, as:, operation:, sql_column:) ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'app/models/effective/resources/relation.rb', line 285

def search_attribute(name, value, as:, operation:, sql_column:)
  raise 'expected relation to be present' unless relation

  attribute = relation.arel_table[name]

  # Normalize the term.
  # If you pass an email attribute it can return nil so we return the full value
  term = Attribute.new(as).parse(value, name: name)
  term = value if term.nil?

  # If using the joined syntax from datatables
  joined = (sql_column.to_s.split('.').first.to_s.include?(relation.arel_table.name) == false)

  searched = case as
    when :active_storage
      relation.send("with_attached_#{name}").references("#{name}_attachment")
        .where(ActiveStorage::Blob.arel_table[:filename].matches("%#{term}%"))

    when :date, :datetime
      if value.kind_of?(String) && term.respond_to?(:strftime)
        end_at = (
          case (value.to_s.scan(/(\d+)/).flatten).length
          when 1 ; term.end_of_year     # Year
          when 2 ; term.end_of_month    # Year-Month
          when 3 ; term.end_of_day      # Year-Month-Day
          when 4 ; term.end_of_hour     # Year-Month-Day Hour
          when 5 ; term.end_of_minute   # Year-Month-Day Hour-Minute
          when 6 ; term + 1.second      # Year-Month-Day Hour-Minute-Second
          else term
          end
        )

        if as == :date
          relation.where("#{sql_column} >= ? AND #{sql_column} < ?", term.to_date, (end_at + 1.day).to_date)
        else
          relation.where("#{sql_column} >= ? AND #{sql_column} <= ?", term, end_at)
        end
      elsif value.respond_to?(:strftime) && operation == :eq
        if as == :date
          relation.where("#{sql_column} = ?", value)
        else
          relation.where("#{sql_column} >= ? AND #{sql_column} <= ?", value.beginning_of_day, value.end_of_day)
        end
      elsif term.respond_to?(:strftime) == false && operation.to_s.include?('days_ago') == false
        relation.none # It's an invalid entered date 
      end
    when :effective_obfuscation
      term = Attribute.new(as, klass: (associated(name).try(:klass) || klass)).parse(value, name: name)
      relation.where(attribute.eq((value == term ? 0 : term)))

    when :effective_addresses
      association = associated(name)
      associated = Resource.new(association).search_any(value)
      relation.where(id: associated.where(addressable_type: klass.name).select(:addressable_id))

    when :effective_roles
      relation.with_role(term)

    when :time
      if term.respond_to?(:strftime)
        timed = relation.where("EXTRACT(hour from #{sql_column}) = ?", term.utc.hour)
        timed = timed.where("EXTRACT(minute from #{sql_column}) = ?", term.utc.min) if term.min > 0
        timed
      else
        relation.none # It's an invalid entered date 
      end
  end

  return searched if searched

  # Simple operation search
  # The Arel operator eq and matches bug out with serialized Array columns. So we avoid for datatables usage.

  case operation
    when :eq then relation.where("#{sql_column} = ?", term)
    when :matches then search_columns_by_ilike_term(relation, term, columns: (sql_column.presence || name))
    when :not_eq then relation.where(attribute.not_eq(term))
    when :does_not_match then relation.where(attribute.does_not_match("%#{term}%"))
    when :starts_with then relation.where(attribute.matches("#{term}%"))
    when :ends_with then relation.where(attribute.matches("%#{term}"))
    when :gt then relation.where(attribute.gt(term))
    when :gteq then relation.where(attribute.gteq(term))
    when :lt then relation.where(attribute.lt(term))
    when :lteq then relation.where(attribute.lteq(term))
    when :days_ago_eq
      date = Time.zone.now.advance(days: -term.to_i)
      relation.where("#{sql_column} >= ? AND #{sql_column} <= ?", date.beginning_of_day, date.end_of_day)
    when :days_ago_lteq # 30 days or less ago.
      date = Time.zone.now.advance(days: -term.to_i)
      relation.where("#{sql_column} >= ?", date)
    when :days_ago_gteq # 30 days or more ago
      date = Time.zone.now.advance(days: -term.to_i)
      relation.where("#{sql_column} <= ?", date)
    else raise("Unexpected operation: #{operation}")
  end
end