qed 2.5.0 → 2.5.1

data/lib/qed/settings.rb

@@ -0,0 +1,155 @@
+module QED
+
+  # Ecapsulate confiduration information needed for QED
+  # run and set user and project options.
+  class Settings
+
+    require 'tmpdir'
+    require 'fileutils'
+
+    # Configuration directory `.qed`, `.config/qed` or `config/qed`.
+    # In this directory special configuration files can be placed
+    # to autmatically effect qed execution. In particular you can
+    # add a `profiles.yml` file to setup convenient execution
+    # scenarios.
+    CONFIG_PATTERN = "{.,.set/,set/.config/,config/}qed"
+
+    # Glob pattern used to search for project's root directory.
+    ROOT_PATTERN = '{.ruby,.git/,.hg/,_darcs/,.qed/,.set/qed/,set/qed/.config/qed/,config/qed/}'
+
+    # Home directory.
+    HOME = File.expand_path('~')
+
+    #
+    def initialize(options={})
+      @rootless = options[:rootless]
+    end
+
+    #
+    def rootless?
+      @rootless
+    end
+
+    # Project's root directory.
+    def root_directory
+      @root_directory ||= find_root
+    end
+
+    # Project's QED configuration directory.
+    # TODO: rename to `config_directory` ?
+    def settings_directory
+      @settings_directory ||= find_settings
+    end
+
+    #
+    def temporary_directory
+      @temporary_directory ||= (
+        if rootless?
+          File.join(Dir.tmpdir, 'qed', File.filename(Dir.pwd), Time.new.strftime("%Y%m%d%H%M%S"))
+        else
+          File.join(root_directory, 'tmp', 'qed')
+        end
+        #FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      )
+    end
+
+    #
+    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
+
+    # Profile configurations.
+    def profiles
+      @profiles ||= (
+        files = Dir["#{settings_directory}/*.rb"]
+        files.map do |file|
+          File.basename(file).chomp('.rb')
+        end
+      )
+    end
+
+    # Require requirement file (from -e option).
+    def require_profile(profile)
+      return unless settings_directory
+      if file = Dir["#{settings_directory}/#{profile}.rb"].first
+        require(file)
+      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
+    # path names, each group being tried in turn.
+    #
+    # * .git/
+    # * .hg/
+    # * _darcs/
+    # * .config/qed/
+    # * config/qed/
+    # * .qed/
+    # * .ruby
+    #
+    # Failing to find any of these locations, resort to the fallback:
+    # 
+    # * lib/
+    #
+    def find_root(path=nil)
+      path = File.expand_path(path || Dir.pwd)
+      path = File.dirname(path) unless File.directory?(path)
+
+      root = lookup(ROOT_PATTERN, path)
+      return root if root
+
+      #root = lookup(path, '{.qed,.config/qed,config/qed}/')
+      #return root if root
+
+      #root = lookup(path, '{qed,demo,demos}/')
+      #return root if root
+
+      root = lookup('lib/', path)
+
+      return root if root
+
+      abort "QED failed to resolve project's root location.\n" +
+            "QED looks for following entries to identify the root:\n" +
+            "  .set/qed/\n" +
+            "  set/qed/\n" +
+            "  .config/qed/\n" +
+            "  config/qed/\n" +
+            "  .qed/\n" +
+            "  .ruby\n" +
+            "  lib/\n" +
+            "Please add one of them to your project to proceed."
+    end
+
+    # Locate configuration directory by seaching up the 
+    # file hierachy relative to the working directory
+    # for one of the following paths:
+    #
+    # * .config/qed/
+    # *  config/qed/
+    # * .qed/
+    #
+    def find_settings
+      Dir[File.join(root_directory,CONFIG_PATTERN)].first
+    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.
+    #
+    # TODO: include HOME directory in search?
+    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
+
+  end
+
+end

data/lib/qed.rb

@@ -1,26 +1,27 @@
-require 'yaml'
-
 module QED
-  DIRECTORY = File.dirname(__FILE__) + '/qed'
-
-  PROFILE = YAML.load(File.new(DIRECTORY + '/profile.yml')) rescue {}
-  PACKAGE = YAML.load(File.new(DIRECTORY + '/package.yml')) rescue {}
 
-  VERSION = PACKAGE.values_at('major','minor','patch','build').compact.join('.')
+  # Access to project metadata.
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/qed.yml')) rescue {}
+    )
+  end
 
