qed 2.8.7 → 2.8.8

data/.ruby

@@ -41,7 +41,7 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.7
+version: 2.8.8
 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,17 @@
 = RELEASE HISTORY
 
+== 2.8.8 | 2012-30-17
+
+Feel like a heel after the last four releases. The simplist solution
+to the configuration issue is to allow traditional configuration
+trump confection based configuration. If the former is used, then
+the later will never even load. Problem solved.
+
+Changes:
+
+* Traditional configuration trump Confection configuration.
+
+
 == 2.8.7 | 2012-03-16
 
 Release fixes a bug that prevented default demo locations from being

data/lib/qed.yml

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

data/lib/qed/settings.rb

@@ -2,26 +2,24 @@ module QED
 
   # Settings ecapsulates setup code for running QED.
   #
-  # QED can use Confection-based configuration, if a Confile is present.
+  # QED supports 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
-  # via the `.map` file. Just add a `qed: path/to/qed/config/file` entry.
+  #     config :qed, :cover do
+  #       require 'simplecov'
+  #       SimpleCov.start do
+  #         coverage_dir 'log/coverage'
+  #       end
+  #     end
   #
-  # In this file special configuration setups can be placed to automatically
-  # effect QED execution, in particular optional profiles can be defined.
+  # QED also supports traditional configuration files placed in either
+  # toplevel `.qed`, `.qed.rb`, `qed.rb` or these files in the `task/`
+  # directory or in the form of `task/<name>.qed`. The same example as
+  # above in one of these files would be:
   #
-  #     if ENV['cover']
+  #     profile :cover do
   #       require 'simplecov'
   #       SimpleCov.start do
   #         coverage_dir 'log/coverage'
-  #         add_group "Shared" do |src_file|
-  #           /lib\/dotruby\/v(\d+)(.*?)$/ !~ src_file.filename
-  #         end
-  #         add_group "Revision 0", "lib/dotruby/v0"
   #       end
   #     end
   #
@@ -34,9 +32,6 @@ module QED
     # will be searched.
     DEFAULT_FILES = ['qed', 'demo', 'spec']
 
-    # QED support configuration file mapping.
-    #MAP_FILE = '.map'
-
     # Glob pattern used to search for project's root directory.
     ROOT_PATTERN = '{.map,.ruby,.git/,.hg/,_darcs/}'
 
@@ -49,6 +44,19 @@ module QED
     # Directory names to omit from automatic selection.
     OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
 
+    # QED support configuration file mapping.
+    #MAP_FILE = '.map'
+
+    #
+    # Mast configuration file lookup glob.
+    #
+    CONFECTION_GLOB = '{,.}confile{.rb,}'
+
+    #
+    # Traditional configuration file lookup glob.
+    #
+    CONFIG_GLOB = '{,.,task/}qed{,file}{,.rb}'
+
     #
     # Initialize new Settings instance.
     #
@@ -67,45 +75,70 @@ module QED
       @format     = :dot
       @trace      = false
       @mode       = nil
-      @profile    = ENV['profile'] || :default
       @loadpath   = ['lib']
       @requires   = []
       @omit       = OMIT_PATHS  # TODO: eventually make configurable
       @rootless   = false
+
+      @profile    = ENV['profile'] || :default
     end
 
     #
-    # 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.
+    # QED can use either a maser configuration file, via the Confection
+    # library, or more traditional toplevel or task directory files. Only
+    # one of these two approaches can be used and the traditional
+    # system, if used, will override use of the confection system.
+    #
+    # Using a master configuraiton file, add for example:
+    #
+    #     config :qed, :simplecov do
+    #       require 'simplecov'
+    #       SimpleCov.start do
+    #         coverage_dir 'log/coverage'
+    #       end
+    #     end
+    #
+    # If using a traditional configuration file, which can be either of
+    # `.qed`, `.qed.rb` or `qed.rb`, case-insensitive, or a `task/<name>.qed`
+    # located file, use the `#profile` method to define different profiles.
     #
