assert_difference 0.3.1 → 0.4.0

data/README.md

@@ -43,8 +43,8 @@ and to use it with RSpec:
 
 For more information read http://pupeno.com/blog/better-assert-difference
 
-Note on Patches/Pull Requests
------------------------------
+Notes on contributing
+---------------------
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -53,8 +53,13 @@ Note on Patches/Pull Requests
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
+* Document any new options and verify the documentation looks correct by running:
+
+      yard server --reload
+
+  and going to http://localhost:8808
 
 Copyright
 ---------
 
-Copyright (c) 2010, 2011, José Pablo Fernández. See LICENSE for details.
+Copyright (c) 2010, 2011, 2012 José Pablo Fernández. See LICENSE for details.

data/Rakefile

@@ -1,29 +1,39 @@
 # -*- encoding: utf-8 -*-
 # Copyright © 2011, José Pablo Fernández
 
-task :default => :test
+require "rake"
+require "rake/testtask"
+require "bundler/gem_tasks"
 
-require "bundler"
-Bundler::GemHelper.install_tasks
+desc "Default: run unit tests."
+task :default => :test
 
-require "rake/testtask"
-Rake::TestTask.new(:test) do |test|
-  test.libs << "lib" << "test"
-  test.pattern = "test/**/test_*.rb"
-  test.verbose = true
+desc "Test the table_builder plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
 end
 
-require "rcov/rcovtask"
-Rcov::RcovTask.new do |test|
-  test.libs << "test"
-  test.pattern = "test/**/test_*.rb"
-  test.verbose = true
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |test|
+    test.libs << "test"
+    test.pattern = "test/**/test_*.rb"
+    test.verbose = true
+  end
+rescue LoadError => e
+  puts "rcov is not installed, oh well"
 end
 
-require "yard"
-YARD::Rake::YardocTask.new do |yard|
-  # Use Markdown for documentation.
-  yard.options << "--markup" << "markdown"
-  # Extra file(s).
-  yard.options << "-" << "LICENSE"
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |yard|
+    # Use Markdown for documentation.
+    yard.options << "--markup" << "markdown"
+    # Extra file(s).
+    yard.options << "-" << "LICENSE"
+  end
+rescue LoadError => e
+  puts "yard is not installed, oh well"
 end

data/lib/assert_difference.rb

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
-# Copyright © 2010, 2011, José Pablo Fernández
+# Copyright © 2010, 2011, 2012 José Pablo Fernández
 
 module AssertDifference
-  VERSION = "0.3.1" unless defined?(::AssertDifference::VERSION)
+  VERSION = "0.4.0" unless defined?(::AssertDifference::VERSION)
 
   # Test numeric difference between the return value of an expression as a result of what is evaluated
   # in the yielded block.
@@ -51,10 +51,18 @@ module AssertDifference
   #       post :something
   #     end
   #
+  # the results of the block is the result of the assert, so you can write
+  #
+  #     email = assert_difference "ActionMailer::Base.deliveries.count" => +1 do
+  #         Mailer.reset_password_email(@user).deliver
+  #     end
+  #     assert_equal [@user.email], email.to
+  #
   # @param [Array, Hash] expressions array of expressions to evaluate or hash
   #   table of expressions and expected difference.
   # @param [Integer] difference expected difference when using an array or single expression.
   # @param [String, nil] message error message to display. One would be constructed if nil.
+  # @return whatever the block returned
   def assert_difference(expressions, difference = 1, message = nil, &block)
     b = block.send(:binding)
     if !expressions.is_a? Hash
@@ -66,12 +74,14 @@ module AssertDifference
     before = {}
     expressions.each { |exp, _| before[exp] = eval(exp, b) }
 
-    yield
+    result = yield
 
     expressions.each do |exp, diff|
       error = "#{exp.inspect} didn't change by #{diff}"
       error = "#{message}.\n#{error}" if message
       assert_equal(before[exp] + diff, eval(exp, b), error)
     end
+
+    return result
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assert_difference
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-25 00:00:00.000000000Z
+date: 2012-02-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70098770379360 !ruby/object:Gem::Requirement
+  requirement: &70228130478420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098770379360
+  version_requirements: *70228130478420
 description: Better assert_difference than Rails by providing a more compact and readable
   syntax through hashes. For some more information read http://pupeno.com/blog/better-assert-difference.
 email:
@@ -59,8 +59,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: assert_difference
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An improved assert_difference
 test_files: []
+has_rdoc: