prawn-icon 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a8ac902ada7341c7635d8513cb1cbb766194d7d
-  data.tar.gz: 8bf0c5b69bdedc4a80c37f5fe7ad7eb9c115e0dc
+  metadata.gz: f598dd2d932646dceab0f8a70f8dd763b5786e9d
+  data.tar.gz: 5f424295e1d8defd4414da7e439fd3cc8da7d570
 SHA512:
-  metadata.gz: 9437bae0f1990156ab41f016b169055162869923c0b6a3a2cca5baac61b8d5b64da32a8d860b0d5629ce93cb164e6690ec4f8f4b62bfb7cdd1fab1568c20c1ad
-  data.tar.gz: dc9433a07cd4c864d78cccfe3be8461a20629286e18b5d812242291e85bd85951b796d0d81d06471bf5da820515dd8f9bbe073e746c14c95deccf0202fa59516
+  metadata.gz: 2943e05b79c2ca885e5a43dc3a65d8f3762502129025f536f25acad77570da60f8307c4bbfef2031df1c146b16600264b04e026516b65ca27e877c0d01313b2b
+  data.tar.gz: 957abf7f70693da0ffc0578ab5b2d42dd19dad1c7deee28e7d3139c7d55d4474f75ba28571c02fd93a0cb8eff29daa1b7e13f8a5dc10b3b6de0e6b85a8483704

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.3.0 - Oct 15, 2016
+
+- Update rubocop developement dependency (to `0.44.1`).
+- Add `simplecov` as a development dependency and require 100% coverage.
+- Break out `Prawn::Icon::Interface` into its own file. This resolves issue [#27](https://github.com/jessedoyle/prawn-icon/issues/27).
+
 # 1.2.0 - Sept 12, 2016
 
 - Update FontAwesome from v4.5.0 to v4.6.3. See [changelog](http://fontawesome.io/icons#new).

data/lib/prawn/icon.rb

@@ -9,207 +9,6 @@
 require_relative 'icon/base'
 require_relative 'icon/font_data'
 require_relative 'icon/parser'
-
-module Prawn
-  # 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::Base::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 = Icon::Base::FONTDIR
-
-    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 = {})
-        make_icon(key, opts).tap(&:render)
-      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)
-        box_options = opts.merge(
-          inline_format: true,
-          document: self,
-          at: [bounds.left, cursor]
-        )
-        icon_box(content, box_options)
-      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
-
-      private
-
-      def icon_box(content, opts = {}) # :nodoc:
-        Text::Formatted::Box.new(content, opts).tap do |box|
-          box.render(dry_run: true)
-          self.y -= box.height
-          unless opts.fetch(:final_gap, true)
-            self.y -= box.line_gap + box.leading
-          end
-        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

data/lib/prawn/icon/interface.rb

@@ -0,0 +1,209 @@
+# encoding: utf-8
+#
+# interface.rb: Prawn extension module and logic.
+#
+# Copyright October 2016, Jesse Doyle. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  # 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::Base::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 = Icon::Base::FONTDIR
+
+    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 = {})
+        make_icon(key, opts).tap(&:render)
+      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)
+        box_options = opts.merge(
+          inline_format: true,
+          document: self,
+          at: [bounds.left, cursor]
+        )
+        icon_box(content, box_options)
+      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
+
+      private
+
+      def icon_box(content, opts = {}) # :nodoc:
+        Text::Formatted::Box.new(content, opts).tap do |box|
+          box.render(dry_run: true)
+          self.y -= box.height
+          unless opts.fetch(:final_gap, true)
+            self.y -= box.line_gap + box.leading
+          end
+        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

data/lib/prawn/icon/version.rb

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

data/prawn-icon.gemspec

@@ -1,6 +1,7 @@
 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
@@ -26,9 +27,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency('pdf-inspector', '~> 1.2.1')
   spec.add_development_dependency('rspec', '~> 3.5.0')
-  spec.add_development_dependency('rubocop', '~> 0.38.0')
+  spec.add_development_dependency('rubocop', '~> 0.44.1')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('pdf-reader', '~> 1.4')
+  spec.add_development_dependency('simplecov', '~> 0.12')
 
   spec.description = <<-END_DESC
   Prawn::Icon provides various icon fonts including

data/spec/spec_helper.rb

@@ -3,6 +3,10 @@
 # Copyright October 2014, Jesse Doyle. All rights reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
+#
+#
+require 'simplecov'
+SimpleCov.start
 
 require "bundler"
 Bundler.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.44.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: |2
     Prawn::Icon provides various icon fonts including
     FontAwesome, Foundation Icons and GitHub Octicons
@@ -142,6 +156,7 @@ files:
 - lib/prawn/icon/base.rb
 - lib/prawn/icon/errors.rb
 - lib/prawn/icon/font_data.rb
+- lib/prawn/icon/interface.rb
 - lib/prawn/icon/parser.rb
 - lib/prawn/icon/version.rb
 - prawn-icon.gemspec