Class: ActiveMocker::Mock::Base

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

Defined Under Namespace

Modules: PropertiesGetterAndSetter 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, order, reverse_order, sum, update_all, where

Methods included from TemplateMethods

included

Methods included from MockAbilities

#clear_mocked_methods, included

Methods included from MockAbilities::InstanceAndClassMethods

#clear_mocked_methods, #mock_instance_method

Methods included from DoNothingActiveRecordMethods

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

Constructor Details

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

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
UserMock.new(first_name: 'Jamie')



141
142
143
144
 
# File 'lib/active_mocker/mock/base.rb', line 141

def initialize(attributes = {}, &block)
  setup_instance_variables
  assign_attributes(attributes, &block)
end

Instance Attribute Details

#associations ⇒ Object (readonly)

Returns the value of attribute associations.



131
132
133
 
# File 'lib/active_mocker/mock/base.rb', line 131

def associations
  @associations
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



131
132
133
 
# File 'lib/active_mocker/mock/base.rb', line 131

def attributes
  @attributes
end

#types ⇒ Object (readonly)

Returns the value of attribute types.



131
132
133
 
# File 'lib/active_mocker/mock/base.rb', line 131

def types
  @types
end

Class Method Details

.build_type(type) ⇒ Object 



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

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

.classes(klass) ⇒ Object 



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

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

.clear_mock ⇒ Object 



118
119
120
121
 
# File 'lib/active_mocker/mock/base.rb', line 118

def clear_mock
  clear_mocked_methods
  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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/active_mocker/mock/base.rb', line 38

def create(attributes = {}, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| create(attr, &block) }
  else
    record = new(id: attributes[:id] || attributes['id'])
    record.save
    record.assign_attributes(attributes, &block)
    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)



76
77
78
79
80
81
82
 
# File 'lib/active_mocker/mock/base.rb', line 76

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



89
90
91
92
 
# File 'lib/active_mocker/mock/base.rb', line 89

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)



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

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. 



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

def from_limit?
  false
end

.inherited(subclass) ⇒ Object 



10
11
12
13
 
# File 'lib/active_mocker/mock/base.rb', line 10

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

.new_relation(collection) ⇒ Object 



110
111
112
 
# File 'lib/active_mocker/mock/base.rb', line 110

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

.records ⇒ Object 



51
52
53
 
# File 'lib/active_mocker/mock/base.rb', line 51

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. 



174
175
176
177
178
179
180
181
182
 
# File 'lib/active_mocker/mock/base.rb', line 174

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:



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/active_mocker/mock/base.rb', line 159

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"]



252
253
254
 
# File 'lib/active_mocker/mock/base.rb', line 252

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



242
243
244
245
 
# File 'lib/active_mocker/mock/base.rb', line 242

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

#delete ⇒ Object Also known as: destroy 



200
201
202
 
# File 'lib/active_mocker/mock/base.rb', line 200

def delete
  records.delete(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



227
228
229
 
# File 'lib/active_mocker/mock/base.rb', line 227

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

#inspect ⇒ Object 



256
257
258
 
# File 'lib/active_mocker/mock/base.rb', line 256

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.



209
210
211
 
# File 'lib/active_mocker/mock/base.rb', line 209

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



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

def persisted?
  records.persisted?(id)
end

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



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

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

#update(attributes = {}) ⇒ Object 



154
155
156
 
# File 'lib/active_mocker/mock/base.rb', line 154

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