prawn-icon 2.0.0 → 2.5.0

data/examples/paymentfont.rb

@@ -19,7 +19,7 @@ Prawn::Document.generate('paymentfont.pdf') do
   define_grid(columns: 6, rows: 12, gutter: 16)
 
   sub_header = 'PaymentFont'
-  link = 'http://paymentfont.io'
+  link = 'https://paymentfont.com'
   page_header sub_header, link
 
   first_page_icons icons do |icon_key|

data/lib/prawn/icon.rb

@@ -11,5 +11,6 @@ require_relative 'icon/base'
 require_relative 'icon/font_data'
 require_relative 'icon/parser'
 require_relative 'icon/interface'
+require_relative 'icon/compatibility'
 
 Prawn::Document.extensions << Prawn::Icon::Interface

data/lib/prawn/icon/compatibility.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+#
+# compatibility.rb - Prawn::Icon FontAwesome 4/5 compatibility shim.
+#
+# Copyright March 2018, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Icon
+    class Compatibility
+      SHIMS = YAML.load_file(
+        File.join(
+          Base::FONTDIR,
+          'fa4',
+          'shims.yml'
+        )
+      ).freeze
+
+      attr_accessor :key
+
+      def initialize(opts = {})
+        self.key = opts.fetch(:key)
+      end
+
+      def translate(io = STDERR)
+        @translate ||= begin
+          if key.start_with?('fa-')
+            map.tap { |replaced| warning(replaced, key, io) }
+          else
+            key
+          end
+        end
+      end
+
+      private
+
+      def map
+        SHIMS.fetch(key) do
+          # FontAwesome shim metadata assumes "fas" as the default
+          # font family if not explicity referenced.
+          "fas-#{key.sub(/fa-/, '')}"
+        end
+      end
+
+      def warning(new_key, old_key, io)
+        io.puts <<-DEPRECATION
+[Prawn::Icon - DEPRECATION WARNING]
+  FontAwesome 4 icon was referenced as '#{old_key}'.
+  Use the FontAwesome 5 icon '#{new_key}' instead.
+  This compatibility layer will be removed in Prawn::Icon 3.0.0.
+DEPRECATION
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/prawn/icon/interface.rb

@@ -62,6 +62,7 @@ module Prawn
       #   inline_format: true
       #
       def icon(key, opts = {})
+        key = translate_key(key)
         make_icon(key, opts).tap(&:render)
       end
 
@@ -81,7 +82,8 @@ module Prawn
       #   the underlying text method call.
       #
       def make_icon(key, opts = {})
-        if opts[:inline_format]
+        key = translate_key(key)
+        if opts.fetch(:inline_format, false)
           inline_icon(key, opts)
         else
           Icon.new(key, self, opts)
@@ -151,6 +153,7 @@ module Prawn
       #   pdf.table(data) => (2 x 2 table)
       #
       def table_icon(key, opts = {})
+        key = translate_key(key)
         if opts[:inline_format]
           content = Icon::Parser.format(self, key)
           opts.merge(content: content)
@@ -161,6 +164,10 @@ module Prawn
 
       private
 
+      def translate_key(key)
+        Compatibility.new(key: key).translate
+      end
+
       def icon_box(content, opts = {}) # :nodoc:
         Text::Formatted::Box.new(content, opts).tap do |box|
           box.render(dry_run: true)
@@ -176,8 +183,7 @@ module Prawn
 
     def initialize(key, document, opts = {})
       @pdf     = document
-      @set     = opts[:set] ||
-                 FontData.specifier_from_key(key)
+      @set     = opts.fetch(:set) { FontData.specifier_from_key(key) }
       @data    = FontData.load(document, @set)
       @key     = strip_specifier_from_key(key)
       @unicode = @data.unicode(@key)

data/lib/prawn/icon/parser.rb

@@ -57,7 +57,6 @@ module Prawn
             tokens.each do |token|
               # Skip the closing tag
               next if token =~ /<\/icon>/i
-              icon = {}
 
               # Convert [[1,2], [3,4]] to { :1 => 2, :3 => 4 }
               attrs = token.scan(ATTR_REGEX).inject({}) do |k, v|
@@ -65,8 +64,7 @@ module Prawn
                 k.merge!(val)
               end
 
