screenpress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60b8533d92e4bd76d766d8edf7c19c1d632daade
+  data.tar.gz: 9714f31a961652e8721eaad4db9a7fb94de3f66c
+SHA512:
+  metadata.gz: 0bde0c099aae02852676f5e45c342b4f74323cc20635e5bbadc3a9c7c97c08a251566d0a3c5908f1d44680499ba2a849f2632cda383306e4b6405d2f81b0286c
+  data.tar.gz: cae85ae2c530f8be666521424907c6e5bb8baaed8a6d1b5300ca6815a15f608960395f3bbdbd7ebe17e7dbae68aef80c31d5ab0dce02c09b681a762bfbeb826a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order rand

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in screenpress.gemspec
+gemspec
+
+gem "capybara", "2.2.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,76 @@
+# Screenpress
+
+It happens. Your button is there but it's white on white on white and no one can see it. Especially your rspec tests.
+
+Screenpress integrates with your Capybara tests to implement a visual regression prevention workflow.
+
+## Setup
+
+```ruby
+
+# acceptance_helper.rb
+
+require 'screenpress'
+
+RSpec.configure do |config|
+  config.include ::Screenpress::DSL
+end
+
+```
+
+```ruby
+
+# your_spec.rb
+
+visit '/tasks/new'
+
+screenpress('tasks/form')
+
+```
+
+This will take a picture of the page and put it at `/screenpress/tasks/form.png` to review.
+
+## Workflow
+
+So it just takes a screenshot and puts in in a folder. So what?
+
+The thing is that it's now in git. If it's different, it's now on your diff and everyone can see what has changed.
+
+You've just added a visual design review to your development process and that's cool. Now we can go back in time and see when that header changed or not accept the pull request in the first place if the button is missing.
+
+### Options
+
+There are a few config options...
+
+```ruby
+# acceptance_helper.rb
+
+require 'screenpress'
+
+# Maybe you want to turn it off in some cases (like on your continuous integration server)
+Screenpress.config.enabled = false if ENV['JENKINS']
+
+# You can change where files are saved relative to project root (default if /screenpress)
+Screenpress.config.path = "/spec/screenpress"
+
+# Or provide the full path
+Screenpress.config.full_path = Rails.root.join("spec", "pictures")
+
+RSpec.configure do |config|
+  config.include ::Screenpress::DSL 
+end
+```
+
+### TODO
+
+* Allow a proc to be set for enablement
+* Maybe be more deliberate like Huxley and set modes (ENV variables?) for recording
+* Enable mode that fails test if image changes
+* Enable tools to easily compare without Github (locally)
+
+
+### Inspiration
+
+* [Huxley](https://github.com/facebook/huxley)
+* [Wraith](https://github.com/BBC-News/wraith)
+* [Capybara Screenshot](https://github.com/mattheworiordan/capybara-screenshot)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/screenpress/config.rb

@@ -0,0 +1,47 @@
+module Screenpress
+  class Config
+    def path=val
+      self.full_path = root.join(val)
+    end
+
+    def full_path=val
+      @full_path = Pathname.new(val).expand_path
+    end
+
+    def full_path
+      self.path = "screenpress" unless @full_path
+      @full_path
+    end
+
+    def enabled=val
+      @enabled = val
+    end
+
+    def enabled?
+      return !!@enabled if defined?(@enabled)
+      @enabled = calc_enabled
+    end
+
+    protected
+
+    def root
+      @root ||= Pathname.new(calc_root_string).expand_path
+    end
+
+    def calc_enabled
+      # TODO env variables or something?
+      true
+    end
+
+    def calc_root_string
+      return Rails.root.to_s                if defined?(Rails)
+      return Padrino.root.to_s              if defined?(Padrino)
+      return Sinatra::Application.root.to_s if defined?(Sinatra)
+      return RAILS_ROOT                     if defined?(RAILS_ROOT)
+      return RACK_ROOT                      if defined?(RACK_ROOT)
+      return ENV['RAILS_ROOT']              if ENV['RAILS_ROOT']
+      return ENV['RACK_ROOT']               if ENV['RACK_ROOT']
+      return Dir.pwd
+    end
+  end
+end

data/lib/screenpress/dsl.rb

@@ -0,0 +1,15 @@
+module Screenpress
+  module DSL
+    def screenpress(relative_filename)
+      return true unless Screenpress.config.enabled?
+      
+      filename = Screenpress.config.full_path.join(relative_filename)
+
+      # TODO: see if have extension
+      filename << ".png"
+      
+      saver = Screenpress::Saver.new(filename.to_s, Capybara, Capybara.page)
+      saver.save
+    end
+  end
+end

data/lib/screenpress/saver.rb

@@ -0,0 +1,112 @@
+require 'fileutils'
+
+module Screenpress
+  class Saver
+    attr_reader :capybara, :page, :filename
+
+    def initialize(filename, capybara = nil, page = nil)
+      @capybara = capybara || Capybara
+      @page     = page || @capybara.page
+      @filename = filename
+    end
+
+    def save
+      # if current_path empty then nothing to screen shot as browser has not loaded any URL
+      return false if capybara.current_path.to_s.empty?
+      save_screenshot
+    end
+
+    def save_screenshot
+      # settings to nil because of issues in some version of capybara
+      old_path = Capybara.save_and_open_page_path
+      Capybara.save_and_open_page_path = nil
+
+      ensure_directory
+
+      Screenpress::Saver::Proxy.save!(capybara.current_driver, page.driver, filename)
+    end
+
+    def ensure_directory
+      folder = File.dirname(filename)
+      return if File.directory?(folder)
+      FileUtils.mkdir_p(folder)
+    end
+
+    class Proxy
+      class << self
+        def save!(name, driver, filename)
+          return send(name, driver, filename) if self.respond_to?(name)
+          
+          klass = driver.class.name
+          if klass =~ /Selenium/
+            return send(:selenium, driver, filename)
+          elsif klass =~ /Mechanize/
+            return send(:mechanize, driver, filename)
+          elsif klass =~ /RackTest/
+            return send(:rack_test, driver, filename)
+          elsif klass =~ /Poltergeist/
+            return send(:poltergeist, driver, filename)
+          elsif klass =~ /Webkit/
+            return send(:webkit, driver, filename)
+          else
+            warn "Screenpress could not detect a screenshot driver for '#{name}'. Saving with default with unknown results."
+            return send(:default, driver, filename)
+          end
+        end
+
+        def default(driver, path)
+          if driver.respond_to?(:save_screenshot)
+            driver.save_screenshot(path)
+          else
+            driver.render(path)
+          end
+          true
+        end
+
+        def rack_test(driver, path)
+          warn "Rack::Test capybara driver has no ability to output screen shots. Skipping."
+          false
+        end
+
+        def mechanize(driver, path)
+          warn "Mechanize capybara driver has no ability to output screen shots. Skipping."
+          false
+        end
+
+        def selenium(driver, path)
+          driver.browser.save_screenshot(path)
+          true
+        end
+
+        def poltergeist(driver, path)
+          driver.render(path, :full => true)
+          true
+        end
+
+        def webkit(driver, path)
+          if driver.respond_to?(:save_screenshot)
+            driver.save_screenshot(path)
+          else
+            driver.render(path)
+          end
+          true
+        end
+
+        def webkit_debug(driver, path)
+          driver.render(path)
+          true
+        end
+
+        def terminus(driver, path)
+          if driver.respond_to?(:save_screenshot)
+            driver.save_screenshot(path)
+            true
+          else
+            warn "Terminus capybara driver has no ability to output screen shots. Skipping."
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/screenpress/version.rb

@@ -0,0 +1,3 @@
+module Screenpress
+  VERSION = "0.1.0"
+end

data/lib/screenpress.rb

@@ -0,0 +1,21 @@
+require "screenpress/version"
+require "capybara"
+
+module Screenpress
+  autoload :Config,    'screenpress/config'
+  autoload :DSL,       'screenpress/dsl'
+  autoload :Saver,     'screenpress/saver'
+
+  class << self
+    def config
+      @config ||= Screenpress::Config.new
+    end
+
+    protected
+
+    def reset
+      # mostly for tests, resets eveything
+      @config = nil
+    end
+  end
+end

data/screenpress.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'screenpress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "screenpress"
+  spec.version       = Screenpress::VERSION
+  spec.authors       = ["Brian Leonard"]
+  spec.email         = ["brian@bleonard.com"]
+  spec.description   = %q{Workflow and Capybara extension that takes screenshots of your tests to prevent visual regressions}
+  spec.summary       = %q{Prevent visual regressions}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capybara"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("debugger")
+end

data/spec/config_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Screenpress::Config do
+  it "should be returned from the module" do
+    Screenpress.config.class.name.should == "Screenpress::Config"
+  end
+
+  describe ".path" do
+    it "should default to /screenpress" do
+      Screenpress.config.full_path.to_s.should == "#{Dir.pwd}/screenpress"
+    end
+
+    it "should use the rails root if it was there" do
+      rails = Object.new
+      rails.should_receive(:root).and_return("/my/rails/")
+      stub_const("Rails", rails)
+      Screenpress.config.full_path.to_s.should == "/my/rails/screenpress"
+    end
+  end
+
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class MyDslTest
+  include Screenpress::DSL
+end
+
+describe "Screenpress::DSL" do 
+  it "should provide screenpress method" do
+    obj = MyDslTest.new
+    obj.should respond_to(:screenpress)
+  end
+
+  it "should be in rspec because it's included in my spec helper" do
+    Screenpress::Config.any_instance.stub(:enabled?).and_return(false)
+    lambda {
+      screenpress("here")
+    }.should_not raise_error
+  end
+
+end

data/spec/saver_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe Screenpress::Saver do
+  before do
+    Screenpress.config.path = image_dir
+  end
+
+  let(:image_dir) { '/tmp' }
+  let(:file_basename) { "my_screenshot" }
+  let(:screenshot_path) { "#{Dir.pwd}#{image_dir}/#{file_basename}.png" }
+
+  let(:driver_mock) { double('Capybara driver') }
+  let(:page_mock) { double('Capybara session page', :body => 'body', :driver => driver_mock) }
+  let(:capybara_mock) {
+    double(Capybara).as_null_object.tap do |m|
+      m.stub(:current_driver).and_return(:default)
+      m.stub(:current_path).and_return('/')
+    end
+  }
+
+  let(:saver) { Screenpress::Saver.new(screenshot_path, capybara_mock, page_mock) }
+
+  context "default" do
+    it 'should be in capybara root output' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+      saver.save
+    end
+
+
+    it 'should save if current_path is empty' do
+      capybara_mock.stub(:current_path).and_return(nil)
+      capybara_mock.should_not_receive(:save_page)
+      driver_mock.should_not_receive(:render)
+
+      saver.save
+    end
+  end
+
+  context "selenium" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:selenium)
+    end
+    it 'should save via browser' do
+      browser_mock = double('browser')
+      driver_mock.should_receive(:browser).and_return(browser_mock)
+      browser_mock.should_receive(:save_screenshot).with(screenshot_path)
+
+      saver.save
+    end
+  end
+
+  context "poltergeist" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:poltergeist)
+    end
+    it 'should save driver render with :full => true' do
+      driver_mock.should_receive(:render).with(screenshot_path, {:full => true})
+
+      saver.save
+    end
+  end
+
+  describe "webkit" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:webkit)
+    end
+
+    context 'has render method' do
+      before do
+        driver_mock.stub(:respond_to?).with(:'save_screenshot').and_return(false)
+      end
+
+      it 'should save driver render' do
+        driver_mock.should_receive(:render).with(screenshot_path)
+
+        saver.save
+      end
+    end
+
+    context 'has save_screenshot method' do
+      before do
+        driver_mock.stub(:respond_to?).with(:'save_screenshot').and_return(true)
+      end
+
+      it 'should save driver render' do
+        driver_mock.should_receive(:save_screenshot).with(screenshot_path)
+
+        saver.save
+      end
+    end
+  end
+
+  describe "webkit debug" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:webkit_debug)
+    end
+
+    it 'should save driver render' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+
+      saver.save
+    end
+  end
+
+  describe "with unknown driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:unknown)
+      Screenpress::Saver::Proxy.stub(:warn).and_return(nil)
+    end
+
+    it 'should save driver render' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+
+      saver.save
+    end
+
+    it 'should output warning about unknown results' do
+      # Not pure mock testing 
+      Screenpress::Saver::Proxy.should_receive(:warn).with(/screenshot driver for 'unknown'.*unknown results/).and_return(nil)
+      driver_mock.should_receive(:render)
+      saver.save
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'screenpress'
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+  
+  config.include Screenpress::DSL
+
+  config.after(:each) do
+    Screenpress.send(:reset)
+  end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: screenpress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Leonard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Workflow and Capybara extension that takes screenshots of your tests
+  to prevent visual regressions
+email:
+- brian@bleonard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/screenpress.rb
+- lib/screenpress/config.rb
+- lib/screenpress/dsl.rb
+- lib/screenpress/saver.rb
+- lib/screenpress/version.rb
+- screenpress.gemspec
+- spec/config_spec.rb
+- spec/dsl_spec.rb
+- spec/saver_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Prevent visual regressions
+test_files:
+- spec/config_spec.rb
+- spec/dsl_spec.rb
+- spec/saver_spec.rb
+- spec/spec_helper.rb