Class: ActiveRecord::Base

Inherits:
Object show all
Defined in:
lib/brick/extensions.rb

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

._brick_relation ⇒ Object (readonly)

Returns the value of attribute _brick_relation.



49
50
51
 
# File 'lib/brick/extensions.rb', line 49

def _brick_relation
  @_brick_relation
end

Class Method Details

._assoc_names ⇒ Object 



65
66
67
 
# File 'lib/brick/extensions.rb', line 65

def _assoc_names
  @_assoc_names ||= {}
end

._br_associatives ⇒ Object

has_many :through associative tables



368
369
370
 
# File 'lib/brick/extensions.rb', line 368

def _br_associatives
  @_br_associatives ||= {}
end

._br_bt_descrip ⇒ Object

belongs_to DSL descriptions



360
361
362
 
# File 'lib/brick/extensions.rb', line 360

def _br_bt_descrip
  @_br_bt_descrip ||= {}
end

._br_cust_cols ⇒ Object

Custom columns



372
373
374
 
# File 'lib/brick/extensions.rb', line 372

def _br_cust_cols
  @_br_cust_cols ||= {}
end

._br_hm_counts ⇒ Object

has_many count definitions



364
365
366
 
# File 'lib/brick/extensions.rb', line 364

def _br_hm_counts
  @_br_hm_counts ||= {}
end

._br_quoted_name(name) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/brick/extensions.rb', line 102

def _br_quoted_name(name)
  name = name.join('.') if name.is_a?(Array)
  if name == '*'
    name
  elsif is_mysql
    "`#{name.gsub('.', '`.`')}`"
  elsif is_postgres || is_mssql
    "\"#{name.gsub('.', '"."')}\""
  else
    name
  end
end

._brick_all_fields ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/brick/extensions.rb', line 95

def _brick_all_fields
  rtans = if respond_to?(:rich_text_association_names)
            rich_text_association_names&.map { |rtan| rtan.to_s.start_with?('rich_text_') ? rtan[10..-1] : rtan }
          end
  columns_hash.keys.map(&:to_sym) + (rtans || [])
end

._brick_calculate_bts_hms(translations, join_array) ⇒ Object

Search for custom column, BT, HM, and HMT DSL stuff



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/brick/extensions.rb', line 400

def self._brick_calculate_bts_hms(translations, join_array)
  # Add any custom columns
  ::Brick.config.custom_columns&.fetch(table_name, nil)&.each do |k, cc|
    if cc.is_a?(Array)
      fk_col = cc.last unless cc.last.blank?
      cc = cc.first
    else
      fk_col = true
    end
    # false = not polymorphic, and true = yes -- please emit_dsl
    pieces, my_dsl = brick_parse_dsl(join_array, [], translations, false, cc, true)
    _br_cust_cols[k] = [pieces, my_dsl, fk_col]
  end
  bts, hms, associatives = ::Brick.get_bts_and_hms(self, true)
  bts.each do |_k, bt|
    next if bt[2] # Polymorphic?

    # join_array will receive this relation name when calling #brick_parse_dsl
    _br_bt_descrip[bt.first] = if bt[1].is_a?(Array)
                                 # Last params here:  "true" is for yes, we are polymorphic
                                 bt[1].each_with_object({}) { |bt_class, s| s[bt_class] = bt_class.brick_parse_dsl(join_array, bt.first, translations, true) }
                               else
                                 { bt.last => bt[1].brick_parse_dsl(join_array, bt.first, translations) }
                               end
  end
  skip_klass_hms = ::Brick.config.skip_index_hms[self.name] || {}
  hms.each do |k, hm|
    next if skip_klass_hms.key?(k)

    if hm.macro == :has_one
      # For our purposes a :has_one is similar enough to a :belongs_to that we can just join forces
      _br_bt_descrip[k] = { hm.klass => hm.klass.brick_parse_dsl(join_array, k, translations) }
    else # Standard :has_many
      _br_hm_counts[k] = hm unless hm.options[:through] && !_br_associatives.fetch(hm.name, nil)
    end
  end
end

._brick_calculate_ordering(ordering, is_do_txt = true) ⇒ Object 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/brick/extensions.rb', line 438

def self._brick_calculate_ordering(ordering, is_do_txt = true)
  order_by_txt = [] if is_do_txt
  ordering = [ordering] if ordering && !ordering.is_a?(Array)
  order_by = ordering&.each_with_object([]) do |ord_part, s| # %%% If a term is also used as an eqi-condition in the WHERE clause, it can be omitted from ORDER BY
               case ord_part
               when String
                 ord_expr = if ord_part.index('(') # Any kind of SQL function at play here?
                              ord_part.gsub('^^^', _br_quoted_name(table_name))
                            else
                              _br_quoted_name(ord_part.gsub('^^^', table_name))
                            end
                 s << Arel.sql(ord_expr)
                 order_by_txt&.<<(ord_expr.index('.') ? "Arel.sql(#{ord_expr.inspect})" : ord_part.inspect)
               else # Expecting only Symbol
                 ord_part = ord_part.to_s
                 if ord_part[0] == '-' # First char '-' means descending order
                   ord_part.slice!(0)
                   is_desc = true
                 end
                 if ord_part[0] == '~' # Char '~' means order NULLs as highest values instead of lowest
                   ord_part.slice!(0)
                   # (Unfortunately SQLServer does not support NULLS FIRST / NULLS LAST, so leave them out.)
                   is_nulls_switch = if is_mysql
                                       :mysql
                                     else # PostgreSQL, OracleEnhanced, SQLite
                                       :pg
                                     end
                 end
                 if _br_hm_counts.key?(ord_part_sym = ord_part.to_sym)
                   ord_part = _br_quoted_name("b_r_#{ord_part}_ct")
                 elsif _br_bt_descrip.key?(ord_part_sym)
                   ord_part = _br_bt_descrip.fetch(ord_part_sym, nil)&.first&.last&.first&.last&.dup
                 elsif !_br_cust_cols.key?(ord_part_sym) && !column_names.include?(ord_part)
                   # Disallow ordering by a bogus column
                   # %%% Note this bogus entry so that Javascript can remove any bogus _brick_order
                   # parameter from the querystring, pushing it into the browser history.
                   ord_part = nil
                 end

                 if ord_part
                   ord_part << ' DESC' if is_desc
                   ord_part << (is_desc ? ' NULLS LAST' : ' NULLS FIRST') if is_nulls_switch == :pg
                   ord_part.insert(0, '-') if is_nulls_switch == :mysql

                   order_by_txt&.<<("Arel.sql(#{ord_part.inspect})")

                   # # Retain any reference to a bt_descrip as being a symbol
                   # # Was:  "#{quoted_table_name}.\"#{ord_part}\""
                   # order_by_txt&.<<(_br_bt_descrip.key?(ord_part) ? ord_part : ord_part.inspect)
                   s << ord_part
                 end
               end
             end
  [order_by, order_by_txt]
end

._brick_find_permits(model_or_assoc, current_permits, done_permits = []) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/brick/extensions.rb', line 376

def _brick_find_permits(model_or_assoc, current_permits, done_permits = [])
  unless done_permits.include?(model_or_assoc)
    done_permits << model_or_assoc
    self.reflect_on_all_associations.select { |assoc| !assoc.belongs_to? }.each_with_object([]) do |assoc, s|
      if assoc.options[:through]
        current_permits << { "#{assoc.name.to_s.singularize}_ids".to_sym => [] }
        s << "#{assoc.name.to_s.singularize}_ids: []"
      end
      if self.instance_methods.include?(:"#{assoc.name}_attributes=")
        # Support nested attributes which use the friendly_id gem
        assoc.klass._brick_nested_friendly_id if Object.const_defined?('FriendlyId') &&
                                                 assoc.klass.instance_variable_get(:@friendly_id_config)
        new_attrib_text = assoc.klass._brick_find_permits(assoc, (new_permits = assoc.klass._brick_all_fields), done_permits)
        new_permits << :_destroy
        current_permits << { "#{assoc.name}_attributes".to_sym => new_permits }
        s << "#{assoc.name}_attributes: #{new_attrib_text}"
      end
    end
  end
  current_permits
end

._brick_index(mode = nil, separator = nil, relation = nil, not_path = nil) ⇒ Object

Providing a relation object allows auto-modules built from table name prefixes to work



342
343
344
345
346
 
# File 'lib/brick/extensions.rb', line 342

def self._brick_index(mode = nil, separator = nil, relation = nil, not_path = nil)
  return if abstract_class?

  ::Brick._brick_index(table_name, mode, separator, relation, not_path)
end

._brick_inheriteds ⇒ Object 



51
52
53
 
# File 'lib/brick/extensions.rb', line 51

def _brick_inheriteds
  @_brick_inheriteds ||= ::ActiveRecord::Base.instance_variable_get(:@_brick_inheriteds)
end

._brick_monetized_attributes ⇒ Object 



158
159
160
 
# File 'lib/brick/extensions.rb', line 158

def _brick_monetized_attributes
  @_brick_monetized_attributes ||= respond_to?(:monetized_attributes) ? monetized_attributes.values : {}
end

._brick_primary_key(relation = nil) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/brick/extensions.rb', line 125

def _brick_primary_key(relation = nil)
  return @_brick_primary_key if instance_variable_defined?(:@_brick_primary_key)

  pk = begin
         primary_key
       rescue
         superclass.respond_to?(:primary_key) && superclass.primary_key
       end
  pk = pk.is_a?(String) ? [pk] : pk.dup || []
  pk.map! { |pk_part| pk_part =~ /^[A-Z0-9_]+$/ ? pk_part.downcase : pk_part } unless connection.adapter_name == 'MySQL2'
  # Just return [] if we're missing any part of the primary key.  (PK is usually just "id")
  if relation && pk.present?
    @_brick_primary_key ||= pk.any? { |pk_part| !relation[:cols].key?(pk_part) } ? [] : pk
  else # No definitive key yet, so return what we can without setting the instance variable
    pk
  end
end

.brick_descrip(obj, data = nil, pk_alias = nil) ⇒ Object 



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
284
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
 
# File 'lib/brick/extensions.rb', line 257

def self.brick_descrip(obj, data = nil, pk_alias = nil)
  dsl = obj if obj.is_a?(String)
  if (dsl ||= ::Brick.config.model_descrips[(klass = self).name] || klass.brick_get_dsl)
    idx = -1
    caches = {}
    output = +''
    is_brackets_have_content = false
    bracket_name = nil
    dsl.each_char do |ch|
      if bracket_name
        if ch == ']' # Time to process a bracketed thing?
          datum = if data
                    data[idx += 1].to_s
                  else
                    obj_name = +''
                    this_obj = obj
                    bracket_name.split('.').each do |part|
                      obj_name += ".#{part}"
                      this_obj = begin
                                   caches.fetch(obj_name) { caches[obj_name] = this_obj&.send(part.to_sym) }
                                 rescue
                                   clsnm = part.camelize
                                   if (possible = this_obj.class.reflect_on_all_associations.select { |a| !a.polymorphic? && (a.class_name == clsnm || a.klass.base_class.name == clsnm) }.first)
                                     caches[obj_name] = this_obj&.send(possible.name)
                                   end
                                 end
                      break if this_obj.nil?
                    end
                    if this_obj.is_a?(ActiveRecord::Base) && (obj_descrip = this_obj.class.brick_descrip(this_obj))
                      this_obj = obj_descrip
                    end
                    if Object.const_defined?('ActiveStorage') && this_obj.is_a?(::ActiveStorage::Filename) &&
                       this_obj.instance_variable_get(:@filename).nil?
                      this_obj.instance_variable_set(:@filename, '')
                    end
                    this_obj&.to_s || ''
                  end
          begin
            is_brackets_have_content = true unless datum.blank?
          rescue
          end
          output << (datum || '')
          bracket_name = nil
        else
          bracket_name << ch
        end
      elsif ch == '['
        bracket_name = +''
      else
        output << ch
      end
    end
    output += bracket_name if bracket_name
  end
  if is_brackets_have_content
    output
  elsif (pk_alias ||= primary_key)
    pk_alias = [pk_alias] unless pk_alias.is_a?(Array)
    id = []
    pk_alias.each do |pk_alias_part|
      if (pk_part = obj.respond_to?(pk_alias_part) ? obj.send(pk_alias_part) : nil)
        id << pk_part
      end
    end
    if id.present?
      "#{klass.name} ##{id.join(', ')}"
    end
  else
    obj.to_s
  end
end

.brick_foreign_type(assoc) ⇒ Object 



91
92
93
 
# File 'lib/brick/extensions.rb', line 91

def brick_foreign_type(assoc)
  reflect_on_association(assoc).foreign_type || "#{assoc}_type"
end

.brick_get_dsl ⇒ Object

Used to show a little prettier name for an object



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/brick/extensions.rb', line 144

def brick_get_dsl
  # If there's no DSL yet specified, just try to find the first usable column on this model
  unless (dsl = ::Brick.config.model_descrips[name])
    skip_columns = _brick_get_fks + (::Brick.config.metadata_columns || []) + [primary_key]
    dsl = if (descrip_col = columns.find { |c| [:boolean, :binary, :xml].exclude?(c.type) && skip_columns.exclude?(c.name) })
            "[#{descrip_col.name}]"
          elsif (pk_parts = self.primary_key.is_a?(Array) ? self.primary_key : [self.primary_key])
            "#{name} ##{pk_parts.map { |pk_part| "[#{pk_part}]" }.join(', ')}"
          end
    ::Brick.config.model_descrips[name] = dsl
  end
  dsl
end

.brick_import_template ⇒ Object 



348
349
350
351
352
353
354
355
356
 
# File 'lib/brick/extensions.rb', line 348

def self.brick_import_template
  template = constants.include?(:IMPORT_TEMPLATE) ? self::IMPORT_TEMPLATE : suggest_template(0, false, true)
  # Add the primary key to the template as being unique (unless it's already there)
  if primary_key
    template[:uniques] = [pk = primary_key.to_sym]
    template[:all].unshift(pk) unless template[:all].include?(pk)
  end
  template
end

.brick_parse_dsl(join_array = nil, prefix = [], translations = {}, is_polymorphic = false, dsl = nil, emit_dsl = false) ⇒ Object 



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
 
# File 'lib/brick/extensions.rb', line 163

def self.brick_parse_dsl(join_array = nil, prefix = [], translations = {}, is_polymorphic = false, dsl = nil, emit_dsl = false)
  unless join_array.is_a?(::Brick::JoinArray)
    join_array = ::Brick::JoinArray.new.tap { |ary| ary.replace([join_array]) } if join_array.is_a?(::Brick::JoinHash)
    join_array = ::Brick::JoinArray.new unless join_array.nil? || join_array.is_a?(Array)
  end
  prefix = [prefix] unless prefix.is_a?(Array)
  members = []
  unless dsl || (dsl = ::Brick.config.model_descrips[name] || brick_get_dsl)
    # With no DSL available, still put this prefix into the JoinArray so we can get primary key (ID) info from this table
    x = prefix.each_with_object(join_array) { |v, s| s[v.to_sym] }
    x[prefix.last] = nil unless prefix.empty? # Using []= will "hydrate" any missing part(s) in our whole series
    return members
  end

  # Do the actual dirty work of recursing through nested DSL
  bracket_name = nil
  dsl2 = +'' # To replace our own DSL definition in case it needs to be expanded
  dsl3 = +'' # To return expanded DSL that is nested from another model
  klass = nil
  dsl.each_char do |ch|
    if bracket_name
      if ch == ']' # Time to process a bracketed thing?
        parts = bracket_name.split('.')
        first_parts = parts[0..-2].each_with_object([]) do |part, s|
          unless (klass = (orig_class = klass).reflect_on_association(part_sym = part.to_sym)&.klass)
            puts "Couldn't reference #{orig_class.name}##{part} that's part of the DSL \"#{dsl}\"."
            break
          end
          s << part_sym
        end
        if first_parts
          if (parts = prefix + first_parts + [parts[-1]]).length > 1 && klass
            unless is_polymorphic
              s = join_array
              parts[0..-3].each { |v| s = s[v.to_sym] }
              s[parts[-2]] = nil # unless parts[-2].empty? # Using []= will "hydrate" any missing part(s) in our whole series
            end
            translations[parts[0..-2].join('.')] = klass
          end
          if klass&.column_names.exclude?(parts.last) &&
             (klass = (orig_class = klass).reflect_on_association(possible_dsl = parts.last&.to_sym)&.klass)
            parts.pop
            if prefix.empty? # Custom columns start with an empty prefix
              prefix << parts.shift until parts.empty?
            end
            # Expand this entry which refers to an association name
            members2, dsl2a = klass.brick_parse_dsl(join_array, prefix + [possible_dsl], translations, is_polymorphic, nil, true)
            members += members2
            dsl2 << dsl2a
            dsl3 << dsl2a
          else
            dsl2 << "[#{bracket_name}]"
            if emit_dsl
              dsl3 << "[#{prefix[1..-1].map { |p| "#{p.to_s}." }.join if prefix.length > 1}#{bracket_name}]"
            end
            parts[-1] = column_names.first if parts[-1].nil? # No primary key to be found?  Grab something to display!
            members << parts
          end
        end
        bracket_name = nil
      else
        bracket_name << ch
      end
    elsif ch == '['
      bracket_name = +''
      klass = self
    else
      dsl2 << ch
      dsl3 << ch
    end
  end
  # Rewrite the DSL in case it's now different from having to expand it
  # if ::Brick.config.model_descrips[name] != dsl2
  #   puts ::Brick.config.model_descrips[name]
  #   puts dsl2.inspect
  #   puts dsl3.inspect
  #   binding.pry
  # end
  if emit_dsl
    # Had been:  [members, dsl2, dsl3]
    [members, dsl3]
  else
    ::Brick.config.model_descrips[name] = dsl2
    members
  end
end

.brick_select(*args, params: {}, brick_col_names: false, **kwargs) ⇒ Object 



494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/brick/extensions.rb', line 494

def self.brick_select(*args, params: {}, brick_col_names: false, **kwargs)
  selects = if args[0].is_a?(Array)
              other_args = args[1..-1]
              args[0]
            else
              other_args = []
              args
            end
  (relation = all).brick_select(selects, *other_args,
                                params: params, brick_col_names: brick_col_names, **kwargs)
  relation.select(selects)
end

.brick_where(*args) ⇒ Object 



507
508
509
 
# File 'lib/brick/extensions.rb', line 507

def self.brick_where(*args)
  (relation = all).brick_where(*args)
end

.bt_link(assoc_name) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/brick/extensions.rb', line 329

def self.bt_link(assoc_name)
  assoc_html_name = unless (assoc_name = assoc_name.to_s).camelize == name
                      CGI.escapeHTML(assoc_name)
                    end
  model_path = ::Rails.application.routes.url_helpers.send("#{_brick_index || table_name}_path".to_sym)
  model_path << "?#{self.inheritance_column}=#{self.name}" if self != base_class
  av_class = Class.new.extend(ActionView::Helpers::UrlHelper)
  av_class.extend(ActionView::Helpers::TagHelper) if ActionView.version < ::Gem::Version.new('7')
  link = av_class.link_to(assoc_html_name ? name : assoc_name, model_path)
  assoc_html_name ? "#{assoc_name}-#{link}".html_safe : link
end

.inherited(model) ⇒ Object

Track the file(s) in which each model is defined



56
57
58
59
 
# File 'lib/brick/extensions.rb', line 56

def inherited(model)
  (_brick_inheriteds[model] ||= []) << caller.first.split(':')[0..1] unless caller.first.include?('/lib/brick/extensions.rb:')
  super
end

.is_brick? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/brick/extensions.rb', line 61

def is_brick?
  instance_variables.include?(:@_brick_relation) && instance_variable_get(:@_brick_relation)
end

.is_mssql ⇒ Object 



121
122
123
 
# File 'lib/brick/extensions.rb', line 121

def is_mssql
  @is_mssql ||= connection.adapter_name == 'SQLServer'
end

.is_mysql ⇒ Object 



118
119
120
 
# File 'lib/brick/extensions.rb', line 118

def is_mysql
  @is_mysql ||= ['Mysql2', 'Trilogy'].include?(connection.adapter_name)
end

.is_postgres ⇒ Object 



115
116
117
 
# File 'lib/brick/extensions.rb', line 115

def is_postgres
  @is_postgres ||= connection.adapter_name == 'PostgreSQL'
end

.is_view? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/brick/extensions.rb', line 69

def is_view?
  false
end

.json_column?(col) ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
86
87
88
89
 
# File 'lib/brick/extensions.rb', line 83

def json_column?(col)
  col.type == :json || ::Brick.config.json_columns[table_name]&.include?(col.name) ||
  (
    respond_to?(:attribute_types) && (attr_types = attribute_types[col.name]).respond_to?(:coder) &&
    (attr_types.coder.is_a?(Class) ? attr_types.coder : attr_types.coder&.class)&.name&.end_with?('JSON')
  )
end

.real_model(params) ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/brick/extensions.rb', line 73

def real_model(params)
  if params && (sub_model = params.fetch(type_col = inheritance_column, nil))
    sub_model = sub_model.first if sub_model.is_a?(Array) # Support the params style that gets returned from #brick_select
    # Make sure the chosen model is really the same or a subclass of this model
    (possible_model = sub_model.constantize) <= self ? possible_model : self
  else
    self
  end
end

Instance Method Details

#brick_descrip(data = nil, pk_alias = nil) ⇒ Object

If available, parse simple DSL attached to a model in order to provide a friendlier name. Object property names can be referenced in square brackets like this: { ‘User’ => ‘[profile.firstname] [profile.lastname]’ }



253
254
255
 
# File 'lib/brick/extensions.rb', line 253

def brick_descrip(data = nil, pk_alias = nil)
  self.class.brick_descrip(self, data, pk_alias)
end