qed 2.8.5 → 2.8.6

data/.confile.rb

@@ -0,0 +1,24 @@
+# Confection based configuration.
+
+config :qed do
+  # default configuration
+end
+
+config :qed, :profile=>:simplecov do
+  require 'simplecov'
+  SimpleCov.start do
+    coverage_dir 'log/coverage'
+    #add_group "Label", "lib/qed/directory"
+  end
+end
+
+config :qed, :profile=>:example do
+  puts ("*" * 78)
+  puts
+
+  at_exit do
+    puts
+    puts ("*" * 78)
+  end
+end
+

data/.ruby

@@ -41,7 +41,7 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.5
+version: 2.8.6
 name: qed
 webcvs: http://github.com/rubyworks/qed/blob/master/
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework

data/HISTORY.rdoc

@@ -1,5 +1,26 @@
 = RELEASE HISTORY
 
+== 2.8.6 | 2012-03-15
+
+This release simply make the configuration more versitile by supporting
+Confection, task directory and traditional `.qed` configuration.
+
+Changes:
+
+* Support variety of configuration systems.
+
+
+== 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 
+reusable.
+
+Changes:
+
+* Include configuration files in distribution.
+
+
 == 2.8.4 | 2012-03-14 18:06
 
 Just a fix of a method that should have been renamed. Nothing to see here.

data/lib/qed.yml

@@ -41,7 +41,7 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.5
+version: 2.8.6
 name: qed
 webcvs: http://github.com/rubyworks/qed/blob/master/
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework

data/lib/qed/cli/qed.rb

@@ -9,6 +9,15 @@ module QED
 
   class Session
 
+    #
+    # Session settings are passed to `Session.new`.
+    #
+    def self.settings
+      @settings ||= Settings.new
+    end
+
+    #
+    # Command line interface for running demos.
     #
     def self.cli(*argv)
       require 'optparse'
@@ -21,13 +30,15 @@ module QED
       #  exit -1
       #end
 
-      session  = Session.new(files, options)
+      session  = Session.new(settings)
       success  = session.run
 
       exit -1 unless success
     end
 
-    # Instance of OptionParser
+    # 
+    # Build an instance of OptionParser.
+    #
     def self.cli_parse(argv)
       options = {}
       options_parser = OptionParser.new do |opt|
@@ -39,10 +50,10 @@ module QED
         #  options[:format] = :dotprogress
         #end
         opt.on('--verbatim', '-v', "shortcut for verbatim reporter") do
-          options[:format] = :verbatim
+          settings.format = :verbatim
         end
         opt.on('--tapy', '-y', "shortcut for TAP-Y reporter") do
-          options[:format] = :tapy
+          settings.format = :tapy
         end
         #opt.on('--bullet', '-b', "use bullet-point reporter") do
         #  options[:format] = :bullet
@@ -54,25 +65,25 @@ module QED
         #  options[:format] = :script  # psuedo-reporter
         #end
         opt.on('--format', '-f FORMAT', "use custom reporter") do |format|
-          options[:format] = format.to_sym
+          settings.format = format.to_sym
         end
 
         opt.separator("Control Options:")
 
         opt.on('-p', '--profile NAME', "load runtime profile") do |name|
-          options[:profile] = name.to_sym
+          settings.profile = name.to_sym
         end
         opt.on('--comment', '-c', "run comment code") do
-          options[:mode] = :comment
+          settings.mode = :comment
         end
         opt.on('--loadpath', "-I PATH", "add paths to $LOAD_PATH") do |paths|
-          options[:loadpath] = paths.split(/[:;]/).map{|d| File.expand_path(d)}
+          settings.loadpath = paths.split(/[:;]/).map{|d| File.expand_path(d)}
         end
         opt.on('--require', "-r LIB", "require library") do |paths|
-          options[:requires] = paths.split(/[:;]/)
+          settings.requires = paths.split(/[:;]/)
         end
         opt.on('--rooted', '-R', "run from project root instead of temporary directory") do
-          options[:rooted] = true
+          settings.rooted = true
         end
         opt.on('--trace', '-t [COUNT]', "number of backtraces for exceptions (0 for all)") do |cnt|
           #options[:trace] = true
@@ -101,8 +112,9 @@ module QED
           unless settings.profiles.empty?
             puts "Available Profiles:"
             require 'confection'
-            Confection.profiles(:qed).each do |name|
-              puts "    #{name}"
+            settings.profiles.each do |name|
+              next if name.strip == ''
+              puts "    -p #{name}"
             end
           end
 
@@ -115,17 +127,6 @@ module QED
       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
-
   end
 
 end

data/lib/qed/session.rb

@@ -19,10 +19,16 @@ module QED
     attr :settings
 
     # New Session
-    def initialize(files, options={})
+    def initialize(settings, options={})
       require_reporters
 
-      @settings = Settings.new(files, options)
+      case settings
+      when Settings
+        @settings = settings
+      else
+        options[:files] = settings
+        @settings = Settings.new(options)
+      end
     end
 
     # Demonstration files (or globs).

data/lib/qed/settings.rb

@@ -2,7 +2,10 @@ module QED
 
   # Settings ecapsulates setup code for running QED.
   #
-  # By convention, configuration for QED is placed in `task/qed.rb`.
+  # QED can use Confection-based configuration, if a Confile is present.
+  #
+  # QED also supports configuration files placed in `task/<profile>.qed`.
+  #
   # Configuration may also be placed at project root level in `qed.rb`,
   # or if you're old-school, a `.qed` hidden file can still be used. If you
   # don't like any of these choices, QED supports configuration file mapping
@@ -24,22 +27,9 @@ 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']
@@ -60,50 +50,75 @@ module QED
     OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
 
     #
+    # Initialize new Settings instance.
     #
-    #
-    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]   || []
+    def initialize(options={})
+      initialize_defaults
+      initialize_configuration
 
-      @omit      = OMIT_PATHS  # TODO: eventually make configurable
+      options.each do |key, val|
+        send("#{key}=", val) if val
+      end
+    end
 
-      @rootless = options[:rootless]
-      #@profiles = {}
+    #
+    def initialize_defaults
+      @files      = nil
+      @format     = :dot
+      @trace      = false
+      @mode       = nil
+      @profile    = ENV['profile'] || :default
+      @loadpath   = ['lib']
+      @requires   = []
+      @omit       = OMIT_PATHS  # TODO: eventually make configurable
+      @rootless   = false
+    end
 
-      @root = @rootless ? system_tmpdir : find_root
+    #
+    # QED can use either the Confection library for configuration,
+    # task-style configuration files in the form of `task/<profile>.qed`,
+    # or a traditional master `.qed` file.
+    #
+    # Note, that setting `ENV['confectionless']` will force Confection
+    # not to be used. This is used by the Confection library so it can
+    # run QED demos too.
+    #
+    def initialize_configuration
+      @profiles = {}
 
-      # Set global. TODO: find away to not need this ?
-      $ROOT = @root
+      if confection_file && !ENV['confectionless']
+        require 'confection'
+        Confection.profiles(:qed).each do |name|
+          @profiles[name.to_s] = lambda{ load_profile_from_confection(name) }
+        end
+      end
 
-      initialize_configuration
+      Dir.glob(File.join(root, 'task/*.qed')).map do |file|
+        name = File.basename(file).chomp('.qed')
+        @profiles[name.to_s] = lambda{ load_profile_from_file(file) }
+      end
 
-      #profile = options[:profile]
-      #confection(:qed, profile)
+      Dir.glob(File.join(root, '{.qed,.qed.rb,qed.rb,Qedfile}')).map do |file|
+        @profiles[nil] = lambda{ load_profile_from_file(file) }
+      end
     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?
+    # Lookup Confection config file.
+    def confection_file
+      Dir.glob(File.join(root, '{,.}confile{.rb,}'), File::FNM_CASEFOLD).first
     end
 
     # Demonstration files (or globs).
-    attr_reader :files
+    def files
+      @files ||= (
+        [DEFAULT_FILES.find{ |d| File.directory?(d) }].compact
+      )
+    end
+
+    #
+    def files=(files)
+      @files = Array(files).flatten.compact
+    end
 
     # File patterns to omit.
     attr_accessor :omit
@@ -118,25 +133,20 @@ module QED
     attr_accessor :mode
 
     # Paths to be added to $LOAD_PATH.
-    attr_reader :loadpath
+    attr_accessor :loadpath
 
     # Libraries to be required.
-    attr_reader :requires
+    attr_accessor :requires
 
     # Operate from project root?
     attr_accessor :rooted
 
+    # Operate from system temporary directory?
+    attr_accessor :rootless
+
     # 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
-
     #
     # Operate relative to project root directory, or use system's location.
     #
@@ -147,14 +157,14 @@ module QED
     #
     # Project's root directory.
     #
-    def root_directory
-      @root
+    def root
+      @root ||= find_root
     end
 
     #
-    # Shorthand for `#root_directory`.
+    # Alias for `#root`.
     #
