bogus 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45d3e04ef1d759f2ae6cb447d108e2b49c933e28
+  data.tar.gz: c2339f094723ca2fd84119abfa1c76091a4fd859
+SHA512:
+  metadata.gz: 6012c4513cfd50e490a50c4487305b547074dd759f28b61fbea9dd2ebd09f40bad12f4ce70cf18357b6048822bfb9af6939eb7891155b1a4749fc763ffc9487d
+  data.tar.gz: 855a276e95ea62f1fa9dbcb5c6934b6a342aa6adadc4b16e919d67ce12c087960db297ff919169214529659eedcea9e6ad9c7d3c653a4261f4495d25d63257d7

data/Gemfile.lock

@@ -1,13 +1,27 @@
 PATH
   remote: .
   specs:
-    bogus (0.0.3)
+    bogus (0.1.0)
       dependor (>= 0.0.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-nulldb-adapter (0.2.3)
+      activerecord (>= 2.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
     archive-tar-minitar (0.5.2)
+    arel (3.0.2)
     aruba (0.4.11)
       childprocess (>= 0.2.3)
       cucumber (>= 1.1.1)
@@ -44,6 +58,7 @@ GEM
       guard (>= 1.1.0)
     guard-rspec (1.1.0)
       guard (>= 1.1)
+    i18n (0.6.1)
     json (1.7.3)
     libnotify (0.7.4)
       ffi (~> 1.0.11)
@@ -79,11 +94,14 @@ GEM
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     thor (0.15.3)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
+  activerecord-nulldb-adapter
   aruba
   bogus!
   coveralls

data/Guardfile

@@ -1,13 +1,6 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'cucumber' do
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { 'features' }
-  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
-  #watch(%r{^lib/(.+)\.rb$})     { 'features' }
-end
-
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }

data/Guardfile.cucumber

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/(.+)\.rb$})     { 'features' }
+end

data/README.md

@@ -1,24 +1,53 @@
 # Bogus
 
