prawn 2.2.2 → 2.3.0

data/spec/prawn/graphics_stroke_styles_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Graphics do

data/spec/prawn/image_handler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::ImageHandler do

data/spec/prawn/images/jpg_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Spec'ing the PNG class. Not complete yet - still needs to check the
 # contents of palette and transparency to ensure they're correct.
 # Need to find files that have these sections first.

data/spec/prawn/images/png_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Spec'ing the PNG class. Not complete yet - still needs to check the
 # contents of palette and transparency to ensure they're correct.
 # Need to find files that have these sections first.

data/spec/prawn/images_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'set'
 require 'pathname'
@@ -41,12 +43,63 @@ describe Prawn::Images do
     expect(info.height).to eq(453)
   end
 
+  it 'does not close passed-in IO objects' do
+    file = File.open(filename, 'rb')
+    _info = pdf.image(file)
+
+    expect(file).to_not be_closed
+  end
+
   it 'accepts Pathname objects' do
     info = pdf.image(Pathname.new(filename))
     expect(info.height).to eq(453)
   end
 
-  context 'setting the length of the bytestream' do
+  describe 'closes opened files again after getting Pathnames', issue: 975 do
+    describe 'spec with File message spy' do
+      let(:not_filename) { 'non-existent filename' }
+      let(:pathname_double) { instance_double('Pathname', file?: true) }
+
+      before do
+        file_content = File.new(filename, 'rb').read
+        allow(Pathname).to receive(:new).with(not_filename) { pathname_double }
+        allow(pathname_double).to receive(:binread) { file_content }
+      end
+
+      it 'uses only binread, which closes opened files' do
+        # this implicitly tests that a file handle is closed again
+        # because only stubbed binread can be called on not_filename
+        _info = pdf.image(not_filename)
+        expect(pathname_double).to have_received(:binread)
+      end
+    end
+
+    system_has_lsof = system('lsof -v > /dev/null 2>&1')
+    system_has_grep = system('grep --version > /dev/null 2>&1')
+    if system_has_lsof && system_has_grep
+      it 'closes opened files, spec with lsof' do
+        gc_was_disabled = GC.disable # GC of File would close the file
+        open_before = `lsof -c ruby | grep "#{filename}"`
+        _info = pdf.image(Pathname.new(filename))
+        open_after = `lsof -c ruby | grep "#{filename}"`
+        GC.enable unless gc_was_disabled
+        expect(open_after).to eq(open_before)
+      end
+    end
+
+    if RUBY_PLATFORM != 'java'
+      it 'closes opened files, spec with ObjectSpace' do
+        gc_was_disabled = GC.disable # GC of File would close the file
+        open_before = ObjectSpace.each_object(File).count { |f| !f.closed? }
+        _info = pdf.image(Pathname.new(filename))
+        open_after = ObjectSpace.each_object(File).count { |f| !f.closed? }
+        GC.enable unless gc_was_disabled
+        expect(open_after).to eq(open_before)
+      end
+    end
+  end
+
+  describe 'setting the length of the bytestream' do
     it 'correctlies work with images from Pathname objects' do
       pdf.image(Pathname.new(filename))
       expect(pdf).to have_parseable_xobjects
@@ -111,7 +164,7 @@ describe Prawn::Images do
     end[:Kids]
     expect(pages.size).to eq(1)
     expect(Set.new(hash[pages[0]][:Resources][:XObject].keys)).to eq(
-      Set.new([:I1, :I2])
+      Set.new(%i[I1 I2])
     )
   end
 
@@ -137,6 +190,7 @@ describe Prawn::Images do
       expect(info.scaled_width).to eq(604)
       expect(info.scaled_height).to eq(453)
     end
+
     it 'moves text position' do
       y = pdf.y
       pdf.image filename, fit: [100, 400]

data/spec/prawn/measurements_extensions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'prawn/measurement_extensions'
 

data/spec/prawn/outline_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Outline do
@@ -42,6 +44,7 @@ describe Prawn::Outline do
     it 'stores all outline titles as UTF-16' do
       hash.each_value do |obj|
         next unless obj.is_a?(Hash) && obj[:Title]
+
         title = obj[:Title].dup
         title.force_encoding(Encoding::UTF_16LE)
         expect(title.valid_encoding?).to eq(true)
@@ -157,7 +160,7 @@ describe Prawn::Outline do
   end
 
   describe '#outline.add_subsection_to' do
-    context 'positioned last' do
+    context 'when positioned last' do
       before do
         pdf.start_new_page
         pdf.text 'Page 3. An added subsection '
@@ -203,7 +206,7 @@ describe Prawn::Outline do
       end
     end
 
-    context 'positioned first' do
+    context 'when positioned first' do
       before do
         pdf.start_new_page
         pdf.text 'Page 3. An added subsection '
@@ -395,6 +398,7 @@ describe Prawn::Outline do
   def find_by_title(title)
     hash.values.find do |obj|
       next unless obj.is_a?(Hash) && obj[:Title]
+
       title_codepoints = obj[:Title].unpack('n*')
       title_codepoints.shift
       utf8_title = title_codepoints.pack('U*')

data/spec/prawn/repeater_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Repeater do
@@ -128,11 +130,11 @@ describe Prawn::Repeater do
     doc
   end
 
-  def repeater(*args, &b)
-    Prawn::Repeater.new(*args, &b)
+  def repeater(*args, &block)
+    Prawn::Repeater.new(*args, &block)
   end
 
-  context 'graphic state' do
+  describe 'graphic state' do
     let(:pdf) { create_pdf }
 
     it 'does not alter the graphic state stack color space' do
@@ -144,7 +146,7 @@ describe Prawn::Repeater do
         .to eq(starting_color_space)
     end
 
-    context 'dynamic repeaters' do
+    context 'with dynamic repeaters' do
       it 'preserves the graphic state at creation time' do
         pdf.repeat :all, dynamic: true do
           pdf.text "fill_color: #{pdf.graphic_state.fill_color}"

data/spec/prawn/soft_mask_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::SoftMask do

data/spec/prawn/stamp_spec.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Stamp do
   describe 'create_stamp before any page is added' do
     let(:pdf) { Prawn::Document.new(skip_page_creation: true) }
+
     it 'works with the font class' do
       # If anything goes wrong, Prawn::Errors::NotOnPage will be raised
       pdf.create_stamp('my_stamp') do
@@ -35,16 +38,16 @@ describe Prawn::Stamp do
   describe 'Document with a stamp' do
     let(:pdf) { create_pdf }
 
-    it 'should raise_error NameTaken error when attempt to create stamp ' \
-      'with same name as an existing stamp' do
+    it 'raises NameTaken error when attempt to create stamp with '\
+       'same name as an existing stamp' do
       pdf.create_stamp('MyStamp')
       expect do
         pdf.create_stamp('MyStamp')
       end.to raise_error(Prawn::Errors::NameTaken)
     end
 
-    it 'should raise_error InvalidName error when attempt to create ' \
-      'stamp with a blank name' do
+    it 'raises InvalidName error when attempt to create stamp with '\
+        'a blank name' do
       expect do
         pdf.create_stamp('')
       end.to raise_error(Prawn::Errors::InvalidName)
@@ -92,7 +95,8 @@ describe Prawn::Stamp do
       objects = output.split('endobj')
 
       objects.each do |obj|
-        next unless obj =~ %r{/Type /Page$}
+        next unless %r{/Type /Page$}.match?(obj)
+
         # The page object must contain the annotation reference
         # to render a clickable link
         expect(obj).to match(%r{^/Annots \[\d \d .\]$})
@@ -112,9 +116,9 @@ describe Prawn::Stamp do
       output = pdf.render
       objects = output.split('endobj')
       objects.each do |object|
-        if object =~ %r{/Type /Page$}
+        if %r{/Type /Page$}.match?(object)
           expect(object).to_not match(%r{/ExtGState})
-        elsif object =~ %r{/Type /XObject$}
+        elsif %r{/Type /XObject$}.match?(object)
           expect(object).to match(%r{/ExtGState})
         end
       end

data/spec/prawn/text/box_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Box do
@@ -56,8 +58,8 @@ describe Prawn::Text::Box do
     expect(text.strings[1]).to eq("I'm fine, thank you.")
   end
 
-  it 'should only require enough space for the descender and the ascender ' \
-    'when determining whether a line can fit' do
+  it 'only requires enough space for the descender and the ascender '\
+     'when determining whether a line can fit' do
     text = 'Oh hai text rect'
     options = {
       document: pdf,
@@ -110,8 +112,7 @@ describe Prawn::Text::Box do
   end
 
   describe '#line_gap' do
-    it 'should == the line gap of the font when using a single ' \
-      'font and font size' do
+    it '==S the line gap of the font when using a single font and font size' do
       string = "Hello world, how are you?\nI'm fine, thank you."
       text_box = described_class.new(string, document: pdf)
       text_box.render
@@ -140,8 +141,8 @@ describe Prawn::Text::Box do
   end
 
   describe '#height without leading' do
-    it 'should == the sum of the height of each line, ' \
-      'not including the space below the last line' do
+    it 'is the sum of the height of each line, not including the space below '\
+       'the last line' do
       text = "Oh hai text rect.\nOh hai text rect."
       options = { document: pdf }
       text_box = described_class.new(text, options)
@@ -152,8 +153,8 @@ describe Prawn::Text::Box do
   end
 
   describe '#height with leading' do
-    it 'should == the sum of the height of each line plus leading, ' \
-      'but not including the space below the last line' do
+    it 'is the sum of the height of each line plus leading, but not including '\
+       'the space below the last line' do
       text = "Oh hai text rect.\nOh hai text rect."
       leading = 12
       options = { document: pdf, leading: leading }
@@ -327,7 +328,7 @@ describe Prawn::Text::Box do
       }
     end
 
-    context ':rotate_around option of :center' do
+    context 'with :rotate_around option of :center' do
       it 'draws content to the page rotated about the center of the text' do
         options[:rotate_around] = :center
         text_box = described_class.new(text, options)
@@ -356,7 +357,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context ':rotate_around option of :upper_left' do
+    context 'with :rotate_around option of :upper_left' do
       it 'draws content to the page rotated about the upper left corner of '\
         'the text' do
         options[:rotate_around] = :upper_left
@@ -384,7 +385,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context 'default :rotate_around' do
+    context 'with default :rotate_around' do
       it 'draws content to the page rotated about the upper left corner of '\
         'the text' do
         text_box = described_class.new(text, options)
@@ -411,7 +412,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context ':rotate_around option of :upper_right' do
+    context 'with :rotate_around option of :upper_right' do
       it 'draws content to the page rotated about the upper right corner of '\
         'the text' do
         options[:rotate_around] = :upper_right
@@ -441,7 +442,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context ':rotate_around option of :lower_right' do
+    context 'with :rotate_around option of :lower_right' do
       it 'draws content to the page rotated about the lower right corner of '\
         'the text' do
         options[:rotate_around] = :lower_right
@@ -471,7 +472,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context ':rotate_around option of :lower_left' do
+    context 'with :rotate_around option of :lower_left' do
       it 'draws content to the page rotated about the lower left corner of '\
         'the text' do
         options[:rotate_around] = :lower_left
@@ -521,8 +522,8 @@ describe Prawn::Text::Box do
       end
     end
 
-    it 'should use the parent-box bottom if in a stretchy bbox and ' \
-      'overflow is :expand, even with an explicit height' do
+    it 'uses the parent-box bottom if in a stretchy bbox and overflow is '\
+       ':expand, even with an explicit height' do
       pdf.bounding_box([0, pdf.cursor], width: pdf.bounds.width) do
         target_height = pdf.y - pdf.bounds.bottom
         text = "Oh hai\n" * 60
@@ -663,7 +664,7 @@ describe Prawn::Text::Box do
     end
   end
 
-  context 'printing UTF-8 string with higher bit characters' do
+  context 'when printing UTF-8 string with higher bit characters' do
     let(:text) { '©' }
 
     let(:text_box) do
