surrogate 0.6.3 → 0.6.4

data/Changelog.md

@@ -1,3 +1,8 @@
+### 0.6.4
+
+* Remove explicit reference to RSpec::Matchers so that surrogate/rspec doesn't depend on rspec-expectations
+* Add `define_setter`, `define_getter`, `define_accessor` which mimic Ruby's `attr_*` methods, but are also recorded / overridable.
+
 ### 0.6.3
 
 * Allow mass initialization of instances with `MockClass.factory key: value`

data/Readme.md

@@ -9,7 +9,7 @@ Handrolling mocks is the best, but involves more overhead than necessary, and us
 error messages. Surrogate addresses this by endowing your objects with common things that most mocks need.
 Currently it is only integrated with RSpec.
 
-This codebase should be considered highly volatile until 1.0 release. The outer interface should be
+This codebase should be considered volatile until 1.0 release. The outer interface should be
 fairly stable, with each 0.a.b version having backwards compatibility for any changes to b (ie
 only refactorings and new features), and possible interface changes (though probably minimal)
 for changes to a. Depending on the internals of the code (anything not shown in the readme) is
@@ -20,8 +20,7 @@ that I introduce.
 Features
 ========
 
-* Declarative syntax
-* Can compare signatures of mocks to signatures of the class being mocked
+* Mock does not diverge from real class because compares signatures of mocks to signatures of the real class.
 * Support default values
 * Easily override values
 * RSpec matchers for asserting what happend (what was invoked, with what args, how many times)
@@ -64,6 +63,21 @@ end
 MockClient.new.request # => ["result1", "result2"]
 ```
 
+Ruby's `attr_accessor`, `attr_reader`, `attr_writer` are mimicked with `define_accessor`, `define_reader`, `define_writer`.
+You can pass a block to `define_accessor` and `define_reader` if you would like to give it a default_value.
+
+```ruby
+class MockClient
+  Surrogate.endow self
+  define_accessor :default_url
+end
+
+client = MockClient.new
+client.default_url # => nil
+client.default_url = 'http://whatever.com'
+client.default_url # => "http://whatever.com"
+```
+
 If you expect **arguments**, your block should receive them.
 This prevents the issues with dynamic mocks where arguments and parameters can diverge.
 It may seem like more work when you have to write the arguments explicitly, but you only
@@ -197,13 +211,13 @@ user.name # => "Jim"
 user.age  # => 26
 
 # use a different name
-class MockUserWithoutFactory
+class MockUserWithRenamedFactory
   Surrogate.endow self, factory: :construct
   define(:name) { 'Samantha' }
   define(:age)  { 83 }
 end
 
-user = MockUserWithoutFactory.construct name: 'Milla'
+user = MockUserWithRenamedFactory.construct name: 'Milla'
 user.name # => "Milla"
 user.age  # => 83
 ```

data/Readme.md.mountain_berry_fields

@@ -21,7 +21,7 @@ Handrolling mocks is the best, but involves more overhead than necessary, and us
 error messages. Surrogate addresses this by endowing your objects with common things that most mocks need.
 Currently it is only integrated with RSpec.
 
-This codebase should be considered highly volatile until 1.0 release. The outer interface should be
+This codebase should be considered volatile until 1.0 release. The outer interface should be
 fairly stable, with each 0.a.b version having backwards compatibility for any changes to b (ie
 only refactorings and new features), and possible interface changes (though probably minimal)
 for changes to a. Depending on the internals of the code (anything not shown in the readme) is
@@ -32,8 +32,7 @@ that I introduce.
 Features
 ========
 
-* Declarative syntax
-* Can compare signatures of mocks to signatures of the class being mocked
+* Mock does not diverge from real class because compares signatures of mocks to signatures of the real class.
 * Support default values
 * Easily override values
 * RSpec matchers for asserting what happend (what was invoked, with what args, how many times)
