rails_icons 0.4.0 → 1.1.0

data/lib/rails_icons/libraries.rb

@@ -0,0 +1,24 @@
+require_relative "configuration/animated"
+require_relative "configuration/boxicons"
+require_relative "configuration/feather"
+require_relative "configuration/heroicons"
+require_relative "configuration/lucide"
+require_relative "configuration/phosphor"
+require_relative "configuration/radix"
+require_relative "configuration/tabler"
+
+module RailsIcons
+  extend self
+
+  def libraries
+    {
+      boxicons: RailsIcons::Configuration::Boxicons,
+      feather: RailsIcons::Configuration::Feather,
+      heroicons: RailsIcons::Configuration::Heroicons,
+      lucide: RailsIcons::Configuration::Lucide,
+      phosphor: RailsIcons::Configuration::Phosphor,
+      radix: RailsIcons::Configuration::Radix,
+      tabler: RailsIcons::Configuration::Tabler
+    }
+  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/sync/engine.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "rails_icons/sync/process_variants"
+
+module RailsIcons
+  module Sync
+    class Engine < Rails::Generators::Base
+      def initialize(name)
+        super
+
+        raise "[Rails Icons] Not a valid library" if RailsIcons.libraries.keys.exclude?(name.to_sym)
+
+        @temp_directory, @name, @library = File.join(TEMP_DIRECTORY, name), name, RailsIcons.libraries.fetch(name.to_sym).source
+      end
+
+      def sync
+        clone_repository
+        process_variants
+        remove_non_svg_files
+
+        move_library
+
+        purge_temp_directory
+      rescue => error
+        say "[Rails Icons] Failed to sync icons: #{error.message}", :red
+
+        post_error_clean_up
+
+        raise
+      end
+
+      private
+
+      TEMP_DIRECTORY = Rails.root.join("tmp/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."
+      end
+
+      def process_variants = Sync::ProcessVariants.new(@temp_directory, @name, @library).process
+
+      def remove_non_svg_files
+        Pathname.glob("#{@temp_directory}/**/*")
+          .select { _1.file? && _1.extname != ".svg" }
+          .each(&:delete)
+
+        say "[Rails Icons] Non-SVG files removed successfully"
+      end
+
+      def move_library
+        destination = File.join(RailsIcons.configuration.destination_path, @name)
+
+        FileUtils.mkdir_p(destination)
+        FileUtils.mv(Dir.glob("#{@temp_directory}/*"), destination, force: true)
+
+        say "[Rails Icons] Synced '#{@name}' library successfully #{%w[😃 🎉 ✨].sample}", :green
+      end
+
+      def purge_temp_directory = FileUtils.rm_rf(TEMP_DIRECTORY)
+
+      def post_error_clean_up
+        if yes?("Do you want to remove the temp files? ('#{@temp_directory}') [y/n]")
+          say "[Rails Icons] Cleaning up…"
+
+          FileUtils.rm_rf(@temp_directory)
+        else
+          say "[Rails Icons] Keeping files at: '#{@temp_directory}'"
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/sync/process_variants.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "rails_icons/sync/transformations"
+
+module RailsIcons
+  module Sync
+    class ProcessVariants < Rails::Generators::Base
+      def initialize(temp_directory, name, library)
+        @temp_directory, @name, @library = temp_directory, name, library
+      end
+
+      def process
+        original_variants = 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)
+
+          original_variants.delete(variant_name.to_s)
+
+          raise "[Rails Icons] Failed to find the icons directory: '#{source}'" unless Dir.exist?(source)
+
+          move_icons(source, destination)
+
+          apply_transformations_to(destination)
+        end
+
+        remove_files_and_folders(original_variants)
+
+        say "[Rails Icons] Icon variants processed successfully"
+      end
+
+      private
+
+      def move_icons(source, destination)
+        FileUtils.mkdir_p(destination)
+
+        Dir.each_child(source).each do |item|
+          FileUtils.mv(File.join(source, item), destination)
+        end
+      end
+
+      def apply_transformations_to(destination)
+        Dir.each_child(destination) do |filename|
+          File.rename(
+            File.join(destination, filename),
+            File.join(destination, Sync::Transformations.transform(filename, transformations.fetch(:filenames, {})))
+          )
+        end
+      end
+
+      def remove_files_and_folders(paths)
+        paths.each do |path|
+          FileUtils.rm_rf(File.join(@temp_directory, path))
+        end
+      end
+
+      def transformations
+        RailsIcons.libraries.dig(@name.to_sym)&.try(:transformations) || {}
+      end
+    end
+  end
+end

data/lib/rails_icons/sync/transformations.rb

@@ -0,0 +1,27 @@
+module RailsIcons
+  module Sync
+    class Transformations < Rails::Generators::Base
+      def self.transform(filename, rules = {})
+        basename = File.basename(filename, File.extname(filename))
+
+        transformed = rules.reduce(basename) do |fn, (type, value)|
+          TRANSFORMERS.fetch(type).call(fn, value)
+        end
+
+        [transformed, File.extname(filename)].join
+      end
+
+      private
+
+      TRANSFORMERS = {
+        delete_prefix: ->(filename, prefixes) {
+          Array(prefixes).reduce(filename) { _1.delete_prefix(_2) }
+        },
+
+        delete_suffix: ->(filename, suffixes) {
+          Array(suffixes).reduce(filename) { _1.delete_suffix(_2) }
+        }
+      }
+    end
+  end
+end

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "0.4.0"
+  VERSION = "1.1.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/libraries"
 require_relative "rails_icons/configuration"
+require_relative "rails_icons/engine"
 require_relative "rails_icons/errors"
 require_relative "rails_icons/railtie"
 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.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2025-01-13 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,24 +57,39 @@ 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_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/boxicons.rb
+- lib/rails_icons/configuration/feather.rb
+- lib/rails_icons/configuration/heroicons.rb
+- lib/rails_icons/configuration/lucide.rb
+- lib/rails_icons/configuration/phosphor.rb
+- lib/rails_icons/configuration/radix.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/icon_configs/heroicons_config.rb
-- lib/rails_icons/icon_configs/lucide_config.rb
-- lib/rails_icons/icon_configs/tabler_config.rb
+- lib/rails_icons/icon/file_path.rb
+- lib/rails_icons/libraries.rb
 - lib/rails_icons/railtie.rb
+- lib/rails_icons/sync/engine.rb
+- lib/rails_icons/sync/process_variants.rb
+- lib/rails_icons/sync/transformations.rb
 - lib/rails_icons/version.rb
 - rails_icons.gemspec
 homepage: https://railsdesigner.com/rails-icons/
@@ -90,15 +106,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.21
+rubygems_version: 3.3.7
 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: []

data/lib/rails_icons/icon_configs/heroicons_config.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module RailsIcons
-  # Defines the configuration options for the heroicons icon pack
-  class HeroiconsConfig
-    def config
-      options = ActiveSupport::OrderedOptions.new
-      setup_heroicons_outline_config(options)
-      setup_heroicons_solid_config(options)
-      setup_heroicons_mini_config(options)
-      setup_heroicons_micro_config(options)
-      options
-    end
-
-    private
-
-    def setup_heroicons_solid_config(options)
-      options.solid = ActiveSupport::OrderedOptions.new
-      options.solid.default = default_solid_options
-    end
-
-    def setup_heroicons_outline_config(options)
-      options.outline = ActiveSupport::OrderedOptions.new
-      options.outline.default = default_outline_options
-    end
-
-    def setup_heroicons_mini_config(options)
-      options.mini = ActiveSupport::OrderedOptions.new
-      options.mini.default = default_mini_options
-    end
-
-    def setup_heroicons_micro_config(options)
-      options.micro = ActiveSupport::OrderedOptions.new
-      options.micro.default = default_micro_options
-    end
-
-    def default_solid_options
-      options = ActiveSupport::OrderedOptions.new
-      options.css = "w-6 h-6"
-      options.data = {}
-      options
-    end
-
-    def default_outline_options
-      options = ActiveSupport::OrderedOptions.new
-      options.stroke_width = 1.5
-      options.css = "w-6 h-6"
-      options.data = {}
-      options
-    end
-
-    def default_mini_options
-      options = ActiveSupport::OrderedOptions.new
-      options.css = "w-5 h-5"
-      options.data = {}
-      options
-    end
-
-    def default_micro_options
-      options = ActiveSupport::OrderedOptions.new
-      options.css = "w-4 h-4"
-      options.data = {}
-      options
-    end
-  end
-end

data/lib/rails_icons/icon_configs/lucide_config.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module RailsIcons
-  # Defines the configuration options for the Lucide icon pack
-  class LucideConfig
-    def config
-      options = ActiveSupport::OrderedOptions.new
-      setup_lucide_outlined_config(options)
-
-      options
-    end
-
-    private
-
-    def setup_lucide_outlined_config(options)
-      options.outline = ActiveSupport::OrderedOptions.new
-      options.outline.default = default_outlined_options
-    end
-
-    def default_outlined_options
-      options = ActiveSupport::OrderedOptions.new
-      options.stroke_width = "1.5"
-      options.css = "w-6 h-6"
-      options.data = {}
-      options
-    end
-  end
-end

data/lib/rails_icons/icon_configs/tabler_config.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module RailsIcons
-  # Defines the configuration options for the Tabler icon pack
-  class TablerConfig
-    def config
-      options = ActiveSupport::OrderedOptions.new
-      setup_tabler_filled_config(options)
-      setup_tabler_outline_config(options)
-
-      options
-    end
-
-    private
-
-    def setup_tabler_filled_config(options)
-      options.filled = ActiveSupport::OrderedOptions.new
-      options.filled.default = default_filled_options
-    end
-
-    def setup_tabler_outline_config(options)
-      options.outline = ActiveSupport::OrderedOptions.new
-      options.outline.default = default_outline_options
-    end
-
-    def default_filled_options
-      options = ActiveSupport::OrderedOptions.new
-      options.css = "w-6 h-6"
-      options.data = {}
-      options
-    end
-
-    def default_outline_options
-      options = ActiveSupport::OrderedOptions.new
-      options.stroke_width = 2
-      options.css = "w-6 h-6"
-      options.data = {}
-      options
-    end
-  end
-end