butternut 0.2.2-java

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.sass-cache

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeremy Stephens
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= butternut
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jeremy Stephens. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "butternut"
+    gem.summary = %Q{A Cucumber formatter that uses Celerity to capture HTML sources (JRuby)}
+    gem.description = %Q{Based on Cucumber's HTML formatter, Butternut uses Celerity to capture page sources after each step.}
+    gem.email = "viking415@gmail.com"
+    gem.homepage = "http://github.com/viking/butternut"
+    gem.authors = ["Jeremy Stephens"]
+    gem.platform = "java"
+    gem.add_dependency "cucumber", ">= 0.6.0"
+    gem.add_dependency "celerity"
+    gem.add_dependency "nokogiri"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.ruby_opts = %w{-X+O}
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => [:check_dependencies, "tmp:clear"]
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "butternut #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Generate the css for the html formatter from sass'
+task :sass do
+  sh 'sass -t expanded lib/butternut/cucumber.sass > lib/butternut/cucumber.css'
+end
+
+namespace :tmp do
+  desc 'Delete temporary files'
+  task :clear do
+    require 'fileutils'
+    FileUtils.rm_rf(Dir.glob(File.dirname(__FILE__) + "/tmp/*"))
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/butternut.gemspec

@@ -0,0 +1,82 @@
+# 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{butternut}
+  s.version = "0.2.2"
+  s.platform = %q{java}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Stephens"]
+  s.date = %q{2010-02-10}
+  s.description = %q{Based on Cucumber's HTML formatter, Butternut uses Celerity to capture page sources after each step.}
+  s.email = %q{viking415@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "butternut.gemspec",
+     "lib/butternut.rb",
+     "lib/butternut/cucumber.css",
+     "lib/butternut/cucumber.sass",
+     "lib/butternut/formatter.rb",
+     "lib/butternut/helpers.rb",
+     "lib/butternut/scenario_extensions.rb",
+     "spec/butternut/formatter_spec.rb",
+     "spec/butternut/helpers_spec.rb",
+     "spec/butternut_spec.rb",
+     "spec/fixtures/blargh.html",
+     "spec/fixtures/css/bar.css",
+     "spec/fixtures/facepalm.jpg",
+     "spec/fixtures/foo.css",
+     "spec/fixtures/foo.html",
+     "spec/fixtures/foo.js",
+     "spec/fixtures/picard.jpg",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tmp/.gitignore"
+  ]
+  s.homepage = %q{http://github.com/viking/butternut}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Cucumber formatter that uses Celerity to capture HTML sources (JRuby)}
+  s.test_files = [
+    "spec/butternut_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/butternut/formatter_spec.rb",
+     "spec/butternut/helpers_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cucumber>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<celerity>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0.6.0"])
+      s.add_dependency(%q<celerity>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0.6.0"])
+    s.add_dependency(%q<celerity>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/butternut/cucumber.css

@@ -0,0 +1,112 @@
+
+
+.cucumber {
+  font-family: Verdana, Arial, sans-serif;
+  font-size: 15px;
+  background: white;
+  padding: 1em; }
+  .cucumber h1, .cucumber h2, .cucumber h3, .cucumber h4, .cucumber ol, .cucumber li, .cucumber pre, .cucumber p {
+    font-size: 1em;
+    padding: 0px;
+    margin: 0px; }
+  .cucumber div.feature {
+    border: 1px solid;
+    padding: 2px;
+    margin: 4px; }
+    .cucumber div.feature div.background, .cucumber div.feature div.scenario, .cucumber div.feature p {
+      padding: 0em 0em 0em 1em; }
+      .cucumber div.feature div.background div.examples, .cucumber div.feature div.scenario div.examples, .cucumber div.feature p div.examples {
+        padding: 0em 0em 0em 1em; }
+  .cucumber .stats {
+    margin: 2em; }
+  .cucumber .summary ul.features li {
+    display: inline; }
+  .cucumber .backtrace {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1em; }
+  .cucumber a {
+    text-decoration: none;
+    color: inherit; }
+    .cucumber a:hover {
+      text-decoration: underline; }
+    .cucumber a:visited {
+      font-weight: normal; }
+    .cucumber a div.examples {
+      border: 1px solid;
+      padding: 2px;
+      margin: 4px; }
+  .cucumber table {
+    border-collapse: collapse; }
+    .cucumber table td, .cucumber table th {
+      font-size: 1em;
+      border: 1px solid #AAAAAA; }
+    .cucumber table td.failed {
+      background: #FFC0CB;
+      color: #8B0000; }
+    .cucumber table td.passed {
+      background: #98FB98;
+      color: #001111; }
+    .cucumber table td.skipped {
+      background: #e0ffff;
+      color: #001111; }
+    .cucumber table td.pending {
+      background: #FFFFE0;
+      color: #111100; }
+    .cucumber table td.undefined {
+      background: #FFFFE0;
+      color: #111100; }
+  .cucumber ol {
+    list-style: none; }
+    .cucumber ol li {
+      margin: 0em 0em 0em 1em;
+      padding: 0em 0em 0em 0.2em;
+      position: relative; }
+      .cucumber ol li span.param {
+        font-weight: bold; }
+      .cucumber ol li div.page {
+        position: absolute;
+        right: 0;
+        top: 0; }
+    .cucumber ol li.failed {
+      border-left: 5px solid red;
+      border-bottom: 1px solid red;
+      background: #ffc0cb;
+      color: #8b0000; }
+      .cucumber ol li.failed span.param {
+        background: !failed_dark; }
+    .cucumber ol li.passed {
+      border-left: 5px solid lime;
+      border-bottom: 1px solid lime;
+      background: #98fb98;
+      color: #001111; }
+      .cucumber ol li.passed span.param {
+        background: lime; }
+    .cucumber ol li.skipped {
+      border-left: 5px solid aqua;
+      border-bottom: 1px solid aqua;
+      background: #e0ffff;
+      color: #001111; }
+      .cucumber ol li.skipped span.param {
+        background: aqua; }
+    .cucumber ol li.pending {
+      border-left: 5px solid #ff8000;
+      border-bottom: 1px solid #ff8000;
+      background: yellow;
+      color: #2a1b0a; }
+      .cucumber ol li.pending span.param {
+        background: #ff8000; }
+    .cucumber ol li.undefined {
+      border-left: 5px solid #ff8000;
+      border-bottom: 1px solid #ff8000;
+      background: yellow;
+      color: #2a1b0a; }
+      .cucumber ol li.undefined span.param {
+        background: #ff8000; }
+  .cucumber .icon-show {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH1gkWFgcEIFayvAAAAB10RVh0Q29tbWVudABDcmVhdGVkIHdpdGggVGhlIEdJTVDvZCVuAAABsElEQVQ4y6WSS2sTURzFf3c6giWktRql7roLqIv5CA1FtBtdpC+6cVGQItFvIz6w0l1F+gG6qa0WxFUIgQhu0hJd9arptJ1mHr33uhgbcjsJFjybC//nOf97xJPK8q6UcoJzKBQKX188f3Wbf8CVUk5UKo9wnKFu8CTo8GZl7RYXgAsQxyG7e00wBmMMN67fBGB2vmwGNY6NXdl+/XKl5AKEYUQQnKQZA99/tJgp3yOKIwQOCGE1x3HCxsanyS6DXjQae/h+ANT7bh4fv4rn3bEl9ML3A96/Wx+oeW5hJnsDpRRJEluHbLd/9dF9DYAkSewBWmvSV3UTtVotM6BUmiK9WcceEEUhnU5oFXuex4W/ceiSSxwlVmJn5yNvV1dRSmWaNje/kMvlWFicWxOz82WTz+eRUlpFDx/cpVgsMjKS50zmqTrFGDBa8WHrM9VqPWXw7OkSxmQ9c3zs02w2EOd8ADB9f4pqtS7d1DuGVutbX42O42RiWmsODnyAIxeg/fsno6MFi8XZVpuY+RsTHB76AL54vLy0tb8vJ9PJA62P44geBobh4ctHWutF/hd/AExBukCW3MYjAAAAAElFTkSuQmCC);
+    background-repeat: no-repeat;
+    float: left;
+    width: 16px;
+    height: 16px;
+    display: block; }

data/lib/butternut/cucumber.sass

@@ -0,0 +1,152 @@
+# cucumber.css is generated from cucumber.sass
+# Regenerate with rake sass
+
+!step_left   = 5px solid
+!step_bottom = 1px solid
+
+!failed         = #FFC0CB
+!failed_dark    = #FF0000
+!failed_text    = #8B0000
+
+!passed         = #98FB98
+!passed_dark    = #00FF00
+!passed_text    = #001111
+
+!skipped        = #E0FFFF
+!skipped_dark   = #00FFFF
+!skipped_text   = #001111
+
+!pending        = #FFFF00
+!pending_dark   = #FF8000
+!pending_text   = #2A1B0A
+
+!undefined      = #FFFF00
+!undefined_dark = #FF8000
+!undefined_text = #2A1B0A
+
+.cucumber
+  :font-family Verdana, Arial, sans-serif
+  :font-size 15px
+  :background white
+  :padding 1em
+
+  h1, h2, h3, h4, ol, li, pre, p
+    :font-size 1em
+    :padding 0px
+    :margin 0px
+
+  div.feature
+    :border 1px solid
+    :padding 2px
+    :margin 4px
+
+    div.background, div.scenario, p
+      :padding 0em 0em 0em 1em
+      div.examples
+        :padding 0em 0em 0em 1em
+
+  .stats
+    :margin 2em
+
+  .summary
+    ul.features
+      li
+        :display inline
+
+  .backtrace
+    :margin-top 0
+    :margin-bottom 0
+    :margin-left 1em
+
+  a
+    :text-decoration none
+    :color inherit
+
+    &:hover
+      :text-decoration underline
+    &:visited
+      :font-weight normal
+
+    div.examples
+      :border 1px solid
+      :padding 2px
+      :margin 4px
+
+  table
+    :border-collapse collapse
+
+    td, th
+      :font-size 1em
+      :border 1px solid #AAAAAA
+    td.failed
+      :background #FFC0CB
+      :color #8B0000
+    td.passed
+      :background #98FB98
+      :color= !passed_text
+    td.skipped
+      :background= !skipped
+      :color= !skipped_text
+    td.pending
+      :background #FFFFE0
+      :color #111100
+    td.undefined
+      :background #FFFFE0
+      :color #111100
+
+  ol
+    :list-style none
+
+    li
+      :margin 0em 0em 0em 1em
+      :padding 0em 0em 0em 0.2em
+      :position relative
+      span.param
+        :font-weight bold
+      div.page
+        :position absolute
+        :right 0
+        :top 0
+    li.failed
+      :border-left= !step_left !failed_dark
+      :border-bottom= !step_bottom !failed_dark
+      :background= !failed
+      :color= !failed_text
+      span.param
+        :background !failed_dark
+    li.passed
+      :border-left= !step_left !passed_dark
+      :border-bottom= !step_bottom !passed_dark
+      :background= !passed
+      :color= !passed_text
+      span.param
+        :background= !passed_dark
+    li.skipped
+      :border-left= !step_left !skipped_dark
+      :border-bottom= !step_bottom !skipped_dark
+      :background= !skipped
+      :color= !skipped_text
+      span.param
+        :background= !skipped_dark
+    li.pending
+      :border-left= !step_left !pending_dark
+      :border-bottom= !step_bottom !pending_dark
+      :background= !pending
+      :color= !pending_text
+      span.param
+        :background= !pending_dark
+    li.undefined
+      :border-left= !step_left !undefined_dark
+      :border-bottom= !step_bottom !undefined_dark
+      :background= !undefined
+      :color= !undefined_text
+      span.param
+        :background= !undefined_dark
+
+  .icon-show
+    :background-image url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH1gkWFgcEIFayvAAAAB10RVh0Q29tbWVudABDcmVhdGVkIHdpdGggVGhlIEdJTVDvZCVuAAABsElEQVQ4y6WSS2sTURzFf3c6giWktRql7roLqIv5CA1FtBtdpC+6cVGQItFvIz6w0l1F+gG6qa0WxFUIgQhu0hJd9arptJ1mHr33uhgbcjsJFjybC//nOf97xJPK8q6UcoJzKBQKX188f3Wbf8CVUk5UKo9wnKFu8CTo8GZl7RYXgAsQxyG7e00wBmMMN67fBGB2vmwGNY6NXdl+/XKl5AKEYUQQnKQZA99/tJgp3yOKIwQOCGE1x3HCxsanyS6DXjQae/h+ANT7bh4fv4rn3bEl9ML3A96/Wx+oeW5hJnsDpRRJEluHbLd/9dF9DYAkSewBWmvSV3UTtVotM6BUmiK9WcceEEUhnU5oFXuex4W/ceiSSxwlVmJn5yNvV1dRSmWaNje/kMvlWFicWxOz82WTz+eRUlpFDx/cpVgsMjKS50zmqTrFGDBa8WHrM9VqPWXw7OkSxmQ9c3zs02w2EOd8ADB9f4pqtS7d1DuGVutbX42O42RiWmsODnyAIxeg/fsno6MFi8XZVpuY+RsTHB76AL54vLy0tb8vJ9PJA62P44geBobh4ctHWutF/hd/AExBukCW3MYjAAAAAElFTkSuQmCC)
+    :background-repeat no-repeat
+    :float left
+    :width 16px
+    :height 16px
+    :display block

data/lib/butternut/formatter.rb

@@ -0,0 +1,144 @@
+require 'cucumber/formatter/html'
+
+require 'fileutils'
+require 'nokogiri'
+require 'uri'
+require 'open-uri'
+require 'net/ftp'   # For Net::FTPPermError
+
+module Butternut
+  class Formatter < Cucumber::Formatter::Html
+
+    def initialize(step_mother, io, options)
+      # find the format options
+      format = options[:formats].detect { |(name, _)| name == "Butternut::Formatter" }
+      if !format || !format[1].is_a?(String)
+        raise "Butternut::Formatter cannot output to STDOUT"
+      end
+      out = format[1]
+
+      super
+      if File.directory?(out)
+        #@assets_dir = out
+        #@assets_url = "."
+      else
+        basename = File.basename(out).sub(/\..*$/, "")
+        @assets_dir = File.join(File.dirname(out), basename)
+        @assets_url = basename
+        if !File.exist?(@assets_dir)
+          FileUtils.mkdir(@assets_dir)
+        end
+      end
+    end
+
+    def before_feature_element(feature_element)
+      super
+      @feature_element = feature_element
+    end
+
+    def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+      return if @hide_this_step
+      # print snippet for undefined steps
+      if status == :undefined
+        step_multiline_class = @step.multiline_arg ? @step.multiline_arg.class : nil
+        @builder.pre do |pre|
+          pre << @step_mother.snippet_text(@step.actual_keyword,step_match.instance_variable_get("@name") || '',step_multiline_class)
+        end
+      end
+      add_page_source_link(@builder)
+      @builder << '</li>'
+    end
+
+    private
+      def add_page_source_link(builder)
+        if !@feature_element.respond_to?(:last_page_source) || @feature_element.last_page_source.nil?
+          # don't add a link of we haven't interacted with a webpage
+          return
+        end
+
+        page_source = @feature_element.last_page_source
+        page_url = @feature_element.last_page_url
+        @feature_element.last_page_source = nil
+        @feature_element.last_page_url = nil
+
+        page_source = transform_page_source(page_source, page_url)
+        path = source_file_name
+        File.open(path, "w") { |f| f.print(page_source) }
+
+        builder.a({:target => "_blank", :href => "#{@assets_url}/#{File.basename(path)}"}) do
+          builder << "Source"
+        end
+      end
+
+      def source_file_name
+        t = Time.now.strftime("%Y%m%d")
+        path = nil
+        while path.nil?
+          path = File.join(@assets_dir, "butternut#{t}-#{$$}-#{rand(0x100000000).to_s(36)}.html")
+          path = nil if File.exist?(path)
+        end
+        path
+      end
+
+      def transform_page_source(page_source, page_url)
+        base_uri = URI.parse(page_url)
+        base_uri.query = nil
+        @already_collected = []
+
+        doc = Nokogiri.HTML(page_source)
+        { :image      => ['img', 'src'],
+          :stylesheet => ['link[rel=stylesheet]', 'href']
+        }.each_pair do |type, (selector, attr)|
+          doc.css(selector).each do |elt|
+            elt_url = elt[attr]
+            next  if elt_url.nil? || elt_url.empty?
+
+            result = save_remote_file(base_uri, type, elt_url)
+            elt[attr] = result  if result
+          end
+        end
+
+        # disable links
+        doc.css('a').each { |link| link['href'] = "#" }
+
+        # turn off scripts
+        doc.css('script').each { |s| s.unlink }
+
+        # disable form elements
+        doc.css('input, select, textarea').each { |x| x['disabled'] = 'disabled' }
+
+        doc.to_s
+      end
+
+      def transform_stylesheet(stylesheet_uri, content)
+        content.gsub(%r{url\(([^\)]+)\)}) do |_|
+          result = save_remote_file(stylesheet_uri, :image, $1)
+          "url(#{result || $1})"
+        end
+      end
+
+      def save_remote_file(base_uri, type, url)
+        # FIXME: two different files could have the same basename :)
+        begin
+          uri = URI.parse(url)
+        rescue URI::InvalidURIError
+          return nil
+        end
+        remote_uri = uri.absolute? ? uri : base_uri.merge(uri)
+        basename   = File.basename(uri.path)
+
+        unless @already_collected.include?(remote_uri)
+          begin
+            content = open(remote_uri.to_s).read
+            content = transform_stylesheet(remote_uri, content) if type == :stylesheet
+            local_path = File.join(@assets_dir, basename)
+            File.open(local_path, "w") { |f| f.write(content) }
+            @already_collected << remote_uri
+          rescue IOError, Errno::ENOENT, OpenURI::HTTPError, Net::FTPPermError
+            return nil
+          end
+        end
+        basename
+      end
+  end
+end