@@ -82,6 +81,23 @@ MockClient.new.request # => ["result1", "result2"]
 <% end %>
 ```
 
+Ruby's `attr_accessor`, `attr_reader`, `attr_writer` are mimicked with `define_accessor`, `define_reader`, `define_writer`.
+You can pass a block to `define_accessor` and `define_reader` if you would like to give it a default_value.
+
+```ruby
+<% test 'attr_* replacements', with: :magic_comments do %>
+class MockClient
+  Surrogate.endow self
+  define_accessor :default_url
+end
+
+client = MockClient.new
+client.default_url # => nil
+client.default_url = 'http://whatever.com'
+client.default_url # => "http://whatever.com"
+<% end %>
+```
+
 If you expect **arguments**, your block should receive them.
 This prevents the issues with dynamic mocks where arguments and parameters can diverge.
 It may seem like more work when you have to write the arguments explicitly, but you only
@@ -230,13 +246,13 @@ user.name # => "Jim"
 user.age  # => 26
 
 # use a different name
-class MockUserWithoutFactory
+class MockUserWithRenamedFactory
   Surrogate.endow self, factory: :construct
   define(:name) { 'Samantha' }
   define(:age)  { 83 }
 end
 
-user = MockUserWithoutFactory.construct name: 'Milla'
+user = MockUserWithRenamedFactory.construct name: 'Milla'
 user.name # => "Milla"
 user.age  # => 83
 <% end %>

data/lib/surrogate/endower.rb

@@ -78,7 +78,28 @@ class Surrogate
 
     def enable_defining_methods(klass)
       def klass.define(method_name, options={}, &block)
-        @hatchery.define method_name, options, &block
+        @hatchery.define method_name.to_sym, options, &block
+      end
+
+      def klass.define_reader(*method_names, &block)
+        block ||= lambda {}
+        method_names.each { |method_name| define method_name, &block }
+        self
+      end
+
+      def klass.define_writer(*method_names)
+        method_names.each do |method_name|
+          define "#{method_name}=" do |value|
+            instance_variable_set("@#{method_name}", value)
+          end
+        end
+        self
+      end
+
+      def klass.define_accessor(*method_names, &block)
+        define_reader(*method_names, &block)
+        define_writer(*method_names)
+        self
       end
     end
 

data/lib/surrogate/hatchling.rb

@@ -19,7 +19,9 @@ class Surrogate
     def invoke_method(method_name, args, &block)
       invocation = Invocation.new(args, &block)
       invoked_methods[method_name] << invocation
-      return get_default method_name, invocation, &block unless has_ivar? method_name
+      if setter?(method_name) || !has_ivar?(method_name)
+        return get_default method_name, invocation, &block
+      end
       interfaces_must_match! method_name, args
       Value.factory(get_ivar method_name).value(method_name)
     end
@@ -35,6 +37,10 @@ class Surrogate
 
   private
 
+    def setter?(method_name)
+      method_name.match(/\w=$/)
+    end
+
     def invoked_methods
       @invoked_methods ||= Hash.new do |hash, method_name|
         must_know method_name

data/lib/surrogate/rspec.rb

@@ -23,6 +23,10 @@ class Surrogate
     end
 
     module Matchers
+      def substitute_for(original_class, options={})
+        SubstitutionMatcher.new original_class, options
+      end
+
       def have_been_told_to(method_name)
         VerbMatcher.new method_name
       end
@@ -65,7 +69,7 @@ class Surrogate
   end
 end
 
-require 'surrogate/rspec/substitute_for'
+require 'surrogate/rspec/substitution_matcher'
 require 'surrogate/rspec/predicate_matcher'
 require 'surrogate/rspec/noun_matcher'
 require 'surrogate/rspec/initialization_matcher'

data/lib/surrogate/rspec/invocation_matcher.rb

@@ -9,7 +9,7 @@ class Surrogate
       attr_accessor :times_predicate, :with_filter, :surrogate, :method_name
 
       def initialize(method_name)
-        self.method_name     = method_name
+        self.method_name     = method_name.to_sym
         self.times_predicate = TimesPredicate.new
         self.with_filter     = WithFilter.new
       end
@@ -27,14 +27,6 @@ class Surrogate
         SurrogateInstanceReflector.new(surrogate).invocations(method_name)
       end
 
-      def failure_message_for_should
-        raise "THIS METHOD SHOULD HAVE BEEN OVERRIDDEN"
-      end
-
-      def failure_message_for_should_not
-        raise "THIS METHOD SHOULD HAVE BEEN OVERRIDDEN"
-      end
-
       def times(times_invoked)
         @times_predicate = TimesPredicate.new(times_invoked, :==)
         self

data/lib/surrogate/rspec/substitution_matcher.rb

@@ -0,0 +1,67 @@
+class Surrogate
+  module RSpec
+    class SubstitutionMatcher
+      def initialize(original_class, options={})
+        @original_class = original_class
+        @comparison     = nil
+        @subset_only    = options.fetch :subset, false
+        @types          = options.fetch :types,  true
+        @names          = options.fetch :names,  false
+      end
+
+      def matches?(surrogate)
+        @comparison = ApiComparer.new(surrogate, @original_class).compare
+        comparing_fields(@comparison, @subset_only, @types, @names).values.inject(:+).empty?
+      end
+
+
+      def failure_message_for_should
+        extra_instance_methods   = @comparison[:instance][:not_on_actual   ].to_a # these come in as sets
+        extra_class_methods      = @comparison[:class   ][:not_on_actual   ].to_a
+        missing_instance_methods = @comparison[:instance][:not_on_surrogate].to_a
+        missing_class_methods    = @comparison[:class   ][:not_on_surrogate].to_a
+        instance_type_mismatch   = @comparison[:instance][:types           ]
+        class_type_mismatch      = @comparison[:class   ][:types           ]
+        instance_name_mismatch   = @comparison[:instance][:names           ]
+        class_name_mismatch      = @comparison[:class   ][:names           ]
+
+
+        differences = []
+        differences << "has extra instance methods: #{extra_instance_methods.inspect}" if extra_instance_methods.any?
+        differences << "has extra class methods: #{extra_class_methods.inspect}"       if extra_class_methods.any?
+        differences << "is missing instance methods: #{missing_instance_methods}"      if !@subset_only && missing_instance_methods.any?
+        differences << "is missing class methods: #{missing_class_methods}"            if !@subset_only && missing_class_methods.any?
+
+        if @types # this conditional is not tested, nor are these error messages
+          instance_type_mismatch.each { |name, types| differences << "##{name} had types #{types.inspect}" }
+          class_type_mismatch.each    { |name, types| differences << ".#{name} had types #{types.inspect}" }
+        end
+
+        if @names # this conditional is not tested, nor are these error messages
+          instance_name_mismatch.each { |method_name, param_names| differences << "##{method_name} had parameter names #{param_names.inspect}" }
+          class_type_mismatch.each    { |method_name, param_names| differences << ".#{method_name} had parameter names #{param_names.inspect}" }
+        end
+        "Was not substitutable because surrogate " << differences.join("\n")
+      end
+
+      def failure_message_for_should_not
+        "Should not have been substitute, but was"
+      end
+
+    private
+
+      def comparing_fields(comparison, subset_only, types, names)
+        fields = {}
+        fields[:instance_not_on_actual   ] = comparison[:instance][:not_on_actual]
+        fields[:class_not_on_actual      ] = comparison[:class   ][:not_on_actual]
+        fields[:instance_not_on_surrogate] = comparison[:instance][:not_on_surrogate] unless @subset_only
+        fields[:class_not_on_surrogate   ] = comparison[:class   ][:not_on_surrogate] unless @subset_only
+        fields[:instance_types           ] = comparison[:instance][:types]            if @types
+        fields[:class_types              ] = comparison[:class   ][:types]            if @types
+        fields[:instance_names           ] = comparison[:instance][:names]            if @names
+        fields[:class_names              ] = comparison[:class   ][:names]            if @names
+        fields
+      end
+    end
+  end
+end

data/lib/surrogate/version.rb

@@ -1,3 +1,3 @@
 class Surrogate
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/spec/defining_api_methods_spec.rb

@@ -47,6 +47,12 @@ describe 'define' do
     it "returns the value that the method returns" do
       mocked_class.define(:meth) { 1234 }.new.meth.should == 1234
     end
+
+    it "always invokes the block when the method is a setter (ends in '=')" do
+      a = 0
+      mocked_class.define(:meth=) { |value| a = value }.new.meth = 1234
+      a.should == 1234
+    end
   end
 
   describe 'declaring the behaviour' do
@@ -170,6 +176,13 @@ describe 'define' do
       expect { mocked_class.new.meth 1, 2 }.to raise_error ArgumentError, /2 for 1/
     end
 
+    it "can be defined with symbols or strings" do
+      mocked_class.define("meth") { |a| a }
+      mocked_class.define(:other_meth) { |a| a * 2 }
+      mocked_class.new.meth(1).should == 1
+      mocked_class.new.other_meth(1).should == 2
+    end
+
     it 'raises an UnpreparedMethodError when it has no default block' do
       mocked_class.define :meth
       expect { instance.meth }.to raise_error Surrogate::UnpreparedMethodError, /meth/
@@ -316,3 +329,57 @@ describe 'define' do
     end
   end
 end
+
+describe 'defining accessors' do
+  specify '#define_reader is an api method for attr_reader' do
+    instance = Surrogate.endow(Class.new).define_reader(:eric, :josh).new
+    instance.was_not asked_for :eric
+    instance.eric.should == nil
+    instance.was asked_for :eric
+    instance.josh.should be_nil
+  end
+
+  specify '#define_reader can be defined with a value' do
+    instance = Surrogate.endow(Class.new).define_reader(:eric, :josh) { "is awesome" }.new
+    instance.eric.should == "is awesome"
+    instance.will_have_eric("less awesome")
+    instance.josh.should == "is awesome"
+  end
+
+  specify '#define_writer is an api method for attr_writer' do
+    instance = Surrogate.endow(Class.new).define_writer(:eric, :josh).new
+    instance.was_not told_to :eric=
+    instance.eric = "was here"
+    instance.instance_variable_get("@eric").should == "was here"
+    instance.was told_to :eric=
+    instance.josh = "was here"
+  end
+
+  specify '#define_accessor is an api method for attr_accessor' do
+    instance = Surrogate.endow(Class.new).define_accessor(:eric, :josh).new
+    instance.was_not asked_for :eric
+    instance.eric.should == nil
+    instance.eric = "was here"
+    instance.eric.should == "was here"
+    instance.was asked_for :eric
+    instance.josh = "was also here"
+    instance.josh.should == "was also here"
+  end
+
+  specify '#define_accessor can take a block for the reader' do
+    instance = Surrogate.endow(Class.new).define_accessor(:eric) {"was here"}.new
+    instance.was_not asked_for :eric
+    instance.eric.should == "was here"
+    instance.was asked_for :eric
+    instance.eric = "was somewhere else"
+    instance.eric.should == "was somewhere else"
+  end
+
+  specify 'they can be defined on the class or the instance' do
+    klass = Surrogate.endow(Class.new) { define_accessor(:i_belong_with_you) { 'you belong with me' } }
+    klass.i_belong_with_you.should == 'you belong with me'
+    klass.i_belong_with_you = "you're my sweetheart"
+    klass.i_belong_with_you.should == "you're my sweetheart"
+    klass.was told_to :i_belong_with_you
+  end
+end

data/spec/rspec/verb_matcher_spec.rb

@@ -23,7 +23,7 @@ shared_examples_for 'a verb matcher' do
   describe 'default use case' do
     before { mocked_class.define :kick, default: [] }
 
-    example 'passes if has been invoked at least once' do
+    example 'passes with a symbol if has been invoked at least once' do
       did_not :kick
       instance.kick
       did :kick
@@ -31,6 +31,14 @@ shared_examples_for 'a verb matcher' do
       did :kick
     end
 
+    example 'passes with a string if invoked at least once' do
+      did_not "kick"
+      instance.kick
+      did "kick"
+      instance.kick
+      did "kick"
+    end
+
     example 'failure message for should' do
       expect { did :kick }.to \
         raise_error(RSpec::Expectations::ExpectationNotMetError, /was never told to kick/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surrogate
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70232941137100 !ruby/object:Gem::Requirement
+  requirement: &70270737052860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70232941137100
+  version_requirements: *70270737052860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70232941136540 !ruby/object:Gem::Requirement
+  requirement: &70270737052300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70232941136540
+  version_requirements: *70270737052300
 - !ruby/object:Gem::Dependency
   name: mountain_berry_fields
-  requirement: &70232941135960 !ruby/object:Gem::Requirement
+  requirement: &70270737051720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *70232941135960
+  version_requirements: *70270737051720
 - !ruby/object:Gem::Dependency
   name: mountain_berry_fields-rspec
-  requirement: &70232941135400 !ruby/object:Gem::Requirement
+  requirement: &70270737051180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *70232941135400
+  version_requirements: *70270737051180
 - !ruby/object:Gem::Dependency
   name: mountain_berry_fields-magic_comments
-  requirement: &70232941134860 !ruby/object:Gem::Requirement
+  requirement: &70270737050560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *70232941134860
+  version_requirements: *70270737050560
 description: Framework to aid in handrolling mock/spy objects.
 email:
 - josh.cheek@gmail.com
@@ -99,7 +99,7 @@ files:
 - lib/surrogate/rspec/invocation_matcher.rb
 - lib/surrogate/rspec/noun_matcher.rb
 - lib/surrogate/rspec/predicate_matcher.rb
-- lib/surrogate/rspec/substitute_for.rb
+- lib/surrogate/rspec/substitution_matcher.rb
 - lib/surrogate/rspec/times_predicate.rb
 - lib/surrogate/rspec/verb_matcher.rb
 - lib/surrogate/rspec/with_filter.rb

data/lib/surrogate/rspec/substitute_for.rb

@@ -1,61 +0,0 @@
-class Surrogate
-  # turn this into a real class
-  ::RSpec::Matchers.define :substitute_for do |original_class, options={}|
-
-    comparison  = nil
-    subset_only = options[:subset]
-    types       = options.fetch :types, true
-    names       = options.fetch :names, false
-
-    def comparing_fields(comparison, subset_only, types, names)
-      fields = {}
-      fields[:instance_not_on_actual   ] = comparison[:instance][:not_on_actual]
-      fields[:class_not_on_actual      ] = comparison[:class   ][:not_on_actual]
-      fields[:instance_not_on_surrogate] = comparison[:instance][:not_on_surrogate] unless subset_only
-      fields[:class_not_on_surrogate   ] = comparison[:class   ][:not_on_surrogate] unless subset_only
-      fields[:instance_types           ] = comparison[:instance][:types]            if types
-      fields[:class_types              ] = comparison[:class   ][:types]            if types
-      fields[:instance_names           ] = comparison[:instance][:names]            if names
-      fields[:class_names              ] = comparison[:class   ][:names]            if names
-      fields
-    end
-
-    match do |mocked_class|
-      comparison = ApiComparer.new(mocked_class, original_class).compare
-      comparing_fields(comparison, subset_only, types, names).values.inject(:+).empty?
-    end
-
-    failure_message_for_should do
-      extra_instance_methods   = comparison[:instance][:not_on_actual   ].to_a # these come in as sets
-      extra_class_methods      = comparison[:class   ][:not_on_actual   ].to_a
-      missing_instance_methods = comparison[:instance][:not_on_surrogate].to_a
-      missing_class_methods    = comparison[:class   ][:not_on_surrogate].to_a
-      instance_type_mismatch   = comparison[:instance][:types           ]
-      class_type_mismatch      = comparison[:class   ][:types           ]
-      instance_name_mismatch   = comparison[:instance][:names           ]
-      class_name_mismatch      = comparison[:class   ][:names           ]
-
-
-      differences = []
-      differences << "has extra instance methods: #{extra_instance_methods.inspect}" if extra_instance_methods.any?
-      differences << "has extra class methods: #{extra_class_methods.inspect}"       if extra_class_methods.any?
-      differences << "is missing instance methods: #{missing_instance_methods}"      if !subset_only && missing_instance_methods.any?
-      differences << "is missing class methods: #{missing_class_methods}"            if !subset_only && missing_class_methods.any?
-
-      if types # this conditional is not tested, nor are these error messages
-        instance_type_mismatch.each { |name, types| differences << "##{name} had types #{types.inspect}" }
-        class_type_mismatch.each    { |name, types| differences << ".#{name} had types #{types.inspect}" }
-      end
-
-      if names # this conditional is not tested, nor are these error messages
-        instance_name_mismatch.each { |method_name, param_names| differences << "##{method_name} had parameter names #{param_names.inspect}" }
-        class_type_mismatch.each    { |method_name, param_names| differences << ".#{method_name} had parameter names #{param_names.inspect}" }
-      end
-      "Was not substitutable because surrogate " << differences.join("\n")
-    end
-
-    failure_message_for_should_not do
-      "Should not have been substitute, but was"
-    end
-  end
-end