pdf_matcher-testing 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1180934421898ae4c82ed36fdaeb5b1be6d17463e0b7aff3ded1e975a364c59d
+  data.tar.gz: 65694222ad05b8e5ea9c8a0ce093be916b2a22be843f0e6922b46e8df04063b5
+SHA512:
+  metadata.gz: d7d862a85f7d4b2018ced2dd13a919c6273d116403db6ded9268be800fe2c42a08c52d0847e9de96e00fbf3c27d025d7cd0beb68c7b49d1f14be465de32987d5
+  data.tar.gz: 8463c6623b18a2e97a3e9313fb36d2e0a8ed838052f0550ff4653f06c53bdef4317f73386c55b796e35f4773ab61957f29005b928edfa06ffc2aa9db99a30c33

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,3 @@
+## 1.0.0
+
+The first stable release.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'minitest'
+gem 'test-unit'
+gem 'rspec'
+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,144 @@
+# PdfMatcher::Testing
+
+[![Test](https://github.com/hidakatsuya/pdf_matcher-testing/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/hidakatsuya/pdf_matcher-testing/actions/workflows/test.yml)
+
+This gem allows testing frameworks such as [Test::Unit](https://github.com/test-unit/test-unit), [RSpec](https://github.com/rspec/rspec) and [Minitest](https://github.com/seattlerb/minitest) to perform PDF matching tests with the [pdf_matcher gem](https://github.com/hidakatsuya/pdf_matcher).
+
+## Prerequisites
+
+This gem works with diff-pdf and pdf_matcher gem. See [the documentation of the pdf_matcher gem](https://github.com/hidakatsuya/pdf_matcher#prerequisites).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_matcher-testing', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pdf_matcher-testing
+
+## Usage
+
+### Test::Unit
+
+```ruby
+require 'pdf_matcher/testing/test_unit_adapter'
+```
+
+You will be able to use the `assert_match_pdf`:
+
+```ruby
+assert_match_pdf expected_pdf_data, actual_pdf_data
+assert_match_pdf '/path/to/expected.pdf', '/path/to/actual.pdf'
+assert_match_pdf Pathname('/path/to/expected.pdf'), Pathname('/path/to/actual.pdf')
+
+# Generating a difference PDF
+assert_match_pdf expected_pdf_data, actual_pdf_data, output_diff: '/path/to/diff.pdf'
+```
+
+Or, you can enable the assertion manually:
+
+```ruby
+require 'pdf_matcher/testing/assertion'
+
+# Enabling globally
+class Test::Unit::TestCase
+  include PdfMatcher::Testing::Assertion
+end
+
+# Enabling individually
+class FooTest < Test::Unit::TestCase
+  include PdfMatcher::Testing::Assertion
+end
+```
+
+### Minitest
+
+```ruby
+require 'pdf_matcher/testing/minitest_adapter'
+```
+
+You will be able to use the `assert_match_pdf` and the `must_match_pdf`:
+
+Assertion:
+```ruby
+assert_match_pdf expected_pdf_data, actual_pdf_data
+```
+
+Expectation:
+```ruby
+expect(actual_pdf_data).to must_match_pdf(expected_pdf_data)
+expect('/path/to/actual.pdf').to must_match_pdf('/path/to/expected.pdf')
+expect(Pathname('/path/to/actual.pdf')).to must_match_pdf(Pathname('/path/to/expected.pdf'))
+
+# Generating a difference PDF
+expect(actual_pdf_data).to must_match_pdf(expected_pdf_data, output_diff: '/path/to/diff.pdf')
+```
+
+Or, you can setup the assertion manually as described in Test::Unit.
+
+### RSpec
+
+```ruby
+require 'pdf_matcher/testing/rspec_adapter'
+```
+
+You will be able to use the `match_pdf`:
+
+```ruby
+expect(actual_pdf_data).to match_pdf(expected_pdf_data)
+expect('/path/to/actual.pdf').to match_pdf('/path/to/expected.pdf')
+expect(Pathname('/path/to/actual.pdf')).to match_pdf(Pathname('/path/to/expected.pdf'))
+
+# Generating a differnce PDF
+expect(actual_pdf_data).to match_pdf(expected_pdf_data, output_diff: '/path/to/diff.pdf')
+```
+
+Or, you can enable the matcher manually:
+
+```ruby
+require 'pdf_matcher/testing/matcher'
+
+# Enabling globally
+RSpec.configure do |config|
+  config.include PdfMatcher::Testing::Matcher
+end
+
+# Enabling individually
+RSpec.describe 'foo' do
+  include PdfMatcher::Testing::Matcher
+end
+```
+
+### Configuring diff-pdf command options
+
+```ruby
+PdfMatcher.config.diff_pdf_opts = %w(
+  --mark-differences
+  --channel-tolerance=40
+)
+```
+
+See `diff-pdf --help` for the available diff-pdf options.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/pdf_matcher-testing.
+
+## Testing
+
+```
+$ 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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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', 'test/**/*_spec.rb']
+end
+
+task :default => :test

data/lib/pdf_matcher/testing/assertion.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pdf_matcher'
+require_relative 'failure_message'
+
+module PdfMatcher
+  module Testing
+    module Assertion
+      def assert_match_pdf(expected_pdf, actual_pdf, options = nil)
+        output_diff = options&.fetch(:output_diff)
+        failure_message = FailureMessage.build(output_diff)
+
+        assert PdfMatcher.match?(expected_pdf, actual_pdf, output_diff: output_diff), failure_message
+      end
+    end
+  end
+end

data/lib/pdf_matcher/testing/failure_message.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PdfMatcher
+  module Testing
+    module FailureMessage
+      BASE_MESSAGE = 'The PDF contents did not match.'
+
+      module_function
+
+      def build(output_diff = nil)
+        [BASE_MESSAGE, message_for_checking_output_diff(output_diff)].compact.join(' ')
+      end
+
+      def message_for_checking_output_diff(output_diff)
+        output_diff ? "Check #{output_diff} for details of the differences." : nil
+      end
+    end
+  end
+end

data/lib/pdf_matcher/testing/matcher.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pdf_matcher'
+require_relative 'failure_message'
+
+module PdfMatcher
+  module Testing
+    module Matcher
+      def match_pdf(expected_pdf, output_diff: nil)
+        MatchPdf.new(expected_pdf, output_diff)
+      end
+
+      class MatchPdf
+        include ::RSpec::Matchers::Composable
+
+        def initialize(expected_pdf, output_diff)
+          @expected_pdf = expected_pdf
+          @output_diff = output_diff
+        end
+
+        def matches?(actual_pdf)
+          PdfMatcher.match?(@expected_pdf, actual_pdf, output_diff: @output_diff)
+        end
+
+        def failure_message
+          FailureMessage.build(@output_diff)
+        end
+
+        def description
+          'match the expected pdf'
+        end
+      end
+    end
+  end
+end

data/lib/pdf_matcher/testing/minitest_adapter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'minitest'
+require_relative 'assertion'
+
+module Minitest
+  class Test
+    include PdfMatcher::Testing::Assertion
+  end
+
+  module Expectations
+    infect_an_assertion :assert_match_pdf, :must_match_pdf
+  end
+end

data/lib/pdf_matcher/testing/rspec_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec'
+
+require_relative 'matcher'
+
+RSpec.configure do |c|
+  c.include PdfMatcher::Testing::Matcher
+end

data/lib/pdf_matcher/testing/test_unit_adapter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+require_relative 'assertion'
+
+module Test
+  module Unit
+    TestCase.include PdfMatcher::Testing::Assertion
+  end
+end

data/lib/pdf_matcher/testing/version.rb

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

data/pdf_matcher-testing.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/pdf_matcher/testing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pdf_matcher-testing'
+  spec.version       = PdfMatcher::Testing::VERSION
+  spec.authors       = ['Katsuya Hidaka']
+  spec.email         = ['hidakatsuya@gmail.com']
+
+  spec.description   = 'This gem allows testing frameworks such as Test::Unit, RSpec and Minitest to perform PDF matching tests with the pdf_matcher gem.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/hidakatsuya/pdf_matcher-testing'
+  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-testing/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']
+
+  spec.add_dependency 'pdf_matcher', '>= 1.0.0'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: pdf_matcher-testing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katsuya Hidaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdf_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: This gem allows testing frameworks such as Test::Unit, RSpec and Minitest
+  to perform PDF matching tests with the pdf_matcher gem.
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pdf_matcher/testing/assertion.rb
+- lib/pdf_matcher/testing/failure_message.rb
+- lib/pdf_matcher/testing/matcher.rb
+- lib/pdf_matcher/testing/minitest_adapter.rb
+- lib/pdf_matcher/testing/rspec_adapter.rb
+- lib/pdf_matcher/testing/test_unit_adapter.rb
+- lib/pdf_matcher/testing/version.rb
+- pdf_matcher-testing.gemspec
+homepage: https://github.com/hidakatsuya/pdf_matcher-testing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hidakatsuya/pdf_matcher-testing
+  source_code_uri: https://github.com/hidakatsuya/pdf_matcher-testing
+  changelog_uri: https://github.com/hidakatsuya/pdf_matcher-testing/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: This gem allows testing frameworks such as Test::Unit, RSpec and Minitest
+  to perform PDF matching tests with the pdf_matcher gem.
+test_files: []