pdf-core 0.5.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ad75dd976f2668839c982efd24ce49e3b699752
-  data.tar.gz: e93711787ed30c984b053d75c6ed64d4f26ad336
+SHA256:
+  metadata.gz: 429f3bfae75301dabdb339edccbdd816026f605dc84d1902f07d6494277d6360
+  data.tar.gz: 13fa187ef7307bc6de531a06d9d97272ff2ba0c2a9e21744b52efe1c387094d5
 SHA512:
-  metadata.gz: fd65e2ad057716601050e53cbb8b9e409cd5be8049c1dc54ad687d84b2f1311abe00b8d31b0542d2fd61cb36393be6044e0a4de2659b8eb444e8daf9faf861ad
-  data.tar.gz: 482df3ef1bb811625319b8098c51738218da5a2db3e22ca7dcdfdd14285c456d1bc35ed66d551b89eb861e841cbfde9bc69b346c50004314d5a653cac7077888
+  metadata.gz: 76f74e81e59e382b4ab8c0bfe0cd58eb6b8624afd4b6b92fee6ed56da432205ad682cd3bd99b364d29be38747727a198f796975cb7718c7f62ad682f33f4953f
+  data.tar.gz: b0b08cdd020ba23a4b3aa135d795eb35089cf0c6fbe34dd5457a3302f78969062347952b2f0f532b9066578a81537059afed889edd7d102817f26439b7f0848e

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,11 +1,29 @@
-require "bundler"
-Bundler.setup
+# frozen_string_literal: true
 
 require 'rake'
 require 'rspec/core/rake_task'
-task :default => [:spec]
 
-desc "Run all rspec files"
-RSpec::Core::RakeTask.new("spec") do |c|
-  c.rspec_opts = "-t ~unresolved"
+task default: %i[spec rubocop]
+
+desc 'Run all rspec files'
+RSpec::Core::RakeTask.new('spec') do |c|
+  c.rspec_opts = '-t ~unresolved'
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rubygems/package_task'
+spec = Gem::Specification.load 'pdf-core.gemspec'
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+task :checksum do
+  require 'digest/sha2'
+  built_gem_path = "pkg/pdf-core-#{Prawn::VERSION}.gem"
+  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksums/#{built_gem_path}.sha512"
+  File.write(checksum_path, checksum)
 end

data/lib/pdf/core.rb

@@ -1,26 +1,29 @@
-require_relative "core/pdf_object"
-require_relative "core/annotations"
-require_relative "core/byte_string"
-require_relative "core/destinations"
-require_relative "core/filters"
-require_relative "core/stream"
-require_relative "core/reference"
-require_relative "core/literal_string"
-require_relative "core/filter_list"
-require_relative "core/page"
-require_relative "core/object_store"
-require_relative "core/document_state"
-require_relative "core/name_tree"
-require_relative "core/graphics_state"
-require_relative "core/page_geometry"
-require_relative "core/outline_root"
-require_relative "core/outline_item"
-require_relative "core/renderer"
+# frozen_string_literal: true
+
+require_relative 'core/pdf_object'
+require_relative 'core/annotations'
+require_relative 'core/byte_string'
+require_relative 'core/destinations'
+require_relative 'core/filters'
+require_relative 'core/stream'
+require_relative 'core/reference'
+require_relative 'core/literal_string'
+require_relative 'core/filter_list'
+require_relative 'core/page'
+require_relative 'core/object_store'
+require_relative 'core/document_state'
+require_relative 'core/name_tree'
+require_relative 'core/graphics_state'
+require_relative 'core/page_geometry'
+require_relative 'core/outline_root'
+require_relative 'core/outline_item'
+require_relative 'core/renderer'
+require_relative 'core/text'
 
 module PDF
   module Core
     module Errors
-      # This error is raised when PdfObject() fails
+      # This error is raised when pdf_object() fails
       FailedObjectConversion = Class.new(StandardError)
 
       # This error is raise when trying to restore a graphic state that

data/lib/pdf/core/annotations.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # annotations.rb : Implements low-level annotation support for PDF
 #
@@ -11,7 +11,6 @@ module PDF
     # Provides very low-level support for annotations.
     #
     module Annotations #:nodoc:
-
       # Adds a new annotation (section 8.4 in PDF spec) to the current page.
       # +options+ must be a Hash describing the annotation.
       #
@@ -19,34 +18,35 @@ module PDF
         state.page.dictionary.data[:Annots] ||= []
         options = sanitize_annotation_hash(options)
         state.page.dictionary.data[:Annots] << ref!(options)
-        return options
+        options
       end
 
-      # A convenience method for creating Text annotations. +rect+ must be an array
-      # of four numbers, describing the bounds of the annotation. +contents+ should
-      # be a string, to be shown when the annotation is activated.
+      # A convenience method for creating Text annotations. +rect+ must be an
+      # array of four numbers, describing the bounds of the annotation.
+      # +contents+ should be a string, to be shown when the annotation is
+      # activated.
       #
-      def text_annotation(rect, contents, options={})
-        options = options.merge(:Subtype => :Text, :Rect => rect, :Contents => contents)
+      def text_annotation(rect, contents, options = {})
+        options = options.merge(Subtype: :Text, Rect: rect, Contents: contents)
         annotate(options)
       end
 
-      # A convenience method for creating Link annotations. +rect+ must be an array
-      # of four numbers, describing the bounds of the annotation. The +options+ hash
-      # should include either :Dest (describing the target destination, usually as a
-      # string that has been recorded in the document's Dests tree), or :A (describing
-      # an action to perform on clicking the link), or :PA (for describing a URL to
-      # link to).
+      # A convenience method for creating Link annotations. +rect+ must be an
+      # array of four numbers, describing the bounds of the annotation. The
+      # +options+ hash should include either :Dest (describing the target
+      # destination, usually as a string that has been recorded in the
+      # document's Dests tree), or :A (describing an action to perform on
+      # clicking the link), or :PA (for describing a URL to link to).
       #
-      def link_annotation(rect, options={})
-        options = options.merge(:Subtype => :Link, :Rect => rect)
+      def link_annotation(rect, options = {})
+        options = options.merge(Subtype: :Link, Rect: rect)
         annotate(options)
       end
 
       private
 
       def sanitize_annotation_hash(options)
-        options = options.merge(:Type => :Annot)
+        options = options.merge(Type: :Annot)
 
         if options[:Dest].is_a?(String)
           options[:Dest] = PDF::Core::LiteralString.new(options[:Dest])
@@ -54,7 +54,6 @@ module PDF
 
         options
       end
-
     end
   end
 end

data/lib/pdf/core/byte_string.rb

@@ -1,5 +1,6 @@
-# encoding: utf-8
-module PDF 
+# frozen_string_literal: true
+
+module PDF
   module Core
     # This is used to differentiate strings that must be encoded as
     # a byte string, such as binary data from encrypted strings.

data/lib/pdf/core/destinations.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # Implements destination support for PDF
 #
@@ -9,16 +9,19 @@
 module PDF
   module Core
     module Destinations #:nodoc:
-
-      # The maximum number of children to fit into a single node in the Dests tree.
+      # The maximum number of children to fit into a single node in the Dests
+      # tree.
       NAME_TREE_CHILDREN_LIMIT = 20 #:nodoc:
 
-      # The Dests name tree in the Name dictionary (see Prawn::Document::Internal#names).
-      # This name tree is used to store named destinations (PDF spec 8.2.1).
-      # (For more on name trees, see section 3.8.4 in the PDF spec.)
+      # The Dests name tree in the Name dictionary (see
+      # Prawn::Document::Internal#names).  This name tree is used to store named
+      # destinations (PDF spec 8.2.1).  (For more on name trees, see section
+      # 3.8.4 in the PDF spec.)
       #
       def dests
