qed 2.1.1 → 2.2.0

data/lib/qed/profile.yml

@@ -0,0 +1,16 @@
+--- 
+title: QED
+suite: proutils
+summary: Quod Erat Demonstrandum
+authors: Thomas Sawyer <transfire@gmail.com>
+created: 2006-12-16
+
+description:
+  QED (Quality Ensured Demonstrations) is a TDD/BDD framework
+  utilizing Literate Programming techniques.
+
+resources:
+  home: http://proutils.github.com/qed
+  work: http://github.com/protuils/qed
+  repo: git://github.com/proutils/qed.git
+

data/lib/qed/reporter/{base.rb → abstract.rb}

@@ -4,18 +4,15 @@ module Reporter
   require 'facets/string'
   require 'ansi/code'
 
-  # = Reporter BaseClass
+  # = Reporter Absract Base Class
   #
   # Serves as the base class for all other output formats.
   #
-  class BaseClass
+  class Abstract
 
     attr :io
     attr :steps
     attr :omit
-    attr :pass
-    attr :fail
-    attr :error
 
     def initialize(options={})
       @io    = options[:io] || STDOUT
@@ -29,6 +26,10 @@ module Reporter
       @error = []
     end
 
+    def passes   ; @pass  ; end
+    def errors   ; @error ; end
+    def failures ; @fail  ; end
+
     #
     def trace?
       @trace
@@ -79,23 +80,16 @@ module Reporter
       @demos += 1
     end
 
-    #
-    def tag(element)
-    end
-
     #
     def load(demo)
     end
+
     #
     def import(file)
     end
 
-    # Before running a step.
-    def element(step)
-    end
-
-    def comment(elem)
-    end
+    #def comment(elem)
+    #end
 
     # Before running a step that is omitted.
     #def omit_step(step)
@@ -107,6 +101,14 @@ module Reporter
       @steps += 1
     end
 
+    # Right before running code.
+    def code(section)
+    end
+
+    # Right before text section.
+    def text(section)
+    end
+
     # After running a step that passed.
     def pass(step)
       @pass << step
@@ -127,10 +129,6 @@ module Reporter
     def after_code(step, file)
     end
 
-    #
-    def after_element(elem)
-    end
-
     #
     def unload
     end

data/lib/qed/reporter/bullet.rb

@@ -1,22 +1,20 @@
 module QED
 module Reporter #:nodoc:
 
-  require 'qed/reporter/base'
+  require 'qed/reporter/abstract'
 
   # = Bullet Point Reporter
   #
-  # Similar to the Verbatim reporter, but does
+  # Similar to the Verbose reporter, but does
   # not display test code for passing tests.
-  class BulletPoint < BaseClass
+  class BulletPoint < Abstract
 
     #
-    def tag(step)
-      case step.name
-      when 'pre'
-        # none
-      when /h\d/
-        io.puts ANSI::Code.bold("#{step.text}\n")
-      when 'p'
+    def text(step)
+      case step.text
+      when /^\=/
+        io.puts "#{step.text}".ansi(:bold)
+      else
         txt = step.text.to_s.strip.tabto(2)
         txt[0,1] = "*"
         io.puts txt
@@ -25,17 +23,17 @@ module Reporter #:nodoc:
     end
 
     def pass(step)
-      #io.puts ANSICode.green("#{step}")
+      #io.puts "#{step}".ansi(:green)
     end
 
     def fail(step, assertion)
       msg = ''
       msg << "  ##### FAIL #####\n"
       msg << "  # " + assertion.to_s
-      msg = ANSI::Code.magenta(msg)
+      msg = msg.ansi(:magenta)
       io.puts msg
       #io.puts
-      io.puts ANSI::Code.red("#{step.text}")
+      io.puts "#{step.text}".ansi(:red)
     end
 
     def error(step, exception)
@@ -44,10 +42,10 @@ module Reporter #:nodoc:
       msg << "  ##### ERROR #####\n"
       msg << "  # " + exception.to_s + "\n"
       msg << "  # " + clean_backtrace(exception.backtrace[0])
-      msg = ANSI::Code.magenta(msg)
+      msg = msg.ansi(:magenta)
       io.puts msg
       #io.puts
-      io.puts ANSI::Code.red("#{step.text}")
+      io.puts "#{step.text}".ansi(:red)
     end
 
     #def report(str)
@@ -69,7 +67,7 @@ module Reporter #:nodoc:
     #  txt[0,1] = "*"
     #  io.puts txt
     #  #io.puts
-    #  #io.puts ANSICode.magenta("#{step}")
+    #  #io.puts "#{step}".ansi(:magenta)
     #end
 
   end #class Summary

data/lib/qed/reporter/dotprogress.rb

@@ -1,11 +1,11 @@
 module QED
 module Reporter #:nodoc:
 
-  require 'qed/reporter/base'
+  require 'qed/reporter/abstract'
 
   # = DotProgress Reporter
   #
-  class DotProgress < BaseClass
+  class DotProgress < Abstract
 
     #
     def before_session(session)
@@ -16,7 +16,8 @@ module Reporter #:nodoc:
     #
     def before_code(step, file)
       super(step, file)
-      io.print "." if step.name == 'pre'
+      io.print "."
+      io.flush
     end
 
     #
@@ -25,7 +26,7 @@ module Reporter #:nodoc:
 
       @error.each do |step, exception|
         backtrace = clean_backtrace(exception.backtrace[0])
-        io.puts ANSI::Code.red("***** ERROR *****")
+        io.puts "***** ERROR *****".ansi(:red)
         io.puts "#{exception}"
         io.puts ":#{backtrace}:"
         #io.puts ":#{exception.backtrace[1]}:"
@@ -35,8 +36,8 @@ module Reporter #:nodoc:
 
       @fail.each do |step, assertion|
         backtrace = clean_backtrace(assertion.backtrace[0])
-        io.puts ANSI::Code.red("***** FAIL *****")
-        io.puts ANSI::Code.bold("#{assertion}")
+        io.puts "***** FAIL *****".ansi(:red)
+        io.puts "#{assertion}".ansi(:bold)
         io.puts ":#{backtrace}:"
         #io.puts assertion if $VERBOSE
         io.puts

data/lib/qed/reporter/html.rb

@@ -1,11 +1,29 @@
 module QED
-module Reporter #:nodoc:
+module Reporter
 
-  require 'qed/reporter/base'
+  require 'qed/reporter/abstract'
 
   # = Html Reporter
   #
-  class Html < BaseClass
+  # TODO: This must be completely redesigned since we moved back
+  # to text based evaluation --which makes generting HTML with 
+  # modifications from the evaluation tricky. But I've come up
+  # with a farily clever way to handle this. Take the original
+  # and use Tilt to translate it into HTML, then take the
+  # evaluation results for code steps and use it to search
+  # the HTML for "the closest match". Find the \<pre> tag
+  # associated with the text and add class and color style.
+  # Of course the tricky part is the matching, but if we
+  # run the text snippet through Tilt as well we should be
+  # able to get an exact match. It won't be fast, but it should
+  # work.
+
+  class Html < Abstract
+
+    #
+    def initialize(*args)
+      raise "HTML format is not currently working"
+    end
 
     #
     def pass(step)

data/lib/qed/reporter/verbatim.rb

@@ -1,44 +1,46 @@
 module QED
 module Reporter #:nodoc:
 
-  require 'qed/reporter/base'
+  require 'qed/reporter/abstract'
 
   # = Verbose ANSI Console Reporter
   #
-  class Verbatim < BaseClass
+  class Verbatim < Abstract
 
     #
-    def tag(element)
-      case element.name
-      when 'pre'
-        # none
-      when /h\d/
-        io.print ANSI::Code.bold("#{element.text.strip}\n\n")
-      when 'p'
-        io.print "#{element.text.strip}\n\n"
-      #when 'a'
-      #  io.print element.to_s
-      when 'ul', 'ol'
-        io.print "\n"
-      when 'li'
-        io.print "* #{element.text.strip}\n"
+    def text(section)
+      case section.text
+      when /^\=/
+        io.puts "#{section.text}".ansi(:bold)
+      else
+        io.puts(section.text + "\n")
+      end
+      if !section.cont.empty?
+        section.cont.each do |c|
+          io.puts(c.ansi(:blue))
+          io.puts
+        end
       end
     end
 
+    # headers ?
+
     #
     def pass(step)
       txt = step.text.rstrip.sub("\n",'')
-      io.print ANSI::Code.green("#{txt}\n\n")
+      io.print "#{txt}\n\n".ansi(:green)
     end
 
     #
     def fail(step, error)
       txt = step.text.rstrip.sub("\n",'')
       tab = step.text.index(/\S/) - 1
-      io.print ANSI::Code.red("#{txt}\n\n")
+      io.print "#{txt}\n\n".ansi(:red)
       msg = []
-      msg << ANSI::Code.bold(ANSI::Code.red("FAIL: ")) + error.to_str
-      msg << ANSI::Code.bold(clean_backtrace(error.backtrace[0]))
+      #msg << ANSI::Code.bold(ANSI::Code.red("FAIL: ")) + error.to_str
+      #msg << ANSI::Code.bold(clean_backtrace(error.backtrace[0]))
+      msg << "FAIL: ".ansi(:bold, :red) + error.to_str
+      msg << clean_backtrace(error.backtrace[0]).ansi(:bold)
       io.puts msg.join("\n").tabto(tab||2)
       io.puts
     end
@@ -48,11 +50,11 @@ module Reporter #:nodoc:
       raise error if $DEBUG
       txt = step.text.rstrip.sub("\n",'')
       tab = step.text.index(/\S/) - 1
-      io.print ANSI::Code.red("#{txt}\n\n")
+      io.print "#{txt}\n\n".ansi(:red)
       msg = []
-      msg << ANSI::Code.bold(ANSI::Code.red("ERROR: ")) + error.to_str.sub(/for QED::Context.*?$/,'')
-      msg << ANSI::Code.bold(clean_backtrace(error.backtrace[0]))
-      #msg = ANSICode.red(msg)
+      msg << "ERROR: #{error.class} ".ansi(:bold,:red) + error.to_str #.sub(/for QED::Context.*?$/,'')
+      msg << clean_backtrace(error.backtrace[0]).ansi(:bold)
+      #msg = msg.ansi(:red)
       io.puts msg.join("\n").tabto(tab||2)
       io.puts
     end
@@ -65,14 +67,14 @@ module Reporter #:nodoc:
     #end
 
     #def report_table(set)
-    #  puts ANSICode.magenta(set.to_yaml.tabto(2))
+    #  puts set.to_yaml.tabto(2).ansi(:magenta)
     #end
 
     #
     #def macro(step)
     #  #io.puts
     #  #io.puts step.text
-    #  io.print ANSICode.magenta("#{step}")
+    #  io.print "#{step}".ansi(:magenta)
     #  #io.puts
     #end
 

data/lib/qed/scope.rb

@@ -1,102 +1,118 @@
-module QED
-
-  require 'ae'
-  require 'qed/advice'
+require 'ae'
 
-  # This module provides the QED syntax (domain specific language)
-  # used to build QED documents.
+module QED
 
-  module DomainLanguage
+  # Scope is the context in which QED documents are run.
+  #
+  class Scope < Module
+ 
+    #
+    def self.new(applique)
+      @applique = applique
+      super(applique)
+    end
 
-    include Advisable
+    #
+    def self.const_missing(name)
+      @applique.const_get(name)
+    end
 
-    # Table-based steps.
-    #--
-    # TODO: Utilize HTML table element for tables.
-    #++
-    def Table(file=nil, &blk)
-      file = file || @_tables.last
-      tbl = YAML.load(File.new(file))
-      tbl.each do |set|
-        blk.call(*set)
-      end
-      @__tables__ ||= []
-      @__tables__ << file
+    #
+    def initialize(applique)
+      super()
+      @applique = applique
+      extend self
+      extend applique # TODO: extend or include applique or none ?
+      #extend DSLi
+      create_clean_binding_method
     end
 
-    # Read/Write a static data fixture.
-    #--
-    # TODO: Perhaps #Data would be best as some sort of Kernel extension.
-    #++
-    def Data(file, &content)
-      raise if File.directory?(file)
-      if content
-        FileUtils.mkdir_p(File.dirname(fname))
-        case File.extname(file)
-        when '.yml', '.yaml'
-          File.open(file, 'w'){ |f| f << content.call.to_yaml }
-        else
-          File.open(file, 'w'){ |f| f << content.call }
-        end
-      else
-        #raise LoadError, "no such fixture file -- #{fname}" unless File.exist?(fname)
-        case File.extname(file)
-        when '.yml', '.yaml'
-          YAML.load(File.new(file))
-        else
-          File.read(file)
-        end
+    # This turned out to be the key to proper scoping.
+    def create_clean_binding_method
+      define_method(:__binding__) do
+        @__binding__ ||= binding
       end
     end
 
-    # Code match-and-transform procedure.
-    #
-    # This is useful to transform human readable code examples
-    # into proper exectuable code. For example, say you want to
-    # run shell code, but want to make if look like typical
-    # shelle examples:
-    #
-    #    $ cp fixture/a.rb fixture/b.rb
-    #
-    # You can use a transform to convert lines starting with '$'
-    # into executable Ruby using #system.
-    #
-    #    system('cp fixture/a.rb fixture/b.rb')
-    #
-    #def Transform(pattern=nil, &procedure)
-    #
-    #end
+    #module DSLi
 
-    def __binding__
-      binding
-    end
+      #def initialize
+      #  @__binding__ = binding
+      #end
 
-  end
+      #def __binding__
+      #  @__binding__
+      #end
 
-  # Scope is the context in which QED documents are run.
-  # Note, that Scope is now a facade over the TOPLEVEL.
+      #
+      #def __binding__
+      #  @__binding__ ||= binding
+      #end
 
-  class Scope
+      #
+      def eval(code)
+        super(code, __binding__)
+      end
 
-    # Reroutes Scope instance to TOPLEVEL.
-    def self.new
-      @self ||= (
-        TOPLEVEL_BINDING.eval("include QED::DomainLanguage")
-        TOPLEVEL_BINDING.eval('self')
-      )
-    end
+      #
+      def When(*patterns, &procedure)
+        @applique.When(*patterns, &procedure)
+      end
 
-    #include DomainLanguage
+      #
+      def Before(type=:code, &procedure)
+        @applique.Before(type, &procedure)
+      end
 
-    #def initialize
-    #  @__binding__ = binding
-    #end
+      #
+      def After(type=:code, &procedure)
+        @applique.After(type, &procedure)
+      end
+
+      # Table-based steps.
+      #--
+      # TODO: Look for files relative to script first?
+      #++
+      def Table(file=nil, &blk)
+        file = file || @_tables.last
+        tbl = YAML.load(File.new(file))
+        tbl.each do |set|
+          blk.call(*set)
+        end
+        @__tables__ ||= []
+        @__tables__ << file
+      end
+
+      # Read/Write a static data fixture.
+      #--
+      # TODO: Perhaps #Data would be best as some sort of Kernel extension.
+      #
+      # TODO: Look for files relative to script first?
+      #++
+      def Data(file, &content)
+        raise if File.directory?(file)
+        if content
+          FileUtils.mkdir_p(File.dirname(fname))
+          case File.extname(file)
+          when '.yml', '.yaml'
+            File.open(file, 'w'){ |f| f << content.call.to_yaml }
+          else
+            File.open(file, 'w'){ |f| f << content.call }
+          end
+        else
+          #raise LoadError, "no such fixture file -- #{fname}" unless File.exist?(fname)
+          case File.extname(file)
+          when '.yml', '.yaml'
+            YAML.load(File.new(file))
+          else
+            File.read(file)
+          end
+        end
+      end
 
-    #def __binding__
-    #  @__binding__
-    #end
-  end
+    #end#module DSL
 
-end
+  end#class Scope
 
+end#module QED