qed 1.2 → 1.3

data/README.rdoc

@@ -44,11 +44,11 @@ In this example, because 4 != 5, this expression will raise an Assertion
 exception. QED's Runner class is thus just a means of running and capturing
 code block containing these assertions.
 
-You can learn more about AE at http://proutils.rubyforge/ae.
+You can learn more about AE at http://proutils.github.com/ae.
 
 === Document Structure
 
-QED documents are simply text files --thus a practice of literal programming.
+QED documents are simply text files --thus a practice of literate programming.
 For example:
 
     = Example

data/Syckfile

@@ -0,0 +1,70 @@
+---
+stats:
+  service  : Stats
+  title    : ~
+  loadpath : ~
+  exclude  : ~
+  output   : ~
+  active   : true
+
+box:
+  service: Box
+  active : true
+  types  : [ gem, tar ]
+  spec   : true
+  include: [ bin, demo, doc, lib, meta, test, "[A-Z]*" ]
+  exclude: [ doc/rdoc, doc/ri ]
+
+dnote:
+  service  : DNote
+  loadpath : ~
+  labels   : ~
+  output   : ~
+  format   : ~
+  active   : true
+
+email:
+  service : Email
+  file    : ~
+  subject : ~
+  mailto  :
+    - ruby-talk@ruby-lang.org
+    - proutils@googlegroups.com
+  from    : <%= ENV['EMAIL_ACCOUNT'] %>
+  server  : <%= ENV['EMAIL_SERVER'] %>
+  port    : <%= ENV['EMAIL_PORT'] %>
+  account : <%= ENV['EMAIL_ACCOUNT'] %>
+  domain  : <%= ENV['EMAIL_DOMAIN'] %>
+  login   : <%= ENV['EMAIL_LOGIN'] %>
+  secure  : <%= ENV['EMAIL_SECURE'] %>
+  active  : true
+
+ridoc:
+  service: RIDoc
+  include: ~
+  exclude: ~
+  active : true
+
+syntax:
+  service  : Syntax
+  loadpath : ~
+  exclude  : ~
+  active   : false
+
+testrb:
+  service  : TestUnit
+  tests    : ~
+  exclude  : ~
+  loadpath : ~
+  requires : ~
+  live     : false   
+  active   : false
+
+vclog:
+  service  : VClog
+  format   : html   # xml, txt
+  layout   : rel    # gnu
+  typed    : false
+  output   : ~
+  active   : false
+

data/demo/01_spec.qed

@@ -1,7 +1,7 @@
 = Standard Sections
 
-QED demos are light-weight specification documents, suitable
-for Interface-driven Development. The documents are divided up into
+QED demos are light-weight specification documents, highly suitable
+to interface-driven design. The documents are divided up into
 clauses separated by blank lines. Clauses that are flush to the 
 left margin are always explanation or comment clauses. Indented
 clauses are always executable code.
@@ -121,7 +121,7 @@ a separate file. The +Data+ method makes is easy to load such files.
 
     Data('data.txt').assert =~ /dolor/
 
-All files are looked for relative to the location of current document.
+All files are found relative to the location of current document.
 
 = Tabular Steps
 
@@ -129,9 +129,9 @@ The +Table+ method is similar to the +Data+ method except that it
 expects a YAML file, and it can take a block to iterate the data over.
 This makes it easy to test tables of examples.
 
-The arity of the table block determines the number of columns each row
-in the table should have. Each row is assigned in turn and run
-through the coded step. Consider the following example:
+The arity of the table block corresponds to the number of columns in
+each row of the table. Each row is assigned in turn and run through
+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.
@@ -171,5 +171,5 @@ This concludes the basic overview of QED's specification system, which
 is itself a QED document. Yes, we eat our own dog food.
 
 ---
-require 'helper'
+1[helper.rb] Helper
 

data/demo/02_err.qed

@@ -0,0 +1,18 @@
+= Examples of Failure
+
+This document is here simply to demonstrate what
+a failed step looks like.
+
+  1.assert == 2
+
+And this step demonstrates an error.
+
+  raise "just because"
+
+When run with the -v (verbatim) option, +qed+ will
+highlight these in red and give a brief error
+message.
+
+---
+1[sample.rb] Sample Helper
+

data/demo/03_site.qed

@@ -0,0 +1,12 @@
+= Addition
+
+  require 'calculator'
+  calculator = Caclulater.new
+
+A Calculator can add two numbers. 
+
+  calculator.push 2
+  calculator.push 2
+  calculator.add
+  calculator.output.assert == 4
+

data/demo/helpers/sample.rb

@@ -0,0 +1,4 @@
+#require 'ae/should'
+puts "This is just here to demonstrate that helpers are loaded."
+puts
+

data/doc/qedoc/index.html

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <title>Demonstration</title>
+  <title>QED Demonstrandum</title>
 
   <style>
     #container{ margin: 0 auto; width: 800px; }
@@ -19,7 +19,7 @@
     h1 { border-bottom: 2px solid silver; }
     h2 { border-bottom: 2px solid silver; padding-top: 0.5em; }
 
-    hr { border: 1px solid silver; }
+    hr { color: #ccc; margin-top: 1.6em; }
 
     p { color: #222; text-align: justify; margin-top: 0.5em; margin-bottom: 0.5em; line-height: 1.4em; }
 
@@ -89,7 +89,7 @@
     <div id="header">
       <img src="img/icon/book.jpg" align="left" style="padding-right: 10px;" alt=""/>
 
-      <h1 class="title">Demonstration</h1>
+      <h1 class="title">QED Demonstrandum</h1>
 
       <h1>Table of Contents</h1>
 
@@ -100,8 +100,8 @@
     <div id="content">
       <h1>Standard Sections</h1>
 <p>
-QED demos are light-weight specification documents, suitable for
-Interface-driven Development. The documents are divided up into clauses
+QED demos are light-weight specification documents, highly suitable to
+interface-driven design. The documents are divided up into clauses
 separated by blank lines. Clauses that are flush to the left margin are
 always explanation or comment clauses. Indented clauses are always
 executable code.
@@ -249,7 +249,7 @@ The <tt>Data</tt> method makes is easy to load such files.
     Data('data.txt').assert =~ /dolor/
 </pre>
 <p>
-All files are looked for relative to the location of current document.
+All files are found relative to the location of current document.
 </p>
 <h1>Tabular Steps</h1>
 <p>
@@ -258,9 +258,9 @@ that it expects a YAML file, and it can take a block to iterate the data
 over. This makes it easy to test tables of examples.
 </p>
 <p>
-The arity of the table block determines the number of columns each row in
-the table should have. Each row is assigned in turn and run through the
-coded step. Consider the following example:
+The arity of the table block corresponds to the number of columns in each
+row of the table. Each row is assigned in turn and run through the coded
+step. Consider the following example:
 </p>
 <p>
 Every row in the <a href="http://table.yml">table.yml table</a> will be
@@ -310,7 +310,28 @@ This concludes the basic overview of QED&#8217;s specification system,
 which is itself a QED document. Yes, we eat our own dog food.
 </p>
 <hr size="1"></hr><p>
-require &#8216;helper&#8217;
+<a href="http://helper.rb">1</a> Helper
+</p>
+
+<h1>Examples of Failure</h1>
+<p>
+This document is here simply to demonstrate what a failed step looks like.
+</p>
+<pre>
+  1.assert == 2
+</pre>
+<p>
+And this step demonstrates an error.
+</p>
+<pre>
+  raise &quot;just because&quot;
+</pre>
+<p>
+When run with the -v (verbatim) option, <tt>qed</tt> will highlight these
+in red and give a brief error message.
+</p>
+<hr size="1"></hr><p>
+<a href="http://helper.rb">1</a> Helper
 </p>
 
 

data/lib/qed/command.rb

@@ -2,58 +2,127 @@
 
 require 'qed'
 require 'optparse'
+require 'shellwords'
 
 module QED
 
   # = QED Commandline Tool
   #
   class Command
+
+    # Configuration directory.
+    CONFDIR = "{.,}config/qed"
+
+    # Initialize and execute.
     def self.execute
       new.execute
     end
 
-    #
+    # Ouput format.
     attr :format
 
+    # Make sure format is a symbol.
+    def format=(type)
+      @format = type.to_sym
+    end
+
+    # Trace execution?
+    attr :trace
+
+    # Options defined by selected profile.
+    attr :profile
+
+    # Command-line options.
+    attr :options
+
+    # Files to be run.
+    attr :files
+
     #
+    def files=(globs)
+      @files = [globs].flatten
+    end
+
+    #
+    attr_accessor :loadpath
+
+    #
+    attr_accessor :requires
+
+    #
+    attr_accessor :env
+
+    #
+
     def initialize
-      @format = nil
+      @format   = nil
+      @env      = nil
+      @profile  = nil
+      @requires = []
+      @loadpath = []
+      @files    = []
+      @options  = {}
     end
 
     # Instance of OptionParser
+
     def opts
       @opts ||= OptionParser.new do |opt|
 
+        opt.separator("Custom Profiles:") unless profiles.empty?
+
+        profiles.each do |name, value|
+          o = "--#{name}"
+          opt.on(o, "#{name} custom profile") do
+            @profile = name
+          end        
+        end
+
+        opt.separator("Report Options (pick one):")
+
         opt.on('--dotprogress', '-d', "use dot-progress reporter [default]") do
-          @format = :summary
+          @options[:format] = :summary
         end
 
         opt.on('--verbatim', '-v', "use verbatim reporter") do
-          @format = :verbatim
+          @options[:format] = :verbatim
         end
 
         opt.on('--summary', '-s', "use summary reporter") do
-          @format = :summary
+          @options[:format] = :summary
         end
 
         opt.on('--script', "psuedo-reporter") do
-          @format = :script  # psuedo-reporter
+          @options[:script]  # psuedo-reporter
+        end
+
+        opt.separator("Control Options:")
+
+        opt.on('--env', '-e [NAME]', "runtime environment [default]") do |name|
+          @options[:env] = name
+        end
+
+        opt.on('--loadpath', "-I PATH", "add paths to $LOAD_PATH") do |arg|
+          @options[:loadpath] ||= []
+          @options[:loadpath].concat(arg.split(/[:;]/).map{ |dir| File.expand_path(dir) })
         end
 
-        opt.on('--loadpath', "-I", "add paths to $LOAD_PATH") do |arg|
-          libs = arg.split(/[:;]/).map{ |dir| File.expand_path(dir) }
-          libs.each{|dir| $LOAD_PATH.unshift(dir)}
+        opt.on('--require', "-r", "require library") do |arg|
+          @options[:requires] ||= []
+          @options[:requires].concat(arg.split(/[:;]/)) #.map{ |dir| File.expand_path(dir) })
         end
 
-        opt.on('--verbose', '-V', "extra verbose output") do
-          @verbose = true
-          $VERBOSE = true
+        opt.on('--trace', '-t', "show full backtraces for exceptions") do
+          @options[:trace] = true
         end
 
-        opt.on('--debug', "demos will exit on error") do
+        opt.on('--debug', "exit immediately upon raised exception") do
+          $VERBOSE = true # wish this were called $WARN
           $DEBUG = true
         end
 
+        opt.separator("Optional Commands:")
+
         opt.on_tail('--version', "display version") do
           puts "QED #{VERSION}"
           exit
@@ -73,35 +142,24 @@ module QED
     end
 
     #
-    #def load_rc
-    #  if rcfile = Dir['.config/qed{,rc}{,.rb}'].first
-    #    load(rcfile)
-    #  end
-    #end
-
-    # 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 demos
       demo_files
     end
 
     #
+
     def demo_files
-      files = ARGV.map do |pattern|
+      files = self.files
+
+      #if files.empty?
+      #  if File.directory?('test')
+      #    files << 'test/doc{,s}'
+      #    files << 'test/demo{,s}'
+      #  end
+      #end
+
+      files = files.map do |pattern|
         Dir[pattern]
       end.flatten.uniq
 
@@ -113,7 +171,7 @@ module QED
         end
       end
 
-      file = files.flatten.uniq
+      files = files.flatten.uniq
 
       #files = files.select do |file| 
       #  %w{.yml .yaml .rb}.include?(File.extname(file))
@@ -122,38 +180,48 @@ module QED
       files
     end
 
-    #
-    def reporter
-      case format
-      when :dotprogress
-        Reporter::DotProgress.new(reporter_options)
-      when :verbatim
-        Reporter::Verbatim.new(reporter_options)
-      when :summary
-        Reporter::Summary.new(reporter_options)
-      else
-        nil
-      end
-    end
+    # Instance of Runner class.
 
-    #
-    def reporter_options
-      { :verbose => @verbose }
+    def runner
+      Runner.new(demos, :format=>format, :trace=>trace)
     end
 
-    #
-    def runner
-      Runner.new(demos, reporter)
+    # Parse command-line options along with profile options.
+
+    def parse
+      @files = []
+      argv = ARGV.dup
+      opts.parse!(argv)
+      @files.concat(argv)
+
+      if profile
+        args = profiles[profile]
+        argv = Shellwords.shellwords(args)
+        opts.parse!(argv)
+        @files.concat(argv)
+      end
+
+      options.each do |k,v|
+        __send__("#{k}=", v)
+      end
     end
 
-    #
+    # Run demonstrations.
+
     def execute
-      opts.parse!
-      #load_rc
-      #load_helpers
-      case reporter
+      parse
+
+      abort "No documents." if demos.empty?
+
+      prepare_loadpath
+
+      require_libraries
+      require_environment
+
+      # TODO: Remove case, can :script be done with Reporter or do we ne need selectable Runner?
+      case format
       when :script
-        specs.each do |spec|
+        demos.each do |spec|
           puts spec.to_script
         end
       else
@@ -161,6 +229,44 @@ module QED
       end
     end
 
+    # Profile configurations.
+
+    def profiles
+      @profiles ||= (
+        file = Dir["#{CONFDIR}/profile{,s}.{yml,yaml}"].first
+        file ? YAML.load(File.new(file)) : {}
+      )
+    end
+
+    # Add to load path (from -I option).
+
+    def prepare_loadpath
+      loadpath.each{ |dir| $LOAD_PATH.unshift(dir) }
+    end
+
+    # Require libraries (from -r option).
+
+    def require_libraries
+      requires.each{ |file| require(file) }
+    end
+
+    # Require requirement file (from -e option.
+
+    def require_environment
+      if env
+        if file = Dir["#{CONFDIR}/{env,environments}/#{env}.rb"].first
+          require(file)
+        end
+      else
+        if file = Dir["#{CONFDIR}/env.rb"].first
+          require(file)
+        elsif file = Dir["#{CONFDIR}/{env,environments}/default.rb"].first
+          require(file)
+        end
+      end
+    end
+
   end
+
 end