watir-screenshot-stitch 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ba4b5b238f75cd352deeb7f1ffde04ff7ed6a28431aed6740163f0c3e79b80d
+  data.tar.gz: ef31000f4b23bfb394fa0fa77b1bfc7504e3230d13d1e052646ff7d8b614b996
+SHA512:
+  metadata.gz: cf8b527dfa9693ad245645c8f11e4ee667a46a4627b91e8b19ed90858ed848e76224ec4acc91f1f28f207f4a3f4d4e014264070014c01dbc90eb65b49d35eabb
+  data.tar.gz: 2da7f9eca707491c9653c6a35368bf99c0ba72913ea0ce7844c8c5710bce03faaf39afef22f1469028b1a65fa6f4d8c76ba2641922f3e3b36057da738af07c75

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# macOS!
+.DS_store
+
+# development
+watir-screenshot-stitch-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at samuel.nissen@rakuten.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in watir-screenshot-stitch.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    watir-screenshot-stitch (0.4.0)
+      binding_of_caller (~> 0.7)
+      mini_magick (~> 4.0)
+      os (~> 1.0)
+      watir (~> 6.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding_of_caller (0.7.3)
+      debug_inspector (>= 0.0.1)
+    childprocess (0.8.0)
+      ffi (~> 1.0, >= 1.0.11)
+    debug_inspector (0.0.3)
+    diff-lcs (1.3)
+    ffi (1.9.18)
+    mini_magick (4.8.0)
+    os (1.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.8.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+    watir (6.10.2)
+      selenium-webdriver (~> 3.4, >= 3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  watir-screenshot-stitch!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sam Nissen
+
+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,87 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir-screenshot-stitch', :git => "https://github.com/samnissen/watir-screenshot-stitch.git"
+```
+
+### MiniMagick
+
+watir-screenshot-stitch relies on [MiniMagick](https://github.com/minimagick/minimagick)
+(and thus ImageMagick). You might need to review that gem's requirements and
+installation before proceeding.
+
+### Firefox
+
+watir-screenshot-stitch is optimized for and tested on Firefox. Your
+Watir / Selenium-Webdriver / geckodriver / Firefox stack must be correctly
+configured. If you can find a good guide for installing and maintaining all
+parts of this stack, you're a better Googler than me.
+
+## Usage
+
+watir-screenshot-stitch attempts can be used with a typical Watir script. This
+
+```ruby
+require 'watir-screenshot-stitch'
+path = "/my/path/image.png"
+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)
+```
+
+will save a full-page screenshot, up to 5000 pixels tall,
+to `/my/path/image.png`.
+
+### 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.
+
+### 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.
+
+#### `:page_height_limit`
+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.
+
+## Development
+
+TODO: This.
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "watir/screenshot/stitch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,3 @@
+module WatirScreenshotStitch
+  VERSION = "0.5.0"
+end

data/lib/watir-screenshot-stitch.rb

@@ -0,0 +1,106 @@
+require "watir-screenshot-stitch/version"
+require "watir"
+require "mini_magick"
+require "os"
+require "binding_of_caller"
+require "base64"
+
+MINIMAGICK_PIXEL_DIMENSION_LIMIT = 65500
+
+module Watir
+  class Screenshot
+
+    #
+    # Represents stitched together screenshot as Base64 encoded string.
+    #
+    # @example
+    #   opts = {:page_height_limit => 5000}
+    #   browser.screenshot.save_stitch("path/abc.png", browser, opts)
+    #
+    # @param [String] path
+    # @param [Watir::Browser] browser
+    # @param [Hash] opts
+    #
+
+    def save_stitch(path, browser, opts = {})
+      @options = opts
+      @path = path
+      @browser = browser
+
+      calculate_dimensions
+
+      build_canvas
+
+      gather_slices
+
+      stitch_together
+
+      @combined_screenshot.write @path
+    end
+
+    private
+      def calculate_dimensions
+        @start = MiniMagick::Image.read(Base64.decode64(self.base64))
+
+        @viewport_height    = (@browser.execute_script "return window.innerHeight").to_f.to_i
+        @page_height        = (@browser.execute_script "return Math.max( document.documentElement.scrollHeight, document.documentElement.getBoundingClientRect().height )").to_f.to_i
+
+        @mac_factor         = 2 if OS.mac?
+        @mac_factor       ||= 1
+
+        limit_page_height
+
+        @loops              = (@page_height / @viewport_height)
+        @remainder          = (@page_height % @viewport_height)
+      end
+
+      def limit_page_height
+        @original_page_height = @page_height
+
+        if @options[:page_height_limit] && ("#{@options[:page_height_limit]}".to_i > 0)
+          @page_height      = [@options[:page_height_limit], @page_height].min
+        end
+
+        if (@page_height*@mac_factor > MINIMAGICK_PIXEL_DIMENSION_LIMIT)
+          @page_height      = (MINIMAGICK_PIXEL_DIMENSION_LIMIT / @mac_factor)
+        end # https://superuser.com/a/773436
+      end
+
+      def build_canvas
+        @combined_screenshot = MiniMagick::Image.new(@path)
+        @combined_screenshot.run_command(:convert, "-size", "#{ @start.width }x#{ @page_height*@mac_factor }", "xc:white", @combined_screenshot.path)
+      end
+
+      def gather_slices
+        @blocks = []
+
+        @blocks << MiniMagick::Image.read(Base64.decode64(self.base64))
+
+        @loops.times do |i|
+          @browser.execute_script("window.scrollBy(0,#{@viewport_height})")
+          @blocks << MiniMagick::Image.read(Base64.decode64(self.base64))
+        end
+      end
+
+      def stitch_together
+        @blocks.each_with_index do |next_screenshot, i|
+          if (@blocks.size == (i+1)) && (@original_page_height == @page_height)
+            next_screenshot.crop last_portion_crop(next_screenshot.width)
+          end
+
+          height = (@viewport_height * i * @mac_factor)
+          combine_screenshot(next_screenshot, height)
+        end
+      end
+
+      def last_portion_crop(next_screenshot_width)
+        "#{next_screenshot_width}x#{@remainder*@mac_factor}+0+#{(@viewport_height*@mac_factor - @remainder*@mac_factor)}!"
+      end # https://gist.github.com/maxivak/3924976
+
+      def combine_screenshot(next_screenshot, offset)
+        @combined_screenshot = @combined_screenshot.composite(next_screenshot) do |c|
+          c.geometry "+0+#{offset}"
+        end
+      end
+  end
+end

data/watir-screenshot-stitch.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "watir-screenshot-stitch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "watir-screenshot-stitch"
+  spec.version       = WatirScreenshotStitch::VERSION
+  spec.authors       = ["Sam Nissen"]
+  spec.email         = ["scnissen@gmail.com"]
+
+  spec.summary       = %q{Extends Watir to take stitched-together screenshots of full web pages.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/samnissen/watir-screenshot-stitch"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+    # raise "RubyGems 2.0 or newer is required to protect against " \
+      # "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "watir", "~> 6.4"
+  spec.add_dependency "mini_magick", "~> 4.0"
+  spec.add_dependency "os", "~> 1.0"
+  spec.add_dependency "binding_of_caller", "~> 0.7"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: watir-screenshot-stitch
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Sam Nissen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 
+email:
+- scnissen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/watir-screenshot-stitch.rb
+- lib/watir-screenshot-stitch/version.rb
+- watir-screenshot-stitch.gemspec
+homepage: https://github.com/samnissen/watir-screenshot-stitch
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Extends Watir to take stitched-together screenshots of full web pages.
+test_files: []