pdf_matcher 1.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72b513695745c25fe76222180e4696e1f193792bcbe5b414ac7566ca6df67e5
-  data.tar.gz: 7e3733f4f0a62233268d78e539c3bcb122309863aa4d344109668b85f3acdfb5
+  metadata.gz: 4b25a11b945dc8e7518398bde01819aa6c7c938eb55d0a337c2ab96d8a39acd6
+  data.tar.gz: c8bf17486d738bd1860f9aef05130e1c8937ebe7e64f223ac01730c2f5261235
 SHA512:
-  metadata.gz: 19e1830cf927f2674a712036bf180865e2d3b12a1860bf8ee485d18482a21be4be250777dbe45ca349e735b0658317474dbeec0d63f762c12eaadee58bd8b4de
-  data.tar.gz: 314cdaf0e906a8702a03c9dea1c548318b8415adca85904539e46084260b54524b087f6c3e37ba39ee6764cadf8a76f89cd1cf45bf52a39e0a0cf3274e47c24d
+  metadata.gz: f3b37821e911c44dd6fecb67c7a27bff348ad857e34e358f06a26501267a8d5298fd457bbdebb4e7c442fcb6d26f7bdffa9e11adb55154ee7c018a7394696001
+  data.tar.gz: b2b96542029235f9e6a95316660a3faa596477e208d3c082957e35e86bc519197b5ec6988eb3a6f849b4a4137c499696fcd7f1f5e0e91e316f1924db0ee3df4e

data/.github/workflows/test.yml

@@ -12,12 +12,13 @@ jobs:
     strategy:
       matrix:
         ruby_version:
-          - 2.6
-          - 2.7
-          - 3.0
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - uses: hidakatsuya/setup-diff-pdf@v1
       with:
@@ -32,4 +33,4 @@ jobs:
       run: bundle install --jobs 4 --retry 3
 
     - name: Run Tests
-      run: bundle exec rake test
+      run: xvfb-run -a bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 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
+
+- Delete (not keep) the difference PDF when the PDFs are matched [44b05f8](https://github.com/hidakatsuya/pdf_matcher/commit/44b05f8c0df8d2429e3b6c50e2fbb02ed87ee139)
+
 ## 1.0.1
 
 ### Bug Fixes

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
+2.7, 3.0, 3.1, 3.2
 
 ## 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,16 +81,25 @@ result.pdf2_path #=> Pathname or nil
 result.pdf1_data #=> "%PDF-..."
 result.pdf2_data #=> "%PDF-..."
 
-# Returns nil if the output_diff parameter is nil.
+# 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
 
-- [test-unit-pdf_matcher](https://github.com/hidakatsuya/test-unit-pdf_matcher)
+Try [pdf_matcher-testing gem](https://github.com/hidakatsuya/pdf_matcher-testing).
 
 ## Contributing
 
@@ -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/matcher.rb

@@ -14,7 +14,18 @@ module PdfMatcher
     end
 
     def match
-      @result ||= MatchResult.new(match_pdfs, pdf1, pdf2, output_diff_path)
+      @result ||= begin
+        matched = match_pdfs
+
+        if matched
+          # [NOTE] The diff-pdf command will generate a diff PDF file
+          # regardless of the result if the `--output_diff` option is given.
+          output_diff_path.unlink if output_diff_path&.exist?
+          MatchResult.new(matched, pdf1, pdf2, nil)
+        else
+          MatchResult.new(matched, pdf1, pdf2, output_diff_path)
+        end
+      end
     end
 
     private

data/lib/pdf_matcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PdfMatcher
-  VERSION = '1.0.1'
+  VERSION = '2.1.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('>= 2.7.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: 1.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2023-02-12 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,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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