glyphs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb4ffc81dcfd96faf6a0f23e3f57780340db27348666e520c7bbc747af04065e
-  data.tar.gz: 48e331ff55405e3c054fd0464a50a38ccf75df6d3e837e2a0edf3e3a18894de8
+  metadata.gz: 83fd5e39450d1ac698d0add8d4344ecbd9001783695ac15f48f7276aba89a05f
+  data.tar.gz: a1c570feaf9d4e623958a626d1a5ffe42fc55d0e4347cd659539e00335a8af3d
 SHA512:
-  metadata.gz: 382ddd08e2e3cd53ce5164bbb6104bfc46b2c1caf48ac5d39b24e08f3a7594cbd0fa95424793d746c616bc7e4e8621ded6c0af1c5bf4357fa309ded75c49c79a
-  data.tar.gz: 1205d90f3d975f3a0880e3768d68c0daf12664c98efb01f715296fd1230dd24fb2af4981e74bd689f98ddf3b7b962c29dc7e3e4dd0125024c49944b312ba8995
+  metadata.gz: b077d3f979ffcd2a41244c48fa6bba440400f44fb48d6033d35208661bfbfc434b65b22a44ee4548771bcac6ac87a97622e14dd6bb4303768066ae61a272ddb4
+  data.tar.gz: a0b9a383c8197cc0079ecea51e3c9879fcb884b12e852aecf6f8a21dd8b0a06e9624bfb753f6a2faf02eec9043c90f4570e2ff40717ed2a648c9b93b52888b62

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
-## [0.3.0]
+## [Unreleased]
+
+### Added
+
+- **A non-main Ractor renders icons it has not cached.** A miss there used to
+  raise `Ractor::IsolationError` (`@configuration from Icons`), because the
+  icons gem reads an unshareable module ivar and parses with Nokogiri, which
+  only the main Ractor can run. `Glyphs::MainRactor` now renders the miss on
+  the main Ractor through [ractor-dispatch](https://github.com/jhawthorn/ractor-dispatch)
+  (Ruby 4.0+, a dependency of Rails 8.2's Active Support) and that Ractor's
+  cache keeps the markup, byte for byte the main Ractor's. The missing-icon
+  policy runs on the main Ractor too. Without ractor-dispatch the miss raises
+  `Glyphs::MainRactor::Unavailable` naming the icon, and `Glyphs.preload_svg`
+  still seeds a Ractor's cache. glyphs does not depend on ractor-dispatch: add
+  it outside Rails 8.2. Refs zoolutions/phlex-reactive#363
+
+## [0.3.0] - 2026-10-15
 
 ### Changed
 
@@ -136,6 +152,23 @@
   rather than the primary mechanism. Only literals are harvested, so the scanner
   never invents a reference.
 
+## [0.2.1] - 2026-07-11
+
+### Added
+
+- **`glyphs:prune_icons` prunes unused icons for smaller Docker images.**
+  `Glyphs::SourceScanner` finds the icons an app references and the task deletes
+  every other synced SVG in the Docker build, keeping `config.keep_icons` (new,
+  for dynamic or data-driven names) and every `fallback_icons` entry, then
+  verifies each kept icon still resolves. Dry-run by default; it deletes only
+  with `PRUNE=1 GLYPHS_PRUNE_ICONS=1`. `config.prune_source_globs` adds paths to
+  scan. Refs #2
+
+### Changed
+
+- **Breaking:** `required_ruby_version` is now `>= 3.4` (CI runs 3.4 and 4.0).
+  Refs #2
+
 ## [0.2.0] - 2026-07-07
 
 ### Changed

data/README.md

@@ -130,11 +130,17 @@ readable on the main Ractor only, which is all an app without Ractors needs; ano
 object with a `#call` method that `Ractor.shareable?` accepts (frozen, with nothing unshareable inside) or
 `Ractor.shareable_proc` (Ruby 4.0+).
 
-The icons gem cannot render inside a non-main Ractor today (its configuration is unshareable module
-state, and Nokogiri is Ractor-unsafe), so each Ractor's cache starts empty and a miss there raises.
-Render on the main Ractor and hand the markup over with `Glyphs.preload_svg`; cache hits then work in that
-Ractor for calls without `data:` whose attributes the cache can apply (a `data:` call, or one with an attribute
-that renders uncached, still needs the icons gem):
+The icons gem cannot render inside a non-main Ractor (its configuration is unshareable module state, and
+Nokogiri is not marked Ractor-safe), so a miss in one renders on the main Ractor instead, through
+[ractor-dispatch](https://github.com/jhawthorn/ractor-dispatch) (Ruby 4.0+). Rails 8.2 apps have it through
+Active Support; elsewhere, add `gem "ractor-dispatch"`. The markup is the main Ractor's, byte for byte, and
+the calling Ractor's cache keeps it, so each icon crosses once per cache entry; cache hits never leave the
+Ractor. The missing-icon policy runs on the main Ractor too, `on_missing_icon` included. A call with an
+attribute that renders uncached, or any call with `cache_svgs = false`, goes to the main Ractor every time.
+
+Without ractor-dispatch, a miss in a non-main Ractor raises `Glyphs::MainRactor::Unavailable`, naming the
+icon. You can still render on the main Ractor and hand the markup over with `Glyphs.preload_svg`; cache hits
+then work in that Ractor for calls without `data:` whose attributes the cache can apply:
 
 ```ruby
 svg = Glyphs.svg_for(name: "house", library: :lucide, variant: nil, attributes: {}) # main Ractor

data/lib/glyphs/main_ractor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Glyphs
+  # Renders an icon on the main Ractor for a non-main one. The icons gem reads
+  # Icons.configuration (an unshareable module ivar) and parses with Nokogiri
+  # (a C extension not marked Ractor-safe), so only the main Ractor can run it.
+  # ractor-dispatch (Ruby 4.0+, a dependency of Rails 8.2's Active Support)
+  # runs the render there and sends the markup back, where the calling Ractor's
+  # own cache keeps it: each icon crosses once per Ractor, not once per render.
+  module MainRactor
+    # Raised in a non-main Ractor that cannot reach the main one.
+    class Unavailable < StandardError; end
+
+    class << self
+      # Whether this Ractor runs the icons gem itself: the main Ractor, or any
+      # code on an engine without Ractors.
+      def current?
+        defined?(::Ractor) ? ::Ractor.main? : true
+      end
+
+      # Glyphs' render (missing-icon policy included) of these arguments, run
+      # on the main Ractor; an Icons::IconNotFound it raises is raised here.
+      def render(**arguments)
+        dispatcher = main_dispatcher(arguments)
+        shared = ::Ractor.make_shareable(arguments, copy: true) # a shareable block captures only shareable values
+        dispatcher.run { Glyphs.__send__(:render_svg, **shared) }
+      end
+
+      private
+
+      def main_dispatcher(arguments)
+        icon = "#{arguments[:library]}/#{arguments[:name]}"
+        unless defined?(::Ractor::Port)
+          raise Unavailable, "#{icon} isn't cached in this Ractor, and rendering it on the main Ractor " \
+                             "needs ractor-dispatch, which needs Ruby 4.0+. Seed the cache with Glyphs.preload_svg."
+        end
+
+        require "ractor/dispatch"
+        ::Ractor::Dispatch.main
+      rescue LoadError
+        raise Unavailable, "#{icon} isn't cached in this Ractor, and rendering it on the main Ractor " \
+                           "needs the ractor-dispatch gem (Rails 8.2 apps have it): add gem \"ractor-dispatch\"."
+      end
+    end
+  end
+end

data/lib/glyphs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Glyphs
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/glyphs.rb

@@ -120,7 +120,15 @@ module Glyphs
 
     private
 
+    # A non-main Ractor cannot run the icons gem, so it renders on the main
+    # Ractor (see MainRactor); the missing-icon policy runs there too.
     def render_svg(name:, library:, variant:, attributes:)
+      return MainRactor.render(name:, library:, variant:, attributes:) unless MainRactor.current?
+
+      resolve_svg(name:, library:, variant:, attributes:)
+    end
+
+    def resolve_svg(name:, library:, variant:, attributes:)
       build_svg(name:, library:, variant:, attributes:)
     rescue Icons::IconNotFound => e
       handle_missing_icon(e, name:, library:, variant:, attributes:)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glyphs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -77,6 +77,7 @@ files:
 - lib/glyphs/icon_reference.rb
 - lib/glyphs/linear_icon.rb
 - lib/glyphs/lucide_icon.rb
+- lib/glyphs/main_ractor.rb
 - lib/glyphs/phosphor_icon.rb
 - lib/glyphs/prune_report.rb
 - lib/glyphs/prune_runner.rb