pdf_spec 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01b0301bfd2cdbf3764c61e5f3ca1158371710c5
+  data.tar.gz: 691e9d263d47ab13a08c35808b6b9fc62c364ba4
+SHA512:
+  metadata.gz: 4dd4ba4eef8400c6f1352ffe3f5caa1d049c0ce48518cbb703bc7e815cd25be15cca3baa0454ad6f5aae46bab6f40f8d33c41f598916ba13ba93658888c2eeac
+  data.tar.gz: bc130fc88ef5a3a9943cca719a2d11cee02c6a14ea84d9a9a36310eadbaeea8fb69d26aa0ddea525d3e3b8313562593edf549222106bfe2b789a0ae64a1e168d

data/.gitignore

@@ -0,0 +1,6 @@
+.yardoc/*
+
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.ruby-gemset

@@ -0,0 +1 @@
+pdf_spec

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pdf_spec.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 TMXCredit, authors Zach Belzer, Sergey Potapov
+
+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,55 @@
+PdfSpec
+-------
+
+PdfSpec includes rspec matchers to compare the appearance of PDF files.
+This is obviously most useful when you need to verify that you can produce
+a PDF that looks identical to a sample PDF file.
+
+# Installation
+
+This library depends on the `rmagick` ruby gem.
+
+## Homebrew
+
+    brew install imagemagick
+    brew install ghostscript
+
+## MacPorts
+    sudo port install ImageMagick
+
+## Debian (Ubuntu)
+
+The following was tested on Ubuntu 11.10 and 12.04.
+
+    sudo apt-get install libmagickwand-dev
+
+## (TODO) Gentoo
+
+    # Install libmagickwand
+
+# Use
+
+To use the matchers in your tests, simple include the Matchers module into RSpec:
+
+    RSpec.configure do |config|
+      config.include(PdfSpec::Matchers)
+    end
+
+Or include it in certain tests:
+
+    describe "Testing PDFs" do
+      include PdfSpec::Matchers
+
+      it "should match..."; end
+    end
+
+Matchers contains the `have_same_pdf_appearance_as` expectation which will render
+out PDF files to pixel buffers in memory and then compare them pixel by pixel.
+
+
+    it "should be the same PDF" do
+      source_pdf = File.read("path/to/source")
+      expected_pdf = File.read("path/to/expected")
+
+      source.should have_same_pdf_appearance_as(expected_pdf)
+    end

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/pdf_spec.rb

@@ -0,0 +1,7 @@
+require 'RMagick'
+
+require 'tempfile'
+
+require "pdf_spec/version"
+require "pdf_spec/matchers"
+

data/lib/pdf_spec/matchers.rb

@@ -0,0 +1,48 @@
+module PdfSpec # :nodoc:
+  module Matchers # :nodoc:
+    # Class that conforms to RSpec specifications for matchers
+    #
+    # @param [String] pdf_data PDF content as a Ruby string
+    class IdenticalPdfs
+      def initialize(pdf_data)
+        @expected_pages = pdf_to_pixel_pages(pdf_data)
+      end
+
+      # Compares given PDF data against
+      #
+      # @param [String] pdf_data PDF content as a Ruby string
+      def matches?(pdf_data)
+        @target_pages = pdf_to_pixel_pages(pdf_data)
+        @target_pages == @expected_pages
+      end
+
+      def failure_message # :nodoc:
+        "expected #{@target_pages.inspect} to look the same as #{@expected_pages.inspect}"
+      end
+
+      def negative_failure_message # :nodoc:
+        "expected #{@target_pages.inspect} not to look the same as #{@expected_pages.inspect}"
+      end
+
+      # Get array of page pixels. The first level array represents PDF pages,
+      # the second level array - pixels.
+      #
+      # @param [String] pdf_data binary string that represents pdf
+      #
+      # @return [Array<Array<Integer>>] array of arrays of pixels
+      def pdf_to_pixel_pages(pdf_data)
+        Magick::ImageList.new.
+          from_blob(pdf_data).
+          remap { |page| page.export_pixels }
+      end
+      private :pdf_to_pixel_pages
+    end
+
+    # Compares the pixel by pixel appearance of two strings of PDF data
+    #
+    # @param [String] expected The expected PDF file contents
+    def have_same_pdf_appearance_as(expected)
+      IdenticalPdfs.new(expected)
+    end
+  end
+end

data/lib/pdf_spec/version.rb

@@ -0,0 +1,3 @@
+module PdfSpec # :nodoc:
+  VERSION = "0.2.0" # :nodoc:
+end

data/pdf_spec.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pdf_spec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pdf_spec"
+  s.version     = PdfSpec::VERSION
+  s.authors     = ["TMX Credit", "Zachary Belzer", "Sergey Potapov"]
+  s.email       = ["rubygems@tmxcredit.com", "zach@tmxcredit.com"]
+  s.homepage    = "https://github.com/TMXCredit/pdf_spec"
+  s.licenses    = ["LICENSE"]
+  s.summary     = %q{RSpec matchers for comparing PDF files}
+  s.description = %q{This library includes matchers that use Poppler and Cairo
+    to render PDF files as images and compare them by the pixel}
+
+  s.rubyforge_project = "pdf_spec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+
+  s.add_runtime_dependency "rmagick", "~> 2.13.0"
+end

data/spec/fixtures/one.html

@@ -0,0 +1,7 @@
+<html>
+  <head>
+  </head>
+  <body>
+    The first sample PDF
+  </body>
+</html>

data/spec/fixtures/one_page.html

@@ -0,0 +1,12 @@
+<html>
+  <head>
+    <style type="text/css">
+      p {
+        page-break-before: always;
+      }
+  </style>
+  </head>
+  <body>
+    The first page
+  </body>
+</html>

data/spec/fixtures/two.html

@@ -0,0 +1,7 @@
+<html>
+  <head>
+  </head>
+  <body>
+    The second sample PDF
+  </body>
+</html>

data/spec/fixtures/two_pages.html

@@ -0,0 +1,15 @@
+<html>
+  <head>
+    <style type="text/css">
+      p {
+        page-break-before: always;
+      }
+  </style>
+  </head>
+  <body>
+    The first page
+    <p>
+      The second page
+    </p>
+  </body>
+</html>

data/spec/matchers_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module PdfSpec
+  module Matchers
+    describe "IdenticalPdfs" do
+      describe "matches?" do
+        it "should be true for matching pdfs" do
+          path = "#{FIXTURES}/one.pdf"
+          first_pdf = File.read("#{FIXTURES}/one.pdf")
+          second_pdf = File.read("#{FIXTURES}/one.pdf")
+
+          matcher = IdenticalPdfs.new(first_pdf)
+          matcher.matches?(second_pdf).should be_true
+        end
+
+        it "should be false for differing pdfs" do
+          first_pdf = File.read("#{FIXTURES}/one.pdf")
+          second_pdf = File.read("#{FIXTURES}/two.pdf")
+
+          matcher = IdenticalPdfs.new(first_pdf)
+          matcher.matches?(second_pdf).should be_false
+        end
+
+        it "should be false for pdfs with a different number of pages" do
+          first_pdf = File.read("#{FIXTURES}/one_page.pdf")
+          second_pdf = File.read("#{FIXTURES}/two_pages.pdf")
+
+          matcher = IdenticalPdfs.new(first_pdf)
+          matcher.matches?(second_pdf).should be_false
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'pdf_spec'
+
+FIXTURES = File.expand_path("../fixtures", __FILE__)
+
+RSpec.configure do |config|
+  config.include(PdfSpec::Matchers)
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: pdf_spec
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- TMX Credit
+- Zachary Belzer
+- Sergey Potapov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: |-
+  This library includes matchers that use Poppler and Cairo
+      to render PDF files as images and compare them by the pixel
+email:
+- rubygems@tmxcredit.com
+- zach@tmxcredit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pdf_spec.rb
+- lib/pdf_spec/matchers.rb
+- lib/pdf_spec/version.rb
+- pdf_spec.gemspec
+- spec/fixtures/one.html
+- spec/fixtures/one.pdf
+- spec/fixtures/one_page.html
+- spec/fixtures/one_page.pdf
+- spec/fixtures/two.html
+- spec/fixtures/two.pdf
+- spec/fixtures/two_pages.html
+- spec/fixtures/two_pages.pdf
+- spec/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TMXCredit/pdf_spec
+licenses:
+- LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: pdf_spec
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for comparing PDF files
+test_files:
+- spec/fixtures/one.html
+- spec/fixtures/one.pdf
+- spec/fixtures/one_page.html
+- spec/fixtures/one_page.pdf
+- spec/fixtures/two.html
+- spec/fixtures/two.pdf
+- spec/fixtures/two_pages.html
+- spec/fixtures/two_pages.pdf
+- spec/matchers_spec.rb
+- spec/spec_helper.rb