prawn 2.1.0 → 2.3.0

data/lib/prawn/text/formatted/wrap.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # wrap.rb: Handles text wrapping for for formatted text
 #
@@ -6,8 +6,8 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require_relative "line_wrap"
-require_relative "arranger"
+require_relative 'line_wrap'
+require_relative 'arranger'
 
 module Prawn
   module Text
@@ -15,10 +15,12 @@ module Prawn
       # @private
 
       module Wrap #:nodoc:
-        def initialize(array, options)
+        def initialize(_array, options)
           @line_wrap = Prawn::Text::Formatted::LineWrap.new
-          @arranger = Prawn::Text::Formatted::Arranger.new(@document,
-                                                           :kerning => options[:kerning])
+          @arranger = Prawn::Text::Formatted::Arranger.new(
+            @document,
+            kerning: options[:kerning]
+          )
           @disable_wrap_by_char = options[:disable_wrap_by_char]
         end
 
@@ -46,15 +48,17 @@ module Prawn
           initialize_wrap(array)
 
           stop = false
-          while !stop
+          until stop
             # wrap before testing if enough height for this line because the
             # height of the highest fragment on this line will be used to
             # determine the line height
-            @line_wrap.wrap_line(:document => @document,
-                                 :kerning => @kerning,
-                                 :width => available_width,
-                                 :arranger => @arranger,
-                                 :disable_wrap_by_char => @disable_wrap_by_char)
+            @line_wrap.wrap_line(
+              document: @document,
+              kerning: @kerning,
+              width: available_width,
+              arranger: @arranger,
+              disable_wrap_by_char: @disable_wrap_by_char
+            )
 
             if enough_height_for_this_line?
               move_baseline_down
@@ -78,30 +82,36 @@ module Prawn
           fragments_this_line = []
 
           word_spacing = word_spacing_for_this_line
-          while fragment = @arranger.retrieve_fragment
+          @arranger.fragments.each do |fragment|
             fragment.word_spacing = word_spacing
             if fragment.text == "\n"
-              printed_fragments << "\n" if @printed_lines.last == ""
+              printed_fragments << "\n" if @printed_lines.last == ''
               break
             end
             printed_fragments << fragment.text
             fragments_this_line << fragment
           end
+          @arranger.fragments.replace []
 
           accumulated_width = 0
           fragments_this_line.reverse! if @direction == :rtl
           fragments_this_line.each do |fragment_this_line|
             fragment_this_line.default_direction = @direction
-            format_and_draw_fragment(fragment_this_line, accumulated_width,
-                                     @line_wrap.width, word_spacing)
+            format_and_draw_fragment(
+              fragment_this_line, accumulated_width,
+              @line_wrap.width, word_spacing
+            )
             accumulated_width += fragment_this_line.width
           end
 
-          @printed_lines << printed_fragments.map { |s| s.force_encoding(::Encoding::UTF_8) }.join
+          @printed_lines << printed_fragments.map do |s|
+            s.dup.force_encoding(::Encoding::UTF_8)
+          end.join
         end
 
         def word_spacing_for_this_line
-          if @align == :justify && @line_wrap.space_count > 0 && !@line_wrap.paragraph_finished?
+          if @align == :justify && @line_wrap.space_count.positive? &&
+              !@line_wrap.paragraph_finished?
             (available_width - @line_wrap.width) / @line_wrap.space_count
           else
             0
@@ -110,13 +120,13 @@ module Prawn
 
         def enough_height_for_this_line?
           @line_height = @arranger.max_line_height
-          @descender   = @arranger.max_descender
-          @ascender    = @arranger.max_ascender
-          if @baseline_y == 0
-            diff = @ascender + @descender
-          else
-            diff = @descender + @line_height + @leading
-          end
+          @descender = @arranger.max_descender
+          @ascender = @arranger.max_ascender
+          diff = if @baseline_y.zero?
+                   @ascender + @descender
+                 else
+                   @descender + @line_height + @leading
+                 end
           require_relatived_total_height = @baseline_y.abs + diff
           if require_relatived_total_height > @height + 0.0001
             # no room for the full height of this line
@@ -133,9 +143,9 @@ module Prawn
 
           # these values will depend on the maximum value within a given line
           @line_height = 0
-          @descender   = 0
-          @ascender    = 0
-          @baseline_y  = 0
+          @descender = 0
+          @ascender = 0
+          @baseline_y = 0
 
           @printed_lines = []
           @nothing_printed = true
@@ -143,10 +153,12 @@ module Prawn
         end
 
         def format_and_draw_fragment(fragment, accumulated_width,
-                                     line_width, word_spacing)
+          line_width, word_spacing)
           @arranger.apply_color_and_font_settings(fragment) do
