pdf_margins 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 627c8a5b2633419fa30dc4d9633ca4b5825f822b
-  data.tar.gz: 0489558643554e50cdbeaf5c18c78c0a62013e8e
+  metadata.gz: 1f4e0cb5d988f4165e55240cce916d486f9316c3
+  data.tar.gz: 25460409951b86d6f51f5b91d61fd88edd3e1b82
 SHA512:
-  metadata.gz: 950b461d6e613d583da0e7ae629bc6c04d792fa440ef77e0469e50c2925a2ed061c1927e3852e995f07514f6166582dc443155ccdbcb2624005e45ccbc241141
-  data.tar.gz: 646cb27222b39c19529abdf79915afff2a8f875c73fbba2efcfac0b242e0889279813ec99c2152554f2954ea792f000a61ea5bc47ec94a63443600969bd2258a
+  metadata.gz: d286a7d196b91486767fa831413a0704e65d40043e606c57f9609e1fe1b69817e5a6812cb4b8dd073ad4090517d5b359511972b5393762faafb0eaa48db8cb6d
+  data.tar.gz: b7ea7a4386a7ae7a58b1ee8651ebe80bde3e0e708d6d6308539383b58351e815b4ba287a10bad6d269b5e4d9b202958311491370fca4371fe4d745c9b5a5df21

data/lib/pdf/margins/checker.rb

@@ -3,6 +3,7 @@ require 'pdf/margins/errors'
 require 'chunky_png'
 require 'oily_png'
 require 'tmpdir'
+require 'logger'
 
 module PDF
   module Margins
@@ -15,21 +16,29 @@ module PDF
       SCALE_MULTIPLIER = 1 
       RESOLUTION = DEFAULT_RESOLUTION * SCALE_MULTIPLIER
 
-      attr_reader :file_path, :top_margin, :right_margin, :bottom_margin, :left_margin, :spreads
+      attr_reader :file_path, :logger
+      attr_reader :top_margin, :right_margin, :bottom_margin, :left_margin, :spreads
 
       # Dimensions are in mm, to be converted to PDF points later. Pass spreads
       # as true to check left and right margins of spreads, not pages.
-      def initialize(file_path, top_margin, right_margin, bottom_margin, left_margin, spreads=false)
+      def initialize(file_path, options = {})
         @file_path     = file_path
-        @top_margin    = top_margin
-        @right_margin  = right_margin
-        @bottom_margin = bottom_margin
-        @left_margin   = left_margin
-        @spreads       = spreads
+        @keep_pngs     = options.delete(:keep_pngs) || false
+
+        @top_margin    = options.delete(:top_margin) || 0
+        @right_margin  = options.delete(:right_margin) || 0
+        @bottom_margin = options.delete(:bottom_margin) || 0
+        @left_margin   = options.delete(:left_margin) || 0
+        @spreads       = options.delete(:spreads) || false
+
+        @logger = options.delete(:logger) || Logger.new(STDOUT).tap do |l|
+          l.level = options.delete(:log_level) || Logger::WARN
+        end
       end
 
       def issues
         temp_dir_path = Dir.mktmpdir("pdf_margins")
+        logger.debug("Rendering PNGs into #{temp_dir_path}")
 
         begin
           # This produces greyscale PNGs - we throw the colour away because we
@@ -39,12 +48,17 @@ module PDF
           issues = []
 
           files = Dir.glob("#{temp_dir_path}/*.png")
+          file_count = files.length
           # ensure the files are sorted naturally
           files = files.sort_by{ |f| f.split('/').last.to_i }
 
+          logger.debug("Rendered #{file_count} files")
+
           files.each_with_index do |png_path, index|
-            image = ChunkyPNG::Image.from_file(png_path)
             page_number = index + 1
+            logger.debug("Rendering page #{page_number} from #{png_path}")
+
+            image = ChunkyPNG::Image.from_file(png_path)
 
             if dirty_top_margin?(image, top_margin)
               issues << Issue.new(page_number, :top)
@@ -64,7 +78,8 @@ module PDF
           end
 
         ensure
-          FileUtils.remove_entry(temp_dir_path)
+          FileUtils.remove_entry(temp_dir_path) unless @keep_pngs
+          logger.info("PNG files kept at: #{temp_dir_path}") if @keep_pngs
         end
 
         return issues
@@ -108,8 +123,11 @@ module PDF
           height.times do |y_offset|
             x_position = x + x_offset
             y_position = y + y_offset
+            pixel      = image[x_position, y_position]
 
-            if image[x_position, y_position] != white 
+            if pixel != white 
+              hex = ChunkyPNG::Color.to_hex(pixel)
+              logger.debug("Found #{hex} pixel at #{x_position},#{y_position}")
               found_dirty_pixel = true
               break
             end

