watir-screenshot-stitch 0.6.11 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1bf1235cd25a0f41d381177c93ca6a0668d5c116
-  data.tar.gz: f69d3d620262a96e78f268a3a614f4b8c86f024f
+SHA256:
+  metadata.gz: 8d42f5b829d5f32b2a1e9a6a8584568e514a106098062ca6e543c9b918282414
+  data.tar.gz: ad58d948a08a88f4193b5dc8c5b561b9ce6d62da98c26555c4001a291cd63140
 SHA512:
-  metadata.gz: 8aad381a4e89008008aa6275961db9831c2960cea03fbf1efbd52631271505f3c9af67d8e8e7b8f7c15cf0b153b00b3921842f53ba446494be493547d588f6f7
-  data.tar.gz: e6f0ffbea07ae0e507fb29a428f86951c48666224d43c92ab3658f9394ff15c1570fa268d3832cfbf75e10212664d5b17d4e5b647dd024c91797f4f8f2f0be15
+  metadata.gz: 3b2a5333d6d2909f1d2d7eaf749c3badfb48e5130a728b416dfa44b92685176bf58b527f0af06f0db4332af7f9d958178dc9aecb3f2de3fab3a96a33dc45aa8a
+  data.tar.gz: eee00e63702ec36baddad298c8bb8136369b46b1665f6f02d6511c82c6b1002544e879b4c0eea800dd30758d315d9d127e55af41cb7a796094e5833d91d09ec5

data/README.md

@@ -1,10 +1,19 @@
 # watir-screenshot-stitch
 
-watir-screenshot-stitch attempts to compensate for Mozilla's decision
-not to (yet?) expose Firefox's full page screenshot functionality
-via geckodriver, [as indicated here](https://github.com/mozilla/geckodriver/issues/570),
-by paging down a given URL by the size of the viewport, capturing
-the entire page in the process.
+watir-screenshot-stitch attempts to compensate for
+the lack of full page screenshot functionality
+in Selenium Webdriver.
+
+It does so in three ways:
+
+* Directly employing geckodriver's new full page screenshot
+functionality (only on Firefox).
+* Screenshot stitching, paging down a given URL by the size 
+of the viewport, capturing screenshots and adjoining them.
+* Employing a bundled
+[html2canvas](https://github.com/niklasvh/html2canvas)
+script against the page to generate a png from a `canvas`
+element. 
 
 ## Installation
 
@@ -34,18 +43,84 @@ parts of this stack, you're a better Googler than me.
 
 ## Usage
 
-### WARNING: Browser passing will soon no longer be required
+### Special note: Upgrading from <= 0.6.11
+
+As warned in version 0.6.6 and beyond, the Watir::Screenshot
+class will have access to the browser in watir-screenshot-stitch
+version 0.7.0 and beyond, and it will not need to be
+passed to the public methods. Previous implementations will break.
+
+To adapt, change your function calls like so:
+
+<table>
+  <thead>
+    <tr>
+    <th>
+      <= 0.6.5
+    </th>
+    <th>
+      >= 0.6.6 && <= 0.6.11
+    </th>
+    <th>
+      >= 0.7.0
+    </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+        `save_stitch(path, browser, opts)`
+      </td>
+      <td>
+        `save_stitch(path, nil, opts)` or
+        `save_stitch(path, browser, opts)`
+      </td>
+      <td>
+        `save_stitch(path, opts)`
+      </td>
+    </tr>
+    <tr>
+      <td>
+        `base64_canvas(browser)`
+      </td>
+      <td>
+        `base64_canvas(browser)` or `base64_canvas`
+      </td>
+      <td>
+        `base64_canvas`
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+### Using geckodriver
+
+watir-screenshot-stitch can employ a special function of geckodriver >= 0.24.0
+while driving Firefox. This
 
-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.
+```ruby
+require 'watir-screenshot-stitch'
+b = Watir::Browser.new :firefox
+b.goto "https://github.com/mozilla/geckodriver/issues/570"
+b.base64_geckodriver
+```
+will return a base64 encoded image blob of the given site.
 
-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.
+In can be saved as a PNG by doing:
+```ruby
+png = b.screenshot.base64_geckodriver
+path = "/my/path/image.png"
+File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
+```
+
+This is the option with the fewest complications, and should be used
+if possible.
+
+#### User geckodriver vs. webdrivers geckodriver
+
+If using the webdrivers gem, watir-screenshot-stitch will attempt to
+use the geckodriver included there, since that's likely to be
+the driver employed by watir. If not, it falls back to the the system user's geckodriver.
 
 ### Stitching
 
@@ -58,7 +133,7 @@ opts = { :page_height_limit => 5000 }
 
 b = Watir::Browser.new :firefox
 b.goto "https://github.com/mozilla/geckodriver/issues/570"
-b.screenshot.save_stitch(path, b, opts)
+b.screenshot.save_stitch(path, opts)
 ```
 
 will stitch together and save a full-page screenshot, up to 5000 pixels tall,
@@ -68,25 +143,31 @@ to `/my/path/image.png`.
 
 html2canvas is a JavaScript library watir-screenshot-stitch can employ to
 try to create a canvas element of the entire page and covert it to a blob.
-For instance,
+For instance, this
 
 ```ruby
 require 'watir-screenshot-stitch'
 
 b = Watir::Browser.new :firefox
 b.goto "https://github.com/watir/watir/issues/702"
-b.screenshot.base64_canvas(b)
+b.screenshot.base64_canvas
 ```
 
 will return a base64 encoded image blob of the given site.
 
 In can be saved as a PNG by doing:
 ```ruby
-png = b.screenshot.base64_canvas(b)
+png = b.screenshot.base64_canvas
 path = "/my/path/image.png"
 File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
 ```
 
+This method of screenshotting
+is less likely to have issues with stitching the images together,
+and running out of memory but has limitations with certain element
+types not being properly displayed. See their documentation for
+more information.
+
 ### Doubling resolution calculations, including macOS Retina
 
 watir-screenshot-stitch uses CSS selectors to determine whether a
@@ -97,14 +178,6 @@ 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?
-
-This is obviously awkward and obtuse. Because watir-screenshot-stitch
-patches Watir, it does not change the way Watir calls the Screenshot class,
-which does not know about the Browser instance (it instead knows
-about the driver). And watir-screenshot-stitch needs the browser to execute
-JavaScript on the page.
-
 ### Options
 
 A hash of key value pairs.
@@ -113,17 +186,19 @@ A hash of key value pairs.
 Should refer to a positive Integer greater than the viewport height.
 
 ### Maximum height
-ImageMagick has a maximum pixel dimension of 65500, and all screenshots
-will be capped to a maximum height of 65500 regardless of any options
-to avoid errors.
+ImageMagick has a maximum pixel dimension of 65500, and all stitched
+screenshots will be capped to a maximum height of 65500 regardless 
+of any options to avoid errors.
 
 ## Development
 
-TODO: This.
+Use `rspec` to run the tests, and see the
+(contributing)[#Contributing] section below &mdash;
+all are welcome.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/watir-screenshot-stitch. 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/samnissen/watir-screenshot-stitch. 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/lib/watir-screenshot-stitch.rb

@@ -1,6 +1,5 @@
 require "time"
 require "watir-screenshot-stitch/version"
-require "watir-screenshot-stitch/utilities"
 require "watir"
 require "mini_magick"
 require "os"
@@ -14,6 +13,33 @@ RANGE_MOD = 0.02
 module Watir
   class Screenshot
 
+    #
+    # Employs a cutting edge feature in geckodriver version 0.24.0
+    # to produce a Base64 encoded string of a full page screenshot.
+    #
+    # @warning
+    #   This will fail if geckodriver is less than version 0.24.0.
+    #
+    # @info
+    #   This is only a patch until this is baked into Selenium/Watir.
+    #
+    # @example
+    #   browser.screenshot.base64_geckodriver
+    #   #=> '7HWJ43tZDscPleeUuPW6HhN3x+z7vU/lufmH0qNTtTum94IBWMT46evImci1vnFGT'
+    #
+    # @return [String]
+    #
+
+    def base64_geckodriver
+      ensure_geckodriver
+
+      resource_url = build_driver_url
+
+      raw = request_payload(resource_url)
+
+      parse_gecko(raw)
+    end
+
     #
     # Represents stitched together screenshot and writes to file.
     #
@@ -27,11 +53,10 @@ module Watir
     # @param [Hash] opts
     #
 
-    def save_stitch(path, browser = @browser, opts = {})
-      return browser.screenshot.save(path) if base64_capable?
+    def save_stitch(path, opts = {})
+      return @browser.screenshot.save(path) if base64_capable?
       @options = opts
       @path = path
-      deprecate_browser(browser, (__LINE__-3))
       calculate_dimensions
 
       return self.save(@path) if (one_shot? || bug_shot?)
@@ -57,9 +82,8 @@ module Watir
     # @return [String]
     #
 
-    def base64_canvas(browser = @browser)
+    def base64_canvas
       return self.base64 if base64_capable?
-      deprecate_browser(browser, (__LINE__-1))
       output = nil
 
       return self.base64 if one_shot? || bug_shot?
@@ -77,10 +101,56 @@ module Watir
     end
 
     private
-      def deprecate_browser(browser, line)
-        return unless browser
-        warn "#{DateTime.now.strftime("%F %T")} WARN Watir Screenshot Stitch [DEPRECATION] Passing the browser is deprecated and will no longer work in version 0.7.0 /lib/watir-screenshot-stitch.rb:#{line}"
-        @browser = browser
+      def parse_gecko(raw = '')
+        JSON.parse(raw, symbolize_names: true)[:value]
+      rescue JSON::ParserError => e
+        raise "geckodriver response '#{raw}' was malformed"
+      end
+
+      def request_payload(request_url)
+        url = URI.parse(request_url)
+        req = Net::HTTP::Get.new(request_url)
+        Net::HTTP.start(url.host, url.port) {|http| http.request(req) }.body
+      rescue Errno::ECONNREFUSED => e
+        raise "geckodriver could not be accessed at '#{request_url}'"
+      end
+
+      def build_driver_path
+        bridge = @browser.driver.session_storage.instance_variable_get(:@bridge)
+        sid = bridge.instance_variable_get(:@session_id)
+
+        raise "Unable to get geckodriver session ID." unless sid
+
+        "session/#{sid}/moz/screenshot/full"
+      end
+
+      def build_driver_url
+        bridge = @browser.driver.session_storage.instance_variable_get(:@bridge)
+        server_uri = bridge.instance_variable_get(:@http).instance_variable_get(:@server_url)
+
+        raise "Unable to get geckodriver server URI." unless server_uri
+
+        request_url = server_uri.to_s + build_driver_path
+      end
+
+      def ensure_geckodriver
+        raise "base64_geckodriver only works on Firefox" unless @browser.name == :firefox
+
+        if webdrivers_defined?
+          current_version = Webdrivers::Geckodriver.current_version
+        else
+          current_version = Gem::Version.new(%x{geckodriver --version}.match(/geckodriver (\d+\.\d+\.\d+)/)[1])
+        end
+
+        correct_version = (current_version >= Gem::Version.new("0.24.0"))
+
+        raise "base64_geckodriver requires version 0.24.x or greater" unless correct_version
+      end
+
+      def webdrivers_defined?
+        Object.const_get("Webdrivers")
+      rescue NameError
+        nil
       end
 
       # in IE & Safari a regular screenshot is a full page screenshot only
@@ -134,10 +204,10 @@ module Watir
       def html2canvas_payload
         case @browser.driver.browser
         when :firefox
-          path = File.join(WatirScreenshotStitch::Utilities.directory, "vendor/html2canvas-0.4.1.js")
+          path = File.expand_path("../../vendor/html2canvas-0.4.1.js", __FILE__)
           File.read(path)
         else
-          path = File.join(WatirScreenshotStitch::Utilities.directory, "vendor/html2canvas.js")
+          path = File.expand_path("../../vendor/html2canvas.js", __FILE__)
           File.read(path)
         end
       end
@@ -169,7 +239,7 @@ module Watir
       def build_canvas
         @start = MiniMagick::Image.read(Base64.decode64(self.base64))
         @combined_screenshot = MiniMagick::Image.new(@path)
-        @combined_screenshot.run_command(:convert, "-size", "#{ @start.width }x#{ @page_height*@mac_factor }", "xc:white", @combined_screenshot.path)
+        @combined_screenshot.run_command(:convert, "-size", "#{ @start.width }x#{ @page_height*@mac_factor }", "xc:white", "-define", "png:color-type=6", @combined_screenshot.path)
       end
 
       def gather_slices

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

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

data/watir-screenshot-stitch.gemspec

@@ -30,14 +30,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "chunky_png", "~> 1.3"
 
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency "rubyzip", "~> 1.2"
-  spec.add_dependency "watir", "~> 6.4"
+  spec.add_dependency "watir", "~> 6.12"
   spec.add_dependency "mini_magick", "~> 4.0"
   spec.add_dependency "os", "~> 1.0"
   spec.add_dependency "binding_of_caller", "~> 0.7"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: watir-screenshot-stitch
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.7.5
 platform: ruby
 authors:
 - Sam Nissen
 - Sandeep Singh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.12'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-description: 
+description:
 email:
 - scnissen@gmail.com
 - sandeepnagra@gmail.com
@@ -156,7 +156,6 @@ files:
 - bin/console
 - bin/setup
 - lib/watir-screenshot-stitch.rb
-- lib/watir-screenshot-stitch/utilities.rb
 - lib/watir-screenshot-stitch/version.rb
 - vendor/html2canvas-0.4.1.js
 - vendor/html2canvas.js
@@ -165,7 +164,7 @@ homepage: https://github.com/samnissen/watir-screenshot-stitch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,9 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Extends Watir to take stitched-together screenshots of full web pages.
 test_files: []

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

@@ -1,11 +0,0 @@
-module WatirScreenshotStitch
-  module Utilities
-    # Return a directory with the project libraries.
-    def self.directory
-      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{WatirScreenshotStitch::NAME}",
-           "#{Gem.dir}/gems/#{WatirScreenshotStitch::NAME}-#{WatirScreenshotStitch::VERSION}"]
-      t.each {|i| return i if File.readable?(i) }
-      raise "watir-screenshot-stitch could not be found in: #{t}"
-    end # https://stackoverflow.com/a/5805783/1651458
-  end
-end