-              icon.merge!(attrs)
-              array << icon
+              array << attrs
             end
           end
         end
@@ -101,13 +99,14 @@ module Prawn
         def keys_to_unicode(document, content, config)
           [].tap do |icons|
             content.each_with_index do |icon, index|
+              key = Compatibility.new(key: icon).translate
               options ||= {}
               options = config[index] if config.any?
               info = {
-                set:     FontData.specifier_from_key(icon),
+                set:     FontData.specifier_from_key(key),
                 size:    options[:size],
                 color:   options[:color],
-                content: FontData.unicode_from_key(document, icon)
+                content: FontData.unicode_from_key(document, key)
               }
               icons << info
             end

data/lib/prawn/icon/version.rb

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

data/spec/integration/icon_spec.rb

@@ -77,17 +77,17 @@ describe Prawn::Icon::Interface do
 
     context 'invalid icon key' do
       it 'should raise IconNotFound' do
-        proc = Proc.new { pdf.icon 'far-__INVALID' }
-
-        expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
+        expect { pdf.icon('far-__INVALID') }.to raise_error(
+          Prawn::Icon::Errors::IconNotFound
+        )
       end
     end
 
     context 'invalid specifier' do
       it 'should raise UnknownFont' do
-        proc = Proc.new { pdf.icon '__INVALID__' }
-
-        expect(proc).to raise_error(Prawn::Errors::UnknownFont)
+        expect { pdf.icon('__INVALID__') }.to raise_error(
+          Prawn::Errors::UnknownFont
+        )
       end
     end
   end

data/spec/unit/compatibility_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+#
+# Copyright March 2018, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+describe Prawn::Icon::Compatibility do
+  describe '#translate' do
+    let(:stderr) { StringIO.new }
+    subject { described_class.new(key: key) }
+
+    context 'with a non-deprecated key' do
+      let(:key) { 'fas-adjust' }
+
+      it 'does not write to STDERR' do
+        value = subject.translate(stderr)
+        stderr.rewind
+        expect(stderr.read).to be_empty
+      end
+
+      it 'returns the original key' do
+        expect(subject.translate(stderr)).to eq(key)
+      end
+    end
+
+    context 'with a depreacted FontAwesome key' do
+      let(:key) { 'fa-birthday-cake' }
+      let(:mapped_key) { 'fas-birthday-cake' }
+
+      it 'writes a deprecation warning to STDERR' do
+        subject.translate(stderr)
+        stderr.rewind
+        errors = stderr.read
+        expect(errors).to include('DEPRECATION')
+        expect(errors).to include(key)
+        expect(errors).to include(mapped_key)
+      end
+
+      it 'returns the mapped key' do
+        expect(subject.translate(stderr)).to eq(mapped_key)
+      end
+    end
+  end
+end

data/spec/unit/errors/icon_key_empty_spec.rb

@@ -12,8 +12,6 @@ describe Prawn::Icon::Errors::IconKeyEmpty do
   end
 
   it 'is thrown on a missing icon key' do
-    proc = Proc.new { pdf.icon '' }
-
-    expect(proc).to raise_error(described_class)
+    expect { pdf.icon('') }.to raise_error(described_class)
   end
 end

data/spec/unit/errors/icon_not_found_spec.rb

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

data/spec/unit/font_data_spec.rb

@@ -72,15 +72,15 @@ describe Prawn::Icon::FontData do
     end
 
     it 'should error when key is nil' do
-      proc = Proc.new { Prawn::Icon::FontData.specifier_from_key nil }
-
-      expect(proc).to raise_error(Prawn::Icon::Errors::IconKeyEmpty)
+      expect { Prawn::Icon::FontData.specifier_from_key(nil) }.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::Icon::Errors::IconKeyEmpty)
+      expect { Prawn::Icon::FontData.specifier_from_key('') }.to raise_error(
+        Prawn::Icon::Errors::IconKeyEmpty
+      )
     end
 
     it 'should handle strings without any dashes properly' do
@@ -141,9 +141,9 @@ describe Prawn::Icon::FontData do
     end
 
     it 'should raise an error if unable to match a key' do
-      proc = Proc.new { fontawesome.unicode('an invalid sequence') }
-
-      expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
+      expect { fontawesome.unicode('an invalid sequence') }.to raise_error(
+        Prawn::Icon::Errors::IconNotFound
+      )
     end
   end
 

data/spec/unit/icon_spec.rb

@@ -19,25 +19,25 @@ describe Prawn::Icon do
       end
 
       it 'should raise an error if icon key is not found' do
-        proc = Proc.new { Prawn::Icon.new 'far-__INVALID__', pdf }
-
-        expect(proc).to raise_error(errors::IconNotFound)
+        expect { Prawn::Icon.new('far-__INVALID__', pdf) }.to raise_error(
+          errors::IconNotFound
+        )
       end
     end
 
     context 'invalid icon specifier' do
       it 'should raise an error' do
-        proc = Proc.new { pdf.icon '__INVALID__  some text' }
-
-        expect(proc).to raise_error(Prawn::Errors::UnknownFont)
+        expect { pdf.icon('__INVALID__  some text') }.to raise_error(
+          Prawn::Errors::UnknownFont
+        )
       end
     end
 
     context 'without a pdf object' do
       it 'should raise an ArgumentError' do
-        proc = Proc.new { Prawn::Icon.new('far-address-book') }
-
-        expect(proc).to raise_error(ArgumentError)
+        expect { Prawn::Icon.new('far-address-book') }.to raise_error(
+          ArgumentError
+        )
       end
     end
   end
@@ -80,9 +80,9 @@ describe Prawn::Icon do
 
     context 'without dashes in key' do
       it 'raise an error about invalid keys' do
-        proc = Proc.new { Prawn::Icon.new 'some invalid key', pdf }
-
-        expect(proc).to raise_error(Prawn::Errors::UnknownFont)
+        expect { Prawn::Icon.new('some invalid key', pdf) }.to raise_error(
+          Prawn::Errors::UnknownFont
+        )
       end
     end
   end
@@ -98,9 +98,9 @@ describe Prawn::Icon do
 
     context 'invalid icon key' do
       it 'should raise IconNotFound' do
-        proc = Proc.new { Prawn::Icon.new 'far-__INVALID__', pdf }
-
-        expect(proc).to raise_error(errors::IconNotFound)
+        expect { Prawn::Icon.new('far-__INVALID__', pdf) }.to raise_error(
+          errors::IconNotFound
+        )
       end
     end
   end

data/spec/unit/parser_spec.rb

@@ -38,16 +38,18 @@ describe Prawn::Icon::Parser do
 
     it 'should raise an error when an icon key is invalid' do
       string = '<icon>an invalid key</icon>'
-      proc = Proc.new { Prawn::Icon::Parser.format(pdf, string) }
 
-      expect(proc).to raise_error(Prawn::Errors::UnknownFont)
+      expect { Prawn::Icon::Parser.format(pdf, string) }.to raise_error(
+        Prawn::Errors::UnknownFont
+      )
     end
 
     it 'should raise an error when an icon is not found for valid set' do
       string = '<icon>far-__INVALID__</icon>'
-      proc = Proc.new { Prawn::Icon::Parser.format(pdf, string) }
 
-      expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
+      expect { Prawn::Icon::Parser.format(pdf, string) }.to raise_error(
+        Prawn::Icon::Errors::IconNotFound
+      )
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2019-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -133,6 +133,7 @@ files:
 - README.md
 - Rakefile
 - data/fonts/DejaVuSans.ttf
+- data/fonts/fa4/shims.yml
 - data/fonts/fab/LICENSE
 - data/fonts/fab/fa-brands.ttf
 - data/fonts/fab/fab.yml
@@ -156,6 +157,7 @@ files:
 - examples/paymentfont.rb
 - lib/prawn/icon.rb
 - lib/prawn/icon/base.rb
+- lib/prawn/icon/compatibility.rb
 - lib/prawn/icon/errors.rb
 - lib/prawn/icon/font_data.rb
 - lib/prawn/icon/interface.rb
@@ -167,6 +169,7 @@ files:
 - spec/support/parser_helper.rb
 - spec/support/pdf_helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/compatibility_spec.rb
 - spec/unit/errors/icon_key_empty_spec.rb
 - spec/unit/errors/icon_not_found_spec.rb
 - spec/unit/font_data_spec.rb
@@ -194,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF