prawn-icon 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4afdc4554a8b808e2c8f6e9d1671613065866172
-  data.tar.gz: 9f543c9a1a41a6a4daa5a991e5b78bc65551d018
+  metadata.gz: 848e11a6ff5beade9d3e3f05d22adca7787893ae
+  data.tar.gz: 8ef5be3f116c32da92c8ab8cbb32ae2a2fa8a919
 SHA512:
-  metadata.gz: 94d7961757cf3b1efc79b6cfed0dbf14d9aede80fce4fb8e8e1cc584bd1cacfd4c9d337e62b4cd7d22712898dbfcfa101e1591f98e8c8e8f707894e338da59b0
-  data.tar.gz: 37de952a3ee296ec162b0aaa2b9414abe46812a8fdf1b18a1679ed3ec3d1fa1a8ece222224d96b0d5b01ff45636e256b040efec269e14a516474a0a656bff886
+  metadata.gz: c7efb8ff4d1b3ce84d0e4063c6d8ca88d8ee24b45d7785a82849889f859650a7b0e5d647834ace3aaf4b40d07e5966bed78677a98c75c187b1092711305afaf3
+  data.tar.gz: 96783b319a46bf55141e49762333aac2ea57581a81387ca775762a35ec5e5d6b9fd599c305ce607a396ea44563756aa1c646a6e49349cf3115b93e4e722ee6c1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.7.0 - July 23, 2015
+
+- Update Travis config to relax the versions of `Prawn` and `Ruby` that are tested against. See `.travis.yml` to see what versions are supported (though you shouldn't have issues with other versions).
+- Implement inline_format for table icons. [#14](https://github.com/jessedoyle/prawn-icon/pull/14).
+- Updated Octicons to v2.4.1. See [changelog](https://github.com/github/octicons/releases/) between versions 2.1.2 and 2.4.1.
+
 # 0.6.4 - May 4, 2015
 
 - [PaymentFont](http://paymentfont.io) is now supported and included in `Prawn::Icon`.

data/fonts/octicon/octicon.yml

@@ -1,5 +1,5 @@
 octicon:
-  __font_version__: '2.1.2'
+  __font_version__: '2.4.1'
   alert: "\uf02d"
   alignment-align: "\uf08a"
   alignment-aligned-to: "\uf08e"
@@ -192,6 +192,8 @@ octicon:
   telescope: "\uf088"
   terminal: "\uf0c8"
   three-bars: "\uf05e"
+  thumbsdown: "\uf0db"
+  thumbsup: "\uf0da"
   tools: "\uf031"
   trashcan: "\uf0d0"
   triangle-down: "\uf05b"

data/lib/prawn/icon.rb

@@ -23,7 +23,8 @@ module Prawn
 
   # Easy icon font usage within Prawn. Currently
   # supported icon fonts include: FontAwesome,
-  # Zurb Foundicons, and GitHub Octicons.
+  # Zurb Foundicons, GitHub Octicons, as well as
+  # PaymentFont.
   #
   # = Icon Keys
   #
@@ -134,20 +135,23 @@ module Prawn
       # == Parameters:
       # key::
       #   Contains the key to a particular icon within
-      #   a font family. Note that :inline_format is not
-      #   supported as a valid option.
+      #   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. Note that :inline_format
-      #   is not supported as a valid option.
+      #   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' }
+      #   eg. { font: 'fa', content: '\uf047' }
+      #
+      #   Note that the +font+ key will not be set
+      #   if +inline_format: true+.
       #
       # == Examples:
       #   require 'prawn/table'
@@ -161,13 +165,12 @@ module Prawn
       #   pdf.table(data) => (2 x 2 table)
       #
       def table_icon(key, opts = {})
-        if opts.delete(:inline_format)
-          raise Prawn::Errors::UnknownOption,
-                'Inline formatting is not supported.'
+        if opts[:inline_format]
+          content = Icon::Parser.format(self, key)
+          opts.merge(content: content)
+        else
+          make_icon(key, opts).format_hash
         end
-
-        icon = make_icon(key, opts)
-        icon.format_hash
       end
     end
 
@@ -199,7 +202,7 @@ module Prawn
 
     private
 
-    def strip_specifier_from_key(key)
+    def strip_specifier_from_key(key) #:nodoc:
       reg = Regexp.new "#{@data.specifier}-"
       key.sub(reg, '') # Only one specifier
     end

data/lib/prawn/icon/version.rb

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

data/spec/integration/icon_spec.rb

@@ -102,20 +102,49 @@ describe Prawn::Icon::Interface do
   end
 
   describe '::table_icon' do
-    it 'should return a hash with font and content keys' do
-      pdf = create_pdf
-      icon = pdf.table_icon 'fa-arrows'
+    context 'inline_format: false (default)' do
+      it 'should return a hash with font and content keys' do
+        pdf = create_pdf
+        icon = pdf.table_icon 'fa-arrows'
 
-      expect(icon.class).to eq(Hash)
-      expect(icon[:font]).to eq('fa')
-      expect(icon[:content]).to eq("\uf047")
+        expect(icon.class).to eq(Hash)
+        expect(icon[:font]).to eq('fa')
+        expect(icon[:content]).to eq("\uf047")
+      end
     end
 
-    it 'should raise an error if inline_format: true' do
-      pdf = create_pdf
-      proc = Proc.new { pdf.table_icon 'fa-arrows', inline_format: true }
+    context 'inline_format: true' do
+      it 'should convert <icon> to <font> tags' do
+        pdf = create_pdf
+        icon = pdf.table_icon '<icon>fa-user</icon>', inline_format: true
+
+        expect(icon.class).to eq(Hash)
+        expect(icon[:content]).to eq('<font name="fa"></font>')
+        expect(icon[:inline_format]).to be_true
+      end
 
-      expect(proc).to raise_error(Prawn::Errors::UnknownOption)
+      it 'should ignore all other tags' do
+        pdf = create_pdf
+        a = ['<b>BOLD</b> <color rgb="0099FF">BLUE</color>', inline_format: true]
+        icon = pdf.table_icon(*a)
+
+        expect(icon.class).to eq(Hash)
+        expect(icon[:content]).to eq(a[0])
+        expect(icon[:inline_format]).to be_true
+      end
+
+      context 'multiple icons' do
+        it 'should ignore any text not in an icon tag' do
+          pdf = create_pdf
+          a = ['<icon>fa-user</icon> Some Text <icon>fi-laptop</icon>', inline_format: true]
+          out = '<font name="fa"></font> Some Text <font name="fi"></font>'
+          icon = pdf.table_icon(*a)
+
+          expect(icon.class).to eq(Hash)
+          expect(icon[:content]).to eq(out)
+          expect(icon[:inline_format]).to be_true
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -138,46 +138,46 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- COPYING
-- GPLv2
-- GPLv3
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- examples/example_helper.rb
-- examples/fa-beer-inline.png
-- examples/fa-beer.png
-- examples/fontawesome.rb
-- examples/foundation_icons.rb
-- examples/octicons.rb
-- examples/paymentfont.rb
+- lib/prawn/icon/font_data.rb
+- lib/prawn/icon/parser.rb
+- lib/prawn/icon/version.rb
+- lib/prawn/icon.rb
+- spec/integration/icon_spec.rb
+- spec/spec_helper.rb
+- spec/support/parser_helper.rb
+- spec/support/pdf_helper.rb
+- spec/unit/font_data_spec.rb
+- spec/unit/icon_spec.rb
+- spec/unit/parser_spec.rb
 - fonts/DejaVuSans.ttf
-- fonts/fa/LICENSE
 - fonts/fa/fa.yml
 - fonts/fa/fontawesome.ttf
-- fonts/fi/LICENSE
+- fonts/fa/LICENSE
 - fonts/fi/fi.yml
 - fonts/fi/foundation-icons.ttf
+- fonts/fi/LICENSE
 - fonts/octicon/LICENSE
 - fonts/octicon/octicon.yml
 - fonts/octicon/octicons.ttf
 - fonts/pf/LICENSE
 - fonts/pf/paymentfont-webfont.ttf
 - fonts/pf/pf.yml
-- lib/prawn/icon.rb
-- lib/prawn/icon/font_data.rb
-- lib/prawn/icon/parser.rb
-- lib/prawn/icon/version.rb
+- examples/example_helper.rb
+- examples/fa-beer-inline.png
+- examples/fa-beer.png
+- examples/fontawesome.rb
+- examples/foundation_icons.rb
+- examples/octicons.rb
+- examples/paymentfont.rb
 - prawn-icon.gemspec
-- spec/integration/icon_spec.rb
-- spec/spec_helper.rb
-- spec/support/parser_helper.rb
-- spec/support/pdf_helper.rb
-- spec/unit/font_data_spec.rb
-- spec/unit/icon_spec.rb
-- spec/unit/parser_spec.rb
+- Gemfile
+- Rakefile
+- README.md
+- CHANGELOG.md
+- COPYING
+- LICENSE
+- GPLv2
+- GPLv3
 homepage: https://github.com/jessedoyle/prawn-icon/
 licenses:
 - RUBY
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF