qed 2.6.3 → 2.7.0

data/.ruby

@@ -1,6 +1,6 @@
 ---
 source:
-- meta/
+- var
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -16,6 +16,7 @@ requirements:
   version: 2.8+
 - name: ae
   version: 1.7+
+- name: confection
 - name: detroit
   groups:
   - build
@@ -38,9 +39,9 @@ revision: 0
 created: '2006-12-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.6.3
+version: 2.7.0
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
-date: '2011-10-24'
+date: '2011-11-20'

data/.yardopts

@@ -1,6 +1,9 @@
+--plugin qed
 --output-dir doc
 --readme README.rdoc
 --title "Q.E.D."
+--protected
+--private
 lib
 -
 [A-Z]*.*

data/HISTORY.rdoc

@@ -1,6 +1,42 @@
 = RELEASE HISTORY
 
-== 2.6.3 / 2011-10-23
+== 2.7.0 | 2011-11-18
+
+The focus of this release is a much improved underlying API, including
+a better event model and the application of SOLID principles to really
+get the code in good shape. In most respects the changes will not effect
+QED documents --at most some event signals may need to be adjusted, if
+an old applique happened to use them.
+
+Beyond the underlying code, some other important changes have been made.
+
+Configuration is now handled by the `confection` gem. Simply add a `qed`
+section to your `Confile`. In it you can add `profile` blocks. See QED
+project's own `.confile` for an example.
+
+A new notation for captures has been added. Captures can now be written
+as `/(\S+)/` and non-capture expressions as `/?:\S+/`. The old 
+parenthetical notation still works. Strings arguments may also add `...`
+to split the string into two match arguments without actually having
+to pass two arguments.
+
+The change most likely to effect old demonstrandum, is the deprecation
+of `...` plain text marker. Be sure to make sure your demos use `:` instead.
+
+Changes:
+
+* Deprecate use of '...' as a plain text example indicator.
+* When string arguments can use '...' to split the match.
+* Applique files can now be demo documents too.
+* Use confection gem for configuration.
+* Must use `-f` option to use (most) alternative reporters.
+* Show full backtrace in (most) reporters.
+* Overhaul evaluator using better signal names.
+* Underlying observer API redesigned (effects reporters).
+* Rework API taking SOLID principles into consideration.
+
+
+== 2.6.3 | 2011-10-23
 
 Fixed output status. When tests fail or error the `qed`
 command with exit -1 instead to 0. Also, the default
@@ -13,7 +49,7 @@ Changes:
 * Fix default spec location to only use one or the other.
 
 
-== 2.6.1 / 2011-07-02
+== 2.6.1 | 2011-07-02
 
 A friend suggested QED default the load path to lib and
 automatically look for QED demos in default locations
@@ -24,18 +60,18 @@ Changes:
 
 * Default loadpath option to lib/.
 * Default files to markup files in spec/, demo/ and qed/.
-* Fix website links (you might acutally find things now).
+* Fix website links (you might actually find things now).
 
 
-== 2.6.0 / 2011-07-01
+== 2.6.0 | 2011-07-01
 
-Thie release fixes some issues with reporters, further refines
+This release fixes some issues with reporters, further refines
 their output and adds the start of a new reporter called dtrace.
 Also the Table and Data macros have been updated. Table can now
 handle a YAML stream with the :stream option, and Data no long runs
-the text through YAML.load whe the file name ends in .yml or .yaml,
+the text through YAML.load when the file name ends in .yml or .yaml,
 In other words it's for raw fixture data. Finally the documentation
-tool has been improved ot simplify HTML generation and also add a
+tool has been improved to simplify HTML generation and also add a
 format option for creating a simple plain text merging instead.
 
 Changes:
@@ -50,10 +86,10 @@ Changes:
 * HTML output is single file, jquery comes from CDNJ.
 
 
-== 2.5.2 / 2011-06-26
+== 2.5.2 | 2011-06-26
 
 This release focuses on reporter improvements. Better trace
-information is now displayed, and the max nmber of backtrace
+information is now displayed, and the max number of backtrace
 lines can be set with the -t option, or $trace environment
 variable.
 
@@ -64,9 +100,9 @@ Changes:
 * Added TAP-Y reporter.
 
 
-== 2.5.1 / 2011-06-07
+== 2.5.1 | 2011-06-07
 
