pdf-core 0.5.1 → 0.9.0

data/lib/pdf/core/graphics_state.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
 # Implements graphics state saving and restoring
 #
@@ -7,7 +8,6 @@
 # This is free software. Please see the LICENSE and COPYING files for details
 #
 
-
 module PDF
   module Core
     class GraphicStateStack
@@ -34,28 +34,26 @@ module PDF
       end
 
       def present?
-        stack.size > 0
+        !stack.empty?
       end
 
       def empty?
         stack.empty?
       end
-
     end
 
     # NOTE: This class may be a good candidate for a copy-on-write hash.
     class GraphicState
-      attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, 
-                    :fill_color, :stroke_color
+      attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, :fill_color, :stroke_color
 
       def initialize(previous_state = nil)
         if previous_state
           initialize_copy(previous_state)
         else
           @color_space  = {}
-          @fill_color   = "000000"
-          @stroke_color = "000000"
-          @dash         = { :dash => nil, :space => nil, :phase => 0 }
+          @fill_color   = '000000'
+          @stroke_color = '000000'
+          @dash         = { dash: nil, space: nil, phase: 0 }
           @cap_style    = :butt
           @join_style   = :miter
           @line_width   = 1
@@ -63,17 +61,17 @@ module PDF
       end
 
       def dash_setting
-        return "[] 0 d" unless @dash[:dash]
+        return '[] 0 d' unless @dash[:dash]
 
-        if @dash[:dash].kind_of?(Array)
-          array = @dash[:dash]
-        else
-          array = [@dash[:dash], @dash[:space]]
-        end
-        
-        
-        "[#{PDF::Core.real_params(array)}] "+
-        "#{PDF::Core.real(@dash[:phase])} d"
+        array =
+          if @dash[:dash].is_a?(Array)
+            @dash[:dash]
+          else
+            [@dash[:dash], @dash[:space]]
+          end
+
+        "[#{PDF::Core.real_params(array)}] "\
+          "#{PDF::Core.real(@dash[:phase])} d"
       end
 
       private
@@ -93,4 +91,3 @@ module PDF
     end
   end
 end
-

data/lib/pdf/core/literal_string.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module PDF
   module Core
     # This is used to differentiate strings that must be encoded as

data/lib/pdf/core/name_tree.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require 'pdf/core/utils'
 
 # name_tree.rb : Implements NameTree for PDF
 #
@@ -16,7 +18,7 @@ module PDF
         attr_accessor :parent
         attr_accessor :ref
 
-        def initialize(document, limit, parent=nil)
+        def initialize(document, limit, parent = nil)
           @document = document
           @children = []
           @limit = limit
@@ -29,7 +31,7 @@ module PDF
         end
 
         def size
-          leaf? ? children.size : children.inject(0) { |sum, child| sum + child.size }
+          leaf? ? children.size : children.sum(&:size)
         end
 
         def leaf?
@@ -47,10 +49,10 @@ module PDF
           if leaf?
             hash[:Names] = children if leaf?
           else
-            hash[:Kids] = children.map { |child| child.ref }
+            hash[:Kids] = children.map(&:ref)
           end
 
-          return hash
+          hash
         end
 
         def least
@@ -76,23 +78,24 @@ module PDF
             children.insert(insertion_point(value), value)
             split! if children.length > limit
           else
-            fit = children.detect { |child| child >= value }
-            fit = children.last unless fit
+            fit = children.find { |child| child >= value }
+            fit ||= children.last
             fit << value
           end
 
           value
         end
 
-        def >=(value)
-          children.empty? || children.last >= value
+        def >=(other)
+          children.empty? || children.last >= other
         end
 
         def split!
           if parent
             parent.split(self)
           else
-            left, right = new_node(self), new_node(self)
+            left = new_node(self)
+            right = new_node(self)
             split_children(self, left, right)
             children.replace([left, right])
           end
@@ -103,51 +106,50 @@ module PDF
         #
         def deep_copy
           node = dup
-          node.instance_variable_set("@children",
-                                     Marshal.load(Marshal.dump(children)))
-          node.instance_variable_set("@ref",
-                                     node.ref ? node.ref.deep_copy : nil)
+          node.instance_variable_set('@children', Utils.deep_clone(children))
+          node.instance_variable_set('@ref', node.ref ? node.ref.deep_copy : nil)
           node
         end
 
         protected
 
-          def split(node)
-            new_child = new_node(self)
-            split_children(node, node, new_child)
-            index = children.index(node)
-            children.insert(index+1, new_child)
-            split! if children.length > limit
-          end
+        def split(node)
+          new_child = new_node(self)
+          split_children(node, node, new_child)
+          index = children.index(node)
+          children.insert(index + 1, new_child)
+          split! if children.length > limit
+        end
 
         private
 
-          def new_node(parent=nil)
-            node = Node.new(document, limit, parent)
-            node.ref = document.ref!(node)
-            return node
-          end
+        def new_node(parent = nil)
+          node = Node.new(document, limit, parent)
+          node.ref = document.ref!(node)
+          node
+        end
 
-          def split_children(node, left, right)
-            half = (node.limit+1)/2
+        def split_children(node, left, right)
+          half = (node.limit + 1) / 2
 
-            left_children, right_children = node.children[0...half], node.children[half..-1]
+          left_children = node.children[0...half]
+          right_children = node.children[half..-1]
 
-            left.children.replace(left_children)
-            right.children.replace(right_children)
+          left.children.replace(left_children)
+          right.children.replace(right_children)
 
-            unless node.leaf?
-              left_children.each { |child| child.parent = left }
-              right_children.each { |child| child.parent = right }
-            end
+          unless node.leaf?
+            left_children.each { |child| child.parent = left }
+            right_children.each { |child| child.parent = right }
           end
+        end
 
-          def insertion_point(value)
-            children.each_with_index do |child, index|
-              return index if child >= value
-            end
-            return children.length
+        def insertion_point(value)
+          children.each_with_index do |child, index|
+            return index if child >= value
           end
+          children.length
+        end
       end
 
       class Value #:nodoc:
@@ -157,11 +159,12 @@ module PDF
         attr_reader :value
 
         def initialize(name, value)
-          @name, @value = PDF::Core::LiteralString.new(name), value
+          @name = PDF::Core::LiteralString.new(name)
+          @value = value
         end
 
-        def <=>(leaf)
-          name <=> leaf.name
+        def <=>(other)
+          name <=> other.name
         end
 
         def inspect

data/lib/pdf/core/object_store.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # Implements PDF object repository
 #
@@ -18,12 +18,12 @@ module PDF
         @identifiers = []
 
         @info  ||= ref(opts[:info] || {}).identifier
-        @root  ||= ref(:Type => :Catalog).identifier
+        @root  ||= ref(Type: :Catalog).identifier
         if opts[:print_scaling] == :none
-          root.data[:ViewerPreferences] = {:PrintScaling => :None}
+          root.data[:ViewerPreferences] = { PrintScaling: :None }
         end
         if pages.nil?
-          root.data[:Pages] = ref(:Type => :Pages, :Count => 0, :Kids => [])
+          root.data[:Pages] = ref(Type: :Pages, Count: 0, Kids: [])
         end
       end
 
@@ -48,22 +48,23 @@ module PDF
       end
 
       # Adds the given reference to the store and returns the reference object.
-      # If the object provided is not a PDF::Core::Reference, one is created from the
-      # arguments provided.
+      # If the object provided is not a PDF::Core::Reference, one is created
+      # from the arguments provided.
       #
       def push(*args, &block)
-        reference = if args.first.is_a?(PDF::Core::Reference)
-          args.first
-        else
-          PDF::Core::Reference.new(*args, &block)
-        end
+        reference =
+          if args.first.is_a?(PDF::Core::Reference)
+            args.first
+          else
+            PDF::Core::Reference.new(*args, &block)
+          end
 
         @objects[reference.identifier] = reference
         @identifiers << reference.identifier
         reference
       end
 
-      alias_method :<<, :push
+      alias << push
 
       def each
         @identifiers.each do |id|
@@ -78,7 +79,7 @@ module PDF
       def size
         @identifiers.size
       end
-      alias_method :length, :size
+      alias length size
 
       # returns the object ID for a particular page in the document. Pages
       # are indexed starting at 1 (not 0!).
@@ -90,17 +91,11 @@ module PDF
       #   object_id_for_page(-11)
       #   => 17
       #
