rails_icons 1.0.0 → 1.2.0

data/lib/rails_icons/configuration/linear.rb

@@ -0,0 +1,48 @@
+# 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.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

@@ -2,15 +2,38 @@
 
 module RailsIcons
   class Configuration
-    class Lucide
+    module Lucide
+      extend self
+
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :outline
+          options.exclude_variants = []
 
           setup_outline_config(options)
         end
       end
 
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Lucide defaults
+          # 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 = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/lucide-icons/lucide.git",
+          variants: {
+            outline: "icons"
+          }
+        }
+      end
+
       private
 
       def setup_outline_config(options)

data/lib/rails_icons/configuration/phosphor.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Phosphor
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :regular
+          options.exclude_variants = []
+
+          setup_bold_config(options)
+          setup_duotone_config(options)
+          setup_fill_config(options)
+          setup_light_config(options)
+          setup_regular_config(options)
+          setup_thin_config(options)
+        end
+      end
+
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Phosphor defaults
+          # config.libraries.phosphor.exclude_variants = [:duotone, :thin] # Exclude specific variants
+
+          # config.libraries.phosphor.bold.default.css = "size-6"
+          # config.libraries.phosphor.bold.default.data = {}
+
+          # config.libraries.phosphor.duotone.default.css = "size-6"
+          # config.libraries.phosphor.duotone.default.data = {}
+
+          # config.libraries.phosphor.fill.default.css = "size-6"
+          # config.libraries.phosphor.fill.default.data = {}
+
+          # config.libraries.phosphor.light.default.css = "size-6"
+          # config.libraries.phosphor.light.default.data = {}
+
+          # config.libraries.phosphor.regular.default.css = "size-6"
+          # config.libraries.phosphor.regular.default.data = {}
+
+          # config.libraries.phosphor.thin.default.css = "size-6"
+          # config.libraries.phosphor.thin.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/phosphor-icons/core.git",
+          variants: {
+            bold: "raw/bold",
+            duotone: "raw/duotone",
+            fill: "raw/fill",
+            light: "raw/light",
+            regular: "raw/regular",
+            thin: "raw/thin"
+          }
+        }
+      end
+
+      def transformations
+        {
+          filenames: {
+            delete_suffix: ["-bold", "-duotone", "-fill", "-light", "-thin"]
+          }
+        }
+      end
+
+      private
+
+      def setup_bold_config(options)
+        options.bold = ActiveSupport::OrderedOptions.new
+        options.bold.default = default_bold_options
+      end
+
+      def setup_duotone_config(options)
+        options.duotone = ActiveSupport::OrderedOptions.new
+        options.duotone.default = default_duotone_options
+      end
+
+      def setup_fill_config(options)
+        options.fill = ActiveSupport::OrderedOptions.new
+        options.fill.default = default_fill_options
+      end
+
+      def setup_light_config(options)
+        options.light = ActiveSupport::OrderedOptions.new
+        options.light.default = default_light_options
+      end
+
+      def setup_regular_config(options)
+        options.regular = ActiveSupport::OrderedOptions.new
+        options.regular.default = default_regular_options
+      end
+
+      def setup_thin_config(options)
+        options.thin = ActiveSupport::OrderedOptions.new
+        options.thin.default = default_thin_options
+      end
+
+      def default_bold_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_duotone_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_fill_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_light_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_regular_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_thin_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/radix.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Radix
+      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 Radix defaults
+          # 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 = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/radix-ui/icons.git",
+          variants: {
+            ".": "packages/radix-icons/icons" # Radix has no variants, store in the top directory
+          }
+        }
+      end
+
+      private
+
+      def default_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-4"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/sidekickicons.rb

@@ -0,0 +1,104 @@
+# 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.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

@@ -2,16 +2,44 @@
 
 module RailsIcons
   class Configuration
-    class Tabler
+    module Tabler
+      extend self
+
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default_variant = :outline
+          options.exclude_variants = []
 
           setup_outline_config(options)
           setup_filled_config(options)
         end
       end
 
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Tabler defaults
+          # 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 = {}
+
+          # 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 source
+        {
+          url: "https://github.com/tabler/tabler-icons.git",
+          variants: {
+            filled: "icons/filled",
+            outline: "icons/outline"
+          }
+        }
+      end
+
       private
 
       def setup_outline_config(options)

data/lib/rails_icons/configuration/weather.rb

@@ -0,0 +1,54 @@
+# 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.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/configuration.rb

@@ -1,11 +1,5 @@
 # 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
@@ -39,16 +33,15 @@ module RailsIcons
 
     def set_default_config
       @config.default_library = nil
+      @config.destination_path = "app/assets/svg/icons"
     end
 
     def set_libraries_config
       @config.libraries = ActiveSupport::OrderedOptions.new
 
-      @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
+      RailsIcons.libraries.each { |name, library| @config.libraries[name] = library.config }
+
+      @config.libraries.animated = Configuration::Animated.config
     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/icon/attributes.rb

@@ -9,7 +9,9 @@ module RailsIcons
 
       def attach(to:)
         @merged_attributes.each do |key, value|
-          if value.is_a?(Hash)
+          if key == :class
+            class_attribute(key, value, to)
+          elsif value.is_a?(Hash)
             hash_attributes(key, value, to)
           else
             string_attributes(key, value, to)
@@ -19,6 +21,10 @@ module RailsIcons
 
       private
 
+      def class_attribute(_, value, to)
+        to[:class] = ActionController::Base.helpers.token_list(value)
+      end
+
       def hash_attributes(key, value, to)
         value.each do |nested_key, nested_value|
           nested_attribute_name = format_attribute_name("#{key}-#{nested_key}")

data/lib/rails_icons/icon/file_path.rb

@@ -0,0 +1,57 @@
+module RailsIcons
+  class Icon
+    class FilePath
+      def initialize(name:, library:, variant:)
+        @name = name
+        @library = library
+        @variant = variant
+      end
+
+      def call
+        return animated_icons_path if @library.animated?
+        return custom_library_path if @library.custom?
+
+        icon_path = icons_path_in_app || icons_path_in_engines
+
+        raise RailsIcons::IconNotFound if icon_path.nil?
+
+        icon_path
+      end
+
+      private
+
+      def animated_icons_path = RailsIcons::Engine.root.join("app", "assets", "svg", "rails_icons", "icons", "animated", "#{@name}.svg")
+
+      def custom_library_path = Rails.root.join(@library.custom_path, "#{@name}.svg")
+
+      def icons_path_in_app
+        path = app_path
+
+        path if File.exist?(path)
+      end
+
+      def icons_path_in_engines
+        path = nil
+
+        Rails::Engine.subclasses.find do |engine|
+          path = engine.root.join(*parts)
+
+          path if File.exist?(path)
+        end
+
+        path
+      end
+
+      def app_path = Rails.root.join(*parts)
+
+      def parts
+        [
+          RailsIcons.configuration.destination_path,
+          @library,
+          @variant,
+          "#{@name}.svg"
+        ].compact_blank!
+      end
+    end
+  end
+end

data/lib/rails_icons/icon.rb

@@ -1,3 +1,4 @@
+require "rails_icons/icon/file_path"
 require "rails_icons/icon/attributes"
 
 class RailsIcons::Icon
@@ -9,7 +10,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")
@@ -35,22 +36,7 @@ class RailsIcons::Icon
     "Icon not found: `#{attributes.join(" / ")}`"
   end
 
-  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 file_path = RailsIcons::Icon::FilePath.new(name: @name, library: @library, variant: @variant).call
 
   def attach_attributes(to:)
     RailsIcons::Icon::Attributes
@@ -79,7 +65,7 @@ class RailsIcons::Icon
       &.dig("custom")
       &.dig(@library.to_sym)&.with_defaults(
         {
-          path: "app/assets/svg/icons/#{@library}"
+          path: [RailsIcons.configuration.destination_path, @library].join("/")
         }
       ) || {}
   end