prawn-icon 1.4.0 → 2.0.0

data/examples/fontawesome.rb

@@ -3,33 +3,41 @@
 require_relative '../lib/prawn/icon'
 require_relative 'example_helper'
 
-Prawn::Document.generate('fontawesome.pdf') do
-  deja_path = File.join \
-    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
+STYLES = {
+  fab: 'Brands',
+  far: 'Regular',
+  fas: 'Solid'
+}.freeze
 
-  font_families.update({
-    'deja' => { normal: deja_path }
-  })
+STYLES.each do |specifier, type|
+  Prawn::Document.generate("fontawesome_#{type.downcase}.pdf") do
+    deja_path = File.join \
+      Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
-  font('deja')
+    font_families.update(
+      'deja' => { normal: deja_path }
+    )
 
-  icons = icon_keys(self, 'fa')
-  required_pages = number_of_pages(self, 'fa')
+    font('deja')
 
-  define_grid(columns: 6, rows: 12, gutter: 16)
+    icons = icon_keys(self, specifier.to_s)
+    required_pages = number_of_pages(self, specifier.to_s)
 
-  sub_header = 'FontAwesome'
-  link = 'http://fontawesome.io/icons/'
-  page_header sub_header, link
+    define_grid(columns: 6, rows: 12, gutter: 16)
 
-  first_page_icons icons do |icon_key|
-    # Just call the +icon+ method and pass in an icon key
-    icon icon_key, size: 20, align: :center
-  end
+    sub_header = "FontAwesome | #{type}"
+    link = 'http://fontawesome.io/icons/'
+    page_header sub_header, link
+
+    first_page_icons icons do |icon_key|
+      # Just call the +icon+ method and pass in an icon key
+      icon icon_key, size: 20, align: :center
+    end
 
-  start_new_page
+    start_new_page
 
-  page_icons icons, required_pages do |icon_key|
-    icon icon_key, size: 20, align: :center
+    page_icons icons, required_pages do |icon_key|
+      icon icon_key, size: 20, align: :center
+    end
   end
 end

data/lib/prawn/icon.rb

@@ -6,6 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
+require_relative 'icon/version'
 require_relative 'icon/base'
 require_relative 'icon/font_data'
 require_relative 'icon/parser'

data/lib/prawn/icon/font_data.rb

@@ -45,7 +45,7 @@ module Prawn
       attr_reader :set
 
       def initialize(document, opts = {})
-        @set = opts[:set] || :fa
+        @set = opts.fetch(:set)
         load_fonts(document)
       end
 

data/lib/prawn/icon/interface.rb

@@ -9,8 +9,7 @@
 module Prawn
   # Easy icon font usage within Prawn. Currently
   # supported icon fonts include: FontAwesome,
-  # Zurb Foundicons, GitHub Octicons, as well as
-  # PaymentFont.
+  # Zurb Foundicons and PaymentFont.
   #
   # = Icon Keys
   #
@@ -58,8 +57,8 @@ module Prawn
       #   the underlying +text+ method call.
       #
       # == Examples:
-      #   pdf.icon 'fa-beer'
-      #   pdf.icon '<icon color="0099FF">fa-arrows</icon>',
+      #   pdf.icon 'fas-beer'
+      #   pdf.icon '<icon color="0099FF">fas-user-circle</icon>',
       #   inline_format: true
       #
       def icon(key, opts = {})
@@ -135,7 +134,7 @@ module Prawn
       #   that match the data necessary for the
       #   specified icon.
       #
-      #   eg. { font: 'fa', content: '\uf047' }
+      #   eg. { font: 'fas', content: "\uf2b9" }
       #
       #   Note that the +font+ key will not be set
       #   if +inline_format: true+.
@@ -145,7 +144,7 @@ module Prawn
       #
       #   data = [
       #     # Explicit brackets must be used here
-      #     [pdf.table_icon('fa-arrows'), 'Cell 1'],
+      #     [pdf.table_icon('fas-coffee'), 'Cell 1'],
       #     ['Cell 2', 'Cell 3']
       #   ]
       #

data/lib/prawn/icon/version.rb

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

data/prawn-icon.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.description = <<-END_DESC
   Prawn::Icon provides various icon fonts including
-  FontAwesome, Foundation Icons and GitHub Octicons
+  FontAwesome, PaymentFont and Foundation Icons
   for use with the Prawn PDF toolkit.
   END_DESC
 end

data/spec/integration/icon_spec.rb

@@ -13,7 +13,7 @@ describe Prawn::Icon::Interface do
     context 'valid icon key' do
       context 'with options' do
         it 'should handle text options (size)' do
-          pdf.icon 'fa-arrows', size: 60
+          pdf.icon 'far-address-book', size: 60
           text = PDF::Inspector::Text.analyze(pdf.render)
 
           expect(text.font_settings.first[:size]).to eq(60)
@@ -22,27 +22,27 @@ describe Prawn::Icon::Interface do
 
       context 'inline_format: true' do
         it 'should handle text options (size)' do
-          pdf.icon '<icon size="60">fa-arrows</icon>', inline_format: true
+          pdf.icon '<icon size="60">far-address-book</icon>', inline_format: true
           text = PDF::Inspector::Text.analyze(pdf.render)
 
-          expect(text.strings.first).to eq("\uf047")
+          expect(text.strings.first).to eq('')
           expect(text.font_settings.first[:size]).to eq(60.0)
         end
 
         it 'should be able to render on multiple documents' do
           pdf1 = create_pdf
           pdf2 = create_pdf
-          pdf1.icon '<icon>fa-arrows</icon>', inline_format: true
-          pdf2.icon '<icon>fa-arrows</icon>', inline_format: true
+          pdf1.icon '<icon>far-address-book</icon>', inline_format: true
+          pdf2.icon '<icon>far-address-book</icon>', inline_format: true
           text1 = PDF::Inspector::Text.analyze(pdf1.render)
           text2 = PDF::Inspector::Text.analyze(pdf2.render)
 
-          expect(text1.strings.first).to eq("\uf047")
-          expect(text2.strings.first).to eq("\uf047")
+          expect(text1.strings.first).to eq('')
+          expect(text2.strings.first).to eq('')
         end
 
         it 'renders the icon at the proper cursor position (#24)' do
-          icon_text = '<icon>fa-info-circle</icon> icon here!'
+          icon_text = '<icon>fas-info-circle</icon> icon here!'
           pdf.text 'Start'
           pdf.move_down 10
           pdf.text 'More'
@@ -57,7 +57,7 @@ describe Prawn::Icon::Interface do
 
         context 'with final_gap: false' do
           it 'renders the icon without a final gap' do
-            icon = pdf.icon '<icon size="60">fa-arrows</icon>',
+            icon = pdf.icon '<icon size="60">far-address-book</icon>',
               inline_format: true,
               final_gap: false
             expect(icon.at.last.round).to eq(792)
@@ -67,17 +67,17 @@ describe Prawn::Icon::Interface do
 
       context 'without options' do
         it 'should render an icon to document' do
-          pdf.icon 'fa-arrows'
+          pdf.icon 'far-address-book'
           text = PDF::Inspector::Text.analyze(pdf.render)
 
-          expect(text.strings.first).to eq("\uf047")
+          expect(text.strings.first).to eq('')
         end
       end
     end
 
     context 'invalid icon key' do
       it 'should raise IconNotFound' do
-        proc = Proc.new { pdf.icon 'fa-__INVALID' }
+        proc = Proc.new { pdf.icon 'far-__INVALID' }
 
         expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
       end
@@ -95,7 +95,7 @@ describe Prawn::Icon::Interface do
   describe '::make_icon' do
     context ':inline_format => false (default)' do
       it 'should return a Prawn::Icon instance' do
-        icon = pdf.make_icon 'fa-arrows'
+        icon = pdf.make_icon 'far-address-book'
 
         expect(icon).to be_a(Prawn::Icon)
       end
@@ -103,7 +103,7 @@ describe Prawn::Icon::Interface do
 
     context ':inline_format => true' do
       it 'should return a Prawn::::Text::Formatted::Box instance' do
-        icon = pdf.make_icon '<icon>fa-arrows</icon>', inline_format: true
+        icon = pdf.make_icon '<icon>far-address-book</icon>', inline_format: true
 
         expect(icon).to be_a(Prawn::Text::Formatted::Box)
       end
@@ -112,7 +112,7 @@ describe Prawn::Icon::Interface do
 
   describe '::inline_icon' do
     it 'should return a Prawn::Text::Formatted::Box instance' do