-  #
+  # Access to project metadata as constants.
   def self.const_missing(name)
     key = name.to_s.downcase
-    if PACKAGE.key?(key)
-      PACKAGE[key]
-    elsif PROFILE.key?(key)
-      PROFILE[key]
-    else
-      super(name)
-    end
+    metadata[key] || super(name)
+  end
+
+  # TODO: Only b/c of Ruby 1.8.x bug.
+  VERSION = metadata['version']
+
+  #
+  def self.cli(*argv)
+    Session.cli(*argv)
   end
+
 end
 
-require 'qed/command'
 require 'qed/session'
-

data/lib/qed.yml

@@ -0,0 +1,47 @@
+--- 
+spec_version: 1.0.0
+replaces: []
+
+loadpath: 
+- lib
+name: qed
+repositories: 
+  public: git://github.com/proutils/qed.git
+conflicts: []
+
+engine_check: []
+
+title: QED
+resources: 
+  home: http://proutils.github.com/qed
+  work: http://github.com/proutils/qed
+maintainers: []
+
+requires: 
+- group: []
+
+  name: ansi
+  version: 0+
+- group: []
+
+  name: facets
+  version: 2.8+
+- group: []
+
+  name: ae
+  version: 0+
+- group: 
+  - build
+  name: syckle
+  version: 0+
+manifest: Manifest
+version: 2.5.1
+licenses: []
+
+copyright: Copyright (c) 2006 Thomas Sawyer
+authors: 
+- Thomas Sawyer <transfire@gmail.com>
+organization: RubyWorks
+description: QED (Quality Ensured Demonstrations) is a TDD/BDD framework utilizing Literate Programming techniques.
+summary: Quod Erat Demonstrandum
+created: 2006-12-16

data/lib/yard-qed.rb

@@ -0,0 +1 @@
+# TODO: Create a YARD plugin for QED.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qed
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 2
   - 5
-  - 0
-  version: 2.5.0
+  - 1
+  version: 2.5.1
 platform: ruby
 authors: 
 - Thomas Sawyer <transfire@gmail.com>
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 01:00:00 -04:00
-default_executable: 
+date: 2011-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ansi
@@ -40,10 +39,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 19
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 8
+        version: "2.8"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -84,22 +84,16 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .ruby
 - bin/qed
 - bin/qedoc
-- eg/hello_world.rdoc
-- eg/view_error.rdoc
-- eg/website.rdoc
 - lib/qed/advice.rb
 - lib/qed/applique.rb
-- lib/qed/command.rb
 - lib/qed/core_ext.rb
 - lib/qed/demo.rb
 - lib/qed/evaluator.rb
 - lib/qed/helpers/file_fixtures.rb
 - lib/qed/helpers/shell_session.rb
-- lib/qed/meta/data.rb
-- lib/qed/meta/package
-- lib/qed/meta/profile
 - lib/qed/parser.rb
 - lib/qed/reporter/abstract.rb
 - lib/qed/reporter/bullet.rb
@@ -108,15 +102,15 @@ files:
 - lib/qed/reporter/verbatim.rb
 - lib/qed/scope.rb
 - lib/qed/session.rb
+- lib/qed/settings.rb
 - lib/qed.rb
+- lib/qed.yml
 - lib/qedoc/command.rb
 - lib/qedoc/document/jquery.js
 - lib/qedoc/document/markup.rb
 - lib/qedoc/document/template.rhtml
 - lib/qedoc/document.rb
-- meta/data.rb
-- meta/package
-- meta/profile
+- lib/yard-qed.rb
 - qed/01_demos.rdoc
 - qed/02_advice.rdoc
 - qed/03_helpers.rdoc
