cucumber-screenshot 0.2.0-universal-darwin → 0.2.1-universal-darwin

data/README.rdoc

@@ -1,11 +1,14 @@
 = Cucumber Screenshot
 
-Cucumber Screenshot adds a new output format to Cucumber that captures
-screenshots of the pages generated by your Rails application as it runs your
-Cucumber/Webrat features.
+Cucumber Screenshot makes it easy to capture screenshots of the pages generated
+by your Rails application as it runs your Cucumber/Webrat features.
 
 It uses WebKit to generate the screenshots and so is only available for OS X.
 
+If you want to take screenshots on any other platform then take a look at
+[this example]http://github.com/aslakhellesoy/cucumber/blob/master/examples/watir/features/support/screenshots.rb
+from Cucumber.
+
 == Requirements
 
 A Rails application with some features written in Cucumber/Webrat.
@@ -18,29 +21,34 @@ To install the latest release as a gem
 
 == Use
 
-Add the following linea to your ./features/support/env.rb file in your Rails
-project.
+Create a cucumber_screenshot_env.rb file in the ./features/support/ directory
+in your Rails project and put the following in it.
 
-  require 'cucumber_screenshot'
-  World(CucumberScreenshot::World)
+  begin
+    require 'cucumber_screenshot'
+    World(CucumberScreenshot::World)
 
-  # Take a screenshot if a scenario fails
-  After do |scenario|
-    if scenario.failed?
-      screenshot
+    After do |scenario|
+      if scenario.failed?
+        screenshot
+      end
     end
-  end
 
-  # Take a screenshot for every step for scenario/features tagged @screenshot
-  AfterStep('@screenshot') do |scenario|
-    if screenshot_due?
-      screenshot
+    AfterStep('@screenshot') do |scenario|
+      if screenshot_due?
+        screenshot
+      end
     end
+  rescue Exception => e
+    puts "Snapshots not available for this environment. Try installing
+      cucumber-screenshot with\n\n  gem install cucumber-screenshot\n"
   end
 
-Then use the 'rake cucumber' and 'rake cucumber:wip' tasks as per usual
+Then use the 'rake cucumber' and 'rake cucumber:wip' tasks as per usual.
 
-Screenshots will be saved in ./features/screenshots in your project.
+Screenshots will be captured for every step failure and for every step in
+scenarios tagged @screenshot. The screenshots will be saved to a 
+./features/screenshots/ directory in your project.
 
 === Capturing a single screenshot
 
@@ -50,7 +58,7 @@ following step to one of your Rails application's step files
   Then "screenshot" do
     screenshot
   end
-  
+
 and then add
 
   Then screenshot
@@ -62,6 +70,7 @@ page that your application generated.
 
 - Clean out existing snapshots before each run
 - Add support for tables
+- Add a Rails generator to add the env and step code to a project
 
 == License
 

data/Rakefile

@@ -2,16 +2,17 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name         = "cucumber-screenshot"
-    gemspec.summary      = "Cucumber formatter that outputs PNG screenshots of your app"
-    gemspec.description  = "Cucumber (http://cukes.info/) formatter that uses Webkit to capture PNG screenshots of your web application during tests"
+    gemspec.summary      = "Extension for Cucumber to capture PNG screenshots of your app"
+    gemspec.description  = "Extension for Cucumber (http://cukes.info/) that makes it easy to use Webkit to capture PNG screenshots of your web application during tests"
     gemspec.platform     = "universal-darwin"
     gemspec.requirements << "Mac OS X 10.5 or later"
     gemspec.requirements << "RubyCocoa"
-    gemspec.add_dependency('cucumber', '= 0.4.2')
-    gemspec.add_dependency('webrat', '= 0.5.3')
+    gemspec.add_dependency('cucumber', '>= 0.4.3')
+    gemspec.add_dependency('webrat', '>= 0.5.3')
     gemspec.add_dependency('snapurl', '>= 0.0.3')
     gemspec.email        = 'joel.chippindale@gmail.com'
     gemspec.authors      = ['Joel Chippindale']
+    gemspec.homepage     = 'http://github.com/mocoso/cucumber-screenshot'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
-:patch: 0
+:patch: 1
 :major: 0
 :minor: 2

data/lib/cucumber_screenshot/world.rb

@@ -10,22 +10,24 @@ module CucumberScreenshot
     end
 
     def screenshot(directory_name = base_screenshot_directory_name, file_name = "screenshot-#{(Time.now.to_f * 100).to_i}")
-      FileUtils.mkdir_p("#{directory_name}/html")
-
-      html_file_name = "#{directory_name}/html/#{file_name}.html"
-      File.open(html_file_name, "w") do |f|
-        f.write rewrite_javascript_and_css_and_image_references(current_response_body)
-      end
-
-      command = "snapurl file://#{html_file_name} --no-thumbnail --no-clip --filename #{file_name} --output-dir #{directory_name}"
-      `#{command}`
-      if $? == 0
-        embed_image "#{directory_name}/#{file_name}.png"
-        self.response_body_for_last_screenshot = current_response_body
-        true
-      else
-        report_error_running_screenshot_command(command)
-        false
+      if current_response_body
+        FileUtils.mkdir_p("#{directory_name}/html")
+
+        html_file_name = "#{directory_name}/html/#{file_name}.html"
+        File.open(html_file_name, "w") do |f|
+          f.write rewrite_javascript_and_css_and_image_references(current_response_body)
+        end
+
+        command = "snapurl file://#{html_file_name} --no-thumbnail --no-clip --filename #{file_name} --output-dir #{directory_name}"
+        `#{command}`
+        if $? == 0
+          embed "#{directory_name}/#{file_name}.png", 'image/png'
+          self.response_body_for_last_screenshot = current_response_body
+          true
+        else
+          report_error_running_screenshot_command(command)
+          false
+        end
       end
     end
 
@@ -33,10 +35,6 @@ module CucumberScreenshot
       current_response_body && current_response_body != response_body_for_last_screenshot && !webrat_session.redirect?
     end
 
-    def embed_image(image_path)
-      @__cucumber_step_mother.embed_image(image_path)
-    end
-
     protected
       def current_response_body
         webrat_session.send(:response) && webrat_session.response_body

data/lib/cucumber_screenshot.rb

@@ -3,8 +3,7 @@ require 'cucumber/formatter/html'
 require 'webrat'
 
 require 'cucumber_screenshot/world'
-require 'cucumber_screenshot/extensions'
 
 module CucumberScreenshot
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/cucumber_screenshot/world_spec.rb

@@ -18,22 +18,72 @@ describe CucumberScreenshot::World do
 
   describe '#screenshot' do
     before(:each) do
+      @session.stub!(
+        :webrat_session => stub('webrat_session', :send => true, :response_body => 'response html'),
+        :rewrite_javascript_and_css_and_image_references => 'rewritten response html',
+        :embed => true
+      )
+
+      # Stub with a command line call, required because don't know of other way to set $? to 0
+      # TODO: Replace with mechanism that doesn't require this call
+      @session.stub!(:'`').and_return { |args| `ruby -e 'true'` }
+
       FileUtils.stub!(:mkdir_p => true)
-      File.stub!(:open => true)
-      @session.stub!(:base_screenshot_directory_name => 'tmp/features/screenshots', :response_body => 'foo')
-      @session.stub!(:'`' => 'foo')
-      # While $? is not being set by the backtick stub
-      @session.stub!(:report_error_running_screenshot_command => true)
+      @file = stub('file', :write => true)
+      File.stub!(:open).and_yield(@file)
     end
 
     it 'should call File.makedirs' do
-      FileUtils.should_receive(:mkdir_p).with('1/2/html').and_return(true)
-      @session.screenshot('1/2', 'snapshot-001')
+      FileUtils.should_receive(:mkdir_p).with('/1/2/html').and_return(true)
+      @session.screenshot('/1/2', 'snapshot-001')
+    end
+
+    it 'should open a file ' do
+      File.should_receive(:open).with('/1/2/html/snapshot-001.html', 'w').and_yield(@file)
+      @session.screenshot('/1/2', 'snapshot-001')
+    end
+
+    it 'should write to file' do
+      @file.should_receive(:write).with('rewritten response html')
+      @session.screenshot('/1/2', 'snapshot-001')
+    end
+
+    it 'should call snapurl' do
+      @session.should_receive(:'`') do |args|
+        args.should == 'snapurl file:///1/2/html/snapshot-001.html --no-thumbnail --no-clip --filename snapshot-001 --output-dir /1/2'
+      end
+      @session.screenshot('/1/2', 'snapshot-001')
+    end
+
+    it 'should embed image' do
+      @session.should_receive(:embed).with('/1/2/snapshot-001.png', 'image/png')
+      @session.screenshot('/1/2', 'snapshot-001')
+    end
+
+    it 'should set response_body_for_last_screenshot' do
+      lambda { @session.screenshot('/1/2', 'snapshot-001') }.should change(@session, :response_body_for_last_screenshot).to('response html')
     end
-  end
 
-  describe '#embed_image' do
+    describe 'when snapurl fails' do
+      before(:each) do
+        @session.stub!(:'`').and_return { |args| `ruby -e 'exit(1)'` }
+        @session.stub!(:report_error_running_screenshot_command)
+      end
 
+      it 'should not embed image' do
+        @session.should_not_receive(:embed)
+        @session.screenshot('/1/2', 'snapshot-001')
+      end
+
+      it 'should not set response_body_for_last_screenshot' do
+        lambda { @session.screenshot('/1/2', 'snapshot-001') }.should_not change(@session, :response_body_for_last_screenshot)
+      end
+
+      it 'should call report_error_running_screenshot_command' do
+        @session.should_receive(:report_error_running_screenshot_command)
+        @session.screenshot('/1/2', 'snapshot-001')
+      end
+    end
   end
 
   describe 'protected' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-screenshot
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: universal-darwin
 authors: 
 - Joel Chippindale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-24 00:00:00 +01:00
+date: 2009-11-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.2
+        version: 0.4.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: webrat
@@ -28,7 +28,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 0.5.3
     version: 
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.3
     version: 
-description: Cucumber (http://cukes.info/) formatter that uses Webkit to capture PNG screenshots of your web application during tests
+description: Extension for Cucumber (http://cukes.info/) that makes it easy to use Webkit to capture PNG screenshots of your web application during tests
 email: joel.chippindale@gmail.com
 executables: []
 
@@ -57,14 +57,12 @@ files:
 - Rakefile
 - VERSION.yml
 - lib/cucumber_screenshot.rb
-- lib/cucumber_screenshot/extensions.rb
 - lib/cucumber_screenshot/world.rb
-- spec/cucumber_screenshot/extensions_spec.rb
 - spec/cucumber_screenshot/world_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/mocoso/cucumber-screenshot
 licenses: []
 
 post_install_message: 
@@ -91,8 +89,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Cucumber formatter that outputs PNG screenshots of your app
+summary: Extension for Cucumber to capture PNG screenshots of your app
 test_files: 
-- spec/cucumber_screenshot/extensions_spec.rb
 - spec/cucumber_screenshot/world_spec.rb
 - spec/spec_helper.rb

data/lib/cucumber_screenshot/extensions.rb

@@ -1,54 +0,0 @@
-module CucumberScreenshot
-  module Extensions
-
-    module StepMother
-      def self.included(base)
-        unless base.method_defined?(:embed_image)
-          base.send(:define_method, :embed_image) do |image_path|
-            @visitor.embed_image(image_path)
-          end
-        end
-      end
-    end
-
-    module TreeWalker
-      def self.included(base)
-        unless base.method_defined?(:embed_image)
-          base.send(:define_method, :embed_image) do |image_path|
-            broadcast(image_path)
-          end
-        end
-      end
-    end
-
-    module Console
-      def self.included(base)
-        unless base.method_defined?(:embed_image)
-          base.send(:define_method, :embed_image) do |image_path|
-            announce("- Image saved to #{image_path}")
-          end
-        end
-      end
-    end
-
-    module Html
-      def self.included(base)
-        unless base.method_defined?(:embed_image)
-          # TODO: needs style
-          # TODO: Place to right of or below step result (when captured with AfterStep)
-          base.send(:define_method, :embed_image) do |image_path|
-            builder.a('Screenshot', :class => 'announcement', :href => '#', :onclick => "img=document.getElementById('#{image_path}'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');")
-            builder.img(:id => image_path, :src => image_path, :style => 'display: none')
-          end
-        end
-      end
-    end
-  end
-end
-
-Cucumber::StepMother.send(:include, CucumberScreenshot::Extensions::StepMother)
-
-Cucumber::Ast::TreeWalker.send(:include, CucumberScreenshot::Extensions::TreeWalker)
-
-Cucumber::Formatter::Pretty.send(:include, CucumberScreenshot::Extensions::Console)
-Cucumber::Formatter::Html.send(:include, CucumberScreenshot::Extensions::Html)

data/spec/cucumber_screenshot/extensions_spec.rb

@@ -1,30 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
-
-describe CucumberScreenshot::Extensions do
-
-  describe 'formatters' do
-    before(:each) do
-      @step_mother = mock('step_mother')
-      @io = mock('io')
-    end
-
-    describe 'Pretty#embed_image' do
-      it 'should call announce' do
-        formatter = Cucumber::Formatter::Pretty.new(@step_mother, @io, {})
-        formatter.should_receive(:announce).with('- Image saved to /tmp/foo.png')
-        formatter.embed_image('/tmp/foo.png')
-      end
-    end
-
-    describe 'Html#embed_image' do
-      it 'should build link and image' do
-        formatter = Cucumber::Formatter::Html.new(@step_mother, @io, {})
-        builder = mock('builder')
-        formatter.stub!(:builder => builder)
-        builder.should_receive(:a)
-        builder.should_receive(:img)
-        formatter.embed_image('/tmp/foo.png')
-      end
-    end
-  end
-end