chromedriver-screenshot 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d669b6828cdf8802b5b771efdec6219512f3cf97
-  data.tar.gz: 82bf11763a57cff6a0d8337231393f32b92e4380
+  metadata.gz: 18e504d4f42af744fbf2ae1865e0f66e02f8954a
+  data.tar.gz: 25ea4dd2c07df554500b49733d33fe531fb640fb
 SHA512:
-  metadata.gz: 9036f2eb0d7e3e6e8a7d924521db19ff227eed196439bc2bf9fddc08909b15d13455ee4d5c228c094c0a5848697ab51d461db2d406d1c359ead8d61131452dc8
-  data.tar.gz: 6ebc32f50f58a4becd615154836abf3a6f408bb2fa06a459976b9eea589ae4e60187c52755504759707c4d915d043872e9cf02e2704f386f8b35d0c19efa2e77
+  metadata.gz: c50253ad37a6b2bdf2a0943e0048cd16ae0836791b7b992843406582a9f13526c719f57381219053882cd950e362624a086de3762db9b4bb6e372a14ef71d02f
+  data.tar.gz: c66caadcd1e538aae50e76928389dde0776113e52b40c6547735d31f41b5f0cfee6fa3e7b7e6e788852d2f910acaaff8796b07ab98c36e0040fb638e49b839b7

data/.gitignore

@@ -26,6 +26,7 @@ build/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
+gemfiles/*.lock
 # .ruby-version
 # .ruby-gemset
 

data/.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 dist: trusty
 rvm:
   - 2.2
+gemfile:
+  - gemfiles/selenium_2.gemfile
+  - gemfiles/selenium_3.gemfile
 cache: bundler
 before_script:
   - export CHROME_BIN=/usr/bin/google-chrome

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "selenium-2" do
+  gem "selenium-webdriver", "< 3.0"
+end
+
+appraise "selenium-3" do
+  gem "selenium-webdriver", ">= 3.0"
+end

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.4.0 (January 30, 2017)
+
+- Add support for both Selenium 2 and 3
+- Transfer ownership to The Orchard
+- Implement Selenium UI testing using Cucumber
+
+Bugs:
+  - Fix dimension mismatches on React applications
+
 ## 0.3.0 (December 6, 2016)
 
 - Upgraded to Selenium 3.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Sean MacGahan
+Copyright (c) 2016 The Orchard
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -15,11 +15,11 @@ You can switch to the old screenshot behavior by changing the `take_full_screens
     ChromedriverScreenshot.take_full_screenshots = false
 
 # Known issues:
-0. Screenshots on Retina displays quadruple in size because Apple is a piece of shit. As a result, screenshots are cropped incorrectly.
+0. Screenshots on Retina displays quadruple in size. As a result, screenshots are cropped incorrectly.
 
 # TODO:
 0. Better inheritance/monkeypatching
-0. Find a solution to the Retina bullshit
+0. Find a solution to screenshots on Retina
 0. Refactor singleton platforms class
 0. Refactor ChunkyPNG method
 0. Add e2e tests

data/chromedriver-screenshot.gemspec

@@ -16,9 +16,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "oily_png", "~> 1.2"
-  s.add_dependency "selenium-webdriver", "~> 3.0"
+  s.add_dependency "selenium-webdriver", ">= 2.0"
 
+  s.add_development_dependency "appraisal", "~> 2.1.0"
   s.add_development_dependency "rspec", "~> 3.2"
   s.add_development_dependency "cucumber", "~> 2.4.0"
   s.add_development_dependency "rake", "~> 10.5.0"
+  s.add_development_dependency "rmagick", "~> 2.16.0"
 end

data/features/step_definitions/image_page_steps.rb

@@ -10,8 +10,5 @@ end
 
 Then(/^the screenshot matches the stored single window image$/) do
   expected_screenshot_path = File.join(support_directory, "fixtures", "single_window_image", "expected_screenshot.png")
-  expected_screenshot = File.read(expected_screenshot_path)
-  actual_screenshot = File.read(@actual_screenshot_path)
-
-  expect(actual_screenshot).to eql expected_screenshot
+  Image.new(@actual_screenshot_path).should_match(expected_screenshot_path)
 end

data/features/support/env.rb

@@ -1,4 +1,5 @@
 require "selenium-webdriver"
 require "chromedriver-screenshot"
+require "rmagick"
 
 ChromedriverScreenshot.take_full_screenshots = true

data/features/support/hooks.rb

@@ -1,5 +1,14 @@
 browser = Selenium::WebDriver.for :chrome
 
+desired_window_height = 600
+desired_window_width = 1024
+browser.manage.window.resize_to(desired_window_width, desired_window_height)
+
+window_height = browser.execute_script ChromedriverScreenshot::Platforms::WINDOW_HEIGHT_SCRIPT
+window_width = browser.execute_script ChromedriverScreenshot::Platforms::WINDOW_WIDTH_SCRIPT
+
+browser.manage.window.resize_to(desired_window_width*2 - window_width, desired_window_height*2 - window_height)
+
 Before do
   @browser = browser
 

data/features/support/image.rb

@@ -0,0 +1,39 @@
+class Image
+  def initialize(image)
+    @path = image
+    @image = Magick::Image.read(image)[0]
+  end
+
+  # consider turning this into a custom matcher instead
+  def should_match(image_path_to_compare, max_difference: 0.10)
+    image_difference = difference_from(image_path_to_compare)
+    fail(
+      "Images don't match!\n"\
+      "  Expected image: #{@path}\n"\
+      "  Actual image: #{image_path_to_compare}\n"\
+      "  Difference: #{image_difference}\n"\
+      "  Threshold: #{max_difference}"
+    ) unless image_difference < max_difference
+  end
+
+  private
+
+  def difference_from(image_path)
+    image_to_compare = Magick::Image.read(image_path)[0]
+
+    assert_dimensions_match(image_to_compare)
+
+    _, diff_metric = @image.compare_channel(image_to_compare, Magick::MeanSquaredErrorMetric)
+    diff_metric
+  end
+
+  def assert_dimensions_match(other_image)
+    base_dims = [@image.columns, @image.rows]
+    compared_dims = [other_image.columns, other_image.rows]
+    fail(
+      "images do not match!\n"\
+      "Base image: #{base_dims}\n"\
+      "Compared image: #{compared_dims}"
+    ) if base_dims != compared_dims
+  end
+end

data/gemfiles/selenium_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "selenium-webdriver", "< 3.0"
+
+gemspec :path => "../"

data/gemfiles/selenium_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "selenium-webdriver", ">= 3.0"
+
+gemspec :path => "../"

data/lib/chromedriver-screenshot.rb

@@ -21,10 +21,11 @@ module Selenium
   module WebDriver
     module Remote
       class Bridge
-        alias_method :window_screenshot, :screenshot
-        def screenshot
+        @@use_selenium_2 = Gem.loaded_specs["selenium-webdriver"].version < Gem::Version.create('3.0')
+
+        def new_screenshot_method
           if browser == :chrome && ChromedriverScreenshot.take_full_screenshots
-            ChromedriverScreenshot::Platforms.create_platform(self)
+            ChromedriverScreenshot::Platforms.create_platform(self, @@use_selenium_2)
 
             screenshot = ChromedriverScreenshot::Page.new.full_screenshot
             blob = screenshot.to_blob(:fast_rgb) # optimized for opaque images; greatly reduces runtime
@@ -33,6 +34,14 @@ module Selenium
             window_screenshot
           end
         end
+
+        if @@use_selenium_2
+          alias_method :window_screenshot, :getScreenshot
+          alias_method :getScreenshot, :new_screenshot_method
+        else
+          alias_method :window_screenshot, :screenshot
+          alias_method :screenshot, :new_screenshot_method
+        end
       end
     end
   end

data/lib/chromedriver-screenshot/platforms.rb

@@ -1,11 +1,17 @@
 module ChromedriverScreenshot
   class Platforms
+    BODY_CLIENT_WIDTH = "document.body.clientWidth"
+    DOCUMENT_CLIENT_WIDTH = "document.documentElement.clientWidth"
+    BODY_CLIENT_HEIGHT = "document.body.clientHeight"
+    DOCUMENT_CLIENT_HEIGHT = "document.documentElement.clientHeight"
+    WINDOW_WIDTH_SCRIPT = "return Math.min(#{BODY_CLIENT_WIDTH}, #{DOCUMENT_CLIENT_WIDTH})"
+    WINDOW_HEIGHT_SCRIPT = "return Math.min(#{BODY_CLIENT_HEIGHT}, #{DOCUMENT_CLIENT_HEIGHT})"
     def self.platform
       @platform
     end
 
-    def self.create_platform(bridge)
-      @platform = new(bridge)
+    def self.create_platform(bridge, use_selenium_2_methods)
+      @platform = new(bridge, use_selenium_2_methods)
     end
 
     def page_width
@@ -17,11 +23,11 @@ module ChromedriverScreenshot
     end
 
     def window_width
-      @window_width ||= execute_script("return document.documentElement.clientWidth")
+      @window_width ||= execute_script WINDOW_WIDTH_SCRIPT
     end
 
     def window_height
-      @window_height ||= execute_script("return document.documentElement.clientHeight")
+      @window_height ||= execute_script WINDOW_HEIGHT_SCRIPT
     end
 
     def window_x
@@ -43,12 +49,17 @@ module ChromedriverScreenshot
 
     private
 
-    def initialize(bridge)
+    def initialize(bridge, use_version_2)
       @bridge = bridge
+      @use_version_2 = use_version_2
     end
 
     def execute_script(script)
-      @bridge.execute_script(script)
+      if @use_version_2
+        @bridge.executeScript(script)
+      else
+        @bridge.execute_script(script)
+      end
     end
   end
 end

data/lib/chromedriver-screenshot/version.rb

@@ -1,3 +1,3 @@
 module ChromedriverScreenshot
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chromedriver-screenshot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sean MacGahan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -28,16 +28,30 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 10.5.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
 description: Full-page screenshots for Chrome in Selenium WebDriver
 email: smacgaha@gmail.com
 executables: []
@@ -89,6 +117,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -102,7 +131,10 @@ files:
 - features/support/fixtures/single_window_image/smiley_face.png
 - features/support/fixtures/single_window_image/test_page.html
 - features/support/hooks.rb
+- features/support/image.rb
 - features/support/step_helpers.rb
+- gemfiles/selenium_2.gemfile
+- gemfiles/selenium_3.gemfile
 - lib/chromedriver-screenshot.rb
 - lib/chromedriver-screenshot/page.rb
 - lib/chromedriver-screenshot/platforms.rb