prawn-icon 3.0.0 → 4.0.0

data/examples/mdi.rb

@@ -0,0 +1,36 @@
+# All example code may be executed by calling `rake legend`
+
+require_relative '../lib/prawn/icon'
+require_relative 'example_helper'
+
+Prawn::Document.generate('mdi_icons.pdf') do
+  deja_path = Prawn::Icon.configuration.font_directory
+    .join('DejaVuSans.ttf')
+    .to_s
+
+  font_families.update({
+    'deja' => { normal: deja_path }
+  })
+
+  font('deja')
+
+  icons = icon_keys(self, 'mdi')
+  required_pages = number_of_pages(self, 'mdi')
+
+  define_grid(columns: 6, rows: 12, gutter: 16)
+
+  sub_header = 'Material Design Icons'
+  link = 'https://materialdesignicons.com/'
+  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
+
+  page_icons icons, required_pages do |icon_key|
+    icon icon_key, size: 20, align: :center
+  end
+end

data/lib/prawn/icon/base.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # base.rb - Base configuration for Prawn::Icon.
 #
 # Copyright September 2016, Jesse Doyle. All rights reserved.

data/lib/prawn/icon/compatibility.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # compatibility.rb - Prawn::Icon FontAwesome 4/5 compatibility shim.
 #
 # Copyright March 2018, Jesse Doyle. All rights reserved.
@@ -31,14 +31,12 @@ module Prawn
         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
+      def translate(io = $stderr)
+        @translate ||= if key.start_with?('fa-')
+                         map.tap { |replaced| warning(replaced, key, io) }
+                       else
+                         key
+                       end
       end
 
       private
@@ -52,14 +50,13 @@ module Prawn
       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 4.0.0.
-DEPRECATION
+        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 a future major release.
+        DEPRECATION
       end
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/prawn/icon/configuration.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # configuration.rb: Prawn icon configuration.
 #
 # Copyright October 2020, Jesse Doyle. All rights reserved.
@@ -32,7 +32,7 @@ module Prawn
       end
 
       def failsafe_gem_path
-        File.expand_path('../../../..', __FILE__)
+        File.expand_path('../../..', __dir__)
       end
       # :nocov:
     end

data/lib/prawn/icon/errors.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # errors.rb - Prawn::Icon standard errors.
 #
 # Copyright September 2016, Jesse Doyle. All rights reserved.

data/lib/prawn/icon/font_data.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # font_data.rb: Icon font metadata container/cache.
 #
 # Copyright October 2014, Jesse Doyle. All rights reserved.
@@ -63,17 +63,19 @@ module Prawn
       end
 
       def path
-        font = Icon.configuration.font_directory
-          .join(@set.to_s)
-          .glob('*.ttf')
-          .first
-
-        if font.nil?
-          raise Prawn::Errors::UnknownFont,
-                "Icon font not found for set: #{@set}"
-        end
+        @path = begin
+          font = Icon.configuration.font_directory
+                     .join(@set.to_s)
+                     .glob('*.ttf')
+                     .first
+
+          if font.nil?
+            raise Prawn::Errors::UnknownFont,
+                  "Icon font not found for set: #{@set}"
+          end
 
-        @path ||= font.to_s
+          font.to_s
+        end
       end
 
       def specifier

data/lib/prawn/icon/interface.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # interface.rb: Prawn extension module and logic.
 #
 # Copyright October 2016, Jesse Doyle. All rights reserved.
@@ -199,9 +199,7 @@ module Prawn
         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
+          self.y -= box.line_gap + box.leading unless opts.fetch(:final_gap, true)
         end
       end
     end

data/lib/prawn/icon/parser.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # parser.rb: Prawn icon tag text parser (pseudo-HTML).
 #
 # Copyright October 2014, Jesse Doyle. All rights reserved.
@@ -31,15 +31,17 @@ module Prawn
     #
     class Parser
       PARSER_REGEX  = Regexp.new \
-                      '<icon[^>]*>|</icon>',
-                      Regexp::IGNORECASE |
-                      Regexp::MULTILINE
+        '<icon[^>]*>|</icon>',
+        Regexp::IGNORECASE |
+        Regexp::MULTILINE
 
-      CONTENT_REGEX = /<icon[^>]*>(?<content>[^<]*)<\/icon>/mi
+      CONTENT_REGEX = /<icon[^>]*>(?<content>[^<]*)<\/icon>/mi.freeze
 
-      TAG_REGEX     = /<icon[^>]*>[^<]*<\/icon>/mi
+      TAG_REGEX     = /<icon[^>]*>[^<]*<\/icon>/mi.freeze
 
-      ATTR_REGEX    = /(?<attr>[a-zA-Z]*)=["|'](?<val>(\w*[^["|']]))["|']/mi
+      # rubocop:disable Lint/MixedRegexpCaptureTypes
+      ATTR_REGEX    = /(?<attr>[a-zA-Z]*)=["|'](?<val>(\w*[^["|']]))["|']/mi.freeze
+      # rubocop:enable Lint/MixedRegexpCaptureTypes
 
       class << self
         def format(document, string)
@@ -103,9 +105,9 @@ module Prawn
               options ||= {}
               options = config[index] if config.any?
               info = {
-                set:     FontData.specifier_from_key(key),
-                size:    options[:size],
-                color:   options[:color],
+                set: FontData.specifier_from_key(key),
+                size: options[:size],
+                color: options[:color],
                 content: FontData.unicode_from_key(document, key)
               }
               icons << info
