Update code style

prawnpdf · May 5, 2018 · 37303f5 · 37303f5
1 parent 5b5ffe5
commit 37303f5
Show file tree

Hide file tree

Showing 198 changed files with 439 additions and 52 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,5 +1,8 @@
 require: rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 2.3
+
 RSpec/ExampleLength:
   Enabled: false
 

diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
diff --git a/Rakefile b/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler.setup
 

diff --git a/bench/afm_text_bench.rb b/bench/afm_text_bench.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'prawn'
 require 'benchmark'

diff --git a/bench/png_type_6.rb b/bench/png_type_6.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'prawn'
 require 'benchmark'

diff --git a/bench/png_type_6_objects.rb b/bench/png_type_6_objects.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'prawn'
 

diff --git a/bench/table_bench.rb b/bench/table_bench.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'prawn'
 require 'benchmark'

diff --git a/bench/ttf_text_bench.rb b/bench/ttf_text_bench.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'prawn'
 require 'benchmark'

diff --git a/lib/prawn.rb b/lib/prawn.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Welcome to Prawn, the best PDF Generation library ever.
 # This documentation covers user level functionality.
 #

diff --git a/lib/prawn/document.rb b/lib/prawn/document.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # document.rb : Implements PDF document generation for Prawn
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.
@@ -269,7 +271,7 @@ def start_new_page(options = {})
 
         # erase the color space so that it gets reset on new page for fussy
         # pdf-readers
-        new_graphic_state.color_space = {} if new_graphic_state
+        new_graphic_state&.color_space = {}
 
         page_options[:graphic_state] = new_graphic_state
       end

diff --git a/lib/prawn/document/bounding_box.rb b/lib/prawn/document/bounding_box.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # bounding_box.rb : Implements a mechanism for shifting the coordinate space
 #
 # Copyright May 2008, Gregory Brown. All Rights Reserved.

diff --git a/lib/prawn/document/column_box.rb b/lib/prawn/document/column_box.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # column_box.rb: Extends BoundingBox to allow for columns of text
 #
 # Author Paul Ostazeski.

diff --git a/lib/prawn/document/internals.rb b/lib/prawn/document/internals.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # internals.rb : Implements document internals for Prawn
 #
 # Copyright August 2008, Gregory Brown. All Rights Reserved.

diff --git a/lib/prawn/document/span.rb b/lib/prawn/document/span.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # span.rb : Implements text columns
 #
 # Copyright September 2008, Gregory Brown. All Rights Reserved.

diff --git a/lib/prawn/encoding.rb b/lib/prawn/encoding.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright September 2008, Gregory Brown, James Healy  All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.

diff --git a/lib/prawn/errors.rb b/lib/prawn/errors.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # errors.rb : Implements custom error classes for Prawn
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.

diff --git a/lib/prawn/font.rb b/lib/prawn/font.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # font.rb : The Prawn font class
 #
 # Copyright May 2008, Gregory Brown / James Healy. All Rights Reserved.
@@ -355,8 +357,11 @@ def normalize_encoding(_string)
     # Destructive version of normalize_encoding; normalizes the encoding of a
     # string in place.
     #
+    # @deprecated
     def normalize_encoding!(str)
-      str.replace(normalize_encoding(str))
+      warn 'Font#normalize_encoding! is deprecated. ' \
+        'Please use non-mutating version Font#normalize_encoding instead.'
+      str.dup.replace(normalize_encoding(str))
     end
 
     # Gets height of current font in PDF points at the given font size

diff --git a/lib/prawn/font/afm.rb b/lib/prawn/font/afm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # prawn/font/afm.rb : Implements AFM font support for Prawn
 #
 # Copyright May 2008, Gregory Brown / James Healy.  All Rights Reserved.

diff --git a/lib/prawn/font/dfont.rb b/lib/prawn/font/dfont.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'ttf'
 
 module Prawn

diff --git a/lib/prawn/font/ttc.rb b/lib/prawn/font/ttc.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'ttf'
 
 module Prawn

diff --git a/lib/prawn/font/ttf.rb b/lib/prawn/font/ttf.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # prawn/font/ttf.rb : Implements AFM font support for Prawn
 #
 # Copyright May 2008, Gregory Brown / James Healy / Jamis Buck
@@ -182,7 +184,7 @@ def to_utf8(text)
 
       def glyph_present?(char)
         code = char.codepoints.first
-        cmap[code] > 0
+        cmap[code].positive?
       end
 
       # Returns the number of characters in +str+ (a UTF-8-encoded string).
@@ -313,7 +315,7 @@ def embed(reference, subset)
           ranges.last << format('<%02x><%04x>', code, unicode)
         end
 
-        range_blocks = ranges.inject('') do |s, list|
+        range_blocks = ranges.inject(+'') do |s, list|
           s << format(
             "%d beginbfchar\n%s\nendbfchar\n",
             list.length, list.join("\n")

diff --git a/lib/prawn/font_metric_cache.rb b/lib/prawn/font_metric_cache.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # font_metric_cache.rb : The Prawn font class
 #
 # Copyright Dec 2012, Kenneth Kalmer. All Rights Reserved.

diff --git a/lib/prawn/graphics.rb b/lib/prawn/graphics.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # graphics.rb : Implements PDF drawing primitives
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.

diff --git a/lib/prawn/graphics/blend_mode.rb b/lib/prawn/graphics/blend_mode.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # blend_mode.rb : Implements blend modes
 #
 # Contributed by John Ford. October, 2015

diff --git a/lib/prawn/graphics/cap_style.rb b/lib/prawn/graphics/cap_style.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # cap_style.rb : Implements stroke cap styling
 #
 # Contributed by Daniel Nelson. October, 2009

diff --git a/lib/prawn/graphics/color.rb b/lib/prawn/graphics/color.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # color.rb : Implements color handling
 #
 # Copyright June 2008, Gregory Brown.  All Rights Reserved.

diff --git a/lib/prawn/graphics/dash.rb b/lib/prawn/graphics/dash.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dash.rb : Implements stroke dashing
 #
 # Contributed by Daniel Nelson. October, 2009
@@ -61,7 +63,7 @@ def dash(length = nil, options = {})
         if length.all?(&:zero?)
           raise ArgumentError,
             'Zero length dashes are invalid. Call #undash to disable dashes.'
-        elsif length.any? { |e| e < 0 }
+        elsif length.any?(&:negative?)
           raise ArgumentError,
             'Negative numbers are not allowed for dash lengths.'
         end

diff --git a/lib/prawn/graphics/join_style.rb b/lib/prawn/graphics/join_style.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # join_style.rb : Implements stroke join styling
 #
 # Contributed by Daniel Nelson. October, 2009

diff --git a/lib/prawn/graphics/patterns.rb b/lib/prawn/graphics/patterns.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha1'
 
 # patterns.rb : Implements axial & radial gradients

diff --git a/lib/prawn/graphics/transformation.rb b/lib/prawn/graphics/transformation.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # transformation.rb: Implements rotate, translate, skew, scale and a generic
 #                     transformation_matrix
 #

diff --git a/lib/prawn/graphics/transparency.rb b/lib/prawn/graphics/transparency.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # transparency.rb : Implements transparency
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.

diff --git a/lib/prawn/grid.rb b/lib/prawn/grid.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # grid.rb: Provides a basic grid layout system for Prawn
 #
 # Contributed by Andrew O'Brien in March 2009

diff --git a/lib/prawn/image_handler.rb b/lib/prawn/image_handler.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ImageHandler provides a way to register image processors with Prawn
 #
 # Contributed by Evan Sharp in November 2013.

diff --git a/lib/prawn/images.rb b/lib/prawn/images.rb
@@ -1,4 +1,7 @@
 # encoding: ASCII-8BIT
+
+# frozen_string_literal: true
+
 # images.rb : Implements PDF image embedding
 #
 # Copyright April 2008, James Healy, Gregory Brown.  All Rights Reserved.

diff --git a/lib/prawn/images/image.rb b/lib/prawn/images/image.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # image.rb : Base class for image info objects
 #
 # Copyright September 2011, Brad Ediger. All rights reserved.

diff --git a/lib/prawn/images/jpg.rb b/lib/prawn/images/jpg.rb
@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # jpg.rb : Extracts the data from a JPG that is needed for embedding
 #
 # Copyright April 2008, James Healy.  All Rights Reserved.

diff --git a/lib/prawn/images/png.rb b/lib/prawn/images/png.rb
@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # png.rb : Extracts the data from a PNG that is needed for embedding
 #
 # Based on some similar code in PDF::Writer by Austin Ziegler
@@ -38,8 +40,8 @@ def initialize(data)
 
         data.read(8) # Skip the default header
 
-        @palette = ''
-        @img_data = ''
+        @palette = +''
+        @img_data = +''
         @transparency = {}
 
         loop do

diff --git a/lib/prawn/measurement_extensions.rb b/lib/prawn/measurement_extensions.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # measurement_extensions.rb: Core extensions for Prawn::Measurements
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.

diff --git a/lib/prawn/measurements.rb b/lib/prawn/measurements.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # measurements.rb: Conversions from other measurements to PDF points
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.

diff --git a/lib/prawn/outline.rb b/lib/prawn/outline.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prawn
   class Document
     # @group Stable API

diff --git a/lib/prawn/repeater.rb b/lib/prawn/repeater.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # repeater.rb : Implements repeated page elements.
 # Heavy inspired by repeating_element() in PDF::Wrapper
 #   http://pdf-wrapper.rubyforge.org/

diff --git a/lib/prawn/security.rb b/lib/prawn/security.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encryption.rb : Implements encrypted PDF and access permissions.
 #
 # Copyright August 2008, Brad Ediger. All Rights Reserved.
@@ -215,9 +217,9 @@ module Core
     def encrypted_pdf_object(obj, key, id, gen, in_content_stream = false)
       case obj
       when Array
-        '[' << obj.map do |e|
+        '[' + obj.map do |e|
           encrypted_pdf_object(e, key, id, gen, in_content_stream)
-        end.join(' ') << ']'
+        end.join(' ') + ']'
       when LiteralString
         obj = ByteString.new(
           Prawn::Document::Security.encrypt_string(obj, key, id, gen)
@@ -237,16 +239,16 @@ def encrypted_pdf_object(obj, key, id, gen, in_content_stream = false)
           in_content_stream
         )
       when ::Hash
-        output = '<< '
-        obj.each do |k, v|
-          unless k.is_a?(String) || k.is_a?(Symbol)
-            raise PDF::Core::Errors::FailedObjectConversion,
-              'A PDF Dictionary must be keyed by names'
-          end
-          output << pdf_object(k.to_sym, in_content_stream) << ' ' <<
-            encrypted_pdf_object(v, key, id, gen, in_content_stream) << "\n"
-        end
-        output << '>>'
+        '<< ' +
+          obj.map do |k, v|
+            unless k.is_a?(String) || k.is_a?(Symbol)
+              raise PDF::Core::Errors::FailedObjectConversion,
+                'A PDF Dictionary must be keyed by names'
+            end
+            pdf_object(k.to_sym, in_content_stream) + ' ' +
+              encrypted_pdf_object(v, key, id, gen, in_content_stream) + "\n"
+          end.join('') +
+          '>>'
       when NameTree::Value
         pdf_object(obj.name) + ' ' +
           encrypted_pdf_object(obj.value, key, id, gen, in_content_stream)
@@ -276,9 +278,9 @@ class Reference
       # Returns the object definition for the object this references, keyed from
       # +key+.
       def encrypted_object(key)
-        @on_encode.call(self) if @on_encode
+        @on_encode&.call(self)
 
-        output = "#{@identifier} #{gen} obj\n"
+        output = +"#{@identifier} #{gen} obj\n"
         if @stream.empty?
           output <<
             PDF::Core.encrypted_pdf_object(data, key, @identifier, gen) << "\n"

diff --git a/lib/prawn/security/arcfour.rb b/lib/prawn/security/arcfour.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implementation of the "ARCFOUR" algorithm ("alleged RC4 (tm)"). Implemented
 # as described at:
 # http://www.mozilla.org/projects/security/pki/nss/draft-kaukonen-cipher-arcfour-03.txt

diff --git a/lib/prawn/soft_mask.rb b/lib/prawn/soft_mask.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # soft_mask.rb : Implements soft-masking
 #
 # Copyright September 2012, Alexander Mankuta. All Rights Reserved.

diff --git a/lib/prawn/stamp.rb b/lib/prawn/stamp.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # stamp.rb : Implements a repeatable stamp
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.