qed 1.0.0 → 1.1.0

data/{LICENSE → COPYING}

@@ -1,5 +1,5 @@
-
-               Respect the Ruby (c) 2008 Tiger Ops
+.
+                 QED (c) 2008, 2009 Thomas Sawyer
 
 
                    GNU GENERAL PUBLIC LICENSE

data/MANIFEST

@@ -11,23 +11,12 @@ doc/qedoc/index.html
 doc/qedoc/jquery.js
 lib
 lib/qed
-lib/qed/assertion.rb
 lib/qed/document
 lib/qed/document/jquery.js
 lib/qed/document/markup.rb
 lib/qed/document/template.rhtml
 lib/qed/document.rb
-lib/qed/doubles
-lib/qed/doubles/mock.rb
-lib/qed/doubles/spy.rb
-lib/qed/doubles/stub.rb
-lib/qed/expectation.rb
-lib/qed/grammar
-lib/qed/grammar/assert.rb
-lib/qed/grammar/expect.rb
-lib/qed/grammar/legacy
-lib/qed/grammar/legacy/assert.rb
-lib/qed/grammar/should.rb
+lib/qed/extract.rb
 lib/qed/reporter
 lib/qed/reporter/base.rb
 lib/qed/reporter/dotprogress.rb
@@ -35,9 +24,6 @@ lib/qed/reporter/summary.rb
 lib/qed/reporter/verbatim.rb
 lib/qed/runner.rb
 lib/qed/script.rb
-lib/qed/utilities
-lib/qed/utilities/extract.rb
-lib/qed/utilities/monitor.rb
 lib/qed.rb
 meta
 meta/authors
@@ -51,6 +37,6 @@ meta/ruby
 meta/summary
 meta/title
 meta/version
-LICENSE
 README.rdoc
 HISTORY
+COPYING

data/README.rdoc

@@ -1,7 +1,7 @@
 = Ruby Q.E.D.
 
       homepage: http://proutils.rubyforge.org/qed
-  mailing list: http://groups.google.com/group/tigerops-community?hl=en
+  mailing list: http://groups.google.com/group/tigerops-community
    development: http://github.com/proutils/qed/tree/master
 
 
@@ -9,16 +9,19 @@
 
 Q.E.D. stands for Quality Enhanced Demos. QED is an easy to use
 quality assurance and documentation system for Ruby Developers.
-QED sit between low-level testing tools like Test Unit and 
-requirements specifications like Cucumber. It is designed to
-address Interface-driven devleopment, which is especailly 
-useful when designing reusble libraries.
+QED sits between lower-level testing tools like Test Unit and 
+grand requirements specifications tools like Cucumber. It is
+designed to address <i>API-Driven Devleopment</i>, which
+is especailly useful when designing reusble libraries.
 
 
 == Features
 
-* Demos can be RDoc or Markdown format. 
-* Uses AE as backend assertion system.
+* Demos can be RDoc, Markdown or any other conforming text format. 
+* Uses excellent Assertive Expressive library for assertion system.
+* Helpers are easily loaded relative to running document.
+* Table macro allows large sets of data to be run by the same code.
+* Documentation tool provides nice output with jQuery-based TOC.
 
 
 == Synopsis
@@ -41,7 +44,7 @@ You can learn more about AE at http://proutils.rubyforge/ae.
 QED documents are simply text files --thus a practice of literal programming.
 For example:
 
-    # Example
+    = Example
 
     Shows that the number 5 does not equal 4.
 
@@ -51,47 +54,81 @@ For example:
 
         5.assert == 5
 
-As you can see, we used Markdown for this document. Almost any text format
+As you can see, we used RDoc for this document. Almost any text format
 can be used. The only neccesary distinction is that desciption text be
 align to the left margin and all code be indented. However QED recognizes
 RDoc and Markdown style headers, so any format that supports this style
 (which covers many markup formats in use today) will work a bit better.
 While strictly speaking QED does not need to recognize headers, it does
-improve console output a bit.
+improve console output.
 
 Give this design some thought. It should become clear that this approach is
 especially fruitful in that it allows *documentation* and *specification*
-to seemlessly merge into a unified *demonstraion*.
-
-If we run this document through QED 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.
+to seemlessly merge into a unified *demonstration*. 
 
 === 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).
+If there were errors or failures, we would see information detaling each.
+
 To run a document through QED, simply use the +qed+ command.
 
-  $ qed demo/01_example.rdoc
+  $ qed -v demo/01_example.rdoc
+
+The <tt>-v</tt> option specifies verbatim mode, which outputs the entire
+document.
 
 Notice we placed the QED document in the demo directory, this is the
-traditional place we have designated for them, though you can put them
+concial place that has been designated for them, though you can put them
 elsewhre in your project if you prefer. Also notice the 01_ in front
 of the name. While this is not necessary, it helps order the documents
-properly with generatingQED documentation (QEDocs).
+properly with generating QED documentation (QEDocs).
 
-Speaking of which, to generate documentation from QED documents, use the
-+qedoc+ command. Eg.
+To generate documentation from QED documents, use the +qedoc+ command.
 
   $ qed --output doc/qedoc --title "Example" demo/*.rdoc
 
+When documenting QED recognizes the format by the file extension and 
+treats it accordingly. An extension of <tt>.qed</tt> is treated the same
+as <tt>.rdoc</tt>.
+
 Use the <tt>--help</tt> options on each command to get more inforamtion on
 the use of these commands.
 
+
+== Requirements
+
+QED depends on the following external libraries:
+
+  * AE     - Assertions Framework
+  * ANSI   - ANSI Color Codes
+  * Facets - Core Extensions
+
+These will be automatically installed when installing QED via RubyGems,
+if they are not already installed.
+
+
 == Copyright and License
 
 Q.E.D.
 
 Copyright (c) 2007,2009 Thomas Sawyer
 
-QED is distributed under the terms of the GPLv3.
+Unless otherwise permitted by the author, QED is distributed under the
+terms of the GPL version 3 or greater. See COPYING file for details.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 

data/bin/qed

@@ -64,18 +64,18 @@ module QED
 
     # TODO: Better way to load helpers?
     #
-    def load_helpers
-      dirs = spec_files.map{ |file| File.join(Dir.pwd, File.dirname(file)) }
-      dirs = dirs.select{ |dir| File.directory?(dir) }
-      dirs.each do |dir|
-        while dir != '/' do
-          helper = File.join(dir, 'qed_helper.rb')
-          load(helper) if File.exist?(helper)
-          break if Dir.pwd == dir
-          dir = File.dirname(dir)
-        end
-      end
-    end
+    #def load_helpers
+    #  dirs = spec_files.map{ |file| File.join(Dir.pwd, File.dirname(file)) }
+    #  dirs = dirs.select{ |dir| File.directory?(dir) }
+    #  dirs.each do |dir|
+    #    while dir != '/' do
+    #      helper = File.join(dir, 'qed_helper.rb')
+    #      load(helper) if File.exist?(helper)
+    #      break if Dir.pwd == dir
+    #      dir = File.dirname(dir)
+    #    end
+    #  end
+    #end
 
     #
     def specs
@@ -120,7 +120,7 @@ module QED
     def execute
       parse_options
       #load_rc
-      load_helpers
+      #load_helpers
       case reporter
       when :script
         specs.each do |spec|

data/demo/01_spec.qed

@@ -31,9 +31,8 @@ And this would have raised a NameError:
 = Neutral Code
 
 There is no means of specifying that a code clause is neutral code,
-i.e. that it should be executed but not tested. So far this
-such a feature has proven to be a YAGNI. Yet we may add such a
-feature in the future if it is ultimately deemed necessary.
+i.e. that it should be executed but not tested. Thus far, such a
+feature has proven to be a YAGNI.
 
 
 = Defining Custom Assertions
@@ -141,3 +140,7 @@ This concludes the basic overview of QED's specification system, which
 is itself a QED document. Yes, we eat our own dog food.
 
 Q.E.D.
+
+---
+require 'qed_helper'
+

data/doc/qedoc/index.html

@@ -109,7 +109,7 @@ executable code.
 <p>
 Each code section is executed in order of appearance, within a rescue
 wrapper that captures any failures or errors. If neither a failure or error
-occur then the code gets a &quot;pass&quot;.
+occur then the code gets a &#8220;pass&#8221;.
 </p>
 <p>
 For example, the following passes:
@@ -118,17 +118,13 @@ For example, the following passes:
   (2 + 2).assert == 4
 </pre>
 <p>
-While the following would &quot;fail&quot;, as indicated by the raising of
-an Assertion error:
+While the following would &#8220;fail&#8221;, as indicated by the raising
+of an Assertion error:
 </p>
 <pre>
-  Assertion.assert.raised? do
+  expect Assertion do
     (2 + 2).assert == 5
   end
-
-  #expect Assertion do
-  #  (2 + 2).assert == 5
-  #end
 </pre>
 <p>
 And this would have raised a NameError:
@@ -145,7 +141,7 @@ that it should be executed but not tested. So far this such a feature has
 proven to be a YAGNI. Yet we may add such a feature in the future if it is
 ultimately deemed necessary.
 </p>
-<h1>Defining Macros</h1>
+<h1>Defining Custom Assertions</h1>
 <p>
 The context in which the QED code is run is a self-extended module, thus
 reusable macros can be created simply by defining a method.
@@ -169,6 +165,13 @@ Let&#8217;s prove that it can also fail:
     assert_integer(&quot;IV&quot;)
   end
 </pre>
+<h1>Helper File</h1>
+<p>
+If you create a file called `qed_helper.rb` located in the directory with
+the QED documents you are running via the `qed` command, it will be loaded
+first. You can use that to load optional AE features, or define your own
+specialized assertion methods.
+</p>
 <h1>Before and After Clauses</h1>
 <p>
 QED supports <b>before</b> and <b>after</b> clauses in a specification
@@ -241,7 +244,7 @@ Finally we will demonstrate a tabular step. <tt>table</tt> method is used
 for this. We supply a file name to the method telling QED where to find the
 table data to be used in the test. All table files are looked for relative
 to the location of the document. If no name is given the
-&#8217;&lt;doc-name&gt;.yaml&#8217; is assumed.
+&#8217;<doc-name>.yaml&#8217; is assumed.
 </p>
 <p>
 The arity of the table block determines the number of columns each row in

data/lib/qed.rb

@@ -1,5 +1,6 @@
+module QED
+  VERSION="1.0.0"  #:till: VERSION="<%= version %>"
+end
+
 require 'qed/runner'
-require 'qed/doubles/mock'
-require 'qed/doubles/stub'
-#require 'qed/doubles/spy'
 

data/lib/qed/document.rb

@@ -77,15 +77,14 @@ module QED
         #strio.close
 
         case ext = File.extname(file)
-        when '.qed'
-          require_qedoc
-          markup = Markup.new(File.read(file))
-          text << markup.to_html
-        when '.rd', '.rdoc'
+        #when '.qed'
+        #  require_qedoc
+        #  markup = Markup.new(File.read(file))
+        #  text << markup.to_html
+        when '.rd', '.rdoc', '.qed'
           require_rdoc
-          markup = SM::SimpleMarkup.new
-          formatter = SM::ToHtml.new
-          text << markup.convert(File.read(file), formatter)
+          markup = RDoc::Markup::ToHtml.new
+          text << markup.convert(File.read(file))
           #text << markup.convert(iotext, formatter)
         when '.md', '.markdown'
           require_rdiscount
@@ -147,8 +146,8 @@ module QED
     #
     def require_rdoc
       @require_rdoc ||= (
-        require 'rdoc/markup/simple_markup'
-        require 'rdoc/markup/simple_markup/to_html'
+        require 'rdoc/markup/to_html'
+        #require 'rdoc/markup/simple_markup'
         true
       )
     end

data/lib/qed/script.rb

@@ -29,8 +29,13 @@ module QED
     # New Script
     def initialize(file, output=nil)
       @file   = file
-      @source = File.read(file)
       @output = output || Reporter::Verbatim.new #(self)
+
+      source = File.read(file)
+      index  = source.rindex('---')
+
+      @source = source[0...index]
+      @helper = source[index+3...-1].strip
     end
 
     #def convert
@@ -40,6 +45,7 @@ module QED
     # Run the script.
     def run
       #steps = @source.split(/\n\s*$/)
+      eval(@helper, context._binding, @file) if @helper
       steps.each do |step|
         output.report_step(step)
         case step

data/meta/requires

@@ -1 +1,3 @@
 ae
+ansi
+facets

data/meta/version

@@ -1 +1 @@
-1.0.0
+1.1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: qed
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Thomas Sawyer <transfire@gmail.com>
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-04 00:00:00 -04:00
+date: 2009-09-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: ansi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: |-
   QED (Quality Enahancing Demos) is a slick Interface-Driven Development
   (IDD) system utilizing Literate Programming concepts.
@@ -33,9 +53,9 @@ extensions: []
 
 extra_rdoc_files: 
 - MANIFEST
-- LICENSE
 - README.rdoc
 - HISTORY
+- COPYING
 files: 
 - bin/qed
 - bin/qedoc
@@ -44,27 +64,17 @@ files:
 - demo/qed_helper.rb
 - doc/qedoc/index.html
 - doc/qedoc/jquery.js
-- lib/qed/assertion.rb
 - lib/qed/document/jquery.js
 - lib/qed/document/markup.rb
 - lib/qed/document/template.rhtml
 - lib/qed/document.rb
-- lib/qed/doubles/mock.rb
-- lib/qed/doubles/spy.rb
-- lib/qed/doubles/stub.rb
-- lib/qed/expectation.rb
-- lib/qed/grammar/assert.rb
-- lib/qed/grammar/expect.rb
-- lib/qed/grammar/legacy/assert.rb
-- lib/qed/grammar/should.rb
+- lib/qed/extract.rb
 - lib/qed/reporter/base.rb
 - lib/qed/reporter/dotprogress.rb
 - lib/qed/reporter/summary.rb
 - lib/qed/reporter/verbatim.rb
 - lib/qed/runner.rb
 - lib/qed/script.rb
-- lib/qed/utilities/extract.rb
-- lib/qed/utilities/monitor.rb
 - lib/qed.rb
 - meta/authors
 - meta/created
@@ -77,9 +87,9 @@ files:
 - meta/summary
 - meta/title
 - meta/version
-- LICENSE
 - README.rdoc
 - HISTORY
+- COPYING
 - MANIFEST
 has_rdoc: true
 homepage: http://proutils.rubyforge.org/qed