-        names.data[:Dests] ||= ref!(PDF::Core::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT))
+        names.data[:Dests] ||= ref!(
+          PDF::Core::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT)
+        )
       end
 
       # Adds a new destination to the dests name tree (see #dests). The
@@ -33,56 +36,56 @@ module PDF
       # Return a Dest specification for a specific location (and optional zoom
       # level).
       #
-      def dest_xyz(left, top, zoom=nil, dest_page=page)
+      def dest_xyz(left, top, zoom = nil, dest_page = page)
         [dest_page.dictionary, :XYZ, left, top, zoom]
       end
 
       # Return a Dest specification that will fit the given page into the
       # viewport.
       #
-      def dest_fit(dest_page=page)
+      def dest_fit(dest_page = page)
         [dest_page.dictionary, :Fit]
       end
 
       # Return a Dest specification that will fit the given page horizontally
       # into the viewport, aligned vertically at the given top coordinate.
       #
-      def dest_fit_horizontally(top, dest_page=page)
+      def dest_fit_horizontally(top, dest_page = page)
         [dest_page.dictionary, :FitH, top]
       end
 
       # Return a Dest specification that will fit the given page vertically
       # into the viewport, aligned horizontally at the given left coordinate.
       #
-      def dest_fit_vertically(left, dest_page=page)
+      def dest_fit_vertically(left, dest_page = page)
         [dest_page.dictionary, :FitV, left]
       end
 
       # Return a Dest specification that will fit the given rectangle into the
       # viewport, for the given page.
       #
-      def dest_fit_rect(left, bottom, right, top, dest_page=page)
+      def dest_fit_rect(left, bottom, right, top, dest_page = page)
         [dest_page.dictionary, :FitR, left, bottom, right, top]
       end
 
       # Return a Dest specfication that will fit the given page's bounding box
       # into the viewport.
       #
-      def dest_fit_bounds(dest_page=page)
+      def dest_fit_bounds(dest_page = page)
         [dest_page.dictionary, :FitB]
       end
 
       # Same as #dest_fit_horizontally, but works on the page's bounding box
       # instead of the entire page.
       #
-      def dest_fit_bounds_horizontally(top, dest_page=page)
+      def dest_fit_bounds_horizontally(top, dest_page = page)
         [dest_page.dictionary, :FitBH, top]
       end
 
       # Same as #dest_fit_vertically, but works on the page's bounding box
       # instead of the entire page.
       #
-      def dest_fit_bounds_vertically(left, dest_page=page)
+      def dest_fit_bounds_vertically(left, dest_page = page)
         [dest_page.dictionary, :FitBV, left]
       end
     end

data/lib/pdf/core/document_state.rb

@@ -1,20 +1,25 @@
+# frozen_string_literal: true
+
 module PDF
   module Core
     class DocumentState #:nodoc:
       def initialize(options)
         normalize_metadata(options)
 
-        if options[:print_scaling]
-          @store = PDF::Core::ObjectStore.new(:info => options[:info], 
-                                              :print_scaling => options[:print_scaling])
-        else
-          @store = PDF::Core::ObjectStore.new(:info => options[:info])
-        end
+        @store =
+          if options[:print_scaling]
+            PDF::Core::ObjectStore.new(
+              info: options[:info],
+              print_scaling: options[:print_scaling]
+            )
+          else
+            PDF::Core::ObjectStore.new(info: options[:info])
+          end
 
         @version                 = 1.3
         @pages                   = []
         @page                    = nil
-        @trailer                 = {}
+        @trailer                 = options.fetch(:trailer, {})
         @compress                = options.fetch(:compress, false)
         @encrypt                 = options.fetch(:encrypt, false)
         @encryption_key          = options[:encryption_key]
@@ -23,25 +28,24 @@ module PDF
         @on_page_create_callback = nil
       end
 
