qed 2.8.1 → 2.8.2

data/.ruby

@@ -8,14 +8,11 @@ copyrights:
 - holder: Thomas Sawyer, Rubyworks
   year: '2006'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
 - name: ansi
 - name: facets
   version: 2.8+
 - name: brass
-- name: confection
 - name: detroit
   groups:
   - build
@@ -25,6 +22,7 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/qed.git
@@ -42,10 +40,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.1
+version: 2.8.2
 scm_uri: http://github.com/rubyworks/qed/blob/master/
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
-date: '2012-02-01'
+date: '2012-03-07'

data/HISTORY.rdoc

@@ -1,5 +1,23 @@
 = RELEASE HISTORY
 
+== 2.8.2 | 2012-03-07
+
+This release simply reverts the configuration file back to an
+independent file. The use of the Confection library was a "noble
+idea", but in the end not one that's likely to gain traction among 
+developers in general, so we have decided to revert back to the
+more traditional `.qed` config file. However, we also added built-in
+support for `task/qed.rb`, which we encourgage so as to promote
+clean project structures. Further, QED also suppots the `.map` YAML
+configuration file which allows you to move the QED config file
+wherever you might prefer it. Just add a `qed: path/to/config/file`
+entry.
+
+Changes:
+
+* Revert to dedicated configuration file.
+
+
 == 2.8.1 | 2012-02-01
 
 This release fixes a bug in the parsing of `#=>` notation. It also

data/lib/qed/settings.rb

@@ -1,13 +1,16 @@
 module QED
 
-  # Ecapsulate configuration information needed for QED to
-  # run and set user and project options.
+  # Settings ecapsulates setup code for running QED.
+  #
+  # By convention, configuration for QED is placed in `task/qed.rb`.
+  # 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.
   #
-  # Configuration for QED is placed in a `.config.rb` or `config.rb` file.
   # In this file special configuration setups can be placed to automatically
   # effect QED execution, in particular optional profiles can be defined.
   #
-  #   qed do
   #     profile :coverage do
   #       require 'simplecov'
   #       SimpleCov.start do
@@ -18,20 +21,26 @@ module QED
   #         add_group "Revision 0", "lib/dotruby/v0"
   #       end
   #     end
-  #   end
-  # 
+  #
   class Settings
 
     require 'tmpdir'
     require 'fileutils'
-    require 'confection'
+
+    # QED support configuration file mapping.
+    MAP_FILE = '.map'
 
     # Glob pattern used to search for project's root directory.
-    ROOT_PATTERN = '{.confile,.confile.rb,confile,confile.rb,.ruby,.git/,.hg/,_darcs/}'
+    ROOT_PATTERN = '{.map,.ruby,.git/,.hg/,_darcs/,.qed,.qed.rb,qed.rb,task/qed.rb}'
+
+    # Glob pattern used to find QED configuration file in root directory.
+    CONFIG_PATTERN = '{task/qed.rb,qed.rb,.qed,.qed.rb}'
 
     # Home directory.
     HOME = File.expand_path('~')
 
+    #
+    #
     #
     def initialize(options={})
       @rootless = options[:rootless]
@@ -42,24 +51,31 @@ module QED
       # Set global. TODO: find away to not need this ?
       $ROOT = @root
 
-      confection('qed').exec
+      if config_file
+        instance_eval(File.read(config_file), config_file)
+      end
     end
 
+    #
     # Operate relative to project root directory, or use system's location.
     #
     def rootless?
       @rootless
     end
 
+    #
     # Project's root directory.
     #
     def root_directory
       @root
     end
 
+    #
     # Shorthand for `#root_directory`.
+    #
     alias_method :root, :root_directory
 
+    #
     # Temporary directory. If `#rootless?` return true then this will be
     # a system's temporary directory (e.g. `/tmp/qed/foo/20111117242323/`).
     # Otherwise, it will local to the project's root int `tmp/qed/`.
@@ -75,15 +91,20 @@ module QED
       )
     end
 
+    #
     # Shorthand for `#temporary_directory`.
+    #
     alias_method :tmpdir, :temporary_directory
 
+    #
     # Remove and recreate temporary working directory.
+    #
     def clear_directory
       FileUtils.rm_r(tmpdir) if File.exist?(tmpdir)
       FileUtils.mkdir_p(tmpdir)
     end
 
+    #
     # Define a profile.
     #
     # @param [#to_s] name
@@ -92,11 +113,14 @@ module QED
     # @yield Procedure to run for profile.
     #
     # @return [Proc] The procedure.
+    #
     def profile(name, &block)
       @profiles[name.to_s] = block
     end
 
+    #
     # Keeps a list of defined profiles.
+    #
     attr_accessor :profiles
 
     # Profile configurations.
@@ -109,7 +133,9 @@ module QED
     #  )
     #end
 
+    #
     # Load QED profile (from -e option).
+    #
     def load_profile(name)
       if profile = profiles[name.to_s]
         instance_eval(&profile)
@@ -121,17 +147,18 @@ module QED
       #end
     end
 
+    #
     # Locate project's root directory. This is done by searching upward
     # in the file heirarchy for the existence of one of the following:
     #
-    #   .confile
-    #   confile
-    #   .confile.rb
-    #   confile.rb
+    #   .map
     #   .ruby
     #   .git/
     #   .hg/
     #   _darcs/
+    #   .qed
+    #   .qed.rb
+    #   qed.rb
     #
     # Failing to find any of these locations, resort to the fallback:
     # 
@@ -168,6 +195,7 @@ module QED
 
     # 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.
@@ -180,6 +208,8 @@ module QED
       end
     end
 
+    #
+    # System-wide temporary directory for QED executation.
     #
     def system_tmpdir
       @system_tmpdir ||= (
@@ -187,6 +217,36 @@ module QED
       )
     end
 
+    #
+    # 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
+      )
+    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
+
   end
 
 end

data/lib/qed.yml

@@ -8,14 +8,11 @@ copyrights:
 - holder: Thomas Sawyer, Rubyworks
   year: '2006'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
 - name: ansi
 - name: facets
   version: 2.8+
 - name: brass
-- name: confection
 - name: detroit
   groups:
   - build
@@ -25,6 +22,7 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/qed.git
@@ -42,10 +40,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.1
+version: 2.8.2
 scm_uri: http://github.com/rubyworks/qed/blob/master/
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
 
   utilizing Literate Programming techniques.'
-date: '2012-02-01'
+date: '2012-03-07'

metadata

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