capybara-animate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0674a67083e92fe9c446bb1696c31f21fa0e9ed
+  data.tar.gz: 5b71c852f577c86c60eeaa3795943017bbb118aa
+SHA512:
+  metadata.gz: 7399daad2edf984af8e0ec624e9546304fa0571a03c6378df79be0137d7af0c7759c0edb69f8816c53337a98c951a8bdd323f52e6ebe087d7cb270c33595c40f
+  data.tar.gz: 85264de1b6dff17abd232399c221be519e93da31e48228ec193a7d8789cb504966601f767c6aaa0a5ad41d3f145758bc16d61f7cdcbc7d33aac79f32147d5553

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,2 @@
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capybara-animate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Caleb Buxton
+
+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,41 @@
+Capybara::Animate
+=
+
+Take a peak at your headless browser acceptance tests. Capybara::Animate captures screenshots after Capybara driven user actions in order to compose an animation of your scenario.
+
+## Installation
+
+Capybara::Animate depends on ImageMagick, on OS X installation is simple: ```brew install imagemagick```
+
+Add this line to your application's Gemfile:
+
+    gem 'capybara-animate', group: :test
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-animate
+
+## Usage
+
+Capybara::Animate automatically hooks in to Cucumber Scenarios tagged with ```@javascript```. It depends on a driver that implements ```#save_screenshot```
+
+## Credit
+
+This is entirely based off of the work of [Shimpei Makimoto's RubyConf 2013 Lightning Talk](https://github.com/makimoto/feature_spec_with_animation/). Simply: my contributions are to make it a gem that plugs into Cucumber scenarios automatically.
+
+## Contributing
+
+In development, Capybara::Animate depends on capybara-webkit. Capybara-webkit depends on the X window system and Qt, see [capybara-webkit's README for instructions on how to setup its dependencies](https://github.com/thoughtbot/capybara-webkit/)
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+  * Include test coverage.
+  * Do not break existing tests.
+  * Add documentation for new features.
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w{--format progress}
+end
+
+Cucumber::Rake::Task.new(:feat) do |t|
+  t.cucumber_opts = %w{--format progress}
+end
+
+task :default => [:spec,:feat]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/capybara-animate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-animate"
+  spec.version       = File.read("VERSION")
+  spec.authors       = ["Caleb Buxton"]
+  spec.email         = ["me@cpb.ca"]
+  spec.description   = %q{Composes Gif Animations from screenshots taken after capybara specified user actions.}
+  spec.summary       = %q{Gif Animations of your Headless Browser tests.}
+  spec.homepage      = "https://github.com/cpb/capybara-animate"
+  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", ">= 2.0.2", "< 2.2.0"
+  spec.add_dependency "gifanime", "~> 0.1"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta2"
+  spec.add_development_dependency "simplecov"
+end

data/features/README.md.feature

@@ -0,0 +1,59 @@
+@disable-bundler
+Feature: README.md statements of public interface
+  In order to see whats going on in headless browser interaction scenarios
+  As a developer
+  I expect scenarios tagged with @javascript or @record to be captured as gif animations
+
+  Background:
+    Given a file named "Gemfile" with:
+    """
+    gem "cucumber"
+    gem "capybara-webkit"
+    gem "rspec-expectations"
+    gem "capybara-animate", path: "../../"
+    """
+    And a file named "features/support/env.rb" with:
+    """
+    require 'capybara/cucumber'
+    require 'capybara/webkit'
+    require 'capybara/animate'
+    require 'rspec/expectations'
+    Capybara.javascript_driver = :webkit
+    """
+    And I run `bundle install`
+
+  Scenario: Running a scenario tagged with @javascript
+    Given a file named "features/capybara-webkit-javascript.feature" with:
+    """
+    Feature: Search for Ruby gems with !rubygems
+      As a Ruby developer
+      In order to quickly find fancy gems
+      The '!rubygems <gemname>` query should take me directly to fancy gems
+
+      @javascript
+      Scenario: Finding the Capybara gem
+        Given I am on the DDG homepage
+        When I search for "!rubygems capybara"
+        Then I should see an exact match on the Ruby Gems search page
+    """
+    And a file named "features/step_definitions/capybara-webkit-javascript_steps.rb" with:
+    """
+    Given /^I am on the DDG homepage$/ do
+      visit 'http://duckduckgo.com'
+    end
+
+    When /^I search for "([^"]*)"$/ do |query|
+      @query = query
+      fill_in 'q', :with => query
+      click_button "search_button_homepage"
+    end
+
+    Then /^I should see an exact match on the Ruby Gems search page$/ do
+      gem_name = @query.split(' ').last
+      page.should have_selector("a[href='/gems/#{gem_name}']")
+    end
+    """
+    When I successfully run `bundle exec cucumber` for up to 48 seconds
+    Then the output should contain "1 scenario (1 passed)"
+    And a file named "html-report/Finding the Capybara gem.gif" should exist
+    And the animated gif "html-report/Finding the Capybara gem.gif" should have 4 frames

data/features/step_definitions/README.md_steps.rb

@@ -0,0 +1,11 @@
+require 'rmagick'
+
+THE_ANIMATED_GIF = Transform(/the animated gif "(.*?)"/) do |filename|
+  in_current_dir do
+    Magick::ImageList.new(filename)
+  end
+end
+
+Then(/^(#{THE_ANIMATED_GIF}) should have (\d+) frames$/) do |animated_gif, expected_frames|
+  expect(animated_gif.length).to eql(expected_frames.to_i)
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'aruba/cucumber'

data/lib/capybara/animate.rb

@@ -0,0 +1,48 @@
+require 'capybara/animate/empty_recorder'
+
+module Capybara
+  module Animate
+    VERSION = File.read(File.join(File.dirname(__FILE__),"..","..","VERSION")).freeze
+
+    def self.included(base)
+      base.send(:prepend,UserActions)
+    end
+
+    def recorder
+      @recorder ||= EmptyRecorder.new
+    end
+
+    def recorder=(other)
+      @recorder = other
+    end
+
+    USER_ACTIONS = [
+      :attach_file,
+      :check,
+      :choose,
+      :click_button,
+      :click_link,
+      :click_link_or_button,
+      :click_on,
+      :evaluate_script,
+      :execute_script,
+      :fill_in,
+      :go_back,
+      :go_forward,
+      :unselect,
+      :visit,
+    ].freeze
+
+    module UserActions
+      USER_ACTIONS.each do |action_method|
+        define_method action_method do |*args, &block|
+          super(*args, &block)
+          self.recorder.add(self)
+        end
+      end
+    end
+  end
+end
+
+require 'capybara/animate/gif_recorder'
+require 'capybara/animate/hooks/cucumber' if defined?(Cucumber)

data/lib/capybara/animate/empty_recorder.rb

@@ -0,0 +1,14 @@
+module Capybara
+  module Animate
+    class EmptyRecorder
+
+      def add(page)
+
+      end
+
+      def generate!
+
+      end
+    end
+  end
+end

data/lib/capybara/animate/gif_recorder.rb

@@ -0,0 +1,37 @@
+require 'gifanime'
+
+module Capybara
+  module Animate
+    class GifRecorder
+      attr_reader :output_file
+
+      def initialize(output_name)
+        @output_file = "#{output_name}.gif"
+        make_path_unless_exists(output_file)
+        @gif_anime = Gifanime.new(output_file, delay: 40)
+        @tmpdir = Dir.mktmpdir
+      end
+
+      def add(page)
+        file = "#{tmpdir}/#{current_frame}.png"
+        page.save_screenshot(file, width: 320, height: 480)
+        gif_anime.add(file)
+      end
+
+      def generate!
+        gif_anime.generate!
+      end
+
+      private
+      attr_reader :tmpdir, :gif_anime
+
+      def current_frame
+        gif_anime.frames.length
+      end
+
+      def make_path_unless_exists(file)
+        FileUtils.mkdir_p(File.dirname(file)) unless File.exists?(File.dirname(file))
+      end
+    end
+  end
+end

data/lib/capybara/animate/hooks/cucumber.rb

@@ -0,0 +1,11 @@
+if defined?(Capybara::Session)
+  Capybara::Session.send(:include, Capybara::Animate)
+  Before("@javascript") do |scenario|
+    page.recorder = Capybara::Animate::GifRecorder.new("html-report/"+scenario.name)
+  end
+
+  After do |scenario|
+    page.recorder.add(page)
+    page.recorder.generate!
+  end
+end

data/spec/capybara/animate/empty_recorder_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+require 'capybara/animate/empty_recorder'
+
+describe Capybara::Animate::EmptyRecorder, type: :recorder do
+end

data/spec/capybara/animate/gif_recorder_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+require 'capybara/animate/gif_recorder'
+
+describe Capybara::Animate::GifRecorder, type: :recorder do
+  let(:gif_anime) { double(add: true, frames: [], generate!: true) }
+  before do
+    allow(Gifanime).to receive(:new).and_return(gif_anime)
+  end
+
+  let(:tmpdir) { FileUtils.mkdir_p(Dir.pwd+"/tmp").first }
+  before do
+    allow(Dir).to receive(:mktmpdir).and_return(tmpdir)
+  end
+
+  let(:output_name) { "the file name" }
+
+  let(:recorder) { described_class.new(output_name) }
+
+  subject { recorder }
+
+  it "should create the output path if it does not yet exist" do
+    unique_path = Dir.pwd+"/tmp/#{SecureRandom::uuid}/foobar"
+    expect do
+      described_class.new(unique_path)
+    end.to change { File.exists?(File.dirname(unique_path))}
+  end
+
+  it "sets the output_file based on initialization values" do
+    expect(subject.output_file).to eql("#{output_name}.gif")
+  end
+
+  describe "#add" do
+    let(:page) { double(save_screenshot: true) }
+
+    let(:adding) { proc { recorder.add(page) } }
+    subject { adding.call }
+
+    it "should save a screenshot from the page to a file in a temp directory" do
+      expect(page).to receive(:save_screenshot).with("#{tmpdir}/0.png", hash_including(:width, :height))
+      subject
+    end
+
+    it "should add the saved screenshot to the Gifanime" do
+      expect(gif_anime).to receive(:add).with("#{tmpdir}/0.png")
+      subject
+    end
+  end
+
+  describe "#generate!" do
+    let(:generating) { proc { recorder.generate! } }
+    subject { generating.call }
+
+    it "should generate with the Gifanime" do
+      expect(gif_anime).to receive(:generate!)
+      subject
+    end
+  end
+end

data/spec/capybara/animate_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Capybara::Animate do
+  ExpectedUserActions = [
+    :attach_file,
+    :check,
+    :choose,
+    :click_button,
+    :click_link,
+    :click_link_or_button,
+    :click_on,
+    :evaluate_script,
+    :execute_script,
+    :fill_in,
+    :go_back,
+    :go_forward,
+    :unselect,
+    :visit,
+  ]
+  class Dummy
+    ExpectedUserActions.each do |lazy|
+      define_method lazy do |*args, &block|
+        instance_variable_set("@#{lazy}", true)
+      end
+
+      define_method "#{lazy}?" do |*args, &block|
+        !!instance_variable_get("@#{lazy}")
+      end
+    end
+  end
+
+  it 'should have a version number' do
+    expect(Capybara::Animate::VERSION).to_not be_nil
+  end
+
+  context "included into a class" do
+    let(:described_class) { Dummy.send(:include, Capybara::Animate) }
+
+    context "the instance" do
+      subject { described_class.new }
+
+      it "should have an EmptyRecorder set to recorder" do
+        expect(subject.recorder).to be_a(Capybara::Animate::EmptyRecorder)
+      end
+
+      it "should be able to set a recorder" do
+        expect do
+          subject.recorder = :foo
+        end.to change { subject.recorder }
+      end
+
+      context "should add itself to the recorder" do
+        ExpectedUserActions.each do |attribute|
+          it "for #{attribute}" do
+            expect(subject.recorder).to receive(:add).with(subject)
+            subject.send(attribute)
+          end
+
+          it "and still call the original #{attribute}" do
+            expect do
+              subject.send(attribute)
+            end.to change { subject.send"#{attribute}?" }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+require 'simplecov'
+
+require 'capybara/animate'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| puts f; require f }

data/spec/support/shared_examples/a_recorder.rb

@@ -0,0 +1,13 @@
+shared_examples_for type: :recorder do
+  it { should respond_to(:add) }
+
+  it { should respond_to(:generate!) }
+
+  describe "#add" do
+    it "should accept an argument" do
+      expect do
+        subject.add(double(save_screenshot: true))
+      end.to_not raise_error
+    end
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: capybara-animate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Buxton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: gifanime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: 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: pry
+  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: 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: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Composes Gif Animations from screenshots taken after capybara specified
+  user actions.
+email:
+- me@cpb.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- capybara-animate.gemspec
+- features/README.md.feature
+- features/step_definitions/README.md_steps.rb
+- features/support/env.rb
+- lib/capybara/animate.rb
+- lib/capybara/animate/empty_recorder.rb
+- lib/capybara/animate/gif_recorder.rb
+- lib/capybara/animate/hooks/cucumber.rb
+- spec/capybara/animate/empty_recorder_spec.rb
+- spec/capybara/animate/gif_recorder_spec.rb
+- spec/capybara/animate_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/a_recorder.rb
+homepage: https://github.com/cpb/capybara-animate
+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: Gif Animations of your Headless Browser tests.
+test_files:
+- features/README.md.feature
+- features/step_definitions/README.md_steps.rb
+- features/support/env.rb
+- spec/capybara/animate/empty_recorder_spec.rb
+- spec/capybara/animate/gif_recorder_spec.rb
+- spec/capybara/animate_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/a_recorder.rb