rails_icons 0.4.0 → 1.1.0

data/lib/rails_icons/configuration/heroicons.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Heroicons
+      extend self
+
+      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
+
+      def initializer_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 source
+        {
+          url: "https://github.com/tailwindlabs/heroicons.git",
+          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/lucide.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Lucide
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+
+          setup_outline_config(options)
+        end
+      end
+
+      def initializer_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 source
+        {
+          url: "https://github.com/lucide-icons/lucide.git",
+          variants: {
+            outline: "icons"
+          }
+        }
+      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/phosphor.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Phosphor
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :regular
+
+          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.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,44 @@
+# 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.default = default_options
+        end
+      end
+
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Radix defaults
+          # 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/tabler.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Tabler
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :outline
+
+          setup_outline_config(options)
+          setup_filled_config(options)
+        end
+      end
+
+      def initializer_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 source
+        {
+          url: "https://github.com/tabler/tabler-icons.git",
+          variants: {
+            filled: "icons/filled",
+            outline: "icons/outline"
+          }
+        }
+      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,12 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "icon_configs/heroicons_config"
-require_relative "icon_configs/lucide_config"
-require_relative "icon_configs/tabler_config"
-
 module RailsIcons
-  # Configuration defines the available configuration options available for each of the icons sets
-  # as well as sets the defaults to heroicons
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   class Configuration
     def initialize
       @config = ActiveSupport::OrderedOptions.new
@@ -30,17 +32,16 @@ module RailsIcons
     private
 
     def set_default_config
-      @config.helper_name = "icon"
-      @config.default_library = "heroicons"
-      @config.default_set = "outline"
+      @config.default_library = nil
+      @config.destination_path = "app/assets/svg/icons"
     end
 
     def set_libraries_config
       @config.libraries = ActiveSupport::OrderedOptions.new
 
-      @config.libraries.heroicons = HeroiconsConfig.new.config
-      @config.libraries.lucide = LucideConfig.new.config
-      @config.libraries.tabler = TablerConfig.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/helpers/icon_helper.rb

@@ -4,14 +4,13 @@ require_relative "../configuration"
 
 module RailsIcons
   module Helpers
-    # Define the "icon" helper to generate and display icons
     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

@@ -3,13 +3,15 @@
 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:)
         @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::NotFound 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,82 +1,74 @@
+require "rails_icons/icon/file_path"
 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")
-  end
+  def error_message
+    attributes = [
+      @library,
+      @variant,
+      @name
+    ].compact_blank
 
-  def custom_library?
-    custom_library.present?
+    "Icon not found: `#{attributes.join(" / ")}`"
   end
 
+  def file_path = RailsIcons::Icon::FilePath.new(name: @name, library: @library, variant: @variant).call
+
   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_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?
+  def default(key) = library_attributes.dig(:default, key)
 
-    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: [RailsIcons.configuration.destination_path, @library].join("/")
+        }
+      ) || {}
   end
+
+  def custom_library? = custom_library.present?
 end