@@ -714,7 +715,7 @@ describe Prawn::Text::Box do
       }
     end
 
-    context 'truncated overflow' do
+    context 'when truncated overflow' do
       let(:text_box) do
         described_class.new(text, options.merge(overflow: :truncate))
       end
@@ -756,7 +757,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context 'truncated with text and size taken from the manual' do
+    context 'when truncated with text and size taken from the manual' do
       it 'returns the right text' do
         text = 'This is the beginning of the text. It will be cut somewhere ' \
           'and the rest of the text will procede to be rendered this time by '\
@@ -775,7 +776,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context 'expand overflow' do
+    context 'when expand overflow' do
       let(:text_box) do
         described_class.new(text, options.merge(overflow: :expand))
       end
@@ -799,7 +800,7 @@ describe Prawn::Text::Box do
       end
     end
 
-    context 'shrink_to_fit overflow' do
+    context 'when shrink_to_fit overflow' do
       let(:text_box) do
         described_class.new(
           text,
@@ -818,9 +819,7 @@ describe Prawn::Text::Box do
       it 'render returns an empty string because no text remains unprinted' do
         expect(text_box.render).to eq('')
       end
-    end
 
-    context 'shrink_to_fit overflow' do
       it 'does not drop below the minimum font size' do
         options[:overflow] = :shrink_to_fit
         options[:min_font_size] = 10.1
@@ -1018,7 +1017,7 @@ describe Prawn::Text::Box do
       expect(text_box.text).to eq(expect)
     end
 
-    it 'wraps lines comprised of a single word of the bounds when '\
+    it 'wraps lines comprised of a single non-alpha word of the bounds when '\
       'wrapping text' do
       text = '©' * 30
 
@@ -1031,8 +1030,8 @@ describe Prawn::Text::Box do
 
       text_box.render
 
-      expected = '©' * 25 + "\n" + '©' * 5
-      pdf.font.normalize_encoding!(expected)
+      expected = +'©' * 25 + "\n" + '©' * 5
+      expected = pdf.font.normalize_encoding(expected)
       expected = expected.force_encoding(Encoding::UTF_8)
       expect(text_box.text).to eq(expected)
     end
@@ -1104,7 +1103,7 @@ describe Prawn::Text::Box do
   end
 
   def reduce_precision(float)
-    (format '%.5f', float).to_f
+    float.round(5)
   end
 
   def first_line(str)

data/spec/prawn/text/formatted/arranger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Formatted::Arranger do
@@ -9,7 +11,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you?' }
       ]
 
@@ -18,7 +20,7 @@ describe Prawn::Text::Formatted::Arranger do
       expect(arranger.unconsumed[0]).to eq(text: 'hello ')
       expect(arranger.unconsumed[1]).to eq(text: 'world how ', styles: [:bold])
       expect(arranger.unconsumed[2])
-        .to eq(text: 'are', styles: [:bold, :italic])
+        .to eq(text: 'are', styles: %i[bold italic])
       expect(arranger.unconsumed[3]).to eq(text: ' you?')
     end
 
@@ -65,7 +67,7 @@ describe Prawn::Text::Formatted::Arranger do
       [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you?' }
       ]
     end
@@ -85,7 +87,7 @@ describe Prawn::Text::Formatted::Arranger do
 
       expect(arranger.consumed[0]).to eq(text: 'hello ')
       expect(arranger.consumed[1]).to eq(text: 'world how ', styles: [:bold])
-      expect(arranger.consumed[2]).to eq(text: 'are', styles: [:bold, :italic])
+      expect(arranger.consumed[2]).to eq(text: 'are', styles: %i[bold italic])
       expect(arranger.consumed[3]).to eq(text: ' you?')
     end
 
@@ -97,7 +99,7 @@ describe Prawn::Text::Formatted::Arranger do
       expect(arranger.current_format_state).to eq(styles: [:bold])
 
       arranger.next_string
-      expect(arranger.current_format_state).to eq(styles: [:bold, :italic])
+      expect(arranger.current_format_state).to eq(styles: %i[bold italic])
 
       arranger.next_string
       expect(arranger.current_format_state).to eq({})
@@ -155,7 +157,7 @@ describe Prawn::Text::Formatted::Arranger do
         [
           { text: 'hello ' },
           { text: 'world how ', styles: [:bold] },
-          { text: 'are', styles: [:bold, :italic] },
+          { text: 'are', styles: %i[bold italic] },
           { text: ' you?' }
         ]
       end
@@ -164,7 +166,7 @@ describe Prawn::Text::Formatted::Arranger do
         arranger.format_array = array
       end
 
-      context 'after all strings have been consumed' do
+      describe 'after all strings have been consumed' do
         before do
           while arranger.next_string
           end
@@ -174,7 +176,7 @@ describe Prawn::Text::Formatted::Arranger do
           expect { arranger.retrieve_fragment }.to raise_error(RuntimeError)
         end
 
-        context 'and finalized' do
+        describe 'and finalized' do
           before do
             arranger.finalize_line
           end
@@ -196,13 +198,13 @@ describe Prawn::Text::Formatted::Arranger do
   end
 
   describe '#update_last_string' do
-    it 'should update the last retrieved string with what actually fit on' \
-      'the line and the list of unconsumed with what did not' do
+    it 'updates the last retrieved string with what actually fit on the line '\
+       'and the list of unconsumed with what did not' do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
-        { text: ' you now?', styles: [:bold, :italic] }
+        { text: 'are', styles: %i[bold italic] },
+        { text: ' you now?', styles: %i[bold italic] }
       ]
       arranger.format_array = array
       while arranger.next_string
@@ -210,10 +212,10 @@ describe Prawn::Text::Formatted::Arranger do
       arranger.update_last_string(' you', ' now?', nil)
       expect(arranger.consumed[3]).to eq(
         text: ' you',
-        styles: [:bold, :italic]
+        styles: %i[bold italic]
       )
       expect(arranger.unconsumed).to eq([
-        { text: ' now?', styles: [:bold, :italic] }
+        { text: ' now?', styles: %i[bold italic] }
       ])
     end
 
@@ -221,12 +223,12 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
       3.times { arranger.next_string }
-      expect(arranger.current_format_state).to eq(styles: [:bold, :italic])
+      expect(arranger.current_format_state).to eq(styles: %i[bold italic])
       arranger.update_last_string('', 'are', '-')
       expect(arranger.current_format_state).to eq(styles: [:bold])
     end
@@ -236,7 +238,7 @@ describe Prawn::Text::Formatted::Arranger do
         array = [
           { text: 'hello ' },
           { text: 'world how ', styles: [:bold] },
-          { text: 'are', styles: [:bold, :italic] },
+          { text: 'are', styles: %i[bold italic] },
           { text: ' you now?' }
         ]
         arranger.format_array = array
@@ -253,7 +255,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you?' }
       ]
       arranger.format_array = array
@@ -274,12 +276,12 @@ describe Prawn::Text::Formatted::Arranger do
   end
 
   describe '#finalize_line' do
-    it 'should make it so that all trailing white space fragments ' \
-      'exclude trailing white space' do
+    it 'makes it so that all trailing white space fragments exclude '\
+       'trailing white space' do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: '   ', styles: [:bold, :italic] }
+        { text: '   ', styles: %i[bold italic] }
       ]
       arranger.format_array = array
       while arranger.next_string
@@ -374,7 +376,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -385,7 +387,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -400,7 +402,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -414,7 +416,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -429,7 +431,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic], size: 28 },
+        { text: 'are', styles: %i[bold italic], size: 28 },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -445,7 +447,7 @@ describe Prawn::Text::Formatted::Arranger do
       array = [
         { text: 'hello ' },
         { text: 'world how ', styles: [:bold] },
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ]
       arranger.format_array = array
@@ -456,7 +458,7 @@ describe Prawn::Text::Formatted::Arranger do
       arranger.retrieve_fragment
       arranger.repack_unretrieved
       expect(arranger.unconsumed).to eq([
-        { text: 'are', styles: [:bold, :italic] },
+        { text: 'are', styles: %i[bold italic] },
         { text: ' you now?' }
       ])
     end