identikal 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc02eff57d85a4e3890315c538f03acb43eb7bae0b21023374ddb36ea6170cb1
+  data.tar.gz: 4f4cbd925ec53da1fdf24ca45ed46310e5674c0aaf69b92e041d48dae17f7972
+SHA512:
+  metadata.gz: 0c07ef817e71ddcbb81644f1fa7b09cb0f61dceecf6d082144eaba13f05b6dc6924a71e8d37664b2134bf091a0d49871551c6e301d1fedbd12b88a572d65cf8e
+  data.tar.gz: 6d94e772be5b1ac8219901ef34190f130b23eefcc2e5f7b55c02596bba78d108723f1d00dcf49c04a0c68b4aeabfde96911b2c63a543a9cac6ba7e9c893f218d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in identikal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jahangir Anwari
+
+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,82 @@
+# Identikal
+
+A no frills tiny gem that does one thing and only one thing. It compares two unencrypted PDF files and returns **true** if they are identical and **false** otherwise. PDF comparison is done in pure Ruby with the help of [HexaPDF](https://github.com/gettalong/hexapdf) and [PDF::Reader](https://github.com/yob/pdf-reader).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'identikal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install identikal
+
+## Usage
+
+### CLI
+Comparing two PDFs from command line can be done by running the below command:
+
+```bash
+$ identikal file_a.pdf file_b.pdf
+true
+```
+
+**Text Only**
+
+If you would like to compare only the "text" content of the PDFs add the `-t` flag:
+
+```bash
+$ identikal -t file_a.pdf file_c.pdf
+false
+```
+
+### Ruby Code
+Besides the command line tool Identikal can also be used in a Ruby application. Identikal supports the following `compare_method`:
+
+* `:all`  compare text along with formatting
+* `:text` compare only text content
+
+`:all` is the default comparison method.
+
+
+**Text with formatting**
+```ruby
+require 'identikal'
+
+base_path = File.expand_path(File.join(__dir__) + '/pdfs')
+pdf_a = File.join(base_path, 'report_a.pdf')
+pdf_b = File.join(base_path, 'report_b.pdf')
+
+if Identikal.files_same?(pdf_a, pdf_b)
+  # some action when files are identical
+else
+  # another action when files are different
+end
+```
+
+**Text Only**
+```ruby
+require 'identikal'
+
+base_path = File.expand_path(File.join(__dir__) + '/pdfs')
+pdf_a = File.join(base_path, 'report_a.pdf')
+pdf_b = File.join(base_path, 'report_b.pdf')
+
+if Identikal.files_same?(pdf_a, pdf_b, compare_method: :text)
+  # some action when files are identical
+else
+  # another action when files are different
+end
+```
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/identikal

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'optparse'
+require 'identikal'
+
+ARGV << '-h' if ARGV.empty?
+compare_method = :all
+verbose = false
+OptionParser.new do |parser|
+  parser.banner = 'Usage: identikal [options] PDF_1 PDF_2'
+  parser.on('-t', '--text', 'Only compare text') do
+    compare_method = :text
+  end
+
+  parser.on('-v', '--verbose', 'Verbose output') do
+    verbose = true
+  end
+
+  parser.on('-h', '--help', 'Print this help') do
+    puts parser
+    exit
+  end
+end.parse!
+
+file_a = ARGV[0]
+file_b = ARGV[1]
+
+begin
+  result = Identikal.files_same? file_a, file_b, compare_method: compare_method
+rescue ArgumentError => e
+  warn "Error: #{e.message}"
+  exit(1)
+end
+
+if verbose
+  puts 'Files are identical' if result
+  puts 'Files are different' unless result
+else
+  puts result
+end

data/identikal.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'identikal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'identikal'
+  spec.version       = Identikal::VERSION
+  spec.authors       = ['Jahangir Anwari']
+  spec.email         = ['jahangir.rubygems@gmail.com']
+
+  spec.summary       = 'Verify if two given PDF files are identical or not.'
+  spec.description = <<-DESCRIPTION
+    A no frills gem that does one thing and only one thing. Checks whether two given PDF files are identical or not.
+    PDF comparison done in pure Ruby.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/jahangiranwari/identikal'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.bindir        = 'bin'
+  spec.executables   = 'identikal'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_dependency 'hexapdf', '~> 0.6.0'
+  spec.add_dependency 'pdf-reader', '~> 2.2.0'
+end

data/lib/identikal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'identikal/version'
+require 'identikal/compare'
+
+module Identikal
+  class << self
+    def files_same?(*args)
+      Identikal::Compare.files_same?(*args)
+    end
+  end
+end

data/lib/identikal/compare.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: false
+
+require 'identikal/error'
+
+module Identikal
+  autoload(:HexaPDF, 'hexapdf')
+  autoload(:PDF, 'pdf-reader')
+
+  class Compare
+    COMPARE_METHODS = %i[text all].freeze
+
+    class << self
+      def files_same?(file_a, file_b, compare_method: :all)
+        validate_arguments(file_a, file_b, compare_method)
+        if compare_method == :text
+          text_only(file_a, file_b)
+        else
+          with_formatting(file_a, file_b)
+        end
+      end
+
+      private
+
+      def text_only(file_a, file_b)
+        reader_a = PDF::Reader.new(file_a)
+        reader_b = PDF::Reader.new(file_b)
+        return false unless reader_a.page_count == reader_b.page_count
+
+        text_compare(reader_a, reader_b)
+      end
+
+      def with_formatting(file_a, file_b)
+        reader_a = HexaPDF::Document.open(file_a)
+        reader_b = HexaPDF::Document.open(file_b)
+        return false unless reader_a.pages.count == reader_b.pages.count
+
+        format_compare(reader_a, reader_b)
+      end
+
+      def format_compare(reader_a, reader_b)
+        reader_a.pages.count.times do |i|
+          text_a = reader_a.pages[i].contents
+          text_b = reader_b.pages[i].contents
+          return false unless text_a == text_b
+        end
+        true
+      end
+
+      def text_compare(reader_a, reader_b)
+        reader_a.page_count.times do |i|
+          text_a = reader_a.pages[i].text.gsub!(/\n+|\s+/, '')
+          text_b = reader_b.pages[i].text.gsub!(/\n+|\s+/, '')
+          return false unless text_a == text_b
+        end
+        true
+      end
+
+      def validate_arguments(file_a, file_b, compare_method)
+        raise Identikal::Error::FileNotFound unless
+          File.file?(file_a) && File.file?(file_b)
+
+        raise Identikal::Error::InvalidComparisonMethod unless
+          COMPARE_METHODS.include?(compare_method)
+      end
+    end
+  end
+end

data/lib/identikal/error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'identikal/compare'
+
+module Identikal
+  module Error
+    class FileNotFound < ArgumentError
+      def to_s
+        'PDF file(s) could not be found. ' \
+        'Please provide two PDF files to compare'
+      end
+    end
+
+    class InvalidComparisonMethod < ArgumentError
+      def to_s
+        'Invalid comparision method. ' \
+        'Please choose one of these methods: ' \
+        "#{Identikal::Compare::COMPARE_METHODS}"
+      end
+    end
+  end
+end

data/lib/identikal/version.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: identikal
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jahangir Anwari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: hexapdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: |2
+      A no frills gem that does one thing and only one thing. Checks whether two given PDF files are identical or not.
+      PDF comparison done in pure Ruby.
+email:
+- jahangir.rubygems@gmail.com
+executables:
+- identikal
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/identikal
+- identikal.gemspec
+- lib/identikal.rb
+- lib/identikal/compare.rb
+- lib/identikal/error.rb
+- lib/identikal/version.rb
+homepage: https://github.com/jahangiranwari/identikal
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jahangiranwari/identikal
+  source_code_uri: https://github.com/jahangiranwari/identikal
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Verify if two given PDF files are identical or not.
+test_files: []