bogus 0.1.4 → 0.1.5

data/features/fakes/replacing_classes.feature

@@ -55,7 +55,7 @@ Feature: Replacing classes with fakes
                  {name: "Moby Dick", author: "Herman Melville"}]
         File.open(Library::FILE, "w") { |f| f.print books.to_yaml }
 
-        Library.books.should == books
+        expect(Library.books).to eq(books)
       end
 
       after do
@@ -77,7 +77,7 @@ Feature: Replacing classes with fakes
 
         fake_class(Library, books: [tom_sawyer, moby_dick])
 
-        BookIndex.by_author("Mark Twain").should == [tom_sawyer]
+        expect(BookIndex.by_author("Mark Twain")).to eq([tom_sawyer])
       end
     end
     """
@@ -99,7 +99,7 @@ Feature: Replacing classes with fakes
                  {name: "Moby Dick", author: "Herman Melville"}]
         File.open(Library::FILE, "w") { |f| f.print books.to_yaml }
 
-        Library.books.should == books
+        expect(Library.books).to eq(books)
       end
 
       after do
@@ -122,7 +122,7 @@ Feature: Replacing classes with fakes
         fake_class(Library, fake_name: :book_repository,
                             books: [tom_sawyer, moby_dick])
 
-        BookIndex.by_author("Mark Twain").should == [tom_sawyer]
+        expect(BookIndex.by_author("Mark Twain")).to eq([tom_sawyer])
       end
     end
     """
@@ -139,7 +139,7 @@ Feature: Replacing classes with fakes
       fake_class(Library, books: [])
 
       it "returns books written by author" do
-        BookIndex.by_author("Mark Twain").should == []
+        expect(BookIndex.by_author("Mark Twain")).to eq([])
       end
     end
     """

data/features/readme.md

@@ -10,7 +10,7 @@ It is not uncommon to encounter code like this in isolated unit tests:
 
       report_card = ReportCard.new(scores, students)
 
-      report_card.average_score.should == 7
+      expect(report_card.average_score).to eq(7)
     end
 
 _NOTE:  In the above example we use mocha syntax, but this patten is common
@@ -42,7 +42,7 @@ Let's reexamine our previous example, this time Bogus-style:
 
       report_card = ReportCard.new(scores, students)
 
-      report_card.average_score.should == 7
+      expect(report_card.average_score).to eq(7)
     end
 
 Can you spot the difference? Not much, huh?
@@ -73,7 +73,7 @@ Now if you test an object that collaborates with our `PushNotifier`, you would d
 
       comment_adder.add("Hello world!")
 
-      push_notifier.should have_received.notify_async("Comment: 'Hello world!' added.")
+      expect(push_notifier).to have_received.notify_async("Comment: 'Hello world!' added.")
     end
 
 While not really impressive, this feature is worth mentioning because it will eliminate a lot of the mocking and stubbing from your tests.
@@ -115,7 +115,7 @@ A contract test like that could look like this:
       scores.add("John", 5)
       scores.add("Mary", 9)
 
-      scores.get(["John", "Mary"]).should == [5, 9]
+      expect(scores.get(["John", "Mary"])).to eq([5, 9])
     end
 
 Obviously Bogus won't be able to write those tests for you. However it can remind you if you forget to add one.
@@ -155,7 +155,7 @@ You can test it easily, with all the benefits of fakes, safe stubbing and contra
       it "should send a push notification" do
         CommentAdder.add("the user", "the comment")
 
-        PushNotifier.should have_received.notify_async("comment added")
+        expect(PushNotifier).to have_received.notify_async("comment added")
       end
     end
 

data/features/safe_stubbing/argument_matchers.feature

@@ -18,7 +18,7 @@ Feature: Argument matchers
 
     stub(Catalog).books_by_author_and_title(any_args) { :some_book }
 
-    Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes").should == :some_book
+    expect(Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes")).to eq(:some_book)
     """
 
   Scenario: Stubbing methods with some wildcard arguments
@@ -29,12 +29,12 @@ Feature: Argument matchers
     stub(Catalog).books_by_author_and_title(any_args) { :some_book }
     stub(Catalog).books_by_author_and_title("Mark Twain", anything) { :twains_book }
 
-    Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer").should == :twains_book
-    Catalog.books_by_author_and_title("Mark Twain", "Huckleberry Finn").should == :twains_book
-    Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes").should == :some_book
+    expect(Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("Mark Twain", "Huckleberry Finn")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes")).to eq(:some_book)
     """
 
-  Scenario: Stubbing methods with proc argument matcher
+  Scenario: Stubbing methods with proc arguments matcher
     Then the following test should pass:
     """ruby
     require_relative 'catalog'
@@ -42,9 +42,22 @@ Feature: Argument matchers
     stub(Catalog).books_by_author_and_title(any_args) { :some_book }
     stub(Catalog).books_by_author_and_title(with{|author| author =~ /Twain/ }) { :twains_book }
 
-    Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer").should == :twains_book
-    Catalog.books_by_author_and_title("M. Twain", "Huckleberry Finn").should == :twains_book
-    Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes").should == :some_book
+    expect(Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("M. Twain", "Huckleberry Finn")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes")).to eq(:some_book)
+    """
+
+  Scenario: Stubbing methods with proc argument matcher
+    Then the following test should pass:
+    """ruby
+    require_relative 'catalog'
+
+    stub(Catalog).books_by_author_and_title(any_args) { :some_book }
+    stub(Catalog).books_by_author_and_title(matches{|author| author =~ /Twain/ }, "Tom Sawyer") { :twains_book }
+
+    expect(Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("M. Twain", "Huckleberry Finn")).to eq(:some_book)
+    expect(Catalog.books_by_author_and_title("Arthur Conan Doyle", "Sherlock Holmes")).to eq(:some_book)
     """
 
   Scenario: Stubbing methods with argument type matcher
@@ -55,6 +68,6 @@ Feature: Argument matchers
     stub(Catalog).books_by_author_and_title(any_args) { :some_book }
     stub(Catalog).books_by_author_and_title(any(String), any(String)) { :twains_book }
 
-    Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer").should == :twains_book
-    Catalog.books_by_author_and_title("M. Twain", :other_book).should == :some_book
+    expect(Catalog.books_by_author_and_title("Mark Twain", "Tom Sawyer")).to eq(:twains_book)
+    expect(Catalog.books_by_author_and_title("M. Twain", :other_book)).to eq(:some_book)
     """

data/features/safe_stubbing/safe_mocking.feature

@@ -33,7 +33,7 @@ Feature: Safe mocking
         library = Library.new
         mock(library).checkout("some book") { :checked_out }
 
-        library.checkout("some book").should == :checked_out
+        expect(library.checkout("some book")).to eq(:checked_out)
       end
     end
     """

data/features/safe_stubbing/safe_stubbing.feature

@@ -25,7 +25,7 @@ Feature: Safe stubbing
         library = Library.new
         stub(library).checkout("some book") { :checked_out }
 
-        library.checkout("some book").should == :checked_out
+        expect(library.checkout("some book")).to eq(:checked_out)
       end
     end
     """

data/features/safe_stubbing/spies.feature

@@ -43,8 +43,8 @@ Feature: Spies
 
         student.study("Moby Dick", "Sherlock Holmes")
 
-        library.should have_received.checkout("Moby Dick")
-        library.should have_received.checkout("Sherlock Holmes")
+        expect(library).to have_received.checkout("Moby Dick")
+        expect(library).to have_received.checkout("Sherlock Holmes")
       end
     end
     """
@@ -63,7 +63,7 @@ Feature: Spies
 
         student.study("Moby Dick")
 
-        library.should_not have_received.return_book("Moby Dick")
+        expect(library).not_to have_received.return_book("Moby Dick")
       end
     end
     """
@@ -82,7 +82,7 @@ Feature: Spies
 
         student.study("Moby Dick", "Sherlock Holmes")
 
-        library.should_not have_received.checkout("Moby Dick", 
+        expect(library).not_to have_received.checkout("Moby Dick", 
           "Sherlock Holmes")
       end
     end
@@ -100,9 +100,9 @@ Feature: Spies
       it "studies using books from library" do
         stub(library).checkout("Moby Dick") { "checked out" }
 
-        library.checkout("Moby Dick").should == "checked out"
+        expect(library.checkout("Moby Dick")).to eq("checked out")
 
-        library.should have_received.checkout("Moby Dick")
+        expect(library).to have_received.checkout("Moby Dick")
       end
     end
     """
@@ -138,7 +138,7 @@ Feature: Spies
       it "sets the background to red" do
         Popup.alert("No such file!", canvas)
 
-        canvas.should have_received(:background_color=, "red")
+        expect(canvas).to have_received(:background_color=, "red")
       end
     end
     """

data/lib/bogus.rb

@@ -7,6 +7,7 @@ require_relative 'bogus/stubbing/record_interactions'
 require_relative 'bogus/proxies_method_calls'
 require_relative 'bogus/rspec/extensions'
 require_relative 'bogus/rspec/adapter'
+require_relative 'bogus/support'
 
 dir = File.realpath File.expand_path('../bogus', __FILE__)
 Dir["#{dir}/**/*.rb"].sort.each do |path|

data/lib/bogus/core_ext.rb

@@ -0,0 +1,22 @@
+# This monkey patch should not break Ruby compatibility
+# but is necessary because MRI, insead of calling object.kind_of?(module),
+# calls the C function, which implements kind_of. This makes
+# using fake objects in switch cases produce unexpected results:
+#
+#   fake = fake(:library) { Library }
+#
+#   case fake
+#   when Library then "bingo!"
+#   else raise "oh noes!"
+#   end
+#
+# Without the patch, the snippet above raises 'oh noes!'
+# instead of returning 'bingo!'.
+class Module
+  # don't warn about redefining === method
+  Bogus::Support.supress_warnings do
+    def ===(object)
+      object.kind_of?(self)
+    end
+  end
+end

data/lib/bogus/fakes/fake.rb

@@ -29,7 +29,8 @@ module Bogus
       alias :__create__ :new
 
       def new(*args, &block)
-        __record__(:new, *args, &block)
+        value = __record__(:new, *args, &block)
+        return value unless ::Bogus::UndefinedReturnValue.undefined?(value)
         __create__
       end
     end

data/lib/bogus/fakes/method_stringifier.rb

@@ -29,6 +29,7 @@ module Bogus
       case type
       when :block then "&#{name}"
       when :key then default ? "#{name}: #{default}" : "#{name}: #{name}"
+      when :keyreq then default ? "#{name}:" : "#{name}: #{name}"
       when :opt then default ? "#{name} = #{default}" : name
       when :req then name
       when :rest then "*#{name}"

data/lib/bogus/mocking_dsl.rb

@@ -32,6 +32,10 @@ module Bogus
       Bogus::WithArguments.new(&block)
     end
 
+    def matches(&block)
+      Bogus::MatchesArgument.new(&block)
+    end
+
     def any(klass)
       Bogus::SameClass.new(klass)
     end

data/lib/bogus/stubbing/has_overwritten_methods.rb

@@ -1,24 +1,42 @@
+require 'set'
+
 module Bogus
   module HasOverwritenMethods
+    def self.aliased_name(name)
+      :"__bogus__alias__#{name}"
+    end
+
+    def self.alias(object, new_name, name)
+      object.singleton_class.send(:alias_method, new_name, name)
+    end
+
     def __overwritten_methods__
-      @__overwritten_methods__ ||= {}
+      @__overwritten_methods__ ||= Set.new
     end
 
     def __overwrite__(name, method, body)
-      return if __overwritten_methods__[name]
-      method = method.to_proc if method
-      __overwritten_methods__[name] = method || :no_such_method
+      return if __overwritten_methods__.include?(name)
+
+      new_name = HasOverwritenMethods.aliased_name(name)
+      HasOverwritenMethods.alias(self, new_name, name) if method
+
+      __overwritten_methods__ << name
+
       instance_eval(body)
     end
 
     def __reset__
-      __overwritten_methods__.each do |name, method|
-        method = __overwritten_methods__.delete(name)
-        instance_eval "undef #{name}"
-        next if method == :no_such_method
-        define_singleton_method(name, method)
+      __overwritten_methods__.each do |name|
+        new_name = HasOverwritenMethods.aliased_name(name)
+
+        if respond_to?(new_name)
+          HasOverwritenMethods.alias(self, name, new_name)
+          instance_eval "undef #{new_name}"
+        else
+          instance_eval "undef #{name}"
+        end
       end
-      @__overwritten_methods__ = {}
+      @__overwritten_methods__ = nil
       @__shadow__ = nil
     end
   end

data/lib/bogus/stubbing/have_received_matcher.rb

@@ -21,15 +21,17 @@ module Bogus
       "have received #{call_str(@name, @args)}"
     end
 
-    def failure_message_for_should
+    def failure_message
       return NO_SHADOW unless Shadow.has_shadow?(@subject)
       %Q{Expected #{@subject.inspect} to #{description}, but it didn't.\n\n} + all_calls_str
     end
+    alias_method :failure_message_for_should, :failure_message
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       return NO_SHADOW unless Shadow.has_shadow?(@subject)
       %Q{Expected #{@subject.inspect} not to #{description}, but it did.}
     end
+    alias_method :failure_message_for_should_not, :failure_message_when_negated
 
     def method_call
       proxy(:set_method)

data/lib/bogus/stubbing/matchers/any_args.rb

@@ -0,0 +1,9 @@
+require_relative 'with_arguments'
+
+module Bogus
+  AnyArgs = WithArguments.new{ true }
+
+  def AnyArgs.inspect
+    "any_args"
+  end
+end

data/lib/bogus/stubbing/matchers/matches_argument.rb

@@ -0,0 +1,11 @@
+module Bogus
+  class MatchesArgument
+    def initialize(&block)
+      @block = block
+    end
+
+    def ==(argument)
+      @block.call(argument)
+    end
+  end
+end

data/lib/bogus/stubbing/{any_args.rb → matchers/with_arguments.rb}

@@ -27,10 +27,4 @@ module Bogus
       args.first
     end
   end
-
-  AnyArgs = WithArguments.new{ true }
-
-  def AnyArgs.inspect
-    "any_args"
-  end
 end

data/lib/bogus/stubbing/overwrites_methods.rb

@@ -6,7 +6,7 @@ module Bogus
 
     def overwrite(object, name)
       raise "wut?" if name == :__shadow__
-      return if object.is_a?(FakeObject)
+      return if already_delegates_to_shadow?(object, name)
 
       object.extend RecordInteractions
       object.extend HasOverwritenMethods
@@ -25,6 +25,11 @@ module Bogus
 
     private
 
+    def already_delegates_to_shadow?(object, name)
+      return false unless object.is_a?(FakeObject)
+      !Fake.instance_methods.include?(name)
+    end
+
     def method_by_name(object, name)
       object.method(name) if object.methods.include?(name)
     end

data/lib/bogus/stubbing/undefined_return_value.rb

@@ -11,5 +11,9 @@ module Bogus
     def method_missing(name, *args, &block)
       raise NoMethodError, "undefined method '#{name}' for #{self}"
     end
+
+    def self.undefined?(value)
+      value.is_a?(self)
+    end
   end
 end

data/lib/bogus/support.rb

@@ -0,0 +1,11 @@
+module Bogus
+  module Support
+    def self.supress_warnings
+      old_verbose = $VERBOSE
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/lib/bogus/version.rb

@@ -1,3 +1,3 @@
 module Bogus
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/bogus/clean_ruby_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Ruby syntax" do
   it "is clean" do
-    bogus_warnings.should == []
+    expect(bogus_warnings).to eq([])
   end
 
   def bogus_warnings