butternut 0.0.1 → 0.1.0

data/Rakefile

@@ -33,7 +33,7 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
+task :spec => [:check_dependencies, "tmp:clear"]
 
 task :default => :spec
 
@@ -51,3 +51,11 @@ 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/features/*"), :verbose => true)
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/butternut.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{butternut}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Stephens"]
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "spec/butternut/helpers_spec.rb",
      "spec/butternut_spec.rb",
      "spec/fixtures/css/bar.css",
+     "spec/fixtures/facepalm.jpg",
      "spec/fixtures/foo.css",
      "spec/fixtures/foo.html",
      "spec/fixtures/foo.js",

data/lib/butternut/formatter.rb

@@ -1,10 +1,12 @@
 require 'cucumber/formatter/ordered_xml_markup'
 require 'cucumber/formatter/duration'
+
 require 'tmpdir'
 require 'fileutils'
 require 'nokogiri'
 require 'uri'
 require 'open-uri'
+require 'net/ftp'   # For Net::FTPPermError
 
 module Butternut
   class Formatter
@@ -414,42 +416,25 @@ module Butternut
     end
 
     def transform_page_source(page_source, page_url)
-      page_uri = URI.parse(page_url)
-      page_uri.query = nil
-      collected_files = []
+      base_uri = URI.parse(page_url)
+      base_uri.query = nil
+      @already_collected = []
 
       doc = Nokogiri.HTML(page_source)
-      { 'img' => 'src',
-        'link[rel=stylesheet]' => 'href'
-      }.each_pair do |selector, attr|
+      { :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.gsub!('\\"', "")
-          next  if elt_url.empty?
-          next  if collected_files.index(elt_url)
-
-          basename    = File.basename(elt_url)
-          local_file  = File.join(@source_output_dir, basename)
-          remote_file = case elt_url
-                        when %r{^\w+://} then elt_url
-                        when %r{^/} then
-                          "#{page_uri.scheme}://#{page_uri.host}:#{page_uri.port}#{elt_url}"
-                        else
-                          page_url.to_s + "/" + elt_url
-                        end
-          File.open(local_file, "w") { |f| f.write open(remote_file).read }
-          collected_files << elt_url
-
-          elt[attr] = basename
+          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 do |link|
-        link['href'] = "#"
-      end
+      doc.css('a').each { |link| link['href'] = "#" }
 
       # turn off scripts
       doc.css('script').each { |s| s.unlink }
@@ -459,5 +444,32 @@ module Butternut
 
       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 :)
+      uri = URI.parse(url)
+      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(@source_output_dir, basename)
+          File.open(local_path, "w") { |f| f.write(content) }
+          @already_collected << remote_uri
+        rescue Errno::ENOENT, OpenURI::HTTPError, Net::FTPPermError
+          return nil
+        end
+      end
+      basename
+    end
   end
 end

data/spec/butternut/formatter_spec.rb

@@ -12,6 +12,12 @@ module Butternut
       end
     end
 
+    Spec::Matchers.define :be_an_existing_file do
+      match do |filename|
+        File.exist?(filename)
+      end
+    end
+
     def setup_formatter(options = {})
       @out = StringIO.new
       @formatter = Butternut::Formatter.new(step_mother, @out, options)
@@ -232,15 +238,15 @@ module Butternut
 
     describe "displaying page source to file" do
       before(:each) do
-        @tmpdir = File.join(File.dirname(__FILE__), "..", "..", "tmp")
+        dir = File.join(File.dirname(__FILE__), "..", "..", "tmp")
         setup_formatter({:formats => [
-          ['Butternut::Formatter', File.join(@tmpdir, "main", "huge.html")]
+          ['Butternut::Formatter', File.join(dir, "main", "huge.html")]
         ]})
         run_defined_feature
         @doc = Nokogiri.HTML(@out.string)
 
-        dir = File.join(@tmpdir, "features", Date.today.to_s)
-        file = most_recent_html_file(dir)
+        @tmp_dir = File.join(dir, "features", Date.today.to_s)
+        file = most_recent_html_file(@tmp_dir)
         @page_doc = Nokogiri.HTML(open(file).read)
       end
 
@@ -264,9 +270,20 @@ module Butternut
       end
 
       it "saves images and stylesheets and rewrites urls in page source" do
-        @page_doc.at('img')['src'].should == "picard.jpg"
-        @page_doc.at('link:first[rel="stylesheet"]')['href'].should == "foo.css"
-        @page_doc.at('link:last[rel="stylesheet"]')['href'].should == "bar.css"
+        @page_doc.at('img:nth(1)')['src'].should == "picard.jpg"
+        File.join(@tmp_dir, "picard.jpg").should be_an_existing_file
+
+        @page_doc.at('link:nth(1)[rel="stylesheet"]')['href'].should == "foo.css"
+        File.join(@tmp_dir, "foo.css").should be_an_existing_file
+
+        @page_doc.at('link:nth(2)[rel="stylesheet"]')['href'].should == "bar.css"
+        File.join(@tmp_dir, "bar.css").should be_an_existing_file
+      end
+
+      it "saves assets and rewrites urls referred to by stylesheets" do
+        foo = open(File.join(@tmp_dir, "foo.css")).read
+        foo.should include("url(facepalm.jpg)")
+        File.join(@tmp_dir, "facepalm.jpg").should be_an_existing_file
       end
 
       it "turns off links" do
@@ -284,6 +301,18 @@ module Butternut
           elt['disabled'].should == "disabled"
         end
       end
+
+      it "handles Errno::ENOENT" do
+        @page_doc.at('img:nth(2)')['src'].should == "/roflpwnage/missing_file_omg.gif"
+      end
+
+      it "handles OpenURI::HTTPError" do
+        @page_doc.at('img:nth(3)')['src'].should == "http://google.com/missing_file_omg.gif"
+      end
+
+      it "handles Net::FTPPermError" do
+        @page_doc.at('img:nth(4)')['src'].should == "ftp://mirror.anl.gov/missing_file_omg.gif"
+      end
     end
   end
 end

data/spec/fixtures/foo.css

@@ -1,3 +1,9 @@
 body {
   font-family: Verdana;
 }
+
+.facepalm {
+  width: 750px;
+  height: 600px;
+  background: url(../fixtures/facepalm.jpg);
+}

data/spec/fixtures/foo.html

@@ -2,7 +2,7 @@
   <head>
     <title>Foo</title>
     <link rel="stylesheet" href="foo.css" type="text/css"/>
-    <link rel="stylesheet" href="/css/bar.css" type="text/css"/>
+    <link rel="stylesheet" href="css/bar.css" type="text/css"/>
     <script type="text/javascript" src="foo.js"></script>
   </head>
   <body>
@@ -17,5 +17,10 @@
       <textarea name="yar"></textarea>
       <input type="submit" value="Submit" />
     </form>
+    <img src="/roflpwnage/missing_file_omg.gif"/>
+    <img src="http://google.com/missing_file_omg.gif"/>
+    <img src="ftp://mirror.anl.gov/missing_file_omg.gif"/>
+
+    <div class="facepalm">&nbsp;</div>
   </body>
 </html>

data/spec/spec.opts

@@ -1 +1,2 @@
 --color
+--backtrace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: butternut
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
   - Jeremy Stephens
@@ -79,6 +79,7 @@ files:
   - spec/butternut/helpers_spec.rb
   - spec/butternut_spec.rb
   - spec/fixtures/css/bar.css
+  - spec/fixtures/facepalm.jpg
   - spec/fixtures/foo.css
   - spec/fixtures/foo.html
   - spec/fixtures/foo.js