chromedriver-screenshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8949dcc7abef43f974d2e8dd41c40bef9de894c
+  data.tar.gz: 6dad23dcb2761771d2d2521a6f473c8773102e19
+SHA512:
+  metadata.gz: b652922889a53a17ac7af928a5856fdf6e59057789bf0e9f2a5537e1f7afb52c2bd821a946dbd0699517d6936ca548c162098fb2b98a43d389cc0afab493ed7b
+  data.tar.gz: 3e0253c1cc6cc8812424031ef05cad4b86b26bc40279c5fdc3753b6a8a5c64230c60ed0705c70d0194829b979e8cac9a01e911af200a21264a1e603466d84f12

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# specify your gem's dependencies in chromedriver-screenshot.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sean MacGahan
+
+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,17 @@
+# chromedriver-screenshot
+Full page screenshots for Chrome in Selenium WebDriver
+
+# Usage
+Simply require the gem after requiring selenium-webdriver or any dependent DSL (ex. watir)
+chromedriver-screenshot will snip the page into separate sections, take screenshots of each individual section, and then stitch them together to create a screenshot of the page in its entirety.
+
+# Known issues:
+0. Screenshots on Retina displays quadruple in size because Apple is a piece of shit. As a result, screenshots are cropped incorrectly.
+
+# TODO:
+0. Better inheritance/monkeypatching
+0. Find a solution to the Retina bullshit
+0. Refactor singleton platforms class
+0. Refactor ChunkyPNG method
+0. Add e2e tests
+0. Finish unit tests

data/chromedriver-screenshot.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "chromedriver-screenshot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "chromedriver-screenshot"
+  s.version     = ChromedriverScreenshot::VERSION
+  s.authors     = "Sean MacGahan"
+  s.email       = "smacgaha@gmail.com"
+  s.homepage    = "http://github.com/smacgaha/chromedriver-screenshot"
+  s.summary     = "Full-page screenshots for Chromedriver"
+  s.description = "Full-page screenshots for Chrome in Selenium WebDriver"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "oily_png", "~> 1.2"
+
+  s.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/chromedriver-screenshot.rb

@@ -0,0 +1,25 @@
+require 'chromedriver-screenshot/page'
+require 'chromedriver-screenshot/row'
+require 'chromedriver-screenshot/tile'
+require 'chromedriver-screenshot/platforms'
+require "oily_png"
+
+# really bad monkeypatching. fix this.
+module Selenium
+  module WebDriver
+    module Remote
+      class Bridge
+        alias_method :window_screenshot, :getScreenshot
+        def getScreenshot
+          if browser == :chrome
+            ChromedriverScreenshot::Platforms.create_platform(self)
+            page = ChromedriverScreenshot::Page.new
+            page.full_screenshot
+          else
+            window_screenshot
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chromedriver-screenshot/page.rb

@@ -0,0 +1,44 @@
+module ChromedriverScreenshot
+  class Page
+    def initialize
+      bounds = row_boundaries
+      @rows = Row.from_boundaries(bounds)
+    end
+
+    def full_screenshot
+      rows = @rows.map { |row| row.screenshot }
+      page_height = rows.inject(0) do |height, row|
+        height += row.height
+      end
+      page_width = rows.first.width # assume all rows have same width
+      screenshot = ChunkyPNG::Image.new(page_width, page_height)
+
+      image_row = 0
+      rows.each do |row|
+        row_height = row.height - 1
+        (0..row.height - 1).each do |row_y|
+          new_image_row = row.row(row_y)
+          screenshot.replace_row!(image_row + row_y, new_image_row)
+        end
+        image_row += row.height
+      end
+
+      Base64::encode64(screenshot.to_blob)
+    end
+
+    private
+
+    def row_boundaries
+      row_boundary_ary = []
+
+      platform = ChromedriverScreenshot::Platforms.platform
+
+      new_boundary = platform.window_height
+      while new_boundary < platform.page_height
+        row_boundary_ary << new_boundary
+        new_boundary += platform.window_height
+      end
+      row_boundary_ary << platform.page_height
+    end
+  end
+end

data/lib/chromedriver-screenshot/platforms.rb

@@ -0,0 +1,50 @@
+module ChromedriverScreenshot
+  class Platforms
+    def self.platform
+      @platform
+    end
+
+    def self.create_platform(bridge)
+      @platform = new(bridge)
+    end
+
+    def page_width
+      @page_width ||= @bridge.executeScript("return document.body.scrollWidth")
+    end
+
+    def page_height
+      @page_height ||= @bridge.executeScript("return document.body.scrollHeight")
+    end
+
+    def window_width
+      @window_width ||= @bridge.executeScript("return window.innerWidth")
+    end
+
+    def window_height
+      @window_height ||= @bridge.executeScript("return window.innerHeight")
+    end
+
+    def window_x
+      @bridge.executeScript("return window.scrollX")
+    end
+
+    def window_y
+      @bridge.executeScript("return window.scrollY")
+    end
+
+    def screenshot
+      @bridge.window_screenshot.unpack("m")[0]
+    end
+
+    def scroll_to(x, y)
+      @bridge.executeScript("window.scrollTo(#{x}, #{y})")
+      sleep 1 # don't know why this is necessary
+    end
+
+    private
+
+    def initialize(bridge)
+      @bridge = bridge
+    end
+  end
+end

data/lib/chromedriver-screenshot/row.rb

@@ -0,0 +1,51 @@
+module ChromedriverScreenshot
+  class Row
+    def self.from_boundaries(boundaries)
+      row_ary = []
+      boundaries.inject(0) do |row_top, row_bottom|
+        row_ary << new(row_top, row_bottom)
+        row_bottom
+      end
+      row_ary
+    end
+
+    def screenshot
+      tiles = @tiles.map { |tile| tile.screenshot }
+
+      row_width = tiles.inject(0) do |width, tile|
+        width += tile.width
+      end
+      row_height = tiles.first.height # assume all tiles have same height
+      screenshot = ChunkyPNG::Image.new(row_width, row_height)
+
+      (1..row_height).each do |row|
+        new_row = tiles.inject([]) do |concatenated_row, tile|
+          concatenated_row += tile.row(row - 1)
+        end
+        screenshot.replace_row!(row - 1, new_row)
+      end
+
+      screenshot
+    end
+
+    private
+
+    def initialize(row_top, row_bottom)
+      bounds = column_boundaries
+      @tiles = Tile.from_boundaries(row_top, row_bottom, column_boundaries)
+    end
+
+    def column_boundaries
+      column_boundary_ary = []
+
+      platform = ChromedriverScreenshot::Platforms.platform
+
+      new_boundary = platform.window_width
+      while new_boundary < platform.window_width
+        column_boundary_ary << new_boundary
+        new_boundary += platform.window_width
+      end
+      column_boundary_ary << platform.page_width
+    end
+  end
+end

data/lib/chromedriver-screenshot/tile.rb

@@ -0,0 +1,41 @@
+module ChromedriverScreenshot
+  class Tile
+    def self.from_boundaries(row_top, row_bottom, boundaries)
+      tile_ary = []
+      boundaries.inject(0) do |column_left, column_right|
+        tile_ary << new([column_left, row_top], [column_right, row_bottom])
+        column_right
+      end
+      tile_ary
+    end
+
+    def initialize(top_left, bot_right)
+      @x, @y = top_left
+      @width = bot_right[0] - @x
+      @height = bot_right[1] - @y
+    end
+
+    def screenshot
+      screenshot_blob = get_screenshot
+      offset_x, offset_y = get_offset
+      screenshot = ChunkyPNG::Image.from_blob(screenshot_blob)
+      screenshot.crop(offset_x, offset_y, @width, @height)
+    end
+
+    private
+
+    def get_screenshot
+      platform = ChromedriverScreenshot::Platforms.platform
+      platform.scroll_to @x, @y
+      platform.screenshot
+    end
+
+    # can't scroll past ends of page, so sometimes position won't be accurate
+    def get_offset
+      platform = ChromedriverScreenshot::Platforms.platform
+      offset_x = @x - platform.window_x
+      offset_y = @y - platform.window_y
+      [offset_x, offset_y]
+    end
+  end
+end

data/lib/chromedriver-screenshot/version.rb

@@ -0,0 +1,3 @@
+module ChromedriverScreenshot
+  VERSION = "0.1.0"
+end

data/spec/chromedriver-screenshot/page_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe ChromedriverScreenshot::Page do
+  context "#initialize" do
+    subject { ChromedriverScreenshot::Page.new }
+
+    before(:example) do
+      platform = double("platform", page_height: 100, window_height: window_height)
+      allow(ChromedriverScreenshot::Platforms).to receive(:platform).and_return(platform)
+      expect(ChromedriverScreenshot::Row).to receive(:from_boundaries).with(expected_ary)
+    end
+
+    context "page height is a multiple of window height" do
+      let(:window_height) { 20 }
+      let(:expected_ary) { [20, 40, 60, 80, 100] }
+
+      it "returns even boundaries" do
+        subject
+      end
+    end
+
+    context "page height is not a multiple of window height" do
+      let(:window_height) { 30 }
+      let(:expected_ary) { [30, 60, 90, 100] }
+
+      it "returns partial boundaries" do
+        subject
+      end
+    end
+
+    context "page height is equal to window height" do
+      let(:window_height) { 100 }
+      let(:expected_ary) { [100] }
+
+      it "returns single even boundary" do
+        subject
+      end
+    end
+
+    context "page height is smaller than window height" do
+      let(:window_height) { 200 }
+      let(:expected_ary) { [100] }
+
+      it "returns single partial boundary" do
+        subject
+      end
+    end
+  end
+end

data/spec/chromedriver-screenshot/tile_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe ChromedriverScreenshot::Tile do
+  context "#screenshot" do
+    subject { new_tile.screenshot }
+    before(:each) do
+      image_blob = ChunkyPNG::Image.from_file("spec/support/fixtures/smiley_face.png").to_blob
+      allow_any_instance_of(described_class).to receive(:get_screenshot).and_return(image_blob)
+      allow_any_instance_of(described_class).to receive(:get_offset).and_return(offset)
+    end
+
+    context "window without offset" do
+      let(:offset) { [0, 0] }
+
+      context "full screen shot" do
+        let(:new_tile) { described_class.new([0, 0], [180, 180]) }
+
+        it "isn't cropped" do
+          expected = ChunkyPNG::Image.from_file("spec/support/fixtures/smiley_face.png")
+          expect(subject <=> expected).to be 0
+        end
+      end
+
+      context "partial screenshot" do
+        let(:new_tile) { described_class.new([0, 0], [120, 90]) }
+
+        it "is cropped" do
+          expected = ChunkyPNG::Image.from_file("spec/support/fixtures/cropped_smiley_face.png")
+          expect(subject <=> expected).to be 0
+        end
+      end
+    end
+
+    context "window with offset" do
+      let(:offset) { [20, 40] }
+
+      context "full screenshot" do
+        let(:new_tile) { described_class.new([0, 0], [160, 140]) }
+
+        it "is cropped" do
+          expected = ChunkyPNG::Image.from_file("spec/support/fixtures/offset_smiley_face.png")
+          expect(subject <=> expected).to be 0
+        end
+      end
+
+      context "partial screenshot" do
+        let(:new_tile) { described_class.new([0, 0], [120, 90]) }
+
+        it "is cropped" do
+          expected = ChunkyPNG::Image.from_file("spec/support/fixtures/offset_cropped_smiley_face.png")
+          expect(subject <=> expected).to be 0
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+require "selenium-webdriver" # result of bad monkeypatching
+require_relative "../lib/chromedriver-screenshot"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: chromedriver-screenshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean MacGahan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Full-page screenshots for Chrome in Selenium WebDriver
+email: smacgaha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- chromedriver-screenshot.gemspec
+- lib/chromedriver-screenshot.rb
+- lib/chromedriver-screenshot/page.rb
+- lib/chromedriver-screenshot/platforms.rb
+- lib/chromedriver-screenshot/row.rb
+- lib/chromedriver-screenshot/tile.rb
+- lib/chromedriver-screenshot/version.rb
+- spec/chromedriver-screenshot/page_spec.rb
+- spec/chromedriver-screenshot/tile_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/cropped_smiley_face.png
+- spec/support/fixtures/offset_cropped_smiley_face.png
+- spec/support/fixtures/offset_smiley_face.png
+- spec/support/fixtures/smiley_face.png
+homepage: http://github.com/smacgaha/chromedriver-screenshot
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Full-page screenshots for Chromedriver
+test_files:
+- spec/chromedriver-screenshot/page_spec.rb
+- spec/chromedriver-screenshot/tile_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/cropped_smiley_face.png
+- spec/support/fixtures/offset_cropped_smiley_face.png
+- spec/support/fixtures/offset_smiley_face.png
+- spec/support/fixtures/smiley_face.png