qed 2.9.0 → 2.9.1

data/demo/applique/quote.md

@@ -0,0 +1,8 @@
+## Applique: Quote
+
+This applique simply provide support to `05_quote.md` demo.
+
+    When "we want to make an example out of the following text" do |text|
+      @quote_text = text
+    end
+

data/lib/qed.yml

@@ -1,70 +1,69 @@
 ---
-source:
+revision: 2013
+type: ruby
+sources:
 - var
 authors:
 - name: Trans
   email: transfire@gmail.com
-copyrights:
-- holder: Thomas Sawyer, Rubyworks
-  year: '2006'
-  license: BSD-2-Clause
+organizations: []
 requirements:
 - name: ansi
 - name: brass
-- name: facets
-  version: 2.8+
-- name: courtier
-  groups:
-  - optional
-  development: true
-- name: blankslate
-  groups:
+- version: 2.8+
+  name: facets
+- groups:
   - optional
   - test
   development: true
-- name: ae
-  groups:
+  name: blankslate
+- groups:
   - test
   development: true
-- name: detroit
-  groups:
+  name: ae
+- groups:
   - build
   development: true
-- name: fire
-  groups:
+  name: detroit
+- groups:
   - build
   development: true
-dependencies: []
-alternatives: []
+  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:
-- uri: git://github.com/rubyworks/qed.git
+- name: upstream
   scm: git
-  name: upstream
-resources:
-- uri: http://rubyworks.github.com/qed
-  name: home
-  type: home
-- uri: http://github.com/rubyworks/qed
-  name: code
-  type: code
-- uri: http://groups.google.com/groups/rubyworks-mailinglist
-  name: mail
-  type: mail
-- uri: http://github.com/rubyworks/qed/issues
-  name: bugs
-  type: bugs
-extra: {}
-load_path:
-- lib
-revision: 0
+  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.0
+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: '2012-04-14'
+date: '2013-02-18'

data/lib/qed/cli.rb

@@ -1,12 +1,10 @@
 if RUBY_VERSION < '1.9'
-  require 'qed/rc' unless ENV['norc']
   require 'qed/configure'
   require 'qed/cli/qed'
   require 'qed/cli/qedoc'
 else
-  require_relative 'rc' unless ENV['norc']
   require_relative 'configure'
-  require_relative('cli/qed')
-  require_relative('cli/qedoc')
+  require_relative 'cli/qed'
+  require_relative 'cli/qedoc'
 end
 

data/lib/qed/cli/qed.rb

@@ -17,6 +17,33 @@ module QED
     #
     # Command line interface for running demos.
     #
+    # When running `qed` on the command line tool, QED can use
+    # either a automatic configuration file, via the RC library,
+    # or setup configuration via an explicitly required file.
+    #
+    # Using a master configuraiton file, add a `config :qed` entry.
+    # For example:
+    #
+    #     config :qed, :profile=>:simplecov do
+    #       require 'simplecov'
+    #       SimpleCov.start do
+    #         coverage_dir 'log/coverage'
+    #       end
+    #     end
+    #
+    # To not use RC, just create a requirable file such as `config/qed-coverage.rb`
+    #
+    #     QED.configure do |qed|
+    #       require 'simplecov'
+    #       SimpleCov.start do
+    #         coverage_dir 'log/coverage'
+    #       end
+    #     end
+    #
+    # Then when running qed use:
+    #
+    #     $ qed -r ./config/qed-coverage.rb
+    #
     def self.cli(*argv)
       require 'optparse'
       require 'shellwords'
@@ -25,12 +52,12 @@ module QED
       # (actually, this is really not a problem anymore, but we'll leave it for now)
       require 'qed/session'
 
-      # If RC config file is available.
-      #RC.commit_configuration
+      Utils.load_config
 
       options = cli_parse(argv)
 
-      session  = Session.new(options)
+      settings = Settings.new(options)
+      session  = Session.new(settings)
       success  = session.run
 
       exit -1 unless success

data/lib/qed/evaluator.rb

@@ -105,6 +105,9 @@ module QED
       advise!(:after_step, step)
     end
 
+    # TODO: We may deprecate link helpers --it's probably not a good idea
+    #       to have per-demo rules any way.
+
     # TODO: Not sure how to handle loading links in --comment runner mode.
 
     # TODO: Should scope be reused by imported demo ?
@@ -114,7 +117,7 @@ module QED
     #
     # @macro step
     def evaluate_links(step)
-      step.text.scan(/\[qed:\/\/(.*?)\]/) do |match|
+      step.text.scan(/(?:\(|\[)qed:\/\/(.*?)(?:\)|\])/) do |match|
         file = $1
         # relative to demo demo
         if File.exist?(File.join(@demo.directory,file))

data/lib/qed/reporter/abstract.rb

@@ -257,7 +257,7 @@ module Reporter
       vars 
     end
 
-    #
+    # TODO: Use global standard for backtrace exclusions.
     INTERNALS = /(lib|bin)[\\\/](qed|ae)/
 
     #

data/lib/qed/session.rb

@@ -3,6 +3,13 @@ module QED
   require 'qed/settings'
   require 'qed/demo'
 
+  def self.run!(name=nil, &block)
+    configure(name, &block) if block
+    session  = Session.new(:profile=>name)
+    success  = session.run
+    exit -1 unless success
+  end
+
   # The Session class encapsulates a set of demonstrations 
   # and the procedure for looping through them and running
   # each in turn.
@@ -85,7 +92,7 @@ module QED
     #  QED.config
     #end
 
-    # TODO: Ultimately use Plugin library to support custom reporters?
+    # TODO: Ultimately use a plugin library to support custom reporters?
 
     # Require all reporters.
     def require_reporters
@@ -158,7 +165,7 @@ module QED
 
     # Set $ASSERTION_COUNTS to zero point.
     def reset_assertion_counts
-      $ASSERTION_COUNTS = Hash.new{|h,k| h[k] = 0 }
+      $ASSERTION_COUNTS = Hash.new{ |h,k| h[k] = 0 }
     end
 
     # Add to load path (from -I option).

data/lib/qed/settings.rb

@@ -1,36 +1,10 @@
 require 'qed/configure'
+require 'qed/utils'
 
 module QED
 
   # Settings ecapsulates setup configuration for running QED.
   #
-  # When running `qed` on the command line tool, QED can use
-  # either a automatic configuration file, via the RC library,
-  # or setup configuration via an explicitly required file.
-  #
-  # Using a master configuraiton file, add a `config :qed` entry.
-  # For example:
-  #
-  #     config :qed, :simplecov, :preset=>true do
-  #       require 'simplecov'
-  #       SimpleCov.start do
-  #         coverage_dir 'log/coverage'
-  #       end
-  #     end
-  #
-  # To not use RC, just create a requirable file such as `config/qed-coverage.rb`
-  #
-  #     QED.configure do |qed|
-  #       require 'simplecov'
-  #       SimpleCov.start do
-  #         coverage_dir 'log/coverage'
-  #       end
-  #     end
-  #
-  # Then when running qed use:
-  #
-  #     $ qed -r ./config/qed-coverage.rb
-  #
   class Settings
 
     require 'tmpdir'
@@ -40,24 +14,18 @@ module QED
     # will be searched.
     DEFAULT_FILES = ['qed', 'demo', 'spec']
 
-    # Glob pattern used to search for project's root directory.
-    ROOT_PATTERN = '{.map,.ruby,.git/,.hg/,_darcs/}'
-
-    # Home directory.
-    HOME = File.expand_path('~')
-
     # Directory names to omit from automatic selection.
     OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
 
     #
     # Initialize new Settings instance.
     #
-    def initialize(options={})
+    def initialize(options={}, &block)
       initialize_defaults
 
       @profile = (options.delete(:profile) || default_profile).to_s
 
-      load_profile
+      load_profile(&block)
 
       options.each do |key, val|
         send("#{key}=", val) if val
@@ -131,7 +99,7 @@ module QED
     # a Proc object in a hash b/c different configuration systems
     # can be used.
     #
-    def load_profile
+    def load_profile(&block)
       config = QED.profiles[@profile]
       config.call(self) if config
     end
@@ -155,7 +123,7 @@ module QED
     # Project's root directory.
     #
     def root
-      @root ||= find_root
+      Utils.root
     end
 
     #
@@ -171,7 +139,7 @@ module QED
     def temporary_directory
       @temporary_directory ||= (
         if rootless?
-          system_tmpdir
+          Utils.system_tmpdir
         else
           File.join(root_directory, 'tmp', 'qed')
         end
@@ -214,81 +182,6 @@ module QED
 
   private
 
-    # TODO: find a way to not need $ROOT global.
-
-    #
-    # Locate project's root directory. This is done by searching upward
-    # in the file heirarchy for the existence of one of the following:
-    #
-    #   .ruby
-    #   .git/
-    #   .hg/
-    #   _darcs/
-    #   .qed
-    #   .qed.rb
-    #   qed.rb
-    #
-    # Failing to find any of these locations, resort to the fallback:
-    # 
-    #   lib/
-    #
-    # If that isn't found, then returns a temporary system location.
-    # and sets `rootless` to true.
-    #
-    def find_root(path=nil)
-      return ($ROOT = system_tmpdir) if @rootless
-
-      path = File.expand_path(path || Dir.pwd)
-      path = File.dirname(path) unless File.directory?(path)
-
-      root = lookup(ROOT_PATTERN, path) || lookup(CONFIG_PATTERN, path)
-      return root if root
-
-      #root = lookup(path, '{qed,demo,spec}/')
-      #return root if root
-
-      root = lookup('lib/', path)
-
-      if !root
-        warn "QED is running rootless."
-        system_tmpdir
-        @rootless = true
-      else
-        root
-      end
-
-      $ROOT = root
-
-      #abort "QED failed to resolve project's root location.\n" +
-      #      "QED looks for following entries to identify the root:\n" +
-      #      ROOT_PATTERN +
-      #      "Please add one of them to your project to proceed."
-    end
-
-    # TODO: Use Dir.ascend from Ruby Facets ?
-
-    #
-    # Lookup path +glob+, searching each higher directory
-    # in turn until just before the users home directory
-    # is reached or just before the system's root directory.
-    #
-    def lookup(glob, path=Dir.pwd)
-      until path == HOME or path == '/' # until home or root
-        mark = Dir.glob(File.join(path,glob), File::FNM_CASEFOLD).first
-        return path if mark
-        path = File.dirname(path)
-      end
-    end
-
-    #
-    # System-wide temporary directory for QED executation.
-    #
-    def system_tmpdir
-      @system_tmpdir ||= (
-        File.join(Dir.tmpdir, 'qed', File.basename(Dir.pwd), Time.new.strftime("%Y%m%d%H%M%S"))
-      )
-    end
-
     # TODO: Support .map in future ?
 
     ##
@@ -317,15 +210,6 @@ module QED
     #  config.exec
     #end
 
-    #
-    #def load_profile_from_file(file)
-    #  if File.exist?(file)
-    #    instance_eval(File.read(file), file)
-    #  else
-    #    # raise "no profile -- #{profile}"
-    #  end
-    #end
-
   end
 
 end

data/lib/qed/utils.rb

@@ -0,0 +1,125 @@
+module QED
+
+  # Glob pattern used to search for project's root directory.
+  ROOT_PATTERN = '{.ruby*,.git/,.hg/,_darcs/}'
+
+  # Glob pattern for standard config file.
+  CONFIG_PATTERN = '{etc/qed.rb,config/qed.rb,Qedfile,.qed}'
+
+  # Home directory.
+  HOME = File.expand_path('~')
+
+  #
+  module Utils
+    extend self
+
+    #
+    def load_config
+      load_etc unless ENV['noetc']
+      load_rc  unless ENV['norc']
+    end
+
+    #
+    def load_rc
+      rc_file= File.join(root, '.rubyrc')
+      if File.exist?(rc_file)
+        begin
+          require 'rc/api'
+          RC.profile_switch 'qed', '-p', '--profile'
+          RC.configure 'qed' do |config|
+            QED.configure(config.profile, &config)
+          end
+        rescue LoadError
+        end
+      end
+    end
+
+    #
+    def load_etc
+      file = Dir.glob(File.join(root, CONFIG_PATTERN)).first
+      if file
+        load file
+      end
+    end
+
+    #
+    def root
+      @root ||= find_root
+    end
+
+    # TODO: find a way to not need $ROOT global.
+
+    #
+    # Locate project's root directory. This is done by searching upward
+    # in the file heirarchy for the existence of one of the following:
+    #
+    #   .ruby
+    #   .git/
+    #   .hg/
+    #   _darcs/
+    #   .qed
+    #   .qed.rb
+    #   qed.rb
+    #
+    # Failing to find any of these locations, resort to the fallback:
+    # 
+    #   lib/
+    #
+    # If that isn't found, then returns a temporary system location.
+    # and sets `rootless` to true.
+    #
+    def find_root(path=nil)
+      return ($ROOT = system_tmpdir) if @rootless
+
+      path = File.expand_path(path || Dir.pwd)
+      path = File.dirname(path) unless File.directory?(path)
+
+      root = lookup(ROOT_PATTERN, path) || lookup(CONFIG_PATTERN, path)
+      return root if root
+
+      #root = lookup(path, '{qed,demo,spec}/')
+      #return root if root
+
+      root = lookup('lib/', path)
+
+      if !root
+        warn "QED is running rootless."
+        system_tmpdir
+        @rootless = true
+      else
+        root
+      end
+
+      $ROOT = root
+
+      #abort "QED failed to resolve project's root location.\n" +
+      #      "QED looks for following entries to identify the root:\n" +
+      #      ROOT_PATTERN +
+      #      "Please add one of them to your project to proceed."
+    end
+
+    #
+    # Lookup path +glob+, searching each higher directory
+    # in turn until just before the users home directory
+    # is reached or just before the system's root directory.
+    #
+    def lookup(glob, path=Dir.pwd)
+      until path == HOME or path == '/' # until home or root
+        mark = Dir.glob(File.join(path,glob), File::FNM_CASEFOLD).first
+        return path if mark
+        path = File.dirname(path)
+      end
+    end
+
+    #
+    # System-wide temporary directory for QED executation.
+    #
+    def system_tmpdir
+      @system_tmpdir ||= (
+        File.join(Dir.tmpdir, 'qed', File.basename(Dir.pwd), Time.new.strftime("%Y%m%d%H%M%S"))
+      )
+    end
+
+  end
+
+end