Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hidakatsuya/pdf_matcher-testing
This gem allows testing frameworks such as Test::Unit, RSpec and Minitest to perform PDF matching tests with the pdf_matcher gem.
https://github.com/hidakatsuya/pdf_matcher-testing
minitest pdf rspec test-unit
Last synced: 22 days ago
JSON representation
This gem allows testing frameworks such as Test::Unit, RSpec and Minitest to perform PDF matching tests with the pdf_matcher gem.
- Host: GitHub
- URL: https://github.com/hidakatsuya/pdf_matcher-testing
- Owner: hidakatsuya
- License: mit
- Created: 2021-05-08T06:30:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-30T14:38:44.000Z (about 1 year ago)
- Last Synced: 2024-12-17T04:56:46.555Z (25 days ago)
- Topics: minitest, pdf, rspec, test-unit
- Language: Ruby
- Homepage: https://rubygems.org/gems/pdf_matcher-testing
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PdfMatcher::Testing
[](https://badge.fury.io/rb/pdf_matcher-testing)
[](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
_(actual_pdf_data).must_match_pdf(expected_pdf_data)
_('/path/to/actual.pdf').must_match_pdf('/path/to/expected.pdf')
_(Pathname('/path/to/actual.pdf')).must_match_pdf(Pathname('/path/to/expected.pdf'))
# Generating a difference PDF
_(actual_pdf_data).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).