undees-bacon 1.1.1

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2007, 2008 Christian Neukirchen <purl.org/net/chneukirchen>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,290 @@
+= 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/>

data/Rakefile

@@ -0,0 +1,138 @@
+# Rakefile for Bacon.  -*-ruby-*-
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+
+desc "Run all the tests"
+task :default => [:test]
+
+desc "Do predistribution stuff"
+task :predist => [:chmod, :changelog, :rdoc]
+
+
+desc "Make an archive as .tar.gz"
+task :dist => [:test, :predist] do
+  sh "git archive --format=tar --prefix=#{release}/ HEAD^{tree} >#{release}.tar"
+  sh "pax -waf #{release}.tar -s ':^:#{release}/:' RDOX ChangeLog doc"
+  sh "gzip -f -9 #{release}.tar"
+end
+
+# Helper to retrieve the "revision number" of the git tree.
+def git_tree_version
+  if File.directory?(".git")
+    @tree_version ||= `git describe`.strip.sub('-', '.')
+    @tree_version << ".0"  unless @tree_version.count('.') == 2
+  else
+    $: << "lib"
+    require 'bacon'
+    @tree_version = Bacon::VERSION
+  end
+  @tree_version
+end
+
+def gem_version
+  git_tree_version.gsub(/-.*/, '')
+end
+
+def release
+  "bacon-#{git_tree_version}"
+end
+
+def manifest
+  `git ls-files`.split("\n") - [".gitignore"]
+end
+
+
+desc "Make binaries executable"
+task :chmod do
+  Dir["bin/*"].each { |binary| File.chmod(0775, binary) }
+end
+
+desc "Generate a ChangeLog"
+task :changelog do
+  File.open("ChangeLog", "w") { |out|
+    `git log -z`.split("\0").map { |chunk|
+      author = chunk[/Author: (.*)/, 1].strip
+      date = chunk[/Date: (.*)/, 1].strip
+      desc, detail = $'.strip.split("\n", 2)
+      detail ||= ""
+      detail = detail.gsub(/.*darcs-hash:.*/, '')
+      detail.rstrip!
+      out.puts "#{date}  #{author}"
+      out.puts "  * #{desc.strip}"
+      out.puts detail  unless detail.empty?
+      out.puts
+    }
+  }
+end
+
+
+desc "Generate RDox"
+task "RDOX" do
+  sh "bin/bacon -Ilib --automatic --specdox >RDOX"
+end
+
+desc "Run all the tests"
+task :test do
+  ruby "bin/bacon -Ilib --automatic --quiet"
+end
+
+
+begin
+  $" << "sources"  if defined? FromSrc
+  require 'rubygems'
+
+  require 'rake'
+  require 'rake/clean'
+  require 'rake/packagetask'
+  require 'rake/gempackagetask'
+  require 'fileutils'
+rescue LoadError
+  # Too bad.
+else
+  spec = Gem::Specification.new do |s|
+    s.name            = "bacon"
+    s.version         = gem_version
+    s.platform        = Gem::Platform::RUBY
+    s.summary         = "a small RSpec clone"
+
+    s.description = <<-EOF
+Bacon is a small RSpec clone weighing less than 350 LoC but
+nevertheless providing all essential features.
+
+http://github.com/chneukirchen/bacon
+    EOF
+
+    s.files           = manifest + %w(RDOX ChangeLog)
+    s.bindir          = 'bin'
+    s.executables     << 'bacon'
+    s.require_path    = 'lib'
+    s.has_rdoc        = true
+    s.extra_rdoc_files = ['README', 'RDOX']
+    s.test_files      = []
+
+    s.author          = 'Christian Neukirchen'
+    s.email           = 'chneukirchen@gmail.com'
+    s.homepage        = 'http://chneukirchen.org/repos/bacon'
+  end
+
+  Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    p.need_tar = false
+    p.need_zip = false
+  end
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << 'Bacon Documentation' <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README'
+  rdoc.rdoc_files.include 'COPYING'
+  rdoc.rdoc_files.include 'RDOX'
+  rdoc.rdoc_files.include('lib/bacon.rb')
+end
+task :rdoc => ["RDOX"]

data/bin/bacon

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'optparse'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/')
+module Bacon; end
+
+automatic = false
+output = 'SpecDoxOutput'
+
+opts = OptionParser.new("", 24, '  ') { |opts|
+  opts.banner = "Usage: bacon [options] [files | -a] [-- untouched arguments]"
+
+  opts.separator ""
+  opts.separator "Ruby options:"
+
+  lineno = 1
+  opts.on("-e", "--eval LINE", "evaluate a LINE of code") { |line|
+    eval line, TOPLEVEL_BINDING, "-e", lineno
+    lineno += 1
+  }
+
+  opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") {
+    $DEBUG = true
+  }
+  opts.on("-w", "--warn", "turn warnings on for your script") {
+    $-w = true
+  }
+
+  opts.on("-I", "--include PATH",
+          "specify $LOAD_PATH (may be used more than once)") { |path|
+    $LOAD_PATH.unshift(*path.split(":"))
+  }
+
+  opts.on("-r", "--require LIBRARY",
+          "require the library, before executing your script") { |library|
+    require library
+  }
+
+  opts.separator ""
+  opts.separator "bacon options:"
+
+  opts.on("-s", "--specdox", "do AgileDox-like output (default)") {
+    output = 'SpecDoxOutput'
+  }
+  opts.on("-q", "--quiet",   "do Test::Unit-like non-verbose output") {
+    output = 'TestUnitOutput'
+  }
+  opts.on("-p", "--tap",     "do TAP (Test Anything Protocol) output") {
+    output = 'TapOutput'
+  }
+  opts.on("-k", "--knock",   "do Knock output") {
+    output = 'KnockOutput'
+  }
+
+  opts.on("-o", "--output FORMAT",
+          "do FORMAT (SpecDox/TestUnit/Tap) output") { |format|
+    output = format + "Output" 
+  }
+  opts.on("-Q", "--no-backtrace", "don't print backtraces") {
+    Bacon.const_set :Backtraces, false
+  }
+
+  opts.on("-a", "--automatic", "gather tests from ./test/, include ./lib/") {
+    $LOAD_PATH.unshift "lib"  if File.directory? "lib"
+    automatic = true
+  }
+
+  opts.on('-n', '--name NAME', String,
+          "runs tests matching regexp NAME") { |n|
+    Bacon.const_set :RestrictName, Regexp.new(n)
+  }
+  
+  opts.on('-t', '--testcase TESTCASE', String,
+          "runs tests in TestCases matching regexp TESTCASE") { |t|
+    Bacon.const_set :RestrictContext, Regexp.new(t)
+  }
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    require 'bacon'
+    puts "bacon #{Bacon::VERSION}"
+    exit
+  end
+
+  opts.parse! ARGV
+}
+
+files = ARGV
+
+if automatic
+  files.concat Dir["test/**/test_*.rb"]
+  files.concat Dir["test/**/spec_*.rb"]
+  files.concat Dir["spec/**/spec_*.rb"]
+end
+
+if files.empty?
+  puts opts.banner
+  exit 1
+end
+
+require 'bacon'
+
+Bacon.extend Bacon.const_get(output) rescue abort "No such formatter: #{output}"
+Bacon.summary_on_exit
+
+files.each { |file|
+  load file
+}
+