rails_icons 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3ee60bafe9a9cffae818c8304e8a69abf56d8de147ff607db5d775137ab5ea
-  data.tar.gz: afacf89281c87e029a0866860ef6edf1a738e06d5918b5254524c2bbe803bbd3
+  metadata.gz: 50dffad405d19a7a365d8dd5684422ac4b0b31fc5e8c9e001d841c2625ed0f66
+  data.tar.gz: ac27f4feb6a7dae8d240896cbcad704675f566080aea2a1df4bad68608bcd0ae
 SHA512:
-  metadata.gz: f1f4ed187c437220dc0b081dbddb95f1204f65a30dca2b89c4b72aba7574888d5adee9766a69821ecb26d2f9e9adff2e78d8b585ec7f639dd8d9754b0cb9296f
-  data.tar.gz: e195bd6ade61e3018a478852d293c8437d0c0490c5d8727d774098c98a10189b4be7d982f73ebb191ce5486a947f46c424265f46fe79fec3fe03ae3e45be543a
+  metadata.gz: 1b3b458095eb630a39f217be671c6bf58dc400c6e5caea9e7eee7ceebc51df6329dced01d3451f483b936f3fb5d59aaeea05de519565e36c12de3aa80abfbeb3
+  data.tar.gz: 60a93aed59ef5c518c39d95b3814062a02240aa86cbfe34ca771164504747ea965fae97a3456cc50dc06e620c04ccc2c5d7825d7724ec7f3850abd583be0cf91

data/Gemfile.lock

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

data/README.md

@@ -1,114 +1,124 @@
 # Rails Icons
 
-Embed any library's icon in your Rails app. There are many icon gems for Rails already, but none are library-agnostic. This means you need to pull in other gems or add your logic to display that one specific icon.
+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.
 
-The first-party supported icons are stored in a seperate repo: [rails_icons_vault](https://github.com/Rails-Designer/rails_icons_vault). This allows you to pull in only the icon libraries you need, keeping the rails_icons gem lean and lightweight.
+```erb
+# Using the default icon library
+<%= icon "check", class: "text-gray-500" %>
 
+# Using any custom library
+<%= icon "apple", library: "simple_icons", class: "text-black" %>
+```
+
+The icons are sourced directly from their respective GitHub repositories, ensuring Rails Icons remain lightweight.
 
-## Sponsored By [Rails Designer](https://railsdesigner.com/)
+
+**Sponsored By [Rails Designer](https://railsdesigner.com/)**
 
 <a href="https://railsdesigner.com/" target="_blank">
-  <img src="https://raw.githubusercontent.com/Rails-Designer/rails_icons/main/docs/rails_designer_icon.jpg" alt="Rails Designer logo"  width="300" />
+  <img src="https://raw.githubusercontent.com/Rails-Designer/rails_icons/main/docs/rails_designer_icon.jpg" alt="Rails Designer logo"  width="240" />
 </a>
 
 
 ## Install
 
-Add this line to your Gemfile:
-
-```ruby
-gem "rails_icons"
+Add the gem
+```bash
+bundle add rails_icons
 ```
 
-And run:
-
+Install, choosing one of the supported libraries
 ```bash
-bundle
+rails generate rails_icons:install --libraries=LIBRARY_NAME
 ```
 
-Sync any of the supported icon libraries from the
-[rails_icons_vault](https://github.com/Rails-Designer/rails_icons_vault):
-
+**Example**
 ```bash
-rails generate rails_icons:sync heroicons
+rails generate rails_icons:install --libraries=heroicons
+
+Or multiple at once
+rails generate rails_icons:install --libraries=heroicons lucide
 ```
 
 
 ## Usage
 
 ```ruby
-# The default library is Heroicons, with "outline" as the default set
+# Uses the default library and variant defined in config/initializer/rails_icons.rb
 icon "check"
 
-# Use another set (options are: outline, solid, mini, micro)
-icon "check", set: "solid"
+# Use another variant
+icon "check", variant: "solid"
+
+# Set library explictly
+icon "check", library: "heroicons"
 
-# Add CSS to the icon
+# Add CSS
 icon "check", class: "text-green-500"
 
 # Add data attributes
 icon "check", data: { controller: "swap" }
 
-# Tweak the stroke-width
+# Set the stroke-width
 icon "check", stroke_width: 2
 ```
 
 
-## Initializer
+## First-party libraries
 
-```ruby
-RailsIcons.configure do |config|
-  # Set the default set for the library
-  config.default_library = "heroicons"
-  config.default_set = "outline"
+- [Feather](https://github.com/feathericons/feather)
+- [Heroicons](https://github.com/tailwindlabs/heroicons)
+- [Lucide](https://github.com/lucide-icons/lucide)
+- [Tabler](https://github.com/tabler/tabler-icons)
 
-  config.libraries.heroicons.solid.default.css = "w-6 h-6"
-  config.libraries.heroicons.solid.default.data = {}
 
-  config.libraries.heroicons.outline.default.css = "w-6 h-6"
-  config.libraries.heroicons.outline.default.stroke_width = "1.5"
-  config.libraries.heroicons.outline.default.data = {}
+## Animated icons
 
-  config.libraries.heroicons.mini.default.css = "w-5 h-5"
-  config.libraries.heroicons.mini.default.data = {}
+Rails Icons also includes a few animated icons. Great for loading states and so on. These are currently included:
 
-  config.libraries.heroicons.micro.default.css = "w-4 h-4"
-  config.libraries.heroicons.micro.default.data = {}
-end
-```
+- `faded-spinner`
+- `trailing-spinner`
+- `fading-dots`
+- `bouncing-dots`
+
+Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as other libraries are available.
 
-Or run `rails generate rails_icons:initializer`.
 
+## Custom icon library
 
-## Add a custom icon library
+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**;
+
+Every custom icon can now be used with the same interface as first-party icon libraries.
 
 ```ruby
-RailsIcons.configure do |config|
-  # …
-  config.libraries.merge!(
-    {
-      custom: {
-        simple_icons: {
-          solid: {
-            path: "app/assets/svg/simple_icons/solid", # optional: the default lookup path is: `app/assets/svg/#{library_name}/#{set}`
-            default: {
-              css: "w-6 h-6"
-            }
-          }
-        }
-      }
-    }
-  )
-  # …
-end
+icon "apple", library: "simple_icons", class: "text-black"
 ```
 
-You can now use any svg-icon in the `app/assets/svg/simple_icons/solid` folder as a first-party icon:
 
-```ruby
-icon "reddit", library: "simple_icons", set: "solid"
+## Sync icons
+
+If a library gets updated, sync the icons to your app by running
+
+```bash
+rails generate rails_icons:sync --libraries=LIBRARY_NAME
 ```
 
+**Example**
+```bash
+rails generate rails_icons:sync --libraries=heroicons
+
+# Or multiple at once:
+rails generate rails_icons:sync --libraries=heroicons lucide
+```
+
+
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `be standardrb` before submitting pull requests. Run tests via `rails test`.
+
 
 ## License
 

data/app/assets/svg/rails_icons/icons/animated/bouncing-dots.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><circle fill="currentColor" stroke="none" cx="4" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 3.6 ; 0 -3.6; 0 3.6" repeatCount="indefinite" begin="0.1"></animateTransform></circle><circle fill="currentColor" stroke="none" cx="12" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 2.4 ; 0 -2.4; 0 2.4" repeatCount="indefinite" begin="0.2"></animateTransform></circle><circle fill="currentColor" stroke="none" cx="20" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 1.2 ; 0 -1.2; 0 1.2" repeatCount="indefinite" begin="0.3"></animateTransform></circle></svg>

data/app/assets/svg/rails_icons/icons/animated/faded-spinner.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" ><defs><style>@keyframes spin {to{transform:rotate(360deg);}}</style></defs><g style="transform-origin:center;animation:spin 1s linear infinite"><circle style="opacity: 0.25" cx="12" cy="12" r="10" stroke="currentColor" stroke-width="4" fill="none"/><path style="opacity: 0.75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"/></g></svg>

data/app/assets/svg/rails_icons/icons/animated/fading-dots.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><circle fill="currentColor" stroke="none" cx="4" cy="12" r="2.5"> <animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.1"></animate></circle><circle fill="currentColor" stroke="none" cx="12" cy="12" r="2.5"><animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.2"></animate></circle><circle fill="currentColor" stroke="none" cx="20" cy="12" r="2.5"><animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.3"></animate></circle></svg>

data/app/assets/svg/rails_icons/icons/animated/trailing-spinner.svg

@@ -0,0 +1 @@
+<svg stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><style>.spinner{transform-origin:center; animation:spinner_outside 2s linear infinite}.spinner circle{stroke-linecap:round;animation:spinner_inside 1.5s ease-in-out infinite}@keyframes spinner_outside{100%{transform:rotate(360deg)}}@keyframes spinner_inside{0%{stroke-dasharray:0 150;stroke-dashoffset:0}47.5%{stroke-dasharray:42 150;stroke-dashoffset:-16}95%,100%{stroke-dasharray:42 150;stroke-dashoffset:-59}}</style><g class="spinner"><circle cx="12" cy="12" r="9.5" fill="none" stroke-width="4"></circle></g></svg>

data/lib/generators/rails_icons/initializer_generator.rb

@@ -1,9 +1,144 @@
+# frozen_string_literal: true
+
 module RailsIcons
   class InitializerGenerator < Rails::Generators::Base
     source_root File.expand_path("templates", __dir__)
 
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
+    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
+    class_option :custom, type: :string, desc: "Name of the custom library"
+
     def copy_initializer
-      copy_file "initializer.rb", "config/initializers/rails_icons.rb"
+      return if File.exist?(INITIALIZER)
+
+      copy_file "initializer.rb", INITIALIZER
+    end
+
+    def insert_default_configuration
+      return unless File.exist?(INITIALIZER)
+      return if default_configuration_exists?
+
+      if options[:libraries].present?
+        default_configuration = <<~RB.indent(2)
+          config.default_library = "#{options[:libraries].first}"
+          # config.default_variant = "" # Set a default variant if multiple exist
+        RB
+
+        insert_into_file INITIALIZER, default_configuration, after: "RailsIcons.configure do |config|\n"
+      end
+    end
+
+    def insert_libraries_configuration
+      insert_into_file INITIALIZER, "\n#{library_configuration}", before: "end"
+    end
+
+    def setup_custom_configuration
+      return "" if options[:custom].blank?
+
+      insert_custom_configuration
+      create_custom_directory
+    end
+
+    private
+
+    INITIALIZER = "config/initializers/rails_icons.rb"
+
+    def insert_custom_configuration
+      unless File.read(INITIALIZER).include?("config.libraries.merge!")
+        custom_default_configuration = <<~RB.indent(2)
+          config.libraries.merge!(
+
+            {
+              custom: {
+              }
+            }
+          )
+        RB
+
+        insert_into_file INITIALIZER, custom_default_configuration, before: "end"
+      end
+
+      insert_into_file INITIALIZER, "\n#{custom_configuration}", after: "custom: {"
+    end
+
+    def create_custom_directory
+      FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
+    end
+
+    def library_configuration
+      configs = {
+        feather: feather_config,
+        heroicons: heroicons_config,
+        lucide: lucide_config,
+        tabler: tabler_config
+      }
+
+      options[:libraries].map { configs[_1.to_sym] }.join("\n")
+    end
+
+    def feather_config
+      <<~RB.indent(2)
+        # Override Feather defaults
+        # config.libraries.feather.default.css = "size-6"
+        # config.libraries.feather.default.stroke_width = "2"
+        # config.libraries.feather.default.data = {}
+      RB
+    end
+
+    def heroicons_config
+      <<~RB.indent(2)
+        # Override Heroicon defaults
+        # config.libraries.heroicons.outline.default.css = "size-6"
+        # config.libraries.heroicons.outline.default.stroke_width = "1.5"
+        # config.libraries.heroicons.outline.default.data = {}
+
+        # config.libraries.heroicons.solid.default.css = "size-6"
+        # config.libraries.heroicons.solid.default.data = {}
+
+        # config.libraries.heroicons.mini.default.css = "size-5"
+        # config.libraries.heroicons.mini.default.data = {}
+
+        # config.libraries.heroicons.micro.default.css = "size-4"
+        # config.libraries.heroicons.micro.default.data = {}
+      RB
+    end
+
+    def lucide_config
+      <<~RB.indent(2)
+        # Override Lucide defaults
+        # config.libraries.lucide.outline.default.css = "size-6"
+        # config.libraries.lucide.outline.default.stroke_width = "1.5"
+        # config.libraries.lucide.outline.default.data = {}
+      RB
+    end
+
+    def tabler_config
+      <<~RB.indent(2)
+        # Override Tabler defaults
+        # config.libraries.tabler.solid.default.css = "size-6"
+        # config.libraries.tabler.solid.default.data = {}
+
+        # config.libraries.tabler.outline.default.css = "size-6"
+        # config.libraries.tabler.outline.default.stroke_width = "2"
+        # config.libraries.tabler.outline.default.data = {}
+      RB
+    end
+
+    def custom_configuration
+      <<~RB.indent(8)
+        #{options[:custom]}: {
+          # path: "app/assets/svg/icons/#{options[:custom]}/",
+          default: {
+            css: "size-6"
+          }
+        }
+      RB
+    end
+
+    def default_configuration_exists?
+      line = /^\s*config\.default_library\s*=/
+
+      File.readlines(INITIALIZER).any? { _1.match?(line) }
     end
   end
 end

data/lib/generators/rails_icons/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
+    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
+    class_option :skip_sync, type: :boolean, default: false
+
+    def initializer_generator
+      generate("rails_icons:initializer", *attributes)
+    end
+
+    def sync_generator
+      return if options[:skip_sync] || options[:libraries].blank?
+
+      generate("rails_icons:sync", *attributes)
+    end
+
+    private
+
+    def attributes = ["--libraries=#{options[:libraries].join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+  end
+end

data/lib/generators/rails_icons/sync/engine.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module RailsIcons
+  module Sync
+    class Engine < Rails::Generators::Base
+      def initialize(temp_icons_directory, library)
+        super
+
+        @temp_directory, @library = File.join(temp_icons_directory, library[:name]), library
+      end
+
+      def sync
+        clone
+        filter_variants_from_directory
+        remove_non_svg_files
+      rescue => error
+        say "[Rails Icons] Failed to sync icons: #{error.message}", :red
+
+        post_error_clean_up
+
+        raise
+      end
+
+      private
+
+      def clone
+        raise "[Rails Icons] Failed to clone repository" unless system("git clone '#{@library[:url]}' '#{@temp_directory}'")
+
+        say "#{@library[:name]} repository cloned successfully."
+      end
+
+      def filter_variants_from_directory
+        original_set_list = Dir.children(@temp_directory)
+
+        @library[:variants].each do |variant_name, variant_source_path|
+          source = File.join(@temp_directory, variant_source_path)
+          destination = File.join(@temp_directory, variant_name.to_s)
+
+          # Whitelist variant directory if present in original_set_list to prevent deletion
+          original_set_list.delete(variant_name.to_s)
+
+          raise "[Rails Icons] Failed to find the icons directory: '#{source}'" unless Dir.exist?(source)
+
+          move_icons(source, destination)
+        end
+
+        remove_files_and_folders(original_set_list)
+
+        say "[Rails Icons] Icon variants filtered successfully"
+      end
+
+      def remove_non_svg_files
+        Pathname.glob("#{@temp_directory}/**/*")
+          .select { |p| p.file? && p.extname != ".svg" }
+          .each(&:delete)
+
+        say "[Rails Icons] Non-SVG files removed successfully"
+      end
+
+      def post_error_clean_up
+        if yes?("Do you want to remove the temp files? ('#{@temp_directory}')")
+          say "[Rails Icons] Cleaning up…"
+
+          FileUtils.rm_rf(@temp_directory)
+        else
+          say "[Rails Icons] Keeping files at: '#{@temp_directory}'"
+        end
+      end
+
+      def move_icons(source, destination)
+        FileUtils.mkdir_p(destination)
+
+        Dir.children(source).each do |item|
+          FileUtils.mv(File.join(source, item), destination)
+        end
+      end
+
+      def remove_files_and_folders(paths)
+        paths.each do |path|
+          FileUtils.rm_rf(File.join(@temp_directory, path))
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_icons/sync_generator.rb

@@ -1,51 +1,59 @@
+# frozen_string_literal: true
+
 require "fileutils"
+require_relative "sync/engine"
 
 module RailsIcons
   class SyncGenerator < Rails::Generators::Base
-    ICON_VAULT_REPO_URL = "https://github.com/Rails-Designer/rails_icons_vault.git".freeze
-
-    argument :libraries, type: :array, default: [], banner: "heroicons lucide"
-
-    class_option :destination, type: :string, default: nil, desc: "Custom destination folder for icons (default: `app/assets/svg/icons/`)"
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
+    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
 
-    desc "Sync a specified icon set(s) from the Rails Icons Vault (https://github.com/Rails-Designer/rails_icons_vault)"
+    desc "Sync an icon library(s) from their respective git repos."
     source_root File.expand_path("templates", __dir__)
 
     def sync_icons
-      icons_dir = options[:destination] || Rails.root.join("app/assets/svg/icons")
-      tmp_dir = Rails.root.join("tmp/icons")
+      raise "[Rails Icons] Not a valid library" if options[:libraries].empty?
+
+      clean_temp_directory
+
+      options[:libraries].each { |library| sync(library) }
+
+      clean_temp_directory
+    end
+
+    private
 
-      FileUtils.rm_rf(tmp_dir) if Dir.exist?(tmp_dir)
-      FileUtils.mkdir_p(tmp_dir)
+    def clean_temp_directory
+      FileUtils.rm_rf(temp_directory) if Dir.exist?(temp_directory)
+    end
 
-      if system("git clone '#{ICON_VAULT_REPO_URL}' '#{tmp_dir}'")
-        say "Repository cloned successfully.", :green
-      else
-        say "Failed to clone repository.", :red
+    def sync(name)
+      library = RailsIcons::Libraries.all.fetch(name.to_sym)
+      library_path = File.join(temp_directory, library[:name])
 
-        exit 1
-      end
+      Sync::Engine.new(temp_directory, library).sync
 
-      libraries.each do |set|
-        set_path = File.join(tmp_dir, "icons", set)
+      raise_library_not_found(name) unless Dir.exist?(library_path)
+      copy_library(library[:name], library_path)
+    end
 
-        if Dir.exist?(set_path)
-          destination_path = File.join(icons_dir, set)
+    def temp_directory
+      Rails.root.join("tmp/icons")
+    end
 
-          FileUtils.mkdir_p(destination_path)
-          FileUtils.cp_r(Dir.glob("#{set_path}/*"), destination_path)
+    def copy_library(library, source)
+      destination = File.join(options[:destination], library)
 
-          say "Synced `#{set}` icons for set", :green
-        else
-          say "Icon set `#{set}` not found", :red
+      FileUtils.mkdir_p(destination)
 
-          exit 1
-        end
-      end
+      FileUtils.cp_r(Dir.glob("#{source}/*"), destination)
 
-      FileUtils.rm_rf(tmp_dir)
+      say "[Rails Icons] Synced '#{library}' library successfully #{%w[😃 🎉 ✨].sample}", :green
+    end
 
-      say "Icons synced successfully", :green
+    def raise_library_not_found(library)
+      say "[Rails Icons] Could not find '#{library}' library 🤷", :red
+      exit 1
     end
   end
 end

data/lib/generators/rails_icons/templates/initializer.rb.tt

@@ -1,18 +1,2 @@
 RailsIcons.configure do |config|
-  # Set the default set for the library
-  config.default_library = "heroicons" # https://heroicons.com/
-  config.default_set = "outline" # other sets for Heroicons are: solid, mini, micro
-
-  config.libraries.heroicons.solid.default.css = "w-6 h-6"
-  config.libraries.heroicons.solid.default.data = {}
-
-  config.libraries.heroicons.outline.default.css = "w-6 h-6"
-  config.libraries.heroicons.outline.default.stroke_width = "1.5"
-  config.libraries.heroicons.outline.default.data = {}
-
-  config.libraries.heroicons.mini.default.css = "w-5 h-5"
-  config.libraries.heroicons.mini.default.data = {}
-
-  config.libraries.heroicons.micro.default.css = "w-4 h-4"
-  config.libraries.heroicons.micro.default.data = {}
 end

data/lib/rails_icons/configuration/animated.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    class Animated
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default = default_options
+        end
+      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/configuration/feather.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    class Feather
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = nil
+
+          options.default = default_options
+        end
+      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/heroicons.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    class Heroicons
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+
+          setup_outline_config(options)
+          setup_solid_config(options)
+          setup_mini_config(options)
+          setup_micro_config(options)
+        end
+      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/lucide.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    class Lucide
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+
+          setup_outline_config(options)
+        end
+      end
+
+      private
+
+      def setup_outline_config(options)
+        options.outline = ActiveSupport::OrderedOptions.new
+        options.outline.default = default_outline_options
+      end
+
+      def default_outline_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = "1.5"
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/tabler.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    class Tabler
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+
+          setup_outline_config(options)
+          setup_filled_config(options)
+        end
+      end
+
+      private
+
+      def setup_outline_config(options)
+        options.outline = ActiveSupport::OrderedOptions.new
+        options.outline.default = default_outline_options
+      end
+
+      def setup_filled_config(options)
+        options.filled = ActiveSupport::OrderedOptions.new
+        options.filled.default = default_filled_options
+      end
+
+      def default_outline_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = 2
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_filled_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration.rb

@@ -1,6 +1,20 @@
 # frozen_string_literal: true
 
+require_relative "configuration/animated"
+require_relative "configuration/feather"
+require_relative "configuration/heroicons"
+require_relative "configuration/lucide"
+require_relative "configuration/tabler"
+
 module RailsIcons
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   class Configuration
     def initialize
       @config = ActiveSupport::OrderedOptions.new
@@ -24,51 +38,17 @@ module RailsIcons
     private
 
     def set_default_config
-      @config.helper_name = "icon"
-      @config.default_library = "heroicons"
-      @config.default_set = "outline"
+      @config.default_library = nil
     end
 
     def set_libraries_config
       @config.libraries = ActiveSupport::OrderedOptions.new
 
-      heroicons_config
-      lucide_config
-    end
-
-    def heroicons_config
-      @config.libraries.heroicons = ActiveSupport::OrderedOptions.new
-
-      @config.libraries.heroicons.solid = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.solid.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.solid.default.css = "w-6 h-6"
-      @config.libraries.heroicons.solid.default.data = {}
-
-      @config.libraries.heroicons.outline = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.outline.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.outline.default.stroke_width = 1.5
-      @config.libraries.heroicons.outline.default.css = "w-6 h-6"
-      @config.libraries.heroicons.outline.default.data = {}
-
-      @config.libraries.heroicons.mini = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.mini.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.mini.default.css = "w-5 h-5"
-      @config.libraries.heroicons.mini.default.data = {}
-
-      @config.libraries.heroicons.micro = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.micro.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.micro.default.css = "w-4 h-4"
-      @config.libraries.heroicons.micro.default.data = {}
-    end
-
-    def lucide_config
-      @config.libraries.lucide = ActiveSupport::OrderedOptions.new
-
-      @config.libraries.lucide.outline = ActiveSupport::OrderedOptions.new
-      @config.libraries.lucide.outline.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.lucide.outline.default.stroke_width = 2
-      @config.libraries.lucide.outline.default.css = "w-6 h-6"
-      @config.libraries.lucide.outline.default.data = {}
+      @config.libraries.animated = Configuration::Animated.new.config
+      @config.libraries.feather = Configuration::Feather.new.config
+      @config.libraries.heroicons = Configuration::Heroicons.new.config
+      @config.libraries.lucide = Configuration::Lucide.new.config
+      @config.libraries.tabler = Configuration::Tabler.new.config
     end
   end
 end

data/lib/rails_icons/helpers/icon_helper.rb

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

data/lib/rails_icons/icon/attributes.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RailsIcons
   class Icon
     class Attributes
-      def initialize(default_attributes: {}, args: {})
-        @merged_attributes = default_attributes.merge(args)
+      def initialize(default_attributes: {}, arguments: {})
+        @merged_attributes = default_attributes.merge(arguments)
       end
 
       def attach(to:)

data/lib/rails_icons/icon.rb

@@ -1,82 +1,88 @@
 require "rails_icons/icon/attributes"
 
 class RailsIcons::Icon
-  def initialize(name:, library:, set:, args:)
+  def initialize(name:, library:, arguments:, variant: nil)
     @name = name
-    @library = library.to_s
-    @set = set
-    @args = args
+    @library = library.to_s.inquiry
+    @variant = (variant || set_variant).to_s
+    @arguments = arguments
   end
 
   def svg
     raise RailsIcons::NotFound, error_message unless File.exist?(file_path)
 
-    svg_file = Nokogiri::HTML::DocumentFragment.parse(File.read(file_path)).at_css("svg")
-
-    attach_attributes to: svg_file
-
-    svg_file.to_html.html_safe
+    Nokogiri::HTML::DocumentFragment.parse(File.read(file_path))
+      .at_css("svg")
+      .tap { |svg| attach_attributes(to: svg) }
+      .to_html
+      .html_safe
   end
 
   private
 
-  def error_message
-    "Icon not found: `#{@library} / #{set} / #{@name}`"
+  def set_variant
+    RailsIcons.configuration.default_variant.presence ||
+      RailsIcons.configuration.libraries.dig(@library.to_sym, :default_variant)
   end
 
-  def file_path
-    custom_library.dig("path") ||
-      Rails.root.join("app", "assets", "svg", "icons", @library, set, "#{@name}.svg")
+  def error_message
+    attributes = [
+      @library,
+      @variant,
+      @name
+    ].compact_blank
+
+    "Icon not found: `#{attributes.join(" / ")}`"
   end
 
-  def custom_library?
-    custom_library.present?
+  def file_path
+    return RailsIcons::Engine.root.join("app", "assets", "svg", "rails_icons", "icons", "animated", "#{@name}.svg") if @library.animated?
+    return Rails.root.join(custom_library.dig(:path), "#{@name}.svg") if custom_library?
+
+    parts = [
+      "app",
+      "assets",
+      "svg",
+      "icons",
+      @library,
+      @variant,
+      "#{@name}.svg"
+    ].compact_blank!
+
+    Rails.root.join(*parts)
   end
 
   def attach_attributes(to:)
     RailsIcons::Icon::Attributes
-      .new(default_attributes: default_attributes, args: @args)
+      .new(default_attributes: default_attributes, arguments: @arguments)
       .attach(to: to)
   end
 
   def default_attributes
     {
-      "stroke-width": default_stroke_width,
-      class: default_css,
-      data: default_data
+      "stroke-width": default(:stroke_width),
+      data: default(:data),
+      class: default(:css)
     }
   end
 
-  def set
-    return @set if @set.present?
-
-    RailsIcons.configuration.default_set
-  end
+  def default(key) = library_attributes.dig(:default, key)
 
-  def default_css
-    library_set_attributes.dig(:default, :css)
-  end
-
-  def default_data
-    library_set_attributes.dig(:default, :data)
-  end
-
-  def default_stroke_width
-    library_set_attributes.dig(:default, :stroke_width)
-  end
-
-  def library_set_attributes
-    return custom_library || {} if custom_library?
-
-    RailsIcons.configuration.libraries.dig(@library, set) || {}
+  def library_attributes
+    custom_library? ? custom_library : RailsIcons.configuration.libraries.dig(@library, @variant) || {}
   end
 
   def custom_library
     RailsIcons
       .configuration
       .libraries
-      .dig("custom")
-      &.with_indifferent_access
-      &.dig(@library, set) || {}
+      &.dig("custom")
+      &.dig(@library.to_sym)&.with_defaults(
+        {
+          path: "app/assets/svg/icons/#{@library}"
+        }
+      ) || {}
   end
+
+  def custom_library? = custom_library.present?
 end

data/lib/rails_icons/libraries.rb

@@ -0,0 +1,45 @@
+module RailsIcons
+  module Libraries
+    module_function
+
+    def all
+      {
+        feather: {
+          name: "feather",
+          url: "https://github.com/feathericons/feather.git",
+          variants: {
+            ".": "icons" # Feather has no variants, store in the top directory
+          }
+        },
+
+        heroicons: {
+          name: "heroicons",
+          url: "https://github.com/tailwindlabs/heroicons.git",
+          variants: {
+            outline: "optimized/24/outline",
+            solid: "optimized/24/solid",
+            mini: "optimized/20/solid",
+            micro: "optimized/16/solid"
+          }
+        },
+
+        lucide: {
+          name: "lucide",
+          url: "https://github.com/lucide-icons/lucide.git",
+          variants: {
+            outline: "icons"
+          }
+        },
+
+        tabler: {
+          name: "tabler",
+          url: "https://github.com/tabler/tabler-icons.git",
+          variants: {
+            filled: "icons/filled",
+            outline: "icons/outline"
+          }
+        }
+      }
+    end
+  end
+end

data/lib/rails_icons/railtie.rb

@@ -9,5 +9,11 @@ module RailsIcons
         include RailsIcons::Helpers::IconHelper
       end
     end
+
+    initializer "rails_icons.assets" do |app|
+      gem_root = Pathname.new(Gem.loaded_specs["rails_icons"].gem_dir)
+
+      app.config.assets.paths << gem_root.join("app", "assets", "svg")
+    end
   end
 end

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/rails_icons.rb

@@ -1,22 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "rails_icons/version"
-require_relative "rails_icons/engine"
 require_relative "rails_icons/configuration"
+require_relative "rails_icons/engine"
 require_relative "rails_icons/errors"
 require_relative "rails_icons/railtie"
+require_relative "rails_icons/libraries"
 require_relative "rails_icons/icon"
 
 module RailsIcons
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.icons_directory
-    File.join("lib", "assets", "rails_icons")
-  end
 end

data/rails_icons.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Rails Designer Developers"]
   spec.email = ["devs@railsdesigner.com"]
 
-  spec.summary = "Add icons from multiple icons in your Rails app"
-  spec.description = "Add SVG icons from multiple libraries, or your own custom icon set with this one gem."
+  spec.summary = "Add any icon library to a Rails app"
+  spec.description = "Add any icon library to a Rails app, from Heroicons, to Lucide to Tabler (and others). Rails Icons is library-agnostic, so you can add any library while using the same interface."
   spec.homepage = "https://railsdesigner.com/rails-icons/"
   spec.license = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir["{bin,app,config,db,lib,public}/**/*", "Rakefile", "README.md", "rails_icons.gemspec", "Gemfile", "Gemfile.lock"]
 
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.required_ruby_version = ">= 3.1.0"
   spec.add_dependency "rails", "> 6.1"
   spec.add_runtime_dependency "nokogiri", "~> 1.16", ">= 1.16.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,8 +44,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.4
-description: Add SVG icons from multiple libraries, or your own custom icon set with
-  this one gem.
+description: Add any icon library to a Rails app, from Heroicons, to Lucide to Tabler
+  (and others). Rails Icons is library-agnostic, so you can add any library while
+  using the same interface.
 email:
 - devs@railsdesigner.com
 executables: []
@@ -56,20 +57,32 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- app/assets/svg/rails_icons/icons/animated/bouncing-dots.svg
+- app/assets/svg/rails_icons/icons/animated/faded-spinner.svg
+- app/assets/svg/rails_icons/icons/animated/fading-dots.svg
+- app/assets/svg/rails_icons/icons/animated/trailing-spinner.svg
 - bin/console
 - bin/rails
 - bin/release
 - bin/setup
 - lib/generators/rails_icons/initializer_generator.rb
+- lib/generators/rails_icons/install_generator.rb
+- lib/generators/rails_icons/sync/engine.rb
 - lib/generators/rails_icons/sync_generator.rb
 - lib/generators/rails_icons/templates/initializer.rb.tt
 - lib/rails_icons.rb
 - lib/rails_icons/configuration.rb
+- lib/rails_icons/configuration/animated.rb
+- lib/rails_icons/configuration/feather.rb
+- lib/rails_icons/configuration/heroicons.rb
+- lib/rails_icons/configuration/lucide.rb
+- lib/rails_icons/configuration/tabler.rb
 - lib/rails_icons/engine.rb
 - lib/rails_icons/errors.rb
 - lib/rails_icons/helpers/icon_helper.rb
 - lib/rails_icons/icon.rb
 - lib/rails_icons/icon/attributes.rb
+- lib/rails_icons/libraries.rb
 - lib/rails_icons/railtie.rb
 - lib/rails_icons/version.rb
 - rails_icons.gemspec
@@ -87,15 +100,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: Add icons from multiple icons in your Rails app
+summary: Add any icon library to a Rails app
 test_files: []