pdf_matcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b370a574cfb2023ac0f80454d526294e3512c3cfe7f99511b56ccd8489eef97
+  data.tar.gz: 38bfdff05969e7e072775045f2d909f5917f6896f75ecace56f5f936139e78c9
+SHA512:
+  metadata.gz: f0eda7923db1b84f51f4e7588434c24ef2a45adc976c4287e8e63e28fd9050608594a95a94e2d72f9d2f99d887aec54d90435791a2e5b04448774bf675ac2f74
+  data.tar.gz: 3a6c2511fa9c6e5946373ba1765317b437ac8d56adebe5bb22e6f60ed7f6b16f6a404926c799c3a632c9908572fd9457c00e5583f41a251035970f7ac1a9fe36

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Test
+
+on: [push, 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
+
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: hidakatsuya/setup-diff-pdf@v1
+      with:
+        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
+
+    - name: Run Tests
+      run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/pkg/
+/tmp/
+/Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Main (unreleased)
+
+## 1.0.0
+
+The first release. See [README.md](README.md) for detailed instructions.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hidakatsuya@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,18 @@
+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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'test-unit'
+gem 'test-unit-rr'
+gem 'prawn'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Katsuya Hidaka
+
+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,96 @@
+# PdfMatcher
+
+[![Test](https://github.com/hidakatsuya/pdf_matcher/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/hidakatsuya/pdf_matcher/actions/workflows/test.yml)
+
+A gem to compare two PDFs and output the differences using [diff-pdf](https://github.com/vslavik/diff-pdf).
+
+## Prerequisites
+
+This gem requires [diff-pdf](https://github.com/vslavik/diff-pdf). See [the README.md](https://github.com/vslavik/diff-pdf) for how to install it.
+
+Note that you can install it with [hidakatsuya/setup-diff-pdf](https://github.com/hidakatsuya/setup-diff-pdf) in GitHub Action.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_matcher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pdf_matcher
+
+## Usage
+
+```ruby
+require 'pdf_matcher'
+
+PdfMatcher.match?(pdf_a, pdf_b) #=> boolean
+
+PdfMatcher.match?('/path/to/a.pdf', '/path/to/b.pdf') #=> boolean
+PdfMatcher.match?(Pathname('/path/to/a.pdf'), Pathname('/path/to/b.pdf')) #=> boolean
+
+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
+
+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']
+)
+result.matched? #=> boolean
+
+# Returns nil if pdf data is passed, otherwise returns path as Pathname.
+result.pdf1_path #=> Pathname or nil
+result.pdf2_path #=> Pathname or nil
+
+result.pdf1_data #=> "%PDF-..."
+result.pdf2_data #=> "%PDF-..."
+
+# Returns nil if the output_diff parameter is nil.
+result.diff_pdf_path #=> Pathname or nil
+result.diff_pdf_data #=> "%PDF-..." or nil
+
+PdfMatcher.config.diff_pdf_opts = ['--dpi=300']
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/pdf_matcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hidakatsuya/pdf_matcher/blob/master/CODE_OF_CONDUCT.md).
+
+## Testing
+
+```
+$ 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
+
+> src# bundle install
+> src# bundle exec rake test
+```
+
+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"
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PdfMatcher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hidakatsuya/pdf_matcher/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/pdf_matcher.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'pdf_matcher/version'
+require_relative 'pdf_matcher/matcher'
+
+module PdfMatcher
+  Config = Struct.new(
+    # Options for diff-pdf.
+    # It will be applied as the default options when executing diff-pdf. Default is nil.
+    #
+    #     PdfMatcher.config.diff_pdf_opts = ['--dpi=300', '--grayscale']
+    #     PdfMatcher.config.diff_pdf_opts = %w(--dpi=300 --grayscale)
+    #
+    # See `diff-pdf --help` for available options.
+    :diff_pdf_opts
+  )
+  def self.config
+    @config ||= Config.new(nil)
+  end
+
+  def self.match?(pdf1, pdf2, output_diff: nil, diff_pdf_opts: nil)
+    match(pdf1, pdf2, output_diff: output_diff, diff_pdf_opts: diff_pdf_opts).matched?
+  end
+
+  def self.match(pdf1, pdf2, output_diff: nil, diff_pdf_opts: nil)
+    Matcher.new(pdf1, pdf2, output_diff: output_diff, diff_pdf_opts: diff_pdf_opts).match
+  end
+end

data/lib/pdf_matcher/diff_pdf.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module PdfMatcher
+  class DiffPdf
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegator :instance, :exec
+    end
+
+    class CommandNotAvailable < StandardError
+      def initialize
+        super 'pdf_matcher requires diff-pdf command, but it does not seem to be installed. ' \
+              'Please install it and try again.'
+      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}")
+    end
+
+    private
+
+    def verify_available!
+      raise CommandNotAvailable unless system('which diff-pdf > /dev/null 2>&1')
+    end
+
+    def build_options(output_diff, options)
+      (options || []).tap do |opts|
+        opts << "--output-diff=#{output_diff}" if output_diff
+      end
+    end
+  end
+end

data/lib/pdf_matcher/match_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module PdfMatcher
+  class MatchResult < Struct.new(:matched, :pdf1_file, :pdf2_file, :diff_pdf_path)
+    extend Forwardable
+
+    alias :matched? :matched
+
+    def_delegator :pdf1_file, :path, :pdf1_path
+    def_delegator :pdf1_file, :data, :pdf1_data
+    def_delegator :pdf2_file, :path, :pdf2_path
+    def_delegator :pdf2_file, :data, :pdf2_data
+
+    def diff_pdf_data
+      @diff_pdf_data ||= diff_pdf_path&.binread
+    end
+  end
+end

data/lib/pdf_matcher/matcher.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'diff_pdf'
+require_relative 'pdf_file'
+require_relative 'match_result'
+
+module PdfMatcher
+  class Matcher
+    def initialize(pdf1, pdf2, output_diff: nil, diff_pdf_opts: nil)
+      @pdf1 = PdfFile.init(pdf1)
+      @pdf2 = PdfFile.init(pdf2)
+      @output_diff_path = output_diff ? Pathname(output_diff) : nil
+      @diff_pdf_opts = diff_pdf_opts || PdfMatcher.config.diff_pdf_opts
+    end
+
+    def match
+      @result ||= MatchResult.new(match_pdfs, pdf1, pdf2, output_diff_path)
+    end
+
+    private
+
+    attr_reader :pdf1, :pdf2, :output_diff_path, :diff_pdf_opts
+
+    def pdfs
+      @pdfs ||= [pdf1, pdf2]
+    end
+
+    def match_pdfs
+      open_pdf_files do |pdf1_path, pdf2_path|
+        DiffPdf.exec(
+          pdf1_path, pdf2_path,
+          output_diff: output_diff_path,
+          options: diff_pdf_opts
+        )
+      end
+    end
+
+    def open_pdf_files
+      pdfs.each(&:open)
+      yield(pdf1.path, pdf2.path)
+    ensure
+      pdfs.each(&:close)
+    end
+  end
+end

data/lib/pdf_matcher/pdf_file.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module PdfMatcher
+  module PdfFile
+    def self.init(path_or_data)
+      case path_or_data
+      # when a pdf path passed as a Pathname
+      when Pathname
+        File.new(path_or_data)
+      when String
+        # when a pdf data passed
+        if path_or_data =~ /^%PDF-/
+          Tempfile.new(path_or_data)
+        # when a pdf path passed
+        else
+          File.new(path_or_data)
+        end
+      else
+        raise ArgumentError
+      end
+    end
+
+    class Base
+      attr_reader :data, :path
+
+      def initialize(data:, path:)
+        @data = data
+        @path = path
+      end
+
+      def open; end
+      def close; end
+    end
+
+    class File < Base
+      def initialize(path)
+        super(data: nil, path: Pathname(path))
+      end
+
+      def data
+        @data ||= path.binread
+      end
+    end
+
+    class Tempfile < Base
+      def initialize(data)
+        super(data: data, path: nil)
+        @io = nil
+      end
+
+      def open
+        @io ||= ::Tempfile.open { |f| f.puts data; f }
+      end
+
+      def path
+        path = @io&.path
+        path ? Pathname(path) : nil
+      end
+
+      def close
+        @io&.close!
+        @io = nil
+      end
+    end
+  end
+end

data/lib/pdf_matcher/version.rb

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

data/pdf_matcher.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/pdf_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pdf_matcher'
+  spec.version       = PdfMatcher::VERSION
+  spec.authors       = ['Katsuya Hidaka']
+  spec.email         = ['hidakatsuya@gmail.com']
+
+  spec.summary       = 'A gem to compare two PDFs and output the differences using diff-pdf'
+  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.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/hidakatsuya/pdf_matcher/blob/main/CHANGELOG.md'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: pdf_matcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katsuya Hidaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-01 00:00:00.000000000 Z
+dependencies: []
+description: PdfMatcher is a gem to compare two PDFs and output the differences using
+  diff-pdf
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pdf_matcher.rb
+- lib/pdf_matcher/diff_pdf.rb
+- lib/pdf_matcher/match_result.rb
+- lib/pdf_matcher/matcher.rb
+- lib/pdf_matcher/pdf_file.rb
+- lib/pdf_matcher/version.rb
+- pdf_matcher.gemspec
+homepage: https://github.com/hidakatsuya/pdf_matcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hidakatsuya/pdf_matcher
+  source_code_uri: https://github.com/hidakatsuya/pdf_matcher
+  changelog_uri: https://github.com/hidakatsuya/pdf_matcher/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A gem to compare two PDFs and output the differences using diff-pdf
+test_files: []