preflight 0.1.1 → 0.2.0

data/lib/preflight/rules/page_box_size.rb

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Ensure that the requests page box (MediaBox, TrimBox, etc) on every page
+    # has the requested size. Dimensions can be in points, mm or inches. Skips
+    # the page if the requested box isn't defined, it's up to other rules to
+    # check for the existence of the box. Pass an array of sizes to allow each
+    # of those sizes.
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::PageBoxSize, :MediaBox, [
+    #       { :width => 100, :height => 200, :units => :mm },
+    #       { :width => 200, :height => 400, :units => :mm }
+    #     ]
+    #     rule Preflight::Rules::PageBoxSize, :TrimBox,
+    #       { :width => 600, :height => 200, :units => :pts }
+    #   end
+    #
+    class PageBoxSize
+      include Preflight::Measurements
+
+      attr_reader :issues
+
+      def initialize(box, sizes)
+        @box, @units = box
+        sizes = [sizes] if sizes.kind_of?(Hash)
+        @orig_sizes = sizes
+
+        @sizes = sizes.map do |size|
+          size[:width]  = length_to_points(size[:width], size[:units])
+          size[:height] = length_to_points(size[:height], size[:units])
+          size
+        end
+      end
+
+      def page=(page)
+        @issues = []
+        dict = page.attributes
+
+        if dict[@box]
+          box_width = dict[@box][2] - dict[@box][0]
+          box_height = dict[@box][3] - dict[@box][1]
+
+          invalid_size = @sizes.none? do |size|
+            size[:width].include?(box_width) &&
+            size[:height].include?(box_height)
+          end
+
+          if invalid_size
+            @issues << Issue.new("#{@box} size didn't match provided size",
+              self,
+              :page => page.number,
+              :box => @box,
+              :box_height => box_height,
+              :box_width => box_width)
+          end
+        end
+      end
+
+      private
+
+      def length_to_points(length, units)
+        case units
+        when :mm then mm_to_points(length)
+        when :in then inches_to_points(length)
+        else
+          points_to_points(length)
+        end
+      end
+
+      def inches_to_points(height)
+        case height
+        when Numeric then Range.new(in2pt(height)-1, in2pt(height)+1)
+        when Range   then Range.new(in2pt(height.min), in2pt(height.max))
+        else
+          raise ArgumentError, "height must be a Numeric or Range object"
+        end
+      end
+
+      def mm_to_points(height)
+        case height
+        when Numeric then Range.new(mm2pt(height)-1, mm2pt(height)+1)
+        when Range   then Range.new(mm2pt(height.min), mm2pt(height.max))
+        else
+          raise ArgumentError, "height must be a Numeric or Range object"
+        end
+      end
+
+      def points_to_points(height)
+        case height
+        when Numeric then Range.new(height, height)
+        when Range   then height
+        else
+          raise ArgumentError, "height must be a Numeric or Range object"
+        end
+      end
+
+    end
+  end
+end

data/lib/preflight/rules/page_box_width.rb

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Ensure the requested page box (MediaBox, TrimBox, etc) on every page has
+    # the requested width. Dimensions can be in points, mm or inches. Skips
+    # the page if the requested box isn't defined, it's up to other rules to
+    # check for the existence of the box.
+    #
+    # Arguments: the target page box, the target height and the the units
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::PageBoxHeight, :MediaBox, 100, :mm
+    #     rule Preflight::Rules::PageBoxHeight, :TrimBox, 600, :pts
+    #     rule Preflight::Rules::PageBoxHeight, :CropBox, 5, :in
+    #     rule Preflight::Rules::PageBoxHeight, :MediaBox, 100..101, :mm
+    #     rule Preflight::Rules::PageBoxHeight, :TrimBox, 600..700, :pts
+    #     rule Preflight::Rules::PageBoxHeight, :CropBox, 5..6, :in
+    #   end
+    #
+    class PageBoxWidth
+      include Preflight::Measurements
+
+      attr_reader :issues
+
+      def initialize(box, width, units)
+        @box, @units = box, units
+        @orig_width = width
+        @width = case units
+                  when :mm then mm_to_points(width)
+                  when :in then inches_to_points(width)
+                  else
+                    points_to_points(width)
+                  end
+      end
+
+      def page=(page)
+        @issues = []
+        dict = page.attributes
+
+        if dict[@box]
+          box_width  = dict[@box][2] - dict[@box][0]
+
+          if !@width.include?(box_width)
+            @issues << Issue.new("#{@box} width must be #{@orig_width}#{@units}", self, :page  => page.number,
+                                                                                        :box   => @box,
+                                                                                        :width => @orig_width,
+                                                                                        :units => @units)
+          end
+        end
+      end
+
+      private
+
+      def inches_to_points(width)
+        case width
+        when Numeric then Range.new(in2pt(width)-1, in2pt(width)+1)
+        when Range   then Range.new(in2pt(width.min), in2pt(width.max))
+        else
+          raise ArgumentError, "width must be a Numeric or Range object"
+        end
+      end
+
+      def mm_to_points(width)
+        case width
+        when Numeric then Range.new(mm2pt(width)-1, mm2pt(width)+1)
+        when Range   then Range.new(mm2pt(width.min), mm2pt(width.max))
+        else
+          raise ArgumentError, "width must be a Numeric or Range object"
+        end
+      end
+
+      def points_to_points(width)
+        case width
+        when Numeric then Range.new(width, width)
+        when Range   then width
+        else
+          raise ArgumentError, "width must be a Numeric or Range object"
+        end
+      end
+    end
+  end
+end

data/lib/preflight/rules/page_count.rb

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Ensure the page count matches certain criteria.
+    #
+    # Arguments: An integer, range, :even or :odd
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::PageCount, 1
+    #     rule Preflight::Rules::PageCount, 1..2
+    #     rule Preflight::Rules::PageCount, [4, 8]
+    #     rule Preflight::Rules::PageCount, :even
+    #     rule Preflight::Rules::PageCount, :odd
+    #   end
+    #
+    class PageCount
+
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      def check_hash(objects)
+        root  = objects.deref(objects.trailer[:Root])
+        pages = objects.deref(root[:Pages])
+        count = objects.deref(pages[:Count])
+
+        case @pattern
+        when Fixnum then check_numeric(count)
+        when Range  then check_range(count)
+        when Array  then check_array(count)
+        when :even  then check_even(count)
+        when :odd   then check_odd(count)
+        else
+          [Issue.new("PageCount: invalid pattern", self)]
+        end
+      end
+
+      private
+
+      def check_numeric(count)
+        if count != @pattern
+          [Issue.new("Page count must equal #{@pattern}", self, :pattern => :invalid, :count => count)]
+        else
+          []
+        end
+      end
+
+      def check_range(count)
+        if !@pattern.include?(count)
+          [Issue.new("Page count must be between #{@pattern.min} and #{@pattern.max}", self, :pattern => @pattern, :count => count)]
+        else
+          []
+        end
+      end
+
+      def check_array(count)
+        if !@pattern.include?(count)
+          [Issue.new("Page count must be one of #{@pattern.join(', ')}", self, :pattern => @pattern, :count => count)]
+        else
+          []
+        end
+      end
+
+      def check_even(count)
+        if count.odd?
+          [Issue.new("Page count must be an even number", self, :pattern => @pattern, :count => count)]
+        else
+          []
+        end
+      end
+
+      def check_odd(count)
+        if count.even?
+          [Issue.new("Page count must be an odd number", self, :pattern => @pattern, :count => count)]
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/preflight/rules/pdfx_output_intent_has_keys.rb

@@ -9,20 +9,30 @@ module Preflight
     # This doesn't raise an error if there is no GTS_PDFX, that's another
     # rules job.
     #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::PdfxOutputIntentHasKeys, :OutputConditionIdentifier, :Info
+    #   end
+    #
     class PdfxOutputIntentHasKeys
 
       def initialize(*keys)
         @keys = keys.flatten
       end
 
-      def messages(ohash)
+      def check_hash(ohash)
         oi = pdfx_output_intent(ohash)
 
         return [] if oi.nil?
 
         missing = @keys - oi.keys
         missing.map { |key|
-          "The GTS_PDFX OutputIntent missing require key #{key}"
+          Issue.new("The GTS_PDFX OutputIntent missing required key #{key}", self, :key => key)
         }
       end
 

data/lib/preflight/rules/print_boxes.rb

@@ -6,29 +6,31 @@ module Preflight
     # For PDFX/1a, every page must have MediaBox, plus either ArtBox or
     # TrimBox
     #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::PrintBoxes
+    #   end
+    #
     class PrintBoxes
-      attr_reader :messages
 
-      def initialize
-        @messages = []
-        @page_num = 0
-        @parent   = {}
-      end
-
-      def begin_page_container(hash = {})
-        @parent.merge!(hash)
-      end
+      attr_reader :issues
 
-      def begin_page(hash = {})
-        @page_num += 1
-        hash = @parent.merge(hash)
+      def page=(page)
+        dict = page.attributes
 
-        if hash[:MediaBox].nil?
-          @messages << "every page must have a MediaBox (page #{@page_num})"
-        elsif hash[:ArtBox].nil? && hash[:TrimBox].nil?
-          @messages << "every page must have either an ArtBox or a TrimBox (page #{@page_num})"
-        elsif hash[:ArtBox] && hash[:TrimBox]
-          @messages << "no page can have both ArtBox and TrimBox - TrimBox is preferred (page #{@page_num})"
+        if dict[:MediaBox].nil?
+          @issues = [Issue.new("every page must have a MediaBox", self, :page => page.number)]
+        elsif dict[:ArtBox].nil? && dict[:TrimBox].nil?
+          @issues = [Issue.new("every page must have either an ArtBox or a TrimBox", self, :page => page.number)]
+        elsif dict[:ArtBox] && dict[:TrimBox]
+          @issues = [Issue.new("no page can have both ArtBox and TrimBox - TrimBox is preferred", self, :page => page.number)]
+        else
+          @issues = []
         end
       end
     end

data/lib/preflight/rules/root_has_keys.rb

@@ -3,18 +3,30 @@
 module Preflight
   module Rules
 
-    # ensure the root dict has the specified keys
+    # Every PDF has a 'Root' dictionary, check that the target file has
+    # certain keys in it's Root
+    #
+    # Arguments: the required keys
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::RootHasKeys, :OutputIntents
+    #   end
+    #
     class RootHasKeys
 
       def initialize(*keys)
         @keys = keys.flatten
       end
 
-      def messages(ohash)
+      def check_hash(ohash)
         root = ohash.object(ohash.trailer[:Root])
         missing = @keys - root.keys
         missing.map { |key|
-          "Root dict missing required key #{key}"
+          Issue.new("Root dict missing required key #{key}", self, :key => key)
         }
       end
     end

metadata

@@ -1,164 +1,148 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: preflight
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-06 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: pdf-reader
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &19765840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 10
-        - 0
-        version: 0.10.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ttfunk
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 1
-        version: 1.0.1
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *19765840
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &19764920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: roodi
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *19764920
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: &19763500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *19763500
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &19762780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *19762780
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &19762260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: 4.4.2
   type: :development
-  version_requirements: *id005
-description: Provides a programatic way to check a PDF file conforms to standards like PDF-X/1a
-email: 
+  prerelease: false
+  version_requirements: *19762260
+description: Provides a programatic way to check a PDF file conforms to standards
+  like PDF-X/1a
+email:
 - james@yob.id.au
-executables: 
+executables:
 - is_pdfx_1a
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/preflight/profiles/pdfx1a.rb
-- lib/preflight/profiles/pdfa1a.rb
+files:
+- lib/preflight.rb
 - lib/preflight/profile.rb
-- lib/preflight/rules/root_has_keys.rb
-- lib/preflight/rules/min_ppi.rb
+- lib/preflight/profiles.rb
+- lib/preflight/rules/no_separation.rb
+- lib/preflight/rules/no_private_data.rb
 - lib/preflight/rules/print_boxes.rb
-- lib/preflight/rules/no_filespecs.rb
 - lib/preflight/rules/info_specifies_trapping.rb
-- lib/preflight/rules/only_embedded_fonts.rb
-- lib/preflight/rules/compression_algorithms.rb
-- lib/preflight/rules/no_encryption.rb
-- lib/preflight/rules/no_font_subsets.rb
 - lib/preflight/rules/match_info_entries.rb
-- lib/preflight/rules/max_version.rb
-- lib/preflight/rules/no_proprietary_fonts.rb
-- lib/preflight/rules/pdfx_output_intent_has_keys.rb
+- lib/preflight/rules/box_nesting.rb
 - lib/preflight/rules/output_intent_for_pdfx.rb
-- lib/preflight/rules/info_has_keys.rb
+- lib/preflight/rules/page_box_size.rb
+- lib/preflight/rules/max_ink_density.rb
+- lib/preflight/rules/page_box_width.rb
+- lib/preflight/rules/pdfx_output_intent_has_keys.rb
+- lib/preflight/rules/min_bleed.rb
+- lib/preflight/rules/no_rgb.rb
+- lib/preflight/rules/page_box_height.rb
+- lib/preflight/rules/no_cmyk.rb
+- lib/preflight/rules/min_ppi.rb
+- lib/preflight/rules/no_transparency.rb
+- lib/preflight/rules/no_filespecs.rb
+- lib/preflight/rules/no_gray.rb
 - lib/preflight/rules/document_id.rb
-- lib/preflight/rules/box_nesting.rb
-- lib/preflight/measurements.rb
+- lib/preflight/rules/max_version.rb
+- lib/preflight/rules/only_embedded_fonts.rb
+- lib/preflight/rules/no_font_subsets.rb
+- lib/preflight/rules/compression_algorithms.rb
+- lib/preflight/rules/mediabox_at_origin.rb
+- lib/preflight/rules/cropbox_matches_mediabox.rb
+- lib/preflight/rules/no_registration_black.rb
+- lib/preflight/rules/info_has_keys.rb
+- lib/preflight/rules/page_count.rb
+- lib/preflight/rules/root_has_keys.rb
+- lib/preflight/rules/no_page_rotation.rb
+- lib/preflight/rules/consistent_boxes.rb
+- lib/preflight/profiles/pdfa1a.rb
+- lib/preflight/profiles/pdfx1a.rb
 - lib/preflight/rules.rb
-- lib/preflight/profiles.rb
-- lib/preflight.rb
+- lib/preflight/measurements.rb
+- lib/preflight/issue.rb
 - bin/is_pdfx_1a
 - README.rdoc
 - CHANGELOG
-has_rdoc: true
 homepage: http://github.com/yob/pdf-preflight
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --title
 - PDF::Preflight
 - --line-numbers
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 2
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.2
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Check PDF files conform to various standards
 test_files: []
-