capybara-screenshot-diff 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c517212dfc9af8af735a354862dcaba9adc96a
-  data.tar.gz: 7828ae0bfa1c9aea2e8814288989288c43c8f64e
+  metadata.gz: 18cb8f36eeb03d05da4cd3300a91e7f871724a77
+  data.tar.gz: 2bbdc4d01d53b5bad98f43b16cec3557a167811b
 SHA512:
-  metadata.gz: 27179f167cc8d6b77850033dd0e5291ae89e7dd4182586e22269a66619fca6e02d891e257c6c7041e51adb13a4b7097e8017e7c6e543ef7f11a6cf02fefef2e9
-  data.tar.gz: be58b147f1948e3136975f1320caa8cbfeeca7d5e5f27651bd8736fe31da35384d950165e8b560c0fdc4b2fe1975e382511ac565cc9f8314a2145982c11d3de0
+  metadata.gz: b46673760287a2ff760f261e089ef75ed469cc83c05148a7dc4ca2791d8d5967f862bbffb45bf670c0e5bde9b50cb2cd42598679814b9cac88920a3bf333b7d5
+  data.tar.gz: 4048618b8364260ba070a1a320d44adf494f1af02344ae26a9d2a21d9a38f90ae3c9d4800c878234e20b494ac0c2af9e8bfaff1ad9689d35cf6a173bed2bdaf0

data/.rubocop.yml

@@ -13,6 +13,9 @@ Metrics/ClassLength:
 Metrics/LineLength:
   Max: 110
 
+Style/Documentation:
+  Enabled: false
+
 Style/MultilineMethodCallIndentation:
   EnforcedStyle: indented
   IndentationWidth: 4

data/.rubocop_todo.yml

@@ -1,31 +1,23 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-04-22 14:35:36 +0200 using RuboCop version 0.39.0.
+# on 2016-12-23 14:12:31 +0100 using RuboCop version 0.46.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-Style/TrivialAccessors:
-  Enabled: false
-
-# Offense count: 2
-Lint/AmbiguousRegexpLiteral:
-  Exclude:
-    - 'lib/capybara/screenshot/diff/capybara_setup.rb'
-
 # Offense count: 3
 Metrics/AbcSize:
-  Max: 55
+  Max: 45
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 12
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 42
+  Max: 36
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.
@@ -34,22 +26,7 @@ Metrics/ParameterLists:
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 17
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/capybara/screenshot/diff/capybara_setup.rb'
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/capybara/screenshot/diff.rb'
-    - 'lib/capybara/screenshot/diff/image_compare.rb'
+  Max: 14
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -57,23 +34,3 @@ Style/Documentation:
 Style/FormatString:
   Exclude:
     - 'lib/capybara/screenshot/diff/capybara_setup.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'capybara-screenshot-diff.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
-# SupportedStyles: aligned, indented
-Style/MultilineMethodCallIndentation:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
-# SupportedStyles: aligned, indented
-Style/MultilineOperationIndentation:
-  Enabled: false

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 rvm:
+  - jruby-9.1.6.0
+  - 2.3.3
+  - 2.2.6
+  - 2.1.9
   - jruby-head
-  - jruby-9.1.2.0
-  - jruby-9.1.5.0
-  - 2.3.1
-  - 2.2.5
-  - 2.1.8
   - ruby-head
 before_install: gem query -i -n ^bundler$ >/dev/null || gem install bundler
 

data/README.md

@@ -251,7 +251,7 @@ To release a new version, update the version number in `lib/capybara/screenshot/
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capybara-screenshot-diff. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/donv/capybara-screenshot-diff. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -1,8 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rubocop/rake_task'
 
-task default: [:test, :rubocop]
+task default: :test
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -10,6 +9,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+require 'rubocop/rake_task'
 RuboCop::RakeTask.new
-
 Rake::Task[:test].enhance [:'rubocop:auto_correct']

data/capybara-screenshot-diff.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'actionpack', '~> 4.1'
+  spec.add_runtime_dependency 'actionpack', '>= 4.1', '<5.1'
   spec.add_runtime_dependency 'capybara', '~> 2.0'
   spec.add_runtime_dependency 'chunky_png', '~> 1.3'
 

data/lib/capybara/screenshot/diff/capybara_setup.rb

@@ -7,132 +7,139 @@ require 'action_dispatch'
 #            and use Module#prepend/include to insert.
 # Add the `screenshot` method to ActionDispatch::IntegrationTest
 # rubocop:disable Metrics/ClassLength
-class ActionDispatch::IntegrationTest
-  ON_WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-  SILENCE_ERRORS = ON_WINDOWS ? '2>nul' : '2>/dev/null'
-
-  def self.os_name
-    case RbConfig::CONFIG['host_os']
-    when /darwin/
-      'macos'
-    when /mswin|mingw|cygwin/
-      'windows'
-    when /linux/
-      'linux'
-    else
-      'unknown'
+module ActionDispatch
+  class IntegrationTest
+    ON_WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+    SILENCE_ERRORS = ON_WINDOWS ? '2>nul' : '2>/dev/null'
+
+    def self.os_name
+      case RbConfig::CONFIG['host_os']
+      when /darwin/
+        'macos'
+      when /mswin|mingw|cygwin/
+        'windows'
+      when /linux/
+        'linux'
+      else
+        'unknown'
+      end
     end
-  end
 
-  def self.screenshot_root
-    Capybara::Screenshot.screenshot_root ||
+    def self.screenshot_root
+      Capybara::Screenshot.screenshot_root ||
         (defined?(Rails.root) && Rails.root) || File.expand_path('.')
-  end
+    end
 
-  def self.screenshot_area
-    parts = ['doc/screenshots']
-    parts << Capybara.default_driver.to_s if Capybara::Screenshot.add_driver_path
-    parts << os_name if Capybara::Screenshot.add_os_path
-    File.join parts
-  end
+    def self.screenshot_area
+      parts = ['doc/screenshots']
+      parts << Capybara.default_driver.to_s if Capybara::Screenshot.add_driver_path
+      parts << os_name if Capybara::Screenshot.add_os_path
+      File.join parts
+    end
 
-  def self.screenshot_area_abs
-    "#{screenshot_root}/#{screenshot_area}".freeze
-  end
+    def self.screenshot_area_abs
+      "#{screenshot_root}/#{screenshot_area}".freeze
+    end
 
-  def initialize(*)
-    super
-    @screenshot_counter = nil
-    @screenshot_group = nil
-    @screenshot_section = nil
-    @test_screenshot_errors = nil
-    @test_screenshots = nil
-  end
+    def initialize(*)
+      super
+      @screenshot_counter = nil
+      @screenshot_group = nil
+      @screenshot_section = nil
+      @test_screenshot_errors = nil
+      @test_screenshots = nil
+    end
 
-  def group_parts
-    parts = []
-    parts << @screenshot_section if @screenshot_section.present?
-    parts << @screenshot_group if @screenshot_group.present?
-    parts
-  end
+    def group_parts
+      parts = []
+      parts << @screenshot_section if @screenshot_section.present?
+      parts << @screenshot_group if @screenshot_group.present?
+      parts
+    end
 
-  def full_name(name)
-    File.join group_parts.<<(name).map(&:to_s)
-  end
+    def full_name(name)
+      File.join group_parts.<<(name).map(&:to_s)
+    end
 
-  def screenshot_dir
-    File.join [self.class.screenshot_area] + group_parts
-  end
+    def screenshot_dir
+      File.join [self.class.screenshot_area] + group_parts
+    end
+
+    setup do
+      if Capybara::Screenshot.window_size
+        if Capybara.default_driver == :selenium
+          page.driver.browser.manage.window.resize_to(*Capybara::Screenshot.window_size)
+        elsif Capybara.default_driver == :poltergeist
+          page.driver.resize(*Capybara::Screenshot.window_size)
+        end
+      end
+    end
 
-  setup do
-    if Capybara::Screenshot.window_size
-      if Capybara.default_driver == :selenium
-        page.driver.browser.manage.window.resize_to(*Capybara::Screenshot.window_size)
-      elsif Capybara.default_driver == :poltergeist
-        page.driver.resize(*Capybara::Screenshot.window_size)
+    teardown do
+      if Capybara::Screenshot::Diff.enabled && @test_screenshots
+        @test_screenshots.each { |args| assert_image_not_changed(*args) }
       end
+      fail(@test_screenshot_errors.join("\n\n")) if @test_screenshot_errors
     end
-  end
 
-  teardown do
-    if Capybara::Screenshot::Diff.enabled && @test_screenshots
-      @test_screenshots.each { |args| assert_image_not_changed(*args) }
+    def screenshot_section(name)
+      @screenshot_section = name.to_s
     end
-    fail(@test_screenshot_errors.join("\n\n")) if @test_screenshot_errors
-  end
 
-  def screenshot_section(name)
-    @screenshot_section = name.to_s
-  end
+    def screenshot_group(name)
+      @screenshot_group = name.to_s
+      @screenshot_counter = 0
+      return unless Capybara::Screenshot.active? && name.present?
+      FileUtils.rm_rf screenshot_dir
+    end
 
-  def screenshot_group(name)
-    @screenshot_group = name.to_s
-    @screenshot_counter = 0
-    return unless Capybara::Screenshot.active? && name.present?
-    FileUtils.rm_rf screenshot_dir
-  end
+    def screenshot(name)
+      return unless Capybara::Screenshot.active?
+      if Capybara.default_driver == :selenium && Capybara::Screenshot.window_size
+        return unless page.driver.browser.manage.window
+              .size == Selenium::WebDriver::Dimension.new(*Capybara::Screenshot.window_size)
+      end
+      if @screenshot_counter
+        name = "#{'%02i' % @screenshot_counter}_#{name}"
+        @screenshot_counter += 1
+      end
+      name = full_name(name)
+      file_name = "#{self.class.screenshot_area_abs}/#{name}.png"
+      org_name = "#{self.class.screenshot_area_abs}/#{name}_0.png~"
+      new_name = "#{self.class.screenshot_area_abs}/#{name}_1.png~"
+
+      FileUtils.mkdir_p File.dirname(file_name)
+      committed_file_name = check_vcs(name, file_name, org_name)
+      take_stable_screenshot(file_name)
+      return unless committed_file_name && File.exist?(committed_file_name)
+      (@test_screenshots ||= []) << [caller[0], name, file_name, committed_file_name, new_name, org_name]
+    end
 
-  def screenshot(name)
-    return unless Capybara::Screenshot.active?
-    if Capybara.default_driver == :selenium && Capybara::Screenshot.window_size
-      return unless page.driver.browser.manage.window
-          .size == Selenium::WebDriver::Dimension.new(*Capybara::Screenshot.window_size)
-    end
-    if @screenshot_counter
-      name = "#{'%02i' % @screenshot_counter}_#{name}"
-      @screenshot_counter += 1
-    end
-    name = full_name(name)
-    file_name = "#{self.class.screenshot_area_abs}/#{name}.png"
-    org_name = "#{self.class.screenshot_area_abs}/#{name}_0.png~"
-    new_name = "#{self.class.screenshot_area_abs}/#{name}_1.png~"
-
-    FileUtils.mkdir_p File.dirname(file_name)
-    svn_file_name = "#{self.class.screenshot_area_abs}/.svn/text-base/#{name}.png.svn-base"
-    if File.exist?(svn_file_name)
-      committed_file_name = svn_file_name
-    else
-      svn_info = `svn info #{file_name} #{SILENCE_ERRORS}`
-      if svn_info.present?
-        wc_root = svn_info.slice(/(?<=Working Copy Root Path: ).*$/)
-        checksum = svn_info.slice(/(?<=Checksum: ).*$/)
-        if checksum
-          committed_file_name = "#{wc_root}/.svn/pristine/#{checksum[0..1]}/#{checksum}.svn-base"
-        end
+    def check_vcs(name, file_name, org_name)
+      svn_file_name = "#{self.class.screenshot_area_abs}/.svn/text-base/#{name}.png.svn-base"
+      if File.exist?(svn_file_name)
+        committed_file_name = svn_file_name
       else
-        committed_file_name = org_name
-        `git show HEAD~0:#{self.class.screenshot_area}/#{name}.png > #{committed_file_name} #{SILENCE_ERRORS}`
-        if File.size(committed_file_name) == 0
-          FileUtils.rm_f committed_file_name
+        svn_info = `svn info #{file_name} #{SILENCE_ERRORS}`
+        if svn_info.present?
+          wc_root = svn_info.slice(/(?<=Working Copy Root Path: ).*$/)
+          checksum = svn_info.slice(/(?<=Checksum: ).*$/)
+          if checksum
+            committed_file_name = "#{wc_root}/.svn/pristine/#{checksum[0..1]}/#{checksum}.svn-base"
+          end
+        else
+          committed_file_name = org_name
+          redirect_target = "#{committed_file_name} #{SILENCE_ERRORS}"
+          `git show HEAD~0:#{self.class.screenshot_area}/#{name}.png > #{redirect_target}`
+          if File.size(committed_file_name) == 0
+            FileUtils.rm_f committed_file_name
+          end
         end
       end
+      committed_file_name
     end
-    take_stable_screenshot(file_name)
-    return unless committed_file_name && File.exist?(committed_file_name)
-    (@test_screenshots ||= []) << [caller[0], name, file_name, committed_file_name, new_name, org_name]
-  end
 
-  IMAGE_WAIT_SCRIPT = <<EOF.freeze
+    IMAGE_WAIT_SCRIPT = <<EOF.freeze
 function pending_image() {
   var images = document.images;
   for (var i = 0; i < images.length; i++) {
@@ -144,36 +151,37 @@ function pending_image() {
 }()
 EOF
 
-  def assert_images_loaded(timeout: Capybara.default_max_wait_time)
-    return unless respond_to? :evaluate_script
-    start = Time.now
-    loop do
-      pending_image = evaluate_script IMAGE_WAIT_SCRIPT
-      break unless pending_image
-      assert (Time.now - start) < timeout,
-          "Image not loaded after #{timeout}s: #{pending_image.inspect}"
-      sleep 0.1
+    def assert_images_loaded(timeout: Capybara.default_max_wait_time)
+      return unless respond_to? :evaluate_script
+      start = Time.now
+      loop do
+        pending_image = evaluate_script IMAGE_WAIT_SCRIPT
+        break unless pending_image
+        assert (Time.now - start) < timeout,
+            "Image not loaded after #{timeout}s: #{pending_image.inspect}"
+        sleep 0.1
+      end
     end
-  end
 
-  def take_stable_screenshot(file_name)
-    assert_images_loaded
-    old_file_size = nil
-    loop do
-      save_screenshot(file_name)
-      break unless Capybara::Screenshot.stability_time_limit
-      new_file_size = File.size(file_name)
-      break if new_file_size == old_file_size
-      old_file_size = new_file_size
-      sleep Capybara::Screenshot.stability_time_limit
+    def take_stable_screenshot(file_name)
+      assert_images_loaded
+      old_file_size = nil
+      loop do
+        save_screenshot(file_name)
+        break unless Capybara::Screenshot.stability_time_limit
+        new_file_size = File.size(file_name)
+        break if new_file_size == old_file_size
+        old_file_size = new_file_size
+        sleep Capybara::Screenshot.stability_time_limit
+      end
     end
-  end
 
-  def assert_image_not_changed(caller, name, file_name, committed_file_name, new_name, org_name)
-    if Capybara::Screenshot::Diff::ImageCompare.compare(committed_file_name, file_name,
-        Capybara::Screenshot.window_size)
-      (@test_screenshot_errors ||= []) <<
+    def assert_image_not_changed(caller, name, file_name, committed_file_name, new_name, org_name)
+      if Capybara::Screenshot::Diff::ImageCompare.compare(committed_file_name, file_name,
+          Capybara::Screenshot.window_size)
+        (@test_screenshot_errors ||= []) <<
           "Screenshot does not match for '#{name}'\n#{file_name}\n#{org_name}\n#{new_name}\nat #{caller}"
+      end
     end
   end
 end

data/lib/capybara/screenshot/diff/version.rb

@@ -2,7 +2,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '0.2.1'.freeze
+      VERSION = '0.3.0'.freeze
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement