qed 2.4.0 → 2.5.0

data/meta/{gemfile → package}

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

data/qed/04_samples.rdoc

@@ -6,12 +6,12 @@ When creating testable demonstrations, there are times when sizable
 chunks of data are needed. It is convenient to store such data in
 separate files. The +Data+ method makes is easy to utilize them.
 
-    Data('demo/samples/data.txt').assert =~ /dolor/
+    Data('qed/samples/data.txt').assert =~ /dolor/
 
 The +Data+ method can also take a block which passes the data
 as the block's only argument.
 
-    Data('demo/samples/data.txt') do |data|
+    Data('qed/samples/data.txt') do |data|
       data.assert =~ /dolor/
     end
 
@@ -32,7 +32,7 @@ the coded step. Consider the following example.
 Every row in the {table.yml table}[table.yml] will be assigned to
 the block parameters and run through the subsequent assertion.
 
-    Table 'demo/samples/table.yml' do |x, y|
+    Table 'qed/samples/table.yml' do |x, y|
       x.upcase.assert == y
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qed
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 2
-  - 4
+  - 5
   - 0
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors: 
 - Thomas Sawyer <transfire@gmail.com>
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -04:00
+date: 2010-11-07 01:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,7 +58,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: syckle
@@ -92,14 +92,13 @@ files:
 - 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/core_ext.rb
 - lib/qed/demo.rb
 - lib/qed/evaluator.rb
-- lib/qed/extensions/filefixtures.rb
-- lib/qed/extensions/shell_session.rb
+- lib/qed/helpers/file_fixtures.rb
+- lib/qed/helpers/shell_session.rb
 - lib/qed/meta/data.rb
-- lib/qed/meta/gemfile
+- lib/qed/meta/package
 - lib/qed/meta/profile
 - lib/qed/parser.rb
 - lib/qed/reporter/abstract.rb
@@ -116,7 +115,7 @@ files:
 - lib/qedoc/document/template.rhtml
 - lib/qedoc/document.rb
 - meta/data.rb
-- meta/gemfile
+- meta/package
 - meta/profile
 - qed/01_demos.rdoc
 - qed/02_advice.rdoc
@@ -140,7 +139,6 @@ files:
 - qed/samples/table.yml
 - test/integration/topcode.rdoc
 - LICENSE
-- Diary.rdoc
 - README.rdoc
 - History.rdoc
 has_rdoc: true

data/Diary.rdoc

@@ -1,117 +0,0 @@
-= Diary
-
-== 2010-06-06 / HTML Won't Do
-
-There have proven to be significant issues associated with translating markup to HTML and having QED evalute the HTML, rather than plain text. To begin with different markup engines translate special characeters in differnt ways. RDoc for instance will translate astrisks around a word into 'b' tags, whereas Textile translates them to 'em' tags. Still other characters are translated into HTML escape codes, eg. <code>\&amp;#8216;</code>. There are a variety of these and each markup language will translate them according to it's own rules (or not at all). This means pattern matches in advice have to take these translations into account. Instead of matching on an asterisk we might need to match on +<b>+. A minor naggle perhaps, but it means being exceptionally aware of all translaterions that occur, and moreover, that applique may not be portable across markup languages.
-
-There are other discrepencies as well such as the translation of code blocks to \<pre> vs. \<pre>\<code> tags, but all this aside, while perhaps annoying, it can be managed. A normalization procedure can help mitage the issues. However, the ultimate problem is your classic YAGNI, the fact that little, if anything, is gained by using HTML as the defacto document format. And this is simply because everyone will write there documents in a text-based markup, none of which fully support the HTML that QED could utilize. For instance RDoc and Markdown do not have a notation for tables (although extended Markdown might). Textile does not have a clean notation for \<pre> blocks --you have to use \<pre>! And ASCIIDoc, while a very capable documentation system has a verbose syntax that is not particullary suited to reading in plain text. Perhaps if all the available markdown languages were equally as capable, it would be worth the additional effort. But lacking this I beleive more advantage can ultimately be gained by allowing QED to have it's own markup syntax one suited best to it's purpose.
-
-
-== 2010-02-03 / Some Determinations
-
-In the end I have decided on loading helpers on the fly via
-special AHREF links. We still need a plan for loading global
-helpers though.
-
-Also, per last entry, Before and After stays b/c When doesn't
-quite cover the usecase. However, I definately encourge the use
-of helper methods in place of Before and After clauses.
-
-
-== 2010-01-28 / Before and After
-
-Wouldn't it better to allow helpers to define methods, which
-can be called in the steps for setting things up, rather than
-using "magic" Before and After clauses which give no indication
-that something has happened?
-
-  = Examples
-
-  == Example #1
-
-  For example #1 we will use example1[helper/example1] support file.
-  First we need to prepare the example. It is a complex process, so we
-  have made a special method for it. See the helper[helper/example1]
-  file for details.
-
-    ex = prepare_example1
-
-  Now we can show that the example is hip.
-
-    ex.assert.hip == true
-
-So we could get rid of Before(:step) and After(:step) definitions this
-way, and it's not such a big loss, b/c we still have #When, and 
-After(:Step) is of very rare utility which can be worked around.
-
-
-== 2010-01-30 / The Best Way to Handle Helpers
-
-1) Should helpers be stored in a special location relative
-to the demo file, from which all helpers in that location
-are loaded automatically. This simplifies loading, but it
-makes support for per-demo helpers more awkward.
-This option also means taking special consideration for
-helpers when documenting --any reference to them will have
-to be tacked-on rather then be an integral part of the document
-itself.
-
-We might do something like this:
-
-  demos/
-    demo1.rdoc
-    demo1/
-      helper.rb
-    demo2.rdoc
-    demo2/
-      helper.rb
-    share/
-      helper.rb
-
-Such that demo1/helper.rb only applies to demo1.rdoc, and 
-likewise for demo2, but both use share/helper.rb.
-
-2) Or, should the demo be able to specify which helpers to
-load via href links. This allows full flexability it selecting
-behavior for the demo. It also means the documentation will
-have references to helpers built-in (although they will have
-to be augmented when documenting to ensure the hrefs link
-correctly). But session-oriented advice doesn't make much
-sense in a per-demo context. We could ignore that, or place
-session advice in a separate location. While this option
-is more flexible, it also means demos may be more difficult
-to follow, because one must scan the links in the document
-to determine which helpers are being used.
-
-An example demo might look like:
-
-  == Examples
-
-  == Example 1
-
-  For example #1 we will use example1[helper/example1] support file.
-
-  ... and so on ...
-
-  == Example 2
-  
-  For example #2 we will use example2[helper/example2] support file.
-  
-  ... and so on ...
-
-In which case it seems prudent to load these helpers as they are 
-evaluated, rather than all at once at the start. However this insinuates
-that there is only one before and after advice at a time, and when
-would before advice for the entire demo run, upon loading the helper?
-
-I think it would be better to use When clauses. Then the helpers could
-be loaded all at once at the start and it would not matter. And instead of
-<code>Before do</code> use <code>When /*/ do</code> for general before
-clauses.
-
-However, if referenced helpers are to be loaded all at once at the start,
-it seems almost silly to even allow helpers to be referenced in the
-document. With the exception of using them as footnotes, it conveys too
-much positional indication. So either load them when they are encountered,
-or use option #1.
-

data/lib/qed/config.rb

@@ -1,60 +0,0 @@
-module QED
-
-=begin
-  # Setup global configuration.
-  #
-  #   QED.config do
-  #
-  #     Before(:session) do
-  #       # ...
-  #     end
-  #
-  #     After(:session) do
-  #       # ...
-  #     end
-  #
-  #   end
-  #
-  def self.configure(&block)
-    @config ||= Profile.new #(nil)
-    @config.instance_eval(&block) if block
-    @config
-  end
-=end
-
-  #
-  class Profile
-
-    #
-    def initialize
-      #@local = ['test/demos', 'demos', 'qed']
-  
-      @before = { :session=>[], :demo=>[], :step=>[] }
-      @after  = { :session=>[], :demo=>[], :step=>[] }
-
-      #if file = Dir.glob('{.,}config/qed.{yml,yaml}').first
-      #  YAML.load(File.new(file)).each do |k,v|
-      #    __send__("#{k}=", v)
-      #  end
-      #end
-    end
-
-    #
-    #attr_accessor :local
-
-    #
-    def Before(type=:session, &procedure)
-      @before[type] << procedure if procedure
-      @before[type]
-    end
-
-    #
-    def After(type=:session, &procedure)
-      @after[type] << procedure if procedure
-      @after[type]
-    end
-
-  end
-
-end
-

data/lib/qed/extensions/filefixtures.rb

@@ -1,27 +0,0 @@
-# This extension provides a simple means for 
-# create file-system fixtures.
-
-require 'erb'
-
-# Set global temporary directory.
-$tmpdir = 'tmp'
-
-#
-def copy_fixture(name, tmpdir=$tmpdir)
-  FileUtils.mkdir(tmpdir)
-  srcdir = File.join(demo_directory, 'fixtures', name)
-  paths  = Dir.glob(File.join(srcdir, '**', '*'), File::FNM_DOTMATCH)
-  paths.each do |path|
-    basename = File.basename(path)
-    next if basename == '.'
-    next if basename == '..'
-    dest = File.join(tmpdir, path.sub(srcdir+'/', ''))
-    if File.directory?(path)
-      FileUtils.mkdir(dest)
-    else
-      text = ERB.new(File.read(path)).result
-      File.open(dest, 'w'){ |f| f << text }
-    end
-  end
-end
-