qed 2.3.0 → 2.4.0

data/lib/qed/scope.rb

@@ -5,7 +5,7 @@ module QED
   # Scope is the context in which QED documents are run.
   #
   class Scope < Module
- 
+
     #
     def self.new(applique, file)
       @_applique = applique
@@ -25,6 +25,7 @@ module QED
 
       extend self
       extend applique # TODO: extend or include applique or none ?
+      include applique
       #extend DSLi
 
       # TODO: custom extends?
@@ -34,19 +35,29 @@ module QED
 
     # This turns out to be the key to proper scoping.
     def __create_clean_binding_method__
-      define_method(:__binding__) do
-        @__binding__ ||= binding
-      end
+      #define_method(:__binding__) do
+      #  @__binding__ ||= binding
+      #end
+      module_eval %{
+        def __binding__
+          @__binding__ ||= binding
+        end
+      }
     end
 
-    # Evaluate code in the context of the scope's special 
-    # binding.
+    # Expanded dirname of +file+.
+    def demo_directory
+      @_demo_directory ||= File.expand_path(File.dirname(@_file))
+    end
+
+    # Evaluate code in the context of the scope's special binding.
     def eval(code, binding=nil)
-      super(code, binding || __binding__)
+      super(code, binding || __binding__, @_file)
     end
 
     # Define "when" advice.
     def When(*patterns, &procedure)
+      patterns = patterns.map{ |pat| pat == :text ? :desc : pat }
       @_applique.When(*patterns, &procedure)
     end
 
@@ -120,4 +131,3 @@ module QED
   end#class Scope
 
 end#module QED
-

data/lib/qed/session.rb

@@ -123,7 +123,7 @@ module QED
       applique
     end
 
-    #
+    # SCM: reverse order of applique so topmost directory comes first
     def applique_scripts
       locs = []
       files.each do |file|
@@ -135,7 +135,7 @@ module QED
           end
         end
       end
-      envs = locs.map{ |loc| Dir[File.join(loc,'**/*.rb')] }
+      envs = locs.reverse.map{ |loc| Dir[File.join(loc,'**/*.rb')] }
       envs.flatten.compact.uniq
     end
 

data/meta/data.rb

@@ -0,0 +1,29 @@
+Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)      # becuase Ruby 1.8~ gets in the way
+
+module QED
+
+  def self.__DIR__
+    File.dirname(__FILE__)
+  end
+
+  def self.gemfile
+    @gemfile ||= (
+      require 'yaml'
+      YAML.load(File.new(__DIR__ + '/gemfile'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(__DIR__ + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    gemfile[key] || profile[key] || super(name)
+  end
+
+end
+

data/meta/gemfile

@@ -0,0 +1,10 @@
+name: qed
+version: 2.4.0
+date: 2010-09-02
+
+requires:
+- ansi
+- facets
+- ae (test)
+- syckle (build)
+

data/{demo → qed}/01_demos.rdoc

@@ -1,16 +1,16 @@
 = Demonstrations
 
-== Standard Sections
+== Steps
 
 QED demos are light-weight specification documents, highly suitable
 to interface-driven design. The documents are divided up into
-clauses separated by blank lines. Clauses that are flush to the 
-left margin are always explanation or comment clauses. Indented
-clauses are always executable code.
+steps separated by blank lines. Steps that are flush to the 
+left margin are always explanatory comments. Indented steps are
+either executable code or plain text samples.
 
-Each code section is executed in order of appearance, within a
-rescue wrapper that captures any failures or errors. If neither
-a failure or error occur then the code gets a "pass".
+Each step is executed in order of appearance within a rescue wrapper
+that captures any failures or errors. If neither a failure or error
+occur then the step gets a "pass".
 
 For example, the following passes.
 
@@ -29,12 +29,6 @@ And this would have raised a NameError.
       nobody_knows_method
     end
 
-== Neutral Code Blocks
-
-There is no means of specifying that a code clause is neutral code,
-i.e. that it should be executed but not tested. Thus far, such a
-feature has proven to be a YAGNI.
-
 == Defining Custom Assertions
 
 The context in which the QED code is run is a self-extended module, thus

data/{demo → qed}/02_advice.rdoc

@@ -85,12 +85,12 @@ an object just magically appear.
 
 == Event Targets
 
-There is a small set of advice targets that do not come before
-or after an event, rather they occur *upon* a particular event.
-These include +:load+ and +:unload+ for when a new helper is loaded;
-+:pass+, +:fail+ and +:error+ for when a code block passes, fails or
-raises an error; and +:text+ and +:code+ which target the immediate
-processing of a text block and code excecution.
+There is a small set of advice targets that do not come before or after,
+rather they occur *upon* a particular event. These include +:load+
+and +:unload+ for when a new helper is loaded; +:pass+, +:fail+ and +:error+
+for when a code block passes, fails or raises an error; and +:head+, +:desc:+,
++:code+ and +:data:+ which targets the immediate processing of a text block
+and code excecution.
 
 These event targets can be advised by calling the +When+ method
 with the target type as an argument along with the code block
@@ -99,7 +99,7 @@ to be run when the event is triggered.
   x = []
 
   When(:text) do |section|
-    section.commentary.scan(/^\*(.*?)$/) do |m|
+    section.text.scan(/^\*(.*?)$/) do |m|
       x << $1.strip
     end
   end

data/{demo → qed}/03_helpers.rdoc

@@ -30,8 +30,8 @@ No where in the demonstration have we defined +pudding+, but
 it has been defined for us in the advice.rb helper script.
 
 We can also see that the generic When clause in our advice
-helper is keeping count of sections. Since the helper
-script was loaded two paragraphs section back, the curent count
+helper is keeping count of decriptive paragraphs. Since the
+helper script was loaded two paragraphs back, the next count
 will be 3.
 
   count.assert == 3

data/{demo → qed}/08_cross_script.rdoc

@@ -23,5 +23,3 @@ And a method.
     "common"
   end
 
-
-

data/{demo → qed}/09_cross_script.rdoc

@@ -20,8 +20,10 @@ Method definitions also do not cross QED scripts.
     cross_script_method
   end
 
-Constants, on the other hand, like global variables do make
-their way across.
+Since each demo is encapsulated in a separated class scope, constants also
+do not make their way across.
 
-  CROSS_SCRIPT_CONSTANT.assert == "cross?"
+  expect NameError do
+    CROSS_SCRIPT_CONSTANT
+  end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qed
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 31
   prerelease: false
   segments: 
   - 2
-  - 3
+  - 4
   - 0
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Thomas Sawyer <transfire@gmail.com>
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 -04:00
+date: 2010-09-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ae
+  name: ansi
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ansi
+  name: facets
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: facets
+  name: ae
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -58,7 +58,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: syckle
@@ -75,7 +75,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 description: QED (Quality Ensured Demonstrations) is a TDD/BDD framework utilizing Literate Programming techniques.
-email: 
+email: ""
 executables: 
 - qedoc
 - qed
@@ -86,35 +86,22 @@ extra_rdoc_files:
 files: 
 - bin/qed
 - bin/qedoc
-- demo/01_demos.rdoc
-- demo/02_advice.rdoc
-- demo/03_helpers.rdoc
-- demo/04_samples.rdoc
-- demo/05_quote.rdoc
-- demo/07_toplevel.rdoc
-- demo/08_cross_script.rdoc
-- demo/09_cross_script.rdoc
-- demo/10_constant_lookup.rdoc
-- demo/applique/constant.rb
-- demo/applique/env.rb
-- demo/applique/fileutils.rb
-- demo/applique/markup.rb
-- demo/applique/quote.rb
-- demo/applique/toplevel.rb
-- demo/helpers/advice.rb
-- demo/helpers/sample.rb
-- demo/helpers/toplevel.rb
-- demo/samples/data.txt
-- demo/samples/table.yml
+- 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/config.rb
+- lib/qed/core_ext/instance_exec.rb
 - lib/qed/demo.rb
 - lib/qed/evaluator.rb
-- lib/qed/package.yml
+- lib/qed/extensions/filefixtures.rb
+- lib/qed/extensions/shell_session.rb
+- lib/qed/meta/data.rb
+- lib/qed/meta/gemfile
+- lib/qed/meta/profile
 - lib/qed/parser.rb
-- lib/qed/profile.yml
 - lib/qed/reporter/abstract.rb
 - lib/qed/reporter/bullet.rb
 - lib/qed/reporter/dotprogress.rb
@@ -128,20 +115,38 @@ files:
 - lib/qedoc/document/markup.rb
 - lib/qedoc/document/template.rhtml
 - lib/qedoc/document.rb
-- script/qedoc
-- script/test
+- meta/data.rb
+- meta/gemfile
+- meta/profile
+- qed/01_demos.rdoc
+- qed/02_advice.rdoc
+- qed/03_helpers.rdoc
+- qed/04_samples.rdoc
+- qed/05_quote.rdoc
+- qed/07_toplevel.rdoc
+- qed/08_cross_script.rdoc
+- qed/09_cross_script.rdoc
+- qed/10_constant_lookup.rdoc
+- qed/applique/constant.rb
+- qed/applique/env.rb
+- qed/applique/fileutils.rb
+- qed/applique/markup.rb
+- qed/applique/quote.rb
+- qed/applique/toplevel.rb
+- qed/helpers/advice.rb
+- qed/helpers/sample.rb
+- qed/helpers/toplevel.rb
+- qed/samples/data.txt
+- qed/samples/table.yml
 - test/integration/topcode.rdoc
-- PROFILE
 - LICENSE
 - Diary.rdoc
 - README.rdoc
-- REQUIRE
-- VERSION
 - History.rdoc
 has_rdoc: true
 homepage: http://proutils.github.com/qed
-licenses: []
-
+licenses: 
+- ""
 post_install_message: 
 rdoc_options: 
 - --title

data/REQUIRE

@@ -1,7 +0,0 @@
-runtime:
-  - ae
-  - ansi
-  - facets
-
-development:
-  - syckle

data/VERSION

@@ -1,5 +0,0 @@
-name : qed
-major: 2
-minor: 3
-patch: 0
-date : 2010-07-14

data/lib/qed/package.yml

@@ -1,5 +0,0 @@
-name : qed
-major: 2
-minor: 3
-patch: 0
-date : 2010-07-14

data/script/qedoc

@@ -1,2 +0,0 @@
-#!/usr/bin/env sh
-qedoc -o doc/qedoc/ -t "QED Demonstrandum" qed/*.rdoc

data/script/test

@@ -1,4 +0,0 @@
-#!/usr/bin/ruby
-pass1 = system "ruby -Ilib -- bin/qed demo/*.rdoc"
-pass2 = system "ruby -Ilib -- bin/qed test/integration/*.rdoc"
-exit -1 unless pass1 && pass2