-    alias_method :root, :root_directory
+    alias_method :root_directory, :root
 
     #
     # Temporary directory. If `#rootless?` return true then this will be
@@ -207,57 +217,27 @@ module QED
     # confection is deactivated via the override file.
     # 
     def profiles
-      return [] if configless?
-      Confection.profiles(:qed)
-    end
-
-=begin
-    #
-    # Keeps a list of defined profiles.
-    #
-    attr_accessor :profiles
-
-    # Profile configurations.
-    #def profiles
-    #  @profiles ||= (
-    #    files = Dir["#{settings_directory}/*.rb"]
-    #    files.map do |file|
-    #      File.basename(file).chomp('.rb')
-    #    end
-    #  )
-    #end
-
-    #
-    # Load QED profile (from -e option).
-    #
-    def load_profile(name)
-      if profile = profiles[name.to_s]
-        instance_eval(&profile)
-        #eval('self', TOPLEVEL_BINDING).instance_eval(&prof)
-      end
-      #return unless settings_directory
-      #if file = Dir["#{settings_directory}/#{profile}.rb"].first
-      #  require(file)
-      #end
+      @profiles.keys
     end
-=end
 
     #
-    # Load QED configuration profile. QED configurations are defined
-    # via standards of the Confection library, unless otherwise
-    # deativated via the `.qed` file.
+    # Load QED configuration profile. The load procedure is stored as
+    # a Proc object in a hash b/c different configuration systems
+    # can be used.
     #
     def load_profile(profile)
-      return if configless?
-      config = confection(:qed, profile.to_sym)
-      config.exec
+      profile = @profiles[profile.to_s]
+      profile.call if profile
     end
 
+  private
+
+    # TODO: find away 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:
     #
-    #   .map
     #   .ruby
     #   .git/
     #   .hg/
@@ -274,6 +254,8 @@ module QED
     # 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)
 
@@ -287,11 +269,13 @@ module QED
 
       if !root
         warn "QED is running rootless."
-        root = system_tmpdir
+        system_tmpdir
         @rootless = true
+      else
+        root
       end
 
-      return root
+      $ROOT = root
 
       #abort "QED failed to resolve project's root location.\n" +
       #      "QED looks for following entries to identify the root:\n" +
@@ -323,15 +307,6 @@ module QED
       )
     end
 
-    #
-    # Lookup, cache and return QED config file.
-    #
-    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.
     ##
@@ -352,6 +327,21 @@ module QED
     #  @_map_file ||= File.join(root_directory,MAP_FILE)
     #end
 
+    #
+    def load_confection_profile(name)
+      config = confection(:qed, name.to_sym)
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qed
 version: !ruby/object:Gem::Version
-  version: 2.8.5
+  version: 2.8.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &25789680 !ruby/object:Gem::Requirement
+  requirement: &17814740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25789680
+  version_requirements: *17814740
 - !ruby/object:Gem::Dependency
   name: facets
-  requirement: &25788160 !ruby/object:Gem::Requirement
+  requirement: &17813900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *25788160
+  version_requirements: *17813900
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &25787120 !ruby/object:Gem::Requirement
+  requirement: &17813280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25787120
+  version_requirements: *17813280
 - !ruby/object:Gem::Dependency
   name: confection
-  requirement: &25785800 !ruby/object:Gem::Requirement
+  requirement: &17812300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25785800
+  version_requirements: *17812300
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &25784360 !ruby/object:Gem::Requirement
+  requirement: &17811720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25784360
+  version_requirements: *17811720
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &25783020 !ruby/object:Gem::Requirement
+  requirement: &17811060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25783020
+  version_requirements: *17811060
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
@@ -91,6 +91,7 @@ extra_rdoc_files:
 - README.rdoc
 - COPYING.rdoc
 files:
+- .confile.rb
 - .ruby
 - .yardopts
 - bin/qed
@@ -144,8 +145,6 @@ files:
 - qed/helpers/toplevel.rb
 - qed/samples/data.txt
 - qed/samples/table.yml
-- task/qed-example.rb
-- task/qed-simplecov.rb
 - HISTORY.rdoc
 - README.rdoc
 - COPYING.rdoc

data/task/qed-example.rb

@@ -1,10 +0,0 @@
-# Just to demonstrate profiles.
-
-puts ("*" * 78)
-puts
-
-at_exit do
-  puts
-  puts ("*" * 78)
-end
-

data/task/qed-simplecov.rb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'simplecov'
-
-SimpleCov.start do
-  coverage_dir 'log/coverage'
-  #add_group "Label", "lib/qed/directory"
-end
-