-      attr_accessor :store, :version, :pages, :page, :trailer, :compress,
-        :encrypt, :encryption_key, :skip_encoding,
-        :before_render_callbacks, :on_page_create_callback
+      attr_accessor :store, :version, :pages, :page, :trailer, :compress, :encrypt, :encryption_key, :skip_encoding
+      attr_accessor :before_render_callbacks, :on_page_create_callback
 
       def populate_pages_from_store(document)
-        return 0 if @store.page_count <= 0 || @pages.size > 0
+        return 0 if @store.page_count <= 0 || !@pages.empty?
 
         count = (1..@store.page_count)
-        @pages = count.map do |index|
-          orig_dict_id = @store.object_id_for_page(index)
-          PDF::Core::Page.new(document, :object_id => orig_dict_id)
-        end
-
+        @pages =
+          count.map do |index|
+            orig_dict_id = @store.object_id_for_page(index)
+            PDF::Core::Page.new(document, object_id: orig_dict_id)
+          end
       end
 
       def normalize_metadata(options)
         options[:info] ||= {}
-        options[:info][:Creator] ||= "Prawn"
-        options[:info][:Producer] ||= "Prawn"
+        options[:info][:Creator] ||= 'Prawn'
+        options[:info][:Producer] ||= 'Prawn'
 
         options[:info]
       end
@@ -56,8 +60,8 @@ module PDF
         on_page_create_callback[doc] if on_page_create_callback
       end
 
-      def before_render_actions(doc)
-        before_render_callbacks.each{ |c| c.call(self) }
+      def before_render_actions(_doc)
+        before_render_callbacks.each { |c| c.call(self) }
       end
 
       def page_count
@@ -67,8 +71,12 @@ module PDF
       def render_body(output)
         store.each do |ref|
           ref.offset = output.size
-          output << (@encrypt ? ref.encrypted_object(@encryption_key) :
-                                ref.object)
+          output <<
+            if @encrypt
+              ref.encrypted_object(@encryption_key)
+            else
+              ref.object
+            end
         end
       end
     end

data/lib/pdf/core/filter_list.rb

@@ -1,6 +1,20 @@
-module PDF 
+# frozen_string_literal: true
+
+module PDF
   module Core
     class FilterList
+      class NotFilter < StandardError
+        DEFAULT_MESSAGE = 'Can not interpret input as a filter'
+        MESSAGE_WITH_FILTER = 'Can not interpret input as a filter: %<filter>s'
+
+        def initialize(message = DEFAULT_MESSAGE, filter: nil)
+          if filter
+            super format(MESSAGE_WITH_FILTER, filter: filter)
+          else
+            super(message)
+          end
+        end
+      end
       def initialize
         @list = []
       end
@@ -14,7 +28,7 @@ module PDF
             @list << [name, params]
           end
         else
-          raise "Can not interpret input as filter: #{filter.inspect}"
+          raise NotFilter.new(filter: filter)
         end
 
         self
@@ -23,7 +37,7 @@ module PDF
       def normalized
         @list
       end
-      alias_method :to_a, :normalized
+      alias to_a normalized
 
       def names
         @list.map do |(name, _)|
@@ -42,9 +56,7 @@ module PDF
       end
 
       def each(&block)
-        @list.each do |filter|
-          block.call(filter)
-        end
+        @list.each(&block)
       end
     end
   end

data/lib/pdf/core/filters.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # prawn/core/filters.rb : Implements stream filters
 #
@@ -12,22 +12,22 @@ module PDF
   module Core
     module Filters
       module FlateDecode
-        def self.encode(stream, params = nil)
+        def self.encode(stream, _params = nil)
           Zlib::Deflate.deflate(stream)
         end
 
-        def self.decode(stream, params = nil)
+        def self.decode(stream, _params = nil)
           Zlib::Inflate.inflate(stream)
         end
       end
 
       # Pass through stub
       module DCTDecode
-        def self.encode(stream, params = nil)
+        def self.encode(stream, _params = nil)
           stream
         end
 
-        def self.decode(stream, params = nil)
+        def self.decode(stream, _params = nil)
           stream
         end
       end