rails_icons 1.0.0 → 1.2.0

data/lib/rails_icons/libraries.rb

@@ -1,45 +1,32 @@
-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
-          }
-        },
+require_relative "configuration/animated"
+require_relative "configuration/boxicons"
+require_relative "configuration/feather"
+require_relative "configuration/flags"
+require_relative "configuration/heroicons"
+require_relative "configuration/linear"
+require_relative "configuration/lucide"
+require_relative "configuration/phosphor"
+require_relative "configuration/radix"
+require_relative "configuration/sidekickicons"
+require_relative "configuration/tabler"
+require_relative "configuration/weather"
 
-        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"
-          }
-        },
+module RailsIcons
+  extend self
 
-        tabler: {
-          name: "tabler",
-          url: "https://github.com/tabler/tabler-icons.git",
-          variants: {
-            filled: "icons/filled",
-            outline: "icons/outline"
-          }
-        }
-      }
-    end
+  def libraries
+    {
+      boxicons: RailsIcons::Configuration::Boxicons,
+      feather: RailsIcons::Configuration::Feather,
+      flags: RailsIcons::Configuration::Flags,
+      heroicons: RailsIcons::Configuration::Heroicons,
+      linear: RailsIcons::Configuration::Linear,
+      lucide: RailsIcons::Configuration::Lucide,
+      phosphor: RailsIcons::Configuration::Phosphor,
+      radix: RailsIcons::Configuration::Radix,
+      sidekickicons: RailsIcons::Configuration::Sidekickicons,
+      tabler: RailsIcons::Configuration::Tabler,
+      weather: RailsIcons::Configuration::Weather
+    }
   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/rails_icons").freeze
+
+      def clone_repository
+        raise "[Rails Icons] Failed to clone repository" unless system("git clone '#{@library[:url]}' '#{@temp_directory}'")
+
+        say "[Rails Icons] '#{@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,74 @@
+# 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)
+        excluded_variants = RailsIcons.configuration.libraries.dig(@name.to_sym)&.exclude_variants || []
+
+        @library[:variants].each do |variant_name, variant_source_path|
+          next if excluded_variants.include?(variant_name)
+
+          source = File.join(@temp_directory, variant_source_path)
+          destination = File.join(@temp_directory, variant_name.to_s)
+
+          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_for(original_variants)
+        remove_previously_downloaded(excluded_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_for(paths)
+        paths.each do |path|
+          FileUtils.rm_rf(File.join(@temp_directory, path))
+        end
+      end
+
+      def remove_previously_downloaded(variants)
+        variants.each do |variant|
+          FileUtils.rm_rf(File.join(RailsIcons.configuration.destination_path, @name, variant.to_s))
+        end
+      end
+
+      def transformations
+        RailsIcons.libraries.dig(@name.to_sym)&.try(:transformations) || {}
+      end
+    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 = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/rails_icons.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "rails_icons/version"
+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/libraries"
 require_relative "rails_icons/icon"
 
 module RailsIcons

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-07 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,23 +67,34 @@ files:
 - 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/base_generator.rb
 - lib/rails_icons/configuration.rb
 - lib/rails_icons/configuration/animated.rb
+- lib/rails_icons/configuration/boxicons.rb
 - lib/rails_icons/configuration/feather.rb
+- lib/rails_icons/configuration/flags.rb
 - lib/rails_icons/configuration/heroicons.rb
+- lib/rails_icons/configuration/linear.rb
 - lib/rails_icons/configuration/lucide.rb
+- lib/rails_icons/configuration/phosphor.rb
+- lib/rails_icons/configuration/radix.rb
+- lib/rails_icons/configuration/sidekickicons.rb
 - lib/rails_icons/configuration/tabler.rb
+- lib/rails_icons/configuration/weather.rb
 - lib/rails_icons/engine.rb
 - lib/rails_icons/errors.rb
 - lib/rails_icons/helpers/icon_helper.rb
 - lib/rails_icons/icon.rb
 - lib/rails_icons/icon/attributes.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/
@@ -107,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Add any icon library to a Rails app

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

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