qed 2.5.1 → 2.6.0

data/lib/{qedoc → qed}/document.rb

@@ -13,57 +13,86 @@ module QED
 
     DEFAULT_TITLE  = "Demonstration"
     DEFAULT_CSS    = nil #"../assets/styles/spec.css"
-    DEFAULT_OUTPUT = "doc/qedoc"
-    DEFAULT_PATH   = "test/demos"
+    DEFAULT_OUTPUT = "qed.html"
+    DEFAULT_PATH   = "qed"
 
     attr_accessor :title
+
     attr_accessor :css
-    attr_accessor :paths
+
     attr_accessor :dryrun
+
     attr_accessor :quiet
 
     # Ouput file.
     attr_accessor :output
 
+    # Either html or plain.
+    # Defaults to extension of output file.
+    attr_accessor :format
+
+    #
+    attr_reader :paths
+
+    #
+    def paths=(paths)
+      @paths = [paths].flatten
+    end
+
     # New Spec Document object.
     def initialize(options={})
       options.each do |k,v|
         __send__("#{k}=", v)
       end
 
+      @paths  ||= []
+
+      @output ||= DEFAULT_OUTPUT
       @title  ||= DEFAULT_TITLE
       @css    ||= DEFAULT_CSS
-      @output ||= DEFAULT_OUTPUT
-      @paths  ||= []
+
+      if File.directory?(@output)
+        @output = File.join(@output, 'qed.html')
+      end
+
+      @format ||= File.extname(@output).sub('.','')
 
       if @paths.empty?
