prawn-icon 1.0.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::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/examples/foundation_icons.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('foundation_icons.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/examples/paymentfont.rb

@@ -5,7 +5,7 @@ require_relative 'example_helper'
 
 Prawn::Document.generate('paymentfont.pdf') do
   deja_path = File.join \
-    Prawn::Icon::FONTDIR, 'DejaVuSans.ttf'
+    Prawn::Icon::Base::FONTDIR, 'DejaVuSans.ttf'
 
   font_families.update({
     'deja' => { normal: deja_path }

data/lib/prawn/icon.rb

@@ -6,207 +6,10 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn'
+require_relative 'icon/version'
+require_relative 'icon/base'
 require_relative 'icon/font_data'
 require_relative 'icon/parser'
-
-module Prawn
-  module Errors
-    # Error raised when an icon glyph is not found
-    #
-    IconNotFound = Class.new(StandardError)
-
-    # Error raised when an icon key is not provided
-    #
-    IconKeyEmpty = Class.new(StandardError)
-  end
-
-  # Easy icon font usage within Prawn. Currently
-  # supported icon fonts include: FontAwesome,
-  # Zurb Foundicons, GitHub Octicons, as well as
-  # PaymentFont.
-  #
-  # = Icon Keys
-  #
-  # Icon keys must be supplied to most +Prawn::Icon+
-  # methods. Keys map directly to a unicode character
-  # within the font that produces a given icon. As a
-  # 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::FONTDIR/font/font.yml.
-  #
-  # Prawn::Icon::
-  #   Houses the methods and interfaces necessary for
-  #   rendering icons to the Prawn::Document.
-  #
-  # Prawn::Icon::FontData::
-  #   Used to store various information about an icon font,
-  #   including the key-to-unicode mapping information.
-  #   Also houses methods to cache and lazily load the
-  #   requested font data on a document basis.
-  #
-  # Prawn::Icon::Parser::
-  #   Used to initially parse icons that are used with the
-  #   inline_format: true option. The input string is parsed
-  #   once for <icon></icon> tags, then the output is provided
-  #   to Prawn's internal formatted text parser.
-  #
-  class Icon
-    FONTDIR = File.join \
-      File.expand_path('../../..', __FILE__), 'data/fonts'
-
-    module Interface
-      # Set up and draw an icon on this document. This
-      # method operates much like +Prawn::Text::Box+.
-      #
-      # == Parameters:
-      # key::
-      #   Contains the key to a particular icon within
-      #   a font family. If :inline_format is true,
-      #   then key may contain formatted text marked
-      #   with <icon></icon> tags and any tag supported
-      #   by Prawn's parser.
-      #
-      # opts::
-      #   A hash of options that may be supplied to
-      #   the underlying +text+ method call.
-      #
-      # == Examples:
-      #   pdf.icon 'fa-beer'
-      #   pdf.icon '<icon color="0099FF">fa-arrows</icon>',
-      #   inline_format: true
-      #
-      def icon(key, opts = {})
-        i = make_icon(key, opts)
-        i.render
-        i
-      end
-
-      # Initialize a new icon object, but do
-      # not render it to the document.
-      #
-      # == Parameters:
-      # key::
-      #   Contains the key to a particular icon within
-      #   a font family. If :inline_format is true,
-      #   then key may contain formatted text marked
-      #   with <icon></icon> tags and any tag supported
-      #   by Prawn's parser.
-      #
-      # opts::
-      #   A hash of options that may be supplied to
-      #   the underlying text method call.
-      #
-      def make_icon(key, opts = {})
-        if opts[:inline_format]
-          inline_icon(key, opts)
-        else
-          Icon.new(key, self, opts)
-        end
-      end
-
-      # Initialize a new formatted text box containing
-      # icon information, but don't render it to the
-      # document.
-      #
-      # == 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 inline_icon(text, opts = {})
-        parsed    = Icon::Parser.format(self, text)
-        content   = Text::Formatted::Parser.format(parsed)
-        opts.merge!(inline_format: true, document: self)
-        Text::Formatted::Box.new(content, opts)
-      end
-
-      # Initialize a new Prawn::Icon, but don't render
-      # the icon to a document. Intended to be used as
-      # an entry of a data array when combined with
-      # Prawn::Table.
-      #
-      # == Parameters:
-      # key::
-      #   Contains the key to a particular icon within
-      #   a font family. The key may contain a string
-      #   with format tags if +inline_format: true+ in
-      #   the +opts+ hash.
-      #
-      # opts::
-      #   A hash of options that may be supplied to the
-      #   underlying text call.
-      #
-      # == Returns:
-      #   A Hash containing +font+ and +content+ keys
-      #   that match the data necessary for the
-      #   specified icon.
-      #
-      #   eg. { font: 'fa', content: '\uf047' }
-      #
-      #   Note that the +font+ key will not be set
-      #   if +inline_format: true+.
-      #
-      # == Examples:
-      #   require 'prawn/table'
-      #
-      #   data = [
-      #     # Explicit brackets must be used here
-      #     [pdf.table_icon('fa-arrows'), 'Cell 1'],
-      #     ['Cell 2', 'Cell 3']
-      #   ]
-      #
-      #   pdf.table(data) => (2 x 2 table)
-      #
-      def table_icon(key, opts = {})
-        if opts[:inline_format]
-          content = Icon::Parser.format(self, key)
-          opts.merge(content: content)
-        else
-          make_icon(key, opts).format_hash
-        end
-      end
-    end
-
-    attr_reader :set, :unicode
-
-    def initialize(key, document, opts = {})
-      @pdf     = document
-      @set     = opts[:set] ||
-                 FontData.specifier_from_key(key)
-      @data    = FontData.load(document, @set)
-      @key     = strip_specifier_from_key(key)
-      @unicode = @data.unicode(@key)
-      @options = opts
-    end
-
-    def format_hash
-      base = { font: @set.to_s, content: @unicode }
-      opts = @options.dup
-      # Prawn::Table renames :color to :text_color
-      opts[:text_color] = opts.delete(:color)
-      base.merge(opts)
-    end
-
-    def render
-      @pdf.font(@data.path) do
-        @pdf.text @unicode, @options
-      end
-    end
-
-    private
-
-    def strip_specifier_from_key(key) #:nodoc:
-      reg = Regexp.new "#{@data.specifier}-"
-      key.sub(reg, '') # Only one specifier
-    end
-  end
-end
+require_relative 'icon/interface'
 
 Prawn::Document.extensions << Prawn::Icon::Interface