prawn-icon 1.3.0 → 2.0.0

data/data/fonts/pf/pf.yml

@@ -1,98 +1,119 @@
+---
 pf:
-  __font_version__: '1.1.2'
-  amazon: "\uf000"
-  american-express: "\uf001"
-  american-express-alt: "\uf002"
-  atm: "\uf003"
-  bankomat: "\uf004"
-  bank-transfer: "\uf005"
-  bitcoin: "\uf006"
-  bitcoin-sign: "\uf007"
-  braintree: "\uf008"
-  btc: "\uf009"
-  card: "\uf00a"
-  carta-si: "\uf00b"
-  cash: "\uf00c"
-  cash-on-delivery: "\uf00d"
-  cb: "\uf00e"
-  cirrus: "\uf00f"
-  cirrus-alt: "\uf010"
-  clickandbuy: "\uf011"
-  credit-card: "\uf012"
-  diners: "\uf013"
-  discover: "\uf014"
-  ec: "\uf015"
-  eps: "\uf016"
-  eur: "\uf017"
-  facture: "\uf018"
-  fattura: "\uf019"
-  flattr: "\uf01a"
-  giropay: "\uf01b"
-  gittip: "\uf01c"
-  gratipay: "\uf01c"
-  google-wallet: "\uf01d"
-  google-wallet-alt: "\uf01e"
-  gbp: "\uf01f"
-  ideal: "\uf020"
-  ils: "\uf021"
-  inr: "\uf022"
-  invoice: "\uf023"
-  invoice-sign: "\uf024"
-  invoice-sign-alt: "\uf025"
-  invoice-sign-alt-o: "\uf026"
-  invoice-sign-o: "\uf027"
-  jcb: "\uf028"
-  jpy: "\uf029"
-  krw: "\uf02a"
-  maestro: "\uf02b"
-  maestro-alt: "\uf02c"
-  mastercard: "\uf02d"
-  mastercard-alt: "\uf02e"
-  mastercard-securecode: "\uf02f"
-  ogone: "\uf030"
-  paybox: "\uf031"
-  paylife: "\uf032"
-  paypal: "\uf033"
-  paypal-alt: "\uf034"
-  paysafecard: "\uf035"
-  postepay: "\uf036"
-  quick: "\uf037"
-  rechnung: "\uf038"
-  ripple: "\uf039"
-  rub: "\uf03a"
-  skrill: "\uf03b"
-  sofort: "\uf03c"
-  square: "\uf03d"
-  stripe: "\uf03e"
-  truste: "\uf03f"
-  try: "\uf040"
-  unionpay: "\uf041"
-  usd: "\uf042"
-  verified-by-visa: "\uf043"
-  verisign: "\uf044"
-  visa: "\uf045"
-  visa-electron: "\uf046"
-  western-union: "\uf047"
-  western-union-alt: "\uf048"
-  wirecard: "\uf049"
-  sepa: "\uf04a"
-  sepa-alt: "\uf04b"
-  apple-pay: "\uf04c"
-  interac: "\uf04d"
-  paymill: "\uf04e"
-  dankort: "\uf04f"
-  bancontact-mister-cash: "\uf050"
-  moip: "\uf051"
-  pagseguro: "\uf052"
-  cash-on-pickup: "\uf053"
-  sage: "\uf054"
-  elo: "\uf055"
-  elo-alt: "\uf056"
-  payu: "\uf057"
-  mercado-pago: "\uf058"
-  mercado-pago-sign: "\uf059"
-  payshop: "\uf05a"
-  multibanco: "\uf05b"
-  gratipay-sign: "\uf05c"
-  six: "\uf05d"
-  cashcloud: "\uf05e"
+  __font_version__: 1.2.5
+  amazon: ""
+  american-express: ""
+  american-express-alt: ""
+  atm: ""
+  bankomat: ""
+  bank-transfer: ""
+  bitcoin: ""
+  bitcoin-sign: ""
+  braintree: ""
+  btc: ""
+  card: ""
+  carta-si: ""
+  cash: ""
+  cash-on-delivery: ""
+  cb: ""
+  cirrus: ""
+  cirrus-alt: ""
+  clickandbuy: ""
+  credit-card: ""
+  diners: ""
+  discover: ""
+  ec: ""
+  eps: ""
+  eur: ""
+  facture: ""
+  fattura: ""
+  flattr: ""
+  giropay: ""
+  google-wallet: ""
+  google-wallet-alt: ""
+  gpb: ""
+  gratipay: ""
+  ideal: ""
+  ils: ""
+  inr: ""
+  invoice: ""
+  invoice-sign: ""
+  invoice-sign-alt: ""
+  invoice-sign-alt-o: ""
+  invoice-sign-o: ""
+  jcb: ""
+  jpy: ""
+  krw: ""
+  maestro: ""
+  maestro-alt: ""
+  mastercard: ""
+  mastercard-alt: ""
+  mastercard-securecode: ""
+  ogone: ""
+  paybox: ""
+  paylife: ""
+  paypal: ""
+  paypal-alt: ""
+  paysafecard: ""
+  postepay: ""
+  quick: ""
+  rechnung: ""
+  ripple: ""
+  rub: ""
+  skrill: ""
+  sofort: ""
+  square: ""
+  stripe: ""
+  truste: ""
+  try: ""
+  unionpay: ""
+  usd: ""
+  verified-by-visa: ""
+  verisign: ""
+  visa: ""
+  visa-electron: ""
+  western-union: ""
+  western-union-alt: ""
+  wirecard: ""
+  sepa: ""
+  sepa-alt: ""
+  apple-pay: ""
+  interac: ""
+  paymill: ""
+  dankort: ""
+  bancontact-mister-cash: ""
+  moip: ""
+  pagseguro: ""
+  cash-on-pickup: ""
+  sage: ""
+  elo: ""
+  elo-alt: ""
+  payu: ""
+  mercado-pago: ""
+  mercado-pago-sign: ""
+  payshop: ""
+  multibanco: ""
+  gratipay-sign: ""
+  six: ""
+  cashcloud: ""
+  interac-alt: ""
+  klarna: ""
+  bitpay: ""
+  venmo: ""
+  visa-debit: ""
+  alipay: ""
+  diners-alt: ""
+  hipercard: ""
+  skrill-alt: ""
+  shopify: ""
+  direct-debit: ""
+  sodexo: ""
+  bpay: ""
+  contactless: ""
+  contactless-alt: ""
+  eth: ""
+  ltc: ""
+  visa-pay: ""
+  wechat-pay: ""
+  amazon-pay: ""
+  amazon-pay-alt: ""

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/errors.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8
+#
+# errors.rb - Prawn::Icon standard errors.
+#
+# Copyright September 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
 module Prawn
   class Icon
     module Errors

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.3.0'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

