prawn-icon 1.0.0 → 2.0.0

data/spec/unit/icon_spec.rb

@@ -7,26 +7,26 @@
 require 'spec_helper'
 
 describe Prawn::Icon do
+  let(:errors) { described_class::Errors }
+  let(:pdf) { create_pdf }
+
   describe '#initialize' do
     context 'valid icon family specifier' do
       it 'should be capable of creating icon instances' do
-        pdf = create_pdf
-        icon = Prawn::Icon.new 'fa-arrows', pdf
+        icon = Prawn::Icon.new 'far-address-book', pdf
 
-        expect(icon.unicode).to eq("\uf047")
+        expect(icon.unicode).to eq('')
       end
 
       it 'should raise an error if icon key is not found' do
-        pdf = create_pdf
-        proc = Proc.new { Prawn::Icon.new 'fa-__INVALID__', pdf }
+        proc = Proc.new { Prawn::Icon.new 'far-__INVALID__', pdf }
 
-        expect(proc).to raise_error(Prawn::Errors::IconNotFound)
+        expect(proc).to raise_error(errors::IconNotFound)
       end
     end
 
     context 'invalid icon specifier' do
       it 'should raise an error' do
-        pdf = create_pdf
         proc = Proc.new { pdf.icon '__INVALID__  some text' }
 
         expect(proc).to raise_error(Prawn::Errors::UnknownFont)
@@ -35,7 +35,7 @@ describe Prawn::Icon do
 
     context 'without a pdf object' do
       it 'should raise an ArgumentError' do
-        proc = Proc.new { Prawn::Icon.new('fa-arrows') }
+        proc = Proc.new { Prawn::Icon.new('far-address-book') }
 
         expect(proc).to raise_error(ArgumentError)
       end
@@ -44,17 +44,15 @@ describe Prawn::Icon do
 
   describe '#format_hash' do
     it 'should add :font and :content keys' do
-      pdf = create_pdf
-      icon = Prawn::Icon.new 'fa-arrows', pdf
+      icon = Prawn::Icon.new 'far-address-book', pdf
       hash = icon.format_hash
 
-      expect(hash[:font]).to eq('fa')
-      expect(hash[:content]).to eq("\uf047")
+      expect(hash[:font]).to eq('far')
+      expect(hash[:content]).to eq('')
     end
 
     it 'should rename key :color to :text_color' do
-      pdf = create_pdf
-      icon = Prawn::Icon.new 'fa-arrows', pdf, color: '0099ff'
+      icon = Prawn::Icon.new 'far-address-book', pdf, color: '0099ff'
       hash = icon.format_hash
 
       expect(hash[:color]).to be_nil
@@ -64,8 +62,7 @@ describe Prawn::Icon do
 
   describe '#render' do
     it 'should render an icon to the page' do
-      pdf = create_pdf
-      pdf.icon('fa-arrows').render
+      pdf.icon('far-address-book').render
       text = PDF::Inspector::Text.analyze(pdf.render)
 
       expect(text.font_settings.first[:name]).to match(/FontAwesome/)
@@ -75,16 +72,14 @@ describe Prawn::Icon do
   describe '#set' do
     context 'with dashes in key' do
       it 'should return the set as a symbol from key' do
-        pdf = create_pdf
-        set = Prawn::Icon.new('fa-arrows', pdf).set
+        set = Prawn::Icon.new('far-address-book', pdf).set
 
-        expect(set).to eq(:fa)
+        expect(set).to eq(:far)
       end
     end
 
     context 'without dashes in key' do
       it 'raise an error about invalid keys' do
-        pdf = create_pdf
         proc = Proc.new { Prawn::Icon.new 'some invalid key', pdf }
 
         expect(proc).to raise_error(Prawn::Errors::UnknownFont)
@@ -95,20 +90,18 @@ describe Prawn::Icon do
   describe '#unicode' do
     context 'valid icon key' do
       it 'should return a unicode character' do
