capybara-flow 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2d4089bc504959b5d01fee1607480e0fa4e1977667b29381abba52516885589
+  data.tar.gz: e889449c864412652e57836cc8355e80e01700713949d4043661bc3d29af037a
+SHA512:
+  metadata.gz: 3db3c1d8c1cc46b6edf34f1090a335a4b8e0c27e84e93ae1454a36c01f492dcd978cf3888b0a6d3e7f704749f28c460cfc7d1db67a744d8d22838ece194dd6a2
+  data.tar.gz: 962e010b739781f9a0f1e1c2dba4d8e462e53a963b138e72309476501a8ba2ea64f6844faf8ff3ece4bc49595b38a5cb8b2312ff878dae938668291ff678f99e

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/.ruby-gemset

@@ -0,0 +1 @@
+capybara-flow

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

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-flow.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,49 @@
+Capybara::Flow
+=
+
+Take a peak at your headless browser acceptance tests. Capybara::Flow captures screenshots after Capybara driven user actions in order to compose an animation of your scenario.
+
+## Installation
+
+Capybara::Flow depends on ImageMagick. On newer versions of OS X installation is simple: 
+```
+brew unlink imagemagick #if you already have imagemagick installed
+brew install imagemagick@6 && brew link imagemagick@6 --force
+```
+
+Add this line to your application's Gemfile:
+
+    gem 'capybara-flow', group: :test
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-flow
+
+## Usage
+
+`Capybara::Flow` automatically hooks in to RSpec system tests with the tag `:js`. 
+It depends on a driver that implements ```#save_screenshot```
+
+## Configuration
+
+Add the following to `spec/support/capybara_flow.rb`
+
+```ruby
+require 'capybara/flow/hooks/rspec'
+
+Capybara::Flow.configure do |config|
+  config.save_path = Rails.root.join("tmp/flow")
+  config.iterations = 1
+  config.delay_in_ms = 700
+end
+
+```
+
+## Credit
+
+This is forked from https://github.com/surzycki/capybara-animate 
+

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/capybara-flow.gemspec

@@ -0,0 +1,27 @@
+# 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-flow"
+  spec.version       = File.read("VERSION")
+  spec.authors       = ["Will Read"]
+  spec.email         = ["will.read@gmail.com"]
+  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/TildeWill/capybara-flow"
+  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{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capybara"
+  spec.add_dependency "rmagick"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/lib/capybara/flow.rb

@@ -0,0 +1,74 @@
+require 'capybara/flow/empty_recorder'
+
+module Capybara
+  module Flow
+    VERSION = File.read(File.join(File.dirname(__FILE__), "..", "..", "VERSION")).freeze
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.included(base)
+      base.send(:prepend, UserActions)
+    end
+
+    def recorder
+      @recorder ||= EmptyRecorder.new
+    end
+
+    def recorder=(other)
+      @recorder = other
+    end
+
+    MATCHERS = [
+      :have_content
+    ]
+
+    USER_ACTIONS = [
+      :attach_file,
+      :check,
+      :uncheck,
+      :choose,
+      :click_button,
+      :click_link,
+      :click_link_or_button,
+      :click_on,
+      :evaluate_script,
+      :execute_script,
+      :fill_in,
+      :go_back,
+      :go_forward,
+      :select,
+      :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
+
+      MATCHERS.each do |matcher_method|
+        define_method matcher_method do |arg|
+          self.recorder.add(self)
+          super(arg)
+        end
+      end
+    end
+  end
+end
+
+require 'capybara/flow/gif_animator'
+require 'capybara/flow/gif_recorder'
+require 'capybara/flow/configuration'

data/lib/capybara/flow/configuration.rb

@@ -0,0 +1,15 @@
+module Capybara
+  module Flow
+    class Configuration
+      attr_accessor :delay_in_ms
+      attr_accessor :iterations
+      attr_accessor :save_path
+
+      def initialize
+        @delay_in_ms = 70
+        @iterations = nil
+        @save_path = "html-report/"
+      end
+    end
+  end
+end

data/lib/capybara/flow/empty_recorder.rb

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

data/lib/capybara/flow/gif_animator.rb

@@ -0,0 +1,28 @@
+require "RMagick"
+
+module Capybara
+  module Flow
+    class GifAnimator
+      attr_reader :frames, :delay, :iterations, :output_file
+
+      def initialize(output_file, options = {})
+        @delay = options[:delay_in_ms]
+        @iterations = options[:iterations]
+        @output_file = output_file
+        @frames = []
+      end
+
+      def add(frame)
+        frames << frame
+      end
+
+      def generate!
+        gif = ::Magick::ImageList.new(*frames)
+        gif.delay = delay if delay
+        gif.iterations = iterations if iterations
+        gif.ticks_per_second = 1000
+        gif.write(output_file)
+      end
+    end
+  end
+end

data/lib/capybara/flow/gif_recorder.rb

@@ -0,0 +1,37 @@
+module Capybara
+  module Flow
+    class GifRecorder
+      attr_reader :output_file
+
+      def initialize(output_name)
+        @frame_dir = output_name
+        @output_file = "#{output_name}.gif"
+        make_path_unless_exists(output_file)
+        make_path_unless_exists(@frame_dir)
+        @gif_animator = GifAnimator.new(output_file, delay_in_ms: Capybara::Flow.configuration.delay_in_ms, iterations: Capybara::Flow.configuration.iterations)
+        @tmpdir = Dir.mktmpdir
+      end
+
+      def add(page)
+        file = File.join(@frame_dir, "#{current_frame}.png")
+        page.save_screenshot(file, width: 320, height: 480)
+        gif_animator.add(file)
+      end
+
+      def generate!
+        gif_animator.generate!
+      end
+
+      private
+      attr_reader :tmpdir, :gif_animator
+
+      def current_frame
+        gif_animator.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/flow/hooks/rspec.rb

@@ -0,0 +1,14 @@
+if defined?(Capybara::Session)
+  Capybara::Session.send(:include, Capybara::Flow)
+  RSpec.configure do |config|
+    config.before(:each, :js) do |example|
+      output_path = File.join(Capybara::Flow.configuration.save_path, example.full_description.parameterize)
+      page.recorder = Capybara::Flow::GifRecorder.new(output_path)
+    end
+
+    config.after(:each, :js) do
+      page.recorder.add(page)
+      page.recorder.generate!
+    end
+  end
+end

data/spec/capybara/flow/empty_recorder_spec.rb

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

data/spec/capybara/flow/gif_recorder_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'securerandom'
+
+require 'capybara/flow/gif_recorder'
+
+describe Capybara::Flow::GifRecorder, type: :recorder do
+  let(:gif_animator) { instance_double(Capybara::Flow::GifAnimator, add: true, frames: [], generate!: true) }
+  let(:tmpdir) { FileUtils.mkdir_p(Dir.pwd+"/tmp").first }
+  let(:output_name) { "the file name" }
+  let(:recorder) { described_class.new(output_name) }
+
+  before do
+    allow(Capybara::Flow::GifAnimator).to receive(:new).and_return(gif_animator)
+    allow(Dir).to receive(:mktmpdir).and_return(tmpdir)
+  end
+
+  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 the output directory so you can go frame by frame" do
+      expect(page).to receive(:save_screenshot).with("the file name/0.png", hash_including(:width, :height))
+      subject
+    end
+
+    it "should add the saved frame to the animation" do
+      expect(gif_animator).to receive(:add).with("the file name/0.png")
+      subject
+    end
+  end
+
+  describe "#generate!" do
+    let(:generating) { proc { recorder.generate! } }
+    subject { generating.call }
+
+    it "should generate the animation" do
+      expect(gif_animator).to receive(:generate!)
+      subject
+    end
+  end
+end

data/spec/capybara/flow_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Capybara::Flow 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::Flow::VERSION).to_not be_nil
+  end
+
+  context "included into a class" do
+    let(:described_class) { Dummy.send(:include, Capybara::Flow) }
+
+    context "the instance" do
+      subject { described_class.new }
+
+      it "should have an EmptyRecorder set to recorder" do
+        expect(subject.recorder).to be_a(Capybara::Flow::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/flow'
+
+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,170 @@
+--- !ruby/object:Gem::Specification
+name: capybara-flow
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Will Read
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-28 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: rmagick
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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:
+- will.read@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- capybara-flow.gemspec
+- lib/capybara/flow.rb
+- lib/capybara/flow/configuration.rb
+- lib/capybara/flow/empty_recorder.rb
+- lib/capybara/flow/gif_animator.rb
+- lib/capybara/flow/gif_recorder.rb
+- lib/capybara/flow/hooks/rspec.rb
+- spec/capybara/flow/empty_recorder_spec.rb
+- spec/capybara/flow/gif_recorder_spec.rb
+- spec/capybara/flow_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/a_recorder.rb
+homepage: https://github.com/TildeWill/capybara-flow
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Gif animations of your headless browser tests.
+test_files:
+- spec/capybara/flow/empty_recorder_spec.rb
+- spec/capybara/flow/gif_recorder_spec.rb
+- spec/capybara/flow_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/a_recorder.rb