shindo 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/README.rdoc

@@ -0,0 +1,112 @@
+= shindo
+
+Simple depth first ruby testing, watch and learn.
+
+== Writing tests
+
+There are two commands you should know, 'tests' and 'test'. Tests help you group similar calls to test, but their return value is ignored.  The return value of test, on the other hand, determines success or failure.
+
+A successful test should return true. (yay)
+
+  Shindo.tests {
+    test('something really important') { true }
+  }
+
+A failing test should return false or nil. (boo)
+
+  Shindo.tests {
+    test('something (hopefully) less important') { false }
+  }
+
+A pending test shouldn't even have a block (meh)
+
+  Shindo.tests {
+    test('something that hasn't been gotten around to yet')
+  }
+
+Grouping tests
+
+  Shindo.tests {
+    tests('foo/bar') {
+      test('foo') { true }
+      test('bar') { true }
+    }
+  }
+
+You can also have descriptions for Shindo.tests, and write that last one like this
+
+  Shindo.tests('foo/bar') {
+    test('foo') { true }
+    test('bar') { false }
+  }
+
+Nest tests as deeply as you would like.
+
+Then, if you want to get real fancy you can also tag your tests, to help narrow down which ones to run
+
+  Shindo.tests {
+    tests('foo/bar', ['foo', 'bar']) {
+      test('foo') { true }
+      test('bar') { true }
+    }
+  }
+
+Or if you can narrow down even more tightly
+
+  Shindo.tests {
+    tests('foo/bar') {
+      test('foo', ['foo']) { true }
+      test('bar', ['bar']) { true }
+    }
+  }
+
+== Running tests
+
+Run tests with the shindo command, the easiest is to specify a file name:
+
+  shindo some_test_file.rb
+
+You can also give directories and it will run all .rb files inside (recurses through subdirectories)
+
+  shindo some_test_directory
+
+That leaves tags, which use +/-.  So run just tests with the 'foo' tag:
+
+  shindo some_test_directory +foo
+
+Or those without the 'bar' tag:
+
+  shindo some_test_directory -bar
+
+Or combine to run everything with a foo tag, but no bar tag
+
+  shindo some_test_directory +foo -bar
+
+== Command line tools
+
+When tests fail you'll get lots of options to help you debug the problem, just enter '?' at the prompt to see your options.
+
+== Copyright
+
+(The MIT License)
+
+Copyright (c) 2009 {geemus (Wesley Beary)}[http://github.com/geemus]
+
+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 OR COPYRIGHT HOLDERS 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/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.add_dependency('annals')
+    gem.name = "shindo"
+    gem.summary = %Q{ruby testing}
+    gem.description = %Q{Simple depth first ruby testing}
+    gem.email = "me@geemus.com"
+    gem.homepage = "http://github.com/geemus/shindo"
+    gem.authors = ["geemus (Wesley Beary)"]
+    gem.rubyforge_project = "shindo"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shindo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/shindo

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), '..', 'lib', 'shindo')
+
+files = []
+tags = []
+for argument in ARGV
+  if argument.match(/^[\+\-]/)
+    tags << argument
+  else
+    path = File.expand_path(argument)
+    if File.directory?(path)
+      files |= Dir.glob(File.join(path, '**', '*.rb'))
+    else
+      files << path
+    end
+  end
+end
+
+success = true
+def run_in_thread(files, tags)
+  tests = Thread.new {
+    Thread.current[:tags] = tags
+    for file in files
+      load(file)
+    end
+  }
+  tests.join
+  if tests[:reload]
+    run_in_thread(files, tags)
+  else
+    success = success && tests[:success]
+  end
+end
+run_in_thread(files, tags)
+
+at_exit {
+  if success
+    exit(0)
+  else
+    exit(1)
+  end
+}

data/lib/shindo.rb

@@ -0,0 +1,240 @@
+require 'rubygems'
+require 'annals'
+
+module Shindo
+
+  def self.tests(header = nil, &block)
+    STDOUT.sync = true
+    Shindo::Tests.new(header, &block)
+  end
+
+  class Tests
+
+    attr_accessor :backtrace
+
+    def initialize(header, tags = [], &block)
+      @afters     = []
+      @annals     = Annals.new
+      @befores    = []
+      @description_stack = []
+      @if_tagged      = Thread.current[:tags].select {|tag| tag.match(/^\+/)}
+      @unless_tagged  = Thread.current[:tags].select {|tag| tag.match(/^\-/)}.map {|tag| tag[1..-1]}
+      @indent     = 1
+      @success    = true
+      @tag_stack  = []
+      Thread.current[:reload] = false
+      print("\n")
+      tests(header, &block)
+      print("\n")
+      if @success
+        Thread.current[:success] = false
+      else
+        Thread.current[:success] = false
+      end
+    end
+
+    def after(&block)
+      @afters[-1].push(block)
+    end
+
+    def before(&block)
+      @befores[-1].push(block)
+    end
+
+    def full_description
+      "#{@description_stack.compact.join(' ')}#{full_tags}"
+    end
+
+    def full_tags
+      unless @tag_stack.flatten.empty?
+        " [#{@tag_stack.flatten.join(', ')}]"
+      end
+    end
+
+    def green_line(content)
+      print_line(content, "\e[32m")
+    end
+
+    def indent(&block)
+      @indent += 1
+      yield
+      @indent -= 1
+    end
+
+    def indentation
+      '  ' * @indent
+    end
+
+    def print_line(content, color = nil)
+      if color && STDOUT.tty?
+        content = "#{color}#{content}\e[0m"
+      end
+      print("#{indentation}#{content}\n")
+    end
+
+    def prompt(&block)
+      print("#{indentation}Action? [c,i,q,r,t,#,?]? ")
+      choice = STDIN.gets.strip
+      print("\n")
+      case choice
+      when 'c'
+        return
+      when 'i'
+        print_line('Starting interactive session...')
+        if @irb.nil?
+          require 'irb'
+          ARGV.clear # Avoid passing args to IRB
+          IRB.setup(nil)
+          @irb = IRB::Irb.new(nil)
+          IRB.conf[:MAIN_CONTEXT] = @irb.context
+          IRB.conf[:PROMPT][:TREST] = {}
+        end
+        for key, value in IRB.conf[:PROMPT][:SIMPLE]
+          IRB.conf[:PROMPT][:TREST][key] = "#{indentation}#{value}"
+        end
+        @irb.context.prompt_mode = :TREST
+        @irb.context.workspace = IRB::WorkSpace.new(block.binding)
+        begin
+          @irb.eval_input
+        rescue SystemExit
+        end
+      when 'q'
+        Thread.current[:success] = false
+        Thread.exit
+      when 'r'
+        print("Reloading...\n")
+        Thread.current[:reload] = true
+        Thread.exit
+      when 't'
+        indent {
+          if @annals.lines.empty?
+            print_line('no backtrace available')
+          else
+            index = 1
+            for line in @annals.lines
+              print_line("#{' ' * (2 - index.to_s.length)}#{index}  #{line}")
+              index += 1
+            end
+          end
+        }
+        print("\n")
+      when '?'
+        print_line('c - ignore this error and continue')
+        print_line('i - interactive mode')
+        print_line('q - quit Shindo')
+        print_line('r - reload and run the tests again')
+        print_line('t - display backtrace')
+        print_line('# - enter a number of a backtrace line to see its context')
+        print_line('? - display help')
+      when /\d/
+        index = choice.to_i - 1
+        if backtrace.lines[index]
+          indent {
+            print_line("#{@annals.lines[index]}: ")
+            indent {
+              print("\n")
+              current_line = @annals.buffer[index]
+              File.open(current_line[:file], 'r') do |file|
+                data = file.readlines
+                current = current_line[:line]
+                min     = [0, current - (@annals.max / 2)].max
+                max     = [current + (@annals.max / 2), data.length].min
+                min.upto(current - 1) do |line|
+                  print_line("#{line}  #{data[line].rstrip}")
+                end
+                yellow_line("#{current}  #{data[current].rstrip}")
+                (current + 1).upto(max - 1) do |line|
+                  print_line("#{line}  #{data[line].rstrip}")
+                end
+              end
+              print("\n")
+            }
+          }
+        else
+          red_line("#{choice} is not a valid backtrace line, please try again.")
+        end
+      else
+        red_line("#{choice} is not a valid choice, please try again.")
+      end
+      red_line("- #{full_description}")
+      prompt(&block)
+    end
+
+    def red_line(content)
+      print_line(content, "\e[31m")
+    end
+
+    def tests(description, tags = [], &block)
+      @tag_stack.push([*tags])
+      @befores.push([])
+      @afters.push([])
+
+      print_line(description || 'Shindo.tests')
+      if block_given?
+        indent { instance_eval(&block) }
+      end
+
+      @afters.pop
+      @befores.pop
+      @tag_stack.pop
+    end
+
+    def test(description, tags = [], &block)
+      @description_stack.push(description)
+      @tag_stack.push([*tags])
+
+      # if the test includes tags and discludes ^tags, evaluate it
+      if (@if_tagged.empty? || !(@if_tagged & @tag_stack.flatten).empty?) &&
+          (@unless_tagged.empty? || (@unless_tagged & @tag_stack.flatten).empty?)
+        if block_given?
+          for before in @befores.flatten.compact
+            before.call
+          end
+
+          @annals.start
+          begin
+            success = instance_eval(&block)
+            @annals.stop
+          rescue => error
+            success = false
+            file, line, method = error.backtrace.first.split(':')
+            if method
+              method << "in #{method[4...-1]} " # get method from "in `foo'"
+            else
+              method = ''
+            end
+            method << "! #{error.message} (#{error.class})"
+            @annals.stop
+            @annals.unshift(:file => file, :line => line.to_i, :method => method)
+          end
+          @success = @success && success
+          if success
+            green_line("+ #{full_description}")
+          else
+            red_line("- #{full_description}")
+            if STDOUT.tty?
+              prompt(&block)
+            end
+          end
+
+          for after in @afters.flatten.compact
+            after.call
+          end
+        else
+          yellow_line("* #{full_description}")
+        end
+      else
+        print_line("_ #{full_description}")
+      end
+
+      @tag_stack.pop
+      @description_stack.pop
+    end
+
+    def yellow_line(content)
+      print_line(content, "\e[33m")
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: shindo
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- geemus (Wesley Beary)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-07 00:00:00 -07:00
+default_executable: shindo
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: annals
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple depth first ruby testing
+email: me@geemus.com
+executables: 
+- shindo
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/shindo
+- lib/shindo.rb
+has_rdoc: true
+homepage: http://github.com/geemus/shindo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shindo
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ruby testing
+test_files: []
+