Module: ActiveRecord::Core::ClassMethods

Defined in:
lib/active_record/core.rb

Instance Method Summary collapse

Instance Method Details

#===(object) ⇒ Object

Overwrite the default class equality method to provide support for decorated models.



444
445
446
 
# File 'lib/active_record/core.rb', line 444

def ===(object) # :nodoc:
  object.is_a?(self)
end

#_internal? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


470
471
472
 
# File 'lib/active_record/core.rb', line 470

def _internal? # :nodoc:
  false
end

#arel_attribute(name, table = arel_table) ⇒ Object

:nodoc:



457
458
459
 
# File 'lib/active_record/core.rb', line 457

def arel_attribute(name, table = arel_table) # :nodoc:
  table[name]
end

#arel_table ⇒ Object

Returns an instance of Arel::Table loaded with the current table name.

class Post < ActiveRecord::Base
  scope :published_and_commented, -> { published.and(arel_table[:comments_count].gt(0)) }
end



453
454
455
 
# File 'lib/active_record/core.rb', line 453

def arel_table # :nodoc:
  @arel_table ||= Arel::Table.new(table_name, klass: self)
end

#cached_find_by_statement(key, &block) ⇒ Object

:nodoc:



474
475
476
477
 
# File 'lib/active_record/core.rb', line 474

def cached_find_by_statement(key, &block) # :nodoc:
  cache = @find_by_statement_cache[connection.prepared_statements]
  cache.compute_if_absent(key) { StatementCache.create(connection, &block) }
end

#filter_attributes ⇒ Object

Returns columns which shouldn't be exposed while calling #inspect.



402
403
404
405
406
407
408
 
# File 'lib/active_record/core.rb', line 402

def filter_attributes
  if defined?(@filter_attributes)
    @filter_attributes
  else
    superclass.filter_attributes
  end
end

#filter_attributes=(filter_attributes) ⇒ Object

Specifies columns which shouldn't be exposed while calling #inspect.



411
412
413
414
 
# File 'lib/active_record/core.rb', line 411

def filter_attributes=(filter_attributes)
  @inspection_filter = nil
  @filter_attributes = filter_attributes
end

#find(*ids) ⇒ Object

:nodoc:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/active_record/core.rb', line 322

def find(*ids) # :nodoc:
  # We don't have cache keys for this stuff yet
  return super unless ids.length == 1
  return super if block_given? || primary_key.nil? || scope_attributes?

  id = ids.first

  return super if StatementCache.unsupported_value?(id)

  key = primary_key

  statement = cached_find_by_statement(key) { |params|
    where(key => params.bind).limit(1)
  }

  statement.execute([id], connection).first ||
    raise(RecordNotFound.new("Couldn't find #{name} with '#{key}'=#{id}", name, key, id))
end

#find_by(*args) ⇒ Object

:nodoc:



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
381
 
# File 'lib/active_record/core.rb', line 341

def find_by(*args) # :nodoc:
  return super if scope_attributes?

  hash = args.first
  return super unless Hash === hash

  hash = hash.each_with_object({}) do |(key, value), h|
    key = key.to_s
    key = attribute_aliases[key] || key

    return super if reflect_on_aggregation(key)

    reflection = _reflect_on_association(key)

    if !reflection
      value = value.id if value.respond_to?(:id)
    elsif reflection.belongs_to? && !reflection.polymorphic?
      key = reflection.join_foreign_key
      pkey = reflection.join_primary_key
      value = value.public_send(pkey) if value.respond_to?(pkey)
    end

    if !columns_hash.key?(key) || StatementCache.unsupported_value?(value)
      return super
    end

    h[key] = value
  end

  keys = hash.keys
  statement = cached_find_by_statement(keys) { |params|
    wheres = keys.index_with { params.bind }
    where(wheres).limit(1)
  }

  begin
    statement.execute(hash.values, connection).first
  rescue TypeError
    raise ActiveRecord::StatementInvalid
  end
end

#find_by!(*args) ⇒ Object

:nodoc:



383
384
385
 
# File 'lib/active_record/core.rb', line 383

def find_by!(*args) # :nodoc:
  find_by(*args) || raise(RecordNotFound.new("Couldn't find #{name}", name))
end

#generated_association_methods ⇒ Object

:nodoc:



391
392
393
394
395
396
397
398
399
 
# File 'lib/active_record/core.rb', line 391

def generated_association_methods # :nodoc:
  @generated_association_methods ||= begin
    mod = const_set(:GeneratedAssociationMethods, Module.new)
    private_constant :GeneratedAssociationMethods
    include mod

    mod
  end
end

#inherited(child_class) ⇒ Object

:nodoc:



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/active_record/core.rb', line 309

def inherited(child_class) # :nodoc:
  # initialize cache at class definition for thread safety
  child_class.initialize_find_by_cache
  unless child_class.base_class?
    klass = self
    until klass.base_class?
      klass.initialize_find_by_cache
      klass = klass.superclass
    end
  end
  super
end

#initialize_find_by_cache ⇒ Object

:nodoc:



305
306
307
 
# File 'lib/active_record/core.rb', line 305

def initialize_find_by_cache # :nodoc:
  @find_by_statement_cache = { true => Concurrent::Map.new, false => Concurrent::Map.new }
end

#initialize_generated_modules ⇒ Object

:nodoc:



387
388
389
 
# File 'lib/active_record/core.rb', line 387

def initialize_generated_modules # :nodoc:
  generated_association_methods
end

#inspect ⇒ Object

Returns a string like 'Post(id:integer, title:string, body:text)'



428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/active_record/core.rb', line 428

def inspect # :nodoc:
  if self == Base
    super
  elsif abstract_class?
    "#{super}(abstract)"
  elsif !connected?
    "#{super} (call '#{super}.connection' to establish a connection)"
  elsif table_exists?
    attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ", "
    "#{super}(#{attr_list})"
  else
    "#{super}(Table doesn't exist)"
  end
end

#inspection_filter ⇒ Object

:nodoc:



416
417
418
419
420
421
422
423
424
425
 
# File 'lib/active_record/core.rb', line 416

def inspection_filter # :nodoc:
  if defined?(@filter_attributes)
    @inspection_filter ||= begin
      mask = InspectionMask.new(ActiveSupport::ParameterFilter::FILTERED)
      ActiveSupport::ParameterFilter.new(@filter_attributes, mask: mask)
    end
  else
    superclass.inspection_filter
  end
end

#predicate_builder ⇒ Object

:nodoc:



462
463
464
 
# File 'lib/active_record/core.rb', line 462

def predicate_builder # :nodoc:
  @predicate_builder ||= PredicateBuilder.new(table_metadata)
end

#type_caster ⇒ Object

:nodoc:



466
467
468
 
# File 'lib/active_record/core.rb', line 466

def type_caster # :nodoc:
  TypeCaster::Map.new(self)
end