qed 2.6.3 → 2.7.0

data/lib/qed/reporter/verbatim.rb

@@ -10,78 +10,120 @@ module Reporter #:nodoc:
     #
     def before_session(session)
       @start_time = Time.now
+
+      trap "INFO" do
+        print_time
+        print_tally
+      end if INFO_SIGNAL
     end
 
-    #
-    def head(step)
-      io.print step.text.ansi(:bold)
+    def step(step)
+      @_explain = step.explain.dup
     end
 
     #
-    def desc(step)
+    def match(step, md)
+      unless md[0].empty?
+        @_explain.sub!(md[0], md[0].ansi(:bold))
+      end
     end
 
     #
-    def data(step)
-      #io.puts step.clean_text.ansi(:blue)
-      #io.puts
+    def applique(step)
+      io.print "#{@_explain}".ansi(:cyan)
+      io.print "#{step.example}" #.ansi(:blue)
     end
 
     #
     def pass(step)
       super(step)
-      if step.code?
-        io.print "#{step.text}".ansi(:green)
-      elsif step.header?
-        io.print "#{step.text}".ansi(:bold)
-      elsif step.data?
-        io.print "#{step.text}".ansi(:blue)
+      if step.heading?
+        if step.code?
+          io.print "#{@_explain}".ansi(:bold, :cyan)
+        else
+          io.print "#{@_explain}".ansi(:bold)
+        end
       else
-        io.print "#{step.text}"
+        io.print "#{@_explain}".ansi(:cyan)
+      end
+
+      if step.has_example? 
+        if step.data?
+          io.print "#{step.example}" #.ansi(:magenta)
+        else
+          io.print "#{step.example}".ansi(:green)
+        end
       end
     end
 
     #
     def fail(step, error)
       super(step, error)
-      txt = step.text.rstrip #.sub("\n",'')
+
       tab = step.text.index(/\S/)
-      io.print "#{txt}\n\n".ansi(:red)
+
+      if step.heading?
+        if step.code?
+          io.print "#{@_explain}".ansi(:bold, :magenta)
+        else
+          io.print "#{@_explain}".ansi(:bold)
+        end
+      else
+        io.print "#{@_explain}".ansi(:magenta)
+      end
+
+      if step.has_example? 
+        if step.data?
+          io.print "#{step.example}".ansi(:red)
+        else
+          io.print "#{step.example}".ansi(:red)
+        end
+      end
+
       msg = []
-      #msg << ANSI::Code.bold(ANSI::Code.red("FAIL: ")) + error.message
-      #msg << ANSI::Code.bold(clean_backtrace(error.backtrace[0]))
       msg << "FAIL: ".ansi(:bold, :red) + error.message.to_s #to_str
-      msg << sane_backtrace(error).first.ansi(:bold)
-      io.puts msg.join("\n").tabto(tab||2)
+      msg << sane_backtrace(error).join("\n").ansi(:bold)
+      msg = msg.join("\n")
+
+      io.puts msg.tabto(tab||2)
       io.puts
     end
 
     #
     def error(step, error)
       super(step, error)
-      raise error if $DEBUG
-      txt = step.text.rstrip #.sub("\n",'')
+
+      raise error if $DEBUG   # TODO: Should this be here?
+
       tab = step.text.index(/\S/)
-      io.print "#{txt}\n\n".ansi(:red)
+
+      if step.heading?
+        if step.code?
+          io.print "#{@_explain}".ansi(:bold, :magenta)
+        else
+          io.print "#{@_explain}".ansi(:bold)
+        end
+      else
+        io.print "#{@_explain}".ansi(:magenta)
+      end
+
+      if step.has_example? 
+        if step.data?
+          io.print "#{step.example}".ansi(:red)
+        else
+          io.print "#{step.example}".ansi(:red)
+        end
+      end
+
       msg = []
       msg << "ERROR: #{error.class} ".ansi(:bold,:red) + error.message #.sub(/for QED::Context.*?$/,'')
-      msg << sane_backtrace(error).first.ansi(:bold)
-      #msg = msg.ansi(:red)
-      io.puts msg.join("\n").tabto(tab||2)
+      msg << sane_backtrace(error).join("\n").ansi(:bold)
+      msg = msg.join("\n") #.ansi(:red)
+
+      io.puts msg.tabto(tab||2)
       io.puts
     end
 
-    #def report(str)
-    #  count[-1] += 1 unless count.empty?
-    #  str = str.chomp('.') + '.'
-    #  str = count.join('.') + ' ' + str
-    #  puts str.strip
-    #end
-
-    #def report_table(set)
-    #  puts set.to_yaml.tabto(2).ansi(:magenta)
-    #end
-
     #
     #def macro(step)
     #  #io.puts
@@ -92,6 +134,7 @@ module Reporter #:nodoc:
 
     #
     def after_session(session)
+      trap 'INFO', 'DEFAULT' if INFO_SIGNAL
       print_time
       print_tally
     end
@@ -100,4 +143,3 @@ module Reporter #:nodoc:
 
 end #module Reporter
 end #module QED
-

data/lib/qed/scope.rb

@@ -9,29 +9,18 @@ module QED
     # Location of `qed/scope.rb`.
     DIRECTORY = File.dirname(__FILE__)
 
-    #
-    #    def self.new(applique, file)
-    #      @_applique = applique
-    #      super(applique, file)
-    #    end
+    # Setup new Scope instance.
+    def initialize(demo, options={})
+      super()
 
-    #    #
-    #    def self.const_missing(name)
-    #      @_applique.const_get(name)
-    #    end
+      @_applique = demo.applique_prime
 
-    #
-    def initialize(applique, cwd, file=nil)
-      super()
-      @_applique = applique
-      @_cwd      = cwd
-      @_file     = file
-      #@loadlist = []
+      @_file     = demo.file
+      @_root     = options[:root] || $ROOT  # FIXME
 
-      include *applique
-      #extend self
-      #extend applique # TODO: extend or include applique or none ?
-      #extend DSLi
+      @_features = []
+
+      include *demo.applique
 
       # TODO: custom extends?
 
@@ -40,9 +29,6 @@ module QED
 
     # This turns out to be the key to proper scoping.
     def __create_clean_binding_method__
