rails_icons 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6413197bc61eb646096a2c6abbf25696fd6eb8c986d85cc08519509066f83e85
-  data.tar.gz: e1a1f952e9f499a39adba3958be58fc7f7aafbd779397ce5b7d62c4e1d16cb9c
+  metadata.gz: 3d7cd3efc6fcdd950e2a509b16d65cb70657b5444ac28b3a16e86a36aaae9a68
+  data.tar.gz: 41e21e7a5d8fa720b16e90c7a67534de8c2fd2e59eac726408243778e2d90f60
 SHA512:
-  metadata.gz: 37de7ecd41860ff20570285ba3910192c5e52273a0991ae06f51a6d823078031bb0304fce7fae49a8866d5b71c2caf3a99f6123b1cfa9209b61b35acf86e1018
-  data.tar.gz: 4590aceead66f68e8b890a53823eb9fe8c959c58678631f854bedf49c763c81deda9de0175763b26fb2ad135be3d561e8ab3dd5a2c19b921cd06fad710330884
+  metadata.gz: 91571161520d6d7a57b6fc53d7e2a81ec49dfc76c58d922b0c3adb1e706207f55de846b436e7d87803262f18d8dfa0e4a4a7874bf7e8b2770df023f5091d4b7b
+  data.tar.gz: 07f2cdb947abed671415af4ec25b784a651acd094581099622bc7e40bf44e98ec70283ee0e1154d974c7a8e6586e1a3a263a88a338c3d0c7af1a42283503443d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_icons (1.2.0)
+    rails_icons (1.4.0)
       nokogiri (~> 1.16, >= 1.16.4)
       rails (> 6.1)
 

data/README.md

@@ -2,12 +2,14 @@
 
 Add any icon library to a Rails app. Rails Icons has first-party support for a [handful of libraries](#first-party-libraries). It is library agnostic so it can be used with any icon library using the same interface.
 
+![Rails Icons - A collection of icons from popular libraries like Feather, Lucide, and Heroicons arranged in a grid pattern around the title text](https://raw.githubusercontent.com/Rails-Designer/rails_icons/HEAD/.github/cover.jpg)
+
 ```erb
 # Using the default icon library
-<%= icon "check", class: "text-gray-500" %>
+icon "check", class: "text-gray-500"
 
 # Using any custom library
-<%= icon "apple", library: "simple_icons", class: "text-black" %>
+icon "apple", library: "simple_icons", class: "text-black"
 ```
 
 The icons are sourced directly from their respective GitHub repositories, ensuring Rails Icons remain lightweight.
@@ -23,6 +25,8 @@ The icons are sourced directly from their respective GitHub repositories, ensuri
   </picture>
 </a>
 
+Want to make JavaScript your second-favorite language? 👉 [JavaScript for Rails Developers](https://javascriptforrails.com/)
+
 
 ## Install
 
@@ -97,7 +101,7 @@ Rails Icons also includes a few animated icons. Great for loading states and so
 - `fading-dots`
 - `bouncing-dots`
 
-Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as the others libraries are available.
+Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as the other libraries are available.
 
 
 ## Custom icon library
@@ -105,7 +109,7 @@ Use like this: `icon "faded-spinner", library: "animated"`. The same attributes
 Need to use an icon from another library?
 
 1. run `rails generate rails_icons:initializer --custom=simple_icons`;
-2. add the (SVG) icons to the created directory **app/assets/svg/icons/simple_icons**;
+2. add the (SVG) icons to the created directory *app/assets/svg/icons/simple_icons*;
 
 Every custom icon can now be used with the same interface as first-party icon libraries.
 ```ruby

data/lib/generators/rails_icons/initializer_generator.rb

@@ -47,7 +47,7 @@ module RailsIcons
     end
 
     def setup_custom_configuration
-      return "" if options[:custom].blank?
+      return if options[:custom].blank?
 
       insert_custom_configuration
       create_custom_directory
@@ -58,7 +58,7 @@ module RailsIcons
     INITIALIZER = "config/initializers/rails_icons.rb"
 
     def insert_custom_configuration
-      unless File.read(INITIALIZER).include?("config.libraries.merge!")
+      unless file_contains?(INITIALIZER, "config.libraries.merge!")
         custom_default_configuration = <<~RB.indent(2)
           config.libraries.merge!(
 
@@ -99,5 +99,7 @@ module RailsIcons
     end
 
     def libraries = options[:libraries].map(&:downcase)
+
+    def validatable? = true
   end
 end

data/lib/generators/rails_icons/install_generator.rb

@@ -25,5 +25,7 @@ module RailsIcons
     private
 
     def attributes = ["--libraries=#{options[:libraries].map(&:downcase).join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+
+    def validatable? = true
   end
 end

data/lib/rails_icons/base_generator.rb

@@ -2,19 +2,47 @@
 
 module RailsIcons
   class BaseGenerator < Rails::Generators::Base
+    hide!
+
     def initialize(*arguments)
       super(*arguments)
 
-      validate!
+      validate! if validatable?
     end
 
     private
 
     def validate!
+      return if custom_library?
+
       raise RailsIcons::LibraryNotFound.new("") if options.libraries.empty?
       raise RailsIcons::LibraryNotFound.new(invalid_libraries.join(", ")) if invalid_libraries.any?
     end
 
+    def validatable? = false
+
     def invalid_libraries = options.libraries.map(&:to_sym).map(&:downcase).reject { RailsIcons.libraries.key?(_1) }
+
+    def custom_library? = options.custom.present?
+
+    # Uses `gsub_file` as a read-only operation to check file content. This
+    # approach is preferred over `File.read` because `gsub_file` is properly stubbed
+    # in generator tests, while `File.read` would fail in the test environment.
+    #
+    def file_contains?(path, content)
+      return false unless File.exist?(path)
+
+      result = false
+
+      gsub_file(path, /.*/) do |file_content|
+        result = file_content.include?(content)
+
+        file_content
+      end
+
+      result
+    rescue Thor::Error
+      false
+    end
   end
 end

data/lib/rails_icons/configuration/boxicons.rb

@@ -19,6 +19,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Boxicons defaults
+          # config.libraries.boxicons.default_variant = "" # Set a default variant for Boxicons
           # config.libraries.boxicons.exclude_variants = [] # Exclude specific variants
 
           # config.libraries.boxicons.solid.css = "size-6"

data/lib/rails_icons/configuration/feather.rb

@@ -17,6 +17,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Feather defaults
+          # config.libraries.feather.default_variant = "" # Feather has no variants, this is provided for backwards compatibility
           # config.libraries.feather.exclude_variants = [] # Feather has no variants, this is provided for backwards compatibility
 
           # config.libraries.feather.default.css = "size-6"

data/lib/rails_icons/configuration/flags.rb

@@ -18,6 +18,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Flags defaults
+          # config.libraries.flags.default_variant = "" # Set a default variant for Flags
           # config.libraries.flags.exclude_variants = [:square, :landscape]
 
           # config.libraries.flags.square.default.css = "size-6"

data/lib/rails_icons/configuration/heroicons.rb

@@ -20,6 +20,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Heroicon defaults
+          # config.libraries.heroicons.default_variant = "" # Set a default variant for Heroicons
           # config.libraries.heroicons.exclude_variants = [:mini, :micro] # Exclude specific variants
 
           # config.libraries.heroicons.outline.default.css = "size-6"

data/lib/rails_icons/configuration/linear.rb

@@ -17,6 +17,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Linear defaults
+          # config.libraries.linear.default_variant = "" # Set a default variant for Linear
           # config.libraries.linear.exclude_variants = []
 
           # config.libraries.linear.default.css = "size-6"

data/lib/rails_icons/configuration/lucide.rb

@@ -17,6 +17,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Lucide defaults
+          # config.libraries.lucide.default_variant = "" # Set a default variant for Lucide
           # config.libraries.lucide.exclude_variants = [] # Exclude specific variants
 
           # config.libraries.lucide.outline.default.css = "size-6"

data/lib/rails_icons/configuration/phosphor.rb

@@ -22,6 +22,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Phosphor defaults
+          # config.libraries.phosphor.default_variant = "" # Set a default variant for Phosphor
           # config.libraries.phosphor.exclude_variants = [:duotone, :thin] # Exclude specific variants
 
           # config.libraries.phosphor.bold.default.css = "size-6"

data/lib/rails_icons/configuration/radix.rb

@@ -17,6 +17,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Radix defaults
+          # config.libraries.radix.default_variant = "" # Radix has no variants, this is provided for backwards compatibility
           # config.libraries.radix.exclude_variants = [] # Radix has no variants, this is provided for backwards compatibility
           # config.libraries.radix.default.css = "size-6"
           # config.libraries.radix.default.stroke_width = "2"

data/lib/rails_icons/configuration/sidekickicons.rb

@@ -20,6 +20,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Sidekickicons defaults
+          # config.libraries.sidekickicons.default_variant = "" # Set a default variant for Sidekickicons
           # config.libraries.sidekickicons.exclude_variants = [:mini, :micro] # Exclude specific variants
 
           # config.libraries.sidekickicons.outline.default.css = "size-6"

data/lib/rails_icons/configuration/tabler.rb

@@ -18,6 +18,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Tabler defaults
+          # config.libraries.tabler.default_variant = "" # Set a default variant for Tabler
           # config.libraries.tabler.exclude_variants = [] # Exclude specific variants
 
           # config.libraries.tabler.regular.default.css = "size-6"

data/lib/rails_icons/configuration/weather.rb

@@ -17,6 +17,7 @@ module RailsIcons
       def initializer_config
         <<~RB.indent(2)
           # Override Weather defaults
+          # config.libraries.weather.default_variant = "" # Set a default variant for Wweather
           # config.libraries.weather.exclude_variants = []
 
           # config.libraries.weather.default.css = "size-6"

data/lib/rails_icons/helpers/icon_helper.rb

@@ -5,10 +5,10 @@ require_relative "../configuration"
 module RailsIcons
   module Helpers
     module IconHelper
-      def icon(name, library: RailsIcons.configuration.default_library, variant: nil, **arguments)
+      def icon(name, library: RailsIcons.configuration.default_library, from: library, variant: nil, **arguments)
         RailsIcons::Icon.new(
           name: name,
-          library: library,
+          library: from || library,
           variant: variant,
           arguments: arguments
         ).svg

data/lib/rails_icons/icon.rb

@@ -2,7 +2,9 @@ require "rails_icons/icon/file_path"
 require "rails_icons/icon/attributes"
 
 class RailsIcons::Icon
-  def initialize(name:, library:, arguments:, variant: nil)
+  def initialize(name:, library:, arguments:, variant: nil, config: RailsIcons.configuration)
+    @config = config # set first, config is used during initialization
+
     @name = name
     @library = library.to_s.inquiry
     @variant = (variant || set_variant).to_s
@@ -22,8 +24,8 @@ class RailsIcons::Icon
   private
 
   def set_variant
-    RailsIcons.configuration.default_variant.presence ||
-      RailsIcons.configuration.libraries.dig(@library.to_sym, :default_variant)
+    @config.libraries.dig(@library.to_sym, :default_variant).presence ||
+      @config.default_variant.presence
   end
 
   def error_message
@@ -55,7 +57,7 @@ class RailsIcons::Icon
   def default(key) = library_attributes.dig(:default, key)
 
   def library_attributes
-    custom_library? ? custom_library : RailsIcons.configuration.libraries.dig(@library, @variant) || {}
+    custom_library? ? custom_library : @config.libraries.dig(@library, @variant) || {}
   end
 
   def custom_library
@@ -65,7 +67,7 @@ class RailsIcons::Icon
       &.dig("custom")
       &.dig(@library.to_sym)&.with_defaults(
         {
-          path: [RailsIcons.configuration.destination_path, @library].join("/")
+          path: [@config.destination_path, @library].join("/")
         }
       ) || {}
   end

data/lib/rails_icons/sync/engine.rb

@@ -6,6 +6,8 @@ require "rails_icons/sync/process_variants"
 module RailsIcons
   module Sync
     class Engine < Rails::Generators::Base
+      hide!
+
       def initialize(name)
         super
 

data/lib/rails_icons/sync/process_variants.rb

@@ -6,6 +6,8 @@ require "rails_icons/sync/transformations"
 module RailsIcons
   module Sync
     class ProcessVariants < Rails::Generators::Base
+      hide!
+
       def initialize(temp_directory, name, library)
         @temp_directory, @name, @library = temp_directory, name, library
       end

data/lib/rails_icons/sync/transformations.rb

@@ -1,6 +1,8 @@
 module RailsIcons
   module Sync
     class Transformations < Rails::Generators::Base
+      hide!
+
       def self.transform(filename, rules = {})
         basename = File.basename(filename, File.extname(filename))
 

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails