prawn-icon 1.1.1 → 1.2.0

data/examples/fontawesome.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('fontawesome.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/examples/foundation_icons.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('foundation_icons.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/examples/octicons.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('octicons.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/examples/paymentfont.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('paymentfont.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/lib/prawn/icon.rb

@@ -6,21 +6,11 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn'
+require_relative 'icon/base'
 require_relative 'icon/font_data'
 require_relative 'icon/parser'
 
 module Prawn
-  module Errors
-    # Error raised when an icon glyph is not found
-    #
-    IconNotFound = Class.new(StandardError)
-
-    # Error raised when an icon key is not provided
-    #
-    IconKeyEmpty = Class.new(StandardError)
-  end
-
   # Easy icon font usage within Prawn. Currently
   # supported icon fonts include: FontAwesome,
   # Zurb Foundicons, GitHub Octicons, as well as
@@ -34,7 +24,7 @@ module Prawn
   # rule, included icon keys should match the keys from
   # the font provider. The icon key mapping is specified
   # in the font's +legend_file+, which is a +YAML+ file
-  # located in Prawn::Icon::FONTDIR/font/font.yml.
+  # located in Prawn::Icon::Base::FONTDIR/font/font.yml.
   #
   # Prawn::Icon::
   #   Houses the methods and interfaces necessary for
@@ -53,8 +43,7 @@ module Prawn
   #   to Prawn's internal formatted text parser.
   #
   class Icon
-    FONTDIR = File.join \
-      File.expand_path('../../..', __FILE__), 'data/fonts'
+    FONTDIR = Icon::Base::FONTDIR
 
     module Interface
       # Set up and draw an icon on this document. This

data/lib/prawn/icon/base.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# base.rb - Base configuration for Prawn::Icon.
+#
+# Copyright September 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'prawn'
+require_relative 'errors'
+
+module Prawn
+  class Icon
+    module Base
+      FONTDIR = File.join \
+        File.expand_path('../../../..', __FILE__), 'data/fonts'
+    end
+  end
+end

data/lib/prawn/icon/errors.rb

@@ -0,0 +1,13 @@
+module Prawn
+  class Icon
+    module Errors
+      # Error raised when an icon glyph is not found
+      #
+      IconNotFound = Class.new(StandardError)
+
+      # Error raised when an icon key is not provided
+      #
+      IconKeyEmpty = Class.new(StandardError)
+    end
+  end
+end

data/lib/prawn/icon/font_data.rb

@@ -34,7 +34,7 @@ module Prawn
 
         def specifier_from_key(key)
           if key.nil? || key == ''
-            raise Prawn::Errors::IconKeyEmpty,
+            raise Errors::IconKeyEmpty,
                   'Icon key provided was nil.'
           end
 
@@ -63,15 +63,15 @@ module Prawn
       end
 
       def path
-        ttf   = File.join(Icon::FONTDIR, @set.to_s, '*.ttf')
-        fonts = Dir[ttf]
+        ttf  = File.join(Icon::Base::FONTDIR, @set.to_s, '*.ttf')
+        font = Dir[ttf].first
 
-        if fonts.empty?
+        if font.nil?
           raise Prawn::Errors::UnknownFont,
                 "Icon font not found for set: #{@set}"
         end
 
-        @path ||= fonts.first
+        @path ||= font
       end
 
       def specifier
@@ -81,7 +81,7 @@ module Prawn
       def unicode(key)
         yaml[specifier][key].tap do |char|
           unless char
-            raise Prawn::Errors::IconNotFound,
+            raise Errors::IconNotFound,
                   "Key: #{specifier}-#{key} not found"
           end
         end

data/lib/prawn/icon/version.rb

@@ -8,6 +8,6 @@
 
 module Prawn
   class Icon
-    VERSION = '1.1.1'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/prawn-icon.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency('prawn', '>= 1.1.0', '< 3.0.0')
 
   spec.add_development_dependency('pdf-inspector', '~> 1.2.1')
-  spec.add_development_dependency('rspec', '~> 3.4.0')
+  spec.add_development_dependency('rspec', '~> 3.5.0')
   spec.add_development_dependency('rubocop', '~> 0.38.0')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('pdf-reader', '~> 1.4')

data/spec/integration/icon_spec.rb

@@ -7,11 +7,12 @@
 require 'spec_helper'
 
 describe Prawn::Icon::Interface do
+  let(:pdf) { create_pdf }
+
   describe '::icon' do
     context 'valid icon key' do
       context 'with options' do
         it 'should handle text options (size)' do
-          pdf = create_pdf
           pdf.icon 'fa-arrows', size: 60
           text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -21,7 +22,6 @@ describe Prawn::Icon::Interface do
 
       context 'inline_format: true' do
         it 'should handle text options (size)' do
-          pdf = create_pdf
           pdf.icon '<icon size="60">fa-arrows</icon>', inline_format: true
           text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -43,7 +43,6 @@ describe Prawn::Icon::Interface do
 
         it 'renders the icon at the proper cursor position (#24)' do
           icon_text = '<icon>fa-info-circle</icon> icon here!'
-          pdf = create_pdf
           pdf.text 'Start'
           pdf.move_down 10
           pdf.text 'More'
@@ -55,11 +54,19 @@ describe Prawn::Icon::Interface do
           expect(icon.at.first).to eq(0)
           expect(icon.at.last.round).to eq(734)
         end
+
+        context 'with final_gap: false' do
+          it 'renders the icon without a final gap' do
+            icon = pdf.icon '<icon size="60">fa-arrows</icon>',
+              inline_format: true,
+              final_gap: false
+            expect(icon.at.last.round).to eq(792)
+          end
+        end
       end
 
       context 'without options' do
         it 'should render an icon to document' do
-          pdf = create_pdf
           pdf.icon 'fa-arrows'
           text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -70,16 +77,14 @@ describe Prawn::Icon::Interface do
 
     context 'invalid icon key' do
       it 'should raise IconNotFound' do
-        pdf = create_pdf
         proc = Proc.new { pdf.icon 'fa-__INVALID' }
 
-        expect(proc).to raise_error(Prawn::Errors::IconNotFound)
+        expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
       end
     end
 
     context 'invalid specifier' do
       it 'should raise UnknownFont' do
-        pdf = create_pdf
         proc = Proc.new { pdf.icon '__INVALID__' }
 
         expect(proc).to raise_error(Prawn::Errors::UnknownFont)
@@ -90,39 +95,35 @@ describe Prawn::Icon::Interface do
   describe '::make_icon' do
     context ':inline_format => false (default)' do
       it 'should return a Prawn::Icon instance' do
-        pdf = create_pdf
         icon = pdf.make_icon 'fa-arrows'
 
-        expect(icon.class).to eq(Prawn::Icon)
+        expect(icon).to be_a(Prawn::Icon)
       end
     end
 
     context ':inline_format => true' do
       it 'should return a Prawn::::Text::Formatted::Box instance' do
-        pdf = create_pdf
         icon = pdf.make_icon '<icon>fa-arrows</icon>', inline_format: true
 
-        expect(icon.class).to eq(Prawn::Text::Formatted::Box)
+        expect(icon).to be_a(Prawn::Text::Formatted::Box)
       end
     end
   end
 
   describe '::inline_icon' do
     it 'should return a Prawn::Text::Formatted::Box instance' do
-      pdf = create_pdf
       icon = pdf.inline_icon '<icon>fa-arrows</icon>'
 
-      expect(icon.class).to eq(Prawn::Text::Formatted::Box)
+      expect(icon).to be_a(Prawn::Text::Formatted::Box)
     end
   end
 
   describe '::table_icon' do
     context 'inline_format: false (default)' do
       it 'should return a hash with font and content keys' do
-        pdf = create_pdf
         icon = pdf.table_icon 'fa-arrows'
 
-        expect(icon.class).to eq(Hash)
+        expect(icon).to be_a(Hash)
         expect(icon[:font]).to eq('fa')
         expect(icon[:content]).to eq("\uf047")
       end
@@ -130,32 +131,29 @@ describe Prawn::Icon::Interface do
 
     context 'inline_format: true' do
       it 'should convert <icon> to <font> tags' do
-        pdf = create_pdf
         icon = pdf.table_icon '<icon>fa-user</icon>', inline_format: true
 
-        expect(icon.class).to eq(Hash)
+        expect(icon).to be_a(Hash)
         expect(icon[:content]).to eq('<font name="fa"></font>')
         expect(icon[:inline_format]).to be true
       end
 
       it 'should ignore all other tags' do
-        pdf = create_pdf
         a = ['<b>BOLD</b> <color rgb="0099FF">BLUE</color>', inline_format: true]
         icon = pdf.table_icon(*a)
 
-        expect(icon.class).to eq(Hash)
+        expect(icon).to be_a(Hash)
         expect(icon[:content]).to eq(a[0])
         expect(icon[:inline_format]).to be true
       end
 
       context 'multiple icons' do
         it 'should ignore any text not in an icon tag' do
-          pdf = create_pdf
           a = ['<icon>fa-user</icon> Some Text <icon>fi-laptop</icon>', inline_format: true]
           out = '<font name="fa"></font> Some Text <font name="fi"></font>'
           icon = pdf.table_icon(*a)
 
-          expect(icon.class).to eq(Hash)
+          expect(icon).to be_a(Hash)
           expect(icon[:content]).to eq(out)
           expect(icon[:inline_format]).to be true
         end
@@ -165,9 +163,10 @@ describe Prawn::Icon::Interface do
 end
 
 describe Prawn::Icon do
+  let(:pdf) { create_pdf }
+
   context 'FontAwesome' do
     it 'should render FontAwesome glyphs' do
-      pdf = create_pdf
       pdf.icon 'fa-user'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -177,7 +176,6 @@ describe Prawn::Icon do
 
   context 'Foundation Icons' do
     it 'should render Foundation glyphs' do
-      pdf = create_pdf
       pdf.icon 'fi-laptop'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -187,7 +185,6 @@ describe Prawn::Icon do
 
   context 'GitHub Octicons' do
     it 'should render GitHub Octicon glyphs' do
-      pdf = create_pdf
       pdf.icon 'octicon-logo-github'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
@@ -197,7 +194,6 @@ describe Prawn::Icon do
 
   context 'PaymentFont' do
     it 'should render PaymentFont glyphs' do
-      pdf = create_pdf
       pdf.icon 'pf-amazon'
       text = PDF::Inspector::Text.analyze(pdf.render)
 

data/spec/support/parser_helper.rb

@@ -14,4 +14,4 @@ module ParserHelper
     regex = Prawn::Icon::Parser::CONTENT_REGEX
     string.scan(regex).flatten
   end
-end
+end

data/spec/support/pdf_helper.rb

@@ -12,4 +12,4 @@ module PDFHelper
   def valid_unicode?(string)
     string.force_encoding('UTF-8').valid_encoding?
   end
-end
+end

data/spec/unit/base_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# Copyright September 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+describe Prawn::Icon::Base do
+  describe 'FONTDIR' do
+    it 'returns the data/fonts directory' do
+      path = File.expand_path '../../..', __FILE__
+      path = File.join path, 'data/fonts'
+      expect(Prawn::Icon::Base::FONTDIR).to eq(path)
+    end
+  end
+end

data/spec/unit/errors/icon_key_empty_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# Copyright September 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+describe Prawn::Icon::Errors::IconKeyEmpty do
+  let(:pdf) { create_pdf }
+
+  it 'is a StandardError' do
+    expect(subject).to be_a(StandardError)
+  end
+
+  it 'is thrown on a missing icon key' do
+    proc = Proc.new { pdf.icon '' }
+
+    expect(proc).to raise_error(described_class)
+  end
+end

data/spec/unit/errors/icon_not_found_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# Copyright September 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+describe Prawn::Icon::Errors::IconNotFound do
+  let(:pdf) { create_pdf }
+
+  it 'is a StandardError' do
+    expect(subject).to be_a(StandardError)
+  end
+
+  it 'is thrown on an invalid icon key' do
+    proc = Proc.new { pdf.icon 'fa-an invalid key' }
+
+    expect(proc).to raise_error(described_class)
+  end
+end

data/spec/unit/font_data_spec.rb

@@ -7,44 +7,47 @@
 require 'spec_helper'
 
 describe Prawn::Icon::FontData do
+  let(:pdf) { create_pdf }
+  let(:fontawesome) { Prawn::Icon::FontData.new(pdf, set: :fa) }
+
+  before { Prawn::Icon::FontData.release_data }
+
   describe '#initialize' do
-    it 'should update font_families on initialization' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
+    before { Prawn::Icon::FontData.new(pdf, set: :fa) }
 
+    it 'should update font_families on initialization' do
       expect(pdf.font_families['fa']).not_to be_nil
     end
   end
 
   describe '::load' do
-    it 'should only load a single object for multiple documents' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.load(pdf, 'fa')
-      obj_id_1 = data.__id__
-      data = Prawn::Icon::FontData.load(pdf, 'fa')
-      obj_id_2 = data.__id__
+    context 'specifier is a string' do
+      let(:data) { Prawn::Icon::FontData.load(pdf, 'fa') }
 
-      expect(obj_id_1).to eq(obj_id_2)
-    end
+      it 'should load the font' do
+        expect(data).not_to be_nil
+      end
 
-    it 'should accept a string as a specifier' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.load(pdf, 'fa')
+      it 'should only load a single object for multiple documents' do
+        obj_id_1 = data.object_id
+        second = Prawn::Icon::FontData.load(pdf, 'fa')
+        obj_id_2 = second.object_id
 
-      expect(data).not_to be_nil
+        expect(obj_id_1).to eq(obj_id_2)
+      end
     end
 
-    it 'should accept a symbol as a specifer' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.load(pdf, :fa)
+    context 'specifier is a symbol' do
+      let(:data) { Prawn::Icon::FontData.load(pdf, :fa) }
 
-      expect(data).not_to be_nil
+      it 'should load the font' do
+        expect(data).not_to be_nil
+      end
     end
   end
 
   describe '::release_data' do
     it 'should remove all data references if requested' do
-      pdf = create_pdf
       Prawn::Icon::FontData.load(pdf, :fa)
       Prawn::Icon::FontData.load(pdf, :fi)
       Prawn::Icon::FontData.load(pdf, :octicon)
@@ -56,7 +59,6 @@ describe Prawn::Icon::FontData do
 
   describe '::unicode_from_key' do
     it 'should provide a UTF-8 string for a valid key' do
-      pdf = create_pdf
       unicode = Prawn::Icon::FontData.unicode_from_key(pdf, 'fa-arrows')
       valid = unicode.force_encoding('UTF-8').valid_encoding?
 
@@ -73,13 +75,13 @@ describe Prawn::Icon::FontData do
     it 'should error when key is nil' do
       proc = Proc.new { Prawn::Icon::FontData.specifier_from_key nil }
 
-      expect(proc).to raise_error(Prawn::Errors::IconKeyEmpty)
+      expect(proc).to raise_error(Prawn::Icon::Errors::IconKeyEmpty)
     end
 
     it 'should error when key is an empty string' do
       proc = Proc.new { Prawn::Icon::FontData.specifier_from_key '' }
 
-      expect(proc).to raise_error(Prawn::Errors::IconKeyEmpty)
+      expect(proc).to raise_error(Prawn::Icon::Errors::IconKeyEmpty)
     end
 
     it 'should handle strings without any dashes properly' do
@@ -91,19 +93,15 @@ describe Prawn::Icon::FontData do
 
   describe '#font_version' do
     it 'should have a font version as a string' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf)
-      version = data.font_version
+      version = fontawesome.font_version
 
-      expect(version.is_a? String).to be true
+      expect(version).to be_a(String)
     end
   end
 
   describe '#legend_path' do
     it 'should have a valid path to a yml file for legend' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf)
-      path = data.legend_path
+      path = fontawesome.legend_path
       extname = File.extname(path)
 
       expect(extname).to eq('.yml')
@@ -112,19 +110,15 @@ describe Prawn::Icon::FontData do
 
   describe '#load_fonts' do
     it 'should return a FontData object' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf)
-      ret_val = data.load_fonts(pdf)
+      ret_val = fontawesome.load_fonts(pdf)
 
-      expect(ret_val.is_a? Prawn::Icon::FontData).to be true
+      expect(ret_val).to be_a(Prawn::Icon::FontData)
     end
   end
 
   describe '#path' do
     it 'should have a valid path to a TTF file' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf)
-      path = data.path
+      path = fontawesome.path
       extname = File.extname(path)
 
       expect(extname).to eq('.ttf')
@@ -133,9 +127,7 @@ describe Prawn::Icon::FontData do
 
   describe '#specifier' do
     it 'should retrieve the string specifier from the yaml legend file' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      specifier = data.specifier
+      specifier = fontawesome.specifier
 
       expect(specifier).to eq('fa')
     end
@@ -143,37 +135,29 @@ describe Prawn::Icon::FontData do
 
   describe '#unicode' do
     it 'should provide a valid UTF-8 encoded string for a valid key' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      unicode = data.unicode('arrows')
+      unicode = fontawesome.unicode('arrows')
       valid = unicode.force_encoding('UTF-8').valid_encoding?
 
       expect(valid).to be true
     end
 
     it 'should raise an error if unable to match a key' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      proc = Proc.new { data.unicode('an invalid sequence') }
+      proc = Proc.new { fontawesome.unicode('an invalid sequence') }
 
-      expect(proc).to raise_error(Prawn::Errors::IconNotFound)
+      expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
     end
   end
 
   describe '#keys' do
     it 'should return a non-empty array of strings' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      keys = data.keys
+      keys = fontawesome.keys
 
       expect(keys).not_to be_empty
-      expect(keys.first.is_a? String).to be true
+      expect(keys.first).to be_a(String)
     end
 
     it 'should not contain the version as a key' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      keys = data.keys
+      keys = fontawesome.keys
 
       expect(keys.include?('__font_version__')).to be false
     end
@@ -181,19 +165,17 @@ describe Prawn::Icon::FontData do
 
   describe '#yaml' do
     it 'should return a hash with the specifier as the first key' do
-      pdf = create_pdf
-      data = Prawn::Icon::FontData.new(pdf, set: :fa)
-      yaml = data.yaml
+      yaml = fontawesome.yaml
       key = yaml.keys.first
       mapping = yaml['fa']
       inner_key = mapping.keys.last
       inner_value = mapping.values.last
       proc = Proc.new { inner_value.force_encoding('UTF-8').valid_encoding? }
 
-      expect(yaml.is_a? Hash).to be true
+      expect(yaml).to be_a(Hash)
       expect(key).to eq('fa')
-      expect(inner_key.is_a? String).to be true
-      expect(inner_value.is_a? String).to be true
+      expect(inner_key).to be_a(String)
+      expect(inner_value).to be_a(String)
       expect(proc.call).to be true
     end
   end