Module: ActiveRecord::Core::ClassMethods

Defined in:
lib/active_record/core.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#filter_attributes ⇒ Object

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



229
230
231
232
233
234
235
 
# File 'lib/active_record/core.rb', line 229

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

Instance Method Details

#===(object) ⇒ Object

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



257
258
259
 
# File 'lib/active_record/core.rb', line 257

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

#_internal? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


284
285
286
 
# File 'lib/active_record/core.rb', line 284

def _internal? # :nodoc:
  false
end

#arel_attribute(name, table = arel_table) ⇒ Object

:nodoc:



270
271
272
273
274
 
# File 'lib/active_record/core.rb', line 270

def arel_attribute(name, table = arel_table) # :nodoc:
  name = name.to_s
  name = attribute_aliases[name] || name
  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



266
267
268
 
# File 'lib/active_record/core.rb', line 266

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

#cached_find_by_statement(key, &block) ⇒ Object

:nodoc:



288
289
290
291
 
# File 'lib/active_record/core.rb', line 288

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

#find(*ids) ⇒ Object

:nodoc:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/active_record/core.rb', line 157

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? ||
                  columns_hash.key?(inheritance_column) && !base_class?

  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)
  }

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

#find_by(*args) ⇒ Object

:nodoc:



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

def find_by(*args) # :nodoc:
  return super if scope_attributes? || reflect_on_all_aggregations.any? ||
                  columns_hash.key?(inheritance_column) && !base_class?

  hash = args.first

  return super if !(Hash === hash) || hash.values.any? { |v|
    StatementCache.unsupported_value?(v)
  }

  # We can't cache Post.find_by(author: david) ...yet
  return super unless hash.keys.all? { |k| columns_hash.has_key?(k.to_s) }

  keys = hash.keys

  statement = cached_find_by_statement(keys) { |params|
    wheres = keys.each_with_object({}) { |param, o|
      o[param] = 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:



210
211
212
 
# File 'lib/active_record/core.rb', line 210

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

#generated_association_methods ⇒ Object

:nodoc:



218
219
220
221
222
223
224
225
226
 
# File 'lib/active_record/core.rb', line 218

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:



151
152
153
154
155
 
# File 'lib/active_record/core.rb', line 151

def inherited(child_class) # :nodoc:
  # initialize cache at class definition for thread safety
  child_class.initialize_find_by_cache
  super
end

#initialize_find_by_cache ⇒ Object

:nodoc:



147
148
149
 
# File 'lib/active_record/core.rb', line 147

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

#initialize_generated_modules ⇒ Object

:nodoc:



214
215
216
 
# File 'lib/active_record/core.rb', line 214

def initialize_generated_modules # :nodoc:
  generated_association_methods
end

#inspect ⇒ Object

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/active_record/core.rb', line 241

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

#predicate_builder ⇒ Object

:nodoc:



276
277
278
 
# File 'lib/active_record/core.rb', line 276

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

#type_caster ⇒ Object

:nodoc:



280
281
282
 
# File 'lib/active_record/core.rb', line 280

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