test-garden 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5355162fcc4ae930d4cdc5ebf84ffa0bd241bae8
+  data.tar.gz: 1ec76a8eefcc3e54601c2bb02b0f55cdf7f08c36
+SHA512:
+  metadata.gz: 88e3890465b22a04480b2fdfcb862bede60305a038a0c90bd9dc7097d87eabdfe65ff89dcbc63bd59d432c7b57a7a0e842332397ea200953a7067852bcaabe2a
+  data.tar.gz: c5eca2fdf237d5abb003ee7f99af9a686728ee291bced3892b8653c188adec99068a0c9f7f2b91acb85aa5f3609a0d10251b0651402907b07c05eb71f4b3edcc

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2014, Joel VanderWerf, vjoel@users.sourceforge.net
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,64 @@
+TestGarden
+==========
+
+A garden of forking tests.[1]
+
+TestGarden is a testing framework for concisely sharing several stages of
+setup code across tests. The shared code is executed once for each test
+that needs it. Tests may be nested to any depth.
+
+TestGarden generates summary output, reporting how many pass, fail, skip,
+and error cases were detected for each group of tests. TestGarden assumes
+assertion failure exceptions are generated by Wrong::Assert#assert.
+
+Synopsis:
+
+    require 'test-garden'
+
+    test Thing do
+      thing = Thing.new; teardown {thing.cleanup()}
+      assert {thing.ok?}
+
+      test "assign foo" do
+        thing.foo = "baz" # does not affect foo in subsequent tests
+        assert {thing.foo == "baz"}
+      end
+
+      test "compare foo in two instances" do
+        thing2 = Thing.new; teardown {thing2.cleanup()}
+        assert {thing.foo == thing2.foo}
+      end
+    end
+
+Run the test like so:
+
+    ruby test_thing.rb [-v | --verbose] [topic topic ...]
+
+If no topics are given, the verbose output is:
+
+    T: Thing
+    T: Thing: assign foo
+    P: Thing: assign foo
+    T: Thing
+    T: Thing: compare foo in two instances
+    P: Thing: compare foo in two instances
+      2 passed,   0 failed,   0 skipped,   0 errors in Thing
+
+If a topic list is given, it is treated as a sequence of regular expressions.
+Only tests whose topic path matches those regular expressions, one for one,
+are executed. (Matching is case insensitive.) For example:
+
+    ruby testfilename.rb thing compare
+
+This executes only the the last test. The verbose output is:
+
+    T: Thing
+    S: Thing: assign foo
+    T: Thing
+    T: Thing: compare foo in two instances
+    P: Thing: compare foo in two instances
+      1 passed,   0 failed,   1 skipped,   0 errors in Thing
+
+Note that the "assign foo" test was skipped, and counted as such.
+
+[1] In reference to "The garden of forking paths", by J.L. Borges.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/testtask'
+
+PRJ = "test-garden"
+
+def version
+  @version ||= begin
+    require 'test-garden'
+    warn "TestGarden::VERSION not a string" unless
+      TestGarden::VERSION.kind_of? String
+    TestGarden::VERSION
+  end
+end
+
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
+
+desc "Run tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "ext"
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+desc "Commit, tag, and push repo; build and push gem"
+task :release => "release:is_new_version" do
+  require 'tempfile'
+  
+  sh "gem build #{PRJ}.gemspec"
+
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
+
+  sh "git tag #{tag}"
+  sh "git push"
+  sh "git push --tags"
+  
+  sh "gem push #{tag}.gem"
+end
+
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
+
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
+
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
+end

data/lib/test-garden.rb

@@ -0,0 +1,250 @@
+require 'wrong'
+include Wrong::Assert
+
+if Wrong.config[:color]
+  require "wrong/rainbow"
+else
+  class String
+    def color(*); self; end
+    def bright; self; end
+  end
+end
+
+# Not directly instantiated by the user. See README and examples.
+class TestGarden
+  # Array of nested topics in descending order from the main topic to the topic
+  # of the current test.
+  attr_reader :stack
+  
+  # Hash of counters for pass, fail, skip, error cases.
+  attr_reader :status
+  
+  # Array of regexes that restrict which topics are traversed.
+  attr_reader :pattern
+  
+  # Stack of arrays of procs that will be called to tear down the current setup.
+  attr_reader :teardowns
+
+  VERSION = '0.4'
+
+  class IncompleteTest < StandardError; end
+
+  # Reads params from command line, or from given array of strings. If
+  # passing an array, you should call this method *before* all tests.
+  def self.params argv=ARGV
+    @params ||= {
+      :verbose => argv.delete("-v") || argv.delete("--verbose"),
+      :pattern => argv.map {|arg| /#{arg}/i}
+    }
+  end
+  
+  # By default, share params for all TestGardens, but allow per-instance
+  # variation by modifying the params hash.
+  def params
+    @params ||= self.class.params.dup
+  end
+  
+  def initialize
+    @pos = []
+    @next = nil
+    @did_one_test = false
+    @stack = []
+    @status = Hash.new(0)
+    @enabled = false
+    @pattern = params[:pattern]
+    @teardowns = []
+    @finishing = false
+  end
+  
+  def enabled?
+    @enabled
+  end
+  
+  def verbose?
+    params[:verbose]
+  end
+
+  def nest topic
+    topic = topic.to_s
+    @main_topic ||= topic
+
+    if @did_one_test
+      if not @next
+        @next = @pos.dup
+      end
+      @pos[-1] += 1 if @pos.length > 0
+      return
+    end
+    
+    if @next
+      len = [@pos.length, @next.length].min
+      if @next[0...len] != @pos[0...len]
+        @pos[-1] += 1 if @pos.length > 0
+        return
+      end
+      
+      if @next == @pos
+        @next = nil
+      end
+    end
+        
+    begin
+      stack.push topic
+      @pos << 0
+      teardowns << []
+      old_enabled = @enabled
+      @enabled = pattern.zip(stack).all? {|pat,subj| !subj or pat === subj}
+      if enabled?
+        puts "T: #{stack.join(": ")}" if verbose?
+        @finishing = false
+        catch :break_test do
+          yield
+          @finishing = stack.dup
+        end
+      else
+        puts "S: #{stack.join(": ")}" if verbose?
+        status[:skip] += 1
+      end
+    
+    ensure
+      if not @did_one_test
+        @did_one_test = true
+      else
+        @finishing = false
+      end
+
+      @enabled = old_enabled
+      @pos.pop
+      stack.pop
+      @pos[-1] += 1 if @pos.length > 0
+    end
+  end
+  
+  def do_teardowns
+    teardowns.pop.reverse_each {|block| block.call}
+  end
+  
+  def print_report
+    ps = "%3d passed" % status[:pass]
+    fs = "%3d failed" % status[:fail]
+    fs = fs.color(:yellow) if status[:fail] > 0
+    ss = "%3d skipped" % status[:skip]
+    es = "%3d errors" % status[:err]
+    es = es.color(:red) if status[:err] > 0
+    report = [ps,fs,ss,es].join(", ")
+    
+    inc = status[:incomplete]
+    if inc > 0
+      is = "%3d incomplete" % inc
+      is = is.color(:white)
+      report << ", #{is}"
+    end
+    
+    line = "#{report} in #{@main_topic}"
+    line = line.bright if verbose?
+    puts line
+  end
+
+  def handle_test_exceptions
+    yield
+
+  rescue Wrong::Assert::AssertionFailedError => ex
+    status[:fail] += 1
+    line = nil
+    ex.backtrace.reverse_each {|l| break if /wrong\/assert.rb/ =~ l; line = l}
+    msg = "F: #{stack.join(": ")}: failed assertion, at #{line}"
+    puts msg.color(:yellow), ex.message
+    throw :break_test
+  
+  rescue IncompleteTest => ex
+    status[:incomplete] += 1
+    if verbose?
+      msg = "I: #{stack.join(": ")}"
+      msg = msg.color(:white)
+      puts msg
+    end
+    throw :break_test
+
+  rescue => ex
+    status[:err]  += 1
+    bt = []
+    ex.backtrace.each {|l| break if /wrong\/assert.rb/ =~ l; bt << l}
+    bts = bt.join("\n  from ")
+    msg = "E: #{stack.join(": ")}: #{ex} (#{ex.class}), at #{bts}"
+    puts msg.color(:red)
+    throw :break_test
+
+  else
+    if enabled?
+      if @finishing
+        status[:pass] += 1
+        puts "P: #{@finishing.join(": ")}" if verbose?
+        @finishing = false
+      end
+    else
+      raise
+    end
+  end
+  
+  def main topic
+    begin
+      nest topic do
+        handle_test_exceptions do
+          yield
+          do_teardowns
+        end
+      end
+      @did_one_test = false
+    end while @next
+  ensure
+    print_report
+  end
+end
+
+# Begin a test block. The topic can be any object; its to_s method is applied
+# to generate the output string. A class or string is typical.
+#
+# The block can include essentially any code, including more #test calls,
+# method calls that call #test, assert{} and teardown{} calls, etc.
+#
+# If the block is omitted, then the test is assumed to be incomplete, perhaps
+# a stub indicating future work. Incomplete tests are counted and reported.
+def test topic
+  if @test
+    @test.nest topic do
+      @test.handle_test_exceptions do
+        if block_given?
+          yield
+          @test.do_teardowns
+        else
+          raise TestGarden::IncompleteTest
+        end
+      end
+    end
+    
+  else
+    begin
+      @test = TestGarden.new
+      @test.main topic do
+        if block_given?
+          yield
+        else
+          raise TestGarden::IncompleteTest
+        end
+      end
+    ensure
+      @test = nil
+    end
+  end
+end
+
+# Alternative to putting the teardown code after all relevant tests.
+# This can be used to keep related setup and teardown code together.
+# Teardows are executed in the reverse of their creation order.
+def teardown(&block)
+  if @test
+    @test.teardowns.last << block
+  else
+    raise "Cannot teardown: not in a test"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: test-garden
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Joel VanderWerf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: |-
+  A testing framework for concisely sharing several stages of
+  setup code across tests.
+email: vjoel@users.sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- COPYING
+- README.md
+- Rakefile
+- lib/test-garden.rb
+homepage: https://github.com/vjoel/test-garden
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- test-garden
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A garden of forking tests
+test_files: []
+has_rdoc: