RubyGems - viewcumber - Versions diffs - 0.0.2 → 0.0.3 - Mend

viewcumber 0.0.2 → 0.0.3

Files changed (7) hide show

data/README.rdoc CHANGED

@@ -1,6 +1,18 @@
 = viewcumber
-Description goes here.
+Cucumber formatter for easily viewing each step of your scenarios
+== Installation
+<tt>gem install viewcumber</tt>
+== Usage
+<tt>viewcumber path/to/filename</tt>
+or
+<tt>cucumber --format Viewcumber path/to/filename</tt>
+Then open <tt>./viewcumber/index.html</tt>
 == Note on Patches/Pull Requests
@@ -14,4 +26,4 @@ Description goes here.
 == Copyright
-Copyright (c) 2010 versapay. See LICENSE for details.
+Copyright (c) 2010 Versapay. See LICENSE for details.

data/Rakefile CHANGED

@@ -8,6 +8,8 @@ begin
     gem.summary = %Q{ Cucumber formatter for easily viewing each step of your scenarios }
     gem.homepage = "http://github.com/versapay/viewcumber"
     gem.authors = ["gregbell", "pcreux", "samuelreh"]
+    gem.default_executable  = "viewcumber"
+    gem.executables         = ["viewcumber"]
     gem.add_dependency "cucumber", ">=0.8.5"
     gem.add_dependency "capybara", ">=0.3"
   end

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.0.2
1	+ 0.0.3

data/bin/viewcumber ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+system("cucumber --format Viewcumber #{ARGV.join(' ')}")

data/lib/viewcumber.rb CHANGED

@@ -5,12 +5,15 @@ require 'erb'
 require 'cucumber/formatter/ordered_xml_markup'
 require 'cucumber/formatter/duration'
 require 'cucumber/formatter/io'
-require 'FileUtils'
+require 'fileutils'
 if respond_to? :AfterStep
   AfterStep do |scenario|
     begin
-      if Capybara.page.driver.respond_to? :html
+      if !@email.blank?
+        Viewcumber.last_step_html = Viewcumber.rewrite_css_and_image_references(@email)
+        @email = nil
+      elsif Capybara.page.driver.respond_to? :html
         Viewcumber.last_step_html = Viewcumber.rewrite_css_and_image_references(Capybara.page.driver.html.to_s)
       end
     rescue Exception => e
@@ -35,6 +38,7 @@ class Viewcumber
    @options = options
    @buffer = {}
    @builder = create_builder(@io)
+   @background_builder = Builder::XmlMarkup.new
    @feature_number = 0
    @scenario_number = 0
    @step_number = 0
@@ -50,7 +54,7 @@ class Viewcumber
  def embed_image(file)
    id = file.hash
-   @builder.span(:class => 'embed') do |pre|
+   builder.span(:class => 'embed') do |pre|
      pre << %{<a href="" onclick="img=document.getElementById('#{id}'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false">Screenshot</a><br>&nbsp;
      <img id="#{id}" style="display: none" src="#{file}"/>}
    end
@@ -62,7 +66,7 @@ class Viewcumber
    copy_assets
    # <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-   @builder.declare!(
+   builder.declare!(
      :DOCTYPE,
      :html,
      :PUBLIC,
@@ -70,22 +74,22 @@ class Viewcumber
      'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
    )
-   @builder << '<html xmlns ="http://www.w3.org/1999/xhtml">'
-   @builder.head do
-     @builder.meta(:content => 'text/html;charset=utf-8')
-     @builder.title 'Cucumber'
+   builder << '<html xmlns ="http://www.w3.org/1999/xhtml">'
+   builder.head do
+     builder.meta(:content => 'text/html;charset=utf-8')
+     builder.title 'Cucumber'
      inline_css
      inline_js
-     @builder << <<-HTML
+     builder << <<-HTML
       <link href='http://fonts.googleapis.com/css?family=Droid+Serif' rel='stylesheet' type='text/css'>
       <link rel="stylesheet" type="text/css" href="main.css" />
       <script type="text/javascript" src="jquery-min.js"></script>
       <script type="text/javascript" src="main.js"></script>
      HTML
    end
-   @builder << '<body>'
-   @builder << "<!-- Step count #{@step_count}-->"
-   @builder << <<-HTML
+   builder << '<body>'
+   builder << "<!-- Step count #{@step_count}-->"
+   builder << <<-HTML
     <div id="navigator">
       <a href="#" id="prev-btn" onclick="Cucumber.previous(); return false;">&larr;</a>
       <a href="#" id="next-btn" onclick="Cucumber.next(); return false;">&rarr;</a>
@@ -96,40 +100,40 @@ class Viewcumber
       <p id="step-name"></p>
     </div>
    HTML
-   @builder << '<div class="cucumber">'
-   @builder << "<ul>"
+   builder << '<div class="cucumber">'
+   builder << "<ul>"
  end
  def after_features(features)
-   @builder << '</li>'
-   @builder << '</ul>'
-   @builder << '</div>'
-   @builder << '<iframe name="viewport" id="viewport"></iframe>'
-   @builder << '</body>'
-   @builder << '</html>'
+   builder << '</li>'
+   builder << '</ul>'
+   builder << '</div>'
+   builder << '<iframe name="viewport" id="viewport"></iframe>'
+   builder << '</body>'
+   builder << '</html>'
  end
  def before_feature(feature)
    @exceptions = []
-   @builder << '<li class="feature">'
+   builder << '<li class="feature">'
  end
  def after_feature(feature)
-   @builder << '</ul>'
-   @builder << '</li> <!--class="feature" -->'
+   builder << '</ul>'
+   builder << '</li> <!--class="feature" -->'
  end
  def before_comment(comment)
-   @builder << '<pre class="comment">'
+   builder << '<pre class="comment">'
  end
  def after_comment(comment)
-   @builder << '</pre>'
+   builder << '</pre>'
  end
  def comment_line(comment_line)
-   @builder.text!(comment_line)
-   @builder.br
+   builder.text!(comment_line)
+   builder.br
  end
  def after_tags(tags)
@@ -137,44 +141,45 @@ class Viewcumber
  end
  def tag_name(tag_name)
-   @builder.text!(@tag_spacer) if @tag_spacer
+   builder.text!(@tag_spacer) if @tag_spacer
    @tag_spacer = ' '
-   @builder.span(tag_name, :class => 'tag')
+   builder.span(tag_name, :class => 'tag')
  end
  def feature_name(keyword, name)
    lines = name.split(/\r?\n/)
    return if lines.empty?
-   @builder.h2 do |h2|
-     #@builder.span(keyword + ': ' + lines[0], :class => 'val')
-     @builder.span(lines[0], :class => 'val')
+   builder.h2 do |h2|
+     #builder.span(keyword + ': ' + lines[0], :class => 'val')
+     builder.span(lines[0], :class => 'val')
    end
-   @builder.p(:class => 'narrative') do
+   builder.p(:class => 'narrative') do
      lines[1..-1].each do |line|
-       @builder.text!(line.strip)
-       @builder.br
+       builder.text!(line.strip)
+       builder.br
      end
    end
-   @builder << '<ul>'
+   builder << '<ul>'
  end
  def before_background(background)
    @in_background = true
-   @builder << '<li class="background">'
+   @background_builder = Builder::XmlMarkup.new
+   builder << '<li class="background">'
  end
  def after_background(background)
    @in_background = nil
-   @builder << "</li>\n"
+   builder << "</li>\n"
  end
  def background_name(keyword, name, file_colon_line, source_indent)
    @listing_background = true
-   @builder.h3 do |h3|
-     @builder.span(keyword, :class => 'keyword')
-     @builder.text!(' ')
-     @builder.span(name, :class => 'val')
-   end
+   # builder.h3 do |h3|
+   #   builder.span(keyword, :class => 'keyword')
+   #   builder.text!(' ')
+   #   builder.span(name, :class => 'val')
+   # end
  end
  def before_feature_element(feature_element)
@@ -184,53 +189,54 @@ class Viewcumber
      Cucumber::Ast::Scenario        => 'scenario',
      Cucumber::Ast::ScenarioOutline => 'scenario outline'
    }[feature_element.class]
-   @builder << "<li class='#{css_class}'>"
+   builder << "<li class='#{css_class}'>"
  end
  def after_feature_element(feature_element)
-   @builder << "</li>\n"
+   builder << "</li>\n"
    @open_step_list = true
  end
  def scenario_name(keyword, name, file_colon_line, source_indent)
    @listing_background = false
-   @builder.h3(:id => "scenario_#{@scenario_number}") do
-     @builder.span(name, :class => 'val')
+   builder.h3(:id => "scenario_#{@scenario_number}") do
+     builder.span(name, :class => 'val')
    end
  end
  def before_outline_table(outline_table)
    @outline_row = 0
-   @builder << '<table>'
+   builder << '<table>'
  end
  def after_outline_table(outline_table)
-   @builder << '</table>'
+   builder << '</table>'
    @outline_row = nil
  end
  def before_examples(examples)
-    @builder << '<li class="examples">'
+    builder << '<li class="examples">'
  end
  def after_examples(examples)
-   @builder << "</li>\n"
+   builder << "</li>\n"
  end
  def examples_name(keyword, name)
-   @builder.h4 do
-     @builder.span(keyword, :class => 'keyword')
-     @builder.text!(' ')
-     @builder.span(name, :class => 'val')
+   builder.h4 do
+     builder.span(keyword, :class => 'keyword')
+     builder.text!(' ')
+     builder.span(name, :class => 'val')
    end
  end
  def before_steps(steps)
-   @builder << '<ol>'
+   builder << '<ol>'
+   builder << @background_builder.target! unless (@in_background || @background_builder.nil?)
  end
  def after_steps(steps)
-   @builder << '</ol>'
+   builder << '</ol>'
  end
  def before_step(step)
@@ -247,6 +253,7 @@ class Viewcumber
  end
  def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+   @in_background_step = true if @in_background
    @step_match = step_match
    @hide_this_step = false
    if exception
@@ -263,7 +270,7 @@ class Viewcumber
    @status = status
    return if @hide_this_step
    set_scenario_color(status)
-   @builder << "<li id='#{@step_id}' class='step #{status}'>"
+   builder << "<li id='#{@step_id}' class='step #{status}'>"
  end
  def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
@@ -271,11 +278,12 @@ class Viewcumber
    # print snippet for undefined steps
    if status == :undefined
      step_multiline_class = @step.multiline_arg ? @step.multiline_arg.class : nil
-     @builder.pre do |pre|
+     builder.pre do |pre|
        pre << @step_mother.snippet_text(@step.actual_keyword,step_match.instance_variable_get("@name") || '',step_multiline_class)
      end
    end
-   @builder << "</li>\n"
+   builder << "</li>\n"
+   @in_background_step = false
  end
  def step_name(keyword, step_match, status, source_indent, background)
@@ -300,22 +308,22 @@ class Viewcumber
  def before_multiline_arg(multiline_arg)
    return if @hide_this_step || @skip_step
-   if Ast::Table === multiline_arg
-     @builder << '<table>'
+   if Cucumber::Ast::Table === multiline_arg
+     builder << '<table>'
    end
  end
  def after_multiline_arg(multiline_arg)
    return if @hide_this_step || @skip_step
-   if Ast::Table === multiline_arg
-     @builder << '</table>'
+   if Cucumber::Ast::Table === multiline_arg
+     builder << '</table>'
    end
  end
  def py_string(string)
    return if @hide_this_step
-   @builder.pre(:class => 'val') do |pre|
-     @builder << string.gsub("\n", '&#x000A;')
+   builder.pre(:class => 'val') do |pre|
+     builder << string.gsub("\n", '&#x000A;')
    end
  end
@@ -324,16 +332,16 @@ class Viewcumber
    @row_id = table_row.dom_id
    @col_index = 0
    return if @hide_this_step
-   @builder << "<tr class='step' id='#{@row_id}'>"
+   builder << "<tr class='step' id='#{@row_id}'>"
  end
  def after_table_row(table_row)
    return if @hide_this_step
-   @builder << "</tr>\n"
+   builder << "</tr>\n"
    if table_row.exception
-     @builder.tr do
-       @builder.td(:colspan => @col_index.to_s, :class => 'failed') do
-         @builder.pre do |pre|
+     builder.tr do
+       builder.td(:colspan => @col_index.to_s, :class => 'failed') do
+         builder.pre do |pre|
            pre << format_exception(table_row.exception)
          end
        end
@@ -358,7 +366,7 @@ class Viewcumber
  end
  def announce(announcement)
-   @builder.pre(announcement, :class => 'announcement')
+   builder.pre(announcement, :class => 'announcement')
  end
  def self.rewrite_css_and_image_references(response_html) # :nodoc:
@@ -367,33 +375,34 @@ class Viewcumber
      list << name if File.directory?(name) and not name.to_s =~ /^\./
      list
    end
-   response_html.gsub(/("|')\/(#{directories.join('|')})/, '\1public/\2')
+   response_html.gsub!(/("|')\/(#{directories.join('|')})/, '\1public/\2')
+   response_html.gsub(/("|')http:\/\/.*\/images/, '\1public/images')
  end
 protected
  def build_exception_detail(exception)
    backtrace = Array.new
-   @builder.div(:class => 'message') do
+   builder.div(:class => 'message') do
      message = exception.message
      if defined?(RAILS_ROOT) && message.include?('Exception caught')
        matches = message.match(/Showing <i>(.+)<\/i>(?:.+)#(\d+)/)
        backtrace += ["#{RAILS_ROOT}/#{matches[1]}:#{matches[2]}"]
        message = message.match(/<code>([^(\/)]+)<\//m)[1]
      end
-     @builder.pre do
-       @builder.text!(message)
+     builder.pre do
+       builder.text!(message)
      end
    end
-   @builder.div(:class => 'backtrace') do
-     @builder.pre do
+   builder.div(:class => 'backtrace') do
+     builder.pre do
        backtrace = exception.backtrace
        backtrace.delete_if { |x| x =~ /\/gems\/(cucumber|rspec)/ }
-       @builder << backtrace_line(backtrace.join("\n"))
+       builder << backtrace_line(backtrace.join("\n"))
      end
    end
    extra = extra_failure_content(backtrace)
-   @builder << extra unless extra == ""
+   builder << extra unless extra == ""
  end
  def set_scenario_color(status)
@@ -406,18 +415,18 @@ protected
  end
  def set_scenario_color_failed
-   @builder.script do
-     @builder.text!("makeRed('cucumber-header');") unless @header_red
+   builder.script do
+     builder.text!("makeRed('cucumber-header');") unless @header_red
      @header_red = true
-     @builder.text!("makeRed('scenario_#{@scenario_number}');") unless @scenario_red
+     builder.text!("makeRed('scenario_#{@scenario_number}');") unless @scenario_red
      @scenario_red = true
    end
  end
  def set_scenario_color_pending
-   @builder.script do
-     @builder.text!("makeYellow('cucumber-header');") unless @header_red
-     @builder.text!("makeYellow('scenario_#{@scenario_number}');") unless @scenario_red
+   builder.script do
+     builder.text!("makeYellow('cucumber-header');") unless @header_red
+     builder.text!("makeYellow('scenario_#{@scenario_number}');") unless @scenario_red
    end
  end
@@ -462,36 +471,36 @@ protected
  def build_step(keyword, step_match, status)
    step_name = step_match.format_args(lambda{|param| %{<span class="param">#{param}</span>}})
-   @builder.div(:class => 'step_name') do |div|
-     @builder << "<a target=\"viewport\" class=\"step-link\" href=\"#{@file_name}\">"
-     @builder.span(keyword, :class => 'keyword')
-     @builder.span(:class => 'val') do |name|
+   builder.div(:class => 'step_name') do |div|
+     builder << "<a target=\"viewport\" class=\"step-link\" href=\"#{@file_name}\">"
+     builder.span(keyword, :class => 'keyword')
+     builder.span(:class => 'val') do |name|
        name << h(step_name).gsub(/&lt;span class=&quot;(.*?)&quot;&gt;/, '<span class="\1">').gsub(/&lt;\/span&gt;/, '</span>')
      end
-     @builder << "</a>"
+     builder << "</a>"
    end
  end
  def build_cell(cell_type, value, attributes)
-   @builder.__send__(cell_type, attributes) do
-     @builder.div do
-       @builder.span(value,:class => 'step param')
+   builder.__send__(cell_type, attributes) do
+     builder.div do
+       builder.span(value,:class => 'step param')
      end
    end
  end
  def inline_css
-   @builder.style(:type => 'text/css') do
+   builder.style(:type => 'text/css') do
      # Inline CSS here
-     #@builder << File.read(File.dirname(__FILE__) + '/cucumber.css')
+     #builder << File.read(File.dirname(__FILE__) + '/cucumber.css')
    end
  end
  def inline_js
-   @builder.script(:type => 'text/javascript') do
+   builder.script(:type => 'text/javascript') do
      # Inline JQuery here
-     #@builder << inline_jquery
-     #@builder << inline_js_content
+     #builder << inline_jquery
+     #builder << inline_js_content
    end
  end
@@ -537,7 +546,7 @@ $('#'+element_id).css('color', '#000000');
  end
  def move_progress
-   @builder << " <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
+   builder << " <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
  end
  def percent_done
@@ -563,8 +572,8 @@ $('#'+element_id).css('color', '#000000');
  end
  def print_stats(features)
-   @builder <<  "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{format_duration(features.duration)} seconds</strong>\";</script>"
-   @builder <<  "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{print_stat_string(features)}\";</script>"
+   builder <<  "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{format_duration(features.duration)} seconds</strong>\";</script>"
+   builder <<  "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{print_stat_string(features)}\";</script>"
  end
  def print_stat_string(features)
@@ -593,6 +602,10 @@ $('#'+element_id).css('color', '#000000');
  def create_builder(io)
    Cucumber::Formatter::OrderedXmlMarkup.new(:target => io, :indent => 0)
  end
+ def builder
+   @in_background_step ? @background_builder : @builder
+ end
  def copy_assets
    FileUtils.mkdir "viewcumber" unless File.directory? "viewcumber"
@@ -601,7 +614,7 @@ $('#'+element_id).css('color', '#000000');
    File.copy assets_dir + "/jquery-min.js", "viewcumber/jquery-min.js"
    File.copy assets_dir + "/viewcumber.js", "viewcumber/main.js"
    File.copy assets_dir + "/viewless.html", "viewcumber/viewless.html"
-   FileUtils.cp_r "public", "viewcumber/public"
+   FileUtils.cp_r File.join(Rails.root, "public"), "viewcumber/public"
  end
  class SnippetExtractor #:nodoc:

data/viewcumber.gemspec ADDED

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{viewcumber}
+  s.version = "0.0.3"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["gregbell", "pcreux", "samuelreh"]
+  s.date = %q{2010-11-10}
+  s.default_executable = %q{viewcumber}
+  s.executables = ["viewcumber"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/viewcumber",
+     "lib/assets/jquery-min.js",
+     "lib/assets/viewcumber.css",
+     "lib/assets/viewcumber.js",
+     "lib/assets/viewless.html",
+     "lib/viewcumber.rb",
+     "test/helper.rb",
+     "test/test_viewcumber.rb",
+     "viewcumber.gemspec"
+  ]
+  s.homepage = %q{http://github.com/versapay/viewcumber}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Cucumber formatter for easily viewing each step of your scenarios}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_viewcumber.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cucumber>, [">= 0.8.5"])
+      s.add_runtime_dependency(%q<capybara>, [">= 0.3"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0.8.5"])
+      s.add_dependency(%q<capybara>, [">= 0.3"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0.8.5"])
+    s.add_dependency(%q<capybara>, [">= 0.3"])
+  end
+end

metadata CHANGED

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: viewcumber
 version: !ruby/object:Gem::Version
-  hash: 27
+  hash: 25
   prerelease: false
   segments:
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors:
 - gregbell
@@ -17,8 +17,8 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-10-08 00:00:00 -07:00
-default_executable:
+date: 2010-11-10 00:00:00 -08:00
+default_executable: viewcumber
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -53,8 +53,8 @@ dependencies:
   version_requirements: *id002
 description:
 email:
-executables: []
+executables:
+- viewcumber
 extensions: []
 extra_rdoc_files:
@@ -67,6 +67,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/viewcumber
 - lib/assets/jquery-min.js
 - lib/assets/viewcumber.css
 - lib/assets/viewcumber.js
@@ -74,6 +75,7 @@ files:
 - lib/viewcumber.rb
 - test/helper.rb
 - test/test_viewcumber.rb
+- viewcumber.gemspec
 has_rdoc: true
 homepage: http://github.com/versapay/viewcumber
 licenses: []