rails_icons 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628225582b62195c9f7bc3994d9fcad7aa37dc563b4d0e73069c5efdddd81332
-  data.tar.gz: 3241569575d809f7c6bbce51804cab8255df585f24a9473878432d2930596fcb
+  metadata.gz: ea0d1a2d414fe4308cfd7a65732fe7422e9a1f10edab64f6673cf0a667ef351f
+  data.tar.gz: 9fa4bab3788760957dce0e13135777fd9a432774fdd2172da077f9d716f5ed5e
 SHA512:
-  metadata.gz: c4226fb17440c8eb8949ecce47be982b7dc17f022e33b1bccc640dbd16b700096e2f6867dceace37c597e56919be83621523ac8f842976365dc81517149bf4cc
-  data.tar.gz: 1c1b35579576475f1b06ccf56416850c3d333402ebfefc63b8b1250b4317a196b04b15512ca5ac17cd26faba7298439114b4f175803c564ecbf1d22123db3eba
+  metadata.gz: 35389cf6c698b29f48229d34db04108c2471f8cb48f6e7b1d1dca8b812a381bcd6c1601fd39e360339aaa3487944130580881c2fa09323b9eeba1023be9714f3
+  data.tar.gz: 5ce92e169233c6a19c6e2e6b626996436d2ddda6b0f1c1c2e14d8b20d58b0550ccbab7b47767cabd0f7106ef8646483abdbfca20a3a7dbaf25108746fbf6158c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_icons (1.1.0)
+    rails_icons (1.3.0)
       nokogiri (~> 1.16, >= 1.16.4)
       rails (> 6.1)
 
@@ -104,7 +104,7 @@ GEM
     marcel (1.0.4)
     method_source (1.0.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.5)
+    mini_portile2 (2.8.8)
     minitest (5.22.3)
     net-imap (0.4.10)
       date
@@ -116,10 +116,10 @@ GEM
     net-smtp (0.5.0)
       net-protocol
     nio4r (2.7.1)
-    nokogiri (1.16.4)
+    nokogiri (1.18.3)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.4-arm64-darwin)
+    nokogiri (1.18.3-arm64-darwin)
       racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.0.5)
@@ -132,7 +132,7 @@ GEM
       railties (>= 7.0.0)
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rack (2.2.9)
     rack-test (2.1.0)
       rack (>= 1.3)
@@ -215,6 +215,7 @@ GEM
 PLATFORMS
   arm64-darwin-22
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   debug (~> 1.9, >= 1.9.2)

data/README.md

@@ -4,10 +4,10 @@ Add any icon library to a Rails app. Rails Icons has first-party support for a [
 
 ```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 +23,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
 
@@ -40,7 +42,7 @@ rails generate rails_icons:install --libraries=LIBRARY_NAME
 ```bash
 rails generate rails_icons:install --libraries=heroicons
 
-Or multiple at once
+# Or multiple at once
 rails generate rails_icons:install --libraries=heroicons lucide
 ```
 
@@ -54,16 +56,16 @@ icon "check"
 # Use another variant
 icon "check", variant: "solid"
 
-# Set library explictly
+# Set library explicitly
 icon "check", library: "heroicons"
 
 # Add CSS
 icon "check", class: "text-green-500"
 
 # Add CSS with class_names
-# article: https://railsdesigner.com/conditional-css-classes-in-rails/
-# docs: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-token_list
 icon "check", class: ["size-4", "bg-red-500": !verified?, "bg-green-500": verified?]
+# ↳ Article: https://railsdesigner.com/conditional-css-classes-in-rails/
+# ↳ Documentation: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-token_list
 
 # Add data attributes
 icon "check", data: { controller: "swap" }
@@ -75,13 +77,17 @@ icon "check", stroke_width: 2
 
 ## First-party libraries
 
-- [Boxicons](https://github.com/atisawd/boxicons) (1600+ icons)
-- [Feather](https://github.com/feathericons/feather) (280+ icons)
-- [Heroicons](https://github.com/tailwindlabs/heroicons) (300+ icons)
-- [Lucide](https://github.com/lucide-icons/lucide) (1500+ icons)
-- [Phosphor](https://github.com/phosphor-icons/core) (9000+ icons)
-- [Radix](https://github.com/radix-ui/icons/) (300+ icons)
-- [Tabler](https://github.com/tabler/tabler-icons) (5700+ icons)
+- [Boxicons](https://railsdesigner.com/rails-icons/boxicons/) (1600+ icons)
+- [Feather](https://railsdesigner.com/rails-icons/feather/) (280+ icons)
+- [Flags](https://railsdesigner.com/rails-icons/flags/) (540+ icons)
+- [Heroicons](https://railsdesigner.com/rails-icons/heroicons/) (300+ icons)
+- [Linear](https://railsdesigner.com/rails-icons/linear/) (170+ icons)
+- [Lucide](https://railsdesigner.com/rails-icons/lucide/) (1500+ icons)
+- [Phosphor](https://railsdesigner.com/rails-icons/phosphor/) (9000+ icons)
+- [Radix](https://railsdesigner.com/rails-icons/radix/) (300+ icons)
+- [SidekickIcons](https://railsdesigner.com/rails-icons/sidekickicons/) (49 icons, complementing [Heroicons](https://railsdesigner.com/rails-icons/heroicons/))
+- [Tabler](https://railsdesigner.com/rails-icons/tabler/) (5700+ icons)
+- [Weather](https://railsdesigner.com/rails-icons/weather/) (215+ icons)
 
 
 ## Animated icons
@@ -93,7 +99,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 other libraries are available.
+Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as the others libraries are available.
 
 
 ## Custom icon library
@@ -101,7 +107,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
@@ -111,7 +117,7 @@ icon "apple", library: "simple_icons", class: "text-black"
 
 ## Sync icons
 
-To sync all installed libraries, run
+To sync all libraries, run
 ```bash
 rails generate rails_icons:sync
 ```

data/lib/generators/rails_icons/initializer_generator.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "rails_icons/base_generator"
+
 module RailsIcons
-  class InitializerGenerator < Rails::Generators::Base
+  class InitializerGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
     desc "Create the Rails Icons initializer."
@@ -20,9 +22,9 @@ module RailsIcons
       return unless File.exist?(INITIALIZER)
       return if default_configuration_exists?
 
-      if options[:libraries].present?
+      if libraries.present?
         default_configuration = <<~RB.indent(2)
-          config.default_library = "#{options[:libraries].first}"
+          config.default_library = "#{libraries.first}"
           # config.default_variant = "" # Set a default variant for all libraries
         RB
 
@@ -45,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
@@ -56,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!(
 
@@ -76,7 +78,7 @@ module RailsIcons
     def create_custom_directory = FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
 
     def library_configuration
-      options[:libraries].map { RailsIcons.libraries[_1.to_sym].initializer_config }.join("\n")
+      libraries.map { RailsIcons.libraries[_1.to_sym].initializer_config }.join("\n")
     end
 
     def custom_configuration
@@ -95,5 +97,7 @@ module RailsIcons
 
       File.readlines(INITIALIZER).any? { _1.match?(line) }
     end
+
+    def libraries = options[:libraries].map(&:downcase)
   end
 end

data/lib/generators/rails_icons/install_generator.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require "rails_icons/base_generator"
+
 module RailsIcons
-  class InstallGenerator < Rails::Generators::Base
+  class InstallGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
-    desc "Install Rails Icons with the choosen libraries. This creates the configuration initializer and will sync the icons."
+    desc "Install Rails Icons with the chosen libraries. This creates the configuration initializer and will sync the icons."
 
     class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
     class_option :destination, type: :string, default: RailsIcons.configuration.destination_path, desc: "Specify destination folder for icons"
@@ -22,6 +24,6 @@ module RailsIcons
 
     private
 
-    def attributes = ["--libraries=#{options[:libraries].join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+    def attributes = ["--libraries=#{options[:libraries].map(&:downcase).join(" ")}", "--destination=#{options[:destination]}"].join(" ")
   end
 end

data/lib/generators/rails_icons/sync_generator.rb

@@ -1,25 +1,22 @@
 # frozen_string_literal: true
 
+require "rails_icons/base_generator"
 require "rails_icons/sync/engine"
 
 module RailsIcons
-  class SyncGenerator < Rails::Generators::Base
+  class SyncGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
-    desc "Sync the choosen icon libraries from their respective git repos."
+    desc "Sync the chosen icon libraries from their respective git repos."
 
     class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
 
-    def sync_icons
-      raise "[Rails Icons] Not a valid library" if libraries.empty?
-
-      libraries.each { Sync::Engine.new(_1).sync }
-    end
+    def sync_icons = libraries.each { Sync::Engine.new(_1).sync }
 
     private
 
     def libraries
-      options[:libraries].presence || synced_libraries
+      options[:libraries].map(&:downcase).presence || synced_libraries
     end
 
     def synced_libraries

data/lib/rails_icons/base_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class BaseGenerator < Rails::Generators::Base
+    hide!
+
+    def initialize(*arguments)
+      super(*arguments)
+
+      validate!
+    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 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

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :regular
+          options.exclude_variants = []
 
           setup_regular_config(options)
           setup_solid_config(options)
@@ -18,6 +19,9 @@ 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"
           # config.libraries.boxicons.solid.data = {}
 

data/lib/rails_icons/configuration/feather.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = nil
+          options.exclude_variants = []
 
           options.default = default_options
         end
@@ -16,6 +17,9 @@ 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"
           # config.libraries.feather.default.stroke_width = "2"
           # config.libraries.feather.default.data = {}

data/lib/rails_icons/configuration/flags.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Flags
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = "landscape"
+          options.exclude_variants = []
+
+          setup_square_config(options)
+          setup_landscape_config(options)
+        end
+      end
+
+      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"
+          # config.libraries.flags.square.default.data = {}
+
+          # config.libraries.flags.landscape.default.css = "size-6"
+          # config.libraries.flags.landscape.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/lipis/flag-icons.git",
+          variants: {
+            square: "flags/1x1",
+            landscape: "flags/4x3"
+          }
+        }
+      end
+
+      private
+
+      def setup_square_config(options)
+        options.square = ActiveSupport::OrderedOptions.new
+        options.square.default = default_square_options
+      end
+
+      def setup_landscape_config(options)
+        options.landscape = ActiveSupport::OrderedOptions.new
+        options.landscape.default = default_landscape_options
+      end
+
+      def default_square_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_landscape_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/heroicons.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :outline
+          options.exclude_variants = []
 
           setup_outline_config(options)
           setup_solid_config(options)
@@ -19,6 +20,9 @@ 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"
           # config.libraries.heroicons.outline.default.stroke_width = "1.5"
           # config.libraries.heroicons.outline.default.data = {}
@@ -68,16 +72,16 @@ module RailsIcons
         options.micro.default = default_micro_options
       end
 
-      def default_solid_options
+      def default_outline_options
         ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = 1.5
           options.css = "size-6"
           options.data = {}
         end
       end
 
-      def default_outline_options
+      def default_solid_options
         ActiveSupport::OrderedOptions.new.tap do |options|
-          options.stroke_width = 1.5
           options.css = "size-6"
           options.data = {}
         end

data/lib/rails_icons/configuration/linear.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Linear
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = nil
+          options.exclude_variants = []
+
+          options.default = default_options
+        end
+      end
+
+      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"
+          # config.libraries.linear.default.stroke_width = "2"
+          # config.libraries.linear.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/cjpatoilo/linearicons.git",
+          variants: {
+            ".": "dist/svg" # Linear has no variants, store in the top directory
+          }
+        }
+      end
+
+      private
+
+      def default_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = "2"
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/lucide.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :outline
+          options.exclude_variants = []
 
           setup_outline_config(options)
         end
@@ -16,6 +17,9 @@ 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"
           # config.libraries.lucide.outline.default.stroke_width = "1.5"
           # config.libraries.lucide.outline.default.data = {}

data/lib/rails_icons/configuration/phosphor.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :regular
+          options.exclude_variants = []
 
           setup_bold_config(options)
           setup_duotone_config(options)
@@ -21,6 +22,9 @@ 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"
           # config.libraries.phosphor.bold.default.data = {}
 

data/lib/rails_icons/configuration/radix.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = nil
+          options.exclude_variants = []
 
           options.default = default_options
         end
@@ -16,6 +17,8 @@ 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"
           # config.libraries.radix.default.data = {}

data/lib/rails_icons/configuration/sidekickicons.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Sidekickicons
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+          options.exclude_variants = []
+
+          setup_outline_config(options)
+          setup_solid_config(options)
+          setup_mini_config(options)
+          setup_micro_config(options)
+        end
+      end
+
+      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"
+          # config.libraries.sidekickicons.outline.default.stroke_width = "1.5"
+          # config.libraries.sidekickicons.outline.default.data = {}
+
+          # config.libraries.sidekickicons.solid.default.css = "size-6"
+          # config.libraries.sidekickicons.solid.default.data = {}
+
+          # config.libraries.sidekickicons.mini.default.css = "size-5"
+          # config.libraries.sidekickicons.mini.default.data = {}
+
+          # config.libraries.sidekickicons.micro.default.css = "size-4"
+          # config.libraries.sidekickicons.micro.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/ndri/sidekickicons",
+          variants: {
+            outline: "optimized/24/outline",
+            solid: "optimized/24/solid",
+            mini: "optimized/20/solid",
+            micro: "optimized/16/solid"
+          }
+        }
+      end
+
+      private
+
+      def setup_outline_config(options)
+        options.outline = ActiveSupport::OrderedOptions.new
+        options.outline.default = default_outline_options
+      end
+
+      def setup_solid_config(options)
+        options.solid = ActiveSupport::OrderedOptions.new
+        options.solid.default = default_solid_options
+      end
+
+      def setup_mini_config(options)
+        options.mini = ActiveSupport::OrderedOptions.new
+        options.mini.default = default_mini_options
+      end
+
+      def setup_micro_config(options)
+        options.micro = ActiveSupport::OrderedOptions.new
+        options.micro.default = default_micro_options
+      end
+
+      def default_solid_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_outline_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = 1.5
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_mini_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-5"
+          options.data = {}
+        end
+      end
+
+      def default_micro_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-4"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/tabler.rb

@@ -8,6 +8,7 @@ module RailsIcons
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :outline
+          options.exclude_variants = []
 
           setup_outline_config(options)
           setup_filled_config(options)
@@ -17,6 +18,10 @@ 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"
           # config.libraries.tabler.solid.default.css = "size-6"
           # config.libraries.tabler.solid.default.data = {}
 

data/lib/rails_icons/configuration/weather.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Weather
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = nil
+          options.exclude_variants = []
+
+          options.default = default_options
+        end
+      end
+
+      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"
+          # config.libraries.weather.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/erikflowers/weather-icons.git",
+          variants: {
+            ".": "svg" # Weather has no variants, store in the top directory
+          }
+        }
+      end
+
+      def transformations
+        {
+          filenames: {
+            delete_prefix: ["wi-"]
+          }
+        }
+      end
+
+      private
+
+      def default_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/errors.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
 module RailsIcons
-  class NotFound < StandardError; end
+  class IconNotFound < StandardError
+    def initialize(icon_name)
+      super("The icon `#{icon_name}` is not available. Please check the icon name and try again.")
+    end
+  end
+
+  class LibraryNotFound < StandardError
+    def initialize(library_name)
+      if library_name.empty?
+        super("No libraries were specified. Please choose from: #{RailsIcons.libraries.keys.to_sentence(last_word_connector: " or ")}")
+      else
+        super("The library `#{library_name}` is not available. Please check the library name and try again.")
+      end
+    end
+  end
 end

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/file_path.rb

@@ -13,7 +13,7 @@ module RailsIcons
 
         icon_path = icons_path_in_app || icons_path_in_engines
 
-        raise RailsIcons::NotFound if icon_path.nil?
+        raise RailsIcons::IconNotFound if icon_path.nil?
 
         icon_path
       end

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
@@ -10,7 +12,7 @@ class RailsIcons::Icon
   end
 
   def svg
-    raise RailsIcons::NotFound, error_message unless File.exist?(file_path)
+    raise RailsIcons::IconNotFound, error_message unless File.exist?(file_path)
 
     Nokogiri::HTML::DocumentFragment.parse(File.read(file_path))
       .at_css("svg")
@@ -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/libraries.rb

@@ -1,11 +1,15 @@
 require_relative "configuration/animated"
 require_relative "configuration/boxicons"
 require_relative "configuration/feather"
+require_relative "configuration/flags"
 require_relative "configuration/heroicons"
+require_relative "configuration/linear"
 require_relative "configuration/lucide"
 require_relative "configuration/phosphor"
 require_relative "configuration/radix"
+require_relative "configuration/sidekickicons"
 require_relative "configuration/tabler"
+require_relative "configuration/weather"
 
 module RailsIcons
   extend self
@@ -14,11 +18,15 @@ module RailsIcons
     {
       boxicons: RailsIcons::Configuration::Boxicons,
       feather: RailsIcons::Configuration::Feather,
+      flags: RailsIcons::Configuration::Flags,
       heroicons: RailsIcons::Configuration::Heroicons,
+      linear: RailsIcons::Configuration::Linear,
       lucide: RailsIcons::Configuration::Lucide,
       phosphor: RailsIcons::Configuration::Phosphor,
       radix: RailsIcons::Configuration::Radix,
-      tabler: RailsIcons::Configuration::Tabler
+      sidekickicons: RailsIcons::Configuration::Sidekickicons,
+      tabler: RailsIcons::Configuration::Tabler,
+      weather: RailsIcons::Configuration::Weather
     }
   end
 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
 
@@ -32,12 +34,12 @@ module RailsIcons
 
       private
 
-      TEMP_DIRECTORY = Rails.root.join("tmp/icons").freeze
+      TEMP_DIRECTORY = Rails.root.join("tmp/rails_icons").freeze
 
       def clone_repository
         raise "[Rails Icons] Failed to clone repository" unless system("git clone '#{@library[:url]}' '#{@temp_directory}'")
 
-        say "'#{@name}' repository cloned successfully."
+        say "[Rails Icons] '#{@name}' repository cloned successfully."
       end
 
       def process_variants = Sync::ProcessVariants.new(@temp_directory, @name, @library).process

data/lib/rails_icons/sync/process_variants.rb

@@ -6,14 +6,19 @@ 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
 
       def process
         original_variants = Dir.children(@temp_directory)
+        excluded_variants = RailsIcons.configuration.libraries.dig(@name.to_sym)&.exclude_variants || []
 
         @library[:variants].each do |variant_name, variant_source_path|
+          next if excluded_variants.include?(variant_name)
+
           source = File.join(@temp_directory, variant_source_path)
           destination = File.join(@temp_directory, variant_name.to_s)
 
@@ -26,7 +31,8 @@ module RailsIcons
           apply_transformations_to(destination)
         end
 
-        remove_files_and_folders(original_variants)
+        remove_files_and_folders_for(original_variants)
+        remove_previously_downloaded(excluded_variants)
 
         say "[Rails Icons] Icon variants processed successfully"
       end
@@ -50,12 +56,18 @@ module RailsIcons
         end
       end
 
-      def remove_files_and_folders(paths)
+      def remove_files_and_folders_for(paths)
         paths.each do |path|
           FileUtils.rm_rf(File.join(@temp_directory, path))
         end
       end
 
+      def remove_previously_downloaded(variants)
+        variants.each do |variant|
+          FileUtils.rm_rf(File.join(RailsIcons.configuration.destination_path, @name, variant.to_s))
+        end
+      end
+
       def transformations
         RailsIcons.libraries.dig(@name.to_sym)&.try(:transformations) || {}
       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.1.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -70,15 +70,20 @@ files:
 - lib/generators/rails_icons/sync_generator.rb
 - lib/generators/rails_icons/templates/initializer.rb.tt
 - lib/rails_icons.rb
+- lib/rails_icons/base_generator.rb
 - lib/rails_icons/configuration.rb
 - lib/rails_icons/configuration/animated.rb
 - lib/rails_icons/configuration/boxicons.rb
 - lib/rails_icons/configuration/feather.rb
+- lib/rails_icons/configuration/flags.rb
 - lib/rails_icons/configuration/heroicons.rb
+- lib/rails_icons/configuration/linear.rb
 - lib/rails_icons/configuration/lucide.rb
 - lib/rails_icons/configuration/phosphor.rb
 - lib/rails_icons/configuration/radix.rb
+- lib/rails_icons/configuration/sidekickicons.rb
 - lib/rails_icons/configuration/tabler.rb
+- lib/rails_icons/configuration/weather.rb
 - lib/rails_icons/engine.rb
 - lib/rails_icons/errors.rb
 - lib/rails_icons/helpers/icon_helper.rb