qed 2.9.0 → 2.9.1

data/.index

@@ -0,0 +1,69 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- name: ansi
+- name: brass
+- version: 2.8+
+  name: facets
+- groups:
+  - optional
+  - test
+  development: true
+  name: blankslate
+- groups:
+  - test
+  development: true
+  name: ae
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: ergo
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/qed
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/qed
+  label: Source Code
+- type: mail
+  uri: http://groups.google.com/groups/rubyworks-mailinglist
+  label: Mailing List
+- type: bugs
+  uri: http://github.com/rubyworks/qed/issues
+  label: Issue Tracker
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/qed.git
+categories: []
+copyrights:
+- holder: Thomas Sawyer, Rubyworks
+  year: '2006'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2009-06-16'
+summary: Quod Erat Demonstrandum
+title: QED
+version: 2.9.1
+name: qed
+webcvs: http://github.com/rubyworks/qed/blob/master/
+description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
+
+  utilizing Literate Programming techniques.'
+date: '2013-02-18'

data/.yardopts

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

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,12 +1,24 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 2.9.0 | 2012-05-19
+## 2.9.1 | 2013-02-20
+
+The RC gem is optional now and old school `etc/qed.rb`, `config/qed.rb` and
+`.qed` are all supported again.
+
+Changes:
+
+* Resupport traditional config files.
+* Make RC optional dependency.
+* Add support for Markdown-style helper links.
+
+
+## 2.9.0 | 2012-05-19
 
 IMPORTANT! The `.qed` configuration file is no longer used for configuration.
-Either use a unified `Config.rb` file or require a special config file via the
-`-r` option, e.g. `qed -r ./config/cov.rb`.
+Either use a unified `.ruby` or `.rubyrc` file or require a special config file
+via the `-r` option, e.g. `qed -r ./config/cov.rb`.
 
-Configuration is now handled by the RC library. The only other
+General configuration is now handled by the RC library. The only other
 form of configuration supported is that of requiring a special file
 directly via `-r ./path/to/file.rb`. This keeps the code as
 simple as possible without giving-up functionality. Because the old
@@ -19,7 +31,7 @@ Changes:
 * Improve hash-arrow assertion notation.
 
 
-== 2.8.8 | 2012-03-17
+## 2.8.8 | 2012-03-17
 
 Feel like a heel after the last four releases. The simplest solution
 to the configuration issue is to allow traditional configuration
@@ -31,7 +43,7 @@ Changes:
 * Traditional configuration trump Confection configuration.
 
 
-== 2.8.7 | 2012-03-16
+## 2.8.7 | 2012-03-16
 
 Release fixes a bug that prevented default demo locations from being
 used when none are specified on the command line. Also change way
@@ -44,7 +56,7 @@ Changes:
 * Change environment variable to config='legacy' to deactivate Confection.
 
 
-== 2.8.6 | 2012-03-15
+## 2.8.6 | 2012-03-15
 
 This release simply make the configuration more versatile by supporting
 Confection, task directory and traditional `.qed` configuration.
@@ -54,7 +66,7 @@ Changes:
 * Support variety of configuration systems.
 
 
-== 2.8.5 | 2012-03-14 19:00
+## 2.8.5 | 2012-03-14 19:00
 
 Minor release simply make sure configuration file(s) were distributed 
 with package. Part of the new idea that configurations can be 
@@ -65,7 +77,7 @@ Changes:
 * Include configuration files in distribution.
 
 
-== 2.8.4 | 2012-03-14 18:06
+## 2.8.4 | 2012-03-14 18:06
 
 Just a fix of a method that should have been renamed. Nothing to see here.
 
@@ -74,7 +86,7 @@ Changes:
 * Renamed #config_override to #configless?.
 
 
-== 2.8.3 | 2012-03-14 18:00
+## 2.8.3 | 2012-03-14 18:00
 
 What a difference a week makes ;) The Confection library has been substantially
 improved and if that trend continues at all then I think it will be well worth
@@ -92,7 +104,7 @@ Changes:
 * Deprecated use of `.map` configuration redirection file.
 
 
-== 2.8.2 | 2012-03-07
+## 2.8.2 | 2012-03-07
 
 This release simply reverts the configuration file back to an
 independent file. The use of the Confection library was a "noble
@@ -110,7 +122,7 @@ Changes:
 * Revert to dedicated configuration file.
 
 
-== 2.8.1 | 2012-02-01
+## 2.8.1 | 2012-02-01
 
 This release fixes a bug in the parsing of `#=>` notation. It also
 adds syntax highlighting to qedoc generated documentation. It does
@@ -122,7 +134,7 @@ Changes:
 * Add highlight.js to qedocs.
 
 
-== 2.8.0 | 2012-01-19
+## 2.8.0 | 2012-01-19
 
 IMPORTANT: READ THIS RELEASE NOTICE! This release makes a minor
 change, but it is one that will effect all end-users. That is, QED no
@@ -141,7 +153,7 @@ Changes:
 * Complies with assertion standards set by BRASS project.
 
 
-== 2.7.0 | 2011-11-18
+## 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
@@ -177,7 +189,7 @@ Changes:
 * Rework API taking SOLID principles into consideration.
 
 
-== 2.6.3 | 2011-10-23
+## 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
@@ -190,7 +202,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
@@ -204,7 +216,7 @@ Changes:
 * Fix website links (you might actually find things now).
 
 
-== 2.6.0 | 2011-07-01
+## 2.6.0 | 2011-07-01
 
 This release fixes some issues with reporters, further refines
 their output and adds the start of a new reporter called dtrace.
@@ -227,7 +239,7 @@ 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 number of backtrace
@@ -241,7 +253,7 @@ 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 major issue
 with the way the latest AE library counts assertions.
@@ -253,7 +265,7 @@ 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
@@ -269,7 +281,7 @@ 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 doubly-linked lists, which makes
@@ -284,7 +296,7 @@ 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 exoskeletons all the way to the bank. A proverbial can of
@@ -307,7 +319,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
@@ -323,7 +335,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
@@ -335,7 +347,7 @@ 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
@@ -371,7 +383,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
@@ -382,7 +394,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
@@ -394,7 +406,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
@@ -410,7 +422,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
@@ -430,7 +442,7 @@ Changes:
   * Verbatim reporter is literally verbatim.
 
 
-== 1.1.1 | 2009-09-05
+## 1.1.1 | 2009-09-05
 
 This release needs a description.
 
@@ -447,7 +459,7 @@ 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.

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD-2-Clause License
+
+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.
+
+(SPDX: BSD-2-Clause)
+

data/{README.rdoc → README.md}

@@ -1,15 +1,15 @@
-= Ruby Q.E.D.
+# Ruby Q.E.D.
 
-{Homepage}[http://rubyworks.github.com/qed] |
-{Documentation}[http://rubydoc.info/gems/qed/frames] |
-{Report Issue}[http://github.com/rubyworks/qed/issues] |
-{Development}[http://github.com/rubyworks/qed] |
-{Mailing list}[http://groups.google.com/group/rubyworks-mailinglist]
+[Homepage](http://rubyworks.github.com/qed) /
+[Documentation](http://rubydoc.info/gems/qed/frames) /
+[Report Issue](http://github.com/rubyworks/qed/issues) /
+[Development](http://github.com/rubyworks/qed) /
+[Mailing list](http://groups.google.com/group/rubyworks-mailinglist)    
+[![Build Status](https://secure.travis-ci.org/rubyworks/qed.png)](http://travis-ci.org/rubyworks/qed)
+[![Gem Version](https://badge.fury.io/rb/qed.png)](http://badge.fury.io/rb/qed)
 
-{<img src="http://travis-ci.org/rubyworks/qed.png" />}[http://travis-ci.org/rubyworks/qed]
 
-
-== Introduction
+## Introduction
 
 Q.E.D. is an abbreviation for the well known Latin phrase "Quod Erat Demonstrandum",
 literally "which was to be demonstrated", which is oft written in its abbreviated
@@ -25,7 +25,7 @@ useful when designing reusable libraries, but it can be used to test code at
 any level of abstraction, from unit test to systems tests.
 
 
-== Features
+## Features
 
 * Write tests and documentation in the same breath!
 * Demos can be RDoc, Markdown or any other conforming text format.
@@ -34,9 +34,9 @@ any level of abstraction, from unit test to systems tests.
 * Documentation tool provides nice output with jQuery-based TOC.
 
 
-== Synopsis
+## Synopsis
 
-=== Assertion Syntax
+### Assertion Syntax
 
 QED can use any BRASS compliant assertions framework. Simply require the library in
 ones applique (see below). Traditionally this has been the AE (Assertive Expressive) library,
@@ -52,7 +52,7 @@ code blocks containing such assertions.
 You can learn more about BRASS and AE at http://rubyworks.github.com/brass and
 http://rubyworks.github.com/ae, repectively.
 
-=== Document Structure
+### Document Structure
 
 QED documents are simply text files called *demonstrandum* (demos for short).
 Because they largely consist of free-form descriptive text, they are a practice
@@ -81,7 +81,7 @@ Give this design some thought. It should become clear that this approach is
 especially fruitful in that it allows *documentation* and *specification*
 to seamlessly merge into a unified *demonstration*. 
 
-=== Running Demonstrations
+### Running Demonstrations
 
 If we were to run the above document through QED in verbatim mode the output
 would be identical (assuming we did not make a typo and the assertions passed).
@@ -91,33 +91,33 @@ To run a document through QED, simply use the +qed+ command.
 
   $ qed -v demo/01_example.rdoc
 
-The <code>-v</code> option specifies verbatim mode, which outputs the entire
+The `-v` option specifies verbatim mode, which outputs the entire
 document.
 
-Notice we placed the QED document in a <code>demo/</code> directory, there is
-no standard place that demonstrations have to go. They can be placed anywhere
-in a project that is preferred (lately I've been use `qed/`). However, the 
-`qed` command will look for `qed/`, `demo/`, `demos/` and `spec/` in that order
-if no location is specified.
+Notice we placed the QED document in a `demo/` directory. This is the
+canonical location, but there is no place that demonstrations have to go. They
+can be placed anywhere that is preferred. However, the `qed` command
+will look for `qed/`, `demo/`, `demos/` and `spec/`, in that order, if no
+path is given.
 
-Also notice the use of `<code>01_</code>` prefix in front of the file name.
-While this is not strictly necessary, it helps order the documents nicely,
-in particular when generating QED documentation ("QEDocs").
+Also notice the use of ``01_`` prefix in front of the file name.
+While this is not strictly necessary, QED sorts the documents, so it helps order
+the documents nicely, in particular when generating QED documentation ("QEDocs").
 
-=== Utilizing Applique
+### Utilizing Applique
 
 QED demonstrandum descriptive text is not strictly passive explanation. Using
 pattern matching techniques, document phrases can trigger underlying actions.
 These actions provide a support structure for running tests called the *applique*.
 
 Creating an applique is easy. Along with your QED scripts, to which the 
-applique will apply, create an <code>applique/</code> directory. In this
+applique will apply, create an `applique/` directory. In this
 directory add Ruby scripts. When you run your demos every Ruby script in 
 the directory will be automatically loaded.
 
 Within these applique scripts *advice* can be defined. Advice can be
 either *event advice*, which is simply triggered by some fixed cycle
-of running, such as <code>Before :each</code> or <code>After :all</code>,
+of running, such as `Before :each` or `After :all`,
 and *pattern advice* which are used to match against descriptive
 phrases in the QED demos. An example would be:
 
@@ -132,23 +132,21 @@ It is rather amazing what can be accomplished with such a system,
 be sure to look at QED's own demonstrandum to get a better notion of
 how you can put the the system to use.
 
-=== Configuration
-
-QED uses the {RC}[http://rubyworks.github.com/rc] library to
-handle configuration.
+### Configuration
 
-Here's a generally useful example of using SimpleCov to generate a test
-coverage report when running your QED demos. Add this to your `Config.rb`
-file:
+Configuration for `qed` can be placed in a `etc/qed.rb` file, or if
+you are using Rails, in `config/qed.rb`. Here's a generally useful
+example of using SimpleCov to generate a test coverage report when
+running your QED demos.
 
-    config :qed, :coverage do
+    QED.configure 'coverage' do
       require 'simplecov'
       SimpleCov.start do
         coverage_dir 'log/coverage'
       end
     end
 
-You can use the profile via the `-p/--profile` option on the command line:
+You can then use the profile via the `-p/--profile` option on the command line:
 
     $ qed -p coverage
 
@@ -156,42 +154,53 @@ Or by setting the `profile` environment variable.
 
     $ profile=coverage qed
 
-=== Generating Documentation
+QED can also use the [RC](http://rubyworks.github.com/rc) gem to handle
+configuration. Be sure to `gem install rc` and then add this to `.rubyrc`
+or `Config.rb` file of the same effect as given above.
+
+    config :qed, :profile=>:coverage do
+      require 'simplecov'
+      SimpleCov.start do
+        coverage_dir 'log/coverage'
+      end
+    end
+
+### Generating Documentation
 
 To generate documentation from QED documents, use the +qedoc+ command.
 
     $ qedoc --output doc/qedoc --title "Example" demo/*.rdoc
 
 When documenting, QED recognizes the format by the file extension and 
-treats it accordingly. An extension of <code>.qed</code> is treated the same
-as <code>.rdoc</code>.
+treats it accordingly. An extension of `.qed` is treated the same
+as `.rdoc`.
 
-Use the <code>--help</code> options on each command to get more information
+Use the `--help` options on each command to get more information
 on the use of these commands.
 
 
-== Requirements
+## Requirements
 
 QED depends on the following external libraries:
 
-* {BRASS}[http://rubyworks.github.com/brass] - Assertions System
-* {ANSI}[http://rubyworks.github.com/ansi] - ANSI Color Codes
-* {RC}[http://rubyworks.github.com/rc] - Runtime Configuration
-* {Facets}[http://rubyworks.github.com/facets] - Core Extensions
+* [BRASS](http://rubyworks.github.com/brass) - Assertions System
+* [ANSI](http://rubyworks.github.com/ansi) - ANSI Color Codes
+* [RC](http://rubyworks.github.com/rc) - Runtime Configuration
+* [Facets](http://rubyworks.github.com/facets) - Core Extensions
 
 These will be automatically installed when installing QED via RubyGems,
 if they are not already installed.
 
 Optional libraries that are generally useful with QED.
 
-* {AE}[http://rubyworks.github.com/ae] - Assertions Framework
+* [AE](http://rubyworks.github.com/ae) - Assertions Framework
 
 Install these individually and require them in your applique to use.
 
 
-== Development
+## Development
 
-=== Testing
+### Testing
 
 QED uses itself for testing, which can be a bit tricky. But works fine for
 the most part. In the future we may add some addition tests via another
@@ -204,11 +213,11 @@ For convenience, use `$ fire spec` to run the test specifications. To also
 generate a test coverage report use `$ fire spec:cov`.
 
 
-== Copyrights
+## Copyrights
 
-(BSD 2 Clause license)
+(BSD-2-Clause license)
 
-Copyright (c) 2009 Rubyworks, Thomas Sawyer
+Copyright (c) 2009 Rubyworks. All rights reserved.
 
-See COPYING.rdoc for details.
+See LICENSE.txt for details.