gjman 0.1.0

data/lib/ext/pdfc/license/overview.txt

@@ -0,0 +1,9 @@
+Here is an overview of the licenses in the various jar files provided with PDFC.
+
+
+JAR file                              License Info
+---------------------------------------------------------------------------------------------
+log4j-1.2.15.jar                      See license/LICENSE.log4j
+PDFCParser.jar                        LGPL license - see lgpl-3.0.txt
+PDFC.jar                              Copyright 2009-2010, i-net software. All rights reserved.
+CCLib.jar                             Copyright 2009-2010, i-net software. All rights reserved.

data/lib/ext/pdfc/readme.txt

@@ -0,0 +1,89 @@
+i-net PDF Comparer v1.01
+-------------------------
+Copyright i-net software GmbH 2009-2010
+All rights reserved
+
+1. Introduction
+---------------
+The PDF Comparer is a tool specifically for comparing two PDF files (or folders containing PDF files)
+for differences.
+It is useful for comparing the PDF output of a Crystal Reports report with the PDF output of this same
+report as exported by i-net Crystal-Clear, or for comparing the PDF output of two different versions
+of i-net Crystal-Clear for any differences or behavioral changes. The following elements are compared
+and any differences logged:
+
+ * Text differences (letters or words missing)
+ * Line/Arc/Box differences (lines or boxes missing or with different styles)
+ * Image differences (images missing)
+ * Margin differences (page margins different)
+
+These differences each have a configurable tolerance value so that minor differences can be
+ignored if necessary. (See point 3 - Configuration)
+
+2. Parameters
+-------------
+Usage:
+PDFC [-c <config file>] [-[i][o]] [<Folder1> <Folder2> | <File1> <File2>]
+
+  -c       Specify a configuration file (config.xml) for PDFC. If none is specified, the default "config.xml" is taken
+  -i       Creates diff images in <Folder1>/differences for any differences found (recommended for a graphical comparison)
+  -o       Creates images for each page of each version (need only be used for debug purposes)
+
+Note that if using two folders, the PDF files must have the same names in each folder.
+
+Will result in an output on the console for any differences found between the PDFs being compared.
+
+Example usage:
+
+PDFC -i CRFolder CCFolder
+
+This would compare all PDF files in the folder "CRFolder" with the PDF files of the same name in the folder "CCFolder".
+
+3. Configuration
+----------------
+The following tolerance values can be set in the config.xml file:
+
+CHART_DENSITY_THRESHOLD 
+          (Decimal) density threshold: ((number of shapes)^3 / area size)
+CHART_REMOVAL_MARGIN 
+          (Decimal) percent of shape height to use as margin for removing PDF elements above and below detected charts
+CREATE_DIFFIMAGES 
+          True to create png files with the marked difference of the compared pages
+CREATE_ORIGIMAGES 
+          True to create a png file for each page that is compared
+LOG_LEVEL
+         Level for Logging (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL). The default is set to WARN
+MAX_ERRORS_PER_REPORT 
+          maximum number of errors that can occur before the comparison is canceled for the current pdf file.
+MAX_WORD_DIFFERENCES 
+          maximum number of differences that can occur before the comparison is canceled
+MODULES 
+          comma separated list of modules to be executed for each page
+NORMALIZERS 
+          comma separated list of normalizers to be executed before and after each page
+TOLERANCE_BOX_ROUND_EDGES 
+          (Integer) maximum number of pixels that a curve control point may differ in total
+TOLERANCE_IMAGE_DISTANCE 
+          maximum number of pixels that the position of an image can differ
+TOLERANCE_IMAGE_SIZE 
+          maximum difference in percent, that the area spanned by an image may differ
+TOLERANCE_LINE_POSITION 
+          (Decimal) maximum number of pixels that the position of a line or curves can differ per axis
+TOLERANCE_LINE_SIZE 
+          (Integer) maximum number of pixels that the length of a line can differ in total
+TOLERANCE_LINE_STYLE 
+          (Boolean) if true, different stroke styles will be an error
+TOLERANCE_LINE_THICKNESS 
+          (Integer) maximum difference in stroke thickness of two lines or curves
+TOLERANCE_PAGE_LEFTCORNER 
+          maximum number of pixels that the left or top margin of a page can differ (is the upper left corner of all elements)
+TOLERANCE_PAGE_RATIO 
+          tolerance for the aspect ratio of the pdf page
+TOLERANCE_PAGE_SIZE 
+          maximum number of pixels that the width or height of a page can differ
+TOLERANCE_UNDERLINE_LENGTH 
+          (Decimal) the maximum difference in percent, which the length of underlines may differ
+
+4. Support
+
+If you have any questions or problems, please do not hesitate to contact tools@inetsoftware.de for technical support.

data/lib/gjman.rb

@@ -0,0 +1,29 @@
+require 'gjman/file_system'
+require 'gjman/jruby'
+require 'gjman/rjb'
+
+module Gjman
+
+  ROOT = File.join(File.expand_path(File.dirname(__FILE__)))
+  JAVA_LIBS = []
+  JAVA_MODE =  RUBY_PLATFORM =~ /java/i ? :JRuby : (
+    begin
+      require 'rjb'
+      :Rjb
+    rescue LoadError
+      :Shell
+    end
+  )
+
+  class << self
+
+    def root(*args)
+      args.size == 0 ? ROOT : File.join(ROOT, *args)
+    end
+
+    def ext(*args)
+      root(*['ext', args].flatten)
+    end
+  end
+
+end

data/lib/gjman/file_system.rb

@@ -0,0 +1,46 @@
+require 'tempfile'
+require 'ftools'
+require 'digest/md5'
+
+module Gjman
+
+  class FileNotFoundError < Exception ; end
+
+  private
+
+    module FileSystem
+      class << self
+
+        def tmp_dir(&block)
+          Dir.mktmpdir(&block)
+        end
+
+        def file_must_exist!(path, timeout=0)
+          if timeout.zero?
+            File.exists?(path) or raise_file_not_found_error(path)
+          else
+            0.upto(timeout.pred) {|i| File.exists?(path) ? (return true) : sleep(1) }
+            raise_file_not_found_error(path)
+          end
+        end
+
+        def trash_tmp_files
+          (@trashable_tmp_files || []).each {|f| f.path && f.unlink }
+          @trashable_tmp_files = nil
+        end
+
+        def tmp_file(basename = nil)
+          basename ||= Digest::MD5.hexdigest(Time.now.to_s)
+          ((@trashable_tmp_files ||= []) << Tempfile.new(basename))[-1]
+        end
+
+        protected
+
+          def raise_file_not_found_error(path)
+            raise FileNotFoundError.new("File '#{path}' not found.")
+          end
+
+      end
+    end
+
+end

data/lib/gjman/java_hacks/ForbidSystemExit.java

@@ -0,0 +1,23 @@
+import java.security.Permission;
+
+// Copy-&-pasted (almost) from
+// http://www.jroller.com/ethdsy/entry/disabling_system_exit
+class ForbidSystemExit
+{
+  public static class Exception extends SecurityException { }
+
+  public static void apply() {
+    final SecurityManager securityManager = new SecurityManager() {
+      public void checkPermission( Permission permission ) {
+        if( permission.getName().startsWith("exitVM") ) {
+          throw new Exception() ;
+        }
+      }
+    } ;
+    System.setSecurityManager( securityManager ) ;
+  }
+
+  public static void unapply() {
+    System.setSecurityManager( null ) ;
+  }
+}

data/lib/gjman/jruby.rb

@@ -0,0 +1,34 @@
+module Gjman
+  module JRuby
+    class << self
+
+      def initialize
+        @initialized ||= (
+          include Java
+          Gjman::JAVA_LIBS.join(':').split(':').each{|jar| require jar }
+          $CLASSPATH << Gjman.root('gjman','java_hacks')
+          java_import 'ForbidSystemExit'
+          true
+        )
+      end
+
+      def classify(klass)
+        java_import klass
+        Java.send(klass)
+      end
+
+      def sandbox(&block)
+        initialize
+        begin
+          ForbidSystemExit.apply
+          @result = yield
+        rescue ForbidSystemExit::Exception
+          @result
+        ensure
+          ForbidSystemExit.unapply
+        end
+      end
+
+    end
+  end
+end

data/lib/gjman/pdf.rb

@@ -0,0 +1,30 @@
+require 'gjman'
+require 'gjman/pdf/utils'
+require 'gjman/pdf/base'
+require 'gjman/pdf/matcher'
+require 'gjman/pdf/merger'
+require 'gjman/pdf/compressor'
+
+module Gjman
+  module PDF
+    class << self
+
+      def match?(x, y)
+        Matcher.test(x, y)
+      end
+
+      def merge(*args)
+        Merger.do(*args)
+      end
+
+      def compress(src, opts={})
+        Compressor.do(src, opts)
+      end
+
+      def uncompress(src, opts={})
+        Compressor.undo(src, opts)
+      end
+
+    end
+  end
+end

data/lib/gjman/pdf/base.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+
+module Gjman
+  module PDF
+    class Base
+      class << self
+
+        extend Forwardable
+
+        def_delegators Utils::PDFC, :diff
+        def_delegators Utils::Multivalent, :merge, :compress, :uncompress, :fonts, :images
+
+        def same_contents?(pdf_x, pdf_y)
+          diff(pdf_x, pdf_y) !~ %r{\| # of Differences.*\-+.*(\| [1-9]+)}m
+        end
+
+        def same_fonts?(pdf_x, pdf_y)
+          # The last line shows processing stats (which we don't need)
+          fonts(pdf_x).split("\n")[0..-2] == fonts(pdf_y).split("\n")[0..-2]
+        end
+
+        def same_images?(pdf_x, pdf_y)
+          # The fist line shows file name (which we don't need)
+          images(pdf_x).split("\n")[1..-1] == images(pdf_y).split("\n")[1..-1]
+        end
+
+      end
+    end
+  end
+end
+

data/lib/gjman/pdf/compressor.rb

@@ -0,0 +1,50 @@
+module Gjman
+  module PDF
+    class Compressor < Base
+      class << self
+
+        def do(src, opts={})
+          default_dest = src.sub(/\.pdf$/, '-o.pdf')
+          work(:compress, src, opts.delete(:to) || default_dest, default_dest)
+        end
+
+        def undo(src, opts={})
+          default_dest = src.sub(/\.pdf$/, '-u.pdf')
+          work(:uncompress, src, opts.delete(:to) || default_dest, default_dest)
+        end
+
+        private
+
+         def work(action, src, dest, tmp_dest)
+           case send(action, src)
+           when /Already compressed\.  \(Force recompression with \-force\.\)/,
+             /java\.lang\.ArrayIndexOutOfBoundsException/
+             File.copy(src, dest)
+           else
+             File.move(tmp_dest, dest)
+           end
+           dest
+         end
+
+          # NOTE: Since pdftk is almost as dead as multivalent (last updated in 2006),
+          # there is really no good reason to choose it over multivalent. Moreover,
+          # since pdf comparison requires java solution, it makes sense to be consistent,
+          # which is essentially sticking to java.
+          #
+          # def do(src, dest)
+          #   pdftk(:compress, src, dest)
+          # end
+          #
+          # def undo(src, dest)
+          #   pdftk(:uncompress, src, dest)
+          # end
+          #
+          # def pdftk(mode, src, dest)
+          #   shell(:pdftk, [src, :output, dest, mode, :verbose])
+          #   dest
+          # end
+
+      end
+    end
+  end
+end

data/lib/gjman/pdf/matcher.rb

@@ -0,0 +1,28 @@
+module Gjman
+  module PDF
+    class Matcher < Base
+      class << self
+
+        def test(pdf_x, pdf_y)
+          begin
+            tmp_x, tmp_y = uncompress(pdf_x, pdf_y)
+            ! [:same_fonts?, :same_images?, :same_contents?].
+              any?{|test| !send(test, tmp_x, tmp_y) }
+          ensure
+            FileSystem.trash_tmp_files
+          end
+        end
+
+        private
+
+          def uncompress(*pdfs)
+            [pdfs].flatten.map do |pdf|
+              tmp = FileSystem.tmp_file([Digest::MD5.hexdigest(pdf),'.pdf']).path
+              PDF.uncompress(pdf, :to => tmp)
+            end
+          end
+
+      end
+    end
+  end
+end

data/lib/gjman/pdf/merger.rb

@@ -0,0 +1,25 @@
+module Gjman
+  module PDF
+    class Merger < Base
+      class << self
+
+        def do(*args)
+          opts = args.last.is_a?(Hash) ? args.pop : {}
+          srcs = [args].flatten
+          default_dest = srcs[0].sub(/\.pdf$/,'-m.pdf')
+          dest = opts.delete(:to) || default_dest
+          work(srcs, dest, default_dest)
+        end
+
+        private
+
+          def work(srcs, dest, tmp_dest)
+            merge(srcs)
+            File.move(tmp_dest, dest) unless dest == tmp_dest
+            dest
+          end
+
+      end
+    end
+  end
+end

data/lib/gjman/pdf/utils.rb

@@ -0,0 +1,2 @@
+require 'gjman/pdf/utils/pdfc'
+require 'gjman/pdf/utils/multivalent'

data/lib/gjman/pdf/utils/multivalent.rb

@@ -0,0 +1,58 @@
+module Gjman
+  module PDF
+    module Utils
+      module Multivalent
+
+        class NotSupportedServiceError < Exception ; end
+
+        JARS = Gjman.ext('multivalent', 'Multivalent20060102.jar')
+        Gjman::JAVA_LIBS << JARS
+
+        SERVICES = {
+          :compress   => %w{tool.pdf.Compress},
+          :uncompress => %w{tool.pdf.Uncompress},
+          :merge      => %w{tool.pdf.Merge},
+          :fonts      => %w{tool.doc.ExtractText --output xml --style},
+          :images     => %w{tool.pdf.Info --images},
+        }
+
+        module JRuby
+          def method_missing(mode, *args)
+            Gjman::JRuby.sandbox do
+              service, args = extract_args(mode, args)
+              Gjman::JRuby.classify(service).main(args.split(' '))
+            end
+          end
+        end
+
+        module Rjb
+          def method_missing(mode, *args)
+            Gjman::Rjb.sandbox do
+              service, args = extract_args(mode, args)
+              Gjman::Rjb.classify(service).main(args.split(' '))
+            end
+          end
+        end
+
+        module Shell
+          def method_missing(mode, *args)
+            service, args = extract_args(mode, args)
+            @cmd ||= 'java -cp %s' % JARS
+            %x|#{@cmd} #{service} #{args} 2>&1|
+          end
+        end
+
+        def self.extract_args(mode, args)
+          (service_args = SERVICES[mode]) or raise NotSupportedServiceError
+          [
+            service_args[0],
+            [service_args[1..-1], args].flatten.compact.join(' ')
+          ]
+        end
+
+        extend const_get(Gjman::JAVA_MODE)
+
+      end
+    end
+  end
+end