cucumber-screenshot 0.3.0

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,78 @@
+= Cucumber Screenshot
+
+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.
+
+== Install
+
+To install the latest release as a gem
+
+  sudo gem install cucumber-screenshot
+
+== Use
+
+Create a cucumber_screenshot_env.rb file in the ./features/support/ directory
+in your Rails project and put the following in it.
+
+  begin
+    require 'cucumber_screenshot'
+    World(CucumberScreenshot::World)
+
+    After do |scenario|
+      if scenario.failed?
+        screenshot
+      end
+    end
+
+    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.
+
+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
+
+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
+
+  Then "screenshot" do
+    screenshot
+  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 generated.
+
+== TODO
+
+- 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
+
+Copyright (c) 2009 Joel Chippindale.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,94 @@
+begin
+  require 'spec'
+  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: gem install rspec'
+end
+
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+task :default => ['spec']
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+  # Change these as appropriate
+  s.name              = 'cucumber-screenshot'
+  s.version           = '0.3.0'
+  s.summary           = 'Extension for Cucumber to capture PNG screenshots of your app'
+
+  s.description       = 'Extension for Cucumber (http://cukes.info/) that makes it easy to use Webkit to capture PNG screenshots of your web application during tests'
+  s.author            = 'Joel Chippindale'
+  s.email             = 'joel.chippindale@gmail.com'
+  s.homepage          = 'http://github.com/mocoso/cucumber-screenshot'
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(cucumber-screenshot.gemspec cucumber-screenshot.tmproj MIT-LICENSE Rakefile README.rdoc) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  s.add_dependency('cucumber', '>= 0.6.2')
+  s.add_dependency('webrat', '>= 0.7.0')
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency('rspec')
+
+  s.post_install_message = 'To take actual screenshots rather than just snapshots of the HTML returned you will need Mac OS X 10.5 or later with RubyCocoa.
+
+You will also need to install the snapurl gem
+
+    gem install snapurl --version=0.3.0
+
+'
+
+  s.requirements = ['Mac OS X 10.5 or later', 'RubyCocoa']
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/cucumber-screenshot.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cucumber-screenshot}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joel Chippindale"]
+  s.date = %q{2010-04-01}
+  s.description = %q{Extension for Cucumber (http://cukes.info/) that makes it easy to use Webkit to capture PNG screenshots of your web application during tests}
+  s.email = %q{joel.chippindale@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["cucumber-screenshot.gemspec", "cucumber-screenshot.tmproj", "MIT-LICENSE", "Rakefile", "README.rdoc", "spec", "lib/cucumber_screenshot", "lib/cucumber_screenshot/world.rb", "lib/cucumber_screenshot.rb"]
+  s.homepage = %q{http://github.com/mocoso/cucumber-screenshot}
+  s.post_install_message = %q{To take actual screenshots rather than just snapshots of the HTML returned you will need Mac OS X 10.5 or later with RubyCocoa.
+
+You will also need to install the snapurl gem
+
+    gem install snapurl --version=0.3.0
+
+}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.requirements = ["Mac OS X 10.5 or later", "RubyCocoa"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Extension for Cucumber to capture PNG screenshots of your app}
+
+  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.2"])
+      s.add_runtime_dependency(%q<webrat>, [">= 0.7.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0.6.2"])
+      s.add_dependency(%q<webrat>, [">= 0.7.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0.6.2"])
+    s.add_dependency(%q<webrat>, [">= 0.7.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/cucumber-screenshot.tmproj

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>cucumber-screenshot</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>334</integer>
+	<key>metaData</key>
+	<dict/>
+	<key>showFileHierarchyDrawer</key>
+	<false/>
+	<key>windowFrame</key>
+	<string>{{294, 105}, {1519, 1028}}</string>
+</dict>
+</plist>

data/lib/cucumber_screenshot.rb

@@ -0,0 +1,20 @@
+require 'cucumber'
+require 'cucumber/formatter/html'
+require 'webrat'
+
+require 'cucumber_screenshot/world'
+
+module CucumberScreenshot
+  VERSION = '0.3.0'
+
+  begin
+    require 'snapurl'
+    SNAPURL_PRESENT = true
+  rescue LoadError
+    SNAPURL_PRESENT = false
+  end
+
+  def self.snap_url_present?
+    SNAPURL_PRESENT
+  end
+end

data/lib/cucumber_screenshot/world.rb

@@ -0,0 +1,63 @@
+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}")
+      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
+
+        if CucumberScreenshot.snap_url_present?
+          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
+    end
+
+    def screenshot_due?
+      current_response_body && current_response_body != response_body_for_last_screenshot && !webrat_session.redirect?
+    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:
+        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}
+
+"
+      end
+
+      def doc_root
+        File.expand_path(File.join(RAILS_ROOT, 'public'))
+      end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: cucumber-screenshot
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Joel Chippindale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 2
+        version: 0.6.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- cucumber-screenshot.gemspec
+- cucumber-screenshot.tmproj
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- lib/cucumber_screenshot/world.rb
+- lib/cucumber_screenshot.rb
+has_rdoc: true
+homepage: http://github.com/mocoso/cucumber-screenshot
+licenses: []
+
+post_install_message: |+
+  To take actual screenshots rather than just snapshots of the HTML returned you will need Mac OS X 10.5 or later with RubyCocoa.
+  
+  You will also need to install the snapurl gem
+  
+      gem install snapurl --version=0.3.0
+  
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- Mac OS X 10.5 or later
+- RubyCocoa
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Extension for Cucumber to capture PNG screenshots of your app
+test_files: []
+