Class: ActiveMocker::Base

Inherits:
Object
  • Object
show all
Extended by:
Queries
Includes:
PropertiesGetterAndSetter, DoNothingActiveRecordMethods, MockAbilities, TemplateMethods
Defined in:
lib/active_mocker/mock/base.rb,
lib/active_mocker/deprecated_components/mock_abilities.rb

Defined Under Namespace

Modules: PropertiesGetterAndSetter, Scopes Classes: ScopeRelation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Queries

all, average, count, delete_all, find, find_by, find_by!, find_or_create_by, find_or_initialize_by, limit, maximum, minimum, none, order, reverse_order, sum, update_all, where

Methods included from TemplateMethods

included

Methods included from DoNothingActiveRecordMethods

#destroyed?, #errors, included, #marked_for_destruction?, #readonly?, #reload, #valid?

Methods included from MockAbilities

#clear_mocked_methods, included, prepended

Methods included from MockAbilities::InstanceAndClassMethods

#clear_mock, #clear_mocked_methods, #mock_instance_method

Constructor Details

#initialize(attributes = {}, &block) ⇒ Base

New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes.

Example:

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



170
171
172
173
174
175
176
 
# File 'lib/active_mocker/mock/base.rb', line 170

def initialize(attributes = {}, &block)
  if self.class.abstract_class?
    raise NotImplementedError, "#{self.class.name} is an abstract class and cannot be instantiated."
  end
  setup_instance_variables
  assign_attributes(attributes, &block)
end

Instance Attribute Details

#_create_caller_locations ⇒ Object 



162
163
164
 
# File 'lib/active_mocker/mock/base.rb', line 162

def _create_caller_locations
  @_create_caller_locations
end

#associations ⇒ Object (readonly)

Returns the value of attribute associations.



160
161
162
 
# File 'lib/active_mocker/mock/base.rb', line 160

def associations
  @associations
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



160
161
162
 
# File 'lib/active_mocker/mock/base.rb', line 160

def attributes
  @attributes
end

#types ⇒ Object (readonly)

Returns the value of attribute types.



160
161
162
 
# File 'lib/active_mocker/mock/base.rb', line 160

def types
  @types
end

Class Method Details

.__new_relation__(collection) ⇒ ScopeRelation

Returns for the given mock so that it will include any scoped methods.

Parameters:

Returns:

  • (ScopeRelation) —

    for the given mock so that it will include any scoped methods



113
114
115
 
# File 'lib/active_mocker/mock/base.rb', line 113

def __new_relation__(collection)
  ScopeRelation.new(collection)
end

._find_associations_by_class(klass_name) ⇒ Object 



126
127
128
 
# File 'lib/active_mocker/mock/base.rb', line 126

def _find_associations_by_class(klass_name)
  associations_by_class[klass_name.to_s]
end

.abstract_class? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/active_mocker/mock/base.rb', line 98

def abstract_class?
  true
end

.build_type(type) ⇒ Object 



102
103
104
105
 
# File 'lib/active_mocker/mock/base.rb', line 102

def build_type(type)
  @@built_types       ||= {}
  @@built_types[type] ||= Virtus::Attribute.build(type)
end

.classes(klass) ⇒ Object 



107
108
109
 
# File 'lib/active_mocker/mock/base.rb', line 107

def classes(klass)
  ActiveMocker::LoadedMocks.find(klass)
end

.clear_mock ⇒ Object

Deprecated. 


122
123
124
 
# File 'lib/active_mocker/mock/base.rb', line 122

def clear_mock
  delete_all
end

.create(attributes = {}, &block) ⇒ Object Also known as: create!

Creates an object (or multiple objects) and saves it to memory.

The attributes parameter can be either a Hash or an Array of Hashes. These Hashes describe the attributes on the objects that are to be created.

Examples

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

# Create an Array of new objects
User.create([{ first_name: 'Jamie' }, { first_name: 'Jeremy' }])

# Create a single object and pass it into a block to set other attributes.
User.create(first_name: 'Jamie') do |u|
  u.is_admin = false
end

# Creating an Array of new objects using a block, where the block is executed for each object:
User.create([{ first_name: 'Jamie' }, { first_name: 'Jeremy' }]) do |u|
  u.is_admin = false
end



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/active_mocker/mock/base.rb', line 34

def create(attributes = {}, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| create(attr, &block) }
  else
    record = new(id: attributes.delete(:id) || attributes.delete("id"))
    record.save
    record.assign_attributes(attributes, &block)
    record._create_caller_locations = caller_locations
    record
  end
end

.delete(id) ⇒ Object

Delete an object (or multiple objects) that has the given id.

This essentially finds the object (or multiple objects) with the given id and then calls delete on it.

Parameters

  • id - Can be either an Integer or an Array of Integers.

Examples

# Destroy a single object
TodoMock.delete(1)

# Destroy multiple objects
todos = [1,2,3]
TodoMock.delete(todos)



73
74
75
76
77
78
79
 
# File 'lib/active_mocker/mock/base.rb', line 73

def delete(id)
  if id.is_a?(Array)
    id.map { |one_id| delete(one_id) }
  else
    find(id).delete
  end
end

.delete_all(conditions = nil) ⇒ Object Also known as: destroy_all

Deletes the records matching conditions.

Post.where(person_id: 5).where(category: ['Something', 'Else']).delete_all



