pdf_margins 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2NiOWYxMjI0NzQ3ZmMxY2VjYTE3NGIzYTdjOTUyODgxZGMwZWI4ZA==
+  data.tar.gz: !binary |-
+    OWE2NTdkODkxNzc5OTI2NGMwZDMyMjc4NzM1MGJlODFlNmE0OWFkYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODY4NjBlYTRjOTA1NGY2MWU5YTdjMjAxNmU4Mzg1ZjNmYzFhODgwZDkyMDJl
+    MDgwZmFmYTc1YTI1N2RkOTZjMzNlNmU2ODBiMGIyZjlhMmJkZTA4NmU1YmVh
+    ZDg3ZDliMzkwNGM4NzQ1OWMyM2U3NGVhMDdhNGZmZDQ1ZGNkYmI=
+  data.tar.gz: !binary |-
+    OTM4YzMxYzdhNjZmY2FkOGQ0MTZhMGI5NGVmZDM3ZWQwNzI0NzQ0Y2FkZjVk
+    NzY4NjQ3NmJmY2VlNGViMjc4MDFiNzUzY2FkOTViZDc1MmVlZDI4YWMwYWI1
+    NjU4OWUxZGFiYjUwNDRlZGM2OWRmMTlmNDUwY2U2NWYyMzM5YWU=

data/README.md

