preflight 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7ddc412afff34baf55fd47a7ddbadc740a660df
+  data.tar.gz: 115e731783daf82fa25e25fc389e3214883ad904
+SHA512:
+  metadata.gz: 7ff7e7d27c1b12b2a643b11b08cbcedc8fbc6ba4886301201f4b418c2bd0244d14cf4d3dd258f373d55cb9d5af54e12961ee54ae62f3104a6193e01f7e94e8ad
+  data.tar.gz: 1e1d33db176f3d6addb711cb9bbbef2a2e16f25c481ee045b3eb5ff4e97f32d3e54ef9b5094b6e317e3447a2cd0c50745edb53d868cc6c01cfc255af04f4ab46

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.3.0 (28th April 2013)
+- new rules
+- improved the behaviour of some rules
+- stopped rule arguments that are mutated from affected later profile checks
+
 v0.2.0 (25th March 2012)
 - BREAKING API CHANGES FROM 0.1.1 release
   - Detected issues are reported with an Issue object instead of a simple string

data/README.rdoc

@@ -121,3 +121,4 @@ This is pure ruby should run on most ruby VMs. I develop on MRI 1.9.2.
 * http://www.planetpdf.com/planetpdf/pdfs/pdfx3_draft4.pdf
 * http://www.gwg.org/doc_pdfxfaq.phtml
 * http://www.pdfxreport.com/lib/exe/fetch.php?id=en%3Adownloads&cache=cache&media=en:technote_pdfx_checks.pdf
+* http://shop.oreilly.com/product/0636920025269.do

data/lib/preflight/profile.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+
 module Preflight
 
   # base functionality for all profiles.
@@ -20,12 +21,12 @@ module Preflight
 
       def import(profile)
         profile.rules.each do |array|
-          rules << array.flatten
+          rules << array
         end
       end
 
       def rule(*args)
-        rules << args.flatten
+        rules << args
       end
 
       def rules
@@ -48,7 +49,7 @@ module Preflight
       end
 
       def rule(*args)
-        instance_rules << args.flatten
+        instance_rules << args
       end
 
       private
@@ -116,7 +117,7 @@ module Preflight
           arr.first.instance_methods.map(&:to_sym).include?(:check_hash)
         }.map { |arr|
           klass = arr[0]
-          klass.new(*arr[1,10])
+          klass.new(*deep_clone(arr[1,10]))
         }
       end
 
@@ -125,9 +126,16 @@ module Preflight
           arr.first.instance_methods.map(&:to_sym).include?(:issues)
         }.map { |arr|
           klass = arr[0]
-          klass.new(*arr[1,10])
+          klass.new(*deep_clone(arr[1,10]))
         }
       end
+
+      # round trip and object through marshall as a hacky but effective
+      # way to deep clone the object. Used to ensure rules that mutate
+      # their arguments don't impact later profile checks.
+      def deep_clone(obj)
+        Marshal.load Marshal.dump(obj)
+      end
     end
   end
 end

data/lib/preflight/rules.rb

@@ -1,4 +1,5 @@
 require 'preflight/rules/box_nesting'
+require 'preflight/rules/box_presence'
 require 'preflight/rules/compression_algorithms'
 require 'preflight/rules/consistent_boxes'
 require 'preflight/rules/cropbox_matches_mediabox'
@@ -12,6 +13,7 @@ require 'preflight/rules/mediabox_at_origin'
 require 'preflight/rules/min_bleed'
 require 'preflight/rules/min_ppi'
 require 'preflight/rules/no_cmyk'
+require 'preflight/rules/no_devicen'
 require 'preflight/rules/no_filespecs'
 require 'preflight/rules/no_font_subsets'
 require 'preflight/rules/no_gray'

data/lib/preflight/rules/box_presence.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Specify the presence of page boxes
+    #
+    # Arguments: hash containing :any or :all key with an array value of box
+    # names as symbols
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::BoxPresence, :any => [:MediaBox, :CropBox]
+    #     rule Preflight::Rules::BoxPresence, :all => [:MediaBox, :CropBox]
+    #   end
+    #
+    class BoxPresence
+
+      attr_reader :issues
+
+      def initialize(options)
+        if options[:any].nil? && options[:all].nil?
+          raise "Preflight::Rules::BoxPresence requires :any or :all option"
+        elsif options[:any] && options[:all]
+          raise "Preflight::Rules::BoxPresence requires only one of :any or :all option"
+        end
+
+        @options = options
+      end
+
+      def page=(page)
+        dict = page.attributes
+
+        present_boxes = dict.keys & [:MediaBox, :CropBox, :TrimBox, :ArtBox]
+
+        if @options[:any] && !@options[:any].any? { |b| present_boxes.include?(b) }
+          @issues = [Issue.new("page must have any of #{@options[:any].join(", ")}", self, :page => page.number)]
+        elsif @options[:all] && !@options[:all].all? { |b| present_boxes.include?(b) }
+          @issues = [Issue.new("page must have all of #{@options[:all].join(", ")}", self, :page => page.number)]
+        else
+          @issues = []
+        end
+      end
+    end
+  end
+end
+