-    # Note, that setting `ENV['config']='legacy'` will force Confection
-    # not to be used. This is used by the Confection library so it can
-    # run QED demos too.
+    #     profile :simplecov do
+    #       require 'simplecov'
+    #       SimpleCov.start do
+    #         coverage_dir 'log/coverage'
+    #       end
+    #     end
     #
     def initialize_configuration
       @profiles = {}
 
-      if confection_file && !ENV['config']=='legacy'
-        require 'confection'
-        Confection.profiles(:qed).each do |name|
-          @profiles[name.to_s] = lambda{ load_profile_from_confection(name) }
-        end
+      # traditional
+      Dir.glob(File.join(root, CONFIG_GLOB), File::FNM_CASEFOLD).each do |file|
+        next unless File.file?(file)
+        instance_eval(File.read(file), file)
       end
 
-      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) }
+      # task directory config files
+      Dir.glob(File.join(root, 'task/*.qed')).each do |file|
+        next unless File.file?(file)
+        instance_eval(File.read(file), file)
       end
 
-      Dir.glob(File.join(root, '{.qed,.qed.rb,qed.rb,Qedfile}')).map do |file|
-        @profiles[nil] = lambda{ load_profile_from_file(file) }
+      # don't use confection gem if other approaches are being used.
+      return unless @profiles.empty?
+
+      # confection
+      if confection_file
+        require 'confection'
+        Confection.profiles(:qed).each do |name|
+          @profiles[name.to_s] = lambda{ load_profile_from_confection(name) }
+        end
       end
     end
 
     # Lookup Confection config file.
     def confection_file
-      Dir.glob(File.join(root, '{,.}confile{.rb,}'), File::FNM_CASEFOLD).first
+      Dir.glob(File.join(root, CONFECTION_GLOB), File::FNM_CASEFOLD).first
     end
 
     # Demonstration files (or globs).
@@ -213,10 +246,11 @@ module QED
     #
     # @return [Proc] The procedure.
     #
-    #def profile(name, &block)
-    #  raise "The #profile method is deprecated."
-    #  #@profiles[name.to_s] = block
-    #end
+    def profile(name=nil, &block)
+      return @profile unless name
+      return @profile[name.to_s] unless block
+      @profiles[name.to_s] = block
+    end
 
     #
     # Profiles are collected from the Confection library, unless 
@@ -238,7 +272,7 @@ module QED
 
   private
 
-    # TODO: find away to not need $ROOT global.
+    # TODO: find a way to not need $ROOT global.
 
     #
     # Locate project's root directory. This is done by searching upward
@@ -289,7 +323,7 @@ module QED
       #      "Please add one of them to your project to proceed."
     end
 
-    # TODO: Use Dir.ascend from Ruby Facets.
+    # TODO: Use Dir.ascend from Ruby Facets ?
 
     #
     # Lookup path +glob+, searching each higher directory
@@ -313,6 +347,8 @@ module QED
       )
     end
 
+    # TODO: Support .map in future ?
+
     ##
     ## Return cached file map from a project's `.map` file, if it exists.
     ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qed
 version: !ruby/object:Gem::Version
-  version: 2.8.7
+  version: 2.8.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &17320540 !ruby/object:Gem::Requirement
+  requirement: &28672460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17320540
+  version_requirements: *28672460
 - !ruby/object:Gem::Dependency
   name: facets
-  requirement: &17317040 !ruby/object:Gem::Requirement
+  requirement: &28671560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *17317040
+  version_requirements: *28671560
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &17314320 !ruby/object:Gem::Requirement
+  requirement: &28671020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17314320
+  version_requirements: *28671020
 - !ruby/object:Gem::Dependency
   name: confection
-  requirement: &17311080 !ruby/object:Gem::Requirement
+  requirement: &28670240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17311080
+  version_requirements: *28670240
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &17306960 !ruby/object:Gem::Requirement
+  requirement: &28669640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17306960
+  version_requirements: *28669640
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &17303640 !ruby/object:Gem::Requirement
+  requirement: &28669100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17303640
+  version_requirements: *28669100
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'