-            draw_fragment(fragment, accumulated_width,
-                          line_width, word_spacing)
+            draw_fragment(
+              fragment, accumulated_width,
+              line_width, word_spacing
+            )
           end
         end
       end

data/lib/prawn/transformation_stack.rb

@@ -1,14 +1,15 @@
-# encoding: utf-8
-#
-# transformation_stack.rb : Stores the transformations that have been applied to the document
+# frozen_string_literal: true
+
+# transformation_stack.rb : Stores the transformations that have been applied to
+# the document
 #
 # Copyright 2015, Roger Nesbitt. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
-#
 
 require 'matrix'
 
+# rubocop: disable Metrics/ParameterLists, Naming/MethodParameterName
 module Prawn
   module TransformationStack
     def add_to_transformation_stack(a, b, c, d, e, f)
@@ -22,7 +23,7 @@ module Prawn
     end
 
     def restore_transformation_stack
-      @transformation_stack.pop if @transformation_stack
+      @transformation_stack&.pop
     end
 
     def current_transformation_matrix_with_translation(x = 0, y = 0)
@@ -40,3 +41,4 @@ module Prawn
     end
   end
 end
+# rubocop: enable Metrics/ParameterLists, Naming/MethodParameterName

data/lib/prawn/utilities.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # utilities.rb : General-purpose utility classes which don't fit anywhere else
 #
@@ -6,18 +6,18 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'thread'
-
 module Prawn
-  # Throughout the Prawn codebase, repeated calculations which can benefit from caching are made
-  # In some cases, caching and reusing results can not only save CPU cycles but also greatly
-  #   reduce memory requirements
+  # Throughout the Prawn codebase, repeated calculations which can benefit from
+  # caching are made.
+  # In some cases, caching and reusing results can not only save CPU cycles but
+  # also greatly reduce memory requirements
   # But at the same time, we don't want to throw away thread safety
   # We have two interchangeable thread-safe cache implementations:
 
   # @private
   class SynchronizedCache
-    # As an optimization, this could access the hash directly on VMs with a global interpreter lock (like MRI)
+    # As an optimization, this could access the hash directly on VMs with
+    # a global interpreter lock (like MRI)
     def initialize
       @cache = {}
       @mutex = Mutex.new
@@ -31,19 +31,4 @@ module Prawn
       @mutex.synchronize { @cache[key] = value }
     end
   end
-
-  # @private
-  class ThreadLocalCache
-    def initialize
-      @cache_id = "cache_#{self.object_id}".to_sym
-    end
-
-    def [](key)
-      (Thread.current[@cache_id] ||= {})[key]
-    end
-
-    def []=(key, value)
-      (Thread.current[@cache_id] ||= {})[key] = value
-    end
-  end
 end

data/lib/prawn/version.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Prawn
-  VERSION = "2.1.0"
+  VERSION = '2.3.0'
 end

data/lib/prawn/view.rb

@@ -1,5 +1,5 @@
-# encoding: UTF-8
-#
+# frozen_string_literal: true
+
 # prawn/view.rb : Implements a mixin for Prawn's DSL
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
@@ -11,6 +11,12 @@ module Prawn
   #     class Greeter
   #       include Prawn::View
   #
+  #       # Optional override: allows you to set document options or even use
+  #       # a custom document class
+  #       def document
+  #         @document ||= Prawn::Document.new(page_size: 'A4')
+  #       end
+  #
   #       def initialize(name)
   #         @name = name
   #       end
@@ -63,10 +69,14 @@ module Prawn
 
     # Delegates all unhandled calls to object returned by +document+ method.
     # (which is an instance of Prawn::Document by default)
-    def method_missing(m, *a, &b)
-      return super unless document.respond_to?(m)
+    def method_missing(method_name, *arguments, &block)
+      return super unless document.respond_to?(method_name)
+
+      document.send(method_name, *arguments, &block)
+    end
 
-      document.send(m, *a, &b)
+    def respond_to_missing?(method_name, _include_all = false)
+      document.respond_to?(method_name)
     end
 
     # Syntactic sugar that uses +instance_eval+ under the hood to provide
@@ -77,8 +87,8 @@ module Prawn
     #      say_goodbye
     #    end
     #
-    def update(&b)
-      instance_eval(&b)
+    def update(&block)
+      instance_eval(&block)
     end
 
     # Syntatic sugar that calls +document.render_file+ under the hood.

data/manual/basic_concepts/adding_pages.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # A PDF document is a collection of pages. When we create a new document be it
 # with <code>Document.new</code> or on a <code>Document.generate</code> block
 # one initial page is created for us.
@@ -12,14 +12,13 @@
 #
 # Just use the <code>start_new_page</code> method and a shiny new page will be
 # created for you just like in the following snippet.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  text "We are still on the initial page for this example. Now I'll ask " +
