prawn 2.2.2 → 2.3.0

data/spec/prawn/document_grid_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Document do
@@ -26,6 +28,7 @@ describe Prawn::Document do
       let(:num_columns) { 5 }
       let(:num_rows) { 8 }
       let(:gutter) { 10.0 }
+
       before do
         pdf.define_grid(
           columns: num_columns,

data/spec/prawn/document_reference_spec.rb

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

data/spec/prawn/document_span_spec.rb

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

data/spec/prawn/document_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'tempfile'
 
@@ -32,7 +34,7 @@ describe Prawn::Document do
 
   describe 'when generating a document with a custom text formatter' do
     it 'uses the provided text formatter' do
-      class TestTextFormatter
+      text_formatter = Class.new do
         def self.format(string)
           [
             {
@@ -49,7 +51,7 @@ describe Prawn::Document do
           ]
         end
       end
-      pdf = described_class.new text_formatter: TestTextFormatter
+      pdf = described_class.new text_formatter: text_formatter
       pdf.text 'Dr. Who?', inline_format: true
       text = PDF::Inspector::Text.analyze(pdf.render)
       expect(text.strings.first).to eq("Just 'The Doctor'.")
@@ -161,6 +163,48 @@ describe Prawn::Document do
     end
   end
 
+  describe '#delete_page(index)' do
+    before do
+      pdf.text 'Page one'
+      pdf.start_new_page
+      pdf.text 'Page two'
+      pdf.start_new_page
+      pdf.text 'Page three'
+    end
+
+    it 'destroy a specific page of the document' do
+      pdf.delete_page(1)
+      expect(pdf.page_number).to eq(2)
+      text_analysis = PDF::Inspector::Text.analyze(pdf.render)
+      expect(text_analysis.strings).to eq(['Page one', 'Page three'])
+    end
+
+    it 'destroy the last page of the document' do
+      pdf.delete_page(-1)
+      expect(pdf.page_number).to eq(2)
+      text_analysis = PDF::Inspector::Text.analyze(pdf.render)
+      expect(text_analysis.strings).to eq(['Page one', 'Page two'])
+    end
+
+    context 'with an invalid index' do
+      let(:expected_content) { ['Page one', 'Page two', 'Page three'] }
+
+      it 'does not destroy an invalid positve index' do
+        pdf.delete_page(42)
+        expect(pdf.page_number).to eq(3)
+        text_analysis = PDF::Inspector::Text.analyze(pdf.render)
+        expect(text_analysis.strings).to eq(expected_content)
+      end
+
+      it 'does not destroy an invalid negative index' do
+        pdf.delete_page(-42)
+        expect(pdf.page_number).to eq(3)
+        text_analysis = PDF::Inspector::Text.analyze(pdf.render)
+        expect(text_analysis.strings).to eq(expected_content)
+      end
+    end
+  end
+
   describe '#page_number' do
     it 'is 1 for a new document' do
       pdf = described_class.new
@@ -356,7 +400,7 @@ describe Prawn::Document do
     end
 
     (PDF::Core::PageGeometry::SIZES.keys - ['LETTER']).each do |k|
-      it "should provide #{k} geometry" do
+      it "provides #{k} geometry" do
         pdf = described_class.new(page_size: k)
         pages = PDF::Inspector::Page.analyze(pdf.render).pages
         expect(pages.first[:size]).to eq(PDF::Core::PageGeometry::SIZES[k])
@@ -572,7 +616,7 @@ describe Prawn::Document do
       expect(pdf).to_not have_received(:text_box)
     end
 
-    context 'start_count_at option' do
+    context 'with start_count_at option' do
       [1, 2].each do |startat|
         context "equal to #{startat}" do
           it 'increments the pages' do
@@ -605,7 +649,7 @@ describe Prawn::Document do
       end
     end
 
-    context 'total_pages option' do
+    context 'with total_pages option' do
       it 'allows the total pages count to be overridden' do
         2.times { pdf.start_new_page }
         allow(pdf).to receive(:text_box)
@@ -616,8 +660,8 @@ describe Prawn::Document do
       end
     end
 
-    context 'special page filter' do
-      context 'such as :odd' do
+    context 'with special page filter' do
+      describe 'such as :odd' do
         it 'increments the pages' do
           3.times { pdf.start_new_page }
           allow(pdf).to receive(:text_box)
@@ -629,7 +673,7 @@ describe Prawn::Document do
         end
       end
 
-      context 'missing' do
+      describe 'missing' do
         it 'does not print any page numbers' do
           3.times { pdf.start_new_page }
           allow(pdf).to receive(:text_box)
@@ -640,8 +684,8 @@ describe Prawn::Document do
       end
     end
 
-    context 'given both a special page filter and a start_count_at parameter' do
-      context 'such as :odd and 7' do
+    context 'with both a special page filter and a start_count_at parameter' do
+      describe 'such as :odd and 7' do
         it 'increments the pages' do
           3.times { pdf.start_new_page }
           allow(pdf).to receive(:text_box)
@@ -660,7 +704,8 @@ describe Prawn::Document do
           expect(pdf).to have_received(:text_box).with('7 3', height: 50)
         end
       end
-      context 'some crazy proc and 2' do
+
+      context 'with some crazy proc and 2' do
         it 'increments the pages' do
           6.times { pdf.start_new_page }
           options = {
@@ -691,7 +736,7 @@ describe Prawn::Document do
       end
     end
 
-    context 'height option' do
+    describe 'height option' do
       before do
         pdf.start_new_page
       end
@@ -724,7 +769,7 @@ describe Prawn::Document do
     end
 
     it 'returns nil given no filter' do
-      expect(pdf.page_match?(:nil, 1)).to be_falsey
+      expect(pdf).to_not be_page_match(:nil, 1)
     end
 
     it 'must provide an :all filter' do
@@ -735,7 +780,7 @@ describe Prawn::Document do
     it 'must provide an :odd filter' do
       odd, even = (1..pdf.page_count).partition(&:odd?)
       expect(odd.all? { |i| pdf.page_match?(:odd, i) }).to eq true
-      expect(even.any? { |i| pdf.page_match?(:odd, i) }).to be_falsey
+      expect(even).to_not(be_any { |i| pdf.page_match?(:odd, i) })
     end
 
     it 'must be able to filter by an array of page numbers' do

data/spec/prawn/font_metric_cache_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'pathname'
 

data/spec/prawn/font_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'pathname'
 
@@ -39,7 +41,7 @@ describe Prawn::Font do
     it 'takes character spacing into account' do
       original_width = pdf.width_of('hello world')
       pdf.character_spacing(7) do
-        expect(pdf.width_of('hello world')).to eq(original_width + 11 * 7)
+        expect(pdf.width_of('hello world')).to eq(original_width + 10 * 7)
       end
     end
 
@@ -69,6 +71,14 @@ describe Prawn::Font do
       end
     end
 
+    it 'reports missing font with style' do
+      expect do
+        pdf.font('Nada', style: :bold) do
+          pdf.width_of('hello')
+        end
+      end.to raise_error(Prawn::Errors::UnknownFont, /Nada \(bold\)/)
+    end
+
     it 'calculates styled widths correctly using TTFs' do
       pdf.font_families.update(
         'DejaVu Sans' => {
@@ -134,9 +144,9 @@ describe Prawn::Font do
 
       text = PDF::Inspector::Text.analyze(pdf.render)
       expect(text.font_settings.map { |e| e[:name] }).to eq(
-        [
-          :"Courier-Bold", :"Courier-BoldOblique", :"Courier-Oblique",
-          :Courier, :Helvetica
+        %i[
+          Courier-Bold Courier-BoldOblique Courier-Oblique
+          Courier Helvetica
         ]
       )
     end
@@ -263,7 +273,7 @@ describe Prawn::Font do
       pdf.font 'Times-Roman'
       pdf.text('hello')
 
-      ['Courier', 'Helvetica', 'Times-Roman'].each do |f|
+      %w[Courier Helvetica Times-Roman].each do |f|
         page_should_include_font(f)
       end
 
@@ -342,12 +352,6 @@ describe Prawn::Font do
         normalized = times.normalize_encoding(original)
         expect(original.equal?(normalized)).to eq false
       end
-
-      it 'modifies the original string when normalize_encoding!() is used' do
-        original = 'Foo'
-        normalized = times.normalize_encoding!(original)
-        expect(original.equal?(normalized)).to eq true
-      end
     end
 
     it 'omits /Encoding for symbolic fonts' do
@@ -450,11 +454,36 @@ describe Prawn::Font do
         normalized = font.normalize_encoding(original)
         expect(original.equal?(normalized)).to eq false
       end
+    end
+  end
+
+  describe 'OTF fonts' do
+    let(:font) { pdf.find_font "#{Prawn::DATADIR}/fonts/Bodoni-Book.otf" }
 
-      it 'modifies the original string when normalize_encoding!() is used' do
+    it 'calculates string width taking into account accented characters' do
+      expect(font.compute_width_of('é', size: 12)).to eq(
+        font.compute_width_of('e', size: 12)
+      )
+    end
+
+    it 'uses the ascender, descender, and cap height from the OTF verbatim' do
+      # These metrics are relative to the font's own bbox. They should not be
+      # scaled with font size.
+      ref = pdf.ref!({})
+      font.send :embed, ref, 0
+
+      # Pull out the embedded font descriptor
+      descriptor = ref.data[:FontDescriptor].data
+      expect(descriptor[:Ascent]).to eq(1023)
+      expect(descriptor[:Descent]).to eq(-200)
+      expect(descriptor[:CapHeight]).to eq(3072)
+    end
+
+    describe 'when normalizing encoding' do
+      it 'does not modify the original string with normalize_encoding()' do
         original = 'Foo'
-        normalized = font.normalize_encoding!(original)
-        expect(original.equal?(normalized)).to eq true
+        normalized = font.normalize_encoding(original)
+        expect(original).to_not be_equal(normalized)
       end
     end
   end
@@ -463,14 +492,14 @@ describe Prawn::Font do
     let(:file) { "#{Prawn::DATADIR}/fonts/Panic+Sans.dfont" }
 
     it 'lists all named fonts' do
-      list = Prawn::Font::DFont.named_fonts(file)
+      list = Prawn::Fonts::DFont.named_fonts(file)
       expect(list).to match_array(%w[
         PanicSans PanicSans-Bold PanicSans-BoldItalic PanicSans-Italic
       ])
     end
 
     it 'counts the number of fonts in the file' do
-      expect(Prawn::Font::DFont.font_count(file)).to eq(4)
+      expect(Prawn::Fonts::DFont.font_count(file)).to eq(4)
     end
 
     it 'defaults selected font to the first one if not specified' do

data/spec/prawn/graphics/blend_mode_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Graphics::BlendMode do
@@ -42,9 +44,9 @@ describe Prawn::Graphics::BlendMode do
 
   it 'setting the blend mode with multiple parameters sets an array of '\
     'blend modes' do
-    make_blend_mode([:Multiply, :Screen, :Overlay])
+    make_blend_mode(%i[Multiply Screen Overlay])
     extgstate = PDF::Inspector::ExtGState.analyze(pdf.render).extgstates.first
-    expect(extgstate[:blend_mode]).to eq([:Multiply, :Screen, :Overlay])
+    expect(extgstate[:blend_mode]).to eq(%i[Multiply Screen Overlay])
   end
 
   describe 'with more than one page' do

data/spec/prawn/graphics/transparency_spec.rb

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

data/spec/prawn/graphics_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Prawn::Graphics do
@@ -12,8 +14,7 @@ describe Prawn::Graphics do
       expect(line_drawing.points).to eq([[100, 600], [100, 500]])
     end
 
-    it 'should draw two lines at (100,600) to (100,500) ' \
-      'and (75,100) to (50,125)' do
+    it 'draws two lines at (100,600) to (100,500) and (75,100) to (50,125)' do
       pdf.line(100, 600, 100, 500)
       pdf.line(75, 100, 50, 125)
 
@@ -67,6 +68,7 @@ describe Prawn::Graphics do
         line_drawing = PDF::Inspector::Graphics::Line.analyze(pdf.render)
         expect(line_drawing.points).to eq([[350, 300], [350, 400]])
       end
+
       it 'requires a y coordinate' do
         expect { pdf.vertical_line(400, 500) }
           .to raise_error(ArgumentError)
@@ -116,6 +118,7 @@ describe Prawn::Graphics do
 
   describe 'When drawing a rounded rectangle' do
     before { pdf.rounded_rectangle([50, 550], 50, 100, 10) }
+
     let(:original_point) do
       curve = PDF::Inspector::Graphics::Curve.analyze(pdf.render)
       curve_points = curve.coords.each_slice(2).to_a
@@ -245,6 +248,10 @@ describe Prawn::Graphics do
       expect { pdf.fill_color 'zcff00' }.to raise_error(ArgumentError)
     end
 
+    it 'raises an error for a color string with invalid characters' do
+      expect { pdf.fill_color 'f0f0f?' }.to raise_error(ArgumentError)
+    end
+
     it 'resets the colors on each new page if they have been defined' do
       pdf.fill_color 'ccff00'
 
@@ -295,6 +302,23 @@ describe Prawn::Graphics do
         end).to eq true
       end
 
+      it 'creates a unique ID for each pattern resource' do
+        pdf.fill_gradient(
+          [256, 512],
+          [356, 512],
+          'ffffff', 'fe00ff'
+        )
+        pdf.fill_gradient(
+          [256, 256],
+          [356, 256],
+          'ffffff', '0000ff'
+        )
+
+        str = pdf.render
+        pattern_ids = str.scan(/SP\h{40}\s+scn/)
+        expect(pattern_ids.uniq.length).to eq 2
+      end
+
       it 'fill_gradient should set fill color to the pattern' do
         pdf.fill_gradient(
           [0, pdf.bounds.height],
@@ -411,7 +435,7 @@ describe Prawn::Graphics do
     end
 
     describe 'gradient transformations' do
-      subject do
+      subject(:transformations) do
         pdf.scale 2 do
           pdf.translate 40, 40 do
             pdf.fill_gradient [0, 10], [15, 15], 'FF0000', '0000FF', opts
@@ -429,7 +453,7 @@ describe Prawn::Graphics do
 
         it 'uses the transformation stack to translate user co-ordinates to '\
           'document co-ordinates required by /Pattern' do
-          is_expected.to eq([[2, 0, 0, 2, 80, 100]])
+          expect(transformations).to eq([[2, 0, 0, 2, 80, 100]])
         end
       end
 
@@ -437,7 +461,7 @@ describe Prawn::Graphics do
         let(:opts) { { apply_transformations: false } }
 
         it "doesn't transform the gradient" do
-          is_expected.to eq([[1, 0, 0, 1, 0, 10]])
+          expect(transformations).to eq([[1, 0, 0, 1, 0, 10]])
         end
       end
 
@@ -446,7 +470,7 @@ describe Prawn::Graphics do
 
         it "doesn't transform the gradient and displays a warning" do
           allow(pdf).to receive(:warn).twice
-          is_expected.to eq([[1, 0, 0, 1, 0, 10]])
+          expect(transformations).to eq([[1, 0, 0, 1, 0, 10]])
           expect(pdf).to have_received(:warn).twice
         end
       end
@@ -607,7 +631,7 @@ describe Prawn::Graphics do
       'the initializer' do
       new_state = PDF::Core::GraphicState.new(pdf.graphic_state)
 
-      [:color_space, :dash, :fill_color, :stroke_color].each do |attr|
+      %i[color_space dash fill_color stroke_color].each do |attr|
         expect(new_state.send(attr)).to eq(pdf.graphic_state.send(attr))
         expect(new_state.send(attr)).to_not equal(pdf.graphic_state.send(attr))
       end
@@ -616,7 +640,7 @@ describe Prawn::Graphics do
     it 'copies mutable attributes when duping' do
       new_state = pdf.graphic_state.dup
 
-      [:color_space, :dash, :fill_color, :stroke_color].each do |attr|
+      %i[color_space dash fill_color stroke_color].each do |attr|
         expect(new_state.send(attr)).to eq(pdf.graphic_state.send(attr))
         expect(new_state.send(attr)).to_not equal(pdf.graphic_state.send(attr))
       end
@@ -629,15 +653,15 @@ describe Prawn::Graphics do
 
     it 'sends the right content on transformation_matrix' do
       allow(pdf.renderer).to receive(:add_content)
-        .with('1.00000 0.00000 0.12346 -1.00000 5.50000 20.00000 cm')
+        .with('1.0 0.0 0.12346 -1.0 5.5 20.0 cm')
       pdf.transformation_matrix 1, 0, 0.123456789, -1.0, 5.5, 20
       expect(pdf.renderer).to have_received(:add_content)
-        .with('1.00000 0.00000 0.12346 -1.00000 5.50000 20.00000 cm')
+        .with('1.0 0.0 0.12346 -1.0 5.5 20.0 cm')
     end
 
     it 'uses fixed digits with very small number' do
       values = Array.new(6, 0.000000000001)
-      string = Array.new(6, '0.00000').join ' '
+      string = Array.new(6, '0.0').join ' '
       allow(pdf.renderer).to receive(:add_content).with("#{string} cm")
       pdf.transformation_matrix(*values)
       expect(pdf.renderer).to have_received(:add_content).with("#{string} cm")
@@ -651,7 +675,7 @@ describe Prawn::Graphics do
 
     it 'saves the graphics state inside the given block' do
       values = Array.new(6, 0.000000000001)
-      string = Array.new(6, '0.00000').join ' '
+      string = Array.new(6, '0.0').join ' '
 
       allow(pdf).to receive(:save_graphics_state).with(no_args)
       allow(pdf.renderer).to receive(:add_content).with(any_args).twice
@@ -742,10 +766,6 @@ describe Prawn::Graphics do
           pdf.rotate(angle, origin: [x, y])
         end.to raise_error(Prawn::Errors::BlockRequired)
       end
-
-      def reduce_precision(float)
-        (format '%.5f', float).to_f
-      end
     end
 
     describe '#translate' do
@@ -808,10 +828,10 @@ describe Prawn::Graphics do
           pdf.scale(factor, origin: [x, y])
         end.to raise_error(Prawn::Errors::BlockRequired)
       end
-
-      def reduce_precision(float)
-        (format '%.5f', float).to_f
-      end
     end
   end
+
+  def reduce_precision(float)
+    float.round(5)
+  end
 end