tryouts 0.8.8 → 2.0.0

data/.gitignore

@@ -0,0 +1 @@
+*.gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Solutious Inc, Delano Mandelbaum
+Copyright (c) 2010 Solutious Inc, Delano Mandelbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -1,257 +1,93 @@
-= Tryouts - v0.8 BETA
+= Tryouts v2.0 ALPHA
 
-Tryouts is a high-level testing library (DSL) for your Ruby codes and command-line applications.
+<i>Put your Ruby tests in comments.</i>
 
-A tryout is made up of one of more drills. The return value of the drill block is compared to the expectations defined by one or more dreams. The goal is to achieve your dreams. 
+<b>NOTE: Tryouts syntax changed 0.x. The old version is still available in the 0.8-FINAL branch.</b>
 
-=== Terminology
 
-* Tryout: a set of drills (think: basketball tryouts)
-* Drill: a single test. 
-* 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
-
-Via Rubygems, one of:
-
-    $ gem install tryouts
-    $ gem install delano-tryouts
-
-or via download:
-* tryouts-latest.tar.gz[http://github.com/delano/tryouts/tarball/latest]
-* tryouts-latest.zip[http://github.com/delano/tryouts/zipball/latest]
-
-
-== Writing Tests
-
-The examples below are a complete overview of Tryouts syntax. 
-
-=== Testing Ruby Codes (:api)
-
-    library :gibbler, "../path/to/gibbler/lib"
-
-    tryouts "Common Usage", :api do
-
-      # Define variables available only within
-      # in the current tryout definition.
-      set :local_variable, 3
-      
-      setup do
-        # do stuff before all drills
-      end
-      
-      clean do 
-        # do stuff after all drills
-      end
-      
-      # This drill block should return 3.
-      drill "Maths R Us", local_variable do
-        12 / 4
-      end
-
-      # You can specify a method to execute
-      # on the return value of the drill block.
-      drill "We want a symbol", :class, Symbol do
-        Class.methods.first
-      end
-
-      # Dreams can also be specified explicitly which is
-      # important b/c it's possible to specify multiple.
-      dream :class, Array
-      dream ['b', 'c', 'd']
-      drill "Should return a list of 3" do
-        letters = 'a'..'z'
-        letters.to_a[1..local_variable]
-      end
-
-      # Drills can pass based on an exception too.
-      dream :exception, NameError
-      drill "Something failed" do
-        raise NameError
-      end
-
-      # We can even put simple drills on a single line.
-      drill 'Small, fast, and furious', 'Muggsy Bogues', :match, /Mug+sy Bogu?es/
-
-    end
-
-
-=== Testing Command-Line Applications (:cli)
-
-You can execute drills on command-line applications. 
+== Basic syntax
     
-    command :rudy, "path/2/rudy"
+    ## A very simple test
+      1 + 1
+    #=> 2
+
+    ## The test description can spread
+    ## across multiple lines. The same
+    ## is true for test definitions.
+      a = 'foo' 
+      b = 'bar'
+      a + b
+    #=> 'foobar'
+
+    ## A test will pass when its return
+    ## value equals the expectation. 
+      'foo'.class
+    #=> String
+
+    ## The expectations are evaluated.
+      1 + 1
+    #=> 1 + 1
     
-    tryouts "Rudy CLI", :cli do
-      
-      # We have specified the name of the command above so 
-      # we only need to specify the arguments in the drill.
-      # $ rudy myaddress -e
-      drill "can display my IP addresses", :myaddress, :e
-      
-      # The drill returns an Array of lines from STDOUT so
-      # we can use Array#grep to check the command output.
-      # If any lines match, this test will pass.
-      dream :grep, /No machines running/
-      drill "can call with no arguments"
-      
-      # Drills can also be defined with a block which gets
-      # executed via Rye::Box#batch. Methods in the block
-      # are executed as commands. The return value of the
-      # block is considered the test output. 
-      dream :match, /\d+\.\d+\.\d+\.\d+/
-      drill "can execute a block of commands" do
-        ret = rudy :q, :myaddress, :e
-        ret.first
+    ## Here's an example of testing errors
+      begin
+        raise RuntimeError
+      rescue RuntimeError
+        :success
       end
-      
-    end
-
-=== Running Performance Benchmarks (:benchmark)
-
-You can also use Tryouts to run benchmarks. The tryouts method takes a second parameter which specifies which drill sergeant to use. Below we specify <tt>:benchmark</tt> so each drill is timed and executed multiple times.
+    #=> :success
 
-   tryouts "Benchmark examples", :benchmark do
-     
-     # We create an Array and store it in a class
-     # variable so it's available to other drills.
-     drill "Create test array" do
-       @@array = (1..100000).map { rand }
-     end
-     
-     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", :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 :sdev, 0.1, 15    
-     drill("Array sort") { @@array.dup.sort }
-      
-   end
+For real world examples, see the Gibbler[github.com/delano/gibbler/tree/master/try/] tryouts.
 
-The drill blocks in a benchmark Tryout return Tryouts::Stats objects. See: Tryouts::Drill::Sergeant::Benchmark
+== Setup / Cleanup
 
-== 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
+All code before the first test definition is assumed to be setup code. All code after the last definition is assumed to be cleanup code. Here is an example:
+  
     
-    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
+    # This is called after all tests
+    require 'gibbler'
+    Gibbler.digest_type = Digest::SHA256
     
-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
+    ## A Symbol can gibbler
+      :anything.gibbler
+    #=> '754f87ca720ec256633a286d9270d68478850b2abd7b0ae65021cb769ae70c08'
     
-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
-
-=== :api Tryouts
-
-http://delano.github.com/tryouts/screens/tryouts-0.8-api.png
-
-<i>from gibbler[http://github.com/delano/gibbler/blob/master/tryouts/10_basic_tryouts.rb]</i>
-
-
-=== :cli Tryouts (verbose)
-
-http://delano.github.com/tryouts/screens/tryouts-0.8-cli.png
-
-<i>from tryouts[http://github.com/delano/tryouts/blob/master/tryouts/20_cli_tryouts.rb]</i>
-
-
-=== :benchmark Tryouts (verbose)
-
-http://delano.github.com/tryouts/screens/tryouts-0.8-benchmark.png
-
-<i>from gibbler[http://github.com/delano/gibbler/blob/master/tryouts/80_performance_tryouts.rb]</i>
-
-== News
-
-=== 2009-07-20: New DSL keyword "set"
-
-The "set" keyword has been introduced in 0.8.4 for defining variables available only to the Tryout definition they were declared in. See Example 1. 
-
-=== 2009-07-01: Drills for command-line applications
-
-Support for testing command-line applications has been re-introduced in 0.8. See example code further down in this README. 
-
-
-
-== BETA Notice
-
-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
+    # This will be called after all tests
+    Gibbler.digest_type = Digest::SHA1
+    
+    
+== Running Tests
 
-Tryouts does some funky stuff to make it simple to write tests. This "funky stuff" means that this library is <em>not thread-safe at definition-time</em>. However, once all tryouts files are parsed (or in OO-syntax, once all objects are created), this class should be <em>thread-safe at drill-time</em>. 
+Try ships with a command-line tool called <tt>try</tt>. When called with no arguments, it will look for files ending with _try.rb in the current directory, or in the subfolder try.
 
+http://delano.github.com/tryouts/screens/tryouts-2.0-success.png
+    
+You can also supply a specific file to test.
 
-== More Info
+    $ try path/2/test.rb
 
-* Check out the sourcecodes[http://github.com/delano/tryouts]
-* Read the rdocs[http://tryouts.rubyforge.org/]
-* About Solutious[http://solutious.com/about/]
-* Inspiration[http://www.youtube.com/watch?v=iB9nhyosDVs]
+If all tests pass, try exits with a 0. Otherwise it exits with the number of tests that failed. 
 
+http://delano.github.com/tryouts/screens/tryouts-2.0-failure.png
 
-== Thanks
+== Installation
 
-* Everyone at Utrecht.rb and Amsterdam.rb for putting up with my Ruby questions :]
-* Sam Aaron (http://sam.aaron.name) for the early feedback. 
-* Kalin Harvey for the encouragement.
+One of:
 
+    $ gem install tryouts
+    
+    
 
 == Credits
 
-* Delano (@solutious.com)
+* delano[http://github.com/delano]
 
+With help from:
 
-== Related Projects
+* cloudhead[http://github.com/cloudhead]
+* mynyml[http://github.com/mynyml]
 
-* Context[http://github.com/jeremymcanally/context/tree/master]
-* Testy[http://github.com/ahoward/testy/tree/master]
-* Expectations[http://expectations.rubyforge.org/]
-* Zebra[http://github.com/giraffesoft/zebra/tree/master]
+== Thanks
 
-== License
+* Syntenic[http://syntenic.com/] for the hackfest venue. 
 
-See: LICENSE.txt
+<i>This collision was brought to you by Montreal.rb.</i>

data/Rakefile

@@ -1,85 +1,62 @@
-require 'rubygems'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'fileutils'
-include FileUtils
+require "rubygems"
+require "rake"
+require "rake/clean"
+require 'yaml'
 
 begin
   require 'hanna/rdoctask'
 rescue LoadError
   require 'rake/rdoctask'
 end
-
-task :default => :package
  
-# CONFIG =============================================================
-
-# Change the following according to your needs
-README = "README.rdoc"
-CHANGES = "CHANGES.txt"
-LICENSE = "LICENSE.txt"
-
-# Files and directories to be deleted when you run "rake clean"
-CLEAN.include [ 'pkg', '*.gem', '.config', 'doc']
-
-# Virginia assumes your project and gemspec have the same name
-name = (Dir.glob('*.gemspec') || ['tryouts']).first.split('.').first
-load "#{name}.gemspec"
-version = @spec.version
-
-# That's it! The following defaults should allow you to get started
-# on other things. 
-
-
-# TESTS/SPECS =========================================================
-
-
-
-# INSTALL =============================================================
+config = YAML.load_file("VERSION.yml")
+task :default => ["build"]
+CLEAN.include [ 'pkg', 'doc' ]
+name = "stella"
 
-Rake::GemPackageTask.new(@spec) do |p|
-  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
+    gem.name = "tryouts"
+    gem.rubyforge_project = gem.name
+    gem.summary = "Put your Ruby tests in comments."
+    gem.description = gem.summary
+    gem.email = "delano@solutious.com"
+    gem.homepage = "http://github.com/delano/tryouts"
+    gem.authors = ["Delano Mandelbaum"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-task :release => [ :rdoc, :package ]
-task :install => [ :rdoc, :package ] do
-	sh %{sudo gem install pkg/#{name}-#{version}.gem}
-end
-task :uninstall => [ :clean ] do
-	sh %{sudo gem uninstall #{name}}
+
+Rake::RDocTask.new do |rdoc|
+  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}.#{config[:BUILD]}"
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "stella #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("LICENSE.txt")
+  rdoc.rdoc_files.include("bin/*.rb")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 
-# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
+# Rubyforge Release / Publish Tasks ==================================
 
-if @spec.rubyforge_project
-  desc 'Publish website to rubyforge'
-  task 'publish:rdoc' => 'doc/index.html' do
-    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
-  end
+#about 'Publish website to rubyforge'
+task 'publish:rdoc' => 'doc/index.html' do
+  sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+end
 
-  desc 'Public release to rubyforge'
-  task 'publish:gem' => [:package] do |t|
-    sh <<-end
-      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
-      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
-    end
+#about 'Public release to rubyforge'
+task 'publish:gem' => [:package] do |t|
+  sh <<-end
+    rubyforge add_release -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+    rubyforge add_file -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
   end
 end
 
 
 
-# RUBY DOCS TASK ==================================
-
-Rake::RDocTask.new do |t|
-	t.rdoc_dir = 'doc'
-	t.title    = @spec.summary
-	t.options << '--line-numbers' << '-A cattr_accessor=object'
-	t.options << '--charset' << 'utf-8'
-	t.rdoc_files.include(LICENSE)
-	t.rdoc_files.include(README)
-	t.rdoc_files.include(CHANGES)
-	t.rdoc_files.include('bin/sergeant')
-	t.rdoc_files.include('lib/**/*.rb')
-end
-

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:MAJOR: 2
+:MINOR: 0
+:PATCH: 0
+:BUILD: '001'

data/bin/try

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+
+# Put our local lib in first place
+BASE_PATH = File.expand_path File.join(File.dirname(__FILE__), '..')
+lib_dir = File.join(BASE_PATH, 'lib')
+$:.unshift lib_dir
+
+require 'tryouts'
+
+# Help out the requires in the tryouts
+[File.join(Dir.pwd, 'lib'), File.join(Dir.pwd, '..', 'lib')].each do |dir|
+  $:.unshift dir
+end
+
+if ARGV.empty?
+  paths = Dir.glob(File.join(Dir.pwd, '{try,tryouts}', '*_{try,tryouts}.rb'))
+  paths += Dir.glob(File.join(Dir.pwd, '*_{try,tryouts}.rb'))
+else
+  paths = ARGV
+end
+
+#Tryouts.debug = true
+#Tryouts.container = self
+
+exit Tryouts.run_all(*paths)
+