delano-tryouts 0.7.2 → 0.7.3

data/CHANGES.txt

@@ -1,6 +1,14 @@
 TRYOUTS, CHANGES
 
 
+#### 0.7.3 (2009-06-27) ###############################
+
+* ADDED: Display Tryouts group name for runtime errors. 
+* ADDED: Improved LoadError error message
+* ADDED: Print error messages for drills that PASS. 
+* ADDED: Better error handling when supplied tryouts file is not found
+
+
 #### 0.7.2 (2009-06-26) ###############################
 
 NOTE: You will need to make a syntax change to your tryouts.

data/README.rdoc

@@ -27,7 +27,7 @@ This is a return to the original syntax and I think it's the right way to go bec
 * <tt>drill 'test name', 'return value', :class, String</tt>
 
 
-== Examples
+== Writing Tests
 
 The examples below are a complete overview of Tryouts syntax. 
 
@@ -97,6 +97,45 @@ You can also use Tryouts to run benchmarks. The tryouts method takes a second pa
 
 The drill blocks in a benchmark Tryout return Tryouts::Stats objects. See: Tryouts::Drill::Sergeant::Benchmark
 
+== Running Tests
+
+Tryouts comes with an executable called <tt>sergeant</tt>. This is the drill sergeant that tells you what percentage of your dreams come true.
+
+    $ sergeant
+    
+    Gibbler Gazette                                                                
+
+     Basic syntax with SHA1 
+      "Object"                                                              PASS
+      "Class"                                                               PASS
+      ...
+      "Knows when an Hash has changed"                                      PASS
+
+    All 9 dreams came true 
+
+
+The sergeant looks in the current working directory for a <tt>tryouts</tt> directory and will automatically load all files ending in <tt>_tryouts.rb</tt>. 
+
+    $ ls -l tryouts/
+    01_mixins_tryouts.rb
+    10_syntax_tryouts.rb
+    20_cli_tryouts.rb
+    30_benchmark_tryouts.rb
+    50_class_context_tryouts.rb
+    
+You can also specify specific files to load:
+
+    $ sergeant any/file.rb
+
+Verbose mode gives you some extra information, including the return values from the drills. The more v's, the more information:
+
+    $ sergeant -v
+    
+In quiet mode, the sergeant returns only a PASS or FAIL message (in the case of a FAIL, it will also return a non-zero exit code): 
+
+    $ sergeant -q
+    PASS
+
 == Screenshots
 
 Here is an example of Tryouts output from a gibbler[http://github.com/delano/gibbler/blob/gibbler-0.2.1/tryouts/gibbler_tryouts.rb] tryout:

data/bin/sergeant

@@ -59,4 +59,9 @@ module TryoutsCLI
   
 end
 
-Drydock.run!(ARGV, STDIN) if Drydock.run?
+begin
+  Drydock.run!(ARGV, STDIN) if Drydock.run?
+rescue Tryouts::Exception => ex
+  puts ex.message
+  puts ex.backtrace if Tryouts.debug?
+end

data/lib/tryouts.rb

@@ -41,7 +41,7 @@ class Tryouts
     end
   end
     
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
   
   require 'tryouts/mixins'
   require 'tryouts/tryout'
@@ -140,15 +140,23 @@ class Tryouts
   # Require +name+. If +path+ is supplied, it will "require path". 
   # * +name+ The name of the library in question (required). Stored as a Symbol to +@library+.
   # * +path+ Add a path to the front of $LOAD_PATH (optional). Use this if you want to load
-  # a specific copy of the library. Otherwise, it loads from the system path.
-  def library(name=nil, path=nil)
+  #   a specific copy of the library. Otherwise, it loads from the system path. If the path 
+  #   in specified in multiple arguments they are joined and expanded.
+  #
+  #    library '/an/absolute/path'
+  #    library __FILE__, '..', 'lib'
+  #
+  def library(name=nil, *path)
     return @library if name.nil?
-    @library = name.to_sym
-    @dtype = :api
+    @library, @dtype = name.to_sym, :api
+    path = File.expand_path(File.join *path)
     $LOAD_PATH.unshift path unless path.nil?
     begin
       require @library.to_s
-    rescue SyntaxError, LoadError, Exception, TypeError, 
+    rescue LoadError => ex
+      @errors << ex.exception("Cannot load library: #{@library} (#{path})")
+      Tryouts.failed = true
+    rescue SyntaxError, Exception, TypeError, 
            RuntimeError, NoMethodError, NameError => ex
       @errors << ex
       Tryouts.failed = true
@@ -241,6 +249,16 @@ class Tryouts
     tryout(args, &block)
   end
   
+  # This method does nothing. It provides a quick way to disable a tryout.
+  #
+  # NOTE: This is a DSL-only method and is not intended for OO use.
+  def xtryouts(*args, &block); end
+  # This method does nothing. It provides a quick way to disable a tryout.
+  #
+  # NOTE: this is a standalone DSL-syntax method.
+  def self.xtryouts(*args, &block); end
+  
+  
   # Parse a +_tryouts.rb+ file. See Tryouts::CLI::Run for an example. 
   #
   # NOTE: this is an OO syntax method
@@ -262,6 +280,12 @@ class Tryouts
            RuntimeError, NoMethodError, NameError => ex
       to.errors << ex
       Tryouts.failed = true
+      # It's helpful to display the group name
+      file_content.match(/^group (.+?)$/) do |x,t|
+        # We use eval as a quick cheat so we don't have
+        # to parse all the various kinds of quotes.
+        to.group = eval x.captures.first
+      end
     end
     @@instances[to.group] = to
     to

data/lib/tryouts/cli/run.rb

@@ -41,13 +41,14 @@ class Run < Drydock::Command
       print "Tryouts #{Tryouts::VERSION} -- "
       print "#{Tryouts.sysinfo.to_s} (#{RUBY_VERSION}) -- "
       puts "#{start.strftime("%Y-%m-%d %H:%M:%S")}"
+      puts
     end
     
     load_available_tryouts_files
     
     passed, failed = 0, 0
     Tryouts.instances.each_pair do |group,tryouts_inst|
-      puts '', ' %-79s'.att(:reverse) % group  unless Tryouts.verbose < 0
+      puts ' %-79s'.att(:reverse) % group  unless Tryouts.verbose < 0
       puts "  #{tryouts_inst.paths.join("\n  ")}" if Tryouts.verbose > 0
       tryouts_inst.tryouts.each_pair do |name,to|
         begin
@@ -61,16 +62,24 @@ class Run < Drydock::Command
         passed += to.passed
         failed += to.failed
       end
-      
+
       unless tryouts_inst.errors.empty?
         title = '%-78s' % " RUNTIME ERRORS !?"
         puts $/, ' ' << title.color(:red).att(:reverse).bright
         tryouts_inst.errors.each do |ex|
-          trace = Tryouts.verbose > 1 ? ex.backtrace : [ex.backtrace.first]
+          
           puts '%4s%s: %s' % ['', ex.class, ex.message.to_s.split($/).join($/ + ' '*16)]
           puts
-          puts '%14s  %s' % ["", trace.join($/ + ' '*16)]
-          puts 
+
+          if [SyntaxError].member? ex.class
+            # don't print anymore. 
+          else
+            unless ex.backtrace.nil?
+              trace = Tryouts.verbose > 1 ? ex.backtrace : [ex.backtrace.first]
+              puts '%14s  %s' % ["", trace.join($/ + ' '*16)]
+              puts 
+            end
+          end
         end
       end
     end
@@ -139,6 +148,9 @@ private
     # If file paths were given, check those only. 
     unless @argv.empty?
       @argv.each do |file|
+        unless File.exists?(file)
+          raise Tryouts::Exception, "Not found: #{file}"
+        end
         file = File.join(file, '**', '*_tryouts.rb') if File.directory?(file)
         @tryouts_files += Dir.glob file
       end
@@ -190,7 +202,7 @@ class Tryouts::CLI::Run
                   `;  .'.'/.       ,\`.`.  ;' 
                    `-=;_-'  `-----'  `-_;=-'        -bodom-
 }
-PUG = %q{
+  PUG = %q{
               __,-----._                       ,-. 
             ,'   ,-.    \`---.          ,-----<._/ 
            (,.-. o:.`    )),"\\\-._    ,'         `. 

data/lib/tryouts/drill.rb

@@ -59,7 +59,11 @@ class Tryouts
         @dreams << Tryouts::Drill::Dream.new(dream_output, format)
       end
     when :benchmark
-      dream_output, format, reps = *(args.size == 1 ? args.first : [args[1], args[0], args[2]])
+      if args.size == 1
+        reps = args.first
+      else
+        dream_output, format, reps = args[1], args[0], args[2]
+      end
       @sergeant = Tryouts::Drill::Sergeant::Benchmark.new reps
       @dreams << Tryouts::Drill::Dream.new(Tryouts::Stats, :class)
       unless dream_output.nil?
@@ -112,27 +116,33 @@ class Tryouts
     
   def info
     out = StringIO.new
-    if Tryouts.verbose > 1
-      if @dreams.empty?
-        out.puts '%6s%s'.color(@clr) % ['', @reality.output.inspect]
-      else
-        @dreams.each do |dream|
-          if dream != @reality
-            out.puts '%6s%s'.color(:red) % ['', @reality.output.inspect]
-          else
-            out.puts '%6s%s'.color(:green) % ["", dream.test_to_string(@reality)]
-          end
+    if Tryouts.verbose > 0
+      if @dtype == :benchmark
+        unless @reality.output.nil?
+          mean, sdev, sum = @reality.output.mean, @reality.output.sdev, @reality.output.sum
+          out.puts '%6s%.4f (sdev:%.4f sum:%.4f)'.color(@clr) % ['', mean, sdev, sum]
         end
+      else
+        out.puts '%6s%s'.color(@clr) % ['', @reality.output.inspect]
       end
-    elsif Tryouts.verbose > 0
-      out.puts '%6s%s'.color(@clr) % ['', @reality.output.inspect]
       unless @reality.stash.empty?
         @reality.stash.each_pair do |n,v|
           out.puts '%18s: %s'.color(@clr) % [n,v.inspect]
         end
-        out.puts
       end
     end
+    if Tryouts.verbose > 1
+
+      @dreams.each do |dream|
+        if dream != @reality
+          out.puts '%6s%s'.color(:red) % ['', dream.test_to_string(@reality)]
+        else
+          out.puts '%6s%s'.color(:green) % ["", dream.test_to_string(@reality)]
+        end
+      end  
+      out.puts
+    
+    end
     out.rewind
     out.read
   end
@@ -162,6 +172,10 @@ class Tryouts
     out.read
   end
   
+  def has_error?
+    !@reality.error.nil?
+  end
+  
   def success?
     return false if @dreams.empty? && @reality.output != true
     begin

data/lib/tryouts/drill/response.rb

@@ -49,7 +49,7 @@ class Tryouts::Drill
           if dream.format.nil?
             reality.output == dream.output
           elsif reality.output.respond_to?(dream.format)
-            reality.output.send(dream.format) == dream.output
+            reality.comparison_value(dream)  == dream.output
           else 
             false
           end
@@ -96,7 +96,7 @@ class Tryouts::Drill
           elsif reality.output.respond_to?(dream.format)
             "#{reality.output.inspect}.#{dream.format} == #{dream.output.inspect}"
           else
-            "#{reality.output.inspect}.respond_to?(#{dream.format.inspect}) == false"
+            "Unknown method #{dream.format.inspect} for #{reality.output.class} "
           end
         
         end
@@ -195,7 +195,7 @@ class Tryouts::Drill
       else 
         if @output.nil? 
           @output
-        elsif @output.respond_to?(dream.format)
+        elsif @output.respond_to?(dream.format.to_sym)
           @output.send(dream.format)
         else
           @output

data/lib/tryouts/drill/sergeant/benchmark.rb

@@ -13,10 +13,10 @@ class Tryouts; class Drill; module Sergeant
     
     attr_reader :output
     
-    # * +reps+ Number of times to execute drill (>= 0, <= 30). Default: 3
+    # * +reps+ Number of times to execute drill (>= 0, <= 1000000). Default: 3
     #
     def initialize(reps=nil)
-      @reps = (1..30).include?(reps) ? reps : 5
+      @reps = (1..1000000).include?(reps) ? reps : 5
       @stats = Tryouts::Stats.new
     end
   
@@ -24,6 +24,7 @@ class Tryouts; class Drill; module Sergeant
       # A Proc object takes precedence over an inline block. 
       runtime = (block.nil? ? inline : block)
       response = Tryouts::Drill::Reality.new
+      
       if runtime.nil?
         raise "We need a block to benchmark"
       else
@@ -34,11 +35,12 @@ class Tryouts; class Drill; module Sergeant
             @stats.sample run
           end
           
+          # We add the output after we run the block so that
+          # that it'll remain nil if an exception was raised
           response.output = @stats
           
         rescue => e
           puts e.message, e.backtrace if Tryouts.verbose > 2
-          response.output = false
           response.etype = e.class
           response.error = e.message
           response.trace = e.backtrace

data/lib/tryouts/tryout.rb

@@ -81,6 +81,14 @@ class Tryouts
       puts $/, ' ' << title.color(:red).att(:reverse)
       puts drill.report
     end
+    # Print errors for successful runs too
+    success = @drills.select { |d| !d.skip? && d.success? }
+    success.each do |drill,index|
+      next unless drill.has_error?
+      title = ' %-69s ' % ["\"#{drill.name}\""]
+      puts $/, ' ' << title.color(:red).att(:reverse)
+      puts drill.report
+    end
   end
   
   # Did every Tryout finish successfully?

data/tryouts.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "tryouts"
   s.rubyforge_project = "tryouts"
-	s.version = "0.7.2"
+	s.version = "0.7.3"
 	s.summary = "Tryouts are high-level tests for your Ruby code. May all your dreams come true!"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delano-tryouts
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors: 
 - Delano Mandelbaum