-        pdf = create_pdf
-        icon = Prawn::Icon.new 'fa-arrows', pdf
+        icon = Prawn::Icon.new 'far-address-book', pdf
 
-        expect(valid_unicode?(icon.unicode)).to be_true
+        expect(valid_unicode?(icon.unicode)).to be true
       end
     end
 
     context 'invalid icon key' do
       it 'should raise IconNotFound' do
-        pdf = create_pdf
-        proc = Proc.new { Prawn::Icon.new 'fa-__INVALID__', pdf }
+        proc = Proc.new { Prawn::Icon.new 'far-__INVALID__', pdf }
 
-        expect(proc).to raise_error(Prawn::Errors::IconNotFound)
+        expect(proc).to raise_error(errors::IconNotFound)
       end
     end
   end
-end
+end

data/spec/unit/parser_spec.rb

@@ -7,23 +7,23 @@
 require 'spec_helper'
 
 describe Prawn::Icon::Parser do
+  let(:pdf) { create_pdf }
+
   describe '::format' do
     it 'should return a raw prawn-formatted string on valid input' do
-      string = '<icon>fa-arrows</icon>'
-      pdf = create_pdf
+      string = '<icon>far-address-book</icon>'
       formatted = Prawn::Icon::Parser.format(pdf, string)
-      match = "<font name=\"fa\"></font>"
+      match = '<font name="far"></font>'
 
       expect(formatted).to eq(match)
     end
 
     it 'should return unchanged if no icon tags are found' do
       string = <<-EOS
-      <link href="#">test</link>
+      <link href='#'>test</link>
       Here's some sample text.
       <i>more text</i>
       EOS
-      pdf = create_pdf
       formatted = Prawn::Icon::Parser.format(pdf, string)
 
       expect(formatted).to eq(string)
@@ -31,7 +31,6 @@ describe Prawn::Icon::Parser do
 
     it 'should return the empty string if given the empty string' do
       string = ''
-      pdf = create_pdf
       formatted = Prawn::Icon::Parser.format(pdf, string)
 
       expect(formatted).to be_empty
@@ -39,24 +38,22 @@ describe Prawn::Icon::Parser do
 
     it 'should raise an error when an icon key is invalid' do
       string = '<icon>an invalid key</icon>'
-      pdf = create_pdf
       proc = Proc.new { Prawn::Icon::Parser.format(pdf, string) }
 
       expect(proc).to raise_error(Prawn::Errors::UnknownFont)
     end
 
     it 'should raise an error when an icon is not found for valid set' do
-      string = '<icon>fa-__INVALID__</icon>'
-      pdf = create_pdf
+      string = '<icon>far-__INVALID__</icon>'
       proc = Proc.new { Prawn::Icon::Parser.format(pdf, string) }
 
-      expect(proc).to raise_error(Prawn::Errors::IconNotFound)
+      expect(proc).to raise_error(Prawn::Icon::Errors::IconNotFound)
     end
   end
 
   describe '::config_from_tokens' do
     it 'should handle attrs with double quotes' do
-      string = '<icon size="20">fa-arrows</icon>'
+      string = '<icon size="20">far-address-book</icon>'
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
       inner = config.first
@@ -65,7 +62,7 @@ describe Prawn::Icon::Parser do
     end
 
     it 'should handle attrs with single quotes' do
-      string = "<icon size='20'>fa-arrows</icon>"
+      string = '<icon size="20">far-address-book</icon>'
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
       inner = config.first
@@ -74,7 +71,7 @@ describe Prawn::Icon::Parser do
     end
 
     it 'should handle both single/double quotes in same string' do
-      string = '<icon color="0099FF" size=\'20\'>fa-arrows</icon>'
+      string = '<icon color="0099FF" size=\'20\'>far-address-book</icon>'
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
       inner = config.first
@@ -84,7 +81,7 @@ describe Prawn::Icon::Parser do
     end
 
     it 'should return an array containing only an empty hash' do
