Module: ActiveRecord::Core

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
lib/active_record/core.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#<=>(other_object) ⇒ Object

Allows sort on objects



324
325
326
327
328
 
# File 'lib/active_record/core.rb', line 324

def <=>(other_object)
  if other_object.is_a?(self.class)
    self.to_key <=> other_object.to_key
  end
end

#==(comparison_object) ⇒ Object Also known as: eql?

Returns true if comparison_object is the same exact object, or comparison_object is of the same type and self has an ID and it is equal to comparison_object.id.

Note that new records are different from any other record by definition, unless the other record is the receiver itself. Besides, if you fetch existing records with select and leave the ID out, you’re on your own, this predicate will return false.

Note also that destroying a record preserves its ID in the model instance, so deleted models are still comparable.



296
297
298
299
300
301
 
# File 'lib/active_record/core.rb', line 296

def ==(comparison_object)
  super ||
    comparison_object.instance_of?(self.class) &&
    id.present? &&
    comparison_object.id == id
end

#connection ⇒ Object

Returns the connection currently associated with the class. This can also be used to “borrow” the connection to do database work that isn’t easily done without going straight to SQL.



344
345
346
347
 
# File 'lib/active_record/core.rb', line 344

def connection
  ActiveSupport::Deprecation.warn("#connection is deprecated in favour of accessing it via the class")
  self.class.connection
end

#connection_handler ⇒ Object 



349
350
351
 
# File 'lib/active_record/core.rb', line 349

def connection_handler
  self.class.connection_handler
end

#encode_with(coder) ⇒ Object

Populate coder with attributes about this record that should be serialized. The structure of coder defined in this method is guaranteed to match the structure of coder passed to the init_with method.

Example:

class Post < ActiveRecord::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}



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

def encode_with(coder)
  coder['attributes'] = attributes
end

#freeze ⇒ Object

Clone and freeze the attributes hash such that associations are still accessible, even on destroyed records, but cloned models will not be frozen.



313
314
315
316
 
# File 'lib/active_record/core.rb', line 313

def freeze
  @attributes = @attributes.clone.freeze
  self
end

#frozen? ⇒ Boolean

Returns true if the attributes hash has been frozen.

Returns:

  • (Boolean) 


319
320
321
 
# File 'lib/active_record/core.rb', line 319

def frozen?
  @attributes.frozen?
end

#has_transactional_callbacks? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


378
379
380
 
# File 'lib/active_record/core.rb', line 378

def has_transactional_callbacks? # :nodoc:
  !_rollback_callbacks.empty? || !_commit_callbacks.empty? || !_create_callbacks.empty?
end

#hash ⇒ Object

Delegates to id in order to allow two records of the same type and id to work with something like:

[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]



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

def hash
  id.hash
end

#init_with(coder) ⇒ Object

Initialize an empty model object from coder. coder must contain the attributes necessary for initializing an empty model object. For example:

class Post < ActiveRecord::Base
end

post = Post.allocate
post.init_with('attributes' => { 'title' => 'hello world' })
post.title # => 'hello world'



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/active_record/core.rb', line 208

def init_with(coder)
  @attributes   = self.class.initialize_attributes(coder['attributes'])
  @columns_hash = self.class.column_types.merge(coder['column_types'] || {})

  init_internals

  @new_record = false

  run_callbacks :find
  run_callbacks :initialize

  self
end

#initialize(attributes = nil) {|_self| ... } ⇒ Object

New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes but not yet saved (pass a hash with key names matching the associated table column names). In both instances, valid attribute keys are determined by the column names of the associated table – hence you can’t have attributes that aren’t part of the table columns.

Example:

# Instantiates a single new object
User.new(first_name: 'Jamie')

Yields:

  • (_self)

Yield Parameters:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/active_record/core.rb', line 180

def initialize(attributes = nil)
  defaults = self.class.column_defaults.dup
  defaults.each { |k, v| defaults[k] = v.dup if v.duplicable? }

  @attributes   = self.class.initialize_attributes(defaults)
  @columns_hash = self.class.column_types.dup

  init_internals
  init_changed_attributes
  ensure_proper_type
  populate_with_current_scope_attributes

  assign_attributes(attributes) if attributes

  yield self if block_given?
  run_callbacks :initialize unless _initialize_callbacks.empty?
end

#initialize_dup(other) ⇒ Object

:nodoc:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/active_record/core.rb', line 249

def initialize_dup(other) # :nodoc:
  cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
  self.class.initialize_attributes(cloned_attributes, :serialized => false)

  @attributes = cloned_attributes
  @attributes[self.class.primary_key] = nil

  run_callbacks(:initialize) unless _initialize_callbacks.empty?

  @changed_attributes = {}
  init_changed_attributes

  @aggregation_cache = {}
  @association_cache = {}
  @attributes_cache  = {}

  @new_record  = true

  ensure_proper_type
  super
end

#inspect ⇒ Object

Returns the contents of the record as a nicely formatted string.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/active_record/core.rb', line 354

def inspect
  # We check defined?(@attributes) not to issue warnings if the object is
  # allocated but not initialized.
  inspection = if defined?(@attributes) && @attributes
                 self.class.column_names.collect { |name|
                   if has_attribute?(name)
                     "#{name}: #{attribute_for_inspect(name)}"
                   end
                 }.compact.join(", ")
               else
                 "not initialized"
               end
  "#<#{self.class} #{inspection}>"
end

#readonly! ⇒ Object

Marks this record as read only.



337
338
339
 
# File 'lib/active_record/core.rb', line 337

def readonly!
  @readonly = true
end

#readonly? ⇒ Boolean

Returns true if the record is read only. Records loaded through joins with piggy-back attributes will be marked as read only since they cannot be saved.

Returns:

  • (Boolean) 


332
333
334
 
# File 'lib/active_record/core.rb', line 332

def readonly?
  @readonly
end

#set_transaction_state(state) ⇒ Object

:nodoc:



374
375
376
 
# File 'lib/active_record/core.rb', line 374

def set_transaction_state(state) # :nodoc:
  @transaction_state = state
end

#slice(*methods) ⇒ Object

Returns a hash of the given methods with their names as keys and returned values as values.



370
371
372
 
# File 'lib/active_record/core.rb', line 370

def slice(*methods)
  Hash[methods.map { |method| [method, public_send(method)] }].with_indifferent_access
end