pdf_matcher 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11245a6de1b19f44ca33ac182e325657ac5662696958ff637a63c5a7a0ee50c
-  data.tar.gz: 3ce202dff0306a6fb81f16f83efe2a2fdf64cac597a815eb6713f656e4e1ef99
+  metadata.gz: 3ac5a54cf936002cdbb8fe08c77e9d6efaa9f4ba2f8cad1e923e5d17807634f0
+  data.tar.gz: 564c3f2732ec1f014cc49f8617be731e6c26f19e531b15d848d6c18e20b7653e
 SHA512:
-  metadata.gz: 2ef1a7e18d03c6eb4a3b57777f850866393e0a9be7176e6ba50a33becc1cec9ec077caa2cac5dbc85a18735726984c94a774dd05f6e3ec0d0c72c20a70e89359
-  data.tar.gz: 761a3295ad8795988e97c0ca7dc019b17814f851401dcc0e247e06a588d3d78a1f5c1b6664f8e6eb5ab23fd9812aa1f2a962db839b145dbed368eee88ec5f298
+  metadata.gz: cf3ce95858ca3f4dba1d3f3f6002583a869fc5bf17e92141e2320bbf55d76839cf5603941019636f1932f7b5c7741c6c06ee681f5e6b690d08d50f70c4255c09
+  data.tar.gz: 160fca6ba03dceb3c155c35a7353d0dc70ce0b237195134a8862e763c0e36c0acaeaa6d182641209d6c6041de666b3475cf83e909f00cbfeb8ced13fc17b02ce

data/.github/workflows/test.yml

@@ -1,35 +1,38 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+      - 'dev**'
+  pull_request:
 
 jobs:
   test:
     name: Test on ruby ${{ matrix.ruby_version }}
-    runs-on: ubuntu-latest
 
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:
         ruby_version:
-          - 2.6
-          - 2.7
-          - 3.0
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
-    - uses: hidakatsuya/setup-diff-pdf@v1
+    - uses: hidakatsuya/action-setup-diff-pdf@v1
       with:
-        diff-pdf-version: 0.5
+        diff-pdf-version: '0.5'
 
     - name: Set up Ruby ${{ matrix.ruby_version }}
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
-
-    - name: Install dependencies
-      run: bundle install --jobs 4 --retry 3
+        bundler-cache: true
 
     - name: Run Tests
-      run: bundle exec rake test
+      run: xvfb-run -a bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## main (Unreleased)
+
+## 2.2.0
+
+### Changes
+
+- Drop Ruby2.7 support
+
+## 2.1.0
+
+### Changes
+
+- Drop Ruby 2.6 support
+
+### Bug Fixes
+
+- Fixes an issue where it would appear diff-pdf ran successfully but actually returned an erroneous exit code. Now raises an error if this occurs.
+
 ## 2.0.0
 
 ### Breaking Changes

data/Gemfile

@@ -6,3 +6,4 @@ gem 'rake'
 gem 'test-unit'
 gem 'test-unit-rr'
 gem 'prawn'
+gem 'matrix'

data/README.md

@@ -15,7 +15,7 @@ Note that you can install it with [hidakatsuya/setup-diff-pdf](https://github.co
 
 ### Supported Ruby Versions
 
-2.6, 2.7, 3.0
+3.0, 3.1, 3.2, 3.3
 
 ## Installation
 
@@ -35,22 +35,43 @@ Or install it yourself as:
 
 ## Usage
 
+### PdfMatcher.match?
+
+Returns true if the PDFs match, false otherwise.
+
+```ruby
+PdfMatcher.match?(pdf_a_data, pdf_b_data)
+PdfMatcher.match?('/path/to/a.pdf', '/path/to/b.pdf')
+PdfMatcher.match?(Pathname('/path/to/a.pdf'), Pathname('/path/to/b.pdf'))
+```
+
+#### `output_diff` option:
+
+If the PDFs do not match, a difference PDF file will be generated at the path specified.
+
 ```ruby
-require 'pdf_matcher'
+PdfMatcher.match?(pdf_a_data, pdf_b_data, output_diff: '/path/to/diff.pdf')
+```
 
-PdfMatcher.match?(pdf_a, pdf_b) #=> boolean
+#### `diff_pdf_opts` option:
 
-PdfMatcher.match?('/path/to/a.pdf', '/path/to/b.pdf') #=> boolean
-PdfMatcher.match?(Pathname('/path/to/a.pdf'), Pathname('/path/to/b.pdf')) #=> boolean
+The specified values will be set as options for the `diff-pdf` command.
 
-PdfMatcher.match?(pdf_a, pdf_b, output_diff: '/path/to/diff.pdf') #=> boolean
-PdfMatcher.match?(pdf_a, pdf_b, diff_pdf_opts: ['--dpi=300']) #=> boolean
+```ruby
+PdfMatcher.match?(pdf_a_data, pdf_b_data, diff_pdf_opts: ['--mark-differences', '--dpi=600'])
+```
 
+### PdfMatcher.match
+
+Returns the PDF match result as a `PdfMatcher::MatchResult` object.
+
+```ruby
 result = PdfMatcher.match(
   pdf_a, pdf_b,
-  output_diff: nil,  # or '/path/to/diff.pdf' or Pathname('/path/to/diff.pdf')
-  diff_pdf_opts: nil # or ['--dpi=300']
+  output_diff: nil,
+  diff_pdf_opts: nil
 )
+
 result.matched? #=> boolean
 
 # Returns nil if pdf data is passed, otherwise returns path as Pathname.
@@ -60,13 +81,22 @@ result.pdf2_path #=> Pathname or nil
 result.pdf1_data #=> "%PDF-..."
 result.pdf2_data #=> "%PDF-..."
 
-# Returns nil if the output_diff parameter is nil or the PDFs are matched.
+# Returns nil if the output_diff parameter is nil or the PDFs do not match.
 result.diff_pdf_path #=> Pathname or nil
 result.diff_pdf_data #=> "%PDF-..." or nil
+```
 
-PdfMatcher.config.diff_pdf_opts = ['--dpi=300']
+### Configuring the default options for the diff-pdf command
+
+```ruby
+PdfMatcher.config.diff_pdf_opts = %w(
+  --mark-differences
+  --channel-tolerance=40
+)
 ```
 
+See `diff-pdf --help` for available options of the diff-pdf.
+
 ## Use in Testing Frameworks
 
 Try [pdf_matcher-testing gem](https://github.com/hidakatsuya/pdf_matcher-testing).
@@ -84,8 +114,8 @@ $ bundle exec rake test
 However, this gem requires diff-pdf. You can install it locally or use a docker container.
 
 ```
-$ docker build -t pdf_matcher:latest .
-$ docker run -v $PWD:/src:cached -it pdf_matcher bash
+$ docker pull ghcr.io/hidakatsuya/ruby-with-diff-pdf:3.2
+$ docker run -v $PWD:/src:cached -it ghcr.io/hidakatsuya/ruby-with-diff-pdf bash
 
 > src# bundle install
 > src# bundle exec rake test
@@ -94,7 +124,7 @@ $ docker run -v $PWD:/src:cached -it pdf_matcher bash
 Or, you can run tests instantlly like this:
 
 ```
-$ docker run --rm -v $PWD:/src -it pdf_matcher bash -c "bundle install && bundle exec rake test"
+$ docker run --rm -v $PWD:/src -it ghcr.io/hidakatsuya/ruby-with-diff-pdf bash -c "bundle install && bundle exec rake test"
 ```
 
 

data/lib/pdf_matcher/diff_pdf.rb

@@ -19,12 +19,28 @@ module PdfMatcher
       end
     end
 
+    class UnknownDiffPdfExitCode < StandardError
+      def initialize(code)
+        super "pdf_matcher did not recognize the exit code #{code} from the diff-pdf command, " \
+              'this probably means there is a problem with your installed version of diff-pdf.'
+      end
+    end
+
     def initialize
       verify_available!
     end
 
     def exec(pdf1_path, pdf2_path, output_diff: nil, options: nil)
-      system("diff-pdf #{build_options(output_diff, options).join(' ')} #{pdf1_path} #{pdf2_path}")
+      `diff-pdf #{build_options(output_diff, options).join(' ')} #{pdf1_path} #{pdf2_path} > /dev/null 2>&1`
+
+      case $?.exitstatus
+      when 0
+        true
+      when 1
+        false
+      else
+        raise UnknownDiffPdfExitCode, $?.exitstatus
+      end
     end
 
     private

data/lib/pdf_matcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PdfMatcher
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 end

data/pdf_matcher.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'PdfMatcher is a gem to compare two PDFs and output the differences using diff-pdf'
   spec.homepage      = 'https://github.com/hidakatsuya/pdf_matcher'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_matcher
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies: []
 description: PdfMatcher is a gem to compare two PDFs and output the differences using
   diff-pdf
@@ -22,7 +22,6 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -49,14 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: A gem to compare two PDFs and output the differences using diff-pdf

data/Dockerfile

@@ -1,18 +0,0 @@
-FROM ruby:3.0.1
-
-RUN apt-get update -qq && apt-get install -y build-essential xvfb
-
-WORKDIR /tmp
-
-RUN apt-get install -y libpoppler-glib-dev poppler-utils libwxgtk3.0-dev && \
-  curl -L https://github.com/vslavik/diff-pdf/archive/master.tar.gz -o diff-pdf-master.tar.gz && \
-  tar zxf diff-pdf-master.tar.gz && \
-  cd diff-pdf-master && \
-  ./bootstrap && \
-  ./configure && \
-  make && make install
-
-RUN mkdir /src
-
-WORKDIR /src
-VOLUME /src