preflight 0.1.1 → 0.2.0

data/lib/preflight/rules/no_cmyk.rb

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+require 'forwardable'
+
+module Preflight
+  module Rules
+
+    # Some print workflows forbid the use of CMYK colour.
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoCmyk
+    #   end
+    #
+    class NoCmyk
+      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_cmyk_color_for_stroking(c, m, y, k)
+        cmyk_detected(c, m, y, k)
+      end
+
+      def set_cmyk_color_for_nonstroking(c, m, y, k)
+        cmyk_detected(c, m, y, k)
+      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 color_space_is_cmyk?(cs)
+        case cs
+        when Symbol then cs == :DeviceCMYK
+        when Array  then
+          cs[0] == :DeviceCMYK || cs[2] == :DeviceCMYK
+        else
+          false
+        end
+      end
+
+      def check_color_space(label)
+        return if @resource_labels_seen.include?(label)
+
+        if color_space_is_cmyk?(@state.find_color_space(label))
+          @issues << Issue.new("CMYK color detected", self, :page  => @page.number)
+        end
+
+        @resource_labels_seen << label
+      end
+
+      def check_xobject(xobject)
+        cs = xobject.hash[:ColorSpace]
+        if cs == :DeviceCMYK
+          @issues << Issue.new("CMYK image detected", self, :page  => @page.number)
+        end
+      end
+
+      def cmyk_detected(c, m, y, k)
+        @issues << Issue.new("CMYK color detected", self, :page    => @page.number,
+                                                          :cyan    => c,
+                                                          :magenta => m,
+                                                          :yellow  => y,
+                                                          :k       => k)
+      end
+
+      def deref(obj)
+        @page.objects.deref(obj)
+      end
+
+    end
+
+  end
+end

data/lib/preflight/rules/no_filespecs.rb

@@ -3,14 +3,24 @@
 module Preflight
   module Rules
 
-    # PDF/X files are not allowed to use Filespecs to refer
-    # to external files.
+    # Check the target PDF doesn't use Filespecs to refer to external files.
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoFilespecs
+    #   end
     #
     class NoFilespecs
 
-      def messages(ohash)
-        if count_filespec_dicts(ohash) > 0
-          ["File uses at least 1 Filespec to refer to an external file"]
+      def check_hash(ohash)
+        filespecs_count = count_filespec_dicts(ohash)
+        if filespecs_count > 0
+          [Issue.new("File uses at least 1 Filespec to refer to an external file", self, :filespecs_count => filespecs_count)]
         else
           []
         end

data/lib/preflight/rules/no_font_subsets.rb

@@ -3,18 +3,27 @@
 module Preflight
   module Rules
 
-    # check a file has no font subsets. Subsets are handy and valid
-    # in standards like PDFX/1a, but they make it hard to edit a
-    # file
+    # check a file has no font subsets. Subsets are handy and valid in
+    # standards like PDFX/1a, but they can make it hard to edit a file
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoFontSubsets
+    #   end
     #
     class NoFontSubsets
 
-      def messages(ohash)
+      def check_hash(ohash)
         array = []
         ohash.each do |key, obj|
           next unless obj.is_a?(::Hash) && obj[:Type] == :Font
           if subset?(obj)
-            array << "Font #{obj[:BaseFont]} is a partial subset"
+            array << Issue.new("Font partially subseted (#{obj[:BaseFont]})", self, :base_font => obj[:BaseFont])
           end
         end
         array
@@ -23,7 +32,7 @@ module Preflight
       private
 
       def subset?(font)
-        font[:BaseFont] && font[:BaseFont].match(/.+\+.+/)
+        font[:BaseFont] && font[:BaseFont].to_s[/.+\+.+/]
       end
     end
   end

data/lib/preflight/rules/no_gray.rb

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+require 'forwardable'
+
+module Preflight
+  module Rules
+
+    # Some print workflows forbid the use of Gray colour.
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoGray
+    #   end
+    #
+    class NoGray
+      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_gray_for_stroking(g)
+        gray_detected(g)
+      end
+
+      def set_gray_for_nonstroking(g)
+        gray_detected(g)
+      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 color_space_is_gray?(cs)
+        case cs
+        when Symbol then cs == :DeviceGray
+        when Array  then
+          cs[0] == :DeviceGray || cs[2] == :DeviceGray
+        else
+          false
+        end
+      end
+
+      def check_color_space(label)
+        return if @resource_labels_seen.include?(label)
+
+        if color_space_is_gray?(@state.find_color_space(label))
+          @issues << Issue.new("Gray color detected", self, :page  => @page.number)
+        end
+
+        @resource_labels_seen << label
+      end
+
+      def check_xobject(xobject)
+        cs = xobject.hash[:ColorSpace]
+        if cs == :DeviceGray
+          @issues << Issue.new("Gray image detected", self, :page  => @page.number)
+        end
+      end
+
+      def gray_detected(g)
+        @issues << Issue.new("Gray color detected", self, :page  => @page.number,
+                                                          :gray  => g)
+      end
+    end
+
+  end
+end

data/lib/preflight/rules/no_page_rotation.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Ensure the target file contains no page rotation.
+    #
+    # Rotating pages is generally acceptable in most specs but it can cause
+    # rendering issues with poor waulity PDF consumers.
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoPageRotation
+    #   end
+    #
+    class NoPageRotation
+
+      attr_reader :issues
+
+      def page=(page)
+        attrs = page.attributes
+
+        if attrs[:Rotate] && 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_private_data.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+module Preflight
+  module Rules
+
+    # Ensure the target file contains no private application data.
+    #
+    # PDF generating apps (like Adobe Illustrator) can embed their own private
+    # data in saved PDFs. This data is generally harmless and ignored by all
+    # other PDF consumers, but it can lead to large increases in file size.
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoPrivateData
+    #   end
+    #
+    class NoPrivateData
+
+      attr_reader :issues
+
+      def page=(page)
+        attrs = page.attributes
+
+        if attrs[:PieceInfo]
+          @issues = [Issue.new("Page contains private PieceInfo data", self, :page => page.number)]
+        else
+          @issues = []
+        end
+      end
+    end
+  end
+end

data/lib/preflight/rules/no_registration_black.rb

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+require 'forwardable'
+
+module Preflight
+  module Rules
+
+    # Some print workflows forbid the use of Registration Black
+    #
+    # Arguments: none
+    #
+    # Usage:
+    #
+    #   class MyPreflight
+    #     include Preflight::Profile
+    #
+    #     rule Preflight::Rules::NoRegistrationBlack
+    #   end
+    #
+    class NoRegistrationBlack
+      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)
+          end
+        end
+      end
+
+      def set_cmyk_color_for_stroking(c, m, y, k)
+        reg_black_detected(c, m, y, k) if registration_black?(c, m, y, k)
+      end
+
+      def set_cmyk_color_for_nonstroking(c, m, y, k)
+        reg_black_detected(c, m, y, k) if registration_black?(c, m, y, k)
+      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 registration_black?(c, m, y, k)
+        c == 1 && m == 1 && y == 1 && k == 1
+      end
+
+      def color_space_is_all?(cs)
+        cs.is_a?(Array) && cs[1].to_s.downcase == "all"
+      end
+
+      def check_color_space(label)
+        return if @resource_labels_seen.include?(label)
+
+        if color_space_is_all?(@state.find_color_space(label))
+          @issues << Issue.new("'All' separation color detected", self, :page  => @page.number)
+        end
+
+        @resource_labels_seen << label
+      end
+
+      def reg_black_detected(c, m, y, k)
+        @issues << Issue.new("Registration black detected", self, :page    => @page.number,
+                                                                  :cyan    => c,
+                                                                  :magenta => m,
+                                                                  :yellow  => y,
+                                                                  :k       => k)
+      end
+
+      def deref(obj)
+        @page.objects.deref(obj)
+      end
+
+    end
+
+  end
+end