-      def object_id_for_page(k)
-        k -= 1 if k > 0
+      def object_id_for_page(page)
+        page -= 1 if page.positive?
         flat_page_ids = get_page_objects(pages).flatten
-        flat_page_ids[k]
-      end
-
-      def is_utf8?(str)
-        str.force_encoding(::Encoding::UTF_8)
-        str.valid_encoding?
+        flat_page_ids[page]
       end
     end
   end
 end
-

data/lib/pdf/core/outline_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PDF
   module Core
     class OutlineItem #:nodoc:
@@ -11,11 +13,15 @@ module PDF
       end
 
       def to_hash
-        hash = { :Title => title,
-                 :Parent => parent,
-                 :Count => closed ? -count : count }
-        [{:First => first}, {:Last => last}, {:Next => defined?(@next) && @next},
-         {:Prev => prev}, {:Dest => dest}].each do |h|
+        hash = {
+          Title: title,
+          Parent: parent,
+          Count: closed ? -count : count
+        }
+        [
+          { First: first }, { Last: last }, { Next: defined?(@next) && @next },
+          { Prev: prev }, { Dest: dest }
+        ].each do |h|
           unless h.values.first.nil?
             hash.merge!(h)
           end

data/lib/pdf/core/outline_root.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PDF
   module Core
     class OutlineRoot #:nodoc:
@@ -8,7 +10,7 @@ module PDF
       end
 
       def to_hash
-        {:Type => :Outlines, :Count => count, :First => first, :Last => last}
+        { Type: :Outlines, Count: count, First: first, Last: last }
       end
     end
   end

data/lib/pdf/core/page.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # prawn/core/page.rb : Implements low-level representation of a PDF page
 #
@@ -12,21 +12,49 @@ require_relative 'graphics_state'
 module PDF
   module Core
     class Page #:nodoc:
-      attr_accessor :document, :margins, :stack
+      attr_accessor :art_indents, :bleeds, :crops, :document, :margins, :stack, :trims
       attr_writer :content, :dictionary
 
-      def initialize(document, options={})
+      ZERO_INDENTS = {
+        left: 0,
+        bottom: 0,
+        right: 0,
+        top: 0
+      }.freeze
+
+      def initialize(document, options = {})
         @document = document
-        @margins  = options[:margins] || { :left    => 36,
-                                           :right   => 36,
-                                           :top     => 36,
-                                           :bottom  => 36  }
+        @margins = options[:margins] || {
+          left: 36,
+          right: 36,
+          top: 36,
+          bottom: 36
+        }
+        @crops = options[:crops] || ZERO_INDENTS
+        @bleeds = options[:bleeds] || ZERO_INDENTS
+        @trims = options[:trims] || ZERO_INDENTS
+        @art_indents = options[:art_indents] || ZERO_INDENTS
         @stack = GraphicStateStack.new(options[:graphic_state])
-        if options[:object_id]
-          init_from_object(options)
-        else
-          init_new_page(options)
-        end
+        @size = options[:size] || 'LETTER'
+        @layout = options[:layout] || :portrait
+
+        @stamp_stream = nil
+        @stamp_dictionary = nil
+
+        @content = document.ref({})
+        content << 'q' << "\n"
+        @dictionary = document.ref(
+          Type: :Page,
+          Parent: document.state.store.pages,
+          MediaBox: dimensions,
+          CropBox: crop_box,
+          BleedBox: bleed_box,
+          TrimBox: trim_box,
+          ArtBox: art_box,
+          Contents: content
+        )
+
+        resources[:ProcSet] = %i[PDF Text ImageB ImageC ImageI]
       end
 
       def graphic_state
@@ -45,28 +73,26 @@ module PDF
       end
 
       def size
-        defined?(@size) && @size || dimensions[2,2]
+        defined?(@size) && @size || dimensions[2, 2]
       end
 
       def in_stamp_stream?
-        !!@stamp_stream
+        !@stamp_stream.nil?
       end
 
       def stamp_stream(dictionary)
-        @stamp_stream     = ""
         @stamp_dictionary = dictionary
+        @stamp_stream     = @stamp_dictionary.stream
         graphic_stack_size = stack.stack.size
 
         document.save_graphics_state
-        document.send(:freeze_stamp_graphics)
+        document.__send__(:freeze_stamp_graphics)
         yield if block_given?
 
         until graphic_stack_size == stack.stack.size
           document.restore_graphics_state
         end
 
-        @stamp_dictionary << @stamp_stream
-
         @stamp_stream      = nil
         @stamp_dictionary  = nil
       end
@@ -76,7 +102,8 @@ module PDF
       end
 
       def dictionary
-        defined?(@stamp_dictionary) && @stamp_dictionary || document.state.store[@dictionary]
+        defined?(@stamp_dictionary) && @stamp_dictionary ||
+          document.state.store[@dictionary]
       end
 
       def resources
@@ -116,62 +143,67 @@ module PDF
           dictionary.data[:Contents].each do |stream|
             stream.stream.compress! if document.compression_enabled?
           end
-        else
-          content.stream.compress! if document.compression_enabled?
+        elsif document.compression_enabled?
+          content.stream.compress!
         end
       end
 
-      def imported_page?
-        @imported_page
-      end
-
       def dimensions
-        return inherited_dictionary_value(:MediaBox) if imported_page?
-
         coords = PDF::Core::PageGeometry::SIZES[size] || size
-        [0,0] + case(layout)
-        when :portrait
-          coords
-        when :landscape
-          coords.reverse
-        else
-          raise PDF::Core::Errors::InvalidPageLayout,
-            "Layout must be either :portrait or :landscape"
-        end
+        [0, 0] +
+          case layout
+          when :portrait
+            coords
+          when :landscape
+            coords.reverse
+          else
+            raise PDF::Core::Errors::InvalidPageLayout,
+              'Layout must be either :portrait or :landscape'
+          end
       end
 
-      private
-
-      def init_from_object(options)
-        @dictionary = options[:object_id].to_i
-
-        unless dictionary.data[:Contents].is_a?(Array) # content only on leafs
-          @content    = dictionary.data[:Contents].identifier
-        end
-
-        @stamp_stream      = nil
-        @stamp_dictionary  = nil
-        @imported_page     = true
+      def art_box
+        left, bottom, right, top = dimensions
+        [
+          left + art_indents[:left],
+          bottom + art_indents[:bottom],
+          right - art_indents[:right],
+          top - art_indents[:top]
+        ]
       end
 
-      def init_new_page(options)
-        @size     = options[:size]    ||  "LETTER"
-        @layout   = options[:layout]  || :portrait
-
-        @stamp_stream      = nil
-        @stamp_dictionary  = nil
-        @imported_page     = false
+      def bleed_box
+        left, bottom, right, top = dimensions
+        [
+          left + bleeds[:left],
+          bottom + bleeds[:bottom],
+          right - bleeds[:right],
+          top - bleeds[:top]
+        ]
+      end
 
-        @content    = document.ref({})
-        content << "q" << "\n"
-        @dictionary = document.ref(:Type        => :Page,
-                                   :Parent      => document.state.store.pages,
-                                   :MediaBox    => dimensions,
-                                   :Contents    => content)
+      def crop_box
+        left, bottom, right, top = dimensions
+        [
+          left + crops[:left],
+          bottom + crops[:bottom],
+          right - crops[:right],
+          top - crops[:top]
+        ]
+      end
 
-        resources[:ProcSet] = [:PDF, :Text, :ImageB, :ImageC, :ImageI]
+      def trim_box
+        left, bottom, right, top = dimensions
+        [
+          left + trims[:left],
+          bottom + trims[:bottom],
+          right - trims[:right],
+          top - trims[:top]
+        ]
       end
 
+      private
+
       # some entries in the Page dict can be inherited from parent Pages dicts.
       #
       # Starting with the current page dict, this method will walk up the
@@ -183,12 +215,10 @@ module PDF
       def inherited_dictionary_value(key, local_dict = nil)
         local_dict ||= dictionary.data
 
-        if local_dict.has_key?(key)
+        if local_dict.key?(key)
           local_dict[key]
-        elsif local_dict.has_key?(:Parent)
+        elsif local_dict.key?(:Parent)
           inherited_dictionary_value(key, local_dict[:Parent].data)
-        else
-          nil
         end
       end
     end