bogus 0.1.3 → 0.1.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bogus (0.1.3)
+    bogus (0.1.4)
       dependor (>= 0.0.4)
 
 GEM
@@ -22,14 +22,14 @@ GEM
       multi_json (~> 1.0)
     archive-tar-minitar (0.5.2)
     arel (3.0.2)
-    aruba (0.4.11)
-      childprocess (>= 0.2.3)
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
       cucumber (>= 1.1.1)
-      ffi (>= 1.0.11)
-      rspec (>= 2.7.0)
+      rspec-expectations (>= 2.7.0)
     builder (3.0.4)
-    childprocess (0.3.2)
-      ffi (~> 1.0.6)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
     colorize (0.5.8)
     coveralls (0.6.7)
       colorize
@@ -37,62 +37,78 @@ GEM
       rest-client
       simplecov (>= 0.7)
       thor
-    cucumber (1.3.3)
+    cucumber (1.3.5)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12.0)
       multi_json (~> 1.7.5)
-      multi_test (~> 0.0.1)
-    dependor (0.0.5)
+      multi_test (>= 0.0.2)
+    dependor (0.0.6)
     diff-lcs (1.2.4)
-    ffi (1.0.11)
-    ffi (1.0.11-java)
+    ffi (1.9.0)
+    ffi (1.9.0-java)
+    formatador (0.2.4)
     gherkin (2.12.0)
       multi_json (~> 1.3)
     gherkin (2.12.0-java)
       multi_json (~> 1.3)
     growl (1.0.3)
-    guard (1.1.1)
-      listen (>= 0.4.2)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
       thor (>= 0.14.6)
     guard-ctags-bundler (0.1.6)
       guard (>= 1.1)
-    guard-cucumber (1.1.0)
+    guard-cucumber (1.4.0)
       cucumber (>= 1.2.0)
       guard (>= 1.1.0)
-    guard-rspec (1.1.0)
-      guard (>= 1.1)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
     i18n (0.6.1)
     json (1.8.0)
     json (1.8.0-java)
-    libnotify (0.7.4)
-      ffi (~> 1.0.11)
-    listen (0.4.5)
-      rb-fchange (~> 0.0.5)
-      rb-fsevent (~> 0.9.1)
-      rb-inotify (~> 0.8.8)
-    mime-types (1.19)
+    libnotify (0.8.1)
+      ffi (>= 1.0.11)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.1)
+    mime-types (1.23)
     minitest (5.0.6)
     multi_json (1.7.7)
-    multi_test (0.0.1)
-    rake (0.9.2.2)
-    rb-fchange (0.0.5)
-      ffi
-    rb-fsevent (0.9.1)
-    rb-inotify (0.8.8)
+    multi_test (0.0.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry (0.9.12.2-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
       ffi (>= 0.5.0)
-    relish (0.6)
+    relish (0.7)
       archive-tar-minitar (>= 0.5.2)
       json (>= 1.4.6)
       rest-client (>= 1.6.1)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rr (1.1.1)
-    rspec (2.14.0)
+    rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.2)
+    rspec-core (2.14.4)
     rspec-expectations (2.14.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.1)
@@ -100,7 +116,10 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    thor (0.15.3)
+    slop (3.4.5)
+    spoon (0.0.4)
+      ffi
+    thor (0.18.1)
     tzinfo (0.3.37)
 
 PLATFORMS

data/Guardfile

@@ -1,7 +1,9 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+interactor :off
+
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/Guardfile.cucumber

@@ -1,6 +1,8 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
+interactor :off
+
 guard 'cucumber' do
   watch(%r{^features/.+\.feature$})
   watch(%r{^features/support/.+$})          { 'features' }

data/README.md

@@ -54,7 +54,7 @@ end
 
 ## License
 
-MIT. See the LICENSE file.
+MIT. See the [LICENSE file][license].
 
 ## Authors
 
@@ -70,3 +70,4 @@ MIT. See the LICENSE file.
 [ar-support]: https://www.relishapp.com/bogus/bogus/docs/configuration/fake-ar-attributes
 [global-configuration]: https://www.relishapp.com/bogus/bogus/docs/fakes/global-fake-configuration
 [contract-tests]: https://www.relishapp.com/bogus/bogus/docs/contract-tests
+[license]: features/license.md

data/bogus.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Bogus::VERSION
   s.authors     = ["Adam Pohorecki"]
   s.email       = ["adam@pohorecki.pl"]
+  s.license     = 'MIT'
   s.homepage    = "https://github.com/psyho/bogus"
   s.summary     = %q{Create fakes to make your isolated unit tests reliable.}
   s.description = %q{Decreases the need to write integration tests by ensuring that the things you stub or mock actually exist.}

data/features/.nav

@@ -17,9 +17,11 @@
   - contract_tests_stubs.feature
   - contract_tests_spies.feature
   - return_value_contracts.feature
+  - custom_overwritten_class.feature
 - configuration (Configuration Options):
   - search_modules.feature
   - fake_ar_attributes.feature
+- minitest_support.feature
 - changelog.md
 - license.md
 - authors.md

data/features/changelog.md

@@ -1,3 +1,11 @@
+## 0.1.4
+
+- Support for contracts in minitest
+- Allowed customizing the class being overwritten by verify_contract
+- Fixed is_a? behavior for fakes
+- Fake#is_a? now returns true for superclasses of and modules included into the faked class.
+- Reorganized the code into subdirectories
+
 ## 0.1.3
 
 - Support for minitest

data/features/contract_tests/custom_overwritten_class.feature

@@ -0,0 +1,115 @@
+Feature: Customizing the overwritten class
+
+  Typically, when you specify a contract to be verified, you do it like this:
+
+      describe SomeClass do
+        verify_contract(:some_fake_name)
+      end
+
+  When you do this, under the hood Bogus replaces `SomeClass` with a proxy that records any calls made to the class and its instances for the duration of the test.
+
+  If the class you want to be overwritten is not the one that is described, you can customize it like so:
+
+      describe "not a class" do
+        verify_contract(:some_fake_name) { SomeClass }
+      end
+
+  In case there is no described class and you don't provide a custom one to be overwritten, the class will be guessed based on the name of the fake:
+
+      describe "not a class" do
+        verify_contract(:some_fake_name)
+      end
+
+  In the above example, Bogus will try to overwrite a class named `SomeFakeName`.
+
+  Background:
+    Given a file named "library.rb" with:
+    """ruby
+    class PublicLibrary
+      def initialize
+        @books = []
+      end
+
+      def has_book?(book)
+        @books.include?(book)
+      end
+
+      def checkout(book)
+        @books.delete(book)
+      end
+
+      def return(book)
+        @books << book
+      end
+    end
+    """
+
+    Given a file named "student.rb" with:
+    """ruby
+    class Student
+      def read(book, library = PublicLibrary.new)
+        if library.has_book?(book)
+          library.checkout(book)
+        end
+      end
+    end
+    """
+
+    And a spec file named "student_spec.rb" with:
+    """ruby
+    require_relative 'student'
+    require_relative 'library'
+
+    describe Student do
+      fake(:library) { PublicLibrary }
+
+      it "checks out the book from library if it is available" do
+        student = Student.new
+        mock(library).has_book?("Moby Dick") { true }
+        mock(library).checkout("Moby Dick") { "Moby Dick" }
+
+        student.read("Moby Dick", library)
+      end
+
+      it "does not check out the book from library if not available" do
+        student = Student.new
+        mock(library).has_book?("Moby Dick") { false }
+
+        student.read("Moby Dick", library)
+
+        library.should_not have_received.checkout("Moby Dick")
+      end
+    end
+    """
+
+  Scenario: Verifying contract for a class that is not the described_class
+  Then spec file with following content should pass:
+    """ruby
+    require_relative 'library'
+
+    describe "Borrowing books from library" do
+      verify_contract(:library) { PublicLibrary }
+
+      let(:library) { PublicLibrary.new }
+
+      it "allows checking out books that are in the inventory" do
+        library.return("Moby Dick")
+
+        library.has_book?("Moby Dick").should be_true
+      end
+
+      it "does not allow checking out unavailable books" do
+        library.has_book?("Moby Dick").should be_false
+      end
+
+      it "marks books as unavailable after they are checked out" do
+        library.return("Moby Dick")
+
+        library.checkout("Moby Dick")
+
+        library.has_book?("Moby Dick").should be_false
+      end
+    end
+    """
+
+

data/features/minitest_support.feature

@@ -0,0 +1,228 @@
+Feature: minitest support
+
+  minitest is supported by Bogus both with the classic assert-style syntax and the minitest/spec expectation syntax.
+
+  Background:
+    Given a file named "library.rb" with:
+    """ruby
+    class Library
+      def self.books
+      end
+
+      def checkout(book)
+      end
+
+      def return_book(book)
+      end
+    end
+    """
+
+    Given a file named "book_index.rb" with:
+    """ruby
+    class BookIndex
+      def self.by_author(author)
+        Library.books.select{|book| book[:author] == author}
+      end
+    end
+    """
+
+    Given a file named "student.rb" with:
+    """ruby
+    class Student
+      def initialize(library)
+        @library = library
+      end
+
+      def study(*book_titles)
+        book_titles.each do |book_title|
+          @library.checkout(book_title)
+        end
+      end
+    end
+    """
+
+  Scenario: Auto-verification of unsatisfied mocks
+    Then minitest file "student_test.rb" with the following content should fail:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest'
+
+    require_relative 'student'
+    require_relative 'library'
+
+    class StudentTest < MiniTest::Unit::TestCase
+      def test_library_checkouts
+        library = fake(:library)
+        student = Student.new(library)
+        mock(library).checkout("Moby Dick")
+        mock(library).checkout("Sherlock Holmes")
+
+        student.study("Moby Dick")
+      end
+    end
+    """
+
+  Scenario: Spying on method calls with assert syntax
+    Then minitest file "student_test.rb" with the following content should pass:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest'
+
+    require_relative 'student'
+    require_relative 'library'
+
+    class StudentTest < MiniTest::Unit::TestCase
+      def setup
+        @library = fake(:library)
+      end
+
+      def test_library_checkouts
+        student = Student.new(@library)
+
+        student.study("Moby Dick", "Sherlock Holmes")
+
+        assert_received @library, :checkout, ["Moby Dick"]
+        assert_received @library, :checkout, ["Sherlock Holmes"], "optional message"
+        refute_received @library, :return_book, ["Moby Dick"]
+      end
+    end
+    """
+
+  Scenario: Spying on method calls with expectation syntax
+    Then minitest file "student_spec.rb" with the following content should pass:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest/spec'
+
+    require_relative 'student'
+    require_relative 'library'
+
+    describe Student do
+      describe "#study" do
+        fake(:library)
+
+        it "studies using books from library" do
+          student = Student.new(library)
+
+          student.study("Moby Dick", "Sherlock Holmes")
+
+          library.must_have_received :checkout, ["Moby Dick"]
+          library.must_have_received :checkout, ["Sherlock Holmes"]
+          library.wont_have_received :return_book, ["Moby Dick"]
+        end
+      end
+    end
+    """
+
+  Scenario: Describe-level class faking
+    Then minitest file "book_index_spec.rb" with the following content should pass:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest/spec'
+
+    require_relative 'book_index'
+    require_relative 'library'
+
+    describe BookIndex do
+      fake_class(Library, books: [])
+
+      it "returns books written by author" do
+        BookIndex.by_author("Mark Twain").must_equal []
+      end
+    end
+    """
+
+  Scenario: Negative contract verification
+    Then minitest file "student_and_library_spec.rb" with the following content should fail:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest/spec'
+
+    require_relative 'student'
+    require_relative 'library'
+
+    describe Student do
+      describe "#study" do
+        fake(:library)
+
+        it "studies using books from library" do
+          Student.new(library).study("Moby Dick")
+          library.must_have_received :checkout, ["Moby Dick"]
+        end
+      end
+    end
+
+    describe Library do
+      verify_contract(:library)
+    end
+    """
+
+  Scenario: Positive contract verification
+    Then minitest file "student_and_library_spec.rb" with the following content should pass:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest/spec'
+
+    require_relative 'student'
+    require_relative 'library'
+
+    describe Student do
+      describe "#study" do
+        fake(:library)
+
+        it "studies using books from library" do
+          Student.new(library).study("Moby Dick")
+          library.must_have_received :checkout, ["Moby Dick"]
+        end
+      end
+    end
+
+    describe Library do
+      verify_contract(:library)
+
+      describe '#checkout' do
+        it "checks books out" do
+          Library.new.checkout("Moby Dick")
+        end
+      end
+    end
+    """
+
+  Scenario: Custom verified class
+    Then minitest file "student_and_library_spec.rb" with the following content should pass:
+    """ruby
+    require 'minitest/autorun'
+    require 'bogus/minitest/spec'
+
+    class NetworkLogger
+      def info(msg)
+      end
+    end
+
+    class OrderProcessor
+      def process(order, logger = NetworkLogger.new)
+        logger.info("#{order} processed")
+      end
+    end
+
+    describe OrderProcessor do
+      describe "#process" do
+        fake(:logger) { NetworkLogger }
+
+        it "processes orders" do
+          OrderProcessor.new.process("burger & fries", logger)
+          logger.must_have_received :info, ["burger & fries processed"]
+        end
+      end
+    end
+
+    describe "Using network logger" do
+      verify_contract(:logger) { NetworkLogger }
+
+      describe '#info' do
+        it "logs on info level" do
+          NetworkLogger.new.info("burger & fries processed")
+        end
+      end
+    end
+    """