-      string = '<icon>fa-arrows</icon>'
+      string = '<icon>far-address-book</icon>'
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
       inner = config.first
@@ -94,7 +91,7 @@ describe Prawn::Icon::Parser do
     end
 
     it 'should return an array containing a single hash of attrs' do
-      string = '<icon size="12" color="CCCCCC">fa-arrows</icon>'
+      string = '<icon size="12" color="CCCCCC">far-address-book</icon>'
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
       inner = config.first
@@ -106,9 +103,9 @@ describe Prawn::Icon::Parser do
 
     it 'should return an array containing as many hashes as icons' do
       string = <<-EOS
-      <icon>fa-arrows</icon>
-      <icon>fa-arrows</icon>
-      <icon>fa-arrows</icon>
+      <icon>far-address-book</icon>
+      <icon>far-address-book</icon>
+      <icon>far-address-book</icon>
       EOS
       tokens = tokenize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
@@ -122,49 +119,45 @@ describe Prawn::Icon::Parser do
       string = ''
       config = []
       content = contentize_string(string)
-      pdf = create_pdf
       icons = Prawn::Icon::Parser.keys_to_unicode(pdf, content, config)
 
       expect(icons).to be_empty
     end
 
     it 'should return an array with unicode content' do
-      string = '<icon>fa-arrows</icon>'
+      string = '<icon>far-address-book</icon>'
       tokens = tokenize_string(string)
       content = contentize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
-      pdf = create_pdf
       icons = Prawn::Icon::Parser.keys_to_unicode(pdf, content, config)
       icon = icons.first[:content]
 
-      expect(valid_unicode?(icon)).to be_true
+      expect(valid_unicode?(icon)).to be true
     end
 
     it 'should return a single array containing attr hash of defaults' do
       # Hash must contain :set and :content by default
-      string = '<icon>fa-arrows</icon>'
+      string = '<icon>far-address-book</icon>'
       tokens = tokenize_string(string)
       content = contentize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
-      pdf = create_pdf
       icons = Prawn::Icon::Parser.keys_to_unicode(pdf, content, config)
       icon = icons.first
 
-      expect(icon[:set]).to eq(:fa)
+      expect(icon[:set]).to eq(:far)
       expect(icon[:content]).not_to be_empty
     end
 
     it 'should handle strings with multiple icons/attrs combinations' do
       string = <<-EOS
-      <icon size="20">fa-arrows</icon>
+      <icon size='20'>far-address-book</icon>
       some filler text
-      <icon>fa-arrows</icon>
-      <icon size="8" color="0099FF">fa-arrows</icon>
+      <icon>far-address-book</icon>
+      <icon size='8' color='0099FF'>far-address-book</icon>
       EOS
       tokens = tokenize_string(string)
       content = contentize_string(string)
       config = Prawn::Icon::Parser.config_from_tokens(tokens)
-      pdf = create_pdf
       icons = Prawn::Icon::Parser.keys_to_unicode(pdf, content, config)
       first = icons.first
       second = icons[1]
@@ -179,40 +172,50 @@ describe Prawn::Icon::Parser do
   end
 
   describe '::icon_tags' do