@@ -0,0 +1,19 @@
+pdf/margins
+==
+
+Simple Ruby library to check a PDF for clear margin areas, by rendering to
+a CMYK bitmap, ensuring that the pixel area defined by each margin is empty.
+It's pretty slow, but this is a lot easier than attempting to work out which
+object in a PDF is rendering into the margin area.
+
+Depends on RMagick, and thus requires a Ruby interpreter that supports
+C extensions, such as MRI.
+
+Written by [Tom Taylor](http://scraplab.net), [Newspaper Club](http://www.newspaperclub.com).
+
+Example
+--
+
+    # measurements in mm, ordered top, right, bottom, left (same as CSS)
+    checker = PDF::Margins::Checker.new('example.pdf', 10, 10, 10, 10)
+    puts checker.issues.inspect

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/pdf/margins/checker.rb

@@ -0,0 +1,102 @@
+require 'pdf/margins/issue'
+require 'RMagick'
+
+module PDF
+  module Margins
+    class Checker
+
+      MM_TO_PTS = 2.83464567
+      DEFAULT_RESOLUTION = 72
+      # If we find that we need higher resolution for better precision then we
+      # can adjust the SCALE_MULTIPLIER at the cost of speed.
+      SCALE_MULTIPLIER = 1 
+      RESOLUTION = DEFAULT_RESOLUTION * SCALE_MULTIPLIER
+
+      attr_reader :file, :top_margin, :right_margin, :bottom_margin, :left_margin
+
+      # Dimensions are in mm, to be converted to PDF points later.
+      def initialize(file, top_margin, right_margin, bottom_margin, left_margin)
+        @file          = file
+        @top_margin    = top_margin
+        @right_margin  = right_margin
+        @bottom_margin = bottom_margin
+        @left_margin   = left_margin
+      end
+
+      def issues
+        image_list = Magick::Image.read(file) do
+          # Force CMYK colorspace, because ImageMagick autodetects PDF colorspace
+          # depending on the contents of the file. By forcing the colorspace we
+          # ensure that the subsequent checks in the `dirty_pixels?` method work.
+          self.colorspace = Magick::CMYKColorspace
+          self.density    = RESOLUTION
+          self.antialias  = false
+        end
+
+        image_list.each_with_index.map do |image, index|
+
+          page_number = index + 1
+          [].tap do |page_issues|
+            if dirty_pixels?(top_pixels(image, top_margin))
+              page_issues << Issue.new(page_number, :top)
+            end
+
+            if dirty_pixels?(bottom_pixels(image, bottom_margin))
+              page_issues << Issue.new(page_number, :bottom)
+            end
+
+            # Newspaper Club assumes that pages are two up, printed as spreads,
+            # so we only check right margins on odd numbered pages, and left
+            # margins on even numbered pages. This should probably be
+            # a configurable option for other types of printing.
+            if page_number % 2 == 0
+              if dirty_pixels?(left_pixels(image, left_margin))
+                page_issues << Issue.new(page_number, :left)
+              end
+            else
+              if dirty_pixels?(right_pixels(image, right_margin))
+                page_issues << Issue.new(page_number, :right)
+              end
+            end
+          end
+        end.flatten
+      end
+
+      private
+
+      def mm_to_pixels(mm)
+        (mm * MM_TO_PTS * SCALE_MULTIPLIER).floor
+      end
+
+      def top_pixels(image, mm)
+        width_px = mm_to_pixels(mm)
+        image.get_pixels(0, 0, image.columns, width_px)
+      end
+
+      def left_pixels(image, mm)
+        width_px = mm_to_pixels(mm)
+        image.get_pixels(0, 0, width_px, image.rows)
+      end
+
+      def right_pixels(image, mm)
+        width_px = mm_to_pixels(mm)
+        x = image.columns - width_px
+        image.get_pixels(x, 0, width_px, image.rows)
+      end
+
+      def bottom_pixels(image, mm)
+        width_px = mm_to_pixels(mm)
+        y = image.rows - width_px
+        image.get_pixels(0, y, image.columns, width_px)
+      end
+
+      def dirty_pixels?(pixels)
+        pixels.any? do |p|
+          (p.cyan | p.magenta | p.yellow | p.black) > 0
+        end
+      end
+
+    end
+  end
+end
+

data/lib/pdf/margins/issue.rb

@@ -0,0 +1,5 @@
+module PDF
+  module Margins
+    class Issue < Struct.new(:page, :side); end
+  end
+end

data/lib/pdf/margins/version.rb

@@ -0,0 +1,5 @@
+module PDF
+  module Margins
+    VERSION = "0.0.1"
+  end
+end

data/lib/pdf/margins.rb

@@ -0,0 +1 @@
+require 'pdf/margins/checker'

data/test/checker_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class CheckerTest < Test::Unit::TestCase
+
+  test "PDF with clear margins" do
+    checker = PDF::Margins::Checker.new(pdf_path('clear-margins.pdf'), 10, 10, 10, 10)
+    assert_equal [], checker.issues
+  end
+
+  test "PDF with dirty left margin on page 1" do
+    checker = PDF::Margins::Checker.new(pdf_path('left-margin-only.pdf'), 10, 10, 10, 10)
+    assert_equal [], checker.issues
+  end
+
+  test "PDF with dirty left margin on page 2" do
+    checker = PDF::Margins::Checker.new(pdf_path('p2-left-margin-only.pdf'), 10, 10, 10, 10)
+    assert_equal [PDF::Margins::Issue.new(2, :left)], checker.issues
+  end
+
+  test "PDF with dirty right margin on page 1" do
+    checker = PDF::Margins::Checker.new(pdf_path('right-margin-only.pdf'), 10, 10, 10, 10)
+    assert_equal [PDF::Margins::Issue.new(1, :right)], checker.issues
+  end
+
+  test "PDF with dirty top margin on page 1" do
+    checker = PDF::Margins::Checker.new(pdf_path('top-margin-only.pdf'), 10, 10, 10, 10)
+    assert_equal [PDF::Margins::Issue.new(1, :top)], checker.issues
+  end
+
+  test "PDF with dirty bottom margin on page 1" do
+    checker = PDF::Margins::Checker.new(pdf_path('bottom-margin-only.pdf'), 10, 10, 10, 10)
+    assert_equal [PDF::Margins::Issue.new(1, :bottom)], checker.issues
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'pdf/margins'
+
+class Test::Unit::TestCase
+
+  def pdf_path(filename)
+    File.join(File.dirname(__FILE__), 'pdfs', filename)
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: pdf_margins
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !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: test-unit
+  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'
+description: 
+email:
+- tom@newspaperclub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pdf/margins/checker.rb
+- lib/pdf/margins/issue.rb
+- lib/pdf/margins/version.rb
+- lib/pdf/margins.rb
+- Rakefile
+- README.md
+- test/checker_test.rb
+- test/pdfs/bottom-margin-only.pdf
+- test/pdfs/clear-margins.pdf
+- test/pdfs/left-margin-only.pdf
+- test/pdfs/p2-left-margin-only.pdf
+- test/pdfs/right-margin-only.pdf
+- test/pdfs/top-margin-only.pdf
+- test/test_helper.rb
+homepage: http://www.newspaperclub.com
+licenses:
+- MIT
+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: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple library to checks whether the margins are clear in a PDF
+test_files:
+- test/checker_test.rb
+- test/pdfs/bottom-margin-only.pdf
+- test/pdfs/clear-margins.pdf
+- test/pdfs/left-margin-only.pdf
+- test/pdfs/p2-left-margin-only.pdf
+- test/pdfs/right-margin-only.pdf
+- test/pdfs/top-margin-only.pdf
+- test/test_helper.rb