86
87
88
89
 
# File 'lib/active_mocker/mock/base.rb', line 86

def delete_all(conditions=nil)
  return records.reset if conditions.nil?
  super
end

.destroy ⇒ Object

Delete an object (or multiple objects) that has the given id.

This essentially finds the object (or multiple objects) with the given id and then calls delete on it.

Parameters

  • id - Can be either an Integer or an Array of Integers.

Examples

# Destroy a single object
TodoMock.delete(1)

# Destroy multiple objects
todos = [1,2,3]
TodoMock.delete(todos)



81
82
83
84
85
86
87
 
# File 'lib/active_mocker/mock/base.rb', line 81

def delete(id)
  if id.is_a?(Array)
    id.map { |one_id| delete(one_id) }
  else
    find(id).delete
  end
end

.from_limit? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/active_mocker/mock/base.rb', line 94

def from_limit?
  false
end

.inherited(subclass) ⇒ Object 



7
8
9
 
# File 'lib/active_mocker/mock/base.rb', line 7

def self.inherited(subclass)
  return ActiveMocker::LoadedMocks.send(:add, subclass) if subclass.superclass == Base
end

.records ⇒ Object 



48
49
50
 
# File 'lib/active_mocker/mock/base.rb', line 48

def records
  @records ||= Records.new
end

Instance Method Details

#_assign_attribute(k, v) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



206
207
208
209
210
211
212
213
214
 
# File 'lib/active_mocker/mock/base.rb', line 206

def _assign_attribute(k, v)
  public_send("#{k}=", v)
rescue NoMethodError
  if respond_to?("#{k}=")
    raise
  else
    raise UnknownAttributeError.new(self, k)
  end
end

#assign_attributes(new_attributes) {|_self| ... } ⇒ Object Also known as: attributes=

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Yields:

  • (_self)

Yield Parameters:



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/active_mocker/mock/base.rb', line 191

def assign_attributes(new_attributes, &block)
  yield self if block_given?
  unless new_attributes.respond_to?(:stringify_keys)
    raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
  end
  return nil if new_attributes.blank?
  attributes = new_attributes.stringify_keys
  attributes.each do |k, v|
    _assign_attribute(k, v)
  end
end

#attribute_names ⇒ Object

Returns an array of names for the attributes available on this object.

person = Person.new
person.attribute_names
# => ["id", "created_at", "updated_at", "name", "age"]



283
284
285
 
# File 'lib/active_mocker/mock/base.rb', line 283

def attribute_names
  self.class.attribute_names
end

#attribute_present?(attribute) ⇒ Boolean

Returns true if the specified attribute has been set and is neither nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings). Otherwise, false. Note that it always returns true with boolean attributes.

person = Task.new(title: '', is_done: false)
person.attribute_present?(:title)   # => false
person.attribute_present?(:is_done) # => true
person.name = 'Francesco'
person.is_done = true
person.attribute_present?(:title)   # => true
person.attribute_present?(:is_done) # => true

Returns:

  • (Boolean) 


273
274
275
276
 
# File 'lib/active_mocker/mock/base.rb', line 273

def attribute_present?(attribute)
  value = read_attribute(attribute)
  !value.nil? && !(value.respond_to?(:empty?) && value.empty?)
end

#delete ⇒ Object Also known as: destroy 



231
232
233
 
# File 'lib/active_mocker/mock/base.rb', line 231

def delete
  records.delete(self)
end

#freeze ⇒ Object

Will not allow attributes to be changed

Will freeze attributes forever. Querying for the record again will not unfreeze it because records exist in memory and are not initialized upon a query. This behaviour differs from ActiveRecord, beware of any side effect this may have when using this method.



296
297
298
 
# File 'lib/active_mocker/mock/base.rb', line 296

def freeze
  @attributes.freeze; self
end

#has_attribute?(attr_name) ⇒ Boolean

Returns true if the given attribute is in the attributes hash, otherwise false.

person = Person.new
person.has_attribute?(:name)    # => true
person.has_attribute?('age')    # => true
person.has_attribute?(:nothing) # => false

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/active_mocker/mock/base.rb', line 258

def has_attribute?(attr_name)
  @attributes.has_key?(attr_name.to_s)
end

#inspect ⇒ Object 



287
288
289
 
# File 'lib/active_mocker/mock/base.rb', line 287

def inspect
  ObjectInspect.new(self.class.name, attributes).to_s
end

#new_record? ⇒ Boolean

Returns true if this object hasn’t been saved yet; otherwise, returns false.

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/active_mocker/mock/base.rb', line 240

def new_record?
  records.new_record?(self)
end

#persisted? ⇒ Boolean

Indicates if the model is persisted. Default is false.

person = Person.new(id: 1, name: 'bob')
person.persisted? # => false

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/active_mocker/mock/base.rb', line 248

def persisted?
  records.persisted?(id)
end

#save(*args) ⇒ Object Also known as: save! 



216
217
218
219
220
221
 
# File 'lib/active_mocker/mock/base.rb', line 216

def save(*args)
  unless self.class.exists?(self)
    self.class.send(:insert, self)
  end
  true
end

#update(attributes = {}) ⇒ Object 



186
187
188
 
# File 'lib/active_mocker/mock/base.rb', line 186

def update(attributes={})
  assign_attributes(attributes)
end