chrome_diff 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63efaa6953d427032ff166c99839064311cfd6d7febbc34b66ec377975f1e991
-  data.tar.gz: a46a9b426140b30d78b14a3093ef6c4df5a4ce445e13d76477f8f8ffafb21005
+  metadata.gz: 3327e0ea798894487c578c34d28051b76114b70b7e5ee252bf64198b05ba8648
+  data.tar.gz: 768b97a67bf46f6605f7326ab55c49cb74ae3b7a6865f977f3d9d9b23e5b9ba8
 SHA512:
-  metadata.gz: 16a7ab5574bbf3a177b47a796d82fedcfbfbd81eeea47a9064eda41d654b901099c3f999e546070b1fb1c61f7be27d9cb93254324a8fd34a77ba6d9a6860f990
-  data.tar.gz: 5da408f12b623dc122ec685dd48982323243edc3ef9c8d628b6299606a424cf404ef743f7e4374f53fa6bccd27cfeb5e69b08722490977898f5830361c3607d6
+  metadata.gz: 75d32c8b2be65dde34e8fb5b586cc7da1e905d043b4a0fa85c11b85bd6578593226558a2ed03e586d6e66facd2761bf65a46baf60acf01b7c7ce2f3e2c81dd86
+  data.tar.gz: 3e7ca23b4f697b5a837adc18fc2e9c2a7ab2721de07146350c145e216830087787955408650d134212c6a81df09d5f59e20cf47a9b6d315f920fb90f775df614

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install dependencies with cache
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run tests
+      run: bundle exec rspec

data/README.md

@@ -1,7 +1,10 @@
 # ChromeDiff
+[![Gem Version](https://badge.fury.io/rb/chrome_diff.svg)](https://badge.fury.io/rb/chrome_diff)
 
 Visual diff tool powered by headless chrome.
 
+This tool controls Chrome by [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) based on [Ferrum](https://github.com/rubycdp/ferrum).
+
 ## Installation
 
 ```console
@@ -14,11 +17,52 @@ $ gem install chrome_diff
 
 ## Usage
 
+### Command-line
 ```console
 $ chrome-diff -f "https://google.com/?q=hello" -t "https://google.com/?q=world"
 There are some diffefences (1.44%): diff.png
 ```
 
+#### Options
+
+```console
+Usage: chrome-diff [options]
+    -f, --from-url [FROM_URL]        From url
+    -t, --to-url [TO_URL]            To url
+    -o, --output [OUTPUT]            Output file
+    -w, --width [WIDTH]              Window width (default 800)
+    -h, --height [HEIGHT]            Window height (default 600)
+    -q, --quiet                      Quiet mode
+        --threshold [THRESHOLD]      Threshold percent (default 1%)
+        --debug                      Debug mode (default false)
+        --no-output                  Don't output diff file
+        --full-screenshot            Capture full screenshot
+```
+
+### As library
+
+```ruby
+session = ChromeDiff::Session.new
+session.compare("https://example.com/", "https://www.google.com/")
+```
+
+#### Customize
+
+```ruby
+session = ChromeDiff::Session.new(width: 800, height: 600, timeout: 5, debug: false)
+session.compare(from_url: from_url, to_url: to_url, output: "diff.png", threshold: 1, full_screenshot: false)
+```
+
+- `width`: window width (default 800px)
+- `height`: window height (default 600px)
+- `timeout`: browser timeout (default 5 seconds)
+- `debug`: debug mode (default false)
+- `from_url`: from url (required)
+- `to_url`: to url (required)
+- `output`: output diff image (default diff.png)
+- `threshold`: threshold percent (default 1%)
+- `full_screenshot`: take full screenshot (default false) 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hogelog/chrome_diff.

data/lib/chrome_diff.rb

@@ -10,7 +10,7 @@ module ChromeDiff
     output: "diff.png",
     width: 800,
     height: 600,
-    fuzz: 1,
+    threshold: 1,
     timeout: 5,
   }
 

data/lib/chrome_diff/cli.rb

@@ -29,7 +29,7 @@ module ChromeDiff
       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("--threshold [THRESHOLD]", "Threshold percent (default 1%)") {|v| opts[:threshold] = 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 }

data/lib/chrome_diff/session.rb

@@ -9,16 +9,16 @@ module ChromeDiff
   class CompareStatus
     attr_reader :status, :diff, :diff_percent
 
-    def initialize(status, stderr, width, height, fuzz)
+    def initialize(status, stderr, width, height, threshold)
       @status = status
-      @fuzz = fuzz
+      @threshold = threshold
 
       @diff = stderr.to_f.to_i
       @diff_percent = @diff.to_f / width / height * 100
     end
 
     def success?
-      @diff_percent <= @fuzz
+      @diff_percent <= @threshold
     end
   end
 
@@ -47,8 +47,8 @@ module ChromeDiff
       @browser.resize(width: @width, height: @height)
     end
 
-    def compare(from_url:, to_url:, output:, fuzz: nil, full_screenshot: nil)
-      fuzz ||= ChromeDiff::DEFAULT_OPTIONS[:fuzz]
+    def compare(from_url:, to_url:, output:, threshold: nil, full_screenshot: nil)
+      threshold ||= ChromeDiff::DEFAULT_OPTIONS[:threshold]
       result = nil
       Dir.mktmpdir do |tmpdir|
         from_file = File.join(tmpdir, "from.png")
@@ -59,7 +59,7 @@ module ChromeDiff
         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)
+        result = CompareStatus.new(status, stderr, @width, @height, threshold)
 
         File.rename(diff_file, output) if output
       end

data/lib/chrome_diff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chrome_diff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hogelog
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-31 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ferrum
@@ -74,6 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".keep"
 - ".rspec"