Sha256: 789c85d11d235af805f75bce2ee248b9daad46a50b6c1c4f62319f8344218dae

Contents?: true

Size: 1.31 KB

Versions: 4

Compression:

Stored size: 1.31 KB

Contents

# 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

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
prawn-icon-2.5.0 lib/prawn/icon/compatibility.rb
prawn-icon-2.4.0 lib/prawn/icon/compatibility.rb
prawn-icon-2.3.0 lib/prawn/icon/compatibility.rb
prawn-icon-2.2.0 lib/prawn/icon/compatibility.rb