qed 2.8.2 → 2.8.3

data/.ruby

@@ -13,6 +13,7 @@ requirements:
 - name: facets
   version: 2.8+
 - name: brass
+- name: confection
 - name: detroit
   groups:
   - build
@@ -40,10 +41,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.2
-scm_uri: http://github.com/rubyworks/qed/blob/master/
+version: 2.8.3
 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-03-07'
+date: '2012-03-14'

data/HISTORY.rdoc

@@ -1,5 +1,23 @@
 = RELEASE HISTORY
 
+== 2.8.3 | 2012-03-14
+
+What a difference a week makes ;) The Confection library has been substantially
+improved and if that trend contiunes at all then I think it will be well worth
+supporting. So with this release QED will again move configuration handling
+over to Confection. Jump over to the Confection project to learn how to use it.
+In short, this release reverts the previous release. Along with this change,
+profiles are now specified via the `-p`/`--profile` command line option instead
+of specialized options.
+
+Changes:
+
+* Use Confection library for configuration.
+* Use `-p`/`--profile` to select configuration profile.
+* Use `config='none'` environment variable to circumvent Confection.
+* Deprecated use of `.map` configuration redirection file.
+
+
 == 2.8.2 | 2012-03-07
 
 This release simply reverts the configuration file back to an

data/README.rdoc

@@ -115,9 +115,9 @@ of running, such as <code>Before :each</code> or <code>After :all</code>,
 and *pattern advice* which are used to match against descriptive
 phrases in the QED demos. An example would be:
 
-  When "a new round is started" do
-    @round = []
-  end
+    When "a new round is started" do
+      @round = []
+    end
 
 So that whenever the phrase "a new round is started" appears in a demo,
 the @round instance variable with be reset to an empty array.
@@ -126,11 +126,31 @@ 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 {Confection}[http://rubyworks.github.com/confection] library to
+handle 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 `Confile`:
+
+    config :qed, :profile=>:coverage do
+      require 'simplecov'
+      SimpleCov.start do
+        coverage_dir 'log/coverage'
+      end
+    end
+
+Or omit the `config` method and just add the block's code to `task/qed-coverage.rb`.
+Either approch makes the `coverage` profile available to the `qed` command.
+
+    $ qed -p coverage
+
 === Generating Documentation
 
 To generate documentation from QED documents, use the +qedoc+ command.
 
-  $ qedoc --output doc/qedoc --title "Example" demo/*.rdoc
+    $ 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
@@ -144,13 +164,20 @@ on the use of these commands.
 
 QED depends on the following external libraries:
 
-  * AE     - Assertions Framework
-  * ANSI   - ANSI Color Codes
-  * Facets - Core Extensions
+* {BRASS}[http://rubyworks.github.com/brass] - Assertions System
+* {ANSI}[http://rubyworks.github.com/ansi] - ANSI Color Codes
+* {Confection}[http://rubyworks.github.com/confection] - Project Tool 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
+
+Install these individually and require them in your applique to use.
+
 
 == Copyrights
 
@@ -161,3 +188,4 @@ Copyright (c) 2009 Rubyworks, Thomas Sawyer
 BSD 2 Clause License
 
 See COPYING.rdoc for details.
+

data/lib/qed.yml

@@ -13,6 +13,7 @@ requirements:
 - name: facets
   version: 2.8+
 - name: brass
+- name: confection
 - name: detroit
   groups:
   - build
@@ -40,10 +41,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.2
-scm_uri: http://github.com/rubyworks/qed/blob/master/
+version: 2.8.3
 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-03-07'
+date: '2012-03-14'

data/lib/qed/cli/qed.rb

@@ -21,8 +21,8 @@ module QED
       #  exit -1
       #end
 
-      session = Session.new(files, options)
-      success = session.run
+      session  = Session.new(files, options)
+      success  = session.run
 
       exit -1 unless success
     end
@@ -33,16 +33,8 @@ module QED
       options_parser = OptionParser.new do |opt|
         opt.banner = "Usage: qed [options] <files...>"
 
-        opt.separator("Custom Profiles:") unless settings.profiles.empty?
-
-        settings.profiles.each do |name, value|
-          o = "--#{name}"
-          opt.on(o, "#{name} custom profile") do
-            options[:profile] = name.to_sym
-          end
-        end
-
         opt.separator("Report Formats (pick one):")
+
         #opt.on('--dotprogress', '-d', "use dot-progress reporter [default]") do
         #  options[:format] = :dotprogress
         #end
@@ -66,12 +58,13 @@ module QED
         end
 
         opt.separator("Control Options:")
+
+        opt.on('-p', '--profile NAME', "load runtime profile") do |name|
+          options[:profile] = name.to_sym
+        end
         opt.on('--comment', '-c', "run comment code") do
           options[:mode] = :comment
         end
-        opt.on('--profile', '-p NAME', "load runtime profile") do |name|
-          options[:profile] = name
-        end
         opt.on('--loadpath', "-I PATH", "add paths to $LOAD_PATH") do |paths|
           options[:loadpath] = paths.split(/[:;]/).map{|d| File.expand_path(d)}
         end
@@ -81,10 +74,7 @@ module QED
         opt.on('--rooted', '-R', "run from project root instead of temporary directory") do
           options[:rooted] = true
         end
-        # COMMIT:
-        #   The qed command --trace option takes a count.
-        #   Use 0 to mean all.
-        opt.on('--trace', '-t [COUNT]', "show full backtraces for exceptions") do |cnt|
+        opt.on('--trace', '-t [COUNT]', "number of backtraces for exceptions (0 for all)") do |cnt|
           #options[:trace] = true
           ENV['trace'] = cnt
         end
@@ -92,10 +82,11 @@ module QED
           $VERBOSE = true # wish this were called $WARN!
         end
         opt.on('--debug', "exit immediately upon raised exception") do
-          $DEBUG   = true
+          $DEBUG = true
         end
 
         opt.separator("Optional Commands:")
+
         opt.on_tail('--version', "display version") do
           puts "QED #{QED::VERSION}"
           exit
@@ -106,18 +97,34 @@ module QED
         end
         opt.on_tail('--help', '-h', "display this help message") do
           puts opt
-          exit
+
+          unless settings.profiles.empty?
+            puts "Available Profiles:"
+            require 'confection'
+            Confection.profiles(:qed).each do |name|
+              puts "    #{name}"
+            end
+          end
+
+          exit -1
         end
       end
+
       options_parser.parse!(argv)
+
       return argv, options
     end
 
+    #
+    #def self.profiles
+    #  Settings.profiles
+    #end
+
     # TODO: Pass to Session class, instead of acting global.
     # It is used at the class level to get profiles for the cli.
-    def self.settings
-      @settings ||= Settings.new
-    end
+    #def self.settings
+    #  @settings ||= Settings.new([])
+    #end
 
   end
 

data/lib/qed/session.rb

@@ -9,67 +9,65 @@ module QED
   #
   class Session
 
-    # If files are not specified than these directories 
-    # will be searched.
-    DEFAULT_FILES = ['qed', 'demo', 'spec']
-
     # Default recognized demos file types.
     DEMO_TYPES = %w{qed rdoc md markdown}
 
     #
     CODE_TYPES = %w{rb}
 
-    # Directory names to omit from automatic selection.
-    OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
+    # Returns instance of Settings class.
+    attr :settings
+
+    # New Session
+    def initialize(files, options={})
+      require_reporters
+
+      @settings = Settings.new(files, options)
+    end
 
     # Demonstration files (or globs).
-    attr_reader :files
+    def files
+      settings.files
+    end
 
     # File patterns to omit.
-    attr_accessor :omit
+    def omit
+      settings.omit
+    end
 
     # Output format.
-    attr_accessor :format
+    def format
+      settings.format
+    end
 
     # Trace execution?
-    attr_accessor :trace
+    def trace?
+      settings.trace
+    end
 
     # Parse mode.
-    attr_accessor :mode
+    def mode
+      settings.mode
+    end
 
     # Paths to be added to $LOAD_PATH.
-    attr_reader :loadpath
+    def loadpath
+      settings.loadpath
+    end
 
     # Libraries to be required.
-    attr_reader :requires
+    def requires
+      settings.requires
+    end
 
     # Operate from project root?
-    attr_accessor :rooted
+    def rooted
+      settings.rooted
+    end
 
     # Selected profile.
-    attr_accessor :profile
-
-    # Returns instance of Settings class.
-    attr :settings
-
-    # New Session
-    def initialize(files, options={})
-      require_reporters
-
-      @files = [files].flatten.compact
-      @files = [DEFAULT_FILES.find{ |d| File.directory?(d) }] if @files.empty?
-      @files = @files.compact
-
-      @format    = options[:format]   || :dot
-      @trace     = options[:trace]    || false
-      @mode      = options[:mode]     || nil
-      @profile   = options[:profile]  || :default
-      @loadpath  = options[:loadpath] || ['lib']
-      @requires  = options[:requires] || []
-
-      @omit      = OMIT_PATHS  # TODO: eventually make configurable
-
-      @settings  = Settings.new(options)
+    def profile
+      settings.profile
     end
 
     #
@@ -95,7 +93,7 @@ module QED
     def reporter
       @reporter ||= (
         name = Reporter.constants.find{ |c| /#{format}/ =~ c.to_s.downcase }
-        Reporter.const_get(name).new(:trace => trace)
+        Reporter.const_get(name).new(:trace => trace?)
       )
     end
 

data/lib/qed/settings.rb

@@ -11,7 +11,7 @@ module QED
   # In this file special configuration setups can be placed to automatically
   # effect QED execution, in particular optional profiles can be defined.
   #
-  #     profile :coverage do
+  #     if ENV['cover']
   #       require 'simplecov'
   #       SimpleCov.start do
   #         coverage_dir 'log/coverage'
@@ -24,36 +24,117 @@ module QED
   #
   class Settings
 
+    #
+    # Because QED usese the Confection library, but Confection also
+    # uses QED for testing, a special configuration exception needed
+    # be sliced out so Confection's test could run without QED using
+    # it. We handle this via a environment variable `config`. Set
+    # it to 'none' to deactivate the use of Confection.
+    #
+    def self.configless?
+      ENV['config'] == 'none'
+    end
+
     require 'tmpdir'
     require 'fileutils'
 
+    require 'confection' unless configless?
+
+    # If files are not specified than these directories 
+    # will be searched.
+    DEFAULT_FILES = ['qed', 'demo', 'spec']
+
     # QED support configuration file mapping.
-    MAP_FILE = '.map'
+    #MAP_FILE = '.map'
 
     # Glob pattern used to search for project's root directory.
-    ROOT_PATTERN = '{.map,.ruby,.git/,.hg/,_darcs/,.qed,.qed.rb,qed.rb,task/qed.rb}'
+    ROOT_PATTERN = '{.map,.ruby,.git/,.hg/,_darcs/}'
 
-    # Glob pattern used to find QED configuration file in root directory.
-    CONFIG_PATTERN = '{task/qed.rb,qed.rb,.qed,.qed.rb}'
+    # Glob pattern used to find QED configuration file relative to root directory.
+    CONFIG_PATTERN = '{.,,task/}qed,qedfile{,.rb}'
 
     # Home directory.
     HOME = File.expand_path('~')
 
+    # Directory names to omit from automatic selection.
+    OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
+
     #
     #
     #
-    def initialize(options={})
+    def initialize(files, options={})
+      @files = [files].flatten.compact
+      @files = [DEFAULT_FILES.find{ |d| File.directory?(d) }] if @files.empty?
+      @files = @files.compact
+
+      @format     = options[:format]     || :dot
+      @trace      = options[:trace]      || false
+      @mode       = options[:mode]       || nil
+      @profile    = options[:profile]    || :default
+      @loadpath   = options[:loadpath]   || ['lib']
+      @requires   = options[:requires]   || []
+
+      @omit      = OMIT_PATHS  # TODO: eventually make configurable
+
       @rootless = options[:rootless]
-      @profiles = {}
+      #@profiles = {}
 
       @root = @rootless ? system_tmpdir : find_root
 
       # Set global. TODO: find away to not need this ?
       $ROOT = @root
 
-      if config_file
-        instance_eval(File.read(config_file), config_file)
-      end
+      initialize_configuration
+
+      #profile = options[:profile]
+      #confection(:qed, profile)
+    end
+
+    #
+    # Because QED uses the Confection library, but Confection also
+    # uses QED for testing, a special configuration exception needed
+    # be sliced out so Confection's demos could run without QED using
+    # it. We handle this via a `.qed` config file. Add this file
+    # to a project and it will deactivate the use of Confection,
+    # and load the contents of the file instead.
+    #
+    def initialize_configuration
+      require 'confection' unless configless?
+    end
+
+    # Demonstration files (or globs).
+    attr_reader :files
+
+    # File patterns to omit.
+    attr_accessor :omit
+
+    # Output format.
+    attr_accessor :format
+
+    # Trace execution?
+    attr_accessor :trace
+
+    # Parse mode.
+    attr_accessor :mode
+
+    # Paths to be added to $LOAD_PATH.
+    attr_reader :loadpath
+
+    # Libraries to be required.
+    attr_reader :requires
+
+    # Operate from project root?
+    attr_accessor :rooted
+
+    # Selected profile.
+    attr_accessor :profile
+
+    #
+    # If Environment varible is set to 'none' then COnfection will not be
+    # used for configuration.
+    #
+    def configless?
+      self.class.configless?
     end
 
     #
@@ -107,6 +188,8 @@ module QED
     #
     # Define a profile.
     #
+    # @deprecated Confection library is used instead.
+    #
     # @param [#to_s] name
     #   Name of profile.
     #
@@ -114,10 +197,21 @@ module QED
     #
     # @return [Proc] The procedure.
     #
-    def profile(name, &block)
-      @profiles[name.to_s] = block
+    #def profile(name, &block)
+    #  raise "The #profile method is deprecated."
+    #  #@profiles[name.to_s] = block
+    #end
+
+    #
+    # Profiles are collected from the Confection library, unless 
+    # confection is deactivated via the override file.
+    # 
+    def profiles
+      return [] if configless?
+      Confection.profiles(:qed)
     end
 
+=begin
     #
     # Keeps a list of defined profiles.
     #
@@ -146,6 +240,18 @@ module QED
       #  require(file)
       #end
     end
+=end
+
+    #
+    # Load QED configuration profile. QED configurations are defined
+    # via standards of the Confection library, unless otherwise
+    # deativated via the `.qed` file.
+    #
+    def load_profile(profile)
+      return if config_override
+      config = confection(:qed, profile.to_sym)
+      config.exec
+    end
 
     #
     # Locate project's root directory. This is done by searching upward
@@ -171,7 +277,7 @@ module QED
       path = File.expand_path(path || Dir.pwd)
       path = File.dirname(path) unless File.directory?(path)
 
-      root = lookup(ROOT_PATTERN, path)
+      root = lookup(ROOT_PATTERN, path) || lookup(CONFIG_PATTERN, path)
       return root if root
 
       #root = lookup(path, '{qed,demo,spec}/')
@@ -220,32 +326,31 @@ module QED
     #
     # Lookup, cache and return QED config file.
     #
-    def config_file
-      @config_file ||= (
-        glob = file_map['qed'] || CONFIG_PATTERN
-        Dir.glob(File.join(root_directory,glob)).first
+    def config_override
+      @config_override ||= (
+        Dir.glob(File.join(root_directory, '.qed')).first
       )
     end
 
-    #
-    # Return cached file map from a project's `.map` file, if it exists.
-    #
-    def file_map
-      @file_map ||= (
-        if File.exist?(map_file)
-          YAML.load_file(map_file)
-        else
-          {}
-        end
-      )
-    end
+    ##
+    ## Return cached file map from a project's `.map` file, if it exists.
+    ##
+    #def file_map
+    #  @file_map ||= (
+    #    if File.exist?(map_file)
+    #      YAML.load_file(map_file)
+    #    else
+    #      {}
+    #    end
+    #  )
+    #end
 
-    #
-    # Lookup, cache and return `.map` map file.
-    #
-    def map_file
-      @_map_file ||= File.join(root_directory,MAP_FILE)
-    end
+    ##
+    ## Lookup, cache and return `.map` map file.
+    ##
+    #def map_file
+    #  @_map_file ||= File.join(root_directory,MAP_FILE)
+    #end
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qed
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &21715680 !ruby/object:Gem::Requirement
+  requirement: &32221080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21715680
+  version_requirements: *32221080
 - !ruby/object:Gem::Dependency
   name: facets
-  requirement: &21714660 !ruby/object:Gem::Requirement
+  requirement: &32219960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *21714660
+  version_requirements: *32219960
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &21736760 !ruby/object:Gem::Requirement
+  requirement: &32234580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21736760
+  version_requirements: *32234580
+- !ruby/object:Gem::Dependency
+  name: confection
+  requirement: &32233240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *32233240
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &21735960 !ruby/object:Gem::Requirement
+  requirement: &32232100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21735960
+  version_requirements: *32232100
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &21734980 !ruby/object:Gem::Requirement
+  requirement: &32231100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21734980
+  version_requirements: *32231100
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'