phlex-icons-flag 2.18.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ca1aa3873b55d858a0c34282ebe7c477ae7ddca2e9ccae1487754d064fc45b
-  data.tar.gz: a9050aa2f6b87ebede2a77a66f358894be0078fe18a2a66a23442fb8fca3dc57
+  metadata.gz: fc89d8e8f56d6db6d8c07c15fe5fba25275cbca73eedcb472100cc58cde42b54
+  data.tar.gz: 96126d470cb3d89dd1547d277ee4ffb7ddc978141233243c8d28025e4c70f5c4
 SHA512:
-  metadata.gz: 16799c23023faa6c39e5695dec9b08081ab660bb16de870664393a86ba8434e69a918ce4d31f2bfbe28a44c6df6a7ddb58c662d0b21dbf6575f1544c56b6bdd1
-  data.tar.gz: 459943f5f31bea1d749c926b62be0fe9856c40c2b68442f73ce07c41d071075c2dfa1bdd1d0c2bce2775d15e0c92fd16097130657784282eb4aafc561961503d
+  metadata.gz: d8448dfabad49f18de482d1f840e6f89e8820806e30afae0dbaa913da447c8f18514ddad1ba5b8b2448f1bd38468d7b995109ed153773ef61de80e6d670df255
+  data.tar.gz: 20edf5b20d23bae692bf546002bbe09e6ea8a5a3d6e0ea17f1e522d905d697383eb102fe5085163c943a6f427b82070ef9b1a1944e491cfa7a3eee559e3e4bcf

data/.rubocop.yml

@@ -25,4 +25,8 @@ Metrics/MethodLength:
   CountAsOne: ['array', 'method_call']
 
 Metrics/ClassLength:
-  CountAsOne: ['array', 'method_call']
+  CountAsOne: ['array', 'method_call']
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/README.md

@@ -62,11 +62,15 @@ The gem provides global configuration options, and per icons pack configuration
 ```ruby
 PhlexIcons.configure do |config|
   config.default_classes = 'size-6'
+  config.helper_method_name = :phlex_icon # Default: :phlex_icon
+  config.default_pack = :hero # Default: nil. Accepts :symbol, "string", or Class (e.g., PhlexIcons::Hero)
 end
 
 # OR
 
 PhlexIcons.configuration.default_classes = 'size-6'
+PhlexIcons.configuration.helper_method_name = :phlex_icon
+PhlexIcons.configuration.default_pack = :hero
 ```
 
 ### Bootstrap Icons configuration
@@ -153,6 +157,9 @@ class PhlexIcons < Phlex::HTML
       Radix::Home(class: 'size-4')
       Remix::HomeLine(class: 'size-4')
       Tabler::Home(variant: :filled, class: 'size-4')
+
+      # or with a string
+      Icon('bootstrap/house', class: 'size-4')
     end
   end
 end
@@ -174,11 +181,48 @@ class PhlexIcons < Phlex::HTML
       render PhlexIcons::Radix::Home.new(class: 'size-4')
       render PhlexIcons::Remix::HomeLine.new(class: 'size-4')
       render PhlexIcons::Tabler::Home.new(variant: :filled, class: 'size-4')
+
+      # or with a string
+      render PhlexIcons::Icon('bootstrap/house', class: 'size-4')
     end
   end
 end
 ```
 
+### Rails View Helper
+
+`phlex-icons` provides a convenient helper method to render icons directly in your ERB or Phlex views.
+
+By default, the helper method is named `phlex_icon`, but is configurable.
+
+```erb
+<%# Render a Bootstrap house icon with default size %>
+<%= phlex_icon 'bootstrap/house' %>
+
+<%# Render a Heroicons solid home icon with a specific class %>
+<%= phlex_icon 'hero/home', variant: :solid, class: 'w-5 h-5 text-blue-500' %>
+
+<%# Render a Tabler home icon, filled variant %>
+<%= phlex_icon 'tabler/home:filled' %>
+
+<%# If default_pack = :hero, render a Heroicons home icon %>
+<%= phlex_icon 'home', class: 'w-6 h-6' %>
+
+<%# Render a Flag icon (rectangle variant is default for flags if not configured otherwise) %>
+<%= phlex_icon 'flag/sa' %>
+
+<%# Render a custom icon %>
+<%= phlex_icon 'custom/my_awesome_icon:variant_name' %>
+```
+
+The first argument is the icon identifier. Such as: `'pack/icon_name:variant'`.
+
+*   If `default_pack` is configured, you can omit the pack name (e.g., `'icon_name:variant'` instead of `'pack/icon_name:variant'`).
+*   The `:variant` part is optional.
+*   Examples: `'hero/house:solid'`, `'house:solid'`, `'house'`
+
+Subsequent arguments are passed as options to the icon component, such as `variant`, `class`, etc.
+
 ### Specific icon pack(s)
 
 Let's say you want to use only Heroicons and Flag Icons, you can use the following gems:

data/generators/flag.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Flag
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/generators/hero.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Hero
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/generators/tabler.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Tabler
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/lib/phlex-icons/configuration.rb

@@ -2,10 +2,33 @@
 
 module PhlexIcons
   class Configuration
-    attr_accessor :default_variant, :default_classes
+    attr_accessor :default_variant, :default_classes, :helper_method_name
+    attr_reader :default_pack
 
     def initialize(default_classes: 'size-6')
       @default_classes = default_classes
+      @helper_method_name = :phlex_icon
+      @default_pack = nil
+    end
+
+    # Custom setter for default_pack
+    # Accepts Class (PhlexIcons::Hero), String ('hero'), or Symbol (:hero)
+    #
+    # @param value [Class, String, Symbol, nil] The value to set the default pack to.
+    # @raise [ArgumentError] If the value is not a Class, String, Symbol, or nil.
+    def default_pack=(value)
+      @default_pack = case value
+                      when Class
+                        # Extract 'Hero' from PhlexIcons::Hero, lowercase, symbolize
+                        value.name.split('::').last&.downcase&.to_sym
+                      when String, Symbol
+                        value.to_sym
+                      when nil
+                        nil
+                      else
+                        raise ArgumentError,
+                              "Invalid type for default_pack: #{value.class}. Expected Class, String, Symbol, or nil."
+                      end
     end
   end
 end

data/lib/phlex-icons/flag/ad_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AdRectangle < Base
       def view_template
-        render Ad.new(variant: :rectangle)
+        render Ad.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ad_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AdSquare < Base
       def view_template
-        render Ad.new(variant: :square)
+        render Ad.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ae_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AeRectangle < Base
       def view_template
-        render Ae.new(variant: :rectangle)
+        render Ae.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ae_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AeSquare < Base
       def view_template
-        render Ae.new(variant: :square)
+        render Ae.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/af_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AfRectangle < Base
       def view_template
-        render Af.new(variant: :rectangle)
+        render Af.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/af_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AfSquare < Base
       def view_template
-        render Af.new(variant: :square)
+        render Af.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ag_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AgRectangle < Base
       def view_template
-        render Ag.new(variant: :rectangle)
+        render Ag.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ag_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AgSquare < Base
       def view_template
-        render Ag.new(variant: :square)
+        render Ag.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ai_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AiRectangle < Base
       def view_template
-        render Ai.new(variant: :rectangle)
+        render Ai.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ai_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AiSquare < Base
       def view_template
-        render Ai.new(variant: :square)
+        render Ai.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/al_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AlRectangle < Base
       def view_template
-        render Al.new(variant: :rectangle)
+        render Al.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/al_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AlSquare < Base
       def view_template
-        render Al.new(variant: :square)
+        render Al.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/am_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AmRectangle < Base
       def view_template
-        render Am.new(variant: :rectangle)
+        render Am.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/am_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AmSquare < Base
       def view_template
-        render Am.new(variant: :square)
+        render Am.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ao_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AoRectangle < Base
       def view_template
-        render Ao.new(variant: :rectangle)
+        render Ao.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ao_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AoSquare < Base
       def view_template
-        render Ao.new(variant: :square)
+        render Ao.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/aq_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AqRectangle < Base
       def view_template
-        render Aq.new(variant: :rectangle)
+        render Aq.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/aq_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AqSquare < Base
       def view_template
-        render Aq.new(variant: :square)
+        render Aq.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ar_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class ArRectangle < Base
       def view_template
-        render Ar.new(variant: :rectangle)
+        render Ar.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ar_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class ArSquare < Base
       def view_template
-        render Ar.new(variant: :square)
+        render Ar.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/arab_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class ArabRectangle < Base
       def view_template
-        render Arab.new(variant: :rectangle)
+        render Arab.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/arab_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class ArabSquare < Base
       def view_template
-        render Arab.new(variant: :square)
+        render Arab.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/as_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AsRectangle < Base
       def view_template
-        render As.new(variant: :rectangle)
+        render As.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/as_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AsSquare < Base
       def view_template
-        render As.new(variant: :square)
+        render As.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/asean_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AseanRectangle < Base
       def view_template
-        render Asean.new(variant: :rectangle)
+        render Asean.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/asean_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AseanSquare < Base
       def view_template
-        render Asean.new(variant: :square)
+        render Asean.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/at_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AtRectangle < Base
       def view_template
-        render At.new(variant: :rectangle)
+        render At.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/at_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AtSquare < Base
       def view_template
-        render At.new(variant: :square)
+        render At.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/au_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AuRectangle < Base
       def view_template
-        render Au.new(variant: :rectangle)
+        render Au.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/au_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AuSquare < Base
       def view_template
-        render Au.new(variant: :square)
+        render Au.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/aw_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AwRectangle < Base
       def view_template
-        render Aw.new(variant: :rectangle)
+        render Aw.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/aw_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AwSquare < Base
       def view_template
-        render Aw.new(variant: :square)
+        render Aw.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ax_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AxRectangle < Base
       def view_template
-        render Ax.new(variant: :rectangle)
+        render Ax.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ax_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AxSquare < Base
       def view_template
-        render Ax.new(variant: :square)
+        render Ax.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/az_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AzRectangle < Base
       def view_template
-        render Az.new(variant: :rectangle)
+        render Az.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/az_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class AzSquare < Base
       def view_template
-        render Az.new(variant: :square)
+        render Az.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ba_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BaRectangle < Base
       def view_template
-        render Ba.new(variant: :rectangle)
+        render Ba.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/ba_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BaSquare < Base
       def view_template
-        render Ba.new(variant: :square)
+        render Ba.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bb_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BbRectangle < Base
       def view_template
-        render Bb.new(variant: :rectangle)
+        render Bb.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bb_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BbSquare < Base
       def view_template
-        render Bb.new(variant: :square)
+        render Bb.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bd_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BdRectangle < Base
       def view_template
-        render Bd.new(variant: :rectangle)
+        render Bd.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bd_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BdSquare < Base
       def view_template
-        render Bd.new(variant: :square)
+        render Bd.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/be_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BeRectangle < Base
       def view_template
-        render Be.new(variant: :rectangle)
+        render Be.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/be_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BeSquare < Base
       def view_template
-        render Be.new(variant: :square)
+        render Be.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bf_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BfRectangle < Base
       def view_template
-        render Bf.new(variant: :rectangle)
+        render Bf.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bf_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BfSquare < Base
       def view_template
-        render Bf.new(variant: :square)
+        render Bf.new(variant: :square, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bg_rectangle.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BgRectangle < Base
       def view_template
-        render Bg.new(variant: :rectangle)
+        render Bg.new(variant: :rectangle, **attrs)
       end
     end
   end

data/lib/phlex-icons/flag/bg_square.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Flag
     class BgSquare < Base
       def view_template
-        render Bg.new(variant: :square)
+        render Bg.new(variant: :square, **attrs)
       end
     end
   end