qed 2.2.1 → 2.2.2

data/{HISTORY → History.rdoc}

@@ -1,18 +1,34 @@
 = RELEASE HISTORY
 
-== 2.2.1 / 2010-06-21
+== 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.
 
-Change:
+Changes:
 
 * Removed HTML parsing dependencies.
 * Reduce Advice to a single class.
 
 
-== 2.2.0 / 2010-06-20
+== 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

data/PROFILE

@@ -11,6 +11,6 @@ description:
 
 resources:
   home: http://proutils.github.com/qed
-  work: http://github.com/protuils/qed
+  work: http://github.com/proutils/qed
   repo: git://github.com/proutils/qed.git
 

data/README.rdoc

@@ -1,6 +1,6 @@
 = Ruby Q.E.D.
 
-      homepage: http://proutils.rubyforge.org/qed
+      homepage: http://proutils.github.com/qed
   mailing list: http://groups.google.com/group/proutils
    development: http://github.com/proutils/qed
 

data/VERSION

@@ -1,5 +1,5 @@
 name : qed
 major: 2
 minor: 2
-patch: 1
-date : 2010-06-20
+patch: 2
+date : 2010-06-21

data/bin/qed

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require 'qed/command'
-QED::Command.execute
+require 'qed'
+QED.main(*ARGV)
 

data/demo/02_advice.rdoc

@@ -114,7 +114,6 @@ So +x+ should now contain these three list samples.
 
   x.assert == [ 'SampleA', 'SampleB', 'SampleC' ]
 
-
 == Pattern Matchers
 
 QED also supports comment match triggers. With the +When+ method one can

data/demo/04_samples.rdoc

@@ -0,0 +1,49 @@
+= Test Samples
+
+== Flat-file Data
+
+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/
+
+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.assert =~ /dolor/
+    end
+
+Files are looked-up relative to the location of the current document.
+If not found then they will be looked-up relative to the current
+working directory.
+
+== Tabular Data
+
+The +Table+ method is similar to the +Data+ method except that it
+expects a YAML file, and it can take a block to iterate the data over.
+This makes it easy to test tables of examples.
+
+The arity of the table block corresponds to the number of columns in
+each row of the table. Each row is assigned in turn and run through
+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|
+      x.upcase.assert == y
+    end
+
+Without the block, the +Table+ methods simply returns the sample data.
+
+== Considerations
+
+Both Data and Table are some what "old fashion" approches to sample
+data. New techinques using plain text blocks are more convenient
+in that the data can be stored directly in the demonstration itself.
+However, for especially large data sets and external file is still
+the better option, and +Data+ and +Table+ make them quite easy to
+access.
+

data/lib/qed.rb

@@ -21,5 +21,6 @@ module QED
   end
 end
 
+require 'qed/command'
 require 'qed/session'
 

data/lib/qed/command.rb

@@ -1,26 +1,39 @@
-#!/usr/bin/env ruby
-
-require 'qed'
 require 'optparse'
 require 'shellwords'
 
 module QED
 
+  def self.main(*argv)
+    Command.main(*argv)
+  end
+
   # = QED Commandline Tool
   #
+  # TODO: Merge Command with Session ?
   class Command
 
-    # Configuration directory.
-    CONFDIR = "{.,}config/qed"
+    # 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 = "{.,.config/,config/}qed"
+
+    # Default location of demonstrations if no specific files
+    # or locations given. This is use in Dir.glob. The default
+    # locations are qed/, demo/ or demos/, searched for in that
+    # order relative to the root directory.
+    DEMO_LOCATION = '{qed,demo,demos}'
+
+    # Glob pattern used to search for project's root directory.
+    ROOT_PATTERN = '{.root,.git,.hg,_darcs}/'
 
-    # Default location of demonstrations if no
-    # specific files or locations given. This
-    # is use in Dir.glob.
-    DEFAULT_DEMO_LOCATION = '{demo,demos}'
+    # Home directory.
+    HOME = File.expand_path('~')
 
-    # Initialize and execute.
-    def self.execute
-      new.execute
+    # Instantiate a new Command object and call #execute.
+    def self.main(*argv)
+      new.execute(argv)
     end
 
     # Ouput format.
@@ -43,22 +56,25 @@ module QED
     # Files to be run.
     attr :files
 
-    #
+    # Ensure files are in a flat list.
     def files=(globs)
       @files = [globs].flatten
     end
 
-    #
+    # Paths to be added to $LOAD_PATH.
     attr_accessor :loadpath
 
-    #
+    # Libraries to be required.
     attr_accessor :requires
 
-    #
+    # ?
     attr_accessor :extension
 
-    # TODO: Should extension and profile have a common reference?
+    # Move to root directory?
+    attr_accessor :root
 
+    #
+    # TODO: Should extension and profile have a common reference?
     def initialize
       @format    = :dotprogress
       @extension = :default
@@ -70,7 +86,6 @@ module QED
     end
 
     # Instance of OptionParser
-
     def opts
       @opts ||= OptionParser.new do |opt|
 
@@ -84,113 +99,96 @@ module QED
         end
 
         opt.separator("Report Formats (pick one):")
-
         opt.on('--dotprogress', '-d', "use dot-progress reporter [default]") do
           @options[:format] = :dotprogress
         end
-
         opt.on('--verbatim', '-v', "use verbatim reporter") do
           @options[:format] = :verbatim
         end
-
         opt.on('--bullet', '-b', "use bullet-point reporter") do
           @options[:format] = :bullet
         end
-
         opt.on('--html', '-h', "use underlying HTML reporter") do
           @options[:format] = :html
         end
-
         opt.on('--format', '-f FORMAT', "use custom reporter") do |format|
           @options[:format] = format
         end
-
         #opt.on('--script', "psuedo-reporter") do
         #  @options[:format] = :script  # psuedo-reporter
         #end
-
         opt.separator("Control Options:")
-
-        opt.on('--ext', '-e [NAME]', "runtime extension [default]") do |name|
+        opt.on('--root', '-R', "run command from project's root directory") do
+          @options[:root] = true
+        end
+        opt.on('--ext', '-e NAME', "runtime extension [default]") do |name|
           @options[:extension] = name
         end
-
         opt.on('--loadpath', "-I PATH", "add paths to $LOAD_PATH") do |arg|
           @options[:loadpath] ||= []
           @options[:loadpath].concat(arg.split(/[:;]/).map{ |dir| File.expand_path(dir) })
         end
-
         opt.on('--require', "-r", "require library") do |arg|
           @options[:requires] ||= []
           @options[:requires].concat(arg.split(/[:;]/)) #.map{ |dir| File.expand_path(dir) })
         end
-
         opt.on('--trace', '-t', "show full backtraces for exceptions") do
           @options[:trace] = true
         end
-
         opt.on('--debug', "exit immediately upon raised exception") do
           $VERBOSE = true # wish this were called $WARN
           $DEBUG = true
         end
-
         opt.separator("Optional Commands:")
-
         opt.on_tail('--version', "display version") do
           puts "QED #{VERSION}"
           exit
         end
-
         opt.on_tail('--copyright', "display copyrights") do
           puts "Copyright (c) 2008, 2009 Thomas Sawyer, GPL License"
           exit
         end
-
         opt.on_tail('--help', '-h', "display this help message") do
           puts opt
           exit
         end
-
       end
     end
 
-    #
+    # Default recognized demos file types.
+    DEMO_TYPES = %w{qed rdoc md markdown}
+
+    # Returns a list of demo files.
     def demos
-      files = self.files
-      types = %w{qed rdoc md markdown} #Tilt.mappings.keys
-      if files.empty?
-        files << DEFAULT_DEMO_LOCATION
-      end
-      files = files.map do |pattern|
-        Dir[pattern]
-      end.flatten.uniq
-      files = files.map do |file|
-        if File.directory?(file)
-          Dir[File.join(file,'**','*.{' + types.join(',') + '}')]
-        else
-          file
+      @demos ||= (
+        files = self.files
+        if files.empty?
+          files << DEMO_LOCATION
         end
-      end
-      files = files.flatten.uniq.sort
-      #files = files.select do |file| 
-      #  %w{.yml .yaml .rb}.include?(File.extname(file))
-      #end
-      files
+        files = files.map{|pattern| Dir[pattern]}.flatten.uniq
+        files = files.map do |file|
+          if File.directory?(file)
+            Dir[File.join(file,'**','*.{' + DEMO_TYPES.join(',') + '}')]
+          else
+            file
+          end
+        end
+        files = files.flatten.uniq
+        files.map{|f| File.expand_path(f) }.sort
+      )
     end
 
     # Session instance.
-
     def session
       @session ||= Session.new(demos, :format=>format, :trace=>trace)
     end
 
     # Parse command-line options along with profile options.
-
-    def parse
-      @files = []
-      argv = ARGV.dup
-      opts.parse!(argv)
-      @files.concat(argv)
+    def parse(argv)
+      #@files = []
+      opts.parse!(argv ||= ARGV.dup)
+      #@files.concat(argv)
+      @files = argv
 
       #if profile
       if args = profiles[profile]
@@ -206,75 +204,116 @@ module QED
     end
 
     # Run demonstrations.
+    def execute(argv)
+      parse(argv)
 
-    def execute
-      parse
+      jump = @options[:root] ? root_directory : Dir.pwd
 
-      abort "No documents." if demos.empty?
+      Dir.chdir(jump) do
+        abort "No documents." if demos.empty?
 
-      prepare_loadpath
+        prepare_loadpath
 
-      require_libraries
-      require_profile
+        require_libraries
+        require_profile
 
-      session.run
+        session.run
+      end
     end
 
-    # Profile configurations.
+    # Project's root directory.
+    def root_directory
+      @root_directory ||= find_root
+    end
+
+    # Project's QED configuation directory.
+    def config_directory
+      @config_directory ||= find_config #Dir[File.join(root_directory, CONFIG_PATTERN)].first
+    end
 
+    # Profile configurations.
     def profiles
       @profiles ||= (
-        file = Dir["#{CONFDIR}/profile{,s}.{yml,yaml}"].first
+        file = Dir["#{config_directory}/profile{,s}.{yml,yaml}"].first
         file ? YAML.load(File.new(file)) : {}
       )
     end
 
     # Add to load path (from -I option).
-
     def prepare_loadpath
       loadpath.each{ |dir| $LOAD_PATH.unshift(dir) }
     end
 
     # Require libraries (from -r option).
-
     def require_libraries
       requires.each{ |file| require(file) }
     end
 
     # Require requirement file (from -e option).
-
     def require_profile