data/prawn-icon.gemspec

@@ -1,16 +1,15 @@
 basedir = File.expand_path(File.dirname(__FILE__))
 require "#{basedir}/lib/prawn/icon/version"
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name     = 'prawn-icon'
   spec.version  = Prawn::Icon::VERSION
   spec.platform = Gem::Platform::RUBY
   spec.summary  = 'Provides icon fonts for PrawnPDF'
   spec.files    =  Dir.glob('{lib,spec,data,examples}/**/**/*') +
-                   %w(prawn-icon.gemspec Gemfile Rakefile) +
-                   %w(README.md CHANGELOG.md) +
-                   %w(COPYING LICENSE GPLv2 GPLv3)
+                   %w[prawn-icon.gemspec Gemfile Rakefile] +
+                   %w[README.md CHANGELOG.md] +
+                   %w[COPYING LICENSE GPLv2 GPLv3]
 
   spec.require_path              = 'lib'
   spec.required_ruby_version     = '>= 1.9.3'
@@ -25,16 +24,16 @@ 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.5.0')
-  spec.add_development_dependency('rubocop', '~> 0.44.1')
+  spec.add_development_dependency('pdf-inspector', '>= 1.2.1')
+  spec.add_development_dependency('rspec', '>= 3.5.0')
+  spec.add_development_dependency('rubocop', '~> 0.49.1')
   spec.add_development_dependency('rake')
-  spec.add_development_dependency('pdf-reader', '~> 1.4')
-  spec.add_development_dependency('simplecov', '~> 0.12')
+  spec.add_development_dependency('pdf-reader', '>= 1.4')
+  spec.add_development_dependency('simplecov')
 
   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