tryouts 0.7.1 → 0.7.2

data/CHANGES.txt

@@ -1,6 +1,16 @@
 TRYOUTS, CHANGES
 
 
+#### 0.7.2 (2009-06-26) ###############################
+
+NOTE: You will need to make a syntax change to your tryouts.
+OLD: dream OUTPUT, :format
+NEW: dream :format, OUTPUT
+
+* CHANGE: Order of dream arguments is reversed!
+* CHANGE: Reduced CLI width to 79
+
+
 #### 0.7.1 (2009-06-26) ###############################
 
 * FIXED: Updated manifest in gemspec

data/README.rdoc

@@ -11,11 +11,21 @@ A tryout is made up of one of more drills. The return value of the drill block i
 * Drill Sergeant: The class responsible for executing a drill.
 * Dream: the expected outcome of a drill. There's always one or more dream per drill.
 
-== Installation ==
+== Installation
 
-{{{
     $ gem install tryouts
-}}}
+
+
+== NOTICE (2009-06-26): DSL Syntax Change
+
+The order of dream arguments has reversed between 0.7.1 and 0.7.2. It is now:
+
+* <tt>dream :method, 'Expected value'</tt>
+
+This is a return to the original syntax and I think it's the right way to go because it reads more naturally:
+
+* <tt>drill 'test name', 'return value', :class, String</tt>
+
 
 == Examples
 
@@ -23,9 +33,9 @@ The examples below are a complete overview of Tryouts syntax.
 
 === Testing Ruby Codes (:api)
 
-    library :caesars, "../path/to/caesars/lib"
+    library :gibbler, "../path/to/gibbler/lib"
 
-    tryouts "Common Usage" do
+    tryouts "Common Usage", :api do
     
       # This drill block should return 3.
       drill "Maths R Us", 3 do
@@ -34,26 +44,26 @@ The examples below are a complete overview of Tryouts syntax.
       
       # You can specify a method to execute
       # on the return value of the drill block. 
-      drill "We want a symbol", Symbol, :class do
+      drill "We want a symbol", :class, Symbol do
         orange.methods.first
       end
       
       # Dreams can also be specified explicitly which is
       # important b/c it's possible to specify multiple.
-      dream Array, :class
+      dream :class, Array
       dream [:a, :b, :c]
       drill "Should return a list of 3" do
         Letters.list(3)
       end
       
       # Drills can pass based on an exception too.
-      dream NameError, :exception
+      dream :exception, NameError
       drill "Something failed" do
         raise NameError
       end
       
       # We can even put simple drills on a single line. 
-      drill "Santa's postal code", 'H0H 0H0', /\w\d\w \d\w\d/, :match
+      drill 'Small, fast, and furious', 'Muggsy Bogues', :match, /Mug+sy Bogu?es/
       
     end
 
@@ -69,18 +79,18 @@ You can also use Tryouts to run benchmarks. The tryouts method takes a second pa
        @@array = (1..100000).map { rand }
      end
      
-     dream 3.0, :mean        # The mean should be <= 3.0 seconds
-     dream 0.1, :sdev        # and the standard deviation <= 0.1
+     dream :mean, 3.0        # The mean should be <= 3.0 seconds
+     dream :sdev, 0.1        # and the standard deviation <= 0.1
      drill("Array sort!") { @@array.dup.sort! }
      
      # You can also include a dream inline
-     drill("Array sort", 3.0, :mean) { @@array.dup.sort }
+     drill("Array sort", :mean, 3.0) { @@array.dup.sort }
      
      # The 3rd argument is the number of times to 
      # execute the drill block. The mean and sdev
      # are calculate based on all iterations. The
      # default is 5 and the maximum is 30.
-     dream 0.1, :sdev, 15    
+     dream :sdev, 0.1, 15    
      drill("Array sort") { @@array.dup.sort }
       
    end
@@ -95,17 +105,18 @@ http://github.com/delano/tryouts/raw/gh-pages/screens/tryouts-1-failure.png
 
 The drill that failed looks like this:
 
-    dream :to_gibble, :respond_to?
-    dream 'ab33b9dec202d136d0e695a3a7b06ee678134882', :to_gibble 
-    drill "Array", Array
+    dream :respond_to?, :to_gibble
+    dream :to_gibble, 'ab33b9dec202d136d0e695a3a7b06ee678134882'
+    drill Array, "Array"
 
 
 == BETA Notice
 
-This library is very new (est. 2009-05-19) and has not been vetted by the scrutiny of time. In particular you can expect:
+Tryouts is very new (est. 2009-05-19) and has not been vetted by the scrutiny of time. In particular you can expect:
 
 * The test definition syntax may change in future releases. 
 * Unexpected errors. 
+* Bugs! I love fixing bugs so if you find one let me know. 
 
 
 == On Threads

data/lib/tryouts/cli/run.rb

@@ -47,7 +47,7 @@ class Run < Drydock::Command
     
     passed, failed = 0, 0
     Tryouts.instances.each_pair do |group,tryouts_inst|
-      puts '', ' %-80s'.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
@@ -63,11 +63,11 @@ class Run < Drydock::Command
       end
       
       unless tryouts_inst.errors.empty?
-        title = '%-79s' % " RUNTIME ERRORS !?"
+        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 '%14s: %s' % [ex.class, ex.message.to_s.split($/).join($/ + ' '*16)]
+          puts '%4s%s: %s' % ['', ex.class, ex.message.to_s.split($/).join($/ + ' '*16)]
           puts
           puts '%14s  %s' % ["", trace.join($/ + ' '*16)]
           puts 

data/lib/tryouts/drill.rb

@@ -32,8 +32,19 @@ class Tryouts
     # A Reality object (the actual output of the test)
   attr_reader :reality
   
-  @@valid_dtypes = [:cli, :api, :benchmark]
+  @@valid_dtypes = [:api, :benchmark]
   
+  # * +name+ The display name of this drill
+  # * +dtype+ A Symbol representing the drill type. One of: :api, :benchmark
+  # * +args+ These are dependent on the drill type. See the Sergeant classes
+  # * +&drill+ The body of the drill. The return value of this block 
+  #   is compared to the exepected output of the dreams. 
+  #
+  # The DSL syntax:
+  # * dream OUTPUT
+  # * dream FORMAT, OUTPUT
+  # * dream FORMAT, OUTPUT, REPS      (benchmark only)
+  #
   def initialize(name, dtype, *args, &drill)
     @name, @dtype, @drill, @skip = name, dtype, drill, false
     @dreams = []
@@ -42,14 +53,17 @@ class Tryouts
       @sergeant = Tryouts::Drill::Sergeant::CLI.new *args
     when :api
       default_output = drill.nil? ? args.shift : nil
+      dream_output, format = *(args.size == 1 ? args.first : args.reverse)
       @sergeant = Tryouts::Drill::Sergeant::API.new default_output
-      @dreams << Tryouts::Drill::Dream.new(*args) unless args.empty?
+      unless args.empty?
+        @dreams << Tryouts::Drill::Dream.new(dream_output, format)
+      end
     when :benchmark
-      default_output, format, reps = *args 
-      @sergeant = Tryouts::Drill::Sergeant::Benchmark.new reps || 1
+      dream_output, format, reps = *(args.size == 1 ? args.first : [args[1], args[0], args[2]])
+      @sergeant = Tryouts::Drill::Sergeant::Benchmark.new reps
       @dreams << Tryouts::Drill::Dream.new(Tryouts::Stats, :class)
-      unless default_output.nil?
-        @dreams << Tryouts::Drill::Dream.new(default_output, format)
+      unless dream_output.nil?
+        @dreams << Tryouts::Drill::Dream.new(dream_output, format)
       end
     when :skip
       @skip = true
@@ -63,6 +77,7 @@ class Tryouts
     @reality = Tryouts::Drill::Reality.new
   end
   
+  def self.valid_dtypes; @@valid_dtypes; end
   def self.valid_dtype?(t); @@valid_dtypes.member?(t); end
   
   def skip?; @skip; end
@@ -128,9 +143,9 @@ class Tryouts
     
     @dreams.each do |dream|
       next if dream == reality #? :normal : :red 
-      out.puts '%12s: %s'.color(@clr) % ["drill", dream.test_to_string(@reality)]
-      out.puts '%12s: %s' % ["returned", @reality.comparison_value(dream).inspect]
-      out.puts '%12s: %s' % ["expected", dream.comparison_value.inspect]
+      out.puts '%12s: %s'.color(@clr) % ["failed", dream.test_to_string(@reality)]
+      out.puts '%12s: %s' % ["drill", @reality.comparison_value(dream).inspect]
+      out.puts '%12s: %s' % ["dream", dream.comparison_value.inspect]
       out.puts
     end
     

data/lib/tryouts/stats.rb

@@ -17,7 +17,7 @@
 # are not stored but instead all the values are calculated on the fly.
 class Tryouts
   class Stats
-    attr_reader :sum, :sumsq, :n, :min, :max
+    attr_reader :sum, :sumsq, :n, :min, :max, :name
 
     def initialize(name=:unknown)
       @name = name
@@ -34,6 +34,8 @@ class Tryouts
       @max = 0.0
     end
 
+    def samples; @n; end
+
     # Adds a sampling to the calculations.
     def sample(s)
       @sum += s
@@ -88,5 +90,7 @@ class Tryouts
       sample(now - @last_time)
       @last_time = now
     end
+    
+    
   end
 end

data/lib/tryouts/tryout.rb

@@ -57,7 +57,7 @@ class Tryouts
     DrillContext.module_eval &setup if setup.is_a?(Proc)
     puts "\n  %s ".bright % @name unless Tryouts.verbose < 0
     @drills.each do |drill|
-      print '   %-70s ' % "\"#{drill.name}\"" unless Tryouts.verbose < 0
+      print '   %-69s ' % "\"#{drill.name}\"" unless Tryouts.verbose < 0
       drill.run DrillContext.new
       if drill.skip?
         @skipped += 1
@@ -77,7 +77,7 @@ class Tryouts
     return if Tryouts.verbose < 0
     failed = @drills.select { |d| !d.skip? && !d.success? }
     failed.each_with_index do |drill,index|
-      title = ' %-70s %2d/%-2d  ' % ["\"#{drill.name}\"", index+1, failed.size]
+      title = ' %-69s %2d/%-2d  ' % ["\"#{drill.name}\"", index+1, failed.size]
       puts $/, ' ' << title.color(:red).att(:reverse)
       puts drill.report
     end
@@ -136,11 +136,8 @@ class Tryouts
     if args.empty?
       dobj = Tryouts::Drill::Dream.from_block definition
     else
-      if args.size == 1
-        dobj = Tryouts::Drill::Dream.new(args.shift)  # dream 'OUTPUT'
-      else
-        dobj = Tryouts::Drill::Dream.new(*args)       # dream 'OUTPUT', :format
-      end
+      args = args.size == 1 ? [args.first] : args.reverse
+      dobj = Tryouts::Drill::Dream.new(*args)
     end
     @dream_catcher.push dobj
     dobj

data/lib/tryouts.rb

@@ -30,9 +30,18 @@ class Tryouts
   class Exception < RuntimeError; end
   # = BadDreams
   # Raised when there is a problem loading or parsing a Tryouts::Drill::Dream object
-  class BadDreams < Exception; end
+  class BadDream < Exception; end
   
-  VERSION = "0.7.1"
+  class NoDrillType < Exception
+    attr_accessor :tname
+    def initialize(t); @tname = t; end
+    def message
+      vdt = Tryouts::Drill.valid_dtypes
+      "Tryout '#{@tname}' has no drill type. Should be: #{vdt.join(', ')}"
+    end
+  end
+    
+  VERSION = "0.7.2"
   
   require 'tryouts/mixins'
   require 'tryouts/tryout'
@@ -167,7 +176,7 @@ class Tryouts
   
   # Create a new Tryout object and add it to the list for this Tryouts class. 
   # * +name+ is the name of the Tryout
-  # * +type+ is the default drill type for the Tryout. One of: :cli, :api
+  # * +dtype+ is the default drill type for the Tryout.
   # * +command+ when type is :cli, this is the name of the Rye::Box method that we're testing. Otherwise ignored. 
   # * +b+ is a block definition for the Tryout. See Tryout#from_block
   #
@@ -177,7 +186,7 @@ class Tryouts
     dtype ||= @dtype
     command ||= @command if dtype == :cli
     
-    raise "No drill type specified for #{name}." if dtype.nil?
+    raise NoDrillType, name if dtype.nil?
     
     to = find_tryout(name, dtype)
     if to.nil?
@@ -240,6 +249,7 @@ class Tryouts
     file_content = File.read(fpath)
     to = Tryouts.new
     begin
+      to.paths << fpath
       to.instance_eval file_content, fpath
       # After parsing the DSL, we'll know the group name.
       # If a Tryouts object already exists for that group
@@ -248,7 +258,6 @@ class Tryouts
         to = @@instances[to.group]
         to.instance_eval file_content, fpath
       end
-      to.paths << fpath
     rescue SyntaxError, LoadError, Exception, TypeError,
            RuntimeError, NoMethodError, NameError => ex
       to.errors << ex

data/tryouts/01_mixins_tryouts.rb

@@ -1,10 +1,7 @@
 
-library :tryouts, File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 group "Mixins"
 
-
-
 test_hash = { 
   :level1 => { 
     :level2 => {}, 
@@ -15,12 +12,12 @@ test_hash = {
 }
 
 
-tryouts "Hash" do
+tryouts "Hash", :api do
   setup do
     
   end
   
   drill "knows the deepest point", test_hash.deepest_point, 3
-  drill "has a last method", {}, :last, :respond_to?
+  drill "has a last method", {} #, :respond_to?, :last
 
 end

data/tryouts/10_syntax_tryouts.rb

@@ -1,17 +1,21 @@
 
 tryout "DSL Syntax", :api do
   
+  drill "can specify a dream inline", 3 do
+    12 / 4
+  end
+    
   dream 4770744
   drill "can specify dream above the drill" do
     4770744
   end
   
-  dream Array, :class
+  dream :class, Array
   drill "can pass based on output object class" do
     [1,2,3]
   end
   
-  dream NameError, :exception
+  dream :exception, NameError
   drill "can pass based on exception class" do
     bad_method_call
   end
@@ -22,19 +26,19 @@ tryout "DSL Syntax", :api do
   
   drill "inline true values will pass too", true
   drill "can specify inline return values", :food, :food
-  drill "can specify match format", 'mahir', /..hi./i, :match
+  drill "can specify match format", 'mahir', :match, /..hi./i
   
   dream "big"
-  dream String, :class
-  dream /\Ab.g\z/, :match
+  dream :class, String
+  dream :match, /\Ab.g\z/
   drill "can handle multiple dreams" do
     "big"
   end
   
-  drill "can specify gt (>) format", 2, 1, :gt
-  drill "can specify gte (>=) format", 2, 2, :gte
-  drill "can specify lt (<) format", 1, 2, :lt
-  drill "can specify lte (<=) format", 2, 2, :lte
+  drill "can specify gt (>) format", 2, :gt, 1
+  drill "can specify gte (>=) format", 2, :gte, 2 
+  drill "can specify lt (<) format", 1, :lt, 2
+  drill "can specify lte (<=) format", 2, :lte, 2
   
-  drill "can run arbitrary formats", [3,1,2], [1,2,3], :sort
+  drill "can run arbitrary formats", [3,1,2], :sort, [1,2,3]
 end

data/tryouts/50_class_context_tryouts.rb

@@ -8,7 +8,7 @@ tryout "Setting class variables", :api do
     @from_setup = true
   end
   
-  drill "can't access class var created in setup (1.9 only)", NameError, :exception do
+  drill "can't access class var created in setup (1.9 only)", :exception, NameError do
     @@from_setup
   end
   
@@ -25,6 +25,5 @@ tryout "Setting class variables", :api do
     @@from_drill.class.to_s
   end
   
-  dream /\w\d\w \d\w\d/, :match
-  drill "Knows where Santa Claus lives", 'H0H 0H0'
+  drill 'Small, fast, and furious', 'Muggsy Bogues', :match, /Mug+sy Bogu?es/
 end

data/tryouts.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "tryouts"
   s.rubyforge_project = "tryouts"
-	s.version = "0.7.1"
+	s.version = "0.7.2"
 	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"
@@ -24,9 +24,9 @@
   
   # = DEPENDENCIES =
   # Add all gem dependencies
-  s.add_dependency 'rye', '>= 0.8.2'
-  s.add_dependency 'drydock', '>= 0.6.6'
-  s.add_dependency 'sysinfo', '>= 0.5.1'
+  s.add_dependency 'rye'
+  s.add_dependency 'drydock'
+  s.add_dependency 'sysinfo'
   
   # = MANIFEST =
   # The complete list of files to be included in the release. When GitHub packages your gem, 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tryouts
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 -04:00
+date: 2009-06-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.2
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: drydock
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.6.6
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: sysinfo
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.1
+        version: "0"
     version: 
 description: Tryouts are high-level tests for your Ruby code. May all your dreams come true!
 email: tryouts@solutious.com