chrome_diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63efaa6953d427032ff166c99839064311cfd6d7febbc34b66ec377975f1e991
+  data.tar.gz: a46a9b426140b30d78b14a3093ef6c4df5a4ce445e13d76477f8f8ffafb21005
+SHA512:
+  metadata.gz: 16a7ab5574bbf3a177b47a796d82fedcfbfbd81eeea47a9064eda41d654b901099c3f999e546070b1fb1c61f7be27d9cb93254324a8fd34a77ba6d9a6860f990
+  data.tar.gz: 5da408f12b623dc122ec685dd48982323243edc3ef9c8d628b6299606a424cf404ef743f7e4374f53fa6bccd27cfeb5e69b08722490977898f5830361c3607d6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 1.17.1

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 chrome_diff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 hogelog
+
+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,28 @@
+# ChromeDiff
+
+Visual diff tool powered by headless chrome.
+
+## Installation
+
+```console
+$ gem install chrome_diff
+```
+
+## Requirements
+- Google Chrome (or Chromium)
+- ImageMagick
+
+## Usage
+
+```console
+$ chrome-diff -f "https://google.com/?q=hello" -t "https://google.com/?q=world"
+There are some diffefences (1.44%): diff.png
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hogelog/chrome_diff.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "chrome_diff"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/chrome_diff.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chrome_diff/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chrome_diff"
+  spec.version       = ChromeDiff::VERSION
+  spec.authors       = ["hogelog"]
+  spec.email         = ["konbu.komuro@gmail.com"]
+
+  spec.summary       = %q{Generate visual diff by chrome.}
+  spec.homepage      = "https://github.com/hogelog/chrome_diff"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "ferrum", "< 1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "< 4.0"
+end

data/exe/chrome-diff

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "chrome_diff"
+
+result = ChromeDiff::CLI.run(ARGV)
+
+exit(result.success? ? 0 : 1)

data/lib/chrome_diff.rb

@@ -0,0 +1,30 @@
+require "chrome_diff/version"
+require "chrome_diff/cli"
+require "chrome_diff/session"
+require "chrome_diff/site_checker"
+
+module ChromeDiff
+  class Error < StandardError; end
+
+  DEFAULT_OPTIONS = {
+    output: "diff.png",
+    width: 800,
+    height: 600,
+    fuzz: 1,
+    timeout: 5,
+  }
+
+  def self.run(**args)
+    width = args.delete(:width)
+    height = args.delete(:height)
+    timeout = args.delete(:timeout)
+    debug = args.delete(:debug)
+
+    begin
+      session = ChromeDiff::Session.new(width: width, height: height, timeout: timeout, debug: debug)
+      session.compare(**args)
+    ensure
+      session.browser&.quit
+    end
+  end
+end

data/lib/chrome_diff/cli.rb

@@ -0,0 +1,53 @@
+require "optparse"
+
+module ChromeDiff
+  class CLI
+    def self.run(argv)
+      opts = ChromeDiff::DEFAULT_OPTIONS.merge(parse_argv(argv.dup))
+      result = ChromeDiff.run(**opts)
+      output = opts[:output]
+
+      unless opts[:quiet]
+        if result.success?
+          message = "There is no difference (%.2f%%)" % result.diff_percent
+        else
+          message = "There are some diffefences (%.2f%%)" % result.diff_percent
+        end
+        message += ": #{output}" if output
+        puts message
+      end
+
+      result
+    end
+
+    def self.parse_argv(argv)
+      opts = {}
+      parser = OptionParser.new
+      parser.on("-f [FROM_URL]", "--from-url", "From url") {|v| opts[:from_url] = v }
+      parser.on("-t [TO_URL]", "--to-url", "To url") {|v| opts[:to_url] = v }
+      parser.on("-o [OUTPUT]", "--output", "Output file") {|v| opts[:output] = v }
+      parser.on("-w [WIDTH]", "--width", "Window width (default 800)") {|v| opts[:width] = v.to_i }
+      parser.on("-h [HEIGHT]", "--height", "Window height (default 600)") {|v| opts[:height] = v.to_i }
+      parser.on("-q", "--quiet", "Quiet mode") {|v| opts[:quiet] = v }
+      parser.on("--fuzz [FUZZ]", "Fuzz factor percent (default 5%)") {|v| opts[:fuzz] = v.to_f }
+      parser.on("--debug", "Debug mode (default false)") {|v| opts[:debug] = !!v }
+      parser.on("--no-output", "Don't output diff file") {|v| opts[:output] = v }
+      parser.on("--full-screenshot", "Capture full screenshot") {|v| opts[:full_screenshot] = !!v }
+      parser.parse(argv)
+
+      required(opts, :from_url)
+      required(opts, :to_url)
+
+      opts
+    rescue ArgumentError => e
+      STDERR.puts(e.message)
+      puts(parser.help)
+      exit 1
+    end
+
+    def self.required(opts, key)
+      arg_key = "--#{key.to_s.gsub("_", "-")}"
+      opts[key] or raise ArgumentError, "#{arg_key} is required"
+    end
+  end
+end

data/lib/chrome_diff/session.rb

@@ -0,0 +1,86 @@
+require "ferrum"
+
+require "fileutils"
+require "tmpdir"
+require "open3"
+require "logger"
+
+module ChromeDiff
+  class CompareStatus
+    attr_reader :status, :diff, :diff_percent
+
+    def initialize(status, stderr, width, height, fuzz)
+      @status = status
+      @fuzz = fuzz
+
+      @diff = stderr.to_f.to_i
+      @diff_percent = @diff.to_f / width / height * 100
+    end
+
+    def success?
+      @diff_percent <= @fuzz
+    end
+  end
+
+  class Session
+    attr_reader :browser
+
+    def initialize(width: nil, height: nil, timeout: nil, debug: false)
+      @width = width || ChromeDiff::DEFAULT_OPTIONS[:width]
+      @height = height || ChromeDiff::DEFAULT_OPTIONS[:height]
+      @timeout = timeout || ChromeDiff::DEFAULT_OPTIONS[:timeout]
+      @debug = debug
+      options = {
+        window_size: [@width, @height],
+        timeout: @timeout,
+        browser_options: {
+          "device-scale-factor" => 1,
+          "force-device-scale-factor" => nil,
+        },
+      }
+      if @debug
+        options[:logger] = STDOUT
+        options[:headless] = false
+      end
+
+      @browser = Ferrum::Browser.new(options)
+      @browser.resize(width: @width, height: @height)
+    end
+
+    def compare(from_url:, to_url:, output:, fuzz: nil, full_screenshot: nil)
+      fuzz ||= ChromeDiff::DEFAULT_OPTIONS[:fuzz]
+      result = nil
+      Dir.mktmpdir do |tmpdir|
+        from_file = File.join(tmpdir, "from.png")
+        to_file = File.join(tmpdir, "to.png")
+        diff_file = File.join(tmpdir, "diff.png")
+
+        screenshot(from_url, from_file, full_screenshot)
+        screenshot(to_url, to_file, full_screenshot)
+
+        _stdout, stderr, status =  Open3.capture3("compare", "-metric", "AE", from_file, to_file, diff_file)
+        result = CompareStatus.new(status, stderr, @width, @height, fuzz)
+
+        File.rename(diff_file, output) if output
+      end
+
+      result
+    end
+
+    def screenshot(url, file, full)
+      @browser.goto(url)
+      wait_complete
+      @browser.resize(width: @width, height: @height)
+      @browser.screenshot(path: file, full: full)
+    end
+
+    def wait_complete
+      @browser.network.wait_for_idle
+      Timeout.timeout(@timeout) do
+        until @browser.page.evaluate('document.readyState') == "complete"
+          sleep 0.1
+        end
+      end
+    end
+  end
+end

data/lib/chrome_diff/site_checker.rb

@@ -0,0 +1,55 @@
+require "fileutils"
+
+module ChromeDiff
+  class SiteChecker
+    def initialize(domains:, sizes:, paths:, options: {})
+      @domains = domains
+      @sizes = sizes
+      @paths = paths
+      @options = options
+    end
+
+    def run
+      options = @options.dup
+      @sizes.each do |size|
+        shots_dir = File.join("shots", size.map(&:to_s).join("x"))
+        FileUtils.mkdir_p(shots_dir)
+
+        options.merge()
+        timeout = options.delete(:timeout)
+        debug = options.delete(:debug) || false
+        session = ChromeDiff::Session.new(width: size[0], height: size[1], timeout: timeout, debug: debug)
+
+        html = ""
+        images = []
+        @paths.each do |name, path|
+          from = "#{@domains[0]}#{path}"
+          to = "#{@domains[1]}#{path}"
+          filename = "#{name}.png"
+          output = File.join(shots_dir, filename)
+          result = session.compare(from_url: from, to_url: to, output: output)
+          puts "#{output} (%.2f%%)" % result.diff_percent
+
+          title = "#{filename} (%.2f%%)" % result.diff_percent
+          images << [name, title]
+          html += <<~HTML
+            <h2 id="#{ name }">#{ title }</h2>
+            <ul>
+              <li><a href="#{from}">#{from}</a></li>
+              <li><a href="#{to}">#{to}</a></li>
+              <li>
+                <a href="#{ filename }">
+                  <img src="#{ filename }">
+                </a>
+              </li>
+            </ul>
+          HTML
+        end
+
+        html = "<ul>\n" + images.map{|name, title| "<li><a href='##{ name }'>#{ title }</a></li>"}.join("\n") + "</ul>\n\n" + html
+
+        File.write(File.join(shots_dir, "index.html"), html)
+      end
+    end
+  end
+end

data/lib/chrome_diff/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: chrome_diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hogelog
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ferrum
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description:
+email:
+- konbu.komuro@gmail.com
+executables:
+- chrome-diff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".keep"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- chrome_diff.gemspec
+- exe/chrome-diff
+- lib/chrome_diff.rb
+- lib/chrome_diff/cli.rb
+- lib/chrome_diff/session.rb
+- lib/chrome_diff/site_checker.rb
+- lib/chrome_diff/version.rb
+homepage: https://github.com/hogelog/chrome_diff
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Generate visual diff by chrome.
+test_files: []