prawn 2.2.2 → 2.3.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Formatted::Box do
@@ -260,7 +262,7 @@ describe Prawn::Text::Formatted::Box do
       expect(fonts_used[1]).to match(/Kai/)
     end
 
-    it 'should omit the fallback fonts overhead when passing an empty array ' \
+    it 'omits the fallback fonts overhead when passing an empty array ' \
       'as the :fallback_fonts' do
       pdf.font('Kai')
 
@@ -299,33 +301,63 @@ describe Prawn::Text::Formatted::Box do
   end
 
   describe 'Text::Formatted::Box#extensions' do
+    let(:formatted_wrap_override) do
+      Module.new do
+        # rubocop: disable RSpec/InstanceVariable
+        def wrap(_array)
+          initialize_wrap([{ text: 'all your base are belong to us' }])
+          @line_wrap.wrap_line(
+            document: @document,
+            kerning: @kerning,
+            width: 10_000,
+            arranger: @arranger
+          )
+          fragment = @arranger.retrieve_fragment
+          format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
+
+          []
+        end
+        # rubocop: enable RSpec/InstanceVariable
+      end
+    end
+
     it 'is able to override default line wrapping' do
-      described_class.extensions << TestFormattedWrapOverride
+      described_class.extensions << formatted_wrap_override
       pdf.formatted_text_box([{ text: 'hello world' }], {})
-      described_class.extensions.delete(TestFormattedWrapOverride)
+      described_class.extensions.delete(formatted_wrap_override)
       text = PDF::Inspector::Text.analyze(pdf.render)
       expect(text.strings[0]).to eq('all your base are belong to us')
     end
 
     it 'overrides Text::Formatted::Box line wrapping does not affect ' \
       'Text::Box wrapping' do
-      described_class.extensions << TestFormattedWrapOverride
+      described_class.extensions << formatted_wrap_override
       pdf.text_box('hello world', {})
-      described_class.extensions.delete(TestFormattedWrapOverride)
+      described_class.extensions.delete(formatted_wrap_override)
       text = PDF::Inspector::Text.analyze(pdf.render)
       expect(text.strings[0]).to eq('hello world')
     end
 
     it "overring Text::Box line wrapping doesn't override Text::Box wrapping" do
-      Prawn::Text::Box.extensions << TestFormattedWrapOverride
+      Prawn::Text::Box.extensions << formatted_wrap_override
       pdf.text_box('hello world', {})
-      Prawn::Text::Box.extensions.delete(TestFormattedWrapOverride)
+      Prawn::Text::Box.extensions.delete(formatted_wrap_override)
       text = PDF::Inspector::Text.analyze(pdf.render)
       expect(text.strings[0]).to eq('all your base are belong to us')
     end
   end
 
   describe 'Text::Formatted::Box#render' do
+    let(:fragment_callback_class) do
+      Class.new do
+        def initialize(_string, _number, _options); end
+
+        def render_behind(fragment); end
+
+        def render_in_front(fragment); end
+      end
+    end
+
     it 'handles newlines' do
       array = [{ text: "hello\nworld" }]
       options = { document: pdf }
@@ -377,11 +409,10 @@ describe Prawn::Text::Formatted::Box do
       expect(text.strings[2]).to eq(' olleh' * number_of_hellos)
       expect(text.strings[3]).to eq('?uoy')
     end
-  end
 
-  describe 'Text::Formatted::Box#render' do
     it 'is able to perform fragment callbacks' do
-      callback_object = TestFragmentCallback.new('something', 7, document: pdf)
+      callback_object =
+        fragment_callback_class.new('something', 7, document: pdf)
       allow(callback_object).to receive(:render_behind)
       allow(callback_object).to receive(:render_in_front)
       array = [
@@ -400,11 +431,12 @@ describe Prawn::Text::Formatted::Box do
     end
 
     it 'is able to perform fragment callbacks on multiple objects' do
-      callback_object = TestFragmentCallback.new('something', 7, document: pdf)
+      callback_object =
+        fragment_callback_class.new('something', 7, document: pdf)
       allow(callback_object).to receive(:render_behind)
       allow(callback_object).to receive(:render_in_front)
 
-      callback_object2 = TestFragmentCallback.new(
+      callback_object2 = fragment_callback_class.new(
         'something else', 14, document: pdf
       )
       allow(callback_object2).to receive(:render_behind)
@@ -432,11 +464,23 @@ describe Prawn::Text::Formatted::Box do
     end
 
     it 'fragment callbacks is able to define only the callback they need' do
-      behind = TestFragmentCallbackBehind.new(
+      behind = (
+        Class.new do
+          def initialize(_string, _number, _options); end
+
+          def render_behind(fragment); end
+        end
+      ).new(
         'something', 7,
         document: pdf
       )
-      in_front = TestFragmentCallbackInFront.new(
+      in_front = (
+        Class.new do
+          def initialize(_string, _number, _options); end
+
+          def render_in_front(fragment); end
+        end
+      ).new(
         'something', 7,
         document: pdf
       )
@@ -463,7 +507,7 @@ describe Prawn::Text::Formatted::Box do
       text_box.render
       contents = PDF::Inspector::Text.analyze(pdf.render)
       fonts = contents.font_settings.map { |e| e[:name] }
-      expect(fonts).to eq([:Helvetica, :"Times-Bold", :Helvetica])
+      expect(fonts).to eq(%i[Helvetica Times-Bold Helvetica])
       expect(contents.strings[0]).to eq('this contains ')
       expect(contents.strings[1]).to eq('Times-Bold')
       expect(contents.strings[2]).to eq(' text')
@@ -479,7 +523,7 @@ describe Prawn::Text::Formatted::Box do
       text_box.render
       contents = PDF::Inspector::Text.analyze(pdf.render)
       fonts = contents.font_settings.map { |e| e[:name] }
-      expect(fonts).to eq([:Helvetica, :"Helvetica-Bold", :Helvetica])
+      expect(fonts).to eq(%i[Helvetica Helvetica-Bold Helvetica])
       expect(contents.strings[0]).to eq('this contains ')
       expect(contents.strings[1]).to eq('bold')
       expect(contents.strings[2]).to eq(' text')
@@ -495,7 +539,7 @@ describe Prawn::Text::Formatted::Box do
       text_box.render
       contents = PDF::Inspector::Text.analyze(pdf.render)
       fonts = contents.font_settings.map { |e| e[:name] }
-      expect(fonts).to eq([:Helvetica, :"Helvetica-Oblique", :Helvetica])
+      expect(fonts).to eq(%i[Helvetica Helvetica-Oblique Helvetica])
     end
 
     it 'is able to set subscript' do
@@ -529,15 +573,16 @@ describe Prawn::Text::Formatted::Box do
     it 'is able to set compound bold and italic text' do
       array = [
         { text: 'this contains ' },
-        { text: 'bold italic', styles: [:bold, :italic] },
+        { text: 'bold italic', styles: %i[bold italic] },
         { text: ' text' }
       ]
       text_box = described_class.new(array, document: pdf)
       text_box.render
       contents = PDF::Inspector::Text.analyze(pdf.render)
       fonts = contents.font_settings.map { |e| e[:name] }
-      expect(fonts).to eq([:Helvetica, :"Helvetica-BoldOblique", :Helvetica])
+      expect(fonts).to eq(%i[Helvetica Helvetica-BoldOblique Helvetica])
     end
+
     it 'is able to underline' do
       array = [
         { text: 'this contains ' },
@@ -740,6 +785,20 @@ describe Prawn::Text::Formatted::Box do
       contents = PDF::Inspector::Text.analyze(pdf.render)
       expect(contents.word_spacing).to be_empty
     end
+
+    it 'raise an exception when align value is not a symbol' do
+      array = [
+        { text: 'hello world ' },
+        { text: "\n" },
+        { text: 'goodbye' }
+      ]
+      options = { document: pdf, align: 'justify' }
+      text_box = described_class.new(array, options)
+      expect { text_box.render }.to raise_error(
+        ArgumentError,
+        'align must be one of :left, :right, :center or :justify symbols'
+      )
+    end
   end
 
   describe 'Text::Formatted::Box#render with :valign => :center' do
@@ -784,42 +843,4 @@ describe Prawn::Text::Formatted::Box do
       expect(text_box.at[1]).to be_within(0.01).of(top_padding)
     end
   end
-
-  class TestFragmentCallback
-    def initialize(_string, _number, _options); end
-
-    def render_behind(fragment); end
-
-    def render_in_front(fragment); end
-  end
-
-  class TestFragmentCallbackBehind
-    def initialize(_string, _number, _options); end
-
-    def render_behind(fragment); end
-  end
-
-  class TestFragmentCallbackInFront
-    def initialize(_string, _number, _options); end
-
-    def render_in_front(fragment); end
-  end
-
-  # rubocop: disable RSpec/InstanceVariable
-  module TestFormattedWrapOverride
-    def wrap(_array)
-      initialize_wrap([{ text: 'all your base are belong to us' }])
-      @line_wrap.wrap_line(
-        document: @document,
-        kerning: @kerning,
-        width: 10_000,
-        arranger: @arranger
-      )
-      fragment = @arranger.retrieve_fragment
-      format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
-
-      []
-    end
-  end
-  # rubocop: enable RSpec/InstanceVariable
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Formatted::Fragment do
@@ -6,7 +8,7 @@ describe Prawn::Text::Formatted::Fragment do
   describe 'Text::Formatted::Fragment' do
     let(:fragment) do
       format_state = {
-        styles: [:bold, :italic],
+        styles: %i[bold italic],
         color: nil,
         link: nil,
         anchor: nil,
@@ -35,7 +37,7 @@ describe Prawn::Text::Formatted::Fragment do
 
     describe '#styles' do
       it 'returns the styles array' do
-        expect(fragment.styles).to eq([:bold, :italic])
+        expect(fragment.styles).to eq(%i[bold italic])
       end
 
       it 'nevers return nil' do
@@ -88,7 +90,7 @@ describe Prawn::Text::Formatted::Fragment do
     end
 
     describe '#absolute_bounding_box' do
-      it 'should return the bounding box surrounding the fragment' \
+      it 'returns the bounding box surrounding the fragment' \
         ' in absolute coordinates' do
         target_box = [50, 193, 150, 217]
         target_box[0] += pdf.bounds.absolute_left
@@ -128,7 +130,7 @@ describe Prawn::Text::Formatted::Fragment do
       expect(fragment.space_count).to eq(2)
     end
 
-    it 'should exclude trailing spaces from the count when ' \
+    it 'excludes trailing spaces from the count when ' \
       ':exclude_trailing_white_space => true' do
       format_state = { exclude_trailing_white_space: true }
       fragment = described_class.new(
@@ -165,7 +167,7 @@ describe Prawn::Text::Formatted::Fragment do
       expect(fragment.text).to eq('hello world ')
     end
 
-    it 'should return the fragment text without trailing spaces when ' \
+    it 'returns the fragment text without trailing spaces when ' \
       ':exclude_trailing_white_space => true' do
       format_state = { exclude_trailing_white_space: true }
       fragment = described_class.new(
@@ -180,7 +182,7 @@ describe Prawn::Text::Formatted::Fragment do
   describe '#word_spacing=' do
     let(:fragment) do
       format_state = {
-        styles: [:bold, :italic],
+        styles: %i[bold italic],
         color: nil,
         link: nil,
         anchor: nil,
@@ -314,7 +316,7 @@ describe Prawn::Text::Formatted::Fragment do
   end
 
   describe '#default_direction=' do
-    it 'should set the direction if there is no fragment level direction ' \
+    it 'sets the direction if there is no fragment level direction ' \
       'specification' do
       format_state = {}
       fragment = described_class.new(
@@ -326,7 +328,7 @@ describe Prawn::Text::Formatted::Fragment do
       expect(fragment.direction).to eq(:rtl)
     end
 
-    it 'should not set the direction if there is a fragment level direction ' \
+    it 'does not set the direction if there is a fragment level direction ' \
       'specification' do
       format_state = { direction: :rtl }
       fragment = described_class.new(

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Formatted::LineWrap do
@@ -18,7 +20,7 @@ describe Prawn::Text::Formatted::LineWrap do
   end
   let(:line_wrap) { described_class.new }
 
-  it 'should only return an empty string if nothing fit or there' \
+  it 'only returns an empty string if nothing fit or there' \
      'was nothing to wrap' do
     8.times do
       line = line_wrap.wrap_line(
@@ -59,7 +61,7 @@ describe Prawn::Text::Formatted::LineWrap do
       expect(string).to eq('hello world, goodbye')
     end
 
-    it 'should strip trailing spaces when a white-space-only fragment was' \
+    it 'strips trailing spaces when a white-space-only fragment was' \
       ' successfully pushed onto the end of a line but no other non-white' \
       ' space fragment fits after it' do
       array = [
@@ -75,6 +77,7 @@ describe Prawn::Text::Formatted::LineWrap do
       )
       expect(string).to eq('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
     end
+
     it 'raise_errors CannotFit if a too-small width is given' do
       array = [
         { text: ' hello world, ' },
@@ -183,7 +186,7 @@ describe Prawn::Text::Formatted::LineWrap do
       expect(string).to eq('hello-')
     end
 
-    it 'should not break after a hyphen that follows white space and' \
+    it 'does not break after a hyphen that follows white space and' \
       'precedes a word' do
       array = [{ text: 'hello -' }]
       arranger.format_array = array
@@ -259,7 +262,7 @@ describe Prawn::Text::Formatted::LineWrap do
       expect(res1).to eq(res2)
     end
 
-    it 'should not display soft hyphens except at the end of a line ' \
+    it 'does not display soft hyphens except at the end of a line ' \
       'for more than one element in format_array', issue: 347 do
       pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
       line_wrap = described_class.new
@@ -320,7 +323,7 @@ describe Prawn::Text::Formatted::LineWrap do
       expect(string).to eq('hello')
     end
 
-    it 'should not break after a hard hyphen that follows a soft hyphen and' \
+    it 'does not break after a hard hyphen that follows a soft hyphen and' \
       'precedes a word' do
       string = pdf.font.normalize_encoding("hello#{Prawn::Text::SHY}-")
       array = [{ text: string }]

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Text::Formatted::Parser do
@@ -17,6 +19,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles sub' do
       string = '<sub>subscript</sub>'
       array = described_class.format(string)
@@ -32,6 +35,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles rgb' do
       string = "<color rgb='#ff0000'>red text</color>"
       array = described_class.format(string)
@@ -47,6 +51,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it '# should be optional in rgb' do
       string = "<color rgb='ff0000'>red text</color>"
       array = described_class.format(string)
@@ -62,6 +67,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles cmyk' do
       string = "<color c='0' m='100' y='0' k='0'>magenta text</color>"
       array = described_class.format(string)
@@ -77,6 +83,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles fonts' do
       string = "<font name='Courier'>Courier text</font>"
       array = described_class.format(string)
@@ -92,6 +99,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles size' do
       string = "<font size='14'>14 point text</font>"
       array = described_class.format(string)
@@ -107,6 +115,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles character_spacing' do
       string = "<font character_spacing='2.5'>extra character spacing</font>"
       array = described_class.format(string)
@@ -122,6 +131,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: 2.5
       )
     end
+
     it 'handles links' do
       string = "<link href='http://example.com'>external link</link>"
       array = described_class.format(string)
@@ -137,6 +147,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles local links' do
       string = "<link local='/home/example/foo.bar'>local link</link>"
       array = described_class.format(string)
@@ -152,6 +163,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles anchors' do
       string = "<link anchor='ToC'>internal link</link>"
       array = described_class.format(string)
@@ -167,6 +179,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles higher order characters properly' do
       string = "<b>©\n©</b>"
       array = described_class.format(string)
@@ -204,6 +217,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'converts &lt; &gt;, and &amp; to <, >, and &, respectively' do
       string = 'hello <b>&lt;, &gt;, and &amp;</b>'
       array = described_class.format(string)
@@ -219,6 +233,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles double qoutes around tag attributes' do
       string = 'some <font size="14">sized</font> text'
       array = described_class.format(string)
@@ -234,6 +249,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'handles single qoutes around tag attributes' do
       string = "some <font size='14'>sized</font> text"
       array = described_class.format(string)
@@ -249,6 +265,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'constructs a formatted text array from a string' do
       string = "hello <b>world\nhow <i>are</i></b> you?"
       array = described_class.format(string)
@@ -299,7 +316,7 @@ describe Prawn::Text::Formatted::Parser do
       )
       expect(array[4]).to eq(
         text: 'are',
-        styles: [:bold, :italic],
+        styles: %i[bold italic],
         color: nil,
         link: nil,
         anchor: nil,
@@ -320,6 +337,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'accepts <strong> as an alternative to <b>' do
       string = '<strong>bold</strong> not bold'
       array = described_class.format(string)
@@ -347,6 +365,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'accepts <em> as an alternative to <i>' do
       string = '<em>italic</em> not italic'
       array = described_class.format(string)
@@ -374,6 +393,7 @@ describe Prawn::Text::Formatted::Parser do
         character_spacing: nil
       )
     end
+
     it 'accepts <a> as an alternative to <link>' do
       string = "<a href='http://example.com'>link</a> not a link"
       array = described_class.format(string)
@@ -424,6 +444,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles sub' do
       string = '<sub>subscript</sub>'
       array = [{
@@ -439,6 +460,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles rgb' do
       string = "<color rgb='ff0000'>red text</color>"
       array = [{
@@ -454,6 +476,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles cmyk' do
       string = "<color c='0' m='100' y='0' k='0'>magenta text</color>"
       array = [{
@@ -469,6 +492,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles fonts' do
       string = "<font name='Courier'>Courier text</font>"
       array = [{
@@ -484,6 +508,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles size' do
       string = "<font size='14'>14 point text</font>"
       array = [{
@@ -499,6 +524,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles character spacing' do
       string =
         "<font character_spacing='2.5'>2.5 extra character spacing</font>"
@@ -515,6 +541,7 @@ describe Prawn::Text::Formatted::Parser do
       }]
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles links' do
       array = [{
         text: 'external link',
@@ -530,6 +557,7 @@ describe Prawn::Text::Formatted::Parser do
       string = "<link href='http://example.com'>external link</link>"
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'handles anchors' do
       array = [{
         text: 'internal link',
@@ -544,6 +572,7 @@ describe Prawn::Text::Formatted::Parser do
       string = "<link anchor='ToC'>internal link</link>"
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'converts <, >, and & to &lt; &gt;, and &amp;, respectively' do
       array = [
         {
@@ -568,6 +597,7 @@ describe Prawn::Text::Formatted::Parser do
       string = 'hello <b>&lt;, &gt;, and &amp;</b>'
       expect(described_class.to_string(array)).to eq(string)
     end
+
     it 'constructs an HTML-esque string from a formatted text array' do
       array = [
         {
@@ -608,7 +638,7 @@ describe Prawn::Text::Formatted::Parser do
         },
         {
           text: 'are',
-          styles: [:bold, :italic],
+          styles: %i[bold italic],
           color: nil,
           link: nil,
           font: nil,