-    it 'should return valid input as prawn formatted text tags wrapping color tags' do
-      icons = [
-        { set: :fa, color: 'CCCCCC', content: "\uf001" }
-      ]
-      tags = Prawn::Icon::Parser.icon_tags(icons)
-      match = "<font name=\"fa\"><color rgb=\"CCCCCC\">\uf001</color></font>"
-
-      expect(tags.size).to eq(1)
-      expect(tags.first).to eq(match)
-    end
-
-    it 'should return valid input as prawn formatted text tags without color' do
-      icons = [
-        { set: :fa, content: "\uf001" }
-      ]
-      tags = Prawn::Icon::Parser.icon_tags(icons)
-      match = "<font name=\"fa\">\uf001</font>"
-
-      expect(tags.size).to eq(1)
-      expect(tags.first).to eq(match)
-    end
-
-    it 'should be capable of handling multiple icon fonts' do
-      icons = [
-        { set: :fa, content: "\uf001" },
-        { set: :fi, content: "\uf001" }
-      ]
-      tags = Prawn::Icon::Parser.icon_tags(icons)
-      match1 = "<font name=\"fa\">\uf001</font>"
-      match2 = "<font name=\"fi\">\uf001</font>"
-
-      expect(tags.size).to eq(2)
-      expect(tags[0]).to eq(match1)
-      expect(tags[1]).to eq(match2)
+    let(:tags) { Prawn::Icon::Parser.icon_tags(icons) }
+
+    context 'with color attribute' do
+      let(:icons) do
+        [
+          { set: :far, color: 'CCCCCC', content: '' }
+        ]
+      end
+
+      it 'should return valid input as prawn formatted text tags wrapping color tags' do
+        match = '<font name="far"><color rgb="CCCCCC"></color></font>'
+
+        expect(tags).to eq([match])
+      end
+    end
+
+    context 'without the color attribute' do
+      let(:icons) do
+        [
+          { set: :far, content: '' }
+        ]
+      end
+
+      it 'should return valid input as prawn formatted text tags without color' do
+        match = '<font name="far"></font>'
+
+        expect(tags).to eq([match])
+      end
+    end
+
+    context 'with multiple icon fonts' do
+      let(:icons) do
+        [
+          { set: :far, content: '' },
+          { set: :fi, content: '\uf001' }
+        ]
+      end
+
+      it 'should be capable of handling multiple icon fonts' do
+        match1 = '<font name="far"></font>'
+        match2 = '<font name="fi">\uf001</font>'
+
+        expect(tags).to eq([match1, match2])
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -34,46 +34,46 @@ dependencies:
   name: pdf-inspector
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.49.1
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -114,23 +114,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pdf-reader
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: |2
     Prawn::Icon provides various icon fonts including
-    FontAwesome, Foundation Icons and GitHub Octicons
+    FontAwesome, PaymentFont and Foundation Icons
     for use with the Prawn PDF toolkit.
 email:
 - jdoyle@ualberta.ca
@@ -147,27 +133,32 @@ files:
 - README.md
 - Rakefile
 - data/fonts/DejaVuSans.ttf
-- data/fonts/fa/LICENSE
-- data/fonts/fa/fa.yml
-- data/fonts/fa/fontawesome.ttf
+- data/fonts/fab/LICENSE
+- data/fonts/fab/fa-brands.ttf
+- data/fonts/fab/fab.yml
+- data/fonts/far/LICENSE
+- data/fonts/far/fa-regular.ttf
+- data/fonts/far/far.yml
+- data/fonts/fas/LICENSE
+- data/fonts/fas/fa-solid.ttf
+- data/fonts/fas/fas.yml
 - data/fonts/fi/LICENSE
 - data/fonts/fi/fi.yml
 - data/fonts/fi/foundation-icons.ttf
-- data/fonts/octicon/LICENSE
-- data/fonts/octicon/octicon.yml
-- data/fonts/octicon/octicons.ttf
 - data/fonts/pf/LICENSE
 - data/fonts/pf/paymentfont-webfont.ttf
 - data/fonts/pf/pf.yml
 - examples/example_helper.rb
-- examples/fa-beer-inline.png
-- examples/fa-beer.png
+- examples/fas-beer-inline.png
+- examples/fas-beer.png
 - examples/fontawesome.rb
 - examples/foundation_icons.rb
-- examples/octicons.rb
 - examples/paymentfont.rb
 - lib/prawn/icon.rb
+- 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
@@ -175,6 +166,9 @@ files:
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
 - spec/support/pdf_helper.rb
+- spec/unit/base_spec.rb
+- spec/unit/errors/icon_key_empty_spec.rb
+- spec/unit/errors/icon_not_found_spec.rb
 - spec/unit/font_data_spec.rb
 - spec/unit/icon_spec.rb
 - spec/unit/parser_spec.rb
@@ -200,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF