hexapdf 0.6.0 → 0.7.0

data/lib/hexapdf/type/info.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/names.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/object_stream.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -97,7 +97,7 @@ module HexaPDF
 
       define_type :ObjStm
 
-      define_field :Type,    type: Symbol, required: true, default: self.type, version: '1.5'
+      define_field :Type,    type: Symbol, required: true, default: type, version: '1.5'
       define_field :N,       type: Integer # not required, will be auto-filled on #write_objects
       define_field :First,   type: Integer # not required, will be auto-filled on #write_objects
       define_field :Extends, type: Stream
@@ -110,7 +110,7 @@ module HexaPDF
       def parse_stream
         data = stream
         oids, offsets = parse_oids_and_offsets(data)
-        oids.each {|oid| add_object(Reference.new(oid, 0))}
+        oids.each {|oid| add_object(Reference.new(oid, 0)) }
         Data.new(data, oids, offsets)
       end
 
@@ -200,7 +200,7 @@ module HexaPDF
         first = value[:First].to_i
 
         stream_tokenizer = Tokenizer.new(StringIO.new(data))
-        data.size > 0 && value[:N].to_i.times do
+        !data.empty? && value[:N].to_i.times do
           oids << stream_tokenizer.next_object
           offsets << first + stream_tokenizer.next_object
         end

data/lib/hexapdf/type/page.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -119,7 +119,7 @@ module HexaPDF
 
       define_type :Page
 
-      define_field :Type,                 type: Symbol, required: true, default: self.type
+      define_field :Type,                 type: Symbol, required: true, default: type
       define_field :Parent,               type: :Pages, required: true, indirect: true
       define_field :LastModified,         type: PDFDate, version: '1.3'
       define_field :Resources,            type: :XXResources
@@ -227,7 +227,7 @@ module HexaPDF
       # streams' data!
       def contents
         Array(self[:Contents]).each_with_object("".b) do |content_stream, content|
-          content << " ".freeze unless content.empty?
+          content << " " unless content.empty?
           content << document.deref(content_stream).stream
         end
       end
@@ -238,7 +238,7 @@ module HexaPDF
       # or by creating a new one if no content stream exists.
       def contents=(data)
         first, *rest = self[:Contents]
-        rest.each {|stream| document.delete(stream)}
+        rest.each {|stream| document.delete(stream) }
         if first
           self[:Contents] = first
           document.deref(first).stream = data
@@ -370,11 +370,10 @@ module HexaPDF
       def perform_validation(&block)
         super
         REQUIRED_INHERITABLE_FIELDS.each do |name|
-          if self[name].nil?
-            yield("Inheritable page field #{name} not set", name == :Resources)
-            self[:Resources] = {}
-            self[:Resources].validate(&block)
-          end
+          next if self[name]
+          yield("Inheritable page field #{name} not set", name == :Resources)
+          self[:Resources] = {}
+          self[:Resources].validate(&block)
         end
       end
 

data/lib/hexapdf/type/page_tree_node.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -61,7 +61,7 @@ module HexaPDF
 
       define_type :Pages
 
-      define_field :Type,   type: Symbol, required: true, default: self.type
+      define_field :Type,   type: Symbol, required: true, default: type
       define_field :Parent, type: Dictionary, indirect: true
       define_field :Kids,   type: Array, required: true, default: []
       define_field :Count,  type: Integer, required: true, default: 0
@@ -72,7 +72,6 @@ module HexaPDF
       define_field :CropBox,   type: Rectangle
       define_field :Rotate,    type: Integer
 
-
       # Returns +true+ since page tree objects must always be indirect.
       def must_be_indirect?
         true
@@ -175,7 +174,7 @@ module HexaPDF
         return nil unless page && page[:Parent]
 
         parent = page[:Parent]
-        index = parent[:Kids].index {|kid| document.deref(kid).data == page.data}
+        index = parent[:Kids].index {|kid| document.deref(kid).data == page.data }
 
         if index
           ancestors = [parent]
@@ -260,7 +259,7 @@ module HexaPDF
 
         if self[:Count] == 0
           yield("A PDF document needs at least one page", true)
-          add_page.validate {|msg, correctable| yield(msg, correctable)}
+          add_page.validate {|msg, correctable| yield(msg, correctable) }
         end
       end
 

data/lib/hexapdf/type/resources.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -64,20 +64,20 @@ module HexaPDF
       def color_space(name)
         case name
         when :DeviceRGB, :DeviceGray, :DeviceCMYK
-          GlobalConfiguration.constantize('color_space.map'.freeze, name).new
+          GlobalConfiguration.constantize('color_space.map', name).new
         else
           space_definition = self[:ColorSpace] && self[:ColorSpace][name]
           if space_definition.nil?
             raise HexaPDF::Error, "Color space '#{name}' not found in the resources"
           elsif space_definition.kind_of?(Array)
-            space_definition.map! {|item| document.deref(item)}
+            space_definition.map! {|item| document.deref(item) }
             space_family = space_definition[0]
           else
             space_family = space_definition
             space_definition = [space_definition]
           end
 
-          GlobalConfiguration.constantize('color_space.map'.freeze, space_family) do
+          GlobalConfiguration.constantize('color_space.map', space_family) do
             HexaPDF::Content::ColorSpace::Universal
           end.new(space_definition)
         end
@@ -97,7 +97,7 @@ module HexaPDF
         color_space_dict = self[:ColorSpace]
 
         name, _value = color_space_dict.value.find do |_k, v|
-          v.map! {|item| document.deref(item)}
+          v.map! {|item| document.deref(item) }
           v == definition
         end
         unless name
