cucumber-screenshot 0.1.0-universal-darwin

data/.gitignore

@@ -0,0 +1,2 @@
+*.gemspec
+pkg/*

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Joel Chippindale
+
+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,59 @@
+= 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.
+
+It uses WebKit to generate the screenshots and so is only available for OS X.
+
+== Requirements
+
+A Rails application with some features written in Cucumber/Webrat.
+
+== Install
+
+To install the latest release as a gem
+
+  sudo gem install cucumber-screenshot
+
+== Use
+
+Add the following line to your ./features/support/env.rb file
+
+  require 'cucumber_screenshot'
+
+and then run
+
+  cucumber features --format screenshot
+
+from your Rails application's directory.
+
+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.
+
+== 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
+  end
+  
+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.
+
+== TODO
+
+- Clean out existing snapshots before each run
+- Add support for tables
+
+== License
+
+Copyright (c) 2009 Joel Chippindale.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,30 @@
+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.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.email        = 'joel.chippindale@gmail.com'
+    gemspec.authors      = ['Joel Chippindale']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run the cucumber-screenshot specs"
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--options', 'spec/spec.opts']
+  end
+rescue LoadError
+  puts 'Rspec not available, install it with: sudo gem install rspec'
+end

data/VERSION.yml

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

data/lib/cucumber_screenshot.rb

@@ -0,0 +1,17 @@
+require 'cucumber'
+require 'webrat'
+
+require 'cucumber_screenshot/formatter'
+require 'cucumber_screenshot/webrat/session'
+
+# 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

data/lib/cucumber_screenshot/formatter.rb

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

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

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

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

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: cucumber-screenshot
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: universal-darwin
+authors: 
+- Joel Chippindale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :runtime
+  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
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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
+email: joel.chippindale@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- 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
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- Mac OS X 10.5 or later
+- RubyCocoa
+rubyforge_project: 
+rubygems_version: 1.3.5
+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/spec_helper.rb