qed 2.6.3 → 2.7.0

data/{spec → qed}/02_advice.rdoc

@@ -5,7 +5,7 @@ They are used to keep demonstrations clean of extraneous,
 repetitive and merely adminstrative code that the reader does
 not need to see over and over.
 
-Typically you will want to put advice definitions is applique
+Typically you will want to put advice definitions in applique
 files, rather then place them directly in the demonstration
 document, but you can do so, as you will see in this document.
 
@@ -98,13 +98,13 @@ to be run when the event is triggered.
 
   x = []
 
-  When(:text) do |section|
+  When(:step) do |section|
     section.text.scan(/^\*(.*?)$/) do |m|
       x << $1.strip
     end
   end
 
-Not let see if it worked.
+Now let's see if it worked.
 
 * SampleA
 * SampleB
@@ -119,6 +119,17 @@ So +x+ should now contain these three list samples.
 QED also supports comment match triggers. With the +When+ method one can
 define procedures to run when a given pattern matches comment text.
 
+    When 'given the facts' do
+      @facts = "this is truth"
+    end
+
+Then whenever the words, 'given the facts' appear in step description
+the `@facts` varaible will be set.
+
+    @facts.assert == "this is truth"
+
+Pattern matchers reall shine when we also add captures to the mix.
+
     When 'given a setting @a equal to (((\d+)))' do |n|
       @a = n.to_i
     end
@@ -140,12 +151,12 @@ so any number can be used. For example, "given a setting @a equal to 2".
 When clauses can also use consecutive pattern matching. For instance
 we could write,
 
-  When 'first match #(((\d+)))', 'then match #(((\d+)))' do |i1, i2|
-    @a = [i1.to_i, i2.to_i]
-  end
+    When 'first match #(((\d+)))', 'then match #(((\d+)))' do |i1, i2|
+      @a = [i1.to_i, i2.to_i]
+    end
 
 So that 'first match #1' will be looked for first, and only after
-that if 'then match #2' is found, will it be condiered a complete match.
+that if 'then match #2' is found, will it be considered a complete match.
 All regular expression slots are collected from all matches and passed to
 the block. We can see that the rule matched this very paragraph.
 

data/qed/03_helpers.rdoc

@@ -0,0 +1,44 @@
+= Helpers
+
+There are two ways to load advice scripts. Manually loaded
+helpers act per demonstrandum and apply only to the currently
+executing demo. Automaticly loaded helpers apply to all 
+demonstrandum within their preview.
+
+Helper scripts can be written just like demonstration scripts,
+or they can be defined as pure Ruby scripts.
+
+== Automatic Helpers
+
+Automatic helpers, known as the "applique" are loaded at the
+start of a session and apply equally to all demonstrandum within
+the same or lower directory as teh demo. These helpers are placed
+in an +applique+ subdirectory. For instance this document uses,
+{applique/env.rb}[applique/env.rb].
+
+== Manual Helpers
+
+Manual helpers are loaded per-demonstration by using specially
+marked links.
+
+For example, because this link, Advice[qed://helpers/advice.rb],
+begins with +qed:+, it will be used to load a helper. We can 
+see this with the following assertion.
+
+  pudding.assert.include?('loaded advice.rb')
+
+No where in the demonstration have we defined +pudding+, but
+it has been defined for us in the advice.rb helper script.
+
+We can also see that the generic When clause in our advice
+helper is keeping count of decriptive paragraphs. Since the
+helper script was loaded two paragraphs back, the next count
+will be 3.
+
+  count.assert == 3
+
+Helpers are vital to building test-demonstration suites for
+applications. But here again, only use them as necessary.
+The more helpers you use the more difficult your demos will
+be to follow.
+

data/{spec → qed}/04_samples.rdoc

@@ -6,12 +6,12 @@ When creating testable demonstrations, there are times when sizable
 chunks of data are needed. It is convenient to store such data in
 separate files. The +Data+ method makes is easy to utilize them.
 
-    Data('qed/samples/data.txt').assert =~ /dolor/
+    Data(File.dirname(__FILE__) + '/samples/data.txt').assert =~ /dolor/
 
 The +Data+ method can also take a block which passes the data
-as the block's only argument.
+as the blocks only argument.
 
-    Data('qed/samples/data.txt') do |data|
+    Data(File.dirname(__FILE__) + '/samples/data.txt') do |data|
       data.assert =~ /dolor/
     end
 
@@ -32,7 +32,7 @@ the coded step. Consider the following example.
 Every row in the {table.yml table}[table.yml] will be assigned to
 the block parameters and run through the subsequent assertion.
 
-    Table 'qed/samples/table.yml' do |x, y|
+    Table File.dirname(__FILE__) + '/samples/table.yml' do |x, y|
       x.upcase.assert == y
     end
 

data/{spec → qed}/05_quote.rdoc

@@ -5,15 +5,15 @@ Sometimes it would more useful to treat them a plain text to
 which the preceeding paragraph can make use in a processing rule.
 
 For example let say we want to make an example out of the following
-text...
+text:
 
   The file will contain
 
   this text
 
-The use of the ellipsis ('...') tells the processor that the next
+The use of the colon (`:`) tells the processor that the next
 segment is a plain text continuation of the current segment, rather
-than example code. If the next segment is varbatim it will be added to
+than executable code. If the next segment is varbatim it will be added to
 the end of the arguments list of any applicable processing rule.
 
 Behind the scenes we created a rule to set the text to an instance

data/{spec → qed}/10_constant_lookup.rdoc

@@ -1,13 +1,13 @@
 = Missing Constant
 
 If a constant is missing it is because it was not found
-in either the demos scope, the applique or the toplevel.
+in either the demos scope, the applique or at the toplevel.
 
   begin
     UnknownConstant
   rescue => err
     # no colon means toplevel
-    /[^:]UnknownConstant/ =~ err.message
+    err.name.to_s.refute.include?('::')
   end
 
 A constant defined in the applique is visible.

data/qed/11_embedded_rules.rdoc

@@ -0,0 +1,46 @@
+= Meta Code
+
+All code steps are evaluated in a rescue clause. If an error occurs, it
+is captured and reported through the test report, and execution continues.
+However, sometimes this is not desired. To evaluate a step without the 
+rescue clause, and effective *fail fast*, append `^` mark to the end of
+the desription text, like so. ^
+
+  When 'this is cool' do |text|
+    @text = text
+  end
+
+Now, let's try it by saying, "this is cool":
+
+  And this is the text.
+
+Did it work?
+
+  @text.assert == "And this is the text."
+
+
+== Match Separator
+
+The `When` method can take a list of String or Regexp as arguments.
+If any of the strings contain `...`, the string will be split into
+two at this point, which effective means that any text can occur
+within this space. It behaves much like adding `((*.?))`, but parses
+more quickly by dividing the string into multiple matches.
+
+  When 'Let /(\w+)/ be ... scared of /(\w+)/' do |name, monster|
+    @name    = name
+    @monster = monster
+  end
+
+Okay let's try it: Let John be very scared of Zombies.
+
+So now what is the name?
+
+  @name.assert == "John"
+
+What is the monster?
+
+  @monster.assert == "Zombies"
+
+Did it work?
+

data/{spec → qed}/helpers/advice.rb

@@ -1,16 +1,15 @@
-# This helper is used to demonstrate
-# the use of advice --before, after
+# This helper is used to demonstrate the use of advice --before, after
 # and when clauses.
 
 count   = 0
 pudding = []
 
-When(:load) do
-  pudding << "load #{File.basename(__FILE__)}"
-end
+#Before(:import) do
+#  pudding << "load #{File.basename(__FILE__)}"
+#end
 
-When(:unload) do
-  pudding << "unload #{File.basename(__FILE__)}"
+After(:import) do
+  pudding << "loaded #{File.basename(__FILE__)}"
 end
 
 #Before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qed
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000 Z
+date: 2011-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &34514420 !ruby/object:Gem::Requirement
+  requirement: &70171077943540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *34514420
+  version_requirements: *70171077943540
 - !ruby/object:Gem::Dependency
   name: facets
-  requirement: &34513660 !ruby/object:Gem::Requirement
+  requirement: &70171077942820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *34513660
+  version_requirements: *70171077942820
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &34513060 !ruby/object:Gem::Requirement
+  requirement: &70171077942200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '1.7'
   type: :runtime
   prerelease: false
-  version_requirements: *34513060
+  version_requirements: *70171077942200
+- !ruby/object:Gem::Dependency
+  name: confection
+  requirement: &70171077941740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70171077941740
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &34512580 !ruby/object:Gem::Requirement
+  requirement: &70171077941200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *34512580
+  version_requirements: *70171077941200
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
@@ -66,17 +77,16 @@ executables:
 extensions: []
 extra_rdoc_files:
 - HISTORY.rdoc
-- SPECSHEET.rdoc
 - README.rdoc
-- LICENSE.rdoc
 files:
 - .ruby
 - .yardopts
 - bin/qed
 - bin/qedoc
-- lib/qed/advice.rb
 - lib/qed/applique.rb
+- lib/qed/cli/qed.rb
 - lib/qed/cli/qedoc.rb
+- lib/qed/cli.rb
 - lib/qed/core_ext.rb
 - lib/qed/demo.rb
 - lib/qed/document/jquery.js
@@ -88,43 +98,38 @@ files:
 - lib/qed/helpers/shell_session.rb
 - lib/qed/parser.rb
 - lib/qed/reporter/abstract.rb
-- lib/qed/reporter/bullet.rb
 - lib/qed/reporter/dotprogress.rb
-- lib/qed/reporter/dtrace.rb
 - lib/qed/reporter/html.rb
 - lib/qed/reporter/tapy.rb
 - lib/qed/reporter/verbatim.rb
 - lib/qed/scope.rb
 - lib/qed/session.rb
 - lib/qed/settings.rb
+- lib/qed/step.rb
 - lib/qed.rb
 - lib/qed.yml
-- lib/yard-qed.rb
-- spec/01_demos.rdoc
-- spec/02_advice.rdoc
-- spec/03_helpers.rdoc
-- spec/04_samples.rdoc
-- spec/05_quote.rdoc
-- spec/07_toplevel.rdoc
-- spec/08_cross_script.rdoc
-- spec/09_cross_script.rdoc
-- spec/10_constant_lookup.rdoc
-- spec/applique/constant.rb
-- spec/applique/env.rb
-- spec/applique/fileutils.rb
-- spec/applique/markup.rb
-- spec/applique/quote.rb
-- spec/applique/toplevel.rb
-- spec/helpers/advice.rb
-- spec/helpers/sample.rb
-- spec/helpers/toplevel.rb
-- spec/samples/data.txt
-- spec/samples/table.yml
-- test/integration/topcode.rdoc
+- qed/01_demos.rdoc
+- qed/02_advice.rdoc
+- qed/03_helpers.rdoc
+- qed/04_samples.rdoc
+- qed/05_quote.rdoc
+- qed/07_toplevel.rdoc
+- qed/08_cross_script.rdoc
+- qed/09_cross_script.rdoc
+- qed/10_constant_lookup.rdoc
+- qed/11_embedded_rules.rdoc
+- qed/99_issues/02_topcode.rdoc
+- qed/applique/constant.rb
+- qed/applique/env.rb
+- qed/applique/fileutils.rb
+- qed/applique/markup.rb
+- qed/applique/toplevel.rb
+- qed/helpers/advice.rb
+- qed/helpers/toplevel.rb
+- qed/samples/data.txt
+- qed/samples/table.yml
 - HISTORY.rdoc
-- SPECSHEET.rdoc
 - README.rdoc
-- LICENSE.rdoc
 homepage: http://rubyworks.github.com/qed
 licenses:
 - BSD-2-Clause

data/LICENSE.rdoc

@@ -1,31 +0,0 @@
-= COPYRIGHT NOTICES
-
-== QED
-
-Copyright:: (c) 2007 Rubyworks, Thomas Sawyer
-License:: BSD-2-Clause
-Website:: http://rubyworks.github.com/yes
-
-    Copyright 2007 Thomas Sawyer, Rubyworks. 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.
-
-    THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``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 Thomas Sawyer OR CONTRIBUTORS 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.
-