@@ -115,7 +117,7 @@ module Prawn
 
         private
 
-        def attr_hash(value) #:nodoc:
+        def attr_hash(value) # :nodoc:
           # If attr == size, we must cast value to float,
           # else symbolize the key and map it to value
           if value[0] =~ /size/i

data/lib/prawn/icon/version.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # version.rb: Prawn icon versioning.
 #
 # Copyright October 2014, Jesse Doyle. All rights reserved.
@@ -8,6 +8,6 @@
 
 module Prawn
   class Icon
-    VERSION = '3.0.0'.freeze
+    VERSION = '4.0.0'
   end
 end

data/lib/prawn/icon.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # icon.rb: Prawn icon functionality.
 #
 # Copyright October 2014, Jesse Doyle. All rights reserved.

data/prawn-icon.gemspec

@@ -1,4 +1,6 @@
-basedir = File.expand_path(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+basedir = __dir__
 require "#{basedir}/lib/prawn/icon/version"
 
 Gem::Specification.new do |spec|
@@ -17,23 +19,23 @@ Gem::Specification.new do |spec|
 
   spec.homepage = 'https://github.com/jessedoyle/prawn-icon/'
 
-  spec.test_files = Dir['spec/*_spec.rb']
   spec.authors    = ['Jesse Doyle']
   spec.email      = ['jdoyle@ualberta.ca']
-  spec.licenses   = ['RUBY', 'GPL-2', 'GPL-3']
+  spec.licenses   = %w[RUBY GPL-2 GPL-3]
 
   spec.add_dependency('prawn', '>= 1.1.0', '< 3.0.0')
 
   spec.add_development_dependency('pdf-inspector', '>= 1.2.1')
-  spec.add_development_dependency('rspec', '>= 3.5.0')
-  spec.add_development_dependency('rubocop', '~> 0.49.1')
-  spec.add_development_dependency('rake')
   spec.add_development_dependency('pdf-reader', '>= 1.4')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '>= 3.5.0')
+  spec.add_development_dependency('rubocop', '~> 1.35.1')
   spec.add_development_dependency('simplecov')
 
-  spec.description = <<-END_DESC
-  Prawn::Icon provides various icon fonts including
-  FontAwesome, PaymentFont and Foundation Icons
-  for use with the Prawn PDF toolkit.
+  spec.description = <<~END_DESC
+    Prawn::Icon provides various icon fonts including
+    FontAwesome, PaymentFont and Foundation Icons
+    for use with the Prawn PDF toolkit.
   END_DESC
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/integration/icon_spec.rb

@@ -68,7 +68,7 @@ describe Prawn::Icon::Interface do
             inspector = PDF::Inspector::Text.analyze(pdf.render)
             y = inspector.positions[1].last.round
 
-            expect(y).to eq(723)
+            expect(y).to eq(722)
           end
         end
       end
@@ -154,7 +154,7 @@ describe Prawn::Icon::Interface do
       x, y = inspector.positions[0]
 
       expect(x).to eq(200)
-      expect(y.round).to eq(90)
+      expect(y.round).to eq(89)
     end
 
     it 'handles final_gap: false correctly' do
@@ -261,4 +261,19 @@ describe Prawn::Icon do
       expect(text.strings.first).to eq('')
     end
   end
+
+  context 'Material Design Icons' do
+    it 'renders Material Design Icon glyphs' do
+      pdf.icon 'mdi-beer'
+      text = PDF::Inspector::Text.analyze(pdf.render)
+
+      # NOTE: Prawn <= 2.4.0 incorrectly handled unicode codepoints
+      # see: https://github.com/prawnpdf/prawn/pull/1327#issuecomment-1905817491
+      if Gem::Version.new(Prawn::VERSION) <= Gem::Version.new('2.4.0')
+        expect(text.strings.first).to eq("\u{F009}")
+      else
+        expect(text.strings.first).to eq("\u{F0098}")
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -45,61 +45,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.35.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -114,10 +114,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-    Prawn::Icon provides various icon fonts including
-    FontAwesome, PaymentFont and Foundation Icons
-    for use with the Prawn PDF toolkit.
+description: |
+  Prawn::Icon provides various icon fonts including
+  FontAwesome, PaymentFont and Foundation Icons
+  for use with the Prawn PDF toolkit.
 email:
 - jdoyle@ualberta.ca
 executables: []
@@ -146,6 +146,9 @@ files:
 - data/fonts/fi/LICENSE
 - data/fonts/fi/fi.yml
 - data/fonts/fi/foundation-icons.ttf
+- data/fonts/mdi/LICENSE
+- data/fonts/mdi/materialdesignicons-webfont.ttf
+- data/fonts/mdi/mdi.yml
 - data/fonts/pf/LICENSE
 - data/fonts/pf/paymentfont-webfont.ttf
 - data/fonts/pf/pf.yml
@@ -154,6 +157,7 @@ files:
 - examples/fas-beer.png
 - examples/fontawesome.rb
 - examples/foundation_icons.rb
+- examples/mdi.rb
 - examples/paymentfont.rb
 - lib/prawn/icon.rb
 - lib/prawn/icon/base.rb
@@ -182,7 +186,8 @@ licenses:
 - RUBY
 - GPL-2
 - GPL-3
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -198,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF