test-unit-pdf_matcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81e35e02fd41985e231e0e937e5588310c991af07ceb5605d2c0da9a56610a40
+  data.tar.gz: 68db090d3becde960d1f283871944e57cd3b6c83c5ad315b2b3c69269a341859
+SHA512:
+  metadata.gz: d66e57f8691eac3e88b97fcea5830d57ea5f1bbc8ad95c2f40009065cfa223c0255f3a5c7400114bbd1faf1ff225b464b2c4f0a545d04463212b045522236030
+  data.tar.gz: e511af2e44af1d856f7c9ee6a22cda7cae9b11faad8079cc3fe9cc9014e2494a07c7afdc3942c8716853d8af7f3dc8695ae8161a435a091b90bd62e8f47c62d1

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/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+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,59 @@
+# Test::Unit::PdfMatcher
+
+[![Test](https://github.com/hidakatsuya/test-unit-pdf_matcher/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/hidakatsuya/test-unit-pdf_matcher/actions/workflows/test.yml)
+
+This gem provides `assert_match_pdf` assertion by [PdfMatcher](https://github.com/hidakatsuya/pdf_matcher) to Test::Unit.
+
+## Prerequisites
+
+This gem requires `diff-pdf`. See [the documentation of PdfMatcher](https://github.com/hidakatsuya/pdf_matcher#prerequisites) for details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'test-unit-pdf_matcher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install test-unit-pdf_matcher
+
+## Usage
+
+Add this line to your `test_helper.rb`:
+
+```ruby
+require 'test/unit/pdf_matcher`
+```
+
+### assert_match_pdf
+
+```ruby
+assert_match_pdf pdf1_data, pdf2_data
+assert_match_pdf '/path/to/1.pdf', '/path/to/2.pdf'
+assert_match_pdf Pathnae('/path/to/1.pdf'), Pathname('/path/to/2.pdf')
+```
+
+You can generate a difference PDF by `output_diff_path` option:
+
+```ruby
+assert_match_pdf pdf1_data, pdf2_data, output_diff_path: '/path/to/diff.pdf'
+```
+
+### Configuring diff-pdf command options
+
+```ruby
+::PdfMatcher.config.diff_pdf_opts = %w(--dpi=300 --grayscale)
+```
+
+See `diff-pdf --help` for the available diff-pdf options.
+
+## 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,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/test/unit/pdf_matcher.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require_relative 'pdf_matcher/version'
+require_relative 'pdf_matcher/assertions'
+
+module Test
+  module Unit
+    TestCase.include PdfMatcher::Assertions
+  end
+end

data/lib/test/unit/pdf_matcher/assertions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'pdf_matcher'
+
+module Test
+  module Unit
+    module PdfMatcher
+      module Assertions
+        # Passes if PdfMatcher.match?(`expected_pdf`, `actual_pdf`).
+        # See https://github.com/hidakatsuya/pdf_matcher for details about PdfMatcher.
+        #
+        # @example
+        #   assert_match_pdf pdf1_data, pdf2_data, output_diff_path: '/path/to/diff.pdf'
+        #   assert_match_pdf '/path/to/1.pdf', '/path/to/2.pdf'
+        #   assert_match_pdf Pathname('/path/to/1.pdf'), Pathname('/path/to/2.pdf')
+        #
+        def assert_match_pdf(expected_pdf, actual_pdf, output_diff_path: nil)
+          full_messages = ['The PDF contents did not match.'].tap { |msgs|
+            msgs << "Check #{output_diff_path} for details of the differences." if output_diff_path
+          }
+          assert_block(full_messages.join(' ')) do
+            ::PdfMatcher.match?(expected_pdf, actual_pdf, output_diff: output_diff_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/pdf_matcher/version.rb

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

data/test-unit-pdf_matcher.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/test/unit/pdf_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'test-unit-pdf_matcher'
+  spec.version       = Test::Unit::PdfMatcher::VERSION
+  spec.authors       = ['Katsuya Hidaka']
+  spec.email         = ['hidakatsuya@gmail.com']
+
+  spec.summary       = 'PdfMatcher for Test::Unit'
+  spec.description   = 'This gem provides assert_match_pdf assertion by PdfMatcher to Test::Unit.'
+  spec.homepage      = 'https://github.com/hidakatsuya/pdf_matcher-test_adapters/test-unit-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.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'
+  spec.add_dependency 'test-unit', '>= 3.4.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: test-unit-pdf_matcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katsuya Hidaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-03 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
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: This gem provides assert_match_pdf assertion by PdfMatcher to Test::Unit.
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/test/unit/pdf_matcher.rb
+- lib/test/unit/pdf_matcher/assertions.rb
+- lib/test/unit/pdf_matcher/version.rb
+- test-unit-pdf_matcher.gemspec
+homepage: https://github.com/hidakatsuya/pdf_matcher-test_adapters/test-unit-pdf_matcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hidakatsuya/pdf_matcher-test_adapters/test-unit-pdf_matcher
+  source_code_uri: https://github.com/hidakatsuya/pdf_matcher-test_adapters/test-unit-pdf_matcher
+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: PdfMatcher for Test::Unit
+test_files: []