-        dir = Dir['{test/demos,demos,demo}'].first || DEFAULT_PATH
-        @paths  = File.join(dir, '**', '*')
+        #dir = Dir['{test/demos,demos,demo}'].first || DEFAULT_PATH
+        #@paths  = File.join(dir, '**', '*')
+        abort "No files to document."
       end
     end
 
     # Demo files.
     def demo_files
       @demo_files ||= (
-        glob = paths.map do |f|
-          File.directory?(f) ? Dir[File.join(f,'**/*')] : Dir[f]
-        end
-        glob = glob.flatten.select do |f|
-          File.file?(f) && f !~ /fixtures\/|helpers\// && f !~ /\.rb$/
+        files = []
+        paths.each do |f|
+          if File.directory?(f)
+            files.concat Dir[File.join(f,'**','*')]
+          else
+            files.concat Dir[f]
+          end
         end
-        glob.sort
+        files = files.reject{ |f| File.directory?(f) }
+        files = files.reject{ |f| File.extname(f) == '.rb' }
+        files = files.reject{ |f| /(fixtures|helpers)\// =~ f }
+        files.sort
       )
     end
 
     # Supress output.
-    def quiet? ; @quiet ; end
+    def quiet?
+      @quiet
+    end
 
     # Generate specification document.
     def generate
-      copy_support_files
+      #copy_support_files
 
-      output = ''
-      files  = []
+      out   = ''
+      files = []
 
       #paths.each do |path|
       #  files.concat(Dir.glob(path).select{ |f| File.file?(f) })
@@ -102,33 +131,49 @@ module QED
         when '.rd', '.rdoc'
           require_rdoc
           require_qedoc
-          markup = Markup.new(txt)
-          text << markup.to_html
-          #text << markup.convert(iotext, formatter)
+          if html?
+            markup = Markup.new(txt)
+            text << markup.to_html
+            #text << markup.convert(iotext, formatter)
+          else
+            text << txt
+          end        
         when '.md', '.markdown'
           require_rdiscount
-          markdown = RDiscount.new(txt)
-          text << markdown.to_html
+          if html?
+            markdown = RDiscount.new(txt)
+            text << markdown.to_html
+          else
+            text << txt
+          end
         end
 
-        output << "#{text}\n"
+        out << "#{text}\n"
       end
 
-      temp = Template.new(template, output, title, css)
-      html = temp.parse_template
-
-      save(html)
+      if html?
+        temp = Template.new(template, output, title, css)
+        html = temp.parse_template
+        save(html)
+      else
+        save(out)
+      end
     end
 
     #
-    def copy_support_files
-      make_output_directory
-      %w{jquery.js}.each do |fname|
-        file = File.join(File.dirname(__FILE__), 'document', fname)
-        FileUtils.cp(file, output)
-      end
+    def html?
+      format == 'html'
     end
 
+    #
+    #def copy_support_files
+    #  make_output_directory
+    #  %w{jquery.js}.each do |fname|
+    #    file = File.join(File.dirname(__FILE__), 'document', fname)
+    #    FileUtils.cp(file, output)
+    #  end
+    #end
+
     # Load specification HTML template.
     def template
       @template ||= (
@@ -143,14 +188,15 @@ module QED
         puts "\nwrite #{output}"
       else
         make_output_directory
-        File.open(output + '/index.html', 'wb') do |f|
+        File.open(output, 'wb') do |f|
           f << text
         end
       end
     end
 
     def make_output_directory
-      FileUtils.mkdir_p(output)
+      dir = File.dirname(output)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
     end
 
   private
@@ -173,7 +219,7 @@ module QED
     #
     def require_qedoc
       @require_qedoc ||= (
-        require 'qedoc/document/markup'
+        require 'qed/document/markup'
         true
       )
     end

data/lib/{qedoc → qed}/document/template.rhtml

@@ -103,17 +103,12 @@
     .title { font-size: 2em; }
   </style>
 
-  <!-- TODO: only include if these files exists -->
-  <link href="../assets/styles/spec.css" type="text/css" rel="stylesheet">
-  <!-- spec.css might be a problem with clobber -->
-  <link href="spec.css" type="text/css" rel="stylesheet">
-
   <% if css %>
   <link rel="stylesheet" href="<%= css %>" type="text/css">
   <% end %>
 
   <!-- JQuery is needed -->
-  <script src="jquery.js" type="text/javascript" language="javascript"></script>
+  <script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/1.6.1/jquery.min.js" type="text/javascript" language="javascript"></script>
 
 </head>
 
@@ -122,7 +117,7 @@
   <!-- Side Table of Contents -->
   <div id="sidebar" style="position: fixed; top: 10; right: 10; background: white;">
     <a href="javascript: toc_toggle();">
-      <img src="img/icon/book.jpg" height="30px;" style="border: none;" alt="TOC" align="right"/>
+      <img src="http://www.cdnjs.com/images/poweredbycloudflare.png" style="border: none;" alt="TOC" align="right"/>
     </a>
 
     <div id="toc_side" class="toc">
@@ -131,7 +126,7 @@
 
   <div id="container">
     <div id="header">
-      <img src="img/icon/book.jpg" align="left" style="padding-right: 10px;" alt=""/>
+      <img src="http://www.cdnjs.com/images/poweredbycloudflare.png" align="left" style="padding-right: 10px;" alt=""/>
 
       <div class="title"><%= title %></div>
 

data/lib/qed/evaluator.rb

@@ -8,7 +8,7 @@ module QED
     #
     def initialize(script, *observers)
       @script  = script
-      @steps   = script.parse
+      @steps   = script.steps
 
       #@file    = script.file
       #@scope   = script.scope

data/lib/qed/parser.rb

@@ -1,5 +1,10 @@
 module QED
 
+  #
+  def self.all_steps
+    @all_steps ||= []
+  end
+
   # The parser breaks down a demonstandum into
   # structured object to passed thru the script
   # evaluator.
@@ -198,6 +203,8 @@ module QED
 
       #
       def initialize(file)
+        QED.all_steps << self
+
         @file = file
         @raw  = []
         @type = :description

data/lib/qed/reporter/abstract.rb

@@ -2,16 +2,25 @@ module QED
 module Reporter
 
   require 'facets/string'
-  require 'ansi/code'
+
+  begin
+    require 'ansi/core'
+  rescue LoadError
+    require 'ansi/code'
+  end
 
   # = Reporter Absract Base Class
   #
   # Serves as the base class for all other output formats.
   class Abstract
 
+    attr :session
+
     attr :io
+
     attr :record
 
+    # TODO: pass session into initialize
     def initialize(options={})
       @io    = options[:io] || STDOUT
       @trace = options[:trace]
@@ -110,6 +119,7 @@ module Reporter
 
     # At the start of a session, before running any demonstrations.
     def before_session(session)
+      @session    = session
       @start_time = Time.now
     end
 
@@ -248,12 +258,24 @@ module Reporter
     end
 
     #
-    def clean_backtrace(btrace)
-      btrace.chomp(":in \`__binding__'")
+    INTERNALS = /(lib|bin)[\\\/](qed|ae)/
+
+    #
+    def sane_backtrace(exception)
+      if trace_count
+        clean_backtrace(*exception.backtrace[0, trace_count])
+      else
+        clean_backtrace(*exception.backtrace)
+      end
     end
 
     #
-    INTERNALS = /(lib|bin)[\\\/](qed|ae)/
+    def clean_backtrace(*btrace)
+      stack = btrace.reject{ |bt| bt =~ INTERNALS } unless $DEBUG
+      stack.map do |bt|
+        bt.chomp(":in \`__binding__'")
+      end
+    end
 
 =begin
     # Clean the backtrace of any reference to ko/ paths and code.
@@ -269,44 +291,140 @@ module Reporter
     end
 =end
 
+    # Produce a pretty code snippet given an exception.
     #
-    def code_snippet(exception, bredth=3)
-      backtrace = exception.backtrace.reject{ |bt| bt =~ INTERNALS }
-      backtrace.first =~ /(.+?):(\d+(?=:|\z))/ or return ""
-      source_file, source_line = $1, $2.to_i
+    # @param exception [Exception, String]
+    #   An exception or backtrace.
+    #
+    # @param radius [Integer]
+    #   The number of surrounding lines to show.
+    #
+    # @return [String] pretty code snippet
+    def code_snippet(exception, radius=2)
+      radius = radius.to_i
+
+      file, lineno = file_and_line(exception)
 
-      source = source(source_file)
+      return nil if file.empty?
+
+      source = source(file)
       
-      radius = bredth # number of surrounding lines to show
-      region = [source_line - radius, 1].max ..
-               [source_line + radius, source.length].min
+      region = [lineno - radius, 1].max ..
+               [lineno + radius, source.length].min
 
       # ensure proper alignment by zero-padding line numbers
       format = " %2s %0#{region.last.to_s.length}d %s"
 
       pretty = region.map do |n|
-        format % [('=>' if n == source_line), n, source[n-1].chomp]
+        format % [('=>' if n == lineno), n, source[n-1].chomp]
       end #.unshift "[#{region.inspect}] in #{source_file}"
 
       pretty
     end
 
+    # Return a structure code snippet in an array of lineno=>line 
+    # hash elements.
+    #
+    # @param exception [Exception, String]
+    #   An exception or backtrace.
+    #
+    # @param radius [Integer]
+    #   The number of surrounding lines to show.
+    #
+    # @return [Hash] structured code snippet
+    def structured_code_snippet(exception, radius=2)
+      radius = radius.to_i
+
+      file, lineno = file_and_line(exception)
+
+      return {} if file.empty?
+
+      source = source(file)    
+
+      region = [lineno - radius, 1].max ..
+               [lineno + radius, source.length].min
+
+      region.map do |n|
+        {n => source[n-1].chomp}
+      end
+    end
+
+    # Cache the source code of a file.
+    #
+    # @param file [String] full pathname to file
     #
+    # @return [String] source code
     def source(file)
       @source[file] ||= (
         File.readlines(file)
       )
     end
 
+    # @param exception [Exception,Array,String]
+    #   An exception or backtrace.
+    #
+    #--
     # TODO: Show more of the file name than just the basename.
+    #++
     def file_and_line(exception)
-      line = exception.backtrace[0]
-      return "" unless line
-      i = line.rindex(':in')
-      line = i ? line[0...i] : line
-      File.basename(line)
+      backtrace = case exception
+                  when Exception
+                    exception.backtrace.reject{ |bt| bt =~ INTERNALS }.first
+                  when Array
+                    exception.first
+                  else
+                    exception
+                  end
+
+      backtrace =~ /(.+?):(\d+(?=:|\z))/ or return ""
+
+      file, lineno = $1, $2.to_i
+
+      return file, lineno
+
+      #i = backtrace.rindex(':in')
+      #line = i ? line[0...i] : line
+      #relative_file(line)
     end
 
+    # Same as file_and_line, exception return file path is relative.
+    def file_line(exception)
+      file, lineno = file_and_line(exception)
+      return relative_file(file), lineno
+    end
+
+    # Default trace count. This is the number of backtrace lines that
+    # will be provided on errors and failed assertions, unless otherwise
+    # overridden with ENV['trace'].
+    DEFAULT_TRACE_COUNT = 3
+
+    # Looks at ENV['trace'] to determine how much trace output to provide.
+    # If it is not set, or set to`false` or `off`, then the default trace count
+    # is used. If set to `0`, `true`, 'on' or 'all' then aa complete trace dump
+    # is provided. Otherwise the value is converted to an integer and that many
+    # line of trace is given.
+    #
+    # @return [Integer, nil] trace count
+    def trace_count
+      cnt = ENV['trace']
+      case cnt
+      when nil, 'false', 'off'
+        DEFAULT_TRACE_COUNT
+      when 0, 'all', 'true', 'on'
+        nil
+      else
+        Integer(cnt)
+      end
+    end
+
+    #
+    def relative_file(file)
+      pwd = Dir.pwd
+      idx = (0...pwd.size).find do |i|
+        file[i,1] != pwd[i,1]
+      end
+      file[(idx || 0)..-1]
+    end
   end
 
 end