-      #define_method(:__binding__) do
-      #  @__binding__ ||= binding
-      #end
       module_eval %{
         def __binding__
           @__binding__ ||= binding
@@ -53,7 +39,7 @@ module QED
     #
     def include(*modules)
       super(*modules)
-      extend self
+      extend self  # overcome dynamic inclusion problem
     end
 
     # Expanded dirname of +file+.
@@ -62,43 +48,39 @@ module QED
     end
 
     # Evaluate code in the context of the scope's special binding.
-    # The return result of the evaluation is stored in `@_`.
+    # The return value of the evaluation is stored in `@_`.
     #
-    # TODO: rename to avoid conflict with Kernel method.
-    def eval(code, file=nil, line=nil)
+    def evaluate(code, file=nil, line=nil)
       if file
-        @_ = super(code, __binding__, file.to_s, line.to_i)
+        @_ = eval(code, __binding__, file.to_s, line.to_i)
       else
-        @_ = super(code, __binding__)
+        @_ = eval(code, __binding__)
       end
     end
 
+    # TODO: Alternative to Plugin gem? If not improve and make standard requirement.
+
     # Utilize is like #require, but will evaluate the script in the context
     # of the current scope.
-    #--
-    # TODO: Alternative to Plugin gem?
     #
-    # TODO: Should work like require so same file isn't loaded twice.
-    #++
     def utilize(file)
       file = Dir[DIRECTORY + "/helpers/#{file}"].first
       if !file
         require 'plugin'
         file = Plugin.find("#{file}{,.rb}", :directory=>nil)
       end
-      if file
+      if file && !@_features.include?(file)
         code = File.read(file)
-        eval(code, nil, file)
+        evaluate(code, nil, file)
       else
         raise LoadError, "no such file -- #{file}"
       end
     end
 
-
     # Define "when" advice.
     def When(*patterns, &procedure)
-      patterns = patterns.map{ |pat| pat == :text ? :desc : pat }
-      @_applique.first.When(*patterns, &procedure)
+      #patterns = patterns.map{ |pat| pat == :text ? :desc : pat }
+      @_applique.When(*patterns, &procedure)
     end
 
     # Define "before" advice. Default type is :each, which
@@ -106,7 +88,7 @@ module QED
     def Before(type=:each, &procedure)
       type = :step if type == :each
       type = :demo if type == :all
-      @_applique.first.Before(type, &procedure)
+      @_applique.Before(type, &procedure)
     end
 
     # Define "after" advice. Default type is :each, which
@@ -114,7 +96,7 @@ module QED
     def After(type=:each, &procedure)
       type = :step if type == :each
       type = :demo if type == :all
-      @_applique.first.After(type, &procedure)
+      @_applique.After(type, &procedure)
     end
 
     # Directory of current document.
@@ -126,13 +108,14 @@ module QED
       end
     end
 
-    # TODO: Should Table and Data be extensions that can be loaded if desired?
+    # TODO: Should Table and Data be extensions that can be optionally loaded?
+
+    # TODO: Cache Table and Data for speed ?
 
     # Use sample table to run steps. The table file is located 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, options={}) #:yield:
       if file
         file = Dir.glob(File.join(File.dirname(@_file), file)).first || file
@@ -166,9 +149,6 @@ module QED
     # Read a static data file and yield contents to block if given.
     #
     # This method no longer automatically uses YAML.load.
-    #--
-    # TODO: Cache data for speed ?
-    #++
     def Data(file) #:yield:
       file = Dir.glob(File.join(File.dirname(@_file), file)).first || file
       #case File.extname(file)
@@ -184,9 +164,10 @@ module QED
       end
     end
 
-    # Clear temporary work directory.
+    # Helper method to clear temporary work directory.
+    #
     def clear_working_directory!
-      dir = @_cwd
+      dir = @_root
       dir = File.expand_path(dir)
 
       if dir == '/' or dir == File.expand_path('~')
@@ -201,7 +182,13 @@ module QED
       dirs.each  { |dir|  FileUtils.rmdir(dir) }
     end
 
-    #
+    # TODO: Project's root directory.
+    #def rootdir
+    #  @_root
+    #end
+
+    # Redirect constant missing to toplevel (i.e. Object). This is 
+    # to allow the evaluation scope to emulate the toplevel.
     def const_missing(const)
       Object.const_get(const)
     end

data/lib/qed/session.rb

@@ -58,8 +58,9 @@ module QED
 
       @files = [files].flatten.compact
       @files = [DEFAULT_FILES.find{ |d| File.directory?(d) }] if @files.empty?
+      @files = @files.compact
 
-      @format    = options[:format]   || :dotprogress
+      @format    = options[:format]   || :dot
       @trace     = options[:trace]    || false
       @mode      = options[:mode]     || nil
       @profile   = options[:profile]  || :default
@@ -93,29 +94,28 @@ module QED
     # Instance of selected Reporter subclass.
     def reporter
       @reporter ||= (
-        name = Reporter.constants.find{ |c| /#{format}/ =~ c.downcase }
+        name = Reporter.constants.find{ |c| /#{format}/ =~ c.to_s.downcase }
         Reporter.const_get(name).new(:trace => trace)
       )
     end
 
-    # Returns an Array of Demo instances.
-    #--
     # TODO: Pass settings to demo, so we can get temporary_directory.
-    #++
+
+    # Returns an Array of Demo instances.
     def demos
       @demos ||= demo_files.map{ |file| Demo.new(file, :mode=>mode, :at=>directory) }
     end
 
+    # List of observers to pass to the evaluator. Only includes the reporter
+    # instance, by default.
     #
     def observers
       [reporter]
     end
 
-    # Run session.
-    #--
     # TODO: remove loadpath additions when done
-    #++
-    # COMMIT: Pre-parse demos before running them.
+
+    # Run session.
     def run
       abort "No documents." if demo_files.empty?
 
@@ -128,19 +128,19 @@ module QED
 
       Dir.chdir(directory) do
         # pre-parse demos
-        demos.each do |demo|
-          demo.steps
-        end
-
-        #profile.before_session(self)
-        reporter.before_session(self)
-        demos.each do |demo|
-          demo.run(*observers)
-          #pid = fork { demo.run(*observers) }
-          #Process.detach(pid)
+        demos.each{ |demo| demo.steps }
+
+        # Let's do it.
+        observers.each{ |o| o.before_session(self) }
+        begin
+          demos.each do |demo|
+            Evaluator.run(demo, :observers=>observers, :settings=>settings) #demo.run(*observers)
+            #pid = fork { demo.run(*observers) }
+            #Process.detach(pid)
+          end
+        ensure
+          observers.each{ |o| o.after_session(self) }
         end
-        reporter.after_session(self)
-        #profile.after_session(self)
       end
 
       reporter.success?
@@ -163,7 +163,7 @@ module QED
 
     #
     def require_profile
-      settings.require_profile(profile)
+      settings.load_profile(profile)
     end
 
     # Returns a list of demo files. The files returned depends on the
@@ -171,22 +171,22 @@ module QED
     def demo_files
       @demo_files ||= (
         if mode == :comment
-          demos_in_comment_mode
+          demo_files_in_comment_mode
         else
-          demos_in_normal_mode
+          demo_files_in_normal_mode
         end
       )
     end
 
     # Collect default files to process in normal demo mode.
-    def demos_in_normal_mode
-      demos_gather(DEMO_TYPES)
+    def demo_files_in_normal_mode
+      demos_gather #(DEMO_TYPES)
     end
 
     # Collect default files to process in code comment mode.
     #
     # TODO: Sure removing applique files is the best approach here?
-    def demos_in_comment_mode
+    def demo_files_in_comment_mode
       files = demos_gather(CODE_TYPES)
       files = files.reject{ |f| f.index('applique/') }  # don't include applique files ???
       files
@@ -206,7 +206,8 @@ module QED
         end
       end
       files = files.flatten.uniq
-      files = files.reject{ |f| f =~ Regexp.new('\/'+omit.join('|')+'\/') }
+      #files = files.reject{ |f| f =~ Regexp.new("/\/(#{omit.join('|')})\//") }
+      files = files.reject{ |f| omit.any?{ |o| f.index("/#{o}/") } }
       files.map{|f| File.expand_path(f) }.uniq.sort
     end
 
@@ -217,123 +218,17 @@ module QED
     #  end
     #end
 
+    # Get the total test count. This method tallies up the number of
+    # _assertive_ steps.
     #
     def total_step_count
       count = 0
-      QED.all_steps.each do |step|
-        count += 1 unless step.header?
-      end
-      count
-    end
-
-    #
-    def self.cli(*argv)
-      require 'optparse'
-      require 'shellwords'
-
-      files, options = cli_parse(argv)
-
-      #if files.empty?
-      #  puts "No files."
-      #  exit -1
-      #end
-
-      session = new(files, options)
-      success = session.run
-
-      exit -1 unless success
-    end
-
-    # Instance of OptionParser
-    def self.cli_parse(argv)
-      options = {}
-      options_parser = OptionParser.new do |opt|
-        opt.banner = "Usage: qed [options] <files...>"
-
-        opt.separator("Custom Profiles:") unless settings.profiles.empty?
-
-        settings.profiles.each do |name, value|
-          o = "--#{name}"
-          opt.on(o, "#{name} custom profile") do
-            options[:profile] = name.to_sym
-          end
-        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('--tapy', '-y', "use TAP-Y reporter") do
-          options[:format] = :tapy
-        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('--script', "psuedo-reporter") do
-        #  options[:format] = :script  # psuedo-reporter
-        #end
-        opt.on('--format', '-f FORMAT', "use custom reporter") do |format|
-          options[:format] = format.to_sym
-        end
-
-        opt.separator("Control Options:")
-        opt.on('--comment', '-c', "run comment code") do
-          options[:mode] = :comment
-        end
-        opt.on('--profile', '-p NAME', "load runtime profile") do |name|
-          options[:profile] = name
-        end
-        opt.on('--loadpath', "-I PATH", "add paths to $LOAD_PATH") do |paths|
-          options[:loadpath] = paths.split(/[:;]/).map{|d| File.expand_path(d)}
-        end
-        opt.on('--require', "-r LIB", "require library") do |paths|
-          options[:requires] = paths.split(/[:;]/)
-        end
-        opt.on('--rooted', '-R', "run from project root instead of temporary directory") do
-          options[:rooted] = true
-        end
-        # COMMIT:
-        #   The qed command --trace option takes a count.
-        #   Use 0 to mean all.
-        opt.on('--trace', '-t [COUNT]', "show full backtraces for exceptions") do |cnt|
-          #options[:trace] = true
-          ENV['trace'] = cnt
-        end
-        opt.on('--warn', "run with warnings turned on") do
-          $VERBOSE = true # wish this were called $WARN!
-        end
-        opt.on('--debug', "exit immediately upon raised exception") do
-          $DEBUG   = true
-        end
-
-        opt.separator("Optional Commands:")
-        opt.on_tail('--version', "display version") do
-          puts "QED #{QED::VERSION}"
-          exit
-        end
-        opt.on_tail('--copyright', "display copyrights") do
-          puts "Copyright (c) 2008 Thomas Sawyer, Apache 2.0 License"
-          exit
-        end
-        opt.on_tail('--help', '-h', "display this help message") do
-          puts opt
-          exit
+      demos.each do |demo|
+        demo.steps.each do |step|
+          count += 1 if step.assertive?
         end
       end
-      options_parser.parse!(argv)
-      return argv, options
-    end
-
-    # TODO: Pass to Session class, instead of acting global.
-    # It is used at the class level to get profiles for the cli.
-    def self.settings
-      @settings ||= Settings.new
+      count
     end
 
   end#class Session