qed 2.5.0 → 2.5.1

data/.ruby

@@ -0,0 +1,47 @@
+--- 
+spec_version: 1.0.0
+replaces: []
+
+loadpath: 
+- lib
+name: qed
+repositories: 
+  public: git://github.com/proutils/qed.git
+conflicts: []
+
+engine_check: []
+
+title: QED
+resources: 
+  home: http://proutils.github.com/qed
+  work: http://github.com/proutils/qed
+maintainers: []
+
+requires: 
+- group: []
+
+  name: ansi
+  version: 0+
+- group: []
+
+  name: facets
+  version: 2.8+
+- group: []
+
+  name: ae
+  version: 0+
+- group: 
+  - build
+  name: syckle
+  version: 0+
+manifest: Manifest
+version: 2.5.1
+licenses: []
+
+copyright: Copyright (c) 2006 Thomas Sawyer
+authors: 
+- Thomas Sawyer <transfire@gmail.com>
+organization: RubyWorks
+description: QED (Quality Ensured Demonstrations) is a TDD/BDD framework utilizing Literate Programming techniques.
+summary: Quod Erat Demonstrandum
+created: 2006-12-16

data/bin/qed

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

data/lib/qed/demo.rb

@@ -17,19 +17,25 @@ module QED
     # Parser mode.
     attr :mode
 
+    # Working directory.
+    attr :cwd
+
     # Scope to run demonstration within. (Known as a "World" in Cucumber.)
     attr :scope
 
     # New Script
     def initialize(file, options={})
-      @file     = file
-      @scope    = options[:scope] || Scope.new(applique, file)
-      @mode     = options[:mode]
-      @binding  = @scope.__binding__
+      @file    = file
+      @mode    = options[:mode]
+      @cwd     = options[:at] || fallback_cwd
+
+      @scope   = options[:scope] || Scope.new(applique, cwd, file)
+
+      @binding = @scope.__binding__
       #apply_environment
     end
 
-    # One binding per script.
+    # One binding per demo.
     def binding
       @binding #||= @scope.__binding__
     end
@@ -46,8 +52,8 @@ module QED
 
     #
     def evaluate(code, line)
-      eval(code, @binding, @file, line)
-      #@scope.module_eval(section.text, @file, section.line)
+      #eval(code, @binding, @file, line)
+      @scope.eval(code, @file, line)
     end
 
     # Returns a cached Array of Applique modules.
@@ -105,6 +111,11 @@ module QED
     #  )
     #end
 
+    # This shouldn't be needed, but is here as a precaution.
+    def fallback_cwd
+      @dir ||= File.join(Dir.tmpdir, 'qed', File.filename(Dir.pwd), Time.new.strftime("%Y%m%d%H%M%S"))
+    end
+
   end
 
 end

data/lib/qed/evaluator.rb

@@ -67,10 +67,14 @@ module QED
         advise!(:when, step) # triggers matchers
       rescue SystemExit
         pass!(step)
-      rescue Assertion => exception
-        fail!(step, exception)
+      #rescue Assertion => exception
+      #  fail!(step, exception)
       rescue Exception => exception
-        error!(step, exception)
+        if exception.assertion?
+          fail!(step, exception)
+        else
+          error!(step, exception)
+        end
       else
         pass!(step)
       end
@@ -78,7 +82,22 @@ module QED
 
     #
     def evaluate_data(step)
-      advise!(:data, step)
+      #advise!(:data, step)
+      begin
+        advise!(:data, step)
+      rescue SystemExit
+        pass!(step)
+      #rescue Assertion => exception
+      #  fail!(step, exception)
+      rescue Exception => exception
+        if exception.assertion?
+          fail!(step, exception)
+        else
+          error!(step, exception)
+        end
+      else
+        pass!(step)
+      end
     end
 
     # Evaluate a demo step.
@@ -87,11 +106,15 @@ module QED
         advise!(:code, step)
         @script.evaluate(step.code, step.lineno)
       rescue SystemExit
-        pass!(step)
-      rescue Assertion => exception
-        fail!(step, exception)
+        pass!(step)  # TODO: skip!(step)
+      #rescue Assertion => exception
+      #  fail!(step, exception)
       rescue Exception => exception
-        error!(step, exception)
+        if exception.assertion?
+          fail!(step, exception)
+        else
+          error!(step, exception)
+        end
       else
         pass!(step)
       end

data/lib/qed/reporter/abstract.rb

@@ -189,7 +189,7 @@ module Reporter
 
     # After running a step that raised an error.
     def error(step, exception)
-      raise exception if $DEBUG
+      raise exception if $DEBUG  # TODO: do we really want to do it like this?
       #@error << [step, exception]
     end
 