-This release makes a number adjustments and fixes one majort issue
+This release makes a number adjustments and fixes one major issue
 with the way the latest AE library counts assertions.
 
 Changes:
@@ -76,11 +112,11 @@ Changes:
 * Backtrace filter omits references to AE library.
 
 
-== 2.5.0 / 2010-11-04
+== 2.5.0 | 2010-11-04
 
 The latest release of QED improves on applique loading, such that each
 demonstrandum gets it's own localized set. The CLI has also been modified
-so that there is no longer a defualt location, the directory or files to run
+so that there is no longer a default location, the directory or files to run
 must be specified.
 
 Changes:
@@ -92,10 +128,10 @@ Changes:
 * CLI requires files be specified.
 
 
-== 2.4.0 / 2010-09-02
+== 2.4.0 | 2010-09-02
 
 All engines go! QED has not been tested against 1.8.6, 1.8.7 and 1.9.2.
-Underthehood steps are not organized in doubely-linked lists, which makes
+Underthehood steps are not organized in doubly-linked lists, which makes
 them much more robust and flexible. This release also improves scoping,
 test counts, and inline documentation parsing.
 
@@ -107,18 +143,18 @@ Changes:
 * Scope is extended by and includes applique.
 
 
-== 2.3.0 / 2010-07-14
+== 2.3.0 | 2010-07-14
 
 Bug to the scurry! QED has broken through the code/document ceiling and
-is cracking ectoskeletons all the way to the bank. A proverbal can of
-Roach-Be-Gone this is! What's that you say? I will exlpain. QED can now
+is cracking exoskeletons all the way to the bank. A proverbial can of
+Roach-Be-Gone this is! What's that you say? I will explain. QED can now
 run directly against code comments. Simply slip the qed command the -c
-option and feed it some ruby scripts, and presto watch you commnets
+option and feed it some ruby scripts, and presto watch you comments
 fail ;) I think you can figure out what to do next.
 
 In addition to this coolness QED has been improved under the floor
 boards as well. The parser, which is much faster, now blocks commentary
-paragraphs and code examples togeher in one-to-one pairings. Not only
+paragraphs and code examples together in one-to-one pairings. Not only
 does this clean-up the code, but it opens up the potential for Around
 advice in a future version.
 
@@ -130,7 +166,7 @@ Changes:
 * Now distributed under the more permissive Apache 2.0 license.
 
 
-== 2.2.2 / 2010-06-21
+== 2.2.2 | 2010-06-21
 
 An issue was reported in which the a code block at the very
 top of a demo was being ignored. This release fixes this issue
@@ -146,7 +182,7 @@ Changes:
 * Added -R option to run demos relative to project root.
 
 
-== 2.2.1 / 2010-06-20
+== 2.2.1 | 2010-06-20
 
 Remove dependencies to Tilt and Nokogiri. Should have
 done this in last release but alas --there is so
@@ -158,13 +194,13 @@ Changes:
 * Reduce Advice to a single class.
 
 
-== 2.2.0 / 2010-06-19
+== 2.2.0 | 2010-06-19
 
 This release returns to a text-based evaluator, rather
 then use HTML. Processing HTML proved to have too many
 edge cases to be effective --both in implementation
 and in end-usage. So to remedy the situation QED has
-return to supportting simple markup formats such as
+return to supporting simple markup formats such as
 RDoc and Markup.
 
 This release also adds multi-pattern advice. Instead of
@@ -174,14 +210,14 @@ descriptions without restoring to regular expressions.
 
 In addition QED now supports raw text blocks. By ending
 a description section in ellipsis (...), the subsequent
-code setion becomes a plain text section and is passed
+code section becomes a plain text section and is passed
 into the argument list of any matching When advice. This
 makes it easy to scaffold fixture files, for example.
 
 Finally, this release also refines the evaluation scopes.
 Where before, a new binding was being created, each was 
 attached to the TOPLEVEL, and therefore not truly isolated 
-on a per-dcoument basis. To correct, QED now mocks the
+on a per-document basis. To correct, QED now mocks the
 TOPLEVEL providing a new instance of this mock object for
 each document.
 
@@ -194,7 +230,7 @@ Changes:
 * Adjust color support for latest ANSI release.
 
 
-== 2.1.1 / 2010-04-08
+== 2.1.1 | 2010-04-08
 
 Fixed bug introduced in the last version that executed all
 scripts in a single binding. There needed to be a binding
@@ -205,7 +241,7 @@ Changes:
 * Fixed cross-script bug by moving binding instantiation into Script class.
 
 
-== 2.1.0 / 2010-04-07
+== 2.1.0 | 2010-04-07
 
 QED documents are now run in the TOPLEVEL context, rather
 than in a subclass of Scope. This ensures code runs as
@@ -217,7 +253,7 @@ Changes:
 * DomainLanguage module is added to include into TOPLEVEL.
 
 
-== 2.0.0 / 2010-03-04
+== 2.0.0 | 2010-03-04
 
 This is a major new release of QED. All demonstration documents
 are now converted to HTML via Tilt (http://github.com/tilt) before
@@ -233,7 +269,7 @@ Changes:
 * New system of version numbers.
 
 
-== 1.2.0 / 2009-12-07
+== 1.2.0 | 2009-12-07
 
 This release adds a significant new feature, Comment Matchers.
 These work like Cucumber allowing for background code to
@@ -249,11 +285,11 @@ Changes:
 
 * 2 Minor Enhancements
 
-  * Use OptionParser for qed exectuable.
+  * Use OptionParser for qed executable.
   * Verbatim reporter is literally verbatim.
 
 
-== 1.1.1 / 2009-09-05
+== 1.1.1 | 2009-09-05
 
 This release 
 
@@ -270,17 +306,17 @@ Changes:
   * Use latest RDoc version.
 
 
-== 1.0.0 / 2009-06-30
+== 1.0.0 | 2009-06-30
 
 QED has found itself. It took some time to really figure out
 what this project "was" and how it should best be utilized.
 This release is the initial release that puts QED in proper
-perpective.
+perspective.
 
 Changes:
 
 * 2 Major Enhancement
 
     * Partial rewrite of a project that was once called "Quarry".
-    * Now uese AE for assertions.
+    * Now use AE for assertions.
 

data/README.rdoc

@@ -1,5 +1,11 @@
 = Ruby Q.E.D.
 
+{Homepage}[http://rubyworks.github.com/qed] |
+{Development}[http://github.com/rubyworks/qed] |
+{Mailing list}[http://groups.google.com/group/rubyworks-mailinglist] |
+
+{<img src="http://travis-ci.org/rubyworks/qed.png" />}[http://travis-ci.org/rubyworks/qed]
+
 
 == Introduction
 
@@ -26,13 +32,6 @@ any level of abstraction, from unit test to systems tests.
 * Documentation tool provides nice output with jQuery-based TOC.
 
 
-== Resources
-
-* {Homepage}[http://rubyworks.github.com/qed]
-* {Mailing list}[http://groups.google.com/group/rubyworks-mailinglist]
-* {Development}[http://github.com/rubyworks/qed]
-
-
 == Synopsis
 
 === Assertion Syntax
@@ -151,12 +150,12 @@ These will be automatically installed when installing QED via RubyGems,
 if they are not already installed.
 
 
-== Copyright and License
+== Copyrights
 
 Q.E.D.
 
-Copyright (c) 2007 Thomas Sawyer
+Copyright (c) 2007 Rubyworks, Thomas Sawyer
 
 BSD 2 Clause License
 
-See LICENSE.rdoc for details.
+See COPYING.rdoc for details.

data/bin/qed

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require 'qed'
+require 'qed/cli'
 QED.cli(*ARGV)
 

data/bin/qedoc

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
-require 'qed/cli/qedoc'
+require 'qed/cli'
 QED::Document.cli(*ARGV)
+

data/lib/qed.rb

@@ -17,11 +17,8 @@ module QED
   # TODO: Only b/c of Ruby 1.8.x bug.
   VERSION = metadata['version']
 
-  #
-  def self.cli(*argv)
-    Session.cli(*argv)
-  end
-
 end
 
 require 'qed/session'
+require 'qed/document'
+

data/lib/qed.yml

@@ -1,6 +1,6 @@
 ---
 source:
-- meta/
+- var
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -16,6 +16,7 @@ requirements:
   version: 2.8+
 - name: ae
   version: 1.7+
+- name: confection
 - name: detroit
   groups:
   - build
@@ -38,9 +39,9 @@ revision: 0
 created: '2006-12-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.6.3
+version: 2.7.0
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
-date: '2011-10-24'
+date: '2011-11-20'

data/lib/qed/applique.rb

@@ -1,15 +1,15 @@
 module QED
 
-  # Applique is a module built per-script from the +applique+ dirctory.
+  # Applique is a module built per-script from the +applique+ directory.
   # Applique scripts are loaded at the start of a session.
   #
-  # <i>The Applique</i> is whole collection of applique that apply to given
+  # *The Applique* is the whole collection of appliques that apply to given
   # demonstrandum. The applique that apply are the scripts located in the
   # directory relative to the demonstrandum script and all such directories
   # above this upto and the project's root directory.
   #
   # All scripts in the Applique must be compatible/consistant. For two demos to
-  # have separate applique must be kept in separate directores.
+  # have separate applique they must be kept in separate directories.
   #
   class Applique < Module
 
@@ -18,22 +18,21 @@ module QED
       @cache ||= {}
     end
 
-    class << self
-      alias_method :_new, :new
-    end
-
-    # New method caches Applique based-on +file+, if given.
-    #--
     # TODO: may need to expand file to be absolute path
-    #++
-    def self.new(file=nil)
-      if file
-        cache[file] ||= _new(file)
-      else
-        _new(file)
-      end
+
+    # Create new Applique caching instance based-on +file+.
+    #
+    # @param [String] file
+    #   The file path to the applique file.
+    #
+    def self.for(file)
+      cache[file] ||= new(file)
     end
 
+    # Setup new Applique instance.
+    #
+    # @param [String] file
+    #   The file path to the applique file.
     #
     def initialize(file=nil)
       super()
@@ -44,10 +43,23 @@ module QED
 
       if file
         @file = file
-        module_eval(File.read(file), file)
+        case File.extname(file)
+        when '.rb'
+          module_eval(File.read(file), file)
+        else
+          # little bit of a trick here, we create a new demo but manually
+          # set the applique. That way the applique files won't be reloaded.
+          # we then run the demo that applique get loaded.
+          demo = Demo.new(file, :applique=>[self])
+          Evaluator.run(demo, :applique=>true)
+        end
       end
     end
 
+    # Duplicate matcher and signal advice when duplicting applique.
+    #
+    # @param [Applique] other
+    #   The original applique.
     #
     def initialize_copy(other)
       @__matchers__ = other.__matchers__.dup
@@ -61,25 +73,47 @@ module QED
     attr :__signals__
 
     # Pattern matchers and "upon" events.
+    #
+    # @param [Symbol,Array<String,Regexp>] patterns
+    #   Event signal, or list of matches.
+    #
+    # @yield Procedure to run on event.
     def When(*patterns, &procedure)
       if patterns.size == 1 && Symbol === patterns.first
         type = "#{patterns.first}".to_sym
         @__signals__[type] = procedure
         #define_method(type, &procedure)
       else
+        patterns = patterns.map do |p|
+          if String === p
+            p.split('...').map{ |e| e.strip } 
+          else
+            p
+          end
+        end.flatten
         @__matchers__ << [patterns, procedure]
       end
     end
 
     # Before advice.
-    def Before(type=:code, &procedure)
+    #
+    # @param [Symbol] type
+    #   Event signal (`:eval`).
+    #
+    # @yield Procedure to run on event.
+    def Before(type=:eval, &procedure)
       type = "before_#{type}".to_sym
       @__signals__[type] = procedure
       #define_method(type, &procedure)
     end
 
     # After advice.
-    def After(type=:code, &procedure)
+    #
+    # @param [Symbol] type
+    #   Event signal (`:eval`).
+    #
+    # @yield Procedure to run on event.
+    def After(type=:eval, &procedure)
       type = "after_#{type}".to_sym
       @__signals__[type] = procedure
       #define_method(type, &procedure)
@@ -90,7 +124,7 @@ module QED
     # This is useful to transform human readable code examples
     # into proper exectuable code. For example, say you want to
     # run shell code, but want to make if look like typical
-    # shelle examples:
+    # shell examples:
     #
     #    $ cp fixture/a.rb fixture/b.rb
     #
@@ -103,10 +137,10 @@ module QED
     #
     #end
 
-    # Redirect missing constants to Object class 
-    # to simulate TOPLEVEL.
+    # TODO: Clean backtrace when constant is not found ?
+
+    # Redirect missing constants to Object classto simulate TOPLEVEL.
     #
-    # TODO: Clean backtrace when constant is not found.
     def const_missing(name)
       Object.const_get(name)
     end
@@ -114,4 +148,3 @@ module QED
   end
 
 end
-