data/lib/preflight/rules/consistent_boxes.rb

@@ -17,14 +17,15 @@ module Preflight
     #
     class ConsistentBoxes
 
-      # each page box MUST be within .03 PDF points of the same box
-      # on all other pages
-      TOLERANCE = (BigDecimal.new("-0.03")..BigDecimal.new("0.03"))
+      # Default tolerance is that each page box MUST be within .03 PDF points
+      # of the same box on all other pages
+      DEFAULT_TOLERANCE = (BigDecimal.new("-0.03")..BigDecimal.new("0.03"))
 
       attr_reader :issues
 
-      def initialize
+      def initialize(tolerance = DEFAULT_TOLERANCE)
         @boxes = {}
+        @tolerance = tolerance
       end
 
       def page=(page)
@@ -38,7 +39,7 @@ module Preflight
         @boxes[:ArtBox]   ||= dict[:ArtBox]
 
         %w(MediaBox CropBox BleedBox TrimBox ArtBox).map(&:to_sym).each do |box_type|
-          unless subtract_all(@boxes[box_type], dict[box_type]).all? { |diff| TOLERANCE.include?(diff) }
+          unless subtract_all(@boxes[box_type], dict[box_type]).all? { |diff| @tolerance.include?(diff) }
             @issues << Issue.new("#{box_type} must be consistent across every page", self, :page             => page.number,
                                                                                            :inconsistent_box => box_type)
           end

data/lib/preflight/rules/no_cmyk.rb

@@ -68,20 +68,24 @@ module Preflight
 
       private
 
-      def color_space_is_cmyk?(cs)
-        case cs
-        when Symbol then cs == :DeviceCMYK
-        when Array  then
-          cs[0] == :DeviceCMYK || cs[2] == :DeviceCMYK
-        else
-          false
-        end
+      def plain_cmyk?(cs)
+        cs == :DeviceCMYK || cs == [:DeviceCMYK]
+      end
+
+      def indexed_cmyk?(cs)
+        cs.is_a?(Array) && cs[0] == :Indexed && cs[1] == :DeviceCMYK
+      end
+
+      def alternative_is_cmyk?(cs)
+        cs.is_a?(Array) && cs[0] == :Separation && cs[2] == :DeviceCMYK
       end
 
       def check_color_space(label)
         return if @resource_labels_seen.include?(label)
 
-        if color_space_is_cmyk?(@state.find_color_space(label))
+        cs = @state.find_color_space(label)
+
+        if plain_cmyk?(cs) || indexed_cmyk?(cs) || alternative_is_cmyk?(cs)
           @issues << Issue.new("CMYK color detected", self, :page  => @page.number)
         end
 
@@ -90,7 +94,7 @@ module Preflight
 
       def check_xobject(xobject)
         cs = xobject.hash[:ColorSpace]
-        if cs == :DeviceCMYK
+        if plain_cmyk?(cs) || indexed_cmyk?(cs) || alternative_is_cmyk?(cs)
           @issues << Issue.new("CMYK image detected", self, :page  => @page.number)
         end
       end

data/lib/preflight/rules/no_devicen.rb

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+require 'forwardable'
+
+module Preflight
+  module Rules
+
+    # Some print workflows forbid the use of DeviceN colours (one or
+    # more spot colours).
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoDevicen
+    #   end
+    #
+    class NoDevicen
+      extend  Forwardable
+
+      # Graphics State Operators
+      def_delegators :@state, :save_graphics_state, :restore_graphics_state
+
+      # Matrix Operators
+      def_delegators :@state, :concatenate_matrix
+
+      attr_reader :issues
+
+      # we're about to start a new page, reset state
+      #
+      def page=(page)
+        @page   = page
+        @state  = PDF::Reader::PageState.new(page)
+        @issues = []
+        @resource_labels_seen = []
+      end
+
+      # descend into nested form xobjects
+      #
+      def invoke_xobject(label)
+        @state.invoke_xobject(label) do |xobj|
+          case xobj
+          when PDF::Reader::FormXObject then
+            xobj.walk(self)
+          when PDF::Reader::Stream then
+            check_xobject(xobj)
+          end
+        end
+      end
+
+      def set_stroke_color_space(label)
+        check_color_space(label)
+      end
+
+      def set_nonstroke_color_space(label)
+        check_color_space(label)
+      end
+
+      private
+
+      def plain_devicen_names(cs)
+        if cs.is_a?(Array) && cs[0] == :DeviceN
+          @page.objects.deref(cs[1])
+        end
+      end
+
+      def indexed_devicen_names(cs)
+        if cs.is_a?(Array) && cs[0] == :Indexed
+          indexed_base = @page.objects.deref(cs[1])
+          if indexed_base.is_a?(Array) && indexed_base[0] == :DeviceN
+            @page.objects.deref(indexed_base[1])
+          end
+        end
+      end
+
+      def check_color_space(label)
+        return if @resource_labels_seen.include?(label)
+
+        cs           = @state.find_color_space(label)
+        spot_names   = plain_devicen_names(cs)
+        spot_names ||= indexed_devicen_names(cs)
+        if spot_names
+          @issues << Issue.new("DeviceN color detected", self, :page => @page.number,
+                                                               :names => spot_names)
+        end
+
+        @resource_labels_seen << label
+      end
+
+      def check_xobject(xobject)
+        cs = xobject.hash[:ColorSpace]
+        spot_names   = plain_devicen_names(cs)
+        spot_names ||= indexed_devicen_names(cs)
+        if spot_names
+          @issues << Issue.new("DeviceN image detected", self, :page  => @page.number,
+                                                               :names => spot_names)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/preflight/rules/no_gray.rb

@@ -68,20 +68,24 @@ module Preflight
 
       private
 
-      def color_space_is_gray?(cs)
-        case cs
-        when Symbol then cs == :DeviceGray
-        when Array  then
-          cs[0] == :DeviceGray || cs[2] == :DeviceGray
-        else
-          false
-        end
+      def plain_gray?(cs)
+        cs == :DeviceGray || cs == [:DeviceGray]
+      end
+
+      def indexed_gray?(cs)
+        cs.is_a?(Array) && cs[0] == :Indexed && cs[1] == :DeviceGray
+      end
+
+      def alternative_is_gray?(cs)
+        cs.is_a?(Array) && cs[0] == :Separation && cs[2] == :DeviceGray
       end
 
       def check_color_space(label)
         return if @resource_labels_seen.include?(label)
 
-        if color_space_is_gray?(@state.find_color_space(label))
+        cs = @state.find_color_space(label)
+
+        if plain_gray?(cs) || indexed_gray?(cs) || alternative_is_gray?(cs)
           @issues << Issue.new("Gray color detected", self, :page  => @page.number)
         end
 
@@ -90,7 +94,7 @@ module Preflight
 
       def check_xobject(xobject)
         cs = xobject.hash[:ColorSpace]
-        if cs == :DeviceGray
+        if plain_gray?(cs) || indexed_gray?(cs) || alternative_is_gray?(cs)
           @issues << Issue.new("Gray image detected", self, :page  => @page.number)
         end
       end

data/lib/preflight/rules/no_page_rotation.rb

@@ -25,12 +25,13 @@ module Preflight
       def page=(page)
         attrs = page.attributes
 
-        if attrs[:Rotate] && attrs[:Rotate] != 0
+        if attrs[:Rotate] && page.objects.deref(attrs[:Rotate]) != 0
           @issues = [Issue.new("Page is rotated", self, :page => page.number)]
         else
           @issues = []
         end
       end
+
     end
   end
 end

data/lib/preflight/rules/no_rgb.rb

@@ -68,20 +68,24 @@ module Preflight
 
       private
 
-      def color_space_is_rgb?(cs)
-        case cs
-        when Symbol then cs == :DeviceRGB
-        when Array  then
-          cs[2] == :DeviceRGB
-        else
-          false
-        end
+      def plain_rgb?(cs)
+        cs == :DeviceRGB || cs == [:DeviceRGB]
+      end
+
+      def indexed_rgb?(cs)
+        cs.is_a?(Array) && cs[0] == :Indexed && cs[1] == :DeviceRGB
+      end
+
+      def alternative_is_rgb?(cs)
+        cs.is_a?(Array) && cs[0] == :Separation && cs[2] == :DeviceRGB
       end
 
       def check_color_space(label)
         return if @resource_labels_seen.include?(label)
 
-        if color_space_is_rgb?(@state.find_color_space(label))
+        cs = @state.find_color_space(label)
+
+        if plain_rgb?(cs) || indexed_rgb?(cs) || alternative_is_rgb?(cs)
           @issues << Issue.new("RGB color detected", self, :page  => @page.number)
         end
 
@@ -90,7 +94,7 @@ module Preflight
 
       def check_xobject(xobject)
         cs = xobject.hash[:ColorSpace]
-        if cs == :DeviceRGB
+        if plain_rgb?(cs) || indexed_rgb?(cs) || alternative_is_rgb?(cs)
           @issues << Issue.new("RGB image detected", self, :page  => @page.number)
         end
       end

data/lib/preflight/rules/no_separation.rb

@@ -45,6 +45,8 @@ module Preflight
           case xobj
           when PDF::Reader::FormXObject then
             xobj.walk(self)
+          when PDF::Reader::Stream then
+            check_xobject(xobj)
           end
         end
       end
@@ -59,18 +61,26 @@ module Preflight
 
       private
 
-      def separation_name(cs)
+      def plain_separation_name(cs)
         if cs.is_a?(Array) && cs[0] == :Separation
           cs[1]
-        else
-          nil
+        end
+      end
+
+      def indexed_separation_name(cs)
+        if cs.is_a?(Array) && cs[0] == :Indexed
+          if cs[1].is_a?(Array) && cs[1][0] == :Separation
+            cs[1][1]
+          end
         end
       end
 
       def check_color_space(label)
         return if @resource_labels_seen.include?(label)
 
-        spot_name = separation_name(@state.find_color_space(label))
+        cs          = @state.find_color_space(label)
+        spot_name   = plain_separation_name(cs)
+        spot_name ||= indexed_separation_name(cs)
         if spot_name
           @issues << Issue.new("Separation color detected #{spot_name}", self, :page => @page.number,
                                                                                :name => spot_name)
@@ -79,6 +89,16 @@ module Preflight
         @resource_labels_seen << label
       end
 
+      def check_xobject(xobject)
+        cs = xobject.hash[:ColorSpace]
+        spot_name   = plain_separation_name(cs)
+        spot_name ||= indexed_separation_name(cs)
+        if spot_name
+          @issues << Issue.new("Separation image detected", self, :page  => @page.number,
+                                                                  :name  => spot_name)
+        end
+      end
+
     end
 
   end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: preflight
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pdf-reader
-  requirement: &19765840 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *19765840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19764920 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19764920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: roodi
-  requirement: &19763500 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19763500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19762780 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *19762780
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &19762260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.4.2
   type: :development
   prerelease: false
-  version_requirements: *19762260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.2
 description: Provides a programatic way to check a PDF file conforms to standards
   like PDF-X/1a
 email:
@@ -77,49 +91,52 @@ extra_rdoc_files: []
 files:
 - lib/preflight.rb
 - lib/preflight/profile.rb
-- lib/preflight/profiles.rb
+- lib/preflight/rules.rb
+- lib/preflight/rules/page_box_size.rb
+- lib/preflight/rules/page_count.rb
+- lib/preflight/rules/no_cmyk.rb
 - lib/preflight/rules/no_separation.rb
-- lib/preflight/rules/no_private_data.rb
-- lib/preflight/rules/print_boxes.rb
-- lib/preflight/rules/info_specifies_trapping.rb
-- lib/preflight/rules/match_info_entries.rb
+- lib/preflight/rules/info_has_keys.rb
+- lib/preflight/rules/document_id.rb
+- lib/preflight/rules/no_registration_black.rb
 - lib/preflight/rules/box_nesting.rb
-- lib/preflight/rules/output_intent_for_pdfx.rb
-- lib/preflight/rules/page_box_size.rb
-- lib/preflight/rules/max_ink_density.rb
+- lib/preflight/rules/max_version.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/pdfx_output_intent_has_keys.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_devicen.rb
 - lib/preflight/rules/no_gray.rb
-- lib/preflight/rules/document_id.rb
-- lib/preflight/rules/max_version.rb
-- lib/preflight/rules/only_embedded_fonts.rb
+- lib/preflight/rules/no_filespecs.rb
+- lib/preflight/rules/max_ink_density.rb
+- lib/preflight/rules/box_presence.rb
+- lib/preflight/rules/print_boxes.rb
+- lib/preflight/rules/no_transparency.rb
+- lib/preflight/rules/no_page_rotation.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/info_specifies_trapping.rb
+- lib/preflight/rules/output_intent_for_pdfx.rb
+- lib/preflight/rules/mediabox_at_origin.rb
+- lib/preflight/rules/match_info_entries.rb
+- lib/preflight/rules/no_private_data.rb
 - lib/preflight/rules/consistent_boxes.rb
-- lib/preflight/profiles/pdfa1a.rb
-- lib/preflight/profiles/pdfx1a.rb
-- lib/preflight/rules.rb
+- lib/preflight/rules/only_embedded_fonts.rb
+- lib/preflight/rules/min_bleed.rb
+- lib/preflight/rules/compression_algorithms.rb
+- lib/preflight/rules/min_ppi.rb
+- lib/preflight/rules/root_has_keys.rb
 - lib/preflight/measurements.rb
 - lib/preflight/issue.rb
+- lib/preflight/profiles.rb
+- lib/preflight/profiles/pdfa1a.rb
+- lib/preflight/profiles/pdfx1a.rb
 - bin/is_pdfx_1a
 - README.rdoc
 - CHANGELOG
 homepage: http://github.com/yob/pdf-preflight
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --title
@@ -128,21 +145,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.2
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Check PDF files conform to various standards
 test_files: []