-      icon = pdf.inline_icon '<icon>fa-arrows</icon>'
+      icon = pdf.inline_icon '<icon>far-address-book</icon>'
 
       expect(icon).to be_a(Prawn::Text::Formatted::Box)
     end
@@ -121,20 +121,20 @@ describe Prawn::Icon::Interface do
   describe '::table_icon' do
     context 'inline_format: false (default)' do
       it 'should return a hash with font and content keys' do
-        icon = pdf.table_icon 'fa-arrows'
+        icon = pdf.table_icon 'far-address-book'
 
         expect(icon).to be_a(Hash)
-        expect(icon[:font]).to eq('fa')
-        expect(icon[:content]).to eq("\uf047")
+        expect(icon[:font]).to eq('far')
+        expect(icon[:content]).to eq('')
       end
     end
 
     context 'inline_format: true' do
       it 'should convert <icon> to <font> tags' do
-        icon = pdf.table_icon '<icon>fa-user</icon>', inline_format: true
+        icon = pdf.table_icon '<icon>fas-user</icon>', inline_format: true
 
         expect(icon).to be_a(Hash)
-        expect(icon[:content]).to eq('<font name="fa"></font>')
+        expect(icon[:content]).to eq('<font name="fas"></font>')
         expect(icon[:inline_format]).to be true
       end
 
@@ -149,8 +149,8 @@ describe Prawn::Icon::Interface do
 
       context 'multiple icons' do
         it 'should ignore any text not in an icon tag' do
-          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>'
+          a = ['<icon>fas-user</icon> Some Text <icon>fi-laptop</icon>', inline_format: true]
+          out = '<font name="fas"></font> Some Text <font name="fi"></font>'
           icon = pdf.table_icon(*a)
 
           expect(icon).to be_a(Hash)
@@ -165,30 +165,39 @@ end
 describe Prawn::Icon do
   let(:pdf) { create_pdf }
 
-  context 'FontAwesome' do
-    it 'should render FontAwesome glyphs' do
-      pdf.icon 'fa-user'
+  context 'FontAwesome | Regular' do
+    it 'should render regular glyphs' do
+      pdf.icon 'far-user'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
-      expect(text.strings.first).to eq("")
+      expect(text.strings.first).to eq('')
     end
   end
 
-  context 'Foundation Icons' do
-    it 'should render Foundation glyphs' do
-      pdf.icon 'fi-laptop'
+  context 'FontAwesome | Solid' do
+    it 'should render solid glyphs' do
+      pdf.icon 'fas-user'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
-      expect(text.strings.first).to eq("")
+      expect(text.strings.first).to eq('')
     end
   end
 
-  context 'GitHub Octicons' do
-    it 'should render GitHub Octicon glyphs' do
-      pdf.icon 'octicon-logo-github'
+  context 'FontAwesome | Brands' do
+    it 'should render FontAwesome glyphs' do
+      pdf.icon 'fab-amazon'
+      text = PDF::Inspector::Text.analyze(pdf.render)
+
+      expect(text.strings.first).to eq('')
+    end
+  end
+
+  context 'Foundation Icons' do
+    it 'should render Foundation glyphs' do
+      pdf.icon 'fi-laptop'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
-      expect(text.strings.first).to eq("")
+      expect(text.strings.first).to eq('')
     end
   end
 
@@ -197,7 +206,7 @@ describe Prawn::Icon do
       pdf.icon 'pf-amazon'
       text = PDF::Inspector::Text.analyze(pdf.render)
 
-      expect(text.strings.first).to eq("")
+      expect(text.strings.first).to eq('')
     end
   end
 end

data/spec/unit/errors/icon_not_found_spec.rb

@@ -12,7 +12,7 @@ describe Prawn::Icon::Errors::IconNotFound do
   end
 
   it 'is thrown on an invalid icon key' do
-    proc = Proc.new { pdf.icon 'fa-an invalid key' }
+    proc = Proc.new { pdf.icon 'far-an invalid key' }
 
     expect(proc).to raise_error(described_class)
   end

data/spec/unit/font_data_spec.rb

@@ -8,21 +8,21 @@ require 'spec_helper'
 
 describe Prawn::Icon::FontData do
   let(:pdf) { create_pdf }
