cucumber-screenshot 0.1.0-universal-darwin → 0.2.0-universal-darwin

data/README.rdoc

@@ -18,27 +18,37 @@ To install the latest release as a gem
 
 == Use
 
-Add the following line to your ./features/support/env.rb file
+Add the following linea to your ./features/support/env.rb file in your Rails
+project.
 
   require 'cucumber_screenshot'
+  World(CucumberScreenshot::World)
 
-and then run
+  # Take a screenshot if a scenario fails
+  After do |scenario|
+    if scenario.failed?
+      screenshot
+    end
+  end
 
-  cucumber features --format screenshot
+  # Take a screenshot for every step for scenario/features tagged @screenshot
+  AfterStep('@screenshot') do |scenario|
+    if screenshot_due?
+      screenshot
+    end
+  end
 
-from your Rails application's directory.
+Then use the 'rake cucumber' and 'rake cucumber:wip' tasks as per usual
 
-This will create a ./features/screenshots directory in your Rails application
-with subfolders for each scenario. Each subfolder will contain a screenshot of
-each page generated and the html source of each of those pages.
+Screenshots will be saved in ./features/screenshots in your project.
 
-== Capturing a single screenshot
+=== Capturing a single screenshot
 
 If you want to capture a single screenshot rather than every page then add the
 following step to one of your Rails application's step files
 
-  sudo gem install webratThen "screenshot" do
-    screenshot.should be_true
+  Then "screenshot" do
+    screenshot
   end
   
 and then add
@@ -46,7 +56,7 @@ and then add
   Then screenshot
 
 to your feature file in the place where you want to capture a screenshot of the
-page that your application geneerated.
+page that your application generated.
 
 == TODO
 

data/Rakefile

@@ -7,9 +7,9 @@ begin
     gemspec.platform     = "universal-darwin"
     gemspec.requirements << "Mac OS X 10.5 or later"
     gemspec.requirements << "RubyCocoa"
-    gemspec.add_dependency('cucumber', '>= 0.3.9')
-    gemspec.add_dependency('webrat', '>= 0.5.3')
-    gemspec.add_dependency('mocoso-snapurl', '>= 0.0.3')
+    gemspec.add_dependency('cucumber', '= 0.4.2')
+    gemspec.add_dependency('webrat', '= 0.5.3')
+    gemspec.add_dependency('snapurl', '>= 0.0.3')
     gemspec.email        = 'joel.chippindale@gmail.com'
     gemspec.authors      = ['Joel Chippindale']
   end

data/VERSION.yml

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

data/lib/cucumber_screenshot.rb

@@ -1,17 +1,10 @@
 require 'cucumber'
+require 'cucumber/formatter/html'
 require 'webrat'
 
-require 'cucumber_screenshot/formatter'
-require 'cucumber_screenshot/webrat/session'
+require 'cucumber_screenshot/world'
+require 'cucumber_screenshot/extensions'
 
-# Add formatter to Cucumber's built in list so you can use
-#
-#   --format screenshot
-#
-# as well as
-#
-#   --format Cucumber::Format::Screenshot
-Cucumber::Cli::Configuration::BUILTIN_FORMATS['screenshot'] = 'CucumberScreenshot::Formatter'
-
-# Make screenshot method available to steps
-Webrat::Methods.delegate_to_session :screenshot
+module CucumberScreenshot
+  VERSION = '0.2.0'
+end

data/lib/cucumber_screenshot/extensions.rb

@@ -0,0 +1,54 @@
+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/lib/cucumber_screenshot/world.rb

@@ -0,0 +1,64 @@
+module CucumberScreenshot
+  module World
+
+    attr_accessor :response_body_for_last_screenshot, :screenshot_index, :screenshot_directory, :current_feature_segment, :current_scenario_segment
+
+    def base_screenshot_directory_name
+      # TODO: Make this configurable
+      # TODO: Make this work for other frameworks e.g. sinatra
+      "#{RAILS_ROOT}/features/screenshots"
+    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
+      end
+    end
+
+    def screenshot_due?
+      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
+      end
+
+      def rewrite_javascript_and_css_and_image_references(response_html) # :nodoc:
+        doc_root = webrat_session.adapter.doc_root
+        return response_html unless doc_root
+        response_html.gsub(/"\/(javascripts|stylesheets|images)\//, '"' + doc_root + '/\1/')
+      end
+
+      def report_error_running_screenshot_command(command)
+        STDERR.puts "
+Unable to make screenshot, to find out what went wrong try the following from the command line
+
+    #{command}
+
+Please remember need to have installed the gem snapurl to take screenshots
+
+    gem install snapurl
+
+"
+      end
+  end
+end

data/spec/cucumber_screenshot/extensions_spec.rb

@@ -0,0 +1,30 @@
+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

data/spec/cucumber_screenshot/world_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+class TestWorld
+  include CucumberScreenshot::World
+end
+
+describe CucumberScreenshot::World do
+  before(:each) do
+    @session = TestWorld.new
+  end
+
+  describe '#base_screenshot_directory_name' do
+    it "add features/screenshots to rails root" do
+      ::RAILS_ROOT = 'tmp'
+      TestWorld.new.base_screenshot_directory_name.should == 'tmp/features/screenshots'
+    end
+  end
+
+  describe '#screenshot' do
+    before(:each) do
+      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)
+    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')
+    end
+  end
+
+  describe '#embed_image' do
+
+  end
+
+  describe 'protected' do
+    describe '#rewrite_javascript_and_css_and_image_references' do
+      before(:each) do
+        @session.stub!(:webrat_session => stub('webrat_session', :adapter => stub('rails_adapter', :doc_root => '/tmp/public')))
+      end
+
+      it 'should replace relative /javascripts/ references with file references' do
+        @session.send(:rewrite_javascript_and_css_and_image_references, '<script src="/javascripts/application.js?1255077419" type="text/javascript"></script>').
+          should == '<script src="/tmp/public/javascripts/application.js?1255077419" type="text/javascript"></script>'
+      end
+
+      it 'should replace relative /javascripts/ references with file references' do
+        @session.send(:rewrite_javascript_and_css_and_image_references, '<link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />').
+          should == '<link href="/tmp/public/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,2 @@
-SPEC_DIR = File.dirname(__FILE__)
-
 require 'rubygems'
 require 'cucumber_screenshot'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-screenshot
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: universal-darwin
 authors: 
 - Joel Chippindale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 +01:00
+date: 2009-10-24 00:00:00 +01: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.3.9
+        version: 0.4.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: webrat
@@ -28,12 +28,12 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.5.3
     version: 
 - !ruby/object:Gem::Dependency 
-  name: mocoso-snapurl
+  name: snapurl
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -57,10 +57,10 @@ files:
 - Rakefile
 - VERSION.yml
 - lib/cucumber_screenshot.rb
-- lib/cucumber_screenshot/formatter.rb
-- lib/cucumber_screenshot/webrat/session.rb
-- spec/cucumber_screenshot/formatter_spec.rb
-- spec/cucumber_screenshot/webrat/session_spec.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
@@ -93,6 +93,6 @@ signing_key:
 specification_version: 3
 summary: Cucumber formatter that outputs PNG screenshots of your app
 test_files: 
-- spec/cucumber_screenshot/formatter_spec.rb
-- spec/cucumber_screenshot/webrat/session_spec.rb
+- spec/cucumber_screenshot/extensions_spec.rb
+- spec/cucumber_screenshot/world_spec.rb
 - spec/spec_helper.rb

data/lib/cucumber_screenshot/formatter.rb

@@ -1,63 +0,0 @@
-module CucumberScreenshot
-  class Formatter < Cucumber::Ast::Visitor
-
-    attr_accessor :response_body_for_last_screenshot, :screenshot_index, :screenshot_directory, :current_feature_segment, :current_scenario_segment
-
-    # Currently ignores io and options arguments
-    def initialize(step_mother, io, options)
-      super(step_mother)
-      @io = io
-      @options = options
-    end
-
-    def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
-      if screenshot_due?
-        self.screenshot_index = screenshot_index.next
-        exit unless session.screenshot(screenshot_directory_name, "screenshot-#{format('%03d', screenshot_index)}")
-        self.response_body_for_last_screenshot = current_response_body
-      end
-      super
-    end
-
-    def visit_scenario_name(keyword, name, file_colon_line, source_indent)
-      puts "Scenario #{name}"
-      self.response_body_for_last_screenshot = nil
-      self.screenshot_index = 0
-      self.current_scenario_segment = segment_for_scenario_named(name)
-    end
-
-    def visit_feature(feature)
-      self.current_feature_segment = segment_for_feature(feature)
-      super
-    end
-
-    def visit_feature_name(name)
-      puts(name)
-    end
-
-    protected
-      def screenshot_directory_name
-        File.join(session.base_screenshot_directory_name, current_feature_segment, current_scenario_segment)
-      end
-
-      def segment_for_feature(feature)
-        feature.file.gsub(/^features\//, '').gsub(/\.feature$/, '')
-      end
-
-      def segment_for_scenario_named(name)
-        name.downcase.gsub(' ', '_').gsub(/(\(|\))/, '')
-      end
-
-      def session
-        step_mother.current_world.webrat_session
-      end
-
-      def current_response_body
-        session.send(:response) && session.response_body
-      end
-
-      def screenshot_due?
-        current_response_body && current_response_body != response_body_for_last_screenshot && !session.redirect?
-      end
-  end
-end

data/lib/cucumber_screenshot/webrat/session.rb

@@ -1,53 +0,0 @@
-module CucumberScreenshot
-  module Webrat
-    module Session #:nodoc:
-
-      def base_screenshot_directory_name
-        # TODO: Make this configurable
-        # TODO: Make this work for other frameworks e.g. sinatra
-        "#{RAILS_ROOT}/features/screenshots"
-      end
-
-      def screenshot(directory_name = base_screenshot_directory_name, file_name = "screenshot-#{Time.now.to_i}")
-        File.makedirs("#{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(response_body)
-        end
-
-        command = "snapurl file://#{html_file_name} --no-thumbnail --no-clip --filename #{file_name} --output-dir #{directory_name}"
-        `#{command}`
-        if $? == 0
-          puts "- Screenshot saved to #{directory_name}/#{file_name}.png\n"
-          true
-        else
-          report_error_running_screenshot_command(command)
-          false
-        end
-      end
-
-      protected
-        def rewrite_javascript_and_css_and_image_references(response_html) # :nodoc:
-          return response_html unless doc_root
-          rewrite_css_and_image_references(response_html).gsub(/"\/(javascript)/, doc_root + '/\1')
-        end
-
-        def report_error_running_screenshot_command(command)
-          STDERR.puts "
-Unable to make screenshot, to find out what went wrong try the following from the command line
-
-    #{command}
-
-Please remember need to have installed the gem mocoso-snapshoturl to take screenshots
-
-    gem install mocoso-snapshoturl
-
-"
-        end
-    end
-  end
-end
-
-Webrat::Session.send(:include, CucumberScreenshot::Webrat::Session)
-

data/spec/cucumber_screenshot/formatter_spec.rb

@@ -1,14 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-module CucumberScreenshot
-  describe Formatter do
-    describe '#visit_scenario_named' do
-      before(:each) do
-        @formatter = Formatter.new(stub('step_mother'), nil, {})
-      end
-      it "set current_scenario_segment from scenario name" do
-        lambda { @formatter.visit_scenario_name(nil, 'Login (when already has an account)', 1, 2) }.should change(@formatter, :current_scenario_segment).to('login_when_already_has_an_account')
-      end
-    end
-  end
-end

data/spec/cucumber_screenshot/webrat/session_spec.rb

@@ -1,30 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-
-module CucumberScreenshot
-  module Webrat
-    describe Session do
-      describe '#base_screenshot_directory_name' do
-        it "add features/screenshots to rails root" do
-          ::RAILS_ROOT = 'tmp'
-          ::Webrat::Session.new.base_screenshot_directory_name.should == 'tmp/features/screenshots'
-        end
-      end
-
-      describe '#screenshot' do
-        before(:each) do
-          @html_file = stub('html_file', :write => true)
-          File.stub!(:makedirs => true, :open => @html_file)
-          @session = ::Webrat::Session.new
-          @session.stub!(:base_screenshot_directory_name => 'tmp/features/screenshots', :response_body => 'foo')
-          @session.stub!(:` => 'foo')
-          @session.stub!(:report_error_running_screenshot_command => true) # While $? is not being set by the backtick stub
-        end
-
-        it 'should call File.makedirs' do
-          File.should_receive(:makedirs).with('1/2/html').and_return(true)
-          @session.screenshot('1/2', 'snapshot-001')
-        end
-      end
-    end
-  end
-end