riot 0.10.2 → 0.10.3

data/README.markdown

@@ -17,6 +17,7 @@ An extremely fast, expressive, and context-driven unit-testing framework. Protes
   - [Respond To](#examples-respond-to)
   - [Assigns](#examples-assigns)
   - [Nested contexts](#examples-nested)
+  - [Block expectations](#examples-block)
 - [OMG! Why did you write this](#omg)
 - [Running tests](#running)
 - [With Sinatra](#sinatra)
@@ -297,6 +298,18 @@ Oh yeah, Riot does those, too. The `setup` from each parent is "loaded" into the
       end
     end
 
+<a name="examples-block"></a>
+#### Example: Block expectations
+
+You can use a block to create the expected value for your assertion,
+which might come in useful if it takes a bit of work to generate your
+expected value.  My apologies for the incredibly contrived example as so:
+
+    context "block expectations" do
+      setup { 2 }
+      asserts_topic.equals { 1 + 1 }
+    end
+
 #### More examples/documentation
 
 There are many more basic assertion modifiers to come. See below for writing Riot extensions if you want to help out.

data/Rakefile

@@ -5,9 +5,10 @@ task :default => [:test]
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = false
+  test.libs    << 'test'
+  test.pattern =  'test/**/*_test.rb'
+  test.warning =  true
+  test.verbose =  false
 end
 
 desc "Run Flog against library (except tests)"
@@ -47,7 +48,7 @@ begin
     gem.email = "gus@gusg.us"
     gem.homepage = "http://github.com/thumblemonks/riot"
     gem.authors = ["Justin 'Gus' Knowlden"]
-    gem.add_dependency 'colorize'
+    gem.add_dependency 'term-ansicolor'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/TODO.markdown

@@ -4,6 +4,9 @@
   - Assertion 
     - scope
     - extensions (e.g. rack/test)
+  - Yard
+    - use yard to document the #assertion method used to define new assertions so the defined assertions will show up in the docs ( http://gnuu.org/2009/11/18/customizing-yard-templates/ )
+    
 - Assertion Macros
   - include/any/contains (array,hash, maybe string?)
     - perhaps able to take an enumerable and compare...

data/VERSION

@@ -1 +1 @@
-0.10.2
+0.10.3

data/lib/riot.rb

@@ -2,6 +2,7 @@ require 'riot/reporter'
 require 'riot/context'
 require 'riot/situation'
 require 'riot/runnable'
+require 'riot/assertion'
 require 'riot/assertion_macros'
 
 module Riot
@@ -19,14 +20,20 @@ module Riot
   end
 
   def self.silently!; @silent = true; end
-  def self.silently?; @silent == true; end
+  def self.silently?; defined?(@silent) && @silent == true end
+
+  def self.reporter=(reporter_class) @reporter_class = reporter_class; end
 
   def self.reporter
-    Riot.silently? ? Riot::SilentReporter : (@reporter_class || Riot::StoryReporter)
+    if Riot.silently?
+      Riot::SilentReporter
+    else
+      (defined?(@reporter_class) && @reporter_class) || Riot::StoryReporter
+    end
   end
-  def self.reporter=(reporter_class) @reporter_class = reporter_class; end
+
   # TODO: make this a flag that DotMatrix and Story respect and cause them to print errors/failures
-  def self.verbose; Riot.reporter = Riot::VerboseReporter; end
+  def self.verbose; Riot.reporter = Riot::VerboseStoryReporter; end
   def self.dots; Riot.reporter = Riot::DotMatrixReporter; end
 
   at_exit { run unless Riot.silently? }

data/lib/riot/assertion.rb

@@ -0,0 +1,45 @@
+module Riot
+  class Assertion < RunnableBlock
+  
+    def initialize(description, &definition)
+      super
+      @expectings, @expect_exception, @expectation_block = [], false, nil
+      @assertion_block = lambda do |actual|
+        actual ? Assertion.pass : Assertion.fail("Expected non-false but got #{actual.inspect} instead")
+      end
+    end
+
+    class << self
+      def pass() [:pass]; end
+      def fail(message) [:fail, message]; end
+      def error(e) [:error, e]; end
+      def assertions; @assertions ||= {}; end
+
+      # TODO: Make everyone switch to 1.8.7 or above so we can go mostly stateless again.
+      # Had to do this for 1.8.6 compatibility  {:() I'm a sad sock monkey
+      def assertion(name, expect_exception=false, &assertion_block)
+        assertions[name] = [expect_exception, assertion_block]
+        class_eval <<-EOC
+          def #{name}(*expectings, &expectation_block)
+            @expectings, @expectation_block = expectings, expectation_block
+            @expect_exception, @assertion_block = Assertion.assertions[#{name.inspect}]
+            self
+          end
+        EOC
+      end
+    end
+
+    def run(situation)
+      @expectings << situation.evaluate(&@expectation_block) if @expectation_block
+      process_macro(situation, @expect_exception) { |actual| @assertion_block.call(actual, *@expectings) }
+    end
+
+  private
+    def process_macro(situation, expect_exception)
+      actual = situation.evaluate(&definition)
+      yield(expect_exception ? nil : actual)
+    rescue Exception => e
+      expect_exception ? yield(e) : Assertion.error(e)
+    end
+  end # Assertion
+end # Riot

data/lib/riot/assertion_macros.rb

@@ -44,7 +44,8 @@ module Riot
     #   topic.assigns(:email, "foo@bar.baz")
     assertion(:assigns) do |actual, *expectings|
       variable, expected_value = expectings
-      actual_value = actual.instance_variable_get("@#{variable}")
+      variable_name            = "@#{variable}"
+      actual_value             = actual.instance_variable_defined?(variable_name) ? actual.instance_variable_get(variable_name) : nil
       if actual_value.nil?
         fail("expected @#{variable} to be assigned a value")
       elsif !expected_value.nil? && expected_value != actual_value

data/lib/riot/reporter.rb

@@ -28,17 +28,22 @@ module Riot
         error(description, result)
       end
     end
+
+    def new(*args, &block)
+      self
+    end
   end # Reporter
 
   class IOReporter < Reporter
+    attr_reader :writer
     def initialize(writer=nil)
       super()
       @writer = writer || STDOUT
     end
-    def say(message) @writer.puts(message); end
+    def say(message) writer.puts(message); end
 
     def results(time_taken)
-      values = [@passes, @failures, @errors, ("%0.6f" % time_taken)]
+      values = [passes, failures, errors, ("%0.6f" % time_taken)]
       say "\n%d passes, %d failures, %d errors in %s seconds" % values
     end
   end
@@ -50,7 +55,7 @@ module Riot
     def error(description, e) say "  ! " + "#{description}: #{e.message}".red; end
   end
 
-  class VerboseReporter < StoryReporter
+  class VerboseStoryReporter < StoryReporter
     def error(description, e)
       super(description, e)
       say "    #{e.class.name} occured".red
@@ -59,9 +64,9 @@ module Riot
   end
 
   class DotMatrixReporter < IOReporter
-    def pass(description); @writer.write ".".green; end
-    def fail(description, message); @writer.write "F".yellow; end
-    def error(description, e); @writer.write "E".red; end
+    def pass(description); writer.write ".".green; end
+    def fail(description, message); writer.write "F".yellow; end
+    def error(description, e); writer.write "E".red; end
     # TODO: Print the failures and errors at the end. Sorry :|
   end
 
@@ -73,12 +78,14 @@ module Riot
   end
 end # Riot
 
-begin
-  raise LoadError if ENV["TM_MODE"]
-  require 'rubygems'
-  require 'colorize'
-rescue LoadError
-  class ::String
+# Colorize strings
+class ::String
+  begin
+    raise LoadError if ENV["TM_MODE"]
+    require 'rubygems'
+    require 'term/ansicolor'
+    include Term::ANSIColor
+  rescue LoadError
     def green; self; end
     alias :red :green
     alias :yellow :green

data/lib/riot/runnable.rb

@@ -1,12 +1,11 @@
 module Riot
   class RunnableBlock
+    attr_reader :definition
     def initialize(description, &definition)
-      @description, @definition = description, definition || Proc.new { topic }
+      @description, @definition = description, definition || lambda { topic }
     end
 
-    def to_s
-      @description
-    end
+    def to_s; @description; end
   end # RunnableBlock
 
   class Setup < RunnableBlock
@@ -15,37 +14,8 @@ module Riot
     end
 
     def run(situation)
-      situation.setup(&@definition)
+      situation.setup(&definition)
       [:setup]
     end
   end # Setup
-
-  class Assertion < RunnableBlock
-    def self.pass() [:pass]; end
-    def self.fail(message) [:fail, message]; end
-    def self.error(e) [:error, e]; end
-
-    def run(situation)
-      process_macro(situation, false) do |actual|
-        actual ? Assertion.pass : Assertion.fail("Expected non-false but got #{actual.inspect} instead")
-      end
-    end
-
-    def self.assertion(name, expect_exception=false, &assertion_block)
-      define_method(name) do |*expectings, &expectation_block|
-        (class << self; self; end).send(:define_method, :run) do |situation|
-          expectings << situation.evaluate(&expectation_block) if expectation_block
-          process_macro(situation, expect_exception) { |actual| assertion_block.call(actual, *expectings) }
-        end # redefine run method when the assertion is called
-        self
-      end # define_method for assertion
-    end
-  private
-    def process_macro(situation, expect_exception)
-      actual = situation.evaluate(&@definition)
-      yield(expect_exception ? nil : actual)
-    rescue Exception => e
-      expect_exception ? yield(e) : Assertion.error(e)
-    end
-  end # Assertion
 end # Riot

data/riot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{riot}
-  s.version = "0.10.2"
+  s.version = "0.10.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin 'Gus' Knowlden"]
-  s.date = %q{2009-11-27}
+  s.date = %q{2009-12-02}
   s.description = %q{An extremely fast, expressive, and context-driven unit-testing framework. A replacement for all other testing frameworks. Protest the slow test.}
   s.email = %q{gus@gusg.us}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "TODO.markdown",
      "VERSION",
      "lib/riot.rb",
+     "lib/riot/assertion.rb",
      "lib/riot/assertion_macros.rb",
      "lib/riot/context.rb",
      "lib/riot/reporter.rb",
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
      "test/assertion_macros/respond_to_test.rb",
      "test/assertion_macros/same_elements_test.rb",
      "test/assertion_test.rb",
+     "test/benchmark/colorize.rb",
      "test/benchmark/riot_vs_minitest.rb",
      "test/benchmark/same_elements_vs_set.rb",
      "test/benchmark/simple_context_and_assertions.rb",
@@ -68,6 +70,7 @@ Gem::Specification.new do |s|
      "test/assertion_macros/respond_to_test.rb",
      "test/assertion_macros/same_elements_test.rb",
      "test/assertion_test.rb",
+     "test/benchmark/colorize.rb",
      "test/benchmark/riot_vs_minitest.rb",
      "test/benchmark/same_elements_vs_set.rb",
      "test/benchmark/simple_context_and_assertions.rb",
@@ -83,12 +86,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<colorize>, [">= 0"])
+      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
     else
-      s.add_dependency(%q<colorize>, [">= 0"])
+      s.add_dependency(%q<term-ansicolor>, [">= 0"])
     end
   else
-    s.add_dependency(%q<colorize>, [">= 0"])
+    s.add_dependency(%q<term-ansicolor>, [">= 0"])
   end
 end
 

data/test/assertion_macros/assigns_test.rb

@@ -3,7 +3,7 @@ require 'teststrap'
 context "An assigns assertion macro" do
   setup do
     item = Object.new
-    item.instance_eval { @foo = 1; @bar; @nil_val = nil }
+    item.instance_eval { @foo = 1; @nil_val = nil }
     Riot::Assertion.new("test") { item }
   end
 

data/test/assertion_test.rb

@@ -32,27 +32,33 @@ context "An assertion" do
     end
   end # that is erroring
 
-  context "with no block" do
+  context "with no block to provide the actual" do
     setup do
       @situation = Riot::Situation.new
       @situation.topic = "hello"
       Riot::Assertion.new("test")
     end
-    should("use block returning topic as default") do
+    should("uses block returning topic as default") do
       topic.equals("hello")
       result = topic.run(@situation)
     end.equals([:pass])
   end
-
+  
   context "with block expectation" do
     setup do
       @situation = Riot::Situation.new
       @situation.topic = "hello"
       Riot::Assertion.new("test")
     end
+
     should("use block returning topic as default") do
       topic.equals { "hello" }
       result = topic.run(@situation)
     end.equals([:pass])
+
+    asserts("block expectation has access to the situation items") do
+      topic.equals { @topic }
+      topic.run(@situation)
+    end.equals([:pass])
   end
 end # An assertion block

data/test/benchmark/colorize.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'benchmark'
+require 'colorize'
+require 'term/ansicolor'
+
+class MyString < String
+  include ::Term::ANSIColor
+end
+
+colorize = String.new
+term_ansicolor = MyString.new
+
+n = 50_000
+
+Benchmark.bmbm do |x|
+  x.report("colorize") do
+    n.times do
+      colorize.green
+      colorize.yellow
+      colorize.red
+    end
+  end
+  x.report("term-ansicolor") do
+    n.times do
+      term_ansicolor.green
+      term_ansicolor.yellow
+      term_ansicolor.red
+    end
+  end
+end
+
+# Rehearsal --------------------------------------------------
+# colorize         4.140000   0.160000   4.300000 (  4.375765)
+# term-ansicolor   0.720000   0.000000   0.720000 (  0.730665)
+# ----------------------------------------- total: 5.020000sec
+# 
+#                      user     system      total        real
+# colorize         4.070000   0.170000   4.240000 (  4.459804)
+# term-ansicolor   0.700000   0.000000   0.700000 (  0.728494)

data/test/benchmark/riot_vs_minitest.rb

@@ -1,4 +1,4 @@
-$:.concat ['./lib']
+$:.unshift(File.dirname(__FILE__)+"/../../lib")
 require 'benchmark'
 
 #

data/test/report_test.rb

@@ -41,6 +41,12 @@ context "A reporter" do
   asserts("description sent to #error") do
     topic.report("break it down", [:error, "error time"])
   end.equals("errored(break it down, error time)")
+
+  context "instance" do
+    setup { Riot::Reporter.new }
+
+    should("return self invoking new") { topic.new }.equals { topic }
+  end
 end # A reporter
 
 require 'stringio'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riot
 version: !ruby/object:Gem::Version 
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors: 
 - Justin 'Gus' Knowlden
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-27 00:00:00 -06:00
+date: 2009-12-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: colorize
+  name: term-ansicolor
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -38,6 +38,7 @@ files:
 - TODO.markdown
 - VERSION
 - lib/riot.rb
+- lib/riot/assertion.rb
 - lib/riot/assertion_macros.rb
 - lib/riot/context.rb
 - lib/riot/reporter.rb
@@ -56,6 +57,7 @@ files:
 - test/assertion_macros/respond_to_test.rb
 - test/assertion_macros/same_elements_test.rb
 - test/assertion_test.rb
+- test/benchmark/colorize.rb
 - test/benchmark/riot_vs_minitest.rb
 - test/benchmark/same_elements_vs_set.rb
 - test/benchmark/simple_context_and_assertions.rb
@@ -105,6 +107,7 @@ test_files:
 - test/assertion_macros/respond_to_test.rb
 - test/assertion_macros/same_elements_test.rb
 - test/assertion_test.rb
+- test/benchmark/colorize.rb
 - test/benchmark/riot_vs_minitest.rb
 - test/benchmark/same_elements_vs_set.rb
 - test/benchmark/simple_context_and_assertions.rb