data/lib/pdf/margins/version.rb

@@ -1,5 +1,5 @@
 module PDF
   module Margins
-    VERSION = "0.2.3"
+    VERSION = "0.3.1"
   end
 end

data/test/checker_test.rb

@@ -2,18 +2,27 @@ require 'test_helper'
 
 class CheckerTest < Test::Unit::TestCase
 
+  def default_options(margin_width = 15)
+    { 
+      top_margin: margin_width, 
+      right_margin: margin_width, 
+      bottom_margin: margin_width, 
+      left_margin: margin_width 
+    }
+  end
+
   test "PDF as pages with clear margins tested as pages" do
-    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-pages.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-pages.pdf'), default_options)
     assert_equal [], checker.issues
   end
 
   test "PDF as spreads with clear margins tested as spreads" do
-    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-spreads.pdf'), 15, 15, 15, 15, true)
+    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-spreads.pdf'), default_options.merge(spreads: true))
     assert_equal [], checker.issues
   end
 
   test "PDF as spreads with clear margins tested as pages" do
-    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-spreads.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('clear-margins-spreads.pdf'), default_options)
     assert_equal [
       PDF::Margins::Issue.new(1, :left),
       PDF::Margins::Issue.new(2, :right),
@@ -23,21 +32,21 @@ class CheckerTest < Test::Unit::TestCase
   end
 
   test "PDF as pages with dirty left margin" do
-    checker = PDF::Margins::Checker.new(pdf_path('left-margin-only.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('left-margin-only.pdf'), default_options)
     assert_equal [
       PDF::Margins::Issue.new(1, :left)
     ], checker.issues
   end
 
   test "PDF as pages with dirty right margin" do
-    checker = PDF::Margins::Checker.new(pdf_path('right-margin-only.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('right-margin-only.pdf'), default_options)
     assert_equal [
       PDF::Margins::Issue.new(1, :right)
     ], checker.issues
   end
 
   test "PDF with dirty top margin as spreads" do
-    checker = PDF::Margins::Checker.new(pdf_path('top-margin-only.pdf'), 15, 15, 15, 15, true)
+    checker = PDF::Margins::Checker.new(pdf_path('top-margin-only.pdf'), default_options.merge(spreads: true))
     assert_equal [
       PDF::Margins::Issue.new(1, :top),
       PDF::Margins::Issue.new(2, :top),
@@ -47,7 +56,7 @@ class CheckerTest < Test::Unit::TestCase
   end
 
   test "PDF with dirty bottom margin as spreads" do
-    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), 15, 15, 15, 15, true)
+    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), default_options.merge(spreads: true))
     assert_equal [
       PDF::Margins::Issue.new(1, :bottom),
       PDF::Margins::Issue.new(2, :bottom),
@@ -57,7 +66,7 @@ class CheckerTest < Test::Unit::TestCase
   end
 
   test "PDF with dirty top margin as pages" do
-    checker = PDF::Margins::Checker.new(pdf_path('top-margin-only.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('top-margin-only.pdf'), default_options)
     assert_equal [
       PDF::Margins::Issue.new(1, :top),
       PDF::Margins::Issue.new(2, :top),
@@ -67,7 +76,7 @@ class CheckerTest < Test::Unit::TestCase
   end
 
   test "PDF with dirty bottom margin as pages" do
-    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), default_options)
     assert_equal [
       PDF::Margins::Issue.new(1, :bottom),
       PDF::Margins::Issue.new(2, :bottom),
@@ -77,17 +86,17 @@ class CheckerTest < Test::Unit::TestCase
   end
 
   test "PDF with all dirty margins being checked as pages with a margin width of 0" do
-    checker = PDF::Margins::Checker.new(pdf_path('16-page-mini.pdf'), 0, 0, 0, 0, false)
+    checker = PDF::Margins::Checker.new(pdf_path('16-page-mini.pdf'), default_options(0))
     assert_equal [], checker.issues
   end
 
   test "PDF with all dirty margins being checked as spreads with a margin width of 0" do
-    checker = PDF::Margins::Checker.new(pdf_path('16-page-mini.pdf'), 0, 0, 0, 0, true)
+    checker = PDF::Margins::Checker.new(pdf_path('16-page-mini.pdf'), default_options(0).merge(spreads: true))
     assert_equal [], checker.issues
   end
 
   test "shelling out to mudraw fails" do
-    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), 15, 15, 15, 15)
+    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), default_options)
     checker.expects(:system).returns(false)
     assert_raises(PDF::Margins::MuDrawCommandError) { checker.issues }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_margins
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Tom Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png