prawn-icon 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdc8d2f00cba2e00c1205ed4de7c247b0f38b27aa853923d3b1f9f4860e95308
-  data.tar.gz: d5911e59b2076987f2cf47ba1f2ec2f51f5cd3588d268f528287ce88bcafca05
+  metadata.gz: 8c9cf8d2f79db2e2732626f6b46ebb9f0a019243b29e68379ccc95e63a604dbd
+  data.tar.gz: a3f67c49dd586f4c45ec9ebcf846514d38f08b6aadd031ca60028fa464a09633
 SHA512:
-  metadata.gz: d0ac31b6d85219aa25a593fc9a14c39cae53876f67290b9b3406e2aaf1dd416de3d37c184330d8f8aa2b5e891e7532c7f487d9270a340a2b4dcbfc19e97a09d8
-  data.tar.gz: 02a6738e896b3e7decbd790e302233cd49ce04c7022be9cb4a4f399fd76ec6f49f361ee4f9d6ebc9b7621f83cc316720735c5766770942cf0a820028238dc89a
+  metadata.gz: 1bf95fa8ae5852d32880167fa6d0fcbc24498b43d0a3db8b5ea4eba6358f403fa4c08ceb68e9a7581a9e637e73a9b6d8774446f09d72c517f4f1098a5cd56230
+  data.tar.gz: ce1dce62f8eabb83c543a8f596848d0417cc2520f706bc6cb2e420850410f7889020d2ed33e231f82181988ae9532ec3d9c9ffa1f2fb12018479e6f94b3ffeb4

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+# 3.0.0 - November 10, 2020
+
+* **breaking change** - Fix incorrect layout and line-wrapping logic for inline-formatted icons. Please see [Inline Format Changes](#inline-format-changes) for more details.
+* Add a `#formatted_icon_box` method to retain the previous inline icon behaviour.
+* Allow `#formatted_icon_box` to accept absolute positioning parameters (`x`, `y`, and `at`). Thanks @navinspm!
+* Update fontawesome from version `5.11.2` to `5.15.1`.
+* See FontAwesome's [upgrade guide](https://github.com/FortAwesome/Font-Awesome/blob/57005cea6da7d1c67f3466974aecd25485f60452/UPGRADING.md) for more details.
+* Introduce a configuration mechanism so that the font directory can be customized as follows:
+
+```ruby
+Prawn::Icon.configure do |config|
+  config.font_directory = '/path/to/fonts'
+end
+```
+
+* Deprecate the global variables of `Prawn::Icon::Base::FONTDIR` and `Prawn::Icon::Compatibility::SHIMS`. Use `Prawn::Icon.configuration.font_directory` and `Prawn::Icon::Compatibility.shims` instead.
+* Use `Gem::Specification#full_gem_path` to get the root path of the gem directory to resolve https://github.com/jessedoyle/prawn-icon/issues/45.
+
+#### Inline Format Changes
+
+As noted in https://github.com/jessedoyle/prawn-icon/issues/49, `Prawn::Icon` did not correctly respect page boundaries for inline-formatted icons.
+
+The fix for the issue requires `Prawn::Icon` to use the inline layout and formatting logic implemented in `Prawn`.
+
+This change has ramifications to the `#icon` and `#inline_icon` method return values, but most applications should not require changes.
+
+Changes are listed below:
+
+* `#icon` - returns `nil` with the `inline_format: true` parameter.
+* `#inline_icon` - returns `nil` (instead of a `Prawn::Text::Formatted::Box` instance).
+
+You can call `#formatted_icon_box` to retain the previous inline icon functionality.
+
 # 2.5.0 - October 4, 2019
 
 * Update FontAwesome from `5.8.2` to `5.11.2`.

data/README.md

@@ -110,6 +110,16 @@ rake legend
 
 should generate these files when run from Prawn::Icon's gem directory.
 
+## Configuration
+
+You can optionally configure Prawn::Icon to use an alternate data directory for font files.
+
+```ruby
+Prawn::Icon.configure do |config|
+  config.font_directory = '/path/to/my/fonts'
+end
+```
+
 ## Contributing
 
 I'll gladly accept pull requests that are well tested for any bug found in Prawn::Icon.

data/Rakefile

@@ -31,4 +31,3 @@ task :legend do
 end
 
 RuboCop::RakeTask.new
-

data/data/fonts/fab/fab.yml

@@ -1,12 +1,11 @@
 ---
 fab:
-  __font_version__: 5.11.2
+  __font_version__: 5.15.1
   500px: ""
   accessible-icon: ""
   accusoft: ""
   acquisitions-incorporated: ""
   adn: ""
-  adobe: ""
   adversal: ""
   affiliatetheme: ""
   airbnb: ""
@@ -67,6 +66,7 @@ fab:
   centos: ""
   chrome: ""
   chromecast: ""
+  cloudflare: ""
   cloudscale: ""
   cloudsmith: ""
   cloudversify: ""
@@ -97,7 +97,9 @@ fab:
   cuttlefish: ""
   d-and-d: ""
   d-and-d-beyond: ""
+  dailymotion: ""
   dashcube: ""
+  deezer: ""
   delicious: ""
   deploydog: ""
   deskpro: ""
@@ -120,6 +122,7 @@ fab:
   earlybirds: ""
   ebay: ""
   edge: ""
+  edge-legacy: ""
   elementor: ""
   ello: ""
   ember: ""
@@ -139,6 +142,7 @@ fab:
   fedora: ""
   figma: ""
   firefox: ""
+  firefox-browser: ""
   first-order: ""
   first-order-alt: ""
   firstdraft: ""
@@ -179,6 +183,7 @@ fab:
   goodreads-g: ""
   google: ""
   google-drive: ""
+  google-pay: ""
   google-play: ""
   google-plus: ""
   google-plus-g: ""
@@ -188,20 +193,26 @@ fab:
   grav: ""
   gripfire: ""
   grunt: ""
+  guilded: ""
   gulp: ""
   hacker-news: ""
   hacker-news-square: ""
   hackerrank: ""
   hips: ""
   hire-a-helper: ""
+  hive: ""
   hooli: ""
   hornbill: ""
   hotjar: ""
   houzz: ""
   html5: ""
   hubspot: ""
+  ideal: ""
   imdb: ""
+  innosoft: ""
   instagram: ""
+  instagram-square: ""
+  instalod: ""
   intercom: ""
   internet-explorer: ""
   invision: ""
@@ -249,9 +260,11 @@ fab:
   meetup: ""
   megaport: ""
   mendeley: ""
+  microblog: ""
   microsoft: ""
   mix: ""
   mixcloud: ""
+  mixer: ""
   mizuni: ""
   modx: ""
   monero: ""
@@ -263,6 +276,7 @@ fab:
   npm: ""
   ns8: ""
   nutritionix: ""
+  octopus-deploy: ""
   odnoklassniki: ""
   odnoklassniki-square: ""
   old-republic: ""
@@ -278,6 +292,7 @@ fab:
   patreon: ""
   paypal: ""
   penny-arcade: ""
+  perbyte: ""
   periscope: ""
   phabricator: ""
   phoenix-framework: ""
@@ -287,6 +302,7 @@ fab:
   pied-piper-alt: ""
   pied-piper-hat: ""
   pied-piper-pp: ""
+  pied-piper-square: ""
   pinterest: ""
   pinterest-p: ""
   pinterest-square: ""
@@ -316,6 +332,7 @@ fab:
   rev: ""
   rocketchat: ""
   rockrms: ""
+  rust: ""
   safari: ""
   salesforce: ""
   sass: ""
@@ -326,6 +343,7 @@ fab:
   sellsy: ""
   servicestack: ""
   shirtsinbulk: ""
+  shopify: ""
   shopware: ""
   simplybuilt: ""
   sistrix: ""
@@ -372,6 +390,7 @@ fab:
   themeco: ""
   themeisle: ""
   think-peaks: ""
+  tiktok: ""
   trade-federation: ""
   trello: ""
   tripadvisor: ""
@@ -385,7 +404,10 @@ fab:
   ubuntu: ""
   uikit: ""
   umbraco: ""
+  uncharted: ""
   uniregistry: ""
+  unity: ""
+  unsplash: ""
   untappd: ""
   ups: ""
   usb: ""
@@ -403,6 +425,7 @@ fab:
   vk: ""
   vnv: ""
   vuejs: ""
+  watchman-monitoring: ""
   waze: ""
   weebly: ""
   weibo: ""
@@ -414,6 +437,7 @@ fab:
   windows: ""
   wix: ""
   wizards-of-the-coast: ""
+  wodu: ""
   wolf-pack-battalion: ""
   wordpress: ""
   wordpress-simple: ""

data/data/fonts/far/far.yml

@@ -1,6 +1,6 @@
 ---
 far:
-  __font_version__: 5.11.2
+  __font_version__: 5.15.1
   address-book: ""
   address-card: ""
   angry: ""

data/data/fonts/fas/fas.yml

@@ -1,6 +1,6 @@
 ---
 fas:
-  __font_version__: 5.11.2
+  __font_version__: 5.15.1
   ad: ""
   address-book: ""
   address-card: ""
@@ -54,6 +54,9 @@ fas:
   backspace: ""
   backward: ""
   bacon: ""
+  bacteria: ""
+  bacterium: ""
+  bahai: ""
   balance-scale: ""
   balance-scale-left: ""
   balance-scale-right: ""
@@ -101,6 +104,7 @@ fas:
   bowling-ball: ""
   box: ""
   box-open: ""
+  box-tissue: ""
   boxes: ""
   braille: ""
   brain: ""
@@ -138,6 +142,7 @@ fas:
   car-battery: ""
   car-crash: ""
   car-side: ""
+  caravan: ""
   caret-down: ""
   caret-left: ""
   caret-right: ""
@@ -222,6 +227,7 @@ fas:
   compact-disc: ""
   compass: ""
   compress: ""
+  compress-alt: ""
   compress-arrows-alt: ""
   concierge-bell: ""
   cookie: ""
@@ -257,6 +263,7 @@ fas:
   dice-two: ""
   digital-tachograph: ""
   directions: ""
+  disease: ""
   divide: ""
   dizzy: ""
   dna: ""
@@ -298,6 +305,7 @@ fas:
   exclamation-circle: ""
   exclamation-triangle: ""
   expand: ""
+  expand-alt: ""
   expand-arrows-alt: ""
   external-link-alt: ""
   external-link-square-alt: ""
@@ -307,6 +315,7 @@ fas:
   fan: ""
   fast-backward: ""
   fast-forward: ""
+  faucet: ""
   fax: ""
   feather: ""
   feather-alt: ""
@@ -412,7 +421,9 @@ fas:
   hamsa: ""
   hand-holding: ""
   hand-holding-heart: ""
+  hand-holding-medical: ""
   hand-holding-usd: ""
+  hand-holding-water: ""
   hand-lizard: ""
   hand-middle-finger: ""
   hand-paper: ""
@@ -424,18 +435,25 @@ fas:
   hand-pointer: ""
   hand-rock: ""
   hand-scissors: ""
+  hand-sparkles: ""
   hand-spock: ""
   hands: ""
   hands-helping: ""
+  hands-wash: ""
   handshake: ""
+  handshake-alt-slash: ""
+  handshake-slash: ""
   hanukiah: ""
   hard-hat: ""
   hashtag: ""
   hat-cowboy: ""
   hat-cowboy-side: ""
   hat-wizard: ""
-  haykal: ""
   hdd: ""
+  head-side-cough: ""
+  head-side-cough-slash: ""
+  head-side-mask: ""
+  head-side-virus: ""
   heading: ""
   headphones: ""
   headphones-alt: ""
@@ -456,6 +474,7 @@ fas:
   hospital: ""
   hospital-alt: ""
   hospital-symbol: ""
+  hospital-user: ""
   hot-tub: ""
   hotdog: ""
   hotel: ""
@@ -464,6 +483,7 @@ fas:
   hourglass-half: ""
   hourglass-start: ""
   house-damage: ""
+  house-user: ""
   hryvnia: ""
   i-cursor: ""
   ice-cream: ""
@@ -497,6 +517,7 @@ fas:
   language: ""
   laptop: ""
   laptop-code: ""
+  laptop-house: ""
   laptop-medical: ""
   laugh: ""
   laugh-beam: ""
@@ -526,6 +547,8 @@ fas:
   long-arrow-alt-up: ""
   low-vision: ""
   luggage-cart: ""
+  lungs: ""
+  lungs-virus: ""
   magic: ""
   magnet: ""
   mail-bulk: ""
@@ -616,6 +639,7 @@ fas:
   pen-square: ""
   pencil-alt: ""
   pencil-ruler: ""
+  people-arrows: ""
   people-carry: ""
   pepper-hot: ""
   percent: ""
@@ -635,6 +659,7 @@ fas:
   plane: ""
   plane-arrival: ""
   plane-departure: ""
+  plane-slash: ""
   play: ""
   play-circle: ""
   plug: ""
@@ -658,6 +683,8 @@ fas:
   print: ""
   procedures: ""
   project-diagram: ""
+  pump-medical: ""
+  pump-soap: ""
   puzzle-piece: ""
   qrcode: ""
   question: ""
@@ -720,6 +747,7 @@ fas:
   share-square: ""
   shekel-sign: ""
   shield-alt: ""
+  shield-virus: ""
   ship: ""
   shipping-fast: ""
   shoe-prints: ""
@@ -735,6 +763,7 @@ fas:
   signal: ""
   signature: ""
   sim-card: ""
+  sink: ""
   sitemap: ""
   skating: ""
   skiing: ""
@@ -755,6 +784,7 @@ fas:
   snowflake: ""
   snowman: ""
   snowplow: ""
+  soap: ""
   socks: ""
   solar-panel: ""
   sort: ""
@@ -796,8 +826,11 @@ fas:
   stop: ""
   stop-circle: ""
   stopwatch: ""
+  stopwatch-20: ""
   store: ""
   store-alt: ""
+  store-alt-slash: ""
+  store-slash: ""
   stream: ""
   street-view: ""
   strikethrough: ""
@@ -858,6 +891,7 @@ fas:
   toggle-on: ""
   toilet: ""
   toilet-paper: ""
+  toilet-paper-slash: ""
   toolbox: ""
   tools: ""
   tooth: ""
@@ -866,6 +900,7 @@ fas:
   tractor: ""
   trademark: ""
   traffic-light: ""
+  trailer: ""
   train: ""
   tram: ""
   transgender: ""
@@ -921,17 +956,23 @@ fas:
   user-times: ""
   users: ""
   users-cog: ""
+  users-slash: ""
   utensil-spoon: ""
   utensils: ""
   vector-square: ""
   venus: ""
   venus-double: ""
   venus-mars: ""
+  vest: ""
+  vest-patches: ""
   vial: ""
   vials: ""
   video: ""
   video-slash: ""
   vihara: ""
+  virus: ""
+  virus-slash: ""
+  viruses: ""
   voicemail: ""
   volleyball-ball: ""
   volume-down: ""

data/examples/fontawesome.rb

@@ -11,8 +11,9 @@ STYLES = {
 
 STYLES.each do |specifier, type|
   Prawn::Document.generate("fontawesome_#{type.downcase}.pdf") do
-    deja_path = File.join \
-      Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
+    deja_path = Prawn::Icon.configuration.font_directory
+      .join('DejaVuSans.ttf')
+      .to_s
 
     font_families.update(
       'deja' => { normal: deja_path }

data/examples/foundation_icons.rb

@@ -4,8 +4,9 @@ require_relative '../lib/prawn/icon'
 require_relative 'example_helper'
 
 Prawn::Document.generate('foundation_icons.pdf') do
-  deja_path = File.join \
-    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
+  deja_path = Prawn::Icon.configuration.font_directory
+    .join('DejaVuSans.ttf')
+    .to_s
 
   font_families.update({
     'deja' => { normal: deja_path }

data/examples/paymentfont.rb

@@ -4,8 +4,9 @@ require_relative '../lib/prawn/icon'
 require_relative 'example_helper'
 
 Prawn::Document.generate('paymentfont.pdf') do
-  deja_path = File.join \
-    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
+  deja_path = Prawn::Icon.configuration.font_directory
+    .join('DejaVuSans.ttf')
+    .to_s
 
   font_families.update({
     'deja' => { normal: deja_path }

data/lib/prawn/icon.rb

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

data/lib/prawn/icon/base.rb

@@ -11,9 +11,21 @@ require_relative 'errors'
 
 module Prawn
   class Icon
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+
     module Base
-      FONTDIR = File.join \
-        File.expand_path('../../../..', __FILE__), 'data/fonts'
+      # @deprecated Use {Prawn::Icon.configuration.font_directory} instead
+      FONTDIR = Prawn::Icon.configuration.font_directory.to_s
     end
   end
 end

data/lib/prawn/icon/compatibility.rb

@@ -9,14 +9,22 @@
 module Prawn
   class Icon
     class Compatibility
+      # @deprecated Use {Prawn::Icon::Compatibility.shims} instead
       SHIMS = YAML.load_file(
-        File.join(
-          Base::FONTDIR,
+        Prawn::Icon.configuration.font_directory.join(
           'fa4',
           'shims.yml'
         )
       ).freeze
 
+      class << self
+        def shims
+          @shims ||= YAML.load_file(
+            Icon.configuration.font_directory.join('fa4', 'shims.yml').to_s
+          )
+        end
+      end
+
       attr_accessor :key
 
       def initialize(opts = {})
@@ -36,7 +44,7 @@ module Prawn
       private
 
       def map
-        SHIMS.fetch(key) do
+        self.class.shims.fetch(key) do
           # FontAwesome shim metadata assumes "fas" as the default
           # font family if not explicity referenced.
           "fas-#{key.sub(/fa-/, '')}"
@@ -48,7 +56,7 @@ module Prawn
 [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.
+  This compatibility layer will be removed in Prawn::Icon 4.0.0.
 DEPRECATION
       end
     end

data/lib/prawn/icon/configuration.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# configuration.rb: Prawn icon configuration.
+#
+# Copyright October 2020, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Icon
+    class Configuration
+      def font_directory=(path)
+        @font_directory = Pathname.new(path)
+      end
+
+      def font_directory
+        @font_directory ||= default_font_directory
+      end
+
+      private
+
+      def default_font_directory
+        Pathname.new(gem_path).join('data', 'fonts')
+      end
+
+      # :nocov:
+      def gem_path
+        spec = Gem.loaded_specs.fetch('prawn-icon') do
+          Struct.new(:full_gem_path).new(failsafe_gem_path)
+        end
+        spec.full_gem_path
+      end
+
+      def failsafe_gem_path
+        File.expand_path('../../../..', __FILE__)
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/prawn/icon/font_data.rb

@@ -63,15 +63,17 @@ module Prawn
       end
 
       def path
-        ttf  = File.join(Icon::Base::FONTDIR, @set.to_s, '*.ttf')
-        font = Dir[ttf].first
+        font = Icon.configuration.font_directory
+          .join(@set.to_s)
+          .glob('*.ttf')
+          .first
 
         if font.nil?
           raise Prawn::Errors::UnknownFont,
                 "Icon font not found for set: #{@set}"
         end
 
-        @path ||= font
+        @path ||= font.to_s
       end
 
       def specifier

data/lib/prawn/icon/interface.rb

@@ -19,7 +19,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::Base::FONTDIR/font/font.yml.
+  # located in {Prawn::Icon.configuration.font_directory}/font/font.yml.
   #
   # Prawn::Icon::
   #   Houses the methods and interfaces necessary for
@@ -38,6 +38,7 @@ module Prawn
   #   to Prawn's internal formatted text parser.
   #
   class Icon
+    # @deprecated Use {Prawn::Icon.configuration.font_directory} instead
     FONTDIR = Icon::Base::FONTDIR
 
     module Interface
@@ -63,11 +64,10 @@ module Prawn
       #
       def icon(key, opts = {})
         key = translate_key(key)
-        make_icon(key, opts).tap(&:render)
+        make_icon(key, opts).tap { |i| i && i.render }
       end
 
-      # Initialize a new icon object, but do
-      # not render it to the document.
+      # Initialize a new icon object.
       #
       # == Parameters:
       # key::
@@ -90,9 +90,9 @@ module Prawn
         end
       end
 
-      # Initialize a new formatted text box containing
-      # icon information, but don't render it to the
-      # document.
+      # Render formatted icon content to the document from
+      # a string containing icons. Content will correctly
+      # transition to a new page when necessary.
       #
       # == Parameters:
       # text::
@@ -107,10 +107,37 @@ module Prawn
       def inline_icon(text, opts = {})
         parsed = Icon::Parser.format(self, text)
         content = Text::Formatted::Parser.format(parsed)
+        formatted_text(content, opts)
+      end
+
+      # Initialize a formatted icon box from an icon-conatining
+      # string. Content is not directly rendered to the document,
+      # instead a +Prawn::Text::Formatted::Box+ instance is returned
+      # that responds to the +render+ method.
+      #
+      # == Parameters:
+      # text::
+      #   Input text to be parsed initially for <icon>
+      #   tags, then passed to Prawn's formatted text
+      #   parser.
+      #
+      # opts::
+      #   A hash of options that may be supplied to the
+      #   underlying text call.
+      #
+      def formatted_icon_box(text, opts = {})
+        parsed = Icon::Parser.format(self, text)
+        content = Text::Formatted::Parser.format(parsed)
+        position = opts.fetch(:at) do
+          [
+            opts.fetch(:x) { bounds.left },
+            opts.fetch(:y) { cursor }
+          ]
+        end
         box_options = opts.merge(
           inline_format: true,
           document: self,
-          at: [bounds.left, cursor]
+          at: position
         )
         icon_box(content, box_options)
       end

data/lib/prawn/icon/version.rb

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

data/spec/integration/icon_spec.rb

@@ -47,20 +47,28 @@ describe Prawn::Icon::Interface do
           pdf.move_down 10
           pdf.text 'More'
           pdf.move_down 20
-          icon = pdf.icon icon_text, inline_format: true
+          pdf.icon icon_text, inline_format: true
           pdf.move_down 30
           pdf.text 'End'
+          inspector = PDF::Inspector::Text.analyze(pdf.render)
+          x, y = inspector.positions[2]
 
-          expect(icon.at.first).to eq(0)
-          expect(icon.at.last.round).to eq(734)
+          expect(x).to eq(0)
+          expect(y.round).to eq(724)
         end
 
         context 'with final_gap: false' do
           it 'renders the icon without a final gap' do
-            icon = pdf.icon '<icon size="60">far-address-book</icon>',
+            pdf.icon(
+              '<icon size="60">far-address-book</icon>',
               inline_format: true,
               final_gap: false
-            expect(icon.at.last.round).to eq(792)
+            )
+            pdf.text('Hello')
+            inspector = PDF::Inspector::Text.analyze(pdf.render)
+            y = inspector.positions[1].last.round
+
+            expect(y).to eq(723)
           end
         end
       end
@@ -102,19 +110,63 @@ describe Prawn::Icon::Interface do
     end
 
     context ':inline_format => true' do
-      it 'should return a Prawn::::Text::Formatted::Box instance' do
+      it 'returns nil' do
         icon = pdf.make_icon '<icon>far-address-book</icon>', inline_format: true
 
-        expect(icon).to be_a(Prawn::Text::Formatted::Box)
+        expect(icon).to be_nil
       end
     end
   end
 
   describe '::inline_icon' do
-    it 'should return a Prawn::Text::Formatted::Box instance' do
+    it 'returns nil' do
       icon = pdf.inline_icon '<icon>far-address-book</icon>'
 
-      expect(icon).to be_a(Prawn::Text::Formatted::Box)
+      expect(icon).to be_nil
+    end
+
+    it 'starts a new page if necessary', github_issue: '49' do
+      text = 209.times.map { 'Hello, World!' }.join(' ')
+      pdf.text(text, size: 18)
+      pdf.icon('Hello, <icon>fas-globe</icon>', inline_format: true, size: 18)
+      inspector = PDF::Inspector::Page.analyze(pdf.render)
+
+      expect(inspector.pages.size).to eq(2)
+    end
+  end
+
+  describe '::formatted_icon_box' do
+    it 'returns a Prawn::Text::Formatted::Box instance' do
+      icon_text = <<~CONTENT
+        <icon size="20">fas-broom</icon>
+        <strikethrough>cancel that</strikethrough>
+        <icon>fas-check</icon>
+      CONTENT
+      box = pdf.formatted_icon_box(icon_text, inline_format: true)
+
+      expect(box).to be_a(Prawn::Text::Formatted::Box)
+    end
+
+    it 'accepts an absolute position parameter' do
+      icon_text = 'Hello, <icon>fas-globe</icon>!'
+      pdf.formatted_icon_box(icon_text, inline_format: true, x: 200, y: 100).render
+      inspector = PDF::Inspector::Text.analyze(pdf.render)
+      x, y = inspector.positions[0]
+
+      expect(x).to eq(200)
+      expect(y.round).to eq(90)
+    end
+
+    it 'handles final_gap: false correctly' do
+      icon_text = <<~CONTENT
+        Hello, <icon size="60">fas-globe</icon>
+        Next line.
+      CONTENT
+      pdf.formatted_icon_box(icon_text, inline_format: true, final_gap: false).render
+      inspector = PDF::Inspector::Text.analyze(pdf.render)
+      x = inspector.positions[1].first
+
+      expect(x.round).to eq(34)
     end
   end
 

data/spec/unit/base_spec.rb

@@ -4,12 +4,31 @@
 #
 # 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)
+describe Prawn::Icon do
+  describe '#configuration' do
+    it 'returns an instance of Prawn::Icon::Configuration' do
+      expect(described_class.configuration).to be_a(Prawn::Icon::Configuration)
+    end
+  end
+
+  describe '#configure' do
+    around(:each) do |example|
+      old = described_class.configuration.dup
+      described_class.configure do |config|
+        config.font_directory = '/tmp/fonts'
+      end
+      example.run
+      described_class.configuration = old
+    end
+
+    it 'yields control' do
+      expect { |b| described_class.configure(&b) }.to yield_control
+    end
+
+    it 'configures properties' do
+      expect(described_class.configuration.font_directory).to eq(
+        Pathname.new('/tmp/fonts')
+      )
     end
   end
 end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+# Copyright October 2020, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+describe Prawn::Icon::Configuration do
+  describe '#font_directory' do
+    before(:each) do
+      subject.font_directory = '/tmp/fakedir'
+    end
+
+    it 'returns a Pathname' do
+      expect(subject.font_directory).to be_a(Pathname)
+    end
+
+    it 'returns the configured path' do
+      expect(subject.font_directory.to_s).to eq('/tmp/fakedir') 
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jesse Doyle
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -158,6 +158,7 @@ files:
 - lib/prawn/icon.rb
 - lib/prawn/icon/base.rb
 - lib/prawn/icon/compatibility.rb
+- lib/prawn/icon/configuration.rb
 - lib/prawn/icon/errors.rb
 - lib/prawn/icon/font_data.rb
 - lib/prawn/icon/interface.rb
@@ -170,6 +171,7 @@ files:
 - spec/support/pdf_helper.rb
 - spec/unit/base_spec.rb
 - spec/unit/compatibility_spec.rb
+- spec/unit/configuration_spec.rb
 - spec/unit/errors/icon_key_empty_spec.rb
 - spec/unit/errors/icon_not_found_spec.rb
 - spec/unit/font_data_spec.rb
@@ -181,7 +183,7 @@ licenses:
 - GPL-2
 - GPL-3
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,9 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF
 test_files: []