@@ -118,7 +118,7 @@ module HexaPDF
       #
       # If there already exists a name for the given XObject, it is just returned.
       def add_xobject(object)
-        object_setter(:XObject, 'XO'.freeze, object)
+        object_setter(:XObject, 'XO', object)
       end
 
       # Returns the graphics state parameter dictionary (see Type::GraphicsStateParameter) stored
@@ -134,7 +134,7 @@ module HexaPDF
       #
       # If there already exists a name for the given dictionary, it is just returned.
       def add_ext_gstate(object)
-        object_setter(:ExtGState, 'GS'.freeze, object)
+        object_setter(:ExtGState, 'GS', object)
       end
 
       # Returns the font dictionary stored under the given name.
@@ -148,7 +148,7 @@ module HexaPDF
       #
       # If there already exists a name for the given dictionary, it is just returned.
       def add_font(object)
-        object_setter(:Font, 'F'.freeze, object)
+        object_setter(:Font, 'F', object)
       end
 
       # Returns the property list stored under the given name.
@@ -162,7 +162,7 @@ module HexaPDF
       #
       # If there already exists a name for the given property list, it is just returned.
       def add_property_list(dict)
-        object_setter(:Properties, 'P'.freeze, dict)
+        object_setter(:Properties, 'P', dict)
       end
 
       private
@@ -180,7 +180,7 @@ module HexaPDF
       def object_setter(dict_name, prefix, object)
         self[dict_name] = {} unless key?(dict_name)
         dict = self[dict_name]
-        name, _value = dict.each.find {|_, dict_obj| dict_obj == object}
+        name, _value = dict.each.find {|_, dict_obj| dict_obj == object }
         unless name
           name = create_resource_name(dict.value, prefix)
           dict[name] = object

data/lib/hexapdf/type/trailer.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -110,7 +110,7 @@ module HexaPDF
         unless value[:Root]
           yield("A PDF document must have a Catalog dictionary", true)
           value[:Root] = document.add(Type: :Catalog)
-          value[:Root].validate {|message, correctable| yield(message, correctable)}
+          value[:Root].validate {|message, correctable| yield(message, correctable) }
         end
 
         if value[:Encrypt] && (!document.security_handler ||

data/lib/hexapdf/type/viewer_preferences.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/xref_stream.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -67,7 +67,8 @@ module HexaPDF
 
       define_type :XRef
 
-      define_field :Type,  type: Symbol, default: self.type, required: true, indirect: false, version: '1.5'
+      define_field :Type,  type: Symbol, default: type, required: true, indirect: false,
+                           version: '1.5'
       # Size is not required because it will be auto-filled before the object is written
       define_field :Size,  type: Integer, indirect: false
       define_field :Index, type: Array, indirect: false
@@ -75,7 +76,6 @@ module HexaPDF
       # W is not required because it will be auto-filled on #update_with_xref_section_and_trailer
       define_field :W,     type: Array, indirect: false
 
-
       # Returns an XRefSection that represents the content of this cross-reference stream.
       #
       # Each invocation returns a new XRefSection object based on the current data in the
@@ -98,6 +98,10 @@ module HexaPDF
       # Makes this cross-reference stream represent the data in the given HexaPDF::XRefSection and
       # Type::Trailer.
       #
+      # The +xref_section+ needs to contain an entry for this cross-reference stream and it is
+      # necessary that this entry is the one with the highest byte position (for calculating the
+      # correct /W entry).
+      #
       # The given cross-reference section is *not* stored but only used to rewrite the associated
       # stream to reflect the cross-reference section. The dictionary is updated with the
       # information from the trailer and the needed entries for the cross-reference section.

data/lib/hexapdf/utils/bit_field.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -68,7 +68,7 @@ module HexaPDF
         value_setter = "#{name}="
 
         define_method(lister) do
-          bit_names.map {|n| send(getter, n) ? n : nil}.compact
+          bit_names.map {|n| send(getter, n) ? n : nil }.compact
         end
         define_method(getter) do |bit|
           (send(value_getter) || 0)[mapping[bit]] == 1
@@ -76,7 +76,7 @@ module HexaPDF
         define_method(setter) do |*bits, clear_existing: false|
           send(value_setter, 0) if clear_existing || send(value_getter).nil?
           result = send(value_getter)
-          bits.each {|bit| result |= 1 << mapping[bit]}
+          bits.each {|bit| result |= 1 << mapping[bit] }
           send(value_setter, result)
         end
       end

data/lib/hexapdf/utils/bit_stream.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -44,7 +44,7 @@ module HexaPDF
     class BitStreamReader
 
       # Creates a new object, optionally providing the string from where the bits should be read.
-      def initialize(data = '')
+      def initialize(data = +'')
         @data = data.force_encoding(Encoding::BINARY)
         @pos = 0
         @bit_cache = 0
@@ -58,7 +58,7 @@ module HexaPDF
         @pos = 0
         self
       end
-      alias :<< :append_data
+      alias << append_data
 
       # Returns the number of remaining bits that can be read.
       def remaining_bits

data/lib/hexapdf/utils/graphics_helpers.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/utils/lru_cache.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/utils/math_helpers.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/utils/object_hash.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -114,7 +114,7 @@ module HexaPDF
       # generation number and the associated data as arguments.
       def each
         return to_enum(__method__) unless block_given?
-        @oids.keys.each {|oid| yield(oid, @oids[oid], @table[oid]) if @table.key?(oid)}
+        @oids.keys.each {|oid| yield(oid, @oids[oid], @table[oid]) if @table.key?(oid) }
         self
       end