RubyGems - qed - Versions diffs - 2.8.0 → 2.8.1 - Mend

qed 2.8.0 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/.ruby +2 -2
data/COPYING.rdoc +31 -0
data/HISTORY.rdoc +12 -0
data/lib/qed.yml +2 -2
data/lib/qed/document.rb +3 -0
data/lib/qed/document/template.rhtml +11 -3
data/lib/qed/qparser.rb +41 -0
data/lib/qed/reporter/linear.rb +132 -0
data/lib/qed/step.rb +2 -2
data/qed/applique/ae.rb +1 -0
data/qed/applique/quote.rdoc +8 -0
metadata +21 -15

data/.ruby CHANGED

@@ -42,10 +42,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.0
+version: 2.8.1
 scm_uri: http://github.com/rubyworks/qed/blob/master/
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
   utilizing Literate Programming techniques.'
-date: '2012-01-25'
+date: '2012-02-01'

data/COPYING.rdoc ADDED

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+== QED
+Copyright:: (c) 2009 Rubyworks, Thomas Sawyer
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/qed
+    Copyright 2009 Rubyworks. All rights reserved.
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+    NO EVENT SHALL Thomas Sawyer OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/HISTORY.rdoc CHANGED

@@ -1,5 +1,17 @@
 = RELEASE HISTORY
+== 2.8.1 | 2012-02-01
+This release fixes a bug in the parsing of `#=>` notation. It also
+adds syntax highlighting to qedoc generated documentation. It does
+this with highlight.js.
+Changes:
+* Fix parsing of `#=>`.
+* Add highlight.js to qedocs.
 == 2.8.0 | 2012-01-19
 IMPORTANT: READ THIS RELEASE NOTICE! This release makes a minor

data/lib/qed.yml CHANGED

@@ -42,10 +42,10 @@ revision: 0
 created: '2009-06-16'
 summary: Quod Erat Demonstrandum
 title: QED
-version: 2.8.0
+version: 2.8.1
 scm_uri: http://github.com/rubyworks/qed/blob/master/
 name: qed
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
   utilizing Literate Programming techniques.'
-date: '2012-01-25'
+date: '2012-02-01'

data/lib/qed/document.rb CHANGED

@@ -156,6 +156,9 @@ module QED
           end
         end
+        # TODO: Use Nokogiri to find all <pre>'s with preceeding <p>'s that have text ending in `:`, and
+        # add the class `no-highlight`. If no preceeding `:` add class ruby.
         out << "#{text}\n"
       end

data/lib/qed/document/template.rhtml CHANGED

@@ -100,8 +100,6 @@
     .wikistyle pre.console code{padding:0!important;font-size:100%!important;background-color:black!important;border:none!important;color:white!important;}
     .wikistyle pre.console span{color:#888!important;}
     .wikistyle pre.console span.command{color:yellow!important;}
-    .title { font-size: 2em; }
   </style>
   <% if css %>
@@ -111,6 +109,16 @@
   <!-- JQuery is needed -->
   <script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/1.6.1/jquery.min.js" type="text/javascript" language="javascript"></script>
+  <!-- Highlight.js -->
+  <script src="http://yandex.st/highlightjs/6.1/highlight.min.js"></script>
+  <link rel="stylesheet" href="http://yandex.st/highlightjs/6.1/styles/github.min.css">
+  <script>
+    $(document).ready(function() {
+      $('pre').each(function(i, e) {hljs.highlightBlock(e)});
+    });
+  </script>
 </head>
 <body class="wikistyle">
@@ -131,7 +139,7 @@
       <!-- TODO: find a preminatn image on web to use -->
       <!-- <img src="http://www.cdnjs.com/images/poweredbycloudflare.png" align="left" style="padding-right: 10px;" alt=""/> -->
-      <div class="title"><%= title %></div>
+      <div style="font-size: 2em"><%= title %></div>
       <h1>Table of Contents</h1>

data/lib/qed/qparser.rb ADDED

@@ -0,0 +1,41 @@
+module QED
+  # Expiremntal quick parser.
+  #
+  # NOT USED YET!
+  #
+  class QuickParser #:nodoc:
+    #
+    def initialize(demo)
+      @lines = demo.lines
+    end
+    #
+    def parse
+      flush  = true
+      script = []
+      @lines.each do |line|
+        case line
+        when /^\s/
+          if flush
+            script << "Test do\n"
+          end
+          script << line
+          flush = false
+        else
+          if !flush
+            script << "end"
+          end
+          script << "# " + line
+          flush = true
+        end
+      end
+      script.join()
+    end
+  end
+end

data/lib/qed/reporter/linear.rb ADDED

@@ -0,0 +1,132 @@
+module QED
+module Reporter #:nodoc:
+  require 'ansi/terminal'
+  require 'qed/reporter/abstract'
+  # Linear reporter limits each step to a single line.
+  #
+  class Linear < Abstract
+    #
+    def before_session(session)
+      @width = ANSI::Terminal.terminal_width - 12
+      @start_time = Time.now
+      puts "[INFO] Session @ #{Time.now}".ansi(:bold)
+    end
+    #
+    def before_demo(demo)
+      file = localize_file(demo.file)
+      puts "[DEMO] #{file}".ansi(:bold)
+    end
+    #
+    def before_applique(step)
+      super(step)
+      #post
+      str = "[NOTE] #{step.explain.gsub(/\s+/,' ')} "[0,@width]
+      pad = @width - str.size + 1
+      print str + (' ' * pad)
+      puts "[#{timestamp}]"
+    end
+    #
+    def pass(step)
+      super(step)
+      print_step(step, 'PASS', :green)
+      #s = []
+      #s << "PASS".ansi(:green)
+      #puts s.join("\n")
+    end
+    #
+    def fail(step, assertion)
+      super(step, assertion)
+      print_step(step, 'FAIL', :red)
+      #puts "FAIL".ansi(:red)
+      s = []
+      s << assertion.class.name
+      s << assertion.message
+      backtrace = sane_backtrace(assertion)
+      backtrace.each do |bt|
+        s << bt
+        s << code_snippet(bt)
+      end
+      puts s.join("\n").tabto(8)
+    end
+    #
+    def error(step, exception)
+      super(step, exception)
+      print_step(step, 'ERRO', :red)
+      #puts "ERROR".ansi(:red)
+      s = []
+      s << assertion.class.name
+      s << assertion.message
+      backtrace = sane_backtrace(assertion)
+      backtrace.each do |bt|
+        s << bt
+        s << code_snippet(bt)
+      end
+      puts s.join("\n").tabto(8)
+    end
+    #
+    def after_session(session)
+      puts "[INFO] %s demos, %s steps: %s failures, %s errors (%s/%s assertions)" % get_tally
+      puts "[INFO] Finished in %.5f seconds." % [Time.now - @start_time]
+      puts "[INFO] End Session @ #{Time.now}".ansi(:bold)
+    end
+  private
+    def timestamp
+      (Time.now - @start_time).to_s[0,8]
+    end
+    #
+    def print(str)
+      @appendable = true
+      io.print str
+    end
+    #
+    def puts(str)
+      @appendable = false
+      io.puts str
+    end
+    #
+    def post
+      io.puts if @appendable
+      @appendable = false
+    end
+    #
+    def print_step(step, stat, *color)
+      desc = step.explain.gsub(/\s+/,' ')
+      if desc.start_with?('=') or desc.start_with?('#')
+        desc = desc.ansi(:magenta)
+      end
+      str = "[#{stat}] #{desc} "[0,@width]
+      pad = @width - str.unansi.size + 1
+      print (str + (' ' * pad)).ansi(*color)
+      puts "[#{timestamp}]"
+    end
+  end
+end#module Reporter
+end#module QED

data/lib/qed/step.rb CHANGED

@@ -229,8 +229,8 @@ module QED
       code = @example_lines.map{ |lineno, line| line }.join("")
       #code.gsub!(/\n\s*\#\ ?\=\>/, '.assert = ')
       #code.gsub!(/\s*\#\ ?\=\>/, '.assert = ')
-      code.gsub!(/\n\s*\#\ ?\=\>(.*?)$/, ' == \1 ? assert(true) : assert(false, "not returned -- \1")')   # TODO: what kind of error ?
-      code.gsub!(/\s*\#\ ?\=\>(.*?)$/,   ' == \1 ? assert(true) : assert(false, "not returned -- \1")')
+      code.gsub!(/\n\s*\#\ ?\=\>(.*?)$/, ' == \1 ? assert(true) : assert(false, %{not returned -- \1})')   # TODO: what kind of error ?
+      code.gsub!(/\s*\#\ ?\=\>(.*?)$/,   ' == \1 ? assert(true) : assert(false, %{not returned -- \1})')
       code
     end

data/qed/applique/ae.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'ae'

data/qed/applique/quote.rdoc ADDED

@@ -0,0 +1,8 @@
+== Applique: Quote
+This applique simply provide support to `quote.rdoc` demo.
+  When "we want to make an example out of the following text" do |text|
+    @quote_text = text
+  end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qed
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
   prerelease:
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000 Z
+date: 2012-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &25621900 !ruby/object:Gem::Requirement
+  requirement: &30707900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25621900
+  version_requirements: *30707900
 - !ruby/object:Gem::Dependency
   name: facets
-  requirement: &25620880 !ruby/object:Gem::Requirement
+  requirement: &30723160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *25620880
+  version_requirements: *30723160
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &25620240 !ruby/object:Gem::Requirement
+  requirement: &30722380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25620240
+  version_requirements: *30722380
 - !ruby/object:Gem::Dependency
   name: confection
-  requirement: &25619480 !ruby/object:Gem::Requirement
+  requirement: &30721540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25619480
+  version_requirements: *30721540
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &25618820 !ruby/object:Gem::Requirement
+  requirement: &30720900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25618820
+  version_requirements: *30720900
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &25616480 !ruby/object:Gem::Requirement
+  requirement: &30720020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25616480
+  version_requirements: *30720020
 description: ! 'QED (Quality Ensured Demonstrations) is a TDD/BDD framework
   utilizing Literate Programming techniques.'
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files:
 - HISTORY.rdoc
 - README.rdoc
+- COPYING.rdoc
 files:
 - .ruby
 - .yardopts
@@ -108,9 +109,11 @@ files:
 - lib/qed/helpers/file_fixtures.rb
 - lib/qed/helpers/shell_session.rb
 - lib/qed/parser.rb
+- lib/qed/qparser.rb
 - lib/qed/reporter/abstract.rb
 - lib/qed/reporter/dotprogress.rb
 - lib/qed/reporter/html.rb
+- lib/qed/reporter/linear.rb
 - lib/qed/reporter/tapy.rb
 - lib/qed/reporter/verbatim.rb
 - lib/qed/scope.rb
@@ -130,10 +133,12 @@ files:
 - qed/10_constant_lookup.rdoc
 - qed/11_embedded_rules.rdoc
 - qed/99_issues/02_topcode.rdoc
+- qed/applique/ae.rb
 - qed/applique/constant.rb
 - qed/applique/env.rb
 - qed/applique/fileutils.rb
 - qed/applique/markup.rb
+- qed/applique/quote.rdoc
 - qed/applique/toplevel.rb
 - qed/helpers/advice.rb
 - qed/helpers/toplevel.rb
@@ -141,6 +146,7 @@ files:
 - qed/samples/table.yml
 - HISTORY.rdoc
 - README.rdoc
+- COPYING.rdoc
 homepage: http://rubyworks.github.com/qed
 licenses:
 - BSD-2-Clause
@@ -162,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key:
 specification_version: 3
 summary: Quod Erat Demonstrandum