verify 0.3

data/LICENSE

@@ -0,0 +1,29 @@
+*
+* Lab419, The Ruby For 1.9 Labratory, or Labrador for 1.9
+* Subproject: Verify ( Mockify )
+* 
+* Distributed under the terms of the BSD License.
+* Copyright (c) 2007, 2008, 2009 Robert Dober
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the Labrador packahe nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY Robert Dober ``AS IS'' AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL Robert Dober BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,53 @@
+This is the very simple Verify mini test framework
+
+It emphasises on being able to check things out quickly without having to load a heavy test
+framework.
+It evolves around my needs but for the time being it is pretty lightweight.
+
+
+	require 'verify'
+
+	Verify "Some Important Facts" do
+	  verify "42 is true" do
+	    42
+	  end
+	  refute "42 is pretty big" do
+	    42 > 100_000
+	  end
+	  verify_exceptions NoMethodError do
+	    42.unrelinguished!
+	  end
+	end
+
+These forms are very easy to remember, but sometimes one needs to see where the
+errors, are, in order to achieve that one can use the parameter form
+
+	Verify "With parameters" do
+	  verify msg: "Everything is well", target: 42, actual: 21 * 2
+	  refute msg: "But not too much",   target: 42, actual: 41
+	end
+
+Mockify allows to capture stdout or simulate stdin, all you need to do is to
+require 'mockify' *before* requiring 'verify' and than you can provide stdin
+and get stdout
+
+	Verify "Providing stdin" do
+	  with_input %w{The Quick Brown Fox} do
+	    verify %{first line is "The"} do
+	      "The" == gets.chomp
+	    end
+	  end
+	end
+
+	Verify "Capturing stdout" do
+	  out = with_output do | o |
+	    puts 42
+	    verify target: "42\n", actual: o.string
+	  end
+	end
+	verify msg: "with_output converted out to an array of lines",
+	    actual: out.map( &:chomp ),
+	    target: %w{ 42 }
+	end
+
+Enjoy

data/RELEASE

@@ -0,0 +1,18 @@
+2009-06-18 Verify ( Mockify )
+-----------------------------
+
+Stripped away from Labrador/Lab419 as a standalone package, under the same license.
+Ruby1.9 only!
+
+*  Mockify became a with_input method, thus stdin and stdout can be mocked now.
+
+*  Verify: verify and refute support the explicit argument form now:
+   While the original call syntax still is supported and ecouraged to be used, it makes it
+   difficult to debug failing tests. The explicit paramter form prints the - optional -
+   descriptive message *and* the target and the actual value.
+
+*  Verify shorter output for Verify do ... end, while the whole resume remains vervose and
+   still indicates failure "graphically" in the last line.
+
+*  All modules were kept in the Lab419 module which remains the "logical" super project for
+   this.

