bogus 0.0.2 → 0.0.3.rc.1

data/.gitignore

@@ -5,3 +5,5 @@ tmp/*
 .rvmrc
 tags
 .rbx
+tags
+gems.tags

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    bogus (0.0.2)
+    bogus (0.0.3.rc.1)
       dependor (>= 0.0.4)
-      rr
 
 GEM
   remote: http://rubygems.org/
   specs:
+    archive-tar-minitar (0.5.2)
     aruba (0.4.11)
       childprocess (>= 0.2.3)
       cucumber (>= 1.1.1)
@@ -30,6 +30,8 @@ GEM
     guard (1.1.1)
       listen (>= 0.4.2)
       thor (>= 0.14.6)
+    guard-ctags-bundler (0.1.6)
+      guard (>= 1.1)
     guard-cucumber (1.1.0)
       cucumber (>= 1.2.0)
       guard (>= 1.1.0)
@@ -42,12 +44,19 @@ GEM
       rb-fchange (~> 0.0.5)
       rb-fsevent (~> 0.9.1)
       rb-inotify (~> 0.8.8)
+    mime-types (1.19)
     rake (0.9.2.2)
     rb-fchange (0.0.5)
       ffi
     rb-fsevent (0.9.1)
     rb-inotify (0.8.8)
       ffi (>= 0.5.0)
+    relish (0.6)
+      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.0.4)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
@@ -68,8 +77,11 @@ DEPENDENCIES
   cucumber
   growl
   guard
+  guard-ctags-bundler
   guard-cucumber
   guard-rspec
   libnotify
   rake
+  relish
+  rr
   rspec

data/Guardfile

@@ -13,3 +13,8 @@ guard 'rspec', :version => 2 do
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
+
+guard 'ctags-bundler', :src_path => ["lib", "spec"] do
+  watch(/^(lib|spec)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end

data/README.md

@@ -7,266 +7,24 @@
 
 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.
 
-## What are fakes?
+Bogus provides facilities to create *fakes* - test doubles that have the same interface as the doubled class.
 
-Fakes are alternative implementations of classes for testing purposes.
-In most cases, fakes are just named stubs: they don't implement the logic (otherwise they should be tested too), but they have the same interface as the real object and they make it easier to remove duplication in your stubs.
+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.
 
-## Stubs and mocks scatter the interface specification all over your specs
+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.
 
-Let's assume that you have a couple of classes that share a collaborator. In this case we have a finds_users object that allows finding users by location and suggests_followings and lists_users_near_city that use it in turn to compute a list of users that match some criteria.
+## Documentation
 
-```ruby
-class FindsUsers
-  takes :users_repository
-
-  def near_point(location, distance_in_km); 
-    # do something with users_repository and return a list of users
-  end
-end
-
-class Geocoder
-  takes :http_client
-
-  def location_for(address)
-    # do something to http_client and return location
-  end
-end
-
-class SuggestsFollowings
-  takes :finds_users
-
-  def suggestions_for(user)
-    finds_users.near_point(user.location, 50).select{|user| user.followers_count > 10}
-  end
-end
-
-class ListsUsersNearCity
-  takes :finds_users, :geocoder
-
-  def users(city)
-    city_location = geocoder.location_for(city.name)
-    finds_users.near_point(city_location, 10)
-  end
-end
-```
-
-Typically, when testing SuggestsFollowings and ListsUsersNearCity you'd have code like this in your specs:
-
-```ruby
-describe SuggestsFollowings
-  let(:finds_users) { stub(:finds_users) }
-  let(:user) { new_user }
-
-  subject { SuggestsFollowings.new(finds_users) }
-
-  it "returns users with follower count of 10 or more" do
-    user_with_followers = new_user(followers_count: 10)
-    users = [new_user(followers_count: 5), user_with_followers]
-
-    finds_users.should_receive(:near_point).with(user.location, 50).and_return(users)
-
-    subject.suggestions_for(user).should == [user_with_followers]
-  end
-
-  # ...
-end
-
-describe ListsUsersNearCity
-  let(:finds_users) { stub(:finds_users) }
-  let(:geocoder) { stub(:geocoder) }
-  let(:city) { new_city(name: "New York") }
-
-  subject { ListsUsersNearCity.new(finds_users, geocoder) }
-
-  it "returns users near center of the city" do
-    location = Location.new(1, 2)
-    users = [new_user, new_user]
-
-    geocoder.should_receive(:location_for).with("New York").and_return(location)
-    finds_users.should_receive(:near_point).with(location, 10).and_return(users)
-
-    subject.users(city).should == users
-  end
-
-  # ...
-end
-```
-
-Notice how the stubbing/mocking code is duplicated between both specs.
-This might not be a huge problem in a small project, but as your codebase grows, there might be more and more objects that interact with finds_users, and the more objects interact with finds_users, the more places it's interface is specified in using stubbing or mock expectations.
-
-## Bogus to the rescue!
-
-Bogus is aimed to help you remove duplication in specifying interfaces from your specs.
-It will reduce the need for integration testing, because with Bogus, you make sure that the test doubles you use have the same interface as the real object, while still allowing you to test in isolation and benefit from that.
-
-So how would your tests look like if you used Bogus?
-
-```ruby
-require 'bogus/rspec'
-
-Bogus.configure do |config|
-  config.spy_by_default = true
-  config.stub_dsl = :rr # only :rr available for now
-end
-
-shared_context 'fakes' do
-  fake(:geocoder) # same as let(:geocoder) { Bogus.fake_for(:geocoder) }
-  fake(:finds_users)
-end
-
-describe SuggestsFollowings
-  include_context "fakes"
-
-  let(:user) { new_user }
-
-  subject { SuggestsFollowings.new(finds_users) }
-
-  it "returns users with follower count of 10 or more" do
-    user_with_followers = new_user(followers_count: 10)
-    users = [new_user(followers_count: 5), user_with_followers]
-
-    # this will actually fail if FindsUsers does not have a near_point method
-    # that takes 2 arguments
-    mock(finds_users).near_point(user.location, 50) { users }
-
-    subject.suggestions_for(user).should == [user_with_followers]
-  end
-
-  # ...
-end
-
-describe ListsUsersNearCity
-  include_context "fakes"
-
-  let(:city) { new_city(name: "New York") }
-
-  subject { ListsUsersNearCity.new(finds_users, geocoder) }
-
-  it "returns users near center of the city" do
-    location = Location.new(1, 2)
-    users = [new_user, new_user]
-
-    mock(geocoder).location_for("New York") { location }
-    mock(finds_users).near_point(location, 10) { users }
-
-    subject.users(city).should == users
-  end
-
-  # ...
-end
-```
-
-As you can see, by using Bogus you can keep writing truly isolated unit tests just like you are used to, but with higher degree of security, because Bogus makes sure, that the methods you are stubbing actually exist and take same arguments.
-
-## Bogus and commands
-
-By default, fakes created by Bogus are nil-objects.
-This is particularly useful when dealing with "command" methods or if you follow the "tell, don't ask" principle.
-
-```ruby
-class SendsEmailNotifications
-  def notify_password_changed(user)
-    # do something
-  end
-end
-
-class Logger
-  def info(*message)
-  end
-end
-
-class ChangesPassword
-  takes :sends_email_notifications, :logger
-
-  def change_password(user, old_pass, new_pass)
-    # change user password
-    user.password = new_pass if user.password == old_pass
-
-    # notify by email
-    sends_email_notifications.notify_password_changed(user)
-
-    # and log
-    logger.info("User", user.name, "changed password")
-  end
-end
-
-describe ChangesPassword do
-  fake(:sends_email_notifications)
-  fake(:logger)
-
-  let(:user) { new_user }
-
-  subject{ ChangesPassword.new(sends_email_notifications, logger) }
-
-  it "sends the email notification" do
-    subject.change_password(user, 'old', 'new')
-    
-    # no need to set up the stub on sends_email_notifications for this to work
-    sends_email_notifications.should have_received.notify_password_changed(user)
-  end
-end
-```
-
-The beautiful thing is, that even if you don't care about testing something (like logging in this example), you still get the benefit of ensuring that the interface matches, even in a fully isolated test.
-
-## Contract tests
-
-Knowing that a method exists and takes the right number of parameters is great, but why stop there?
-Bogus can also make sure that the interface you stub is actually tested somewhere with the correct arguments and return value.
-
-```ruby
-describe ChangesPassword do
-  fake(:sends_email_notifications)
-  fake(:logger)
-
-  let(:user) { new_user }
-
-  subject{ ChangesPassword.new(sends_email_notifications, logger) }
-
-  it "sends the email notification" do
-    subject.change_password(user, 'old', 'new')
-    
-    sends_email_notifications.should have_received.notify_password_changed(user)
-  end
-end
-```
-
-In the above spec, SendsEmailNotifications#notify_password_changed is specified as a method that takes a user as an argument.
-Thanks to Bogus, we already know that there is a class named SendsEmailNotifications and it has a #notify_password_changed method that takes one argument.
-But how can we be sure that this argument is a User, and not a String for example?
-
-Here's how Bogus can help with this problem:
-
-```ruby
-describe SendsEmailNotifications do
-  verify_contract(:sends_email_notifications)
-
-  let(:sends_email_notifications) { SendsEmailNotifications.new }
-
-  it "send email notifications" do
-    user = new_user
-
-    sends_email_notifications.notify_password_changed(user)
-
-    # ...
-  end
-end
-```
+[You can find our (executable) documentation on Relish.][docs]
 
 ## License
 
 MIT. See the LICENSE file.
 
-## TODO:
-
-This is a README driven project, so don't expect stuff in the README to be implemented ;P
-
-See the features directory for the completed functionality.
-
 ## Authors
 
 * [Adam Pohorecki](http://github.com/psyho)
 * [Paweł Pierzchała](http://github.com/wrozka)
 * [Marek Nowak](https://github.com/yundt)
+
+[docs]: http://www.relishapp.com/bogus/bogus/docs 

data/bogus.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'dependor', '>= 0.0.4'
-  s.add_dependency 'rr'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
@@ -29,6 +28,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-cucumber'
+  s.add_development_dependency 'guard-ctags-bundler'
   s.add_development_dependency 'growl'
   s.add_development_dependency 'libnotify'
+  s.add_development_dependency 'rr'
+  s.add_development_dependency 'relish'
 end

data/features/.nav

@@ -0,0 +1,21 @@
+- getting_started.md (Getting Started)
+- readme.md (Introduction to Bogus)
+- changelog.md
+- fakes (Fakes):
+  - fake_objects.feature
+  - global_fake_configuration.feature
+  - anonymous_doubles.feature
+  - replacing_classes.feature
+- safe_stubbing (Safe Stubbing):
+  - safe_mocking.feature
+  - safe_stubbing.feature
+  - spies.feature
+  - argument_matchers.feature
+- contract_tests (Contract Tests):
+  - contract_tests_mocks.feature
+  - contract_tests_stubs.feature
+  - contract_tests_spies.feature
+  - return_value_contracts.feature
+- configuration_options.feature
+- license.md
+- authors.md

data/features/authors.md

@@ -0,0 +1,42 @@
+## Adam Pohorecki
+
+github: [psyho][psyho]
+twitter: [@apohorecki][apohorecki]
+blog: [adam.pohorecki.pl][blog]
+
+## Paweł Pierzchała
+
+github: [wrozka][wrozka]
+twitter: [@zwrozka][zwrozka]
+
+## Marek Nowak
+
+github: [yundt][yundt]
+twitter: [@yundt][yundt]
+
+## Contract tests
+
+The contract tests feature was inspired by [J. B. Rainsberger's talk: "Integration Tests are a Scam"][scam].
+
+## Mocking DSL syntax
+
+The mocking DSL syntax was inspired by the [RR framework][rr].
+
+## Sponsor
+
+The development of Bogus was partially sponsored by [Lunar Logic][llp].
+
+[llp]: http://www.lunarlogicpolska.com
+
+[psyho]: https://github.com/psyho
+[apohorecki]: http://twitter.com/apohorecki
+[blog]: http://adam.pohorecki.pl
+
+[wrozka]: https://github.com/wrozka
+[zwrozka]: http://twitter.com/zwrozka
+
+[yundt]: https://github.com/yundt
+[yundt]: http://twitter.com/yundt
+
+[scam]: http://www.infoq.com/presentations/integration-tests-scam
+[rr]: https://github.com/btakita/rr

data/{CHANGELOG.md → features/changelog.md}

@@ -1,5 +1,3 @@
-# Changelog
-
 ## 0.0.1
 
 Initial version.
@@ -15,3 +13,12 @@ Initial version.
 - Implemented anonymous fakes.
 - Fixed a bug in copying ActiveRecord classes.
 - (internal) Replaced autoloads with require.
+
+## 0.0.3 (not released yet)
+
+- Global fake configuration
+- Inline method stubbing syntax
+- Removed dependency on RR
+- verifies_contracts records on described_class instead of class based on fake name
+- Replacing classes with fakes
+