@@ -140,11 +134,9 @@ files:
 - test/integration/topcode.rdoc
 - LICENSE
 - README.rdoc
-- History.rdoc
-has_rdoc: true
 homepage: http://proutils.github.com/qed
-licenses: 
-- ""
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -174,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: qed
-rubygems_version: 1.3.7
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: Quod Erat Demonstrandum

data/History.rdoc

@@ -1,210 +0,0 @@
-= RELEASE HISTORY
-
-== 2.5.0 / 2010-11-04
-
-The latest release of QED improves on applique loading, such that each
-demonstrandum gets it's own localized set. The CLI has also been modified
-so that there is no longer a defualt location, the directory or files to run
-must be specified.
-
-Changes:
-
-* Better handling of Applique.
-* Remove Advice class --advice is now stored in Applique.
-* Each applique file is it's own module.
-* Advice from each applique is applied.
-* CLI requires files be specified.
-
-
-== 2.4.0 / 2010-09-02
-
-All engines go! QED has not been tested against 1.8.6, 1.8.7 and 1.9.2.
-Underthehood steps are not organized in doubely-linked lists, which makes
-them much more robust and flexible. This release also improves scoping,
-test counts, and inline documentation parsing.
-
-Changes:
-
-* Use new doubly-linked list step design.
-* Fix -r option on command line.
-* Provide #instance_exec core extension for Ruby 1.8.6.
-* Scope is extended by and includes applique.
-
-
-== 2.3.0 / 2010-07-14
-
-Bug to the scurry! QED has broken through the code/document ceiling and
-is cracking ectoskeletons all the way to the bank. A proverbal can of
-Roach-Be-Gone this is! What's that you say? I will exlpain. QED can now
-run directly against code comments. Simply slip the qed command the -c
-option and feed it some ruby scripts, and presto watch you commnets
-fail ;) I think you can figure out what to do next.
-
-In addition to this coolness QED has been improved under the floor
-boards as well. The parser, which is much faster, now blocks commentary
-paragraphs and code examples togeher in one-to-one pairings. Not only
-does this clean-up the code, but it opens up the potential for Around
-advice in a future version.
-
-Changes:
-
-* NEW! Ruby script comment run mode.
-* Better parsing system uses commentary-example pairs.
-* Colon can also be used to specify plain text (along with ellipsis).
-* Now distributed under the more permissive Apache 2.0 license.
-
-
-== 2.2.2 / 2010-06-21
-
-An issue was reported in which the a code block at the very
-top of a demo was being ignored. This release fixes this issue
-by rewriting the parser (much better now thanks!). At the same
-time the Data and Table methods have been polished, both of
-which can now pick up sample data relative to the current demo.
-
-Changes:
-
-* Rewrite parser and fix top code issue.
-* Data method cannot write data, instead executes block.
-* Data and Table methods look for file relative to demo first.
-* Added -R option to run demos relative to project root.
-
-
-== 2.2.1 / 2010-06-20
-
-Remove dependencies to Tilt and Nokogiri. Should have
-done this in last release but alas --there is so
-much to do.
-
-Changes:
-
-* Removed HTML parsing dependencies.
-* Reduce Advice to a single class.
-
-
-== 2.2.0 / 2010-06-19
-
-This release returns to a text-based evaluator, rather
-then use HTML. Processing HTML proved to have too many
-edge cases to be effective --both in implementation
-and in end-usage. So to remedy the situation QED has
-return to supportting simple markup formats such as
-RDoc and Markup.
-
-This release also adds multi-pattern advice. Instead of
-a single pattern, multiple patterns can be matched
-sequentially. This make it a easier to match large text
-descriptions without restoring to regular expressions.
-
-In addition QED now supports raw text blocks. By ending
-a description section in ellipsis (...), the subsequent
-code setion becomes a plain text section and is passed
-into the argument list of any matching When advice. This
-makes it easy to scaffold fixture files, for example.
-
-Finally, this release also refines the evaluation scopes.
-Where before, a new binding was being created, each was 
-attached to the TOPLEVEL, and therefore not truly isolated 
-on a per-dcoument basis. To correct, QED now mocks the
-TOPLEVEL providing a new instance of this mock object for
-each document.
-
-Changes:
-
-* No longer uses HTML for document processing.
-* Support for plain text blocks using ellipsis.
-* New sequential multi-pattern matches.
-* Mock TOPLEVEL at both the demo and applique levels.
-* Adjust color support for latest ANSI release.
-
-
-== 2.1.1 / 2010-04-08
-
-Fixed bug introduced in the last version that executed all
-scripts in a single binding. There needed to be a binding
-for each script.
-
-Changes:
-
-* Fixed cross-script bug by moving binding instantiation into Script class.
-
-
-== 2.1.0 / 2010-04-07
-
-QED documents are now run in the TOPLEVEL context, rather
-than in a subclass of Scope. This ensures code runs as
-one would expect it too in the wild.
-
-Changes:
-
-* Scope.new redirect to TOPLEVEL.
-* DomainLanguage module is added to include into TOPLEVEL.
-
-
-== 2.0.0 / 2010-03-04
-
-This is a major new release of QED. All demonstration documents
-are now converted to HTML via Tilt (http://github.com/tilt) before
-being run through the test runner. So QED now supports any markup
-format supported by Tilt, as well as ordinary HTML. Simply
-stated, QED process <tt>pre</tt> tags as code and everything else
-as comments. Nokogiri is used to parse the HTML.
-
-Changes:
-
-* HTML serves as a common format.
-* New dependencies: Tilt and Nokogiri.
-* New system of version numbers.
-
-
-== 1.2.0 / 2009-12-07
-
-This release adds a significant new feature, Comment Matchers.
-These work like Cucumber allowing for background code to
-be run when matching comments occur --a much better solution
-for setup and teardown.
-
-Changes:
-
-* 2 Major Enhancements
-
-  * Added command matchers via #When method.
-  * All QED methods are now capitalized.
-
-* 2 Minor Enhancements
-
-  * Use OptionParser for qed exectuable.
-  * Verbatim reporter is literally verbatim.
-
-
-== 1.1.1 / 2009-09-05
-
-This release 
-
-Changes:
-
-* 2 Major Enhancements
-
-  * Helpers are provided by bottom code.
-  * Added Markdown header support.
-
-* 2 Minor Enhancements
-
-  * Use Ansi project for color output.
-  * Use latest RDoc version.
-
-
-== 1.0.0 / 2009-06-30
-
-QED has found itself. It took some time to really figure out
-what this project "was" and how it should best be utilized.
-This release is the initial release that puts QED in proper
-perpective.
-
-Changes:
-
-* 2 Major Enhancement
-
-    * Partial rewrite of a project that was once called "Quarry".
-    * Now uese AE for assertions.
-

data/eg/hello_world.rdoc

@@ -1,15 +0,0 @@
-= Hello World
-
-Did you know that famous `Hello World` moniker is
-eleven characters long?
-
-    "Hello World".size.assert == 11
-
-To pass a piece of literal text on with a description
-we simply need to end it with a ...
-
-    Now this text will appear verbatim.
-    In the applique arguments.
-
-That's all.
-

data/eg/view_error.rdoc

@@ -1,21 +0,0 @@
-= Examples of Failure
-
-This document is here simply to demonstrate what
-a failed and error raising code steps looks like.
-
-When run with the -v (verbatim) option, for instance, +qed+
-will highlight the following sections in red and give a brief
-error message.
-
-== Failure
-
-This step demonstrates a failed assertion.
-
-  1.assert == 2
-
-== Error
-
-This step demonstrates a raised error.
-
-  raise "Just because"
-

data/eg/website.rdoc

@@ -1,12 +0,0 @@
-= Addition
-
-  require 'calculator'
-  calculator = Caclulater.new
-
-A Calculator can add two numbers. 
-
-  calculator.push 2
-  calculator.push 2
-  calculator.add
-  calculator.output.assert == 4
-