Module: Spec::Rails::Mocks

Included in:
ActiveSupport::TestCase
Defined in:
lib/spec/rails/mocks.rb

Defined Under Namespace

Modules: ModelStubber

Instance Method Summary collapse

Instance Method Details

#add_stubs(object, stubs = {}) ⇒ Object

DEPRECATED - use object.stub!(:method => value, :method2 => value)

Stubs methods on object (if object is a symbol or string a new mock with that name will be created). stubs is a Hash of method=>value



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/spec/rails/mocks.rb', line 121

def add_stubs(object, stubs = {}) #:nodoc:
  Kernel.warn <<-WARNING
DEPRECATION NOTICE: add_stubs is deprecated and will be removed
from a future version of rspec-rails. Use this instead:
  
  object.stub!(:method => value, :method2 => value)
  
WARNING
  object.stub!(stubs)
end

#mock_model(model_class, options_and_stubs = {}) {|m| ... } ⇒ Object

Creates a mock object instance for a model_class with common methods stubbed out. Additional methods may be easily stubbed (via add_stubs) if stubs is passed.

Yields:

  • (m) 


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/spec/rails/mocks.rb', line 11

def mock_model(model_class, options_and_stubs = {})
  id = options_and_stubs[:id] || next_id
  options_and_stubs = options_and_stubs.reverse_merge({
    :id => id,
    :to_param => id.to_s,
    :new_record? => false,
    :destroyed? => false,
    :marked_for_destruction? => false,
    :errors => stub("errors", :count => 0)
  })
  m = mock("#{model_class.name}_#{id}", options_and_stubs)
  m.__send__(:__mock_proxy).instance_eval <<-CODE
    def @target.as_new_record
      self.stub(:id).and_return nil
      self.stub(:to_param).and_return nil
      self.stub(:new_record?).and_return true
      self
    end
    def @target.to_str
      self.to_s
    end
    def @target.is_a?(other)
      #{model_class}.ancestors.include?(other)
    end
    def @target.kind_of?(other)
      #{model_class}.ancestors.include?(other)
    end
    def @target.instance_of?(other)
      other == #{model_class}
    end
    def @target.class
      #{model_class}
    end
  CODE
  yield m if block_given?
  m
end

#stub_model(model_class, stubs = {}) ⇒ Object

:call-seq:

stub_model(Model)
stub_model(Model).as_new_record
stub_model(Model, hash_of_stubs)
stub_model(Model, instance_variable_name, hash_of_stubs)

Creates an instance of Model that is prohibited from accessing the database*. For each key in hash_of_stubs, if the model has a matching attribute (determined by asking it) are simply assigned the submitted values. If the model does not have a matching attribute, the key/value pair is assigned as a stub return value using RSpec’s mocking/stubbing framework.

new_record? is overridden to return the result of id.nil? This means that by default new_record? will return false. If you want the object to behave as a new record, sending it as_new_record will set the id to nil. You can also explicitly set :id => nil, in which case new_record? will return true, but using as_new_record makes the example a bit more descriptive.

While you can use stub_model in any example (model, view, controller, helper), it is especially useful in view examples, which are inherently more state-based than interaction-based.

Database Independence

stub_model does not make your examples entirely database-independent. It does not stop the model class itself from loading up its columns from the database. It just prevents data access from the object itself. To completely decouple from the database, take a look at libraries like unit_record or NullDB.

Examples

stub_model(Person)
stub_model(Person).as_new_record
stub_model(Person, :id => 37)
stub_model(Person) do |person|
  person.first_name = "David"
end



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/spec/rails/mocks.rb', line 102

def stub_model(model_class, stubs={})
  stubs = {:id => next_id}.merge(stubs)
  model_class.new.tap do |model|
    model.id = stubs.delete(:id)
    model.extend ModelStubber
    stubs.each do |k,v|
      if model.has_attribute?(k)
        model[k] = stubs.delete(k)
      end
    end
    model.stub!(stubs)
    yield model if block_given?
  end
end