-       "Prawn to gently start a new page. Please follow me to the next page."
+  text "We are still on the initial page for this example. Now I'll ask " \
+    'Prawn to gently start a new page. Please follow me to the next page.'
 
   start_new_page
 

data/manual/basic_concepts/basic_concepts.rb

@@ -1,34 +1,43 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for Prawn basic concepts.
 #
 
-require_relative "../example_helper"
+require_relative '../example_helper'
 
-Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
-  package "basic_concepts" do |p|
-    p.example "creation", :eval_source => false, :full_source => true
-    p.example "origin"
-    p.example "cursor"
-    p.example "other_cursor_helpers"
-    p.example "adding_pages"
-    p.example "measurement"
-    p.example "view", :eval_source => false, :full_source => true
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
+  package 'basic_concepts' do |p|
+    p.example 'creation', eval_source: false, full_source: true
+    p.example 'origin'
+    p.example 'cursor'
+    p.example 'other_cursor_helpers'
+    p.example 'adding_pages'
+    p.example 'measurement'
+    p.example 'view', eval_source: false, full_source: true
 
     p.intro do
-      prose("This chapter covers the minimum amount of functionality you'll need to start using Prawn.
+      prose <<-TEXT
+        This chapter covers the minimum amount of functionality you'll need to
+        start using Prawn.
 
-      If you are new to Prawn this is the first chapter to read. Once you are comfortable with the concepts shown here you might want to check the Basics section of the Graphics, Bounding Box and Text sections.
+        If you are new to Prawn this is the first chapter to read. Once you are
+        comfortable with the concepts shown here you might want to check the
+        Basics section of the Graphics, Bounding Box and Text sections.
 
-      The examples show:")
+        The examples show:
+      TEXT
 
-      list( "How to create new pdf documents in every possible way",
-            "Where the origin for the document coordinates is. What are Bounding Boxes and how they interact with the origin",
-            "How the cursor behaves",
-            "How to start new pages",
-            "What the base unit for measurement and coordinates is and how to use other convenient measures",
-            "How to build custom view objects that use Prawn's DSL"
-          )
+      list(
+        'How to create new pdf documents in every possible way',
+        'Where the origin for the document coordinates is. What are Bounding '\
+          'Boxes and how they interact with the origin',
+        'How the cursor behaves',
+        'How to start new pages',
+        'What the base unit for measurement and coordinates is and how to use '\
+          'other convenient measures',
+        "How to build custom view objects that use Prawn's DSL"
+      )
     end
   end
 end

data/manual/basic_concepts/creation.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # There are three ways to create a PDF Document in Prawn: creating a new
 # <code>Prawn::Document</code> instance, or using the
 # <code>Prawn::Document.generate</code> method with and without block arguments.
@@ -19,21 +19,20 @@
 # The generate method without block arguments requires
 # less typing and defines and renders the pdf document in one shot.
 # Almost all of the examples are coded this way.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 # Assignment
 pdf = Prawn::Document.new
-pdf.text "Hello World"
-pdf.render_file "assignment.pdf"
+pdf.text 'Hello World'
+pdf.render_file 'assignment.pdf'
 
 # Implicit Block
-Prawn::Document.generate("implicit.pdf") do
-  text "Hello World"
+Prawn::Document.generate('implicit.pdf') do
+  text 'Hello World'
 end
 
 # Explicit Block
-Prawn::Document.generate("explicit.pdf") do |pdf|
-  pdf.text "Hello World"
+Prawn::Document.generate('explicit.pdf') do |pdf|
+  pdf.text 'Hello World'
 end

data/manual/basic_concepts/cursor.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # We normally write our documents from top to bottom and it is no different with
 # Prawn. Even if the origin is on the bottom left corner we still fill the page
 # from the top to the bottom. In other words the cursor for inserting content
@@ -11,9 +11,8 @@
 # The following snippet shows how the cursor behaves when we add some text to
 # the page and demonstrates some of the helpers to manage the cursor position.
 # The <code>cursor</code> method returns the current cursor position.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do

data/manual/basic_concepts/measurement.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The base unit in Prawn is the PDF Point. One PDF Point is equal to 1/72 of
 # an inch.
 #
@@ -10,15 +10,14 @@
 # Just <code>require "prawn/measurement_extensions"</code> and it will mix some
 # helpers onto <code>Numeric</code> for converting common measurement units to
 # PDF Points.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  require "prawn/measurement_extensions"
+  require 'prawn/measurement_extensions'
 
-  [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|
+  %i[mm cm dm m in yd ft].each do |measurement|
     text "1 #{measurement} in PDF Points: #{1.send(measurement)} pt"
     move_down 5.mm
   end