data/lib/mockify.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# encoding: utf-8
+#
+#--
+#*
+#* Lab419, The Ruby For 1.9 Labratory, or Labrador for 1.9
+#* 
+#* Distributed under the terms of the BSD License.
+#* Copyright (c) 2007, 2008, 2009 Robert Dober
+#* All rights reserved.
+#*
+#* Redistribution and use in source and binary forms, with or without
+#* modification, are permitted provided that the following conditions are met:
+#*     * Redistributions of source code must retain the above copyright
+#*       notice, this list of conditions and the following disclaimer.
+#*     * Redistributions in binary form must reproduce the above copyright
+#*       notice, this list of conditions and the following disclaimer in the
+#*       documentation and/or other materials provided with the distribution.
+#*     * Neither the name of the Labrador packahe nor the
+#*       names of its contributors may be used to endorse or promote products
+#*       derived from this software without specific prior written permission.
+#*
+#* THIS SOFTWARE IS PROVIDED BY Robert Dober ``AS IS'' AND ANY
+#* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+#* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#* DISCLAIMED. IN NO EVENT SHALL Robert Dober BE LIABLE FOR ANY
+#* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+#* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+#* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+#* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+#++
+#
+# The Verify tool is a KISS verification and test tool, it is inspired by Ara T. Howard's testy.rb.
+# Ara however has still implemented a BDD framework, the purpose of Verify is to provide a Ruby Programmer
+# with a very simple yet effective tool to test her assumptions about code.
+#
+# Verify was motivated by the remark of Phlip who made an excellent point about assert. The Verify tool
+# tries to implement exactly that idea.
+# 
+# Verify has the following goals
+#
+#   * Almost nothing to learn, one wrapper method and three test methods
+#      # At the end a resume of the verifications with an error message for each failed verification
+#      # will be printed to stderr.
+#      Verify optional_message do
+#         # All verifications to be reported go here and can have one of the following forms
+#         verify optional_message, &blk
+#         # verify that blk[] returns a true value
+#         verify_not optional_message, &blk
+#         # verify that vlk[] does not return a true value
+#         verify_exceptions *exceptions, &blk
+#         # verify that one exception of the list passed to the method is raised by blk[]
+#      end
+#
+#
+#   * No metaprogramming, no at_exit hook, execution of the verification inside a wrapper object, no global namespace pollution,
+#     except the Verify method. 
+#
+#   * Very simple output
+require 'stringio'
+module Lab419
+  #
+  # Mockify has been created for Verify but can easily be used as a general
+  # purpose mocking technique for stdin and stdout.
+  # If you are not using Mockify with Verify you simply have to include the
+  # module yourself before calling #with_input and #with_output:
+  # E.g.
+  #
+  #    require 'mockify'
+  #    include Lab419::Mockify
+  #
+  module Mockify
+    AUTHOR="Robert Dober"
+    VERSION="0.3"
+
+    #
+    # The provided block will be executed in an environement in which stdin
+    # is a StringIO object,  created as a function of method parameter ary.
+    # 
+    # If ary is an IO object it will be used directly.
+    # If the ary parameter is a String  a StringIO object is constructed by
+    # passing ary to the constructor.
+    # If it is an Array, the array will be joined with newline before being
+    # fed to StringIO constructor.
+    # All other arguments will raise an ArgumentError!
+    #
+    def with_input ary, &blk
+      ary = case ary
+	    when String
+	      StringIO::new ary
+	    when Enumerable
+	      StringIO::new ary.to_a.join( "\n" )
+	    when IO
+	      ary
+	    else
+	      raise ArgumentError, "Cannot make an IO out of #{ary.inspect}"
+	    end
+
+      backup = $stdin
+      $stdin = ary
+      blk.call 
+    ensure
+      $stdin = backup
+    end
+
+    #
+    # The provided block will be executed in an environement  in which stdout is captured by
+    # a StringIO object. This is either a newly created StringIO object or a StringIO object
+    # provided as a parameter to with_output.  with_output will return the StringIO that has 
+    # been used, but it will also pass it to the block.  Therefore verifications can be made
+    # inside the block.
+    # The returned object is the StringIO object already converted to an array of lines, but
+    # the object passed into the block  is the StringIO object itself that still will change
+    # by each "writing" to stdout in the block.
+    # self.
+    #     e.g.
+    #     out = with_output do | o |
+    #       puts 42
+    #       verify target: "42\n", actual: o.string
+    #       puts
+    #     end
+    #     verify do [ "42", "" ] == out
+    #
+    def with_output ary=nil, &blk
+
+      ary ||= StringIO::new
+      raise ArgumentError, "output mocking objects must be stringio's" unless StringIO === ary
+
+      backup = $>
+      $> = ary
+      #instance_eval( &client )
+      blk[ ary ] 
+      ary.rewind
+      ary.each_line.to_a
+    ensure
+      $> = backup
+    end
+  end
+end

data/lib/verify.rb