@@ -237,8 +237,8 @@ module Reporter
     end
 
     def print_tally
-      assert_count = Assertion.count
-      assert_fails = Assertion.fails
+      assert_count = AE::Assertor.counts[:total]
+      assert_fails = AE::Assertor.counts[:fail]
       assert_delta = assert_count - assert_fails
 
       mask = "%s demos, %s steps: %s failures, %s errors (%s/%s assertions)"
@@ -253,7 +253,7 @@ module Reporter
     end
 
     #
-    INTERNALS = /(lib|bin)[\\\/]qed/
+    INTERNALS = /(lib|bin)[\\\/](qed|ae)/
 
 =begin
     # Clean the backtrace of any reference to ko/ paths and code.

data/lib/qed/reporter/verbatim.rb

@@ -23,8 +23,8 @@ module Reporter #:nodoc:
 
     #
     def data(step)
-      io.puts step.clean_text.ansi(:blue)
-      io.puts
+      #io.puts step.clean_text.ansi(:blue)
+      #io.puts
     end
 
     #
@@ -34,6 +34,8 @@ module Reporter #:nodoc:
         io.print "#{step.text}".ansi(:green)
       elsif step.header?
         io.print "#{step.text}".ansi(:bold)
+      elsif step.data?
+        io.print "#{step.text}".ansi(:blue)
       else
         io.print "#{step.text}"
       end
@@ -48,7 +50,7 @@ module Reporter #:nodoc:
       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_str
+      msg << "FAIL: ".ansi(:bold, :red) + error.message.to_s #to_str
       msg << clean_backtrace(error.backtrace[0]).ansi(:bold)
       io.puts msg.join("\n").tabto(tab||2)
       io.puts

data/lib/qed/scope.rb

@@ -21,9 +21,10 @@ module QED
     #    end
 
     #
-    def initialize(applique, file=nil)
+    def initialize(applique, cwd, file=nil)
       super()
       @_applique = applique
+      @_cwd      = cwd
       @_file     = file
       #@loadlist = []
 
@@ -61,12 +62,12 @@ module QED
     end
 
     # Evaluate code in the context of the scope's special binding.
-    def eval(code, binding=nil, file=nil)
-      super(code, binding || __binding__, @_file)
+    # The return result of the evaluation is stored in `@_`.
+    def eval(code, file=nil, line=nil)
+      @_ = super(code, __binding__, @_file, line)
     end
 
 
-
     # Utilize is like #require, but will evaluate the script in the context
     # of the current scope.
     #--
@@ -89,7 +90,6 @@ module QED
     end
 
 
-
     # Define "when" advice.
     def When(*patterns, &procedure)
       patterns = patterns.map{ |pat| pat == :text ? :desc : pat }
@@ -113,7 +113,6 @@ module QED
     end
 
 
-
     # TODO: Should Table and Data be extensions that can be loaded if desired?
 
     # Use sample table to run steps. The table file will be
@@ -165,6 +164,23 @@ module QED
       #end
     end
 
+    # Clear temporary work directory.
+    def clear_working_directory!
+      dir = @_cwd
+      dir = File.expand_path(dir)
+
+      if dir == '/' or dir == File.expand_path('~')
+        abort "DANGER! Trying to use home or root as a temporary directory!"
+      end
+
+      entries = Dir.glob(File.join(dir, '**/*'))
+
+      dirs, files = entries.partition{ |f| File.directory?(f) }
+
+      files.each { |file| FileUtils.rm(file)   }
+      dirs.each  { |dir|  FileUtils.rmdir(dir) }
+    end
+
     #
     def const_missing(const)
       Object.const_get(const)

data/lib/qed/session.rb

@@ -1,6 +1,6 @@
 module QED
 
-  #require 'qed/config'
+  require 'qed/settings'
   require 'qed/demo'
 
   # The Session class encapsulates a set of demonstrations 
@@ -9,27 +9,66 @@ module QED
   #
   class Session
 
-    # Demonstration files.
-    attr :files
+    # Default recognized demos file types.
+    DEMO_TYPES = %w{qed rdoc md markdown}
+
+    #
+    CODE_TYPES = %w{rb}
+
+    # Directory names to omit from automatic selection.
+    OMIT_PATHS = %w{applique helpers support sample samples fixture fixtures}
+
+    # Demonstration files (or globs).
+    attr_reader :files
+
+    # File patterns to omit.
+    attr_accessor :omit
 
     # Output format.
     attr_accessor :format
 
-    # Trace mode
+    # Trace execution?
     attr_accessor :trace
 
-    #
+    # Parse mode.
     attr_accessor :mode
 
+    # Paths to be added to $LOAD_PATH.
+    attr_reader :loadpath
+
+    # Libraries to be required.
+    attr_reader :requires
+
+    # Do not operate from project root?
+    attr_accessor :rootless
+
+    # Selected profile.
+    attr_accessor :profile
+
+    # Returns instance of Settings class.
+    attr :settings
+
     # New Session
     def initialize(files, options={})
       require_reporters
 
-      @files  = [files].flatten
+      @files     = [files].flatten
+
+      @format    = options[:format]   || :dotprogress
+      @trace     = options[:trace]    || false
+      @mode      = options[:mode]     || nil
+      @profile   = options[:profile]  || :default
+      @loadpath  = options[:loadpath] || []
+      @requires  = options[:requires] || []
 
-      @mode   = options[:mode]
-      @trace  = options[:trace]  || false
-      @format = options[:format] || :dotprogress
+      @omit      = OMIT_PATHS  # TODO: eventually make configurable
+
+      @settings  = Settings.new(options)
+    end
+
+    #
+    def directory
+      settings.tmpdir
     end
 
     # Top-level configuration.
@@ -53,8 +92,11 @@ module QED
     end
 
     # Returns an Array of Demo instances.
+    #--
+    # TODO: Pass settings to demo, so we can get temporary_dirctory.
+    #++
     def demos
-      @demos ||= files.map{ |file| Demo.new(file, :mode=>mode) }
+      @demos ||= demo_files.map{ |file| Demo.new(file, :mode=>mode, :at=>directory) }
     end
 
     #
@@ -63,16 +105,94 @@ module QED
     end
 
     # Run session.
+    #--
+    # TODO: remove loadpath additions when done
+    #++
     def run
-      #profile.before_session(self)
-      reporter.before_session(self)
-      demos.each do |demo|
-        demo.run(*observers)
-        #pid = fork { demo.run(*observers) }
-        #Process.detach(pid)
+      abort "No documents." if demo_files.empty?
+
+      clear_directory
+
+      prepare_loadpath
+      require_libraries
+
+      require_profile  # TODO: here or in chdir?
+
+      Dir.chdir(directory) do
+        #profile.before_session(self)
+        reporter.before_session(self)
+        demos.each do |demo|
+          demo.run(*observers)
+          #pid = fork { demo.run(*observers) }
+          #Process.detach(pid)
+        end
+        reporter.after_session(self)
+        #profile.after_session(self)
+      end
+    end
+
+    #
+    def clear_directory
+      settings.clear_directory
+    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
+
+    #
+    def require_profile
+      settings.require_profile(profile)
+    end
+
+    # Returns a list of demo files. The files returned depends on the
+    # +files+ attribute and if none given, then the current run mode.
+    def demo_files
+      @demo_files ||= (
+        if mode == :comment
+          demos_in_comment_mode
+        else
+          demos_in_normal_mode
+        end
+      )
+    end
+
+    # Collect default files to process in normal demo mode.
+    def demos_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
+      files = demos_gather(CODE_TYPES)
+      files = files.reject{ |f| f.index('applique/') }  # don't include applique files ???
+      files
+    end
+
+    # Gather list of demo files. Uses +omit+ to remove certain files
+    # based on the name of their parent directory.
+    def demos_gather(extensions=DEMO_TYPES)
+      files = self.files
+      #files << default_location if files.empty?
+      files = files.map{|pattern| Dir[pattern]}.flatten.uniq
+      files = files.map do |file|
+        if File.directory?(file)
+          Dir[File.join(file,'**','*.{' + extensions.join(',') + '}')]
+        else
+          file
+        end
       end
-      reporter.after_session(self)
-      #profile.after_session(self)
+      files = files.flatten.uniq
+      files = files.reject{ |f| f =~ Regexp.new('\/'+omit.join('|')+'\/') }
+      files.map{|f| File.expand_path(f) }.uniq.sort
     end
 
     # Globally applicable advice.
@@ -82,6 +202,108 @@ module QED
     #  end
     #end
 
+    #
+    def self.cli(*argv)
+      require 'optparse'
+      require 'shellwords'
+
+      files, options = cli_parse(argv)
+
+      if files.empty?
+        puts "No files."
+        puts options_parser
+        exit -1
+      end
+
+      session = new(files, options)
+      session.run
+    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('--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('--rootless', '-R', "run from system-wide temporary directory") do
+          options[:rootless] = true
+        end
+        opt.on('--trace', '-t', "show full backtraces for exceptions") do
+          options[:trace] = true
+        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
+        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
+    end
+
   end#class Session
 
 end#module QED