Module: ActiveEntity::Core

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

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#<=>(other_object) ⇒ Object

Allows sort on objects



224
225
226
227
228
229
230
 
# File 'lib/active_entity/core.rb', line 224

def <=>(other_object)
  if other_object.is_a?(self.class)
    to_key <=> other_object.to_key
  else
    super
  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.



192
193
194
195
196
197
 
# File 'lib/active_entity/core.rb', line 192

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

#blank? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/active_entity/core.rb', line 236

def blank? # :nodoc:
  false
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 < ActiveEntity::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}



178
179
180
181
 
# File 'lib/active_entity/core.rb', line 178

def encode_with(coder)
  self.class.yaml_encoder.encode(@attributes, coder)
  coder["active_entity_yaml_version"] = 2
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.



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

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

#frozen? ⇒ Boolean

Returns true if the attributes hash has been frozen.

Returns:

  • (Boolean) 


219
220
221
 
# File 'lib/active_entity/core.rb', line 219

def frozen?
  @attributes.frozen?
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) ]



202
203
204
205
206
207
208
 
# File 'lib/active_entity/core.rb', line 202

def hash
  if id
    self.class.hash ^ id.hash
  else
    super
  end
end

#init_with(coder, &block) ⇒ Object

Initialize an empty model object from coder. coder should be the result of previously encoding an Active Entity model, using #encode_with.

class Post < ActiveEntity::Base
end

old_post = Post.new(title: "hello world")
coder = {}
old_post.encode_with(coder)

post = Post.allocate
post.init_with(coder)
post.title # => 'hello world'



109
110
111
112
 
# File 'lib/active_entity/core.rb', line 109

def init_with(coder, &block)
  attributes = self.class.yaml_encoder.decode(coder)
  init_with_attributes(attributes, coder["new_record"], &block)
end

#init_with_attributes(attributes) {|_self| ... } ⇒ Object

Initialize an empty model object from attributes. attributes should be an attributes object, and unlike the ‘initialize` method, no assignment calls are made per attribute.

Yields:

  • (_self)

Yield Parameters:



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/active_entity/core.rb', line 118

def init_with_attributes(attributes) # :nodoc:
  @attributes = attributes

  init_internals

  yield self if block_given?

  _run_find_callbacks
  _run_initialize_callbacks

  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:



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/active_entity/core.rb', line 81

def initialize(attributes = nil)
  @attributes = self.class._default_attributes.deep_dup

  init_internals
  initialize_internals_callback

  assign_attributes(attributes) if attributes

  yield self if block_given?
  _run_initialize_callbacks

  enable_attr_readonly!
end

#initialize_dup(other) ⇒ Object

:nodoc:



158
159
160
161
162
163
164
 
# File 'lib/active_entity/core.rb', line 158

def initialize_dup(other) # :nodoc:
  @attributes = @attributes.deep_dup

  _run_initialize_callbacks

  super
end

#inspect ⇒ Object

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/active_entity/core.rb', line 252

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.attribute_names.collect do |name|
      if has_attribute?(name)
        attr = _read_attribute(name)
        value = if attr.nil?
          attr.inspect
        else
          attr = format_for_inspect(attr)
          inspection_filter.filter_param(name, attr)
        end
        "#{name}: #{value}"
      end
    end.compact.join(", ")
  else
    "not initialized"
  end

  "#<#{self.class} #{inspection}>"
end

#present? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/active_entity/core.rb', line 232

def present? # :nodoc:
  true
end

#pretty_print(pp) ⇒ Object

Takes a PP and prettily prints this record to it, allowing you to get a nice result from pp record when pp is required.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/active_entity/core.rb', line 277

def pretty_print(pp)
  return super if custom_inspect_method_defined?
  pp.object_address_group(self) do
    if defined?(@attributes) && @attributes
      attr_names = self.class.attribute_names.select { |name| has_attribute?(name) }
      pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
        pp.breakable " "
        pp.group(1) do
          pp.text attr_name
          pp.text ":"
          pp.breakable
          value = _read_attribute(attr_name)
          value = inspection_filter.filter_param(attr_name, value) unless value.nil?
          pp.pp value
        end
      end
    else
      pp.breakable " "
      pp.text "not initialized"
    end
  end
end

#readonly! ⇒ Object

Marks this record as read only.



247
248
249
 
# File 'lib/active_entity/core.rb', line 247

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) 


242
243
244
 
# File 'lib/active_entity/core.rb', line 242

def readonly?
  @readonly
end

#slice(*methods) ⇒ Object

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



301
302
303
 
# File 'lib/active_entity/core.rb', line 301

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