@@ -0,0 +1,205 @@
+#!/usr/bin/ruby -w
+# encoding: utf-8
+#
+#--
+#*
+#* Lab419, The Ruby For 1.9 Labratory, or Labrador for 1.9
+#* 
+#* Distributed under the terms of the BSD License.
+#* Copyright (c) 2007, 2008, 2009 Robert Dober
+#* All rights reserved.
+#*
+#* Redistribution and use in source and binary forms, with or without
+#* modification, are permitted provided that the following conditions are met:
+#*     * Redistributions of source code must retain the above copyright
+#*       notice, this list of conditions and the following disclaimer.
+#*     * Redistributions in binary form must reproduce the above copyright
+#*       notice, this list of conditions and the following disclaimer in the
+#*       documentation and/or other materials provided with the distribution.
+#*     * Neither the name of the Labrador packahe nor the
+#*       names of its contributors may be used to endorse or promote products
+#*       derived from this software without specific prior written permission.
+#*
+#* THIS SOFTWARE IS PROVIDED BY Robert Dober ``AS IS'' AND ANY
+#* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+#* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#* DISCLAIMED. IN NO EVENT SHALL Robert Dober BE LIABLE FOR ANY
+#* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+#* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+#* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+#* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+#++
+#
+# The Verify tool is a KISS verification and test tool, it is inspired by Ara T. Howard's testy.rb.
+# Ara however has still implemented a BDD framework, the purpose of Verify is to provide a Ruby Programmer
+# with a very simple yet effective tool to test her assumptions about code.
+#
+# Verify was motivated by the remark of Phlip who made an excellent point about assert. The Verify tool
+# tries to implement exactly that idea.
+# 
+# Verify has the following goals
+#
+#   * Almost nothing to learn, one wrapper method and three test methods
+#      # At the end a resume of the verifications with an error message for each failed verification
+#      # will be printed to stderr.
+#      Verify optional_message do
+#         # All verifications to be reported go here and can have one of the following forms
+#         verify optional_message, &blk
+#         # verify that blk[] returns a true value
+#         verify_not optional_message, &blk
+#         # verify that vlk[] does not return a true value
+#         verify_exceptions *exceptions, &blk
+#         # verify that one exception of the list passed to the method is raised by blk[]
+#      end
+#
+#
+#   * No metaprogramming, no at_exit hook, execution of the verification inside a wrapper object, no global namespace pollution,
+#     except the Verify method. 
+#
+#   * Very simple output
+
+module Lab419
+  module Verify
+    VERSION = "0.3"
+    AUTHOR  = "Robert Dober"
+    URLS    = %w{http://labrador.rubyforge.org/verify}
+  end 
+end
+
+total_failed   = 0
+total_verified = 0
+report_stream  = $stderr
+
+optional_message = lambda do | msg |
+  msg ? "#{msg}: " : ""
+end
+
+percentage = lambda do | all, nok |
+  all.zero? ? "(***.**%)" :
+    "(%6.2f%%)" % ( 10_000 * ( all - nok ).to_f / all / 100 )
+end
+
+total_report = lambda do
+  report_stream << "\n"
+  resume = 
+    "+++  S u m m a r y: Verifications: #{total_verified+total_failed}, failed: #{total_failed}, succeeded: #{total_verified} #{percentage[ total_verified + total_failed, total_failed ]}  +++"
+    rchar = total_failed.zero? ? "=" : "*"
+    s = resume.size
+    report_stream << "+" * s
+    report_stream << "\n"
+    report_stream << "+++" << " " * ( s - 6 ) << "+++"
+    report_stream << "\n"
+    report_stream << ( resume << "\n" )
+    report_stream << "+++" << " " * ( s - 6 ) << "+++"
+    report_stream << "\n"
+    report_stream << ( rchar * resume.size.pred << "\n" )
+end
+
+include(  Module::new do
+  define_method :Verify do  |ver_msg=nil, ver_stream=nil, &ver_blk|
+  report_stream = ver_stream if ver_stream
+  messages = []
+  failed = 0
+  verified = 0
+
+  fail_verification = lambda do | level, msg |
+    p caller if $DEBUG
+  if level then
+    messages << "Error: #{msg} #{caller[level]}"
+  else
+    messages << "Error: #{msg}"
+  end
+  failed += 1 
+  total_failed += 1
+  end
+
+  report = lambda do | msg = nil, stream = $stderr |
+    #stream << "\n"
+    messages.map{ |m| m << "\n" }.each do | line |
+    stream << line
+    end
+
+  rchar = failed.zero? ? "=" : "*"
+  resume = 
+      "#{rchar}#{rchar} #{optional_message[ msg ]}Verifications: #{verified+failed}, failed: #{failed}, succeeded: #{verified} #{percentage[ verified + failed, failed ]}"
+      stream << ( resume << "\n" )
+      #stream << ( rchar * resume.size << "\n" )
+  end
+
+  succeed_verification = lambda do 
+    verified += 1
+    total_verified += 1
+  end
+
+  Module::new do
+
+    begin
+      extend Lab419::Mockify
+    rescue NameError
+      # Mockify has not been required by the user
+    end
+
+    define_method :verify do | msg=nil, &blk |
+      begin
+        if Hash === msg then
+          t = msg[ :target ]
+          a = msg[ :actual ]
+          msg = msg[ :message ] || msg[ :msg ]
+          return fail_verification [ 2, "#{msg}\n.. target: #{t.inspect}\n.. actual: #{a.inspect}\n.. #{msg} in " ] unless t==a
+          return succeed_verification[]
+        end
+        return fail_verification[ 2, "#{msg} in " ] unless blk[]
+        succeed_verification[]
+      rescue Exception => e
+        fail_verification[ nil, "#{msg} #{e.message} in #{e.backtrace.first}" ]
+      end
+    end
+
+    define_method :refute do | msg=nil, &blk |
+      begin
+        if Hash === msg then
+          t = msg[ :target ]
+          a = msg[ :actual ]
+          msg = msg[ :message ] || msg[ :msg ]
+          return fail_verification [ 2, "#{msg}\n.. target: #{t.inspect}\n.. actual: #{a.inspect}\n.. #{msg} in " ] if t==a
+          return succeed_verification[]
+        end
+        return fail_verification[ 2, "#{msg} in " ] if blk[]
+        succeed_verification[]
+      rescue Exception => e
+        fail_verification[ nil, "#{msg} #{e.message} in #{e.backtrace.first}" ]
+      end
+    end
+
+    define_method :verify_exceptions do | *excpts, &blk |
+      begin
+        blk[]
+        fail_verification[ 2, "None of #{excpts} thrown in " ]
+      rescue *excpts
+        succeed_verification[]
+      rescue Exception => e
+        fail_verification[ 3, "#{e} #{e.class} was thrown, but one of \"#{excpts}\" was expected in " ]
+      end
+    end
+
+    extend self
+    module_eval( &ver_blk )
+    report[ ver_msg, ver_stream || report_stream ]
+
+  end
+
+  end
+  end
+       )
+
+       at_exit do
+         at_exit do
+           at_exit do
+             total_report[]
+           end
+         end
+       end
+       # vim: sw=2 sts=2 ft=ruby nu expandtab: