watir-screenshot-stitch 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07f47edb1870dd100e4a9d57aa967533aee97f2e19f5ba14afcb80dfb5c19b6
-  data.tar.gz: 154b57ebd2422ed32b6cd831fb78bdd3262b20f30effc74e529800ba7ab9137e
+  metadata.gz: fd6ae2c56651dc8041dffd92f6c9b4477e9c81d11b17b2aac058904ab58f1f8e
+  data.tar.gz: f277df5ee5f812fa4de1f7a5d1a902fb4ee52d73ccd8a8186c203914d4483d73
 SHA512:
-  metadata.gz: 9413b0fb0799c887fa5cd5fa74536ffed83cced52a9e8ce2ecb62d576df5828a18d4a7bc876e66f6722f97e6f384c10e3eaf8cba24a5a1b97bce011ad68b05eb
-  data.tar.gz: 8cfa1e3c257a0c37b60c6f4c3211b9f1c5d69cc40fe0ded93907ef9bb0c5a73ddedf6e4b5f161531f70e7512cb72712c3237e618d0f7ea6fe348e77924c1ee44
+  metadata.gz: 100a998821100f775154a1429dd73daf6dd630492b332393ad55efb0e134c386e24f023759f655108b85423c79045739339737b6e447dd7bf0ce692e8deb0316
+  data.tar.gz: 3b3036501c185abc589046eefcaccf2931a8eda494697366831c51b15bf41221185f4d159e5a248e3f276c2a821962f5dea54339f946d008404cb4575ecf5a9b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    watir-screenshot-stitch (0.6.4)
+    watir-screenshot-stitch (0.6.5)
       binding_of_caller (~> 0.7)
       mini_magick (~> 4.0)
       os (~> 1.0)
@@ -12,11 +12,11 @@ GEM
   specs:
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
-    childprocess (0.8.0)
+    childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
     debug_inspector (0.0.3)
     diff-lcs (1.3)
-    ffi (1.9.18)
+    ffi (1.9.23)
     mini_magick (4.8.0)
     os (1.0.0)
     rake (10.5.0)
@@ -34,10 +34,10 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
     rubyzip (1.2.1)
-    selenium-webdriver (3.8.0)
+    selenium-webdriver (3.12.0)
       childprocess (~> 0.5)
-      rubyzip (~> 1.0)
-    watir (6.10.2)
+      rubyzip (~> 1.2)
+    watir (6.11.0)
       selenium-webdriver (~> 3.4, >= 3.4.1)
 
 PLATFORMS
@@ -50,4 +50,4 @@ DEPENDENCIES
   watir-screenshot-stitch!
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -29,6 +29,19 @@ parts of this stack, you're a better Googler than me.
 
 ## Usage
 
+### WARNING: Browser passing will soon no longer be required
+
+As of watir-screenshot-stitch version 0.7.0, the Watir::Screenshot
+class will have access to the browser, and it will not need to be
+passed to the public methods. `save_stitch(path, browser, opts)`
+will become `save_stitch(path, opts)`, and `base64_canvas(browser)`
+will become `base64_canvas` and existing implementations will
+break.
+
+To suppress warnings in the meantime, upgrade to Watir 6.12
+and pass `nil` in place of the `browser` for #save_stitch and
+use `base64_canvas` with no parameters.
+
 ### Stitching
 
 watir-screenshot-stitch can be used with a typical Watir script. This
@@ -62,11 +75,15 @@ b.screenshot.base64_canvas(b)
 
 will return a base64 encoded image blob of the given site.
 
-### macOS Retina
+### Doubling resolution calculations, including macOS Retina
 
-watir-screenshot-stitch assumes any user running macOS is displaying at
-'Retina' resolution, therefore multiplies all screen resolutions by 2.
-Any other operating system will not trigger this multiplication.
+watir-screenshot-stitch uses CSS selectors to determine whether a
+resulting screenshot's dimensions will be double
+the page dimensions when a screenshot is captured,
+as is the case for macOS 'Retina', and relies on this
+logic to determine how to stitch together images.
+This means that moving the browser window while it is be driven by
+Watir can cause unpredictable results.
 
 ### Passing the browser?
 
@@ -102,4 +119,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Watir::Screenshot::Stitch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/watir-screenshot-stitch/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Watir::Screenshot::Stitch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/samnissen/watir-screenshot-stitch/blob/master/CODE_OF_CONDUCT.md).

data/lib/watir-screenshot-stitch.rb

@@ -21,14 +21,15 @@ module Watir
     #   browser.screenshot.save_stitch("path/abc.png", browser, opts)
     #
     # @param [String] path
-    # @param [Watir::Browser] browser
+    # @deprecated
+    #   @param [Watir::Browser] browser
     # @param [Hash] opts
     #
 
-    def save_stitch(path, browser, opts = {})
+    def save_stitch(path, browser = @browser, opts = {})
       @options = opts
       @path = path
-      @browser = browser
+      deprecate_browser(browser, (__LINE__-3))
       calculate_dimensions
 
       return self.save(@path) if (one_shot? || bug_shot?)
@@ -48,13 +49,14 @@ module Watir
     #   browser.screenshot.base64_canvas(browser)
     #   #=> '7HWJ43tZDscPleeUuPW6HhN3x+z7vU/lufmH0qNTtTum94IBWMT46evImci1vnFGT'
     #
-    # @param [Watir::Browser] browser
+    # @deprecated
+    #   @param [Watir::Browser] browser
     #
     # @return [String]
     #
 
-    def base64_canvas(browser)
-      @browser = browser
+    def base64_canvas(browser = @browser)
+      deprecate_browser(browser, (__LINE__-1))
       output = nil
 
       return self.base64 if one_shot? || bug_shot?
@@ -72,6 +74,12 @@ module Watir
     end
 
     private
+      def deprecate_browser(browser, line)
+        return unless browser
+        warn "[DEPRECATION] WatirScreenshotStitch: Passing the browser is deprecated and will no longer work in version 0.7.0 /lib/watir-screenshot-stitch.rb:#{line}"
+        @browser = browser
+      end
+
       def one_shot?
         calculate_dimensions unless @loops && @remainder
         ( (@loops == 1) && (@remainder == 0) )

data/lib/watir-screenshot-stitch/version.rb

@@ -1,4 +1,4 @@
 module WatirScreenshotStitch
   NAME = 'watir-screenshot-stitch'
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir-screenshot-stitch
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Sam Nissen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Extends Watir to take stitched-together screenshots of full web pages.