-      return unless root
-
-      # common environment, always loaded if present.
-      #if file = Dir["#{root}/#{CONFDIR}/default.rb"].first
-      #  require(file)
-      #end
-
-      #env = env() || 'default'
-
-      if file = Dir["#{root}/#{CONFDIR}/#{extension}.rb"].first
+      return unless config_directory
+      if file = Dir["#{config_directory}/#{extension}.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.
+    #
+    # * .root/
+    # * .git/
+    # * .hg/
+    # * _darcs/
+    #
+    # Failing to find any of these locations, resort to the fallback:
+    # 
+    # * lib/
     #
-    def root
-      QED.root
+    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 "Failed to resolve project's root location. Try adding a .root directory."
     end
 
-  end
+    # Locate configuration directory by seaching up the 
+    # file hierachy relative to the working directory
+    # for one of the following paths:
+    #
+    # * .qed/
+    # * .config/qed/
+    # *  config/qed/
+    #
+    def find_config
+      lookup(CONFIG_PATTERN)
+    end
 
-  # Is there no perfect way to find root directory of a project?
-  def self.root(path=nil)
-    path ||= Dir.pwd
-    path = File.dirname(path) unless File.directory?(path)
-    until path == File.dirname(path)
-      mark = Dir[File.join(path, 'README*')].first
-      return path if mark
-      path = File.dirname(path)
+    # 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
-    nil
+
   end
 
 end

data/lib/qed/package.yml

@@ -1,5 +1,5 @@
 name : qed
 major: 2
 minor: 2
-patch: 1
-date : 2010-06-20
+patch: 2
+date : 2010-06-21

data/lib/qed/parser.rb

@@ -14,38 +14,51 @@ module QED
       @ast = []
     end
 
-    #
+    # Abstract Syntax Tree
     attr :ast
 
+    # Parse the demo into an abstract syntax tree.
     #
+    # TODO: I know there has to be a faster way to do this.
     def parse
-      state = :text
-      linein = 0
-
-      text  = ''
-
+      blocks = [[]]
+      state  = :none
       @lines.each_with_index do |line, lineno|
-        if /^\S/ =~ line
-          if state == :code
-            add_section(:code, text, linein)
-            linein = lineno
-            text = ''
+        case line
+        when /^$/
+          case state 
+          when :code
+            blocks.last << line
+          when :blank
+            blocks.last << line
+          else
+            blocks.last << line
+            state = :blank
           end
+        when /^\s+/
+          blocks << [] if state != :code
+          blocks.last << line
+          state = :code
+        else
+          blocks << [] if state != :text
+          blocks.last << line
           state = :text
-          text << line          
+        end
+      end
+      blocks.shift if blocks.first.empty?
+
+      line_cnt = 1
+      blocks.each do |block|
+        text = block.join
+        case text
+        when /\A\s+/
+          add_section(:code, text, line_cnt)
         else
-          if state == :text
-            next if text.strip.empty?
-            add_section(:text, text, linein)
-            linein = lineno
-            text = ''
-          end
-          state = :code
-          text << line          
+          add_section(:text, text, line_cnt)          
         end
+        line_cnt += block.size
       end
-      add_section(state, text, linein)
-      @ast.reject!{ |sect| sect.type == :code && sect.text.strip.empty? }
+      #@ast.reject!{ |sect| sect.type == :code && sect.text.strip.empty? }
       return @ast
     end
 
@@ -53,7 +66,7 @@ module QED
     def add_section(state, text, lineno)
       case state
       when :code
-        if ast.last.raw?
+        if ast.last && ast.last.cont?
           @ast.last << text #clean_quote(text)
         else
           @ast << CodeSection.new(text, lineno)
@@ -85,23 +98,31 @@ module QED
 
     #
     class TextSection < Section
+
       attr :args
+
       attr :cont
+
       def initialize(text, line, *args)
         @text = text
         @line = line
         @args = args
         @cont = []
       end
+
+      #
       def <<(text)
         @cont << clean_continuation(text)
         @args << block_continuation(text)
       end
+
+      #
       def type
         :text
       end
+
       # TODO: Use ':' or '...' ?
-      def raw?
+      def cont?
         #/\:\s*\Z/m =~ text
         /\.\.\.\s*\Z/m =~ text
       end

data/lib/qed/profile.yml

@@ -11,6 +11,6 @@ description:
 
 resources:
   home: http://proutils.github.com/qed
-  work: http://github.com/protuils/qed
+  work: http://github.com/proutils/qed
   repo: git://github.com/proutils/qed.git
 

data/lib/qed/reporter/bullet.rb

@@ -13,7 +13,7 @@ module Reporter #:nodoc:
     def text(step)
       case step.text
       when /^\=/
-        io.puts "#{step.text}".ansi(:bold)
+        io.print "#{step.text}".ansi(:bold)
       else
         txt = step.text.to_s.strip.tabto(2)
         txt[0,1] = "*"
@@ -32,8 +32,7 @@ module Reporter #:nodoc:
       msg << "  # " + assertion.to_s
       msg = msg.ansi(:magenta)
       io.puts msg
-      #io.puts
-      io.puts "#{step.text}".ansi(:red)
+      io.print "#{step.text}".ansi(:red)
     end
 
     def error(step, exception)
@@ -44,8 +43,7 @@ module Reporter #:nodoc:
       msg << "  # " + clean_backtrace(exception.backtrace[0])
       msg = msg.ansi(:magenta)
       io.puts msg
-      #io.puts
-      io.puts "#{step.text}".ansi(:red)
+      io.print "#{step.text}".ansi(:red)
     end
 
     #def report(str)

data/lib/qed/reporter/verbatim.rb

@@ -10,10 +10,10 @@ module Reporter #:nodoc:
     #
     def text(section)
       case section.text
-      when /^\=/
-        io.puts "#{section.text}".ansi(:bold)
+      when /\A[=#]/
+        io.print "#{section.text}".ansi(:bold)
       else
-        io.puts(section.text + "\n")
+        io.print(section.text)
       end
       if !section.cont.empty?
         section.cont.each do |c|
@@ -27,14 +27,14 @@ module Reporter #:nodoc:
 
     #
     def pass(step)
-      txt = step.text.rstrip.sub("\n",'')
-      io.print "#{txt}\n\n".ansi(:green)
+      txt = step.text #.rstrip.sub("\n",'')
+      io.print "#{txt}".ansi(:green)
     end
 
     #
     def fail(step, error)
       txt = step.text.rstrip.sub("\n",'')
-      tab = step.text.index(/\S/) - 1
+      tab = step.text.index(/\S/)
       io.print "#{txt}\n\n".ansi(:red)
       msg = []
       #msg << ANSI::Code.bold(ANSI::Code.red("FAIL: ")) + error.to_str
@@ -49,7 +49,7 @@ module Reporter #:nodoc:
     def error(step, error)
       raise error if $DEBUG
       txt = step.text.rstrip.sub("\n",'')
-      tab = step.text.index(/\S/) - 1
+      tab = step.text.index(/\S/)
       io.print "#{txt}\n\n".ansi(:red)
       msg = []
       msg << "ERROR: #{error.class} ".ansi(:bold,:red) + error.to_str #.sub(/for QED::Context.*?$/,'')

data/lib/qed/scope.rb

@@ -7,110 +7,109 @@ module QED
   class Scope < Module
  
     #
-    def self.new(applique)
-      @applique = applique
-      super(applique)
+    def self.new(applique, file)
+      @_applique = applique
+      super(applique, file)
     end
 
     #
     def self.const_missing(name)
-      @applique.const_get(name)
+      @_applique.const_get(name)
     end
 
     #
-    def initialize(applique)
+    def initialize(applique, file=nil)
       super()
-      @applique = applique
+      @_applique = applique
+      @_file     = file
+
       extend self
       extend applique # TODO: extend or include applique or none ?
       #extend DSLi
-      create_clean_binding_method
+
+      # TODO: custom extends?
+
+      __create_clean_binding_method__
     end
 
-    # This turned out to be the key to proper scoping.
-    def create_clean_binding_method
+    # This turns out to be the key to proper scoping.
+    def __create_clean_binding_method__
       define_method(:__binding__) do
         @__binding__ ||= binding
       end
     end
 
-    #module DSLi
+    # Evaluate code in the context of the scope's special 
+    # binding.
+    def eval(code)
+      super(code, __binding__)
+    end
 
-      #def initialize
-      #  @__binding__ = binding
-      #end
+    # Define "when" advice.
+    def When(*patterns, &procedure)
+      @_applique.When(*patterns, &procedure)
+    end
 
-      #def __binding__
-      #  @__binding__
-      #end
+    # Define "before" advice.
+    def Before(type=:code, &procedure)
+      @_applique.Before(type, &procedure)
+    end
 
-      #
-      #def __binding__
-      #  @__binding__ ||= binding
-      #end
+    # Define "after" advice.
+    def After(type=:code, &procedure)
+      @_applique.After(type, &procedure)
+    end
 
-      #
-      def eval(code)
-        super(code, __binding__)
-      end
+    # TODO: Should Table and Data be extensions that can be loaded if desired?
 
-      #
-      def When(*patterns, &procedure)
-        @applique.When(*patterns, &procedure)
-      end
-
-      #
-      def Before(type=:code, &procedure)
-        @applique.Before(type, &procedure)
+    # Use sample table to run steps. The table file will be
+    # looked for relative to the demo, failing that it will
+    # be looked for relative to the working directory.
+    #
+    # TODO: Cache data for speed ?
+    def Table(file=nil) #:yield:
+      if file
+        file = Dir.glob(File.join(File.dirname(@_file), file)).first || file
+      else
+        file = @_last_table
       end
+      @_last_table = file
 
-      #
-      def After(type=:code, &procedure)
-        @applique.After(type, &procedure)
+      tbl  = YAML.load(File.new(file))
+      tbl.each do |set|
+        yield(*set)
       end
+    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)
+    # Read a static data sample.
+    #
+    # TODO: Cache data for speed ?
+    def Data(file) #:yield:
+      #raise if File.directory?(file)
+      #if content
+      #  FileUtils.mkdir_p(File.dirname(file))
+      #  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)
+        file = Dir.glob(File.join(File.dirname(@_file), file)).first || file
+        case File.extname(file)
+        when '.yml', '.yaml'
+          data = YAML.load(File.new(file))
+        else
+          data = File.read(file)
         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
+        if block_given?
+          yield(data)
         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
+          data
         end
-      end
-
-    #end#module DSL
+      #end
+    end
 
   end#class Scope
 

data/lib/qed/script.rb

@@ -23,7 +23,7 @@ module QED
     def initialize(applique, file, scope=nil)
       @applique = applique.dup # localize copy of applique
       @file     = file
-      @scope    = scope || Scope.new(applique)
+      @scope    = scope || Scope.new(applique, file)
       @binding  = @scope.__binding__
       #@loadlist = []
       #apply_environment
@@ -34,7 +34,7 @@ module QED
       @binding #||= @scope.__binding__
     end
 
-    #
+    # TODO: demo advice vs. applique advice
     def advice
       #@scope.__advice__
       @applique.__advice__

data/lib/qed/session.rb

@@ -42,7 +42,7 @@ module QED
     #  QED.config
     #end
 
-    # TODO: Ultimately use Plugin library.
+    # TODO: Ultimately use Plugin library to support custom reporters?
     def require_reporters
       Dir[File.dirname(__FILE__) + '/reporter/*'].each do |file|
         require file
@@ -94,7 +94,7 @@ module QED
     #  end
     #end
 
-    # TODO: associate scripts to there applique
+    # TODO: associate scripts to there applique ?
     def create_applique
       applique = Applique.new
       #eval "include QED::DomainLanguage", TOPLEVEL_BINDING

data/script/test

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

data/test/integration/topcode.rdoc

@@ -0,0 +1,8 @@
+  x = "Is this running?" 
+  x.assert == "Is this running?"
+
+This demo simply checks to make sure top code is exectued
+like any other code when there is no prior description.
+
+  x.assert == "Is this running?"
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qed
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 2
   - 2
-  - 1
-  version: 2.2.1
+  - 2
+  version: 2.2.2
 platform: ruby
 authors: 
 - Thomas Sawyer <transfire@gmail.com>
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-20 00:00:00 -04:00
+date: 2010-06-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,7 +89,7 @@ files:
 - demo/01_demos.rdoc
 - demo/02_advice.rdoc
 - demo/03_helpers.rdoc
-- demo/04_fixtures.rdoc
+- demo/04_samples.rdoc
 - demo/05_quote.rdoc
 - demo/07_toplevel.rdoc
 - demo/08_cross_script.rdoc
@@ -101,14 +101,11 @@ files:
 - demo/applique/markup.rb
 - demo/applique/quote.rb
 - demo/applique/toplevel.rb
-- demo/fixtures/data.txt
-- demo/fixtures/table.yml
 - demo/helpers/advice.rb
 - demo/helpers/sample.rb
 - demo/helpers/toplevel.rb
-- eg/hello_world.rdoc
-- eg/view_error.rdoc
-- eg/website.rdoc
+- demo/samples/data.txt
+- demo/samples/table.yml
 - lib/qed/advice.rb
 - lib/qed/applique.rb
 - lib/qed/command.rb
@@ -133,13 +130,13 @@ files:
 - lib/qedoc/document.rb
 - script/qedoc
 - script/test
+- test/integration/topcode.rdoc
 - PROFILE
+- Diary.rdoc
 - README.rdoc
-- HISTORY
 - REQUIRE
-- ROADMAP
-- DIARY.rdoc
 - VERSION
+- History.rdoc
 - COPYING
 has_rdoc: true
 homepage: http://proutils.github.com/qed

data/ROADMAP

@@ -1,12 +0,0 @@
-= ROADMAP
-
-== 2.2.0
-
-* Simplify code. I do not think we need both an Evaluator and Scope classes.
-
-== 2.3.0
-
-* Add a distributed evaluator, probably using Drb. This will allow the code
-portion of documents to run in an isolated process. It will also make it possible
-(in the long run) to run tests in parallel acrosss a cluster.
-

data/demo/04_fixtures.rdoc

@@ -1,29 +0,0 @@
-= Fixtures
-
-== Flat-file Data
-
-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 load such files.
-
-    Data('demo/fixtures/data.txt').assert =~ /dolor/
-
-All files are found relative to the location of current document.
-
-== Tabular Data
-
-The +Table+ method is similar to the +Data+ method except that it
-expects a YAML file, and it can take a block to iterate the data over.
-This makes it easy to test tables of examples.
-
-The arity of the table block corresponds to the number of columns in
-each row of the table. Each row is assigned in turn and run through
-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/fixtures/table.yml' do |x, y|
-      x.upcase.assert == y
-    end
-

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
-