quarry 0.5.0 → 0.5.2

data/CHANGES

@@ -1,6 +1,35 @@
+== 0.5.2 / 2008-11-28
+
+* 21 Other Enhancements
+
+    * renamed specs with enumerations (#ab5cd7c746d934993dd54d72e9e217dd0777a7f5)
+    * better output on error output (#b1c56a4e7df4ca6e6b772a1f6b8e220dc4c812be)
+    * sort specs when documenting (#e587777eed633106fd075c4f1cee141e8fdd714c)
+    * bin/quarry, separated verbatim from verbose (#ea4fcf3539f98164ae18fd00136595ae9fc775b4)
+    * continued work on website (#eaaac37d2ece34145abae377b9fcae44025d08ab)
+    * fixed should grammar (#168fe5965911a442c7930006c6b8faf849c613fe)
+    * updated README (#32f237b10ef44c2e065fc45844201ac074199f03)
+    * added #p to monitor (#a42cc437348b4d62f26939bd357761612ed28487)
+    * work on tabular (#b6d3f4e687df4eedd29a4ae9871c67f35ee13b62)
+    * adjusted header css for website (#fa5037f70a830c6513121ab69bb81970ab4c869e)
+    * Merge: fa5037f... b6d3f4e...
+      Merge branch 'master' of gitosis@rubyforge.org:quarry (#381903a9f6523bcd466242810da88208f8296de9)
+    * work on table macros, improved markup parsing (#aa9e0b4f4a99a7ee0cb7313ed8593285919e6350)
+    * Merge: 381903a... aa9e0b4...
+      Merge branch 'master' of gitosis@rubyforge.org:quarry (#d12faecf82b46423234ea873d64d3a1a983be30e)
+    * made markup object reposible for running their own code (#85adcfac7fc7b901db27cce659f7a24d192bc7a1)
+    * made assert method compatible w/ old school (#5928ee8ad0bbc8178254b5043b09d64a5e09b070)
+    * moved sample spec's to demo/ (#759fd887741f892752ade8776a9c05c7fdbdc036)
+    * improved reporter for better tabular output (#8fdb7eb6c09b0cec16f333fca004594bea4eb162)
+    * prepare release of 0.5.1 (#eb342d8c2a66ec59d9aa1c9b6de76b6b9e9337fb)
+    * added TODO and some comments to reporter.rb (#a225aef3ac5947d4fcc5b77a4cb491b34a3fea55)
+    * markup now tracks before/after instead of runner (#42205099bbaa5b90f105741a0f7b05737426a058)
+    * --script mode now works (#1e9e5919b62da86db2c5c4a15a1ebdb59e75f5d3)
+
+
 == 0.5.0 / 2008-11-19
 
-* 12 Other Enhancements
+* 15 Other Enhancements
 
     * imporved quarry doc tool (#36ce74b4f694b984bc9addc22eb74d6ecbb503e5)
     * bin/quarry, added loadpath option (#6ba04ef83777d64192c9c62c9060d8fa37aad933)
@@ -14,6 +43,9 @@
     * clean-up some code (#35b47d0254ccaf7594d5c1db0c5a88021ff8a795)
     * bin/quarry, fixed references (#8c2b5094b5b647415dcbd31212b1270ca317e1ce)
     * fixed old Spec namespace and backtrace argument to Assertion (#6d6deaad38c3abb5dce164067970bee82412c93e)
+    * prep for 0.5.0 (#b4f808d65d766f91f04fa36b7ee3274b6868af3e)
+    * update spec.js (#f79443ef0bb4b84302c7104ff69e7ad18cfd7a1d)
+    * renamed ruby-xacto to quarry-extract (#9fe0dafcef9d73baef4b719687e3e908aeb7789a)
 
 
 == 0.4.0 / 2008-11-15

data/MANIFEST

@@ -1,54 +1,59 @@
+bin
+lib
+meta
 spec
-spec/complex.rd
-spec/mock.rd
-spec/basic.rd
-spec/stub.rd
 MANIFEST
 CHANGES
 RELEASE
+TODO
 README
-meta
-meta/created
-meta/homepage
-meta/summary
-meta/abstract
-meta/authors
-meta/requires
-lib
+VERSION
+COPYING
+bin/quarry
+bin/quarry-doc
+bin/quarry-extract
 lib/quarry
+lib/quarry.rb
 lib/quarry/probe.rb
 lib/quarry/document
-lib/quarry/document/template.rhtml
 lib/quarry/grammar.rb
 lib/quarry/config.rb
 lib/quarry/runner.rb
 lib/quarry/runner
-lib/quarry/runner/context.rb
 lib/quarry/stub.rb
 lib/quarry/mock.rb
 lib/quarry/extract.rb
 lib/quarry/markup.rb
 lib/quarry/reporter
-lib/quarry/reporter/verbatim.rb
-lib/quarry/reporter/dotprogress.rb
-lib/quarry/reporter/summary.rb
 lib/quarry/monitor.rb
 lib/quarry/reporter.rb
 lib/quarry/expectation.rb
 lib/quarry/document.rb
 lib/quarry/grammar
+lib/quarry/markup
+lib/quarry/assertion.rb
+lib/quarry/document/template.rhtml
+lib/quarry/runner/context.rb
+lib/quarry/reporter/verbatim.rb
+lib/quarry/reporter/dotprogress.rb
+lib/quarry/reporter/summary.rb
 lib/quarry/grammar/expect.rb
 lib/quarry/grammar/assert.rb
 lib/quarry/grammar/legacy
-lib/quarry/grammar/legacy/assert.rb
 lib/quarry/grammar/should.rb
-lib/quarry/markup
+lib/quarry/grammar/legacy/assert.rb
+lib/quarry/markup/macro.rb
 lib/quarry/markup/step.rb
-lib/quarry/assertion.rb
-lib/quarry.rb
-VERSION
-bin
-bin/ruby-xacto
-bin/quarry
-bin/quarry-doc
-COPYING
+lib/quarry/markup/before.rb
+lib/quarry/markup/header.rb
+lib/quarry/markup/after.rb
+lib/quarry/markup/table.rb
+lib/quarry/markup/comment.rb
+meta/created
+meta/homepage
+meta/summary
+meta/abstract
+meta/authors
+meta/requires
+spec/04_mock.rd
+spec/03_stub.rd

data/README

@@ -15,71 +15,77 @@ useful QA tools.
 
 === Specifications
 
-Quarry's BBD system is uniqe in a few ways. First it utilizes
-Ruby's Execption system to catch Assertions which are defined
-via assertion <i>functors</i>. Eg.
-
-    require 'quarry/assertion'
+Quarry's BDD/TDD system is uniqe in a few ways. First it utilizes
+Ruby's Execption system to catch Assertions which are defined via
+assertion <i>functors</i>. Eg.
 
     4.assert == 5
 
 Because 4 != 5, this expression will raise an Assertion exception.
-Quarry's Specification Runner class is thus just a means of
-running and capturing these assertions.
+Quarry's Specification Runner class is thus just a means of running
+and capturing these assertions.
+
+While we used TDD teminology in the above example, Quarry supports
+a range of momenclature to suit the preferences of TDD vs. BDD 
+developers. The abot could just as well been written as:
+
+  4.should == 5
+
+or 
+
+  4.expect == 5
+
+These are effecitvely the same. For the most part the different terms
+do exactly the same thing. Somtimes though they differ to conform with
+the TDD vs. BDD prespective they intend to support.
 
-Quarry's Specifications themselves are simple text files, a practice
+Quarry's Specifications themselves are simple text files --a practice
 of literal programming. 
 
     Example Specification
     =====================
+
     Shows that the number 5 does not equal 4.
 
-        5.assert! == 4
+        5.should! == 4
 
     But in fact equals 5.
 
-        5.assert == 5
-
-    QED.
+        5.should == 5
 
-If we run this specification in verbatim mode the output would identical
-(assuming we did not make a type and the assertions passed).
-If there were errors or assertion failures, we would see information
-detaling each.
+If we run this specification in verbatim mode the output would be identical
+(assuming we did not make a typo and the assertions passed). If there were
+errors or failures, we would see information detaling each.
 
-As you can see I used Markdown for my spcecification. You can use almost any
-format you like. The only neccesary distiction is that desciption text be
+As you can see, we used Markdown for this spcecification. Almost any
+format can be used. The only neccesary distinction is that desciption text be
 align to the left margin and all specification code be indented. Quarry also
-recognized headers, currently Markdown and RDoc style headers (We'll add
-Textile soon.)
+recognized headers, currently Markdown and RDoc style headers, which covers
+most markup foramts in common use today. While strictly speaking Qaurry
+does not need to recognize headers, it does improve console output a bit
+if it does.
 
-We'll leave discussion of the merits of this system to another place. But
-it should be clear that this approach if especcailly conveniant, allowing
-documentation and specification to seemlessly merge.
+Give this design some though. It should become clear that this approach if
+especially fruitful in that it allows documentation and specification to
+seemlessly merge.
 
 
-=== Stubs
+=== Stubs, Mocks and Spies
 
-Quarry provides a flexible stubbing facility.
+Quarry provides a flexible stubbing and mocking facility.
 
 For now see RDoc API.
 
-
-=== MethodProbe
-
-MethodProbe (aka the Duck Hunter) can dip-down into a method and
-provide a read-out how it functions --known as a <i>method signiture</i>.
-MethodProbe is somewhat expiremental becuase it is runtime bound, so proper
+The Spy/Probe (aka the Duck Hunter) can dip-down into a method and
+provide a read-out how it functions --known as a <i>method signature</i>.
+Probe is somewhat expiremental becuase it is runtime bound, so proper
 execution can not be 100% guarenteed.  It can miss some parts of a method
-due to conditional branching (a probe can;t pretend to be false) and,
+due to conditional branching (a probe can't pretend to be false) and,
 albiet rare, it can also get stuck in an infinite loop a la the
 Halting Problem. Even so, it can be used effectively under controlled
 situations if used with care.
 
 
-=== More to come ....
-
-
 == Copying
 
 Copyright (c) 2007, 2008 Tiger Ops / Thomas Sawyer

data/RELEASE

@@ -1,10 +1,11 @@
-This is the first offical release of the new Ruby Quarry. 
-Prepare to change the way you drive.
+This release improves the Markup class structure allowing for
+tabular steps and script output. 
 
 
-### 0.5.0 / 2008-11-19
+### 0.5.2 / 2008-11-28
 
-* Major Enhancements
+* 2 Major Enhancements
 
-    * Reorganized library files
+    * Markup tracks before and after macros.
+    * Script output using --script option.
 

data/TODO

@@ -0,0 +1,9 @@
+= TODO List
+
+* Reporting could still use some improvement. The idea
+  was to pass the Step object to the step report methods,
+  but this is a bit of a problem for tabular output, since
+  we don't wnat to print the same code over and over.
+  So right now it uses a Faux Step. Not sure that's the
+  best way to do it.
+

data/VERSION

@@ -1 +1 @@
-quarry 0.5.0 beta (2008-11-19)
+quarry 0.5.2 beta (2008-11-28)

data/bin/quarry

@@ -22,9 +22,11 @@ module Quarry
       @opts ||= GetoptLong.new(
         [ '--version',        GetoptLong::NO_ARGUMENT ],
         [ '--help',     '-h', GetoptLong::NO_ARGUMENT ],
-        [ '--debug',    '-d', GetoptLong::NO_ARGUMENT ],
-        [ '--verbose',  '-v', GetoptLong::NO_ARGUMENT ],
+        [ '--debug',    '-D', GetoptLong::NO_ARGUMENT ],
+        [ '--verbose',  '-V', GetoptLong::NO_ARGUMENT ],
+        [ '--verbatim', '-v', GetoptLong::NO_ARGUMENT ],
         [ '--summary',  '-s', GetoptLong::NO_ARGUMENT ],
+        [ '--script',         GetoptLong::NO_ARGUMENT ],
         [ '--loadpath', '-I', GetoptLong::REQUIRED_ARGUMENT ]
       )
     end
@@ -39,9 +41,13 @@ module Quarry
         when '--debug'
           $DEBUG = true
         when '--verbose'
-          @reporter = :verbose
+          $VERBOSE = true
+        when '--verbatim'
+          @reporter = :verbatim
         when '--summary'
           @reporter = :summary
+        when '--script'
+          @reporter = :script  # psuedo-reporter
         when '--loadpath'
           arg.split(/[:;]/).each{|dir| $LOAD_PATH.unshift(dir)}
         end
@@ -83,7 +89,7 @@ module Quarry
     #
     def output
       case reporter
-      when :verbose
+      when :verbatim
         Quarry::Reporter::Verbatim.new
       when :summary
         Quarry::Reporter::Summary.new
@@ -100,18 +106,26 @@ module Quarry
     def execute
       parse_options
       load_rc
-      runner.check
+      case reporter
+      when :script
+        specs.each do |spec|
+          puts spec.to_script
+        end
+      else
+        runner.check
+      end
     end
 
     HELP = <<-END
-quarry [--options] [specs...]
+quarry [--options] [spec/tests...]
 
 Options:
--v --verbose
--s --summary
-
--h --help
-   --version
+-v --verbatim   use verbatim reporter
+-s --summary    use summary reporter
+-V --verbose    extra verbose output
+-D --debug      spec/tests will exit on error
+-h --help       show this help information
+   --version    show quarry version
     END
 
   end

data/lib/quarry/assertion.rb

@@ -12,11 +12,7 @@ module Quarry
     end
 
     def to_str
-      msg = message
-      msg = msg.to_s unless String === msg
-      #msg += '.' unless msg.empty?
-      #msg += "\n#{default}."
-      msg.strip
+      message.to_s.strip
     end
 
   end

data/lib/quarry/document.rb

@@ -42,12 +42,12 @@ module Quarry
 
     # Generate specification document.
     def generate
+      text  = ''
       files = []
       paths.each do |path|
         files.concat(Dir.glob(path).select{ |f| File.file?(f) })
       end
-
-      text = ''
+      files.sort!
       files.each do |file|
         puts file unless quiet?
         case ext = File.extname(file)

data/lib/quarry/grammar/assert.rb

@@ -13,8 +13,13 @@ module Quarry
       #
       #   4.assert == 3
       #
-      def assert
-        return Expectation.new(self, :backtrace=>caller)
+      def assert(test=nil, msg=nil)
+        if test
+          msg = "failed assertion (no message given)" unless msg
+          raise Assertion.new(msg, caller) unless test
+        else
+          return Expectation.new(self, :backtrace=>caller)
+        end
       end
 
       # Assert not an operational relationship.
@@ -26,8 +31,13 @@ module Quarry
       # if Ruby would allow +!=+ to be define as a method,
       # or at least +!+ as a unary method.
       #
-      def assert!
-        return Expectation.new(self, :negate=>true, :backtrace=>caller)
+      def assert!(test=nil, msg=nil)
+        if test
+          msg = "failed assertion (no message given)" unless msg
+          raise Assertion.new(msg, caller) if test
+        else
+          return Expectation.new(self, :negate=>true, :backtrace=>caller)
+        end
       end
 
       # Same as #assert!.

data/lib/quarry/grammar/legacy/assert.rb

@@ -16,16 +16,26 @@ module Quarry
       #
       module Assertions
 
+        # Private method upon which all of the legacy assertions are based
+        # (except for #assert itself).
+        #
+        def __assert__(test, msg=nil)
+          msg = "failed assertion (no message given)" unless msg
+          raise Assertion.new(msg, caller[1..-1]) unless test
+        end
+
+        private :__assert__
+
         # The assertion upon which all other assertions are based.
         #
         #   assert [1, 2].include?(5)
         #
         def assert(test=nil, msg=nil)
           if test
-            msg = "failed assertion (no message given)") unless msg
-            raise Excpectation.new(:message=>msg) unless test
+            msg = "failed assertion (no message given)" unless msg
+            raise Assertion.new(msg, caller) unless test
           else
-            Expectation.new(:delegate=>self)
+            Expectation.new(self, :backtrace=>caller)
           end
         end
 
@@ -38,7 +48,7 @@ module Quarry
         def assert_block(msg=nil) # :yields: 
           test = ! yield
           msg = "assertion failed" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if expected == +actual.
@@ -52,7 +62,7 @@ module Quarry
         def assert_equal(exp, act, msg=nil)
           test = (exp == act)
           msg  = "Expected #{act.inspect} to be equal to #{exp.inspect}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if expected_float and actual_float are equal within delta tolerance.
@@ -62,7 +72,7 @@ module Quarry
         def assert_in_delta(exp, act, delta, msg=nil)
           test = (exp.to_f - act.to_f).abs <= delta.to_f
           msg  = "Expected #{exp} to be within #{delta} of #{act}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if object .instance_of? klass
@@ -72,7 +82,7 @@ module Quarry
         def assert_instance_of(cls, obj, msg=nil)
           test = (cls === obj)
           msg  = "Expected #{obj} to be a #{cls}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if object .kind_of? klass
@@ -82,7 +92,7 @@ module Quarry
         def assert_kind_of(cls, obj, msg=nil)
           test = obj.kind_of?(cls)
           msg  = "Expected #{obj.inspect} to be a kind of #{cls}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if string =~ pattern.
@@ -92,7 +102,7 @@ module Quarry
         def assert_match(exp, act, msg=nil)
           test = (act =~ exp)
           msg  = "Expected #{act.inspect} to match #{exp.inspect}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if object is nil.
@@ -102,7 +112,7 @@ module Quarry
         def assert_nil(obj, msg=nil)
           test = obj.nil?
           msg  = "Expected #{obj.inspect} to be nil" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if regexp !~ string
@@ -112,7 +122,7 @@ module Quarry
         def assert_no_match(exp, act, msg=nil)
           test = (act !~ exp)
           msg  = "Expected #{act.inspect} to match #{exp.inspect}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if expected != actual
@@ -122,7 +132,7 @@ module Quarry
         def assert_not_equal(exp, act, msg=nil)
           test = (exp != act)
           msg  = "Expected #{act.inspect} to not be equal to #{exp.inspect}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if ! object .nil?
@@ -132,7 +142,7 @@ module Quarry
         def assert_not_nil(obj, msg=nil)
           test = ! obj.nil?
           msg  = "Expected #{obj.inspect} to not be nil" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if ! actual .equal? expected
@@ -142,7 +152,7 @@ module Quarry
         def assert_not_same(exp, act, msg=nil)
           test = ! exp.equal?(act)
           msg  = "Expected #{act.inspect} to not be the same as #{exp.inspect}" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Compares the +object1+ with +object2+ using operator.
@@ -154,7 +164,7 @@ module Quarry
         def assert_operator(o1, op, o2, msg="")
           test = o1.__send__(op, o2)
           msg = "Expected #{o1}.#{op}(#{o2}) to be true" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if the block raises one of the given exceptions.
@@ -168,14 +178,15 @@ module Quarry
           begin
             yield
             msg = "Expected #{exp} to be raised" unless msg
-            assert false, msg
+            __assert__(false, msg)
           rescue Exception => e
             test = (exp === e)
             msg  = "Expected #{exp} to be raised, but got #{e.class}" unless msg
-            assert test, msg
+            __assert__(test, msg)
             return e
           end
         end
+
         alias_method :assert_raise, :assert_raises
 
         # Provides a way to assert that a procedure
@@ -201,7 +212,7 @@ module Quarry
           #flip = (Symbol === obj) && ! (Symbol === meth) # HACK for specs
           #obj, meth = meth, obj if flip
           test = obj.respond_to?(meth)
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if +actual+ .equal? +expected+ (i.e. they are the same instance).
@@ -212,7 +223,7 @@ module Quarry
         def assert_same(exp, act, msg=nil)
           msg  = "Expected #{act.inspect} to be the same as #{exp.inspect}" unless msg
           test = exp.equal?(act)
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if the method send returns a true value.
@@ -230,7 +241,7 @@ module Quarry
           r, m, *args = *send_array
           test = r.__send__(m, *args)
           msg  = "Expected #{r}.#{m}(*#{args.inspect}) to return true" unless msg
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Passes if the block throws expected_symbol
@@ -252,7 +263,7 @@ module Quarry
             end
             test = false
           end
-          assert(test, msg)
+          __assert__(test, msg)
         end
 
         # Flunk always fails.
@@ -260,7 +271,7 @@ module Quarry
         #   flunk 'Not done testing yet.'
         #
         def flunk(msg=nil)
-          assert(false, msg)
+          __assert__(false, msg)
         end
 
       end #module Assertions