rolemodel-rails 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab7ce13bbc4227eedf045d0ce216b341049445daab3856f6b1d435f9799ffb53
-  data.tar.gz: 5e5ce9316bd729ad8dd3bacf21d849aa274d9c870768fd6d7866f5cb2ae093bf
+  metadata.gz: fede781704d5a6d3f851f7dfafe1ab6a6d3be865609e009b6eaff8610c510656
+  data.tar.gz: ae9be94c16906a8ccb1bca770b9e6f385ef6f7e5e8e97a8c6c830502d567b145
 SHA512:
-  metadata.gz: 74101aeb24869c8e84b1bb645573df9b95e97dfaf79d8c0d4d5980efafe46c64f414b9afded5511a9f4ae8bf0ee2339074e841710f08ba8314d996bd27a847db
-  data.tar.gz: 6438c65a802314259eaa3c0ebe8cdd94301e95f3dc5a1e82c1809f2285c219f731953da1b1bfe45ac5c877273a958b7ba5cd17f6052d4500dd12302590f194c4
+  metadata.gz: bd3700f56df8e270774d4036bdebe388d86c37bcd190fb75f39022640dee94200ae7fe7eef23474a58c2c10e5aafea2809619bc34a6b6d4e86777798287b603b
+  data.tar.gz: d75431fd64ce262417b5468ae9af0f60ec5125d499c3f2bdbb91b6278c60fe20bb3d312bce1a3b85dc2882aef931968cc499a91e5e457579667248795e603ec6

data/README.md

@@ -2,6 +2,8 @@
 
 Executable Best Practices for Rails apps, based on RoleModel's best approaches
 
+![title image](title_image.png)
+
 Attempts to solve the pain of:
 
 * Setup of a new Rails app is harder than it needs to be
@@ -324,8 +326,8 @@ e.g.
 bin/new_generator testing/fantasitic_specs 'A Fantastic Testing Framework'
 ```
 
-We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`) to test generators against. They reference the rolemodel-rails gem by local path,
-so you can navigate into one of them and run your generator for immediate feedback while developing.
+We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`) to test generators against. The specs run generators against a copy of `example_rails_current`.
+`example_rails_legacy` references the rolemodel-rails gem by local path, so you can navigate into it and run your generator for immediate feedback while developing.
 
 ## Testing
 

data/lib/generators/rolemodel/optics/icons/README.md

@@ -10,3 +10,10 @@ Adds icon helper for handling icon generation using the provider of your choice.
 
 Run the generator with the `-i` option to install the IconBuilders themselves in your
 application's `lib/rolemodel/optics` directory.
+
+## SVG icons (for example, Hugeicons)
+
+Use `--custom`. Put each SVG in `app/assets/images/icons/`, and `icon('name')` inlines it with
+Optics' `.icon--svg` modifier (Optics 2.5+), so size, weight and emphasis modifiers apply. A subfolder
+works as part of the name: `icon('duotone-rounded/home-01')`. Draw the SVGs with `currentColor`
+so they follow the text color.

data/lib/rolemodel/optics/custom_icon_builder.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 # CustomIconBuilder is an IconBuilder that allows for custom SVG icons to be used in the application.
+# It inlines app/assets/images/icons/<name>.svg, so any SVG set works, including Hugeicons:
+#
+#   icon('home-01')                   # icons/home-01.svg
+#   icon('duotone-rounded/home-01')   # icons/duotone-rounded/home-01.svg
 class Rolemodel::Optics::CustomIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
@@ -15,28 +19,28 @@ class Rolemodel::Optics::CustomIconBuilder < Rolemodel::Optics::IconBuilder
     :span
   end
 
-  # NOTE: This does not work with propshaft and the latest asset pipeline
-  # We will need to find a way to make this work in Rails 8 with propshaft.
-  def tag_contents # rubocop:disable Metrics/AbcSize
+  def tag_contents
     # Inspired by https://blog.cloud66.com/using-svgs-in-a-rails-stack
-    asset = Rails.application.assets_manifest.find_sources(svg_path).first
+    source = svg_source
+    return "<!-- SVG #{svg_path} not found -->".html_safe if source.nil?
 
-    if asset
-      file = asset.source.force_encoding('UTF-8')
-      doc = Nokogiri::HTML::DocumentFragment.parse file
-      svg = doc.at_css 'svg'
-      svg['class'] = options[:class] if options[:class].present?
+    # These SVG files can safely be marked html_safe since we created them and they are part of this app's code.
+    source.dup.force_encoding('UTF-8').html_safe
+  end
+
+  # Propshaft and Sprockets find assets differently.
+  def svg_source
+    assets = Rails.application.assets
+    if assets.respond_to?(:load_path)
+      assets.load_path.find(svg_path)&.content
     else
-      doc = "<!-- SVG #{svg_path} not found -->"
+      Rails.application.assets_manifest.find_sources(svg_path).first&.source
     end
-
-    # These SVG files can safely be marked html_safe since we created them and they are part of this app's code.
-    raw doc
   end
 
   def tag_classes
     [
-      'custom-icons',
+      'icon--svg',
       filled ? 'icon--filled' : '',
       weight == DEFAULT_WEIGHT ? '' : "icon--weight-#{weight}",
       emphasis == DEFAULT_EMPHASIS ? '' : "icon--#{emphasis}-emphasis"

data/lib/rolemodel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -459,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: The RoleModel Way of building Rails apps.
 test_files: []