shindo 0.0.18 → 0.1.0

data/Gemfile

@@ -1,3 +1,2 @@
-gem 'rake'
 gem 'formatador', '>=0.0.14'
-gem 'gestalt', '>=0.0.6'
+gem 'gestalt', '>=0.0.11'

data/Gemfile.lock

@@ -1,24 +1,18 @@
 --- 
-specs: 
-- rake: 
-    version: 0.8.7
-- formatador: 
-    version: 0.0.14
-- gestalt: 
-    version: 0.0.6
-hash: 967644697cb16cde400ae3abbd4c764876c4a3b0
-sources: []
-
 dependencies: 
   formatador: 
-    version: ">= 0.0.14"
-    group: 
-    - :default
-  rake: 
-    version: ">= 0"
     group: 
     - :default
+    version: ">= 0.0.14"
   gestalt: 
-    version: ">= 0.0.6"
     group: 
     - :default
+    version: ">= 0.0.11"
+specs: 
+- formatador: 
+    version: 0.0.14
+- gestalt: 
+    version: 0.0.11
+hash: 5c2e77551db0a4772439a57b49e0ecc967e4dfe3
+sources: []
+

data/README.rdoc

@@ -4,62 +4,43 @@ 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.
+Tests group similar assertions, but their return value is ignored.
 
-A successful test should return true. (yay)
+After that you just test based on the two things a ruby thing should do, raise or return.
 
-  Shindo.tests do
-    test('something really important') { true }
-  end
-
-A failing test should return false or nil. (boo)
+Returns takes what you expect and checks a block to see if the return value matches:
 
   Shindo.tests do
-    test('something (hopefully) less important') { false }
+    returns(true) { true }
+    returns(false) { false }
   end
 
-A pending test shouldn't even have a block (meh)
+Raises takes what error you expect and checks to see if the block will raise it:
 
   Shindo.tests do
-    test('something that hasn't been gotten around to yet')
-  end
-
-Grouping tests
-
-  Shindo.tests do
-    tests('foo/bar') do
-      test('foo') { true }
-      test('bar') { true }
-    end
+    raises(StandardError) { StandardError.new }
   end
 
-You can also have descriptions for Shindo.tests, and write that last one like this
+You can also override the default descriptions:
 
   Shindo.tests('foo/bar') do
-    test('foo') { true }
-    test('bar') { false }
+    returns('foo', 'returns foo when bar') { 'foo' }
+    returns('bar', 'returns bar when qux') { 'bar' }
   end
 
-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 do
-    tests('foo/bar', ['foo', 'bar']) do
+  Shindo.tests('tests for foo', 'foo') do
       test('foo') { true }
-      test('bar') { true }
-    end
   end
 
-Or if you can narrow down even more tightly
-
-  Shindo.tests do
-    tests('foo/bar') do
-      test('foo', ['foo']) { true }
-      test('bar', ['bar']) { true }
+  Shindo.tests('tests for bar', 'bar') do
+      test('bar') { true }
     end
   end
 
+Note: you'll have to supply a non-default description first, and then follow up with tags.
+
 == Running tests
 
 Run tests with the shindo command, the easiest is to specify a file name:

data/bin/shindo

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 require File.join(File.dirname(__FILE__), '..', 'lib', 'shindo')
 
-helpers = Dir.glob(File.join(Dir.pwd, 'tests', '**', '*helper.rb'))
-tests = []
+helpers = Dir.glob(File.join(Dir.pwd, 'tests', '**', '*helper.rb')).sort_by {|helper| helper.count(File::SEPARATOR)}
 tags = []
 for argument in ARGV
   if argument.match(/^[\+\-]/)
@@ -10,18 +9,24 @@ for argument in ARGV
   else
     path = File.expand_path(argument)
     if File.directory?(path)
+      tests ||= []
       tests |= Dir.glob(File.join(path, '**', '*tests.rb'))
-    else
+    elsif File.exists?(path)
+      tests ||= []
       tests << path
+    else
+      Formatador.display_line("[red][bold]#{argument}[/] [red]does not exist, please fix this path and try again.[/]")
+      Kernel.exit(1)
     end
   end
 end
 
-if tests.empty?
-  tests |= Dir.glob(File.join('tests', '**', '*tests.rb'))
+# ARGV was empty or only contained tags
+unless tests
+  tests = Dir.glob(File.join('tests', '**', '*tests.rb'))
 end
 
-@success = true
+@started_at = Time.now
 def run_in_thread(helpers, tests, tags)
   shindo = Thread.new {
     Thread.current[:tags] = tags
@@ -34,14 +39,25 @@ def run_in_thread(helpers, tests, tags)
   }
   shindo.join
   if shindo[:reload]
-    @success = true
     run_in_thread(helpers, tests, tags)
   else
-    @success = @success && shindo[:success]
+    @totals = shindo[:totals]
   end
 end
 run_in_thread(helpers, tests, tags)
 
+@totals   ||= { :failed => 0, :pending => 0, :succeeded => 0 }
+@success  = @totals[:failed] == 0
+lines = []
+lines << "[red]#{@totals[:failed]} failed[/]," if @totals[:failed] > 0
+lines << "[yellow]#{@totals[:pending]} pending[/]," if @totals[:pending] > 0
+lines << "[green]#{@totals[:succeeded]} succeeded[/]"
+lines = lines[0...-2].join(', ') << ' and ' << lines[-1] if lines.length > 3
+lines << "in [bold]#{Time.now - @started_at}[/] seconds"
+Formatador.display_line
+Formatador.display_line(lines.join(' '))
+Formatador.display_line
+
 if @success
   Kernel.exit(0)
 else

data/lib/shindo.rb

@@ -1,10 +1,11 @@
 require 'rubygems'
 require 'formatador'
+require 'gestalt'
 
 module Shindo
 
-  unless VERSION
-    VERSION = '0.0.18'
+  unless const_defined?(:VERSION)
+    VERSION = '0.1.0'
   end
 
   def self.tests(description = nil, tags = [], &block)
@@ -20,8 +21,8 @@ module Shindo
       @formatador = Formatador.new
       @tag_stack  = []
       Thread.current[:reload] = false
-      Thread.current[:success] = true
       Thread.current[:tags] ||= []
+      Thread.current[:totals] ||= { :failed => 0, :pending => 0, :skipped => 0, :succeeded => 0 }
       @if_tagged = []
       @unless_tagged = []
       for tag in Thread.current[:tags]
@@ -45,20 +46,130 @@ module Shindo
       @befores.last.push(block)
     end
 
+    def tests(description, tags = [], &block)
+      return if @exit || Thread.current[:reload]
+
+      tags = [*tags]
+      @tag_stack.push(tags)
+      @befores.push([])
+      @afters.push([])
+
+      @description = nil
+      description ||= 'Shindo.tests'
+      description = "[bold]#{description}[normal]"
+      unless tags.empty?
+        description << " (#{tags.join(', ')})"
+      end
+
+      # 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?
+          @formatador.display_line(description)
+          @formatador.indent { instance_eval(&block) }
+        else
+          @description = description
+        end
+      else
+        @formatador.display_line("[light_black]#{description}[/]")
+      end
+
+      @afters.pop
+      @befores.pop
+      @tag_stack.pop
+
+      Thread.exit if @exit || Thread.current[:reload]
+      self
+    end
+
+    def raises(error, &block)
+      assert(:raises, error, "raises #{error.inspect}", &block)
+    end
+
+    def returns(expectation, &block)
+      assert(:returns, expectation, "returns #{expectation.inspect}", &block)
+    end
+
+    def test(description = 'returns true', &block)
+      assert(:returns, true, description, &block)
+    end
+
+    private
+
+    def assert(type, expectation, description, &block)
+      return if @exit || Thread.current[:reload]
+      description = [@description, description].compact.join(' ')
+      success = nil
+      @gestalt = Gestalt.new({'formatador' => @formatador})
+      if block_given?
+        begin
+          for before in @befores.flatten.compact
+            before.call
+          end
+          value = @gestalt.run(&block)
+          success = case type
+          when :raises
+            value.is_a?(expectation)
+          when :returns
+            value == expectation
+          end
+          for after in @afters.flatten.compact
+            after.call
+          end
+        rescue => error
+          @formatador.display_line("[red]#{error.message} (#{error.class})[/]")
+        end
+        if success
+          success(description)
+        else
+          failure(description)
+          @message ||= [
+            "expected => #{expectation.inspect}",
+            "returned => #{value.inspect}"
+          ]
+          @formatador.indent do
+            @formatador.display_lines([*@message].map {|message| "[red]#{message}[/]"})
+          end
+          @message = nil
+          if STDOUT.tty?
+            prompt(description, &block)
+          end
+        end
+      else
+        pending(description)
+      end
+      success
+    end
+
+    def failure(description, &block)
+      Thread.current[:totals][:failed] += 1
+      @formatador.display_line("[red]- #{description}[/]")
+    end
+
+    def pending(description, &block)
+      Thread.current[:totals][:pending] += 1
+      @formatador.display_line("[yellow]# #{description}[/]")
+    end
+
     def prompt(description, &block)
       @formatador.display("Action? [c,e,i,q,r,t,?]? ")
       choice = STDIN.gets.strip
+      continue = false
       @formatador.display_line
       @formatador.indent do
         case choice
         when 'c', 'continue'
-          return
+          continue = true
         when /^e .*/, /^eval .*/
-          value = eval(choice[2..-1], block.binding)
-          if value.nil?
-            value = 'nil'
+          begin
+            value = eval(choice[2..-1], @gestalt.bindings.last)
+            if value.nil?
+              value = 'nil'
+            end
+            @formatador.display_line(value)
+          rescue => error
+            @formatador.display_line("[red]#{error.message} (#{error.class})[/]")
           end
-          @formatador.display_line(value)
         when 'i', 'interactive', 'irb'
           @formatador.display_line('Starting interactive session...')
           if @irb.nil?
@@ -73,21 +184,23 @@ module Shindo
             IRB.conf[:PROMPT][:SHINDO][key] = "#{@formatador.indentation}#{value}"
           end
           @irb.context.prompt_mode = :SHINDO
-          @irb.context.workspace = IRB::WorkSpace.new(block.binding)
+          @irb.context.workspace = IRB::WorkSpace.new(@gestalt.bindings.last)
           begin
             @irb.eval_input
           rescue SystemExit
           end
         when 'q', 'quit', 'exit'
-          Thread.current[:success] = false
-          Thread.exit
+          @formatador.display_line("Exiting...")
+          @exit = true
         when 'r', 'reload'
           @formatador.display_line("Reloading...")
           Thread.current[:reload] = true
-          Thread.exit
         when 't', 'backtrace', 'trace'
-          require 'gestalt'
-          Gestalt.trace({'c-call' => true, 'formatador' => @formatador}, &block)
+          if @gestalt.calls.empty?
+            @formatador.display_line("[red]No methods were called, so no backtrace was captured.[/]")
+          else
+            @gestalt.display_calls
+          end
         when '?', 'help'
           @formatador.display_lines([
             'c - ignore this error and continue',
@@ -102,93 +215,15 @@ module Shindo
         end
         @formatador.display_line
       end
-      @formatador.display_line("[red]- #{description}[/]")
-      prompt(description, &block)
-    end
-
-    def tests(description, tags = [], &block)
-      tags = [*tags]
-      @tag_stack.push(tags)
-      @befores.push([])
-      @afters.push([])
-
-      unless tags.empty?
-        taggings = " (#{tags.join(', ')})"
-      end
-
-      @formatador.display_line((description || 'Shindo.tests') << taggings.to_s)
-      if block_given?
-        @formatador.indent { instance_eval(&block) }
-      end
-
-      @afters.pop
-      @befores.pop
-      @tag_stack.pop
-    end
-
-    def test(description, tags = [], &block)
-      tags = [*tags]
-      @tag_stack.push(tags)
-      unless tags.empty?
-        taggings = " (#{tags.join(', ')})"
-      end
-
-      # 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?
-          begin
-            for before in @befores.flatten.compact
-              before.call
-            end
-            Thread.current[:success] = instance_eval(&block)
-            for after in @afters.flatten.compact
-              after.call
-            end
-          rescue => error
-            Thread.current[:success] = false
-            @formatador.display_line("[red]#{error.message} (#{error.class})[/]")
-          end
-          if Thread.current[:success]
-            @formatador.display_line("[green]+ #{description}#{taggings.to_s}[/]")
-          else
-            @formatador.display_line("[red]- #{description}#{taggings.to_s}[/]")
-            if STDOUT.tty?
-              prompt(description, &block)
-            end
-          end
-        else
-          @formatador.display_line("[yellow]* #{description}#{taggings.to_s}[/]")
-        end
-      else
-        @formatador.display_line("_ #{description}#{taggings.to_s}")
+      unless continue || @exit
+        @formatador.display_line("[red]- #{description}[/]")
+        prompt(description, &block)
       end
-
-      @tag_stack.pop
     end
 
-  end
-
-end
-
-
-if __FILE__ == $0
-
-  def bar(string, remaining = ['b','a','r'])
-    if remaining.empty?
-      string
-    else
-      bar(string << remaining.shift, remaining)
-    end
-  end
-
-  Shindo.tests do
-
-    test('failure') do
-      raise StandardError.new('exception')
-      @foo = ''
-      bar(@foo)
-      @foo == 'foo'
+    def success(description, &block)
+      Thread.current[:totals][:succeeded] += 1
+      @formatador.display_line("[green]+ #{description}[/]")
     end
 
   end

data/shindo.gemspec

@@ -13,21 +13,21 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'shindo'
-  s.version           = '0.0.18'
-  s.date              = '2010-05-02'
+  s.version           = '0.1.0'
+  s.date              = '2010-05-21'
   s.rubyforge_project = 'shindo'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
-  s.summary     = "Ruby testing."
-  s.description = "Simple depth first ruby testing."
+  s.summary     = "Simple depth first Ruby testing."
+  s.description = "Work with your tests, not against them."
 
   ## List the primary authors. If there are a bunch of authors, it's probably
   ## better to set the email to an email list or something. If you don't have
   ## a custom homepage, consider using your GitHub URL or the like.
   s.authors  = ["geemus (Wesley Beary)"]
   s.email    = 'geemus@gmail.com'
-  s.homepage = 'http://github.com/geemus/NAME'
+  s.homepage = 'http://github.com/geemus/shindo'
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
   s.add_dependency('formatador', '>=0.0.14')
-  s.add_dependency('gestalt', '>=0.0.6')
+  s.add_dependency('gestalt', '>=0.0.11')
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
@@ -69,6 +69,7 @@ Gem::Specification.new do |s|
     lib/shindo/rake.rb
     shindo.gemspec
     tests/basic_tests.rb
+    tests/bin_tests.rb
     tests/data/exception
     tests/data/failure
     tests/data/negative

data/tests/basic_tests.rb

@@ -1,27 +1,9 @@
 Shindo.tests('basics') do
 
-  tests('exception') do
-    @output = bin(path('exception'))
-    test('output') { @output.include?('- exception') }
-    test('status') { $?.exitstatus == 1 }
-  end
+  returns(false)        { false }
 
-  tests('failure') do
-    @output = bin(path('failure'))
-    test('output') { @output.include?('- failure') }
-    test('status') { $?.exitstatus == 1 }
-  end
+  raises(StandardError) { raise StandardError.new }
 
-  tests('pending') do
-    @output = bin(path('pending'))
-    test('output') { @output.include?('* pending') }
-    test('status') { $?.exitstatus == 0 }
-  end
-
-  tests('success') do
-    @output = bin(path('success'))
-    test('output') { @output.include?('+ success') }
-    test('status') { $?.exitstatus == 0 }
-  end
+  test('returns true')  { true }
 
 end

data/tests/bin_tests.rb

@@ -0,0 +1,27 @@
+Shindo.tests('bin') do
+
+  tests('exception') do
+    @output = bin(path('exception'))
+    includes('- exception')           { @output }
+    tests('$?.exitstatus').returns(1) { $?.exitstatus }
+  end
+
+  tests('failure') do
+    @output = bin(path('failure'))
+    includes('- failure')             { @output }
+    tests('$?.exitstatus').returns(1) { $?.exitstatus }
+  end
+
+  tests('pending') do
+    @output = bin(path('pending'))
+    includes('# pending')             { @output }
+    tests('$?.exitstatus').returns(0) { $?.exitstatus }
+  end
+
+  tests('success') do
+    @output = bin(path('success'))
+    includes('+ success')             { @output }
+    tests('$?.exitstatus').returns(0) { $?.exitstatus }
+  end
+
+end

data/tests/data/negative

@@ -1,4 +1,7 @@
-Shindo.tests do
+Shindo.tests('success') do
   test('is tested') { true }
-  test('is skipped', 'negative') { false }
-end
+end
+
+Shindo.tests('skipped', 'negative') do
+  test('is skipped') { false }
+end

data/tests/data/positive

@@ -1,4 +1,7 @@
-Shindo.tests do
-  test('is tested', 'positive') { true }
+Shindo.tests('success',  'positive') do
+  test('is tested') { true }
+end
+
+Shindo.tests('skipped') do
   test('is skipped') { false }
-end
+end

data/tests/tag_tests.rb

@@ -1,17 +1,17 @@
-Shindo.tests('tags') do
+Shindo.tests('bin') do
 
-  tests('negative') do
+  tests("negative -negative") do
     @output = bin("#{path('negative')} -negative")
-    test('is tested')   { @output.include?('+ is tested') }
-    test('is skipped')  { @output.include?('_ is skipped (negative)') }
-    test('status')      { $?.exitstatus == 0 }
+    includes('+ is tested')           { @output }
+    includes('skipped (negative)')    { @output }
+    tests('$?.exitstatus').returns(0) { $?.exitstatus }
   end
 
-  tests('positive') do
+  tests("positive +positive") do
     @output = bin("#{path('positive')} +positive")
-    test('is tested')   { @output.include?('+ is tested (positive)') }
-    test('is skipped')  { @output.include?('_ is skipped') }
-    test('status')      { $?.exitstatus == 0 }
+    includes('+ is tested')           { @output }
+    includes('skipped')               { @output }
+    tests('$?.exitstatus').returns(0) { $?.exitstatus }
   end
 
 end

data/tests/tests_helper.rb

@@ -9,3 +9,17 @@ end
 def path(name)
   File.join(File.dirname(__FILE__), 'data', name)
 end
+
+module Shindo
+  class Tests
+
+    def includes(expectation, description = "includes #{expectation.inspect}", &block)
+      test(description) do
+        value = instance_eval(&block)
+        @message = "expected #{value.inspect} to include #{expectation.inspect}"
+        value.include?(expectation)
+      end
+    end
+
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 18
-  version: 0.0.18
+  version: 0.1.0
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-02 00:00:00 -07:00
+date: 2010-05-21 00:00:00 -07:00
 default_executable: shindo
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,11 +41,11 @@ dependencies:
         segments: 
         - 0
         - 0
-        - 6
-        version: 0.0.6
+        - 11
+        version: 0.0.11
   type: :runtime
   version_requirements: *id002
-description: Simple depth first ruby testing.
+description: Work with your tests, not against them.
 email: geemus@gmail.com
 executables: 
 - shindo
@@ -63,6 +63,7 @@ files:
 - lib/shindo/rake.rb
 - shindo.gemspec
 - tests/basic_tests.rb
+- tests/bin_tests.rb
 - tests/data/exception
 - tests/data/failure
 - tests/data/negative
@@ -72,7 +73,7 @@ files:
 - tests/tag_tests.rb
 - tests/tests_helper.rb
 has_rdoc: true
-homepage: http://github.com/geemus/NAME
+homepage: http://github.com/geemus/shindo
 licenses: []
 
 post_install_message: 
@@ -100,6 +101,6 @@ rubyforge_project: shindo
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
-summary: Ruby testing.
+summary: Simple depth first Ruby testing.
 test_files: []