schmurfy-bacon 1.3.3 → 1.3.4

data/README.md

@@ -0,0 +1,56 @@
+# Bacon
+
+This is my personal fork of the [bacon test](https://github.com/chneukirchen/bacon) framework tailored to my needs, here is
+a non exhaustive list of changes worth mentioning:
+
+- added a new default nicer output formatter, I look at tests most of my work days
+  and got tired of the old standard look.
+- added some optional extensions:
+  - mocha integration: allow using mocha expectations
+  - eventmachine integration: make your tests run inside the eventmachine loop
+
+# Using it
+
+In your project add this to your Gemfile:
+
+```ruby
+gem "schmurfy-bacon"
+```
+
+And then the simplest test would be:  
+(you might want to split the common part to a spec_helper.rb file and requires it in your tests)
+
+```ruby
+require "rubygems"
+require "bundler/setup"
+require "bacon"
+
+# Without that nothing will be shown after the tests
+Bacon.summary_on_exit()
+
+# Using mocha
+# require "bacon/ext/mocha"
+
+# Using eventmachine
+# require "bacon/ext/em"
+
+describe "My test" do
+  before do
+    @v = 42
+  end
+  
+  should "run" do
+    @v.should == 42
+  end
+end
+
+```
+
+Check the examples directory for more.
+
+
+
+# Screenshot
+
+![](https://github.com/schmurfy/bacon/raw/master/screenshot.png)
+

data/bacon.gemspec

@@ -18,7 +18,6 @@ http://github.com/chneukirchen/bacon
   s.bindir          = 'bin'
   s.executables     << 'bacon'
   s.require_path    = 'lib'
-  s.extra_rdoc_files = ['README']
   s.test_files      = []
   
   s.add_dependency 'term-ansicolor'

data/bin/bacon

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/')
 module Bacon; end
 
 automatic = false
-output = 'SpecDoxOutput'
+output = 'BetterOutput'
 
 opts = OptionParser.new("", 24, '  ') { |opts|
   opts.banner = "Usage: bacon [options] [files | -a] [-- untouched arguments]"

data/lib/bacon.rb

@@ -59,9 +59,9 @@ module Bacon
   
   def self.summary_on_exit
     return  if Counter[:installed_summary] > 0
-    @timer = Time.now
+    started_at = Time.now
     at_exit {
-      handle_summary
+      handle_summary(started_at)
       if $!
         raise $!
       elsif Counter[:errors] + Counter[:failed] > 0

data/lib/bacon/ext/mocha.rb

@@ -7,6 +7,17 @@ require 'mocha'
 # containing only mocha expectations.
 # 
 module Bacon
+  class Context
+    def freeze_time(t = Time.now)
+      Time.stubs(:now).returns(t)
+      if block_given?
+        yield
+        Time.unstub(:now)
+      end
+    end
+    
+  end
+  
   module MochaRequirementsCounter
     def self.increment
       Counter[:requirements] += 1

data/lib/bacon/version.rb

@@ -1,3 +1,3 @@
 module Bacon
-  VERSION = "1.3.3"
+  VERSION = "1.3.4"
 end

data/lib/output/better_output.rb

@@ -32,8 +32,10 @@ module BetterOutput
     
   end
 
-  def handle_summary
+  def handle_summary(started_at)
+    elapsed_time = Time.now.to_i - started_at.to_i
     print ErrorLog  if Backtraces
+    puts "Execution time: #{human_duration(elapsed_time)}"
     puts "%d specifications (%d requirements), %d failures, %d errors" %
       Counter.values_at(:specifications, :requirements, :failed, :errors)
   end
@@ -41,4 +43,15 @@ module BetterOutput
   def spaces(str = " ")
     str * 2 * (Counter[:context_depth] - 1)
   end
+
+private
+  
+  def human_duration(secs)
+    [[60, 'seconds'], [60, 'minutes'], [24, 'hours'], [1000, 'days']].map do |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        (n > 0) ? "#{n.to_i} #{name}" : nil
+      end
+    end.compact.reverse.join(' ')
+  end
 end

data/lib/output/knock_output.rb

@@ -12,5 +12,5 @@ module KnockOutput
     end
   end
 
-  def handle_summary;  end
+  def handle_summary(started_at);  end
 end

data/lib/output/spec_dox_output.rb

@@ -11,7 +11,7 @@ module SpecDoxOutput
     puts error.empty? ? "" : " [#{error}]"
   end
 
-  def handle_summary
+  def handle_summary(started_at)
     print ErrorLog  if Backtraces
     puts "%d specifications (%d requirements), %d failures, %d errors" %
       Counter.values_at(:specifications, :requirements, :failed, :errors)

data/lib/output/tap_output.rb

@@ -13,7 +13,7 @@ module TapOutput
     end
   end
 
-  def handle_summary
+  def handle_summary(started_at)
     puts "1..#{Counter[:specifications]}"
     puts "# %d tests, %d assertions, %d failures, %d errors" %
       Counter.values_at(:specifications, :requirements, :failed, :errors)

data/lib/output/test_unit_output.rb

@@ -10,7 +10,7 @@ module TestUnitOutput
     end
   end
 
-  def handle_summary
+  def handle_summary(started_at)
     puts "", "Finished in #{Time.now - @timer} seconds."
     puts ErrorLog  if Backtraces
     puts "%d tests, %d assertions, %d failures, %d errors" %

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schmurfy-bacon
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-06 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &70253621968160 !ruby/object:Gem::Requirement
+  requirement: &70328114246540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70253621968160
+  version_requirements: *70328114246540
 description: ! 'Bacon is a small RSpec clone weighing less than 350 LoC but
 
   nevertheless providing all essential features.
@@ -34,13 +34,12 @@ email: chneukirchen@gmail.com
 executables:
 - bacon
 extensions: []
-extra_rdoc_files:
-- README
+extra_rdoc_files: []
 files:
 - .gitignore
 - COPYING
 - Gemfile
-- README
+- README.md
 - Rakefile
 - bacon.gemspec
 - bin/bacon
@@ -60,6 +59,7 @@ files:
 - lib/output/spec_dox_output.rb
 - lib/output/tap_output.rb
 - lib/output/test_unit_output.rb
+- screenshot.png
 - test/spec_bacon.rb
 - test/spec_nontrue.rb
 - test/spec_should.rb
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3307888883450251243
+      hash: -3752377546693975737
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3307888883450251243
+      hash: -3752377546693975737
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11

data/README

@@ -1,290 +0,0 @@
-= Bacon -- small RSpec clone.
-
-   "Truth will sooner come out from error than from confusion."
-                                               ---Francis Bacon
-
-Bacon is a small RSpec clone weighing less than 350 LoC but
-nevertheless providing all essential features.
-
-
-== Whirl-wind tour
-
-    require 'bacon'
-    
-    describe 'A new array' do
-      before do
-        @ary = Array.new
-      end
-      
-      it 'should be empty' do
-        @ary.should.be.empty
-        @ary.should.not.include 1
-      end
-    
-      it 'should have zero size' do
-        @ary.size.should.equal 0
-        @ary.size.should.be.close 0.1, 0.5
-      end
-    
-      it 'should raise on trying fetch any index' do
-        lambda { @ary.fetch 0 }.
-          should.raise(IndexError).
-          message.should.match(/out of array/)
-    
-        # Alternatively:
-        should.raise(IndexError) { @ary.fetch 0 }
-      end
-    
-      it 'should have an object identity' do
-        @ary.should.not.be.same_as Array.new
-      end
-    
-      # Custom assertions are trivial to do, they are lambdas returning a
-      # boolean vale:
-      palindrome = lambda { |obj| obj == obj.reverse }
-      it 'should be a palindrome' do
-        @ary.should.be.a palindrome
-      end
-    
-      it 'should have super powers' do
-        should.flunk "no super powers found"
-      end
-    end
-
-Now run it:
-
-    $ bacon whirlwind.rb
-    A new array
-    - should be empty
-    - should have zero size
-    - should raise on trying fetch any index
-    - should have an object identity
-    - should be a palindrome
-    - should have super powers [FAILED]
-    
-    Bacon::Error: no super powers found
-    	./whirlwind.rb:39: A new array - should have super powers
-    	./whirlwind.rb:38
-    	./whirlwind.rb:3
-    
-    6 specifications (9 requirements), 1 failures, 0 errors
-
-If you want shorter output, use the Test::Unit format:
-
-    $ bacon -q whirlwind.rb
-    .....F
-    Bacon::Error: no super powers found
-    	./whirlwind.rb:39: A new array - should have super powers
-    	./whirlwind.rb:38
-    	./whirlwind.rb:3
-    
-    6 tests, 9 assertions, 1 failures, 0 errors
-
-It also supports TAP:
-
-    $ bacon -p whirlwind.rb
-    ok 1        - should be empty
-    ok 2        - should have zero size
-    ok 3        - should raise on trying fetch any index
-    ok 4        - should have an object identity
-    ok 5        - should be a palindrome
-    not ok 6    - should have super powers: FAILED
-    # Bacon::Error: no super powers found
-    # 	./whirlwind.rb:39: A new array - should have super powers
-    # 	./whirlwind.rb:38
-    # 	./whirlwind.rb:3
-    1..6
-    # 6 tests, 9 assertions, 1 failures, 0 errors
-
-    $ bacon -p whirlwind.rb | taptap -q
-    Tests took 0.00 seconds.
-    FAILED tests 6
-       6) should have super powers: FAILED
-
-    Failed 1/6 tests, 83.33% okay.
-
-(taptap is available from http://chneukirchen.org/repos/taptap/)
-
-As of Bacon 1.1, it also supports Knock:
-
-    $ bacon -k whirlwind.rb
-    ok - should be empty
-    ok - should have zero size
-    ok - should raise on trying fetch any index
-    ok - should have an object identity
-    ok - should be a palindrome
-    not ok - should have super powers: FAILED
-    # Bacon::Error: no super powers found
-    # 	./whirlwind.rb:39: A new array - should have super powers
-    # 	./whirlwind.rb:38
-    # 	./whirlwind.rb:3
-
-    $ bacon -k whirlwind.rb | kn-sum
-    6 tests, 1 failed (83.3333% succeeded)
-
-(knock is available from http://github.com/chneukirchen/knock/)
-
-
-== Implemented assertions
-
-* should.<predicate> and should.be.<predicate>
-* should.equal
-* should.match
-* should.be.identical_to / should.be.same_as
-* should.raise(*exceptions) { }
-* should.change { }
-* should.throw(symbol) { }
-* should.satisfy { |object| }
-
-
-== Added core predicates
-
-* Object#true?
-* Object#false?
-* Proc#change?
-* Proc#raise?
-* Proc#throw?
-* Numeric#close?
-
-
-== before/after
-
-before and after need to be defined before the first specification in
-a context and are run before and after each specification.
-
-As of Bacon 1.1, before and after do nest in nested contexts.
-
-
-== Shared contexts
-
-You can define shared contexts in Bacon like this:
-
-    shared "an empty container" do
-      it "should have size zero" do
-      end
-
-      it "should be empty" do
-      end
-    end
-
-    context "A new array" do
-      behaves_like "an empty container"
-    end
-
-These contexts are not executed on their own, but can be included with
-behaves_like in other contexts.  You can use shared contexts to
-structure suites with many recurring specifications.
-
-
-== Matchers
-
-Custom matchers are simply lambdas returning a boolean value, for
-example:
-
-  def shorter_than(max_size)
-    lambda { |obj| obj.size < max_size }
-  end
-
-  [1,2,3].should.be shorter_than(5)
-
-You can use modules and extend to group matchers for use in multiple
-contexts.
-
-
-== bacon standalone runner
-
-  -s, --specdox            do AgileDox-like output (default)
-  -q, --quiet              do Test::Unit-like non-verbose output
-  -p, --tap                do TAP (Test Anything Protocol) output
-  -k, --knock              do Knock output
-  -o, --output FORMAT      do FORMAT (SpecDox/TestUnit/Tap) output
-  -Q, --no-backtrace       don't print backtraces  
-  -a, --automatic          gather tests from ./test/, include ./lib/
-  -n, --name NAME          runs tests matching regexp NAME
-  -t, --testcase TESTCASE  runs tests in TestCases matching regexp TESTCASE
-
-If you don't want to use the standalone runner, run
-Bacon.summary_on_exit to install an exit handler showing the summary.
-
-
-== Object#should
-
-You can use Object#should outside of contexts, where the result of
-assertion will be returned as a boolean.  This is nice for
-demonstrations, quick checks and doctest tests.
-
-    >> require 'bacon'
-    >> (1 + 1).should.equal 2
-    => true
-    >> (6*9).should.equal 42
-    => false
-
-
-== Bacon with autotest
-
-Since version 1.0, there is autotest support.  You need to tag your
-test directories (test/ or spec/) by creating an .bacon file there.
-Autotest then will find it.  bin/bacon needs to be in PATH or RUBYPATH.
-
-
-== Converting specs
-
-spec-converter is a simple tool to convert test-unit or dust style
-tests to test/spec specs.
-
-It can be found at http://opensource.thinkrelevance.com/wiki/spec_converter.
-
-
-== Thanks to
-
-* Michael Fellinger, for fixing Bacon for 1.9 and various improvements.
-* Gabriele Renzi, for implementing Context#should.
-* James Tucker, for the autotest support.
-* Yossef Mendelssohn, for nested contexts.
-* everyone contributing bug fixes.
-
-
-== History
-
-* January 7, 2008: First public release 0.9.
-
-* July 6th, 2008: Second public release 1.0.
-  * Add Context#should as a shortcut for Context#it('should ' + _).
-  * describe now supports multiple arguments for better organization.
-  * Empty specifications are now erroneous.
-  * after-blocks run in the case of exceptions too.
-  * Autotest support.
-  * Bug fixes.
-
-* November 30th, 2008: Third public release 1.1.
-  * Nested before/after.
-  * Add -Q/--no-backtraces to not show details about failed specifications.
-  * Add Knock output.
-  * Bug fixes.
-
-
-== Contact
-
-Please mail bugs, suggestions and patches to
-<mailto:chneukirchen@gmail.com>.
-
-Git repository (patches rebased on HEAD are most welcome):
-http://github.com/chneukirchen/bacon
-git://github.com/chneukirchen/bacon.git
-
-
-== Copying
-
-Copyright (C) 2007, 2008 Christian Neukirchen <purl.org/net/chneukirchen>
-
-Bacon is freely distributable under the terms of an MIT-style license.
-See COPYING or http://www.opensource.org/licenses/mit-license.php.
-
-
-== Links
-
-Behavior-Driven Development:: <http://behaviour-driven.org/>
-RSpec:: <http://rspec.rubyforge.org/>
-test/spec:: <http://test-spec.rubyforge.org/>
-
-Christian Neukirchen:: <http://chneukirchen.org/>