prawn-icon 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57a618536d834a1bd0152e30fb00c47d676fe191c59cf951c615b51ac50eb23
-  data.tar.gz: 1e9d4b34b75ebef98c0cbca35547f3f49a909670461d5e9b85d4baaab3299acf
+  metadata.gz: 65ec086141aaa9ec4ddbe0f192c2a5a56b1be5eed7857fd6d48692561c484efa
+  data.tar.gz: 925215c0ad8f8ae7ed3cff3ce2d6ded45e461b181f7f37f3aeb6d34824a177c8
 SHA512:
-  metadata.gz: f1ba430c458287e398baf22c25d524036b9f77ad7f9c2d2bec39ce1557000bce273f604e77ef2b9581a8dd7fc08be77dee895017b6d2143cf3672115d0b81c09
-  data.tar.gz: 4f1912f735e51d02758f971c6dc3ea6ea3162b4ec2c8dc358daed23344027ba8ae6fb220cae5c8ecb78f4f5140975038c16fb73892e6ebe25589d033532201e4
+  metadata.gz: 8c6bf1ac1d9242b0b6c319ff1aac9ee0f01bc744e19a40047d860815e4dc1f608c0e150ac8181f993932f16b1618e4354f8f60b0cecbcfe80e8360de5bfa18b5
+  data.tar.gz: c4d8601c087a96c442a237ebeb54b94e5e0cc86fec0aa7e0557b48225cd42d852035b811ad8c4bdbd69929c246f8564c62f6a429f97c36c81580b9c7a426b7b2

data/CHANGELOG.md

@@ -1,12 +1,18 @@
+# 4.1.0 - December 12, 2024
+
+* Add a `size_mode` option to the `icon` method that scales the size of the rendered icon to fit within the requested value.
+
+Please see the documentation [here](https://github.com/jessedoyle/prawn-icon?tab=readme-ov-file#icon-size-mode) for further information. Thanks @pepijnve! [Pull Request](https://github.com/jessedoyle/prawn-icon/pull/65)
+
 # 4.0.0 - November 25, 2024
 
-* **breaking change** - Update from FontAwesom 5.11.2 to 6.7.1. Please see the notes [here](https://fontawesome.com/changelog#v6-0-0) for information related to changed or removed icons in the set. Thanks @pepijnve! [https://github.com/jessedoyle/prawn-icon/pull/62](Pull Request)
+* **breaking change** - Update from FontAwesome 5.11.2 to 6.7.1. Please see the notes [here](https://fontawesome.com/changelog#v6-0-0) for information related to changed or removed icons in the set. Thanks @pepijnve! [Pull Request](https://github.com/jessedoyle/prawn-icon/pull/62)
 
 # 3.1.0 - September 1, 2022
 
 * Update our CI matrix to include recent versions of Prawn and Ruby! Thanks @petergoldstein! (#55)
 * Resolve a few code smells that were flagged by Rubocop.
-* [Material Design Icons](https://materialdesignicons.com) are now supported! Currently version `7.0.96` is included. Thanks @maneex! [https://github.com/jessedoyle/prawn-icon/pull/59](Pull Request).
+* [Material Design Icons](https://materialdesignicons.com) are now supported! Currently version `7.0.96` is included. Thanks @maneex! [Pull Request](https://github.com/jessedoyle/prawn-icon/pull/59).
 * Memoize calls to `Prawn::Icon::FontData#path` to improve performance.
 
 #### Material Design Icons

data/README.md

@@ -101,7 +101,7 @@ If you wish to fork this repository and add a new font, you'll likely need to su
 
 ## Examples
 
-A Rake task is included to generate documents that display each icon and it's corresponding icon key.
+A Rake task is included to generate documents that display each icon and its corresponding icon key.
 
 The command:
 
@@ -121,6 +121,23 @@ Prawn::Icon.configure do |config|
 end
 ```
 
+## Icon Size Mode
+
+Some font families (in particular those of FontAwesome 6) define metrics that may render an icon at a size larger than requested (as described [here](https://github.com/jessedoyle/prawn-icon/pull/62#issuecomment-2501622305)).
+
+Prawn::Icon provides a `size_mode` parameter that can be utilized to control this behaviour:
+
+* `size_mode: :font_size` (**default**) - Renders the icon at a size calculated via font metrics. This may result in an icon that renders larger than requested due to ascender/descender metrics.
+* `size_mode: :icon_height` - Renders the icon at a size scaled down to the requested size.
+
+You can specify the size mode as follows:
+
+```ruby
+Prawn::Document.generate('size_mode.pdf') do |pdf|
+  pdf.icon 'far-circle', size: 100, size_mode: :icon_height
+end
+```
+
 ## Contributing
 
 I'll gladly accept pull requests that are well tested for any bug found in Prawn::Icon.

data/lib/prawn/icon/interface.rb

@@ -225,7 +225,16 @@ module Prawn
 
     def render
       @pdf.font(@data.path) do
-        @pdf.text @unicode, @options
+        opts = @options
+
+        if @options.fetch(:size_mode, :font_size) == :icon_height
+          requested_size = @options[:size] || @pdf.font_size
+          actual_height = @pdf.font.height_at(requested_size)
+          adjusted_size = requested_size / actual_height * requested_size
+          opts = opts.merge(size: adjusted_size)
+        end
+
+        @pdf.text @unicode, opts
       end
     end
 

data/lib/prawn/icon/version.rb

@@ -8,6 +8,6 @@
 
 module Prawn
   class Icon
-    VERSION = '4.0.0'
+    VERSION = '4.1.0'
   end
 end

data/spec/integration/icon_spec.rb

@@ -18,6 +18,13 @@ describe Prawn::Icon::Interface do
 
           expect(text.font_settings.first[:size]).to eq(60)
         end
+
+        it 'should handle text options (icon height)' do
+          pdf.icon 'far-address-book', size: 60, size_mode: :icon_height
+          text = PDF::Inspector::Text.analyze(pdf.render)
+
+          expect(text.font_settings.first[:size]).to be_within(0.0001).of(58.25243)
+        end
       end
 
       context 'inline_format: true' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-icon
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Jesse Doyle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Provides icon fonts for PrawnPDF