-  let(:fontawesome) { Prawn::Icon::FontData.new(pdf, set: :fa) }
+  let(:fontawesome) { Prawn::Icon::FontData.new(pdf, set: :far) }
 
   before { Prawn::Icon::FontData.release_data }
 
   describe '#initialize' do
-    before { Prawn::Icon::FontData.new(pdf, set: :fa) }
+    before { Prawn::Icon::FontData.new(pdf, set: :far) }
 
     it 'should update font_families on initialization' do
-      expect(pdf.font_families['fa']).not_to be_nil
+      expect(pdf.font_families['far']).not_to be_nil
     end
   end
 
   describe '::load' do
     context 'specifier is a string' do
-      let(:data) { Prawn::Icon::FontData.load(pdf, 'fa') }
+      let(:data) { Prawn::Icon::FontData.load(pdf, 'far') }
 
       it 'should load the font' do
         expect(data).not_to be_nil
@@ -30,7 +30,7 @@ describe Prawn::Icon::FontData do
 
       it 'should only load a single object for multiple documents' do
         obj_id_1 = data.object_id
-        second = Prawn::Icon::FontData.load(pdf, 'fa')
+        second = Prawn::Icon::FontData.load(pdf, 'far')
         obj_id_2 = second.object_id
 
         expect(obj_id_1).to eq(obj_id_2)
@@ -38,7 +38,7 @@ describe Prawn::Icon::FontData do
     end
 
     context 'specifier is a symbol' do
-      let(:data) { Prawn::Icon::FontData.load(pdf, :fa) }
+      let(:data) { Prawn::Icon::FontData.load(pdf, :far) }
 
       it 'should load the font' do
         expect(data).not_to be_nil
@@ -48,9 +48,8 @@ describe Prawn::Icon::FontData do
 
   describe '::release_data' do
     it 'should remove all data references if requested' do
-      Prawn::Icon::FontData.load(pdf, :fa)
+      Prawn::Icon::FontData.load(pdf, :far)
       Prawn::Icon::FontData.load(pdf, :fi)
-      Prawn::Icon::FontData.load(pdf, :octicon)
       data = Prawn::Icon::FontData.release_data
 
       expect(data).to be_empty
@@ -59,7 +58,7 @@ describe Prawn::Icon::FontData do
 
   describe '::unicode_from_key' do
     it 'should provide a UTF-8 string for a valid key' do
-      unicode = Prawn::Icon::FontData.unicode_from_key(pdf, 'fa-arrows')
+      unicode = Prawn::Icon::FontData.unicode_from_key(pdf, 'far-address-book')
       valid = unicode.force_encoding('UTF-8').valid_encoding?
 
       expect(valid).to be true
@@ -68,8 +67,8 @@ describe Prawn::Icon::FontData do
 
   describe '::specifier_from_key' do
     it 'should provide the font specifier from a valid key' do
-      specifier = Prawn::Icon::FontData.specifier_from_key('fa-arrows')
-      expect(specifier).to eq(:fa)
+      specifier = Prawn::Icon::FontData.specifier_from_key('far-address-book')
+      expect(specifier).to eq(:far)
     end
 
     it 'should error when key is nil' do
@@ -129,13 +128,13 @@ describe Prawn::Icon::FontData do
     it 'should retrieve the string specifier from the yaml legend file' do
       specifier = fontawesome.specifier
 
-      expect(specifier).to eq('fa')
+      expect(specifier).to eq('far')
     end
   end
 
   describe '#unicode' do
     it 'should provide a valid UTF-8 encoded string for a valid key' do
-      unicode = fontawesome.unicode('arrows')
+      unicode = fontawesome.unicode('address-book')
       valid = unicode.force_encoding('UTF-8').valid_encoding?
 
       expect(valid).to be true
@@ -167,13 +166,13 @@ describe Prawn::Icon::FontData do
     it 'should return a hash with the specifier as the first key' do
       yaml = fontawesome.yaml
       key = yaml.keys.first
-      mapping = yaml['fa']
+      mapping = yaml['far']
       inner_key = mapping.keys.last
       inner_value = mapping.values.last
       proc = Proc.new { inner_value.force_encoding('UTF-8').valid_encoding? }
 
       expect(yaml).to be_a(Hash)
-      expect(key).to eq('fa')
+      expect(key).to eq('far')
       expect(inner_key).to be_a(String)
       expect(inner_value).to be_a(String)
       expect(proc.call).to be true