+Bogus aims to make your unit tests more reliable by ensuring that you don't stub or mock methods that don't actually exist in the mocked objects.
+
 [![build status](https://secure.travis-ci.org/psyho/bogus.png)](http://travis-ci.org/psyho/bogus)
 [![Code Climate](https://codeclimate.com/github/psyho/bogus.png)](https://codeclimate.com/github/psyho/bogus)
 [![Coverage Status](https://coveralls.io/repos/psyho/bogus/badge.png?branch=master)](https://coveralls.io/r/psyho/bogus?branch=master)
 [![Gem Version](https://badge.fury.io/rb/bogus.png)](http://badge.fury.io/rb/bogus)
 [![Dependency Status](https://gemnasium.com/psyho/bogus.png)](https://gemnasium.com/psyho/bogus)
 
-## What is Bogus?
+## Example
 
-Bogus aims to make your unit tests more reliable by ensuring that you don't stub or mock methods that don't actually exist in the mocked objects.
+```ruby
+class PostRepository
+  def store(title)
+    # save a new post in the database
+  end
+end
+
+class PostAdder < Struct.new(:post_repository)
+  def add(title)
+    post = post_repository.store(title)
+    # do some stuff with the post
+  end
+end
 
-Bogus provides facilities to create *fakes* - test doubles that have the same interface as the doubled class.
+describe PostAdder do
+  fake(:post_repository)
 
-Another feature of Bogus is *safe stubbing*, which does not allow you to stub methods that don't exist or don't match the signature specified when stubbing.
+  it "stores the post" do
+    post_adder = PostAdder.new(post_repository)
+    
+    post_adder.add("Bogus is safe!")
 
-A unique feature of Bogus are the *contract tests*, which reduce the need for integrated tests to a minimum by ensuring that the things you stub match how the object really behaves.
+    post_repository.should have_received.store("Bogus is safe!")
+  end
+end
+```
+
+## Features
+
+* [Safe Stubbing][safe-stubbing] - Bogus does not allow you to stub methods that don't exist or don't match the stubbed signature.
+* [Fakes][fakes] - test doubles that have the same interface as the doubled class.
+* [Support for ActiveRecord models][ar-support] - Bogus comes with support for active record fields out of the box.
+* [Global fake configuration][global-configuration] - Decouple your fakes from class names and define default return values in one place.
+* [Contract tests][contract-tests] - a unique feature of Bogus, which reduces the need for integrated tests to a minimum by ensuring that the things you stub match how the object really behaves.
 
 ## Documentation
 
-[You can find our (executable) documentation on Relish.][docs]
+[You can find more detailed (and executable) documentation on Relish.][docs]
 
 ## License
 
@@ -28,6 +57,13 @@ MIT. See the LICENSE file.
 
 * [Adam Pohorecki](http://github.com/psyho)
 * [Paweł Pierzchała](http://github.com/wrozka)
+* [Piotr Szotkowski](https://github.com/chastell)
 * [Marek Nowak](https://github.com/yundt)
 
 [docs]: http://www.relishapp.com/bogus/bogus/docs 
+
+[safe-stubbing]: https://www.relishapp.com/bogus/bogus/docs/safe-stubbing
+[fakes]: https://www.relishapp.com/bogus/bogus/docs/fakes
+[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

data/bogus.gemspec

@@ -34,4 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rr'
   s.add_development_dependency 'relish'
   s.add_development_dependency 'coveralls'
+
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'activerecord-nulldb-adapter'
 end

data/features/.nav

@@ -1,6 +1,5 @@
 - getting_started.md (Getting Started)
 - readme.md (Introduction to Bogus)
-- changelog.md
 - fakes (Fakes):
   - fake_objects.feature
   - global_fake_configuration.feature
@@ -12,11 +11,15 @@
   - safe_stubbing.feature
   - spies.feature
   - argument_matchers.feature
+  - active_record.feature
 - contract_tests (Contract Tests):
   - contract_tests_mocks.feature
   - contract_tests_stubs.feature
   - contract_tests_spies.feature
   - return_value_contracts.feature
-- configuration_options.feature
+- configuration (Configuration Options):
+  - search_modules.feature
+  - fake_ar_attributes.feature
+- changelog.md
 - license.md
 - authors.md

data/features/authors.md

@@ -9,10 +9,15 @@ blog: [adam.pohorecki.pl][blog]
 github: [wrozka][wrozka]
 twitter: [@zwrozka][zwrozka]
 
+## Piotr Szotkowski
+
+github: [chastell][chastell]
+twitter: [@chastell][chastell-twitter]
+
 ## Marek Nowak
 
 github: [yundt][yundt]
-twitter: [@yundt][yundt]
+twitter: [@yundt][yundt-twitter]
 
 ## Contract tests
 
@@ -35,8 +40,11 @@ The development of Bogus was partially sponsored by [Lunar Logic][llp].
 [wrozka]: https://github.com/wrozka
 [zwrozka]: http://twitter.com/zwrozka
 
+[chastell]: https://github.com/chastell
+[chastell-twitter]: http://twitter.com/chastell
+
 [yundt]: https://github.com/yundt
-[yundt]: http://twitter.com/yundt
+[yundt-twitter]: http://twitter.com/yundt
 
 [scam]: http://www.infoq.com/presentations/integration-tests-scam
 [rr]: https://github.com/btakita/rr

data/features/changelog.md

@@ -27,3 +27,14 @@ Initial version.
 
 - Support mocking methods with optional parameters
 
+## 0.1.0 (in progress)
+
+- Support for stubbing on frozen fakes
+- Safe stubbing of constructors
+- Fixed spying on anonymous fakes
+- Automatic handling of ActiveRecord columns
+- Support Ruby 2.0 keyword arguments
+
+### Breaking changes:
+
+- Fakes no longer return themselves from unstubbed method calls, because this was often a source of confusion. In the new version we return a Bogus::UndefinedReturnValue which contains the method name and arguments from where it was returned.

data/features/configuration/fake_ar_attributes.feature

@@ -0,0 +1,51 @@
+Feature: fake_ar_attributes
+
+  Instances of ActiveRecord::Base subclasses are different then most of the objects you might encounter because the field access on those classes is done by taking advantage of Ruby's `method_missing` functionality.
+
+  Unfortunately, in order to create a fake, Bogus has to examine all of the methods that are defined on a given class and herein lies the problem, the methods that you would expect to have on your ActiveRecord models do not exist:
+
+      class BlogPost < ActiveRecord::Base
+      end
+
+      blog_post = BlogPost.new
+      blog_post.respond_to?(:name) # => true
+      blog_post.method(:name) # raises NameError
+
+  Normally, this would prevent Bogus from being able to fake those methods, but in the case of ActiveRecord we can figure out those fields by looking at the `BlogPost.columns` property. Based on that we can define those accessors on the created fake. If you wish to take advantage of that, you just need to flip a configuration switch:
+
+      Bogus.configure do |c|
+        c.fake_ar_attributes = true
+      end
+
+  Scenario: Adding missing accessors to AR classes
+    Given a file named "foo.rb" with:
+    """ruby
+    require 'active_record'
+    require 'nulldb'
+
+    ActiveRecord::Schema.verbose = false
+    ActiveRecord::Base.establish_connection :adapter => :nulldb
+
+    ActiveRecord::Schema.define do
+      create_table :blog_posts do |t|
+        t.string :name
+        t.string :tags
+      end
+    end
+
+    class BlogPost < ActiveRecord::Base
+    end
+
+    Bogus.configure do |c|
+      c.fake_ar_attributes = true
+    end
+    """
+
+    Then the following test should pass:
+    """ruby
+    post = fake(:blog_post, name: "the name")
+    stub(post).tags { "foo, bar" }
+
+    post.name.should == "the name"
+    post.tags.should == "foo, bar"
+    """

data/features/configuration/readme.md

@@ -0,0 +1,7 @@
+Bogus can be configured, similarly to many other frameworks with a configure block. 
+
+    Bogus.configure do |c|
+      c.search_modules = [Object]
+      c.fake_ar_attributes = true
+    end
+

data/features/{configuration_options.feature → configuration/search_modules.feature}

@@ -1,6 +1,6 @@
-Feature: Configuration Options
+Feature: search_modules
 
-  Bogus can be configured, similarly to many other frameworks with a configure block.  This feature describes the configuration options available.
+  Most projects do not have a separate namespace for their classes, which the default that Bogus assumes. However, if all (or some) of your classes exist within some module you can add it to the list of modules that Bogus will look in when trying to resolve class names.
 
   Scenario: search_modules
     Given a file named "foo.rb" with:

data/features/fakes/anonymous_doubles.feature

@@ -2,15 +2,15 @@ Feature: Anonymous test doubles
 
   Anonymous test doubles can be useful as a stepping stone towards actual fakes and when migrating from another testing library.
 
-  In contrast with other testing libraries, Bogus makes its fakes respond to all methods by default and makes those calls chainable.  This way you can spy on methods without stubbing them first.
+  In contrast with other testing libraries, Bogus makes its fakes respond to all methods by default. This way you can spy on methods without stubbing them first.
 
-  It is not advisable to use those for anything else than an intermediate step.  Fakes that mimic an actual class have many more benefits.
+  It is not advisable to use those for anything else than an intermediate step. Fakes that mimic an actual class have many more benefits.
 
   The syntax for defining fakes is:
 
       fake(method_1: return_value, method_2: proc{return_value2})
 
-  If you pass a proc as a return value to a fake, the proc will be called to obtain the value.  This can be used for instance to raise errors in stubbed methods.
+  If you pass a proc as a return value to a fake, the proc will be called to obtain the value. This can be used for instance to raise errors in stubbed methods.
 
   If you want to actually return a proc from a method, you need to use a slightly longer syntax:
 
@@ -81,7 +81,7 @@ Feature: Anonymous test doubles
       let(:library) { fake }
       let(:jake) { Student.new("Jake") }
       
-      it "allows stubbing any method with any parameters" do
+      it "allows mocking any method with any parameters" do
         mock(library).register_junior("Jake") { "the card" }
 
         jake.sign_up(library)
@@ -124,7 +124,7 @@ Feature: Anonymous test doubles
       let(:library) { fake }
       let(:jake) { Student.new("Jake") }
       
-      it "allows stubbing any method with any parameters" do
+      it "allows spying on any method" do
         jake.sign_up(library)
 
         library.should have_received.register_junior("Jake")
@@ -138,8 +138,12 @@ Feature: Anonymous test doubles
     describe Student do
       let(:library) { fake }
       
-      it "allows stubbing any method with any parameters" do
-        library.foo.bar("hello").baz.should == library
+      it "allows calling any method with any parameters" do
+        expect {
+          library.foo
+          library.bar("hello")
+          library.baz(1, 2, 3, 4, 5)
+        }.not_to raise_error
       end
     end
     """

data/features/fakes/fake_objects.feature

@@ -59,22 +59,6 @@ Feature: Faking existing classes
     end
     """
 
-  Scenario: Fakes have null-object semantics
-    Then spec file with following content should pass:
-    """ruby
-    describe "library fake" do
-      fake(:library)
-
-      it "returns self from all methods" do
-        library.checkout("hello").should == library
-      end
-
-      it "makes method chaining possible" do
-        library.checkout("hello").return_book("world").should == library
-      end
-    end
-    """
-
   Scenario: Taking the guesswork out of finding a class to copy
     Then spec file with following content should pass:
     """ruby

data/lib/bogus/active_record_accessors.rb

@@ -0,0 +1,41 @@
+require 'forwardable'
+
+module Bogus
+  class ActiveRecordAccessors
+    extend Takes
+    extend Forwardable
+
+    takes :klass, :instance_methods
+
+    def_delegators :instance_methods, :remove, :define
+
+    def all
+      return [] unless klass < ActiveRecord::Base
+      return missing_attributes
+    end
+
+    def get(name)
+      Attribute.new(name)
+    end
+
+    private
+
+    def instance_methods
+      @instance_methods.call(klass)
+    end
+
+    def all_attributes
+      klass.columns.map(&:name).map(&:to_sym)
+    end
+
+    def missing_attributes
+      all_attributes - instance_methods.all
+    end
+
+    class Attribute < Struct.new(:name)
+      def parameters
+        []
+      end
+    end
+  end
+end

data/lib/bogus/class_methods.rb

@@ -1,6 +1,6 @@
 module Bogus
   class ClassMethods
-    extend Bogus::Takes
+    extend Takes
     takes :klass
 
     def all

data/lib/bogus/configuration.rb

@@ -1,6 +1,7 @@
 module Bogus
   class Configuration
     attr_writer :search_modules
+    attr_accessor :fake_ar_attributes
 
     def search_modules
       @search_modules ||= [Object]