icons 0.0.2 → 0.6.0

data/lib/icons/icon/attributes.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Icons
+  class Icon
+    class Attributes
+      def initialize(default_attributes: {}, arguments: {})
+        @merged_attributes = default_attributes.merge(arguments)
+      end
+
+      def attach(to:)
+        @merged_attributes.each do |key, value|
+          if key == :class
+            class_attribute(key, value, to)
+          elsif value.is_a?(Hash)
+            hash_attributes(key, value, to)
+          else
+            string_attributes(key, value, to)
+          end
+        end
+      end
+
+      private
+
+      def class_attribute(_, value, to)
+        to[:class] = token_list(value)
+      end
+
+      def token_list(value)
+        case value
+        when Array
+          # Flatten and process each element
+          value.flatten.map { |v|
+            if v.is_a?(Hash)
+              v.select { |_, val| val }.keys.map(&:to_s).join(" ")
+            else
+              v.to_s
+            end
+          }.compact.reject(&:empty?).join(" ")
+        when Hash
+          # Handle both string and symbol keys, filter truthy values
+          value.select { |_, v| v }.keys.map(&:to_s).join(" ")
+        else
+          value.to_s
+        end
+      end
+
+      def hash_attributes(key, value, to)
+        value.each do |nested_key, nested_value|
+          nested_attribute_name = format_attribute_name("#{key}-#{nested_key}")
+
+          to[nested_attribute_name] = nested_value
+        end
+      end
+
+      def string_attributes(key, value, to)
+        normalized_key = format_attribute_name(key.to_s)
+
+        to[normalized_key] = value
+      end
+
+      def format_attribute_name(name)
+        name.tr("_", "-")
+      end
+    end
+  end
+end

data/lib/icons/icon/file_path.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Icons
+  class Icon
+    class FilePath
+      def initialize(name:, library:, variant:)
+        @name = name
+        @library = library.to_s
+        @variant = variant
+      end
+
+      def call
+        if animated_library?
+          path = animated_icons_path
+          raise Icons::IconNotFound if path.nil?
+          return path
+        end
+
+        return custom_library_path if custom_library?
+
+        icon_path = icons_path_in_app
+
+        raise Icons::IconNotFound if icon_path.nil?
+
+        icon_path
+      end
+
+      private
+
+      def animated_library?
+        @library == "animated"
+      end
+
+      def animated_icons_path
+        # Animated icons are bundled with the gem at lib/icons/assets/animated/
+        # __dir__ is lib/icons/icon, so go up one level to lib/icons
+        gem_icons_dir = Pathname.new(__dir__).join("..")
+        path = gem_icons_dir.join("assets", "animated", "#{@name}.svg")
+
+        File.exist?(path) ? path : nil
+      end
+
+      def custom_library?
+        Icons.libraries[@library.to_sym]&.respond_to?(:custom_path)
+      end
+
+      def custom_library_path
+        library_config = Icons.libraries[@library.to_sym]
+        Icons.config.base_path.join(library_config.custom_path, "#{@name}.svg")
+      end
+
+      def icons_path_in_app
+        path = app_path
+
+        path if File.exist?(path)
+      end
+
+      def app_path
+        Icons.config.base_path.join(*parts)
+      end
+
+      def parts
+        [
+          Icons.configuration.icons_path,
+          @library,
+          (@variant unless @variant == "."),  # Don't include "." as a directory
+          "#{@name}.svg"
+        ].compact.reject { |p| p.to_s.empty? }
+      end
+    end
+  end
+end

data/lib/icons/icon.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+require "icons/icon/file_path"
+require "icons/icon/attributes"
+
+class Icons::Icon
+  def initialize(name:, library:, arguments:, variant: nil)
+    @config = Icons.configuration
+
+    @name = name
+    @library = library.to_s
+    @variant = (variant || set_variant).to_s
+    @arguments = arguments
+  end
+
+  def svg
+    raise Icons::IconNotFound, error_message unless File.exist?(file_path)
+
+    Nokogiri::HTML::DocumentFragment.parse(File.read(file_path))
+      .at_css("svg")
+      .tap { |svg| attach_attributes(to: svg) }
+      .to_html
+  end
+
+  private
+
+  def set_variant
+    value = @config.libraries.dig(@library.to_sym, :default_variant) ||
+      @config.default_variant
+
+    value.to_s.empty? ? nil : value
+  end
+
+  def error_message
+    attributes = [
+      @library,
+      @variant,
+      @name
+    ].compact
+
+    "Icon not found: `#{attributes.join(" / ")}`"
+  end
+
+  def file_path
+    Icons::Icon::FilePath.new(name: @name, library: @library, variant: @variant).call
+  end
+
+  def attach_attributes(to:)
+    Icons::Icon::Attributes
+      .new(default_attributes: default_attributes, arguments: @arguments)
+      .attach(to: to)
+  end
+
+  def default_attributes
+    {
+      "stroke-width": default(:stroke_width),
+      data: default(:data),
+      class: default(:css)
+    }
+  end
+
+  def default(key)
+    library_attributes.dig(:default, key)
+  end
+
+  def library_attributes
+    keys = [@library, @variant].compact.reject { |k| k.to_s.empty? }
+    @config.libraries.dig(*keys) || {}
+  end
+end

data/lib/icons/libraries.rb

@@ -0,0 +1,32 @@
+require "icons/configuration/animated"
+require "icons/configuration/boxicons"
+require "icons/configuration/feather"
+require "icons/configuration/flags"
+require "icons/configuration/heroicons"
+require "icons/configuration/linear"
+require "icons/configuration/lucide"
+require "icons/configuration/phosphor"
+require "icons/configuration/radix"
+require "icons/configuration/sidekickicons"
+require "icons/configuration/tabler"
+require "icons/configuration/weather"
+
+module Icons
+  extend self
+
+  def libraries
+    {
+      boxicons: Icons::Configuration::Boxicons,
+      feather: Icons::Configuration::Feather,
+      flags: Icons::Configuration::Flags,
+      heroicons: Icons::Configuration::Heroicons,
+      linear: Icons::Configuration::Linear,
+      lucide: Icons::Configuration::Lucide,
+      phosphor: Icons::Configuration::Phosphor,
+      radix: Icons::Configuration::Radix,
+      sidekickicons: Icons::Configuration::Sidekickicons,
+      tabler: Icons::Configuration::Tabler,
+      weather: Icons::Configuration::Weather
+    }
+  end
+end

data/lib/icons/sync/process_variants.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "icons/sync/transformations"
+
+module Icons
+  class Sync
+    class ProcessVariants
+      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 = Icons.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 "[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)
+
+        puts "[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(Icons.configuration.icons_path, @name, variant.to_s))
+        end
+      end
+
+      def transformations
+        library_config = Icons.libraries.dig(@name.to_sym)
+
+        if library_config&.respond_to?(:transformations)
+          library_config.transformations
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/icons/sync/transformations.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Icons
+  class Sync
+    class Transformations
+      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) { |fn, prefix| fn.delete_prefix(prefix) }
+        },
+
+        delete_suffix: ->(filename, suffixes) {
+          Array(suffixes).reduce(filename) { |fn, suffix| fn.delete_suffix(suffix) }
+        }
+      }
+    end
+  end
+end

data/lib/icons/sync.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "icons/sync/process_variants"
+
+module Icons
+  class Sync
+    def initialize(name)
+      raise "[Icons] Not a valid library" if Icons.libraries.keys.exclude?(name.to_sym)
+
+      @name = name
+      @library = Icons.libraries.fetch(name.to_sym).source
+      @temp_directory = File.join(temp_directory_root, name)
+    end
+
+    def now
+      clone_repository
+      process_variants
+      remove_non_svg_files
+
+      move_library
+
+      purge_temp_directory
+    rescue => error
+      puts "[Icons] Failed to sync icons: #{error.message}"
+
+      post_error_clean_up
+
+      raise
+    end
+
+    private
+
+    def temp_directory_root
+      Icons.config.base_path.join("tmp/icons")
+    end
+
+    def clone_repository
+      raise "[Icons] Failed to clone repository" unless system("git clone '#{@library[:url]}' '#{@temp_directory}'")
+
+      puts "[Icons] '#{@name}' repository cloned"
+    end
+
+    def process_variants
+      Sync::ProcessVariants.new(@temp_directory, @name, @library).process
+    end
+
+    def remove_non_svg_files
+      require "pathname"
+
+      Pathname.glob("#{@temp_directory}/**/*")
+        .select { |path| path.file? && path.extname != ".svg" }
+        .each(&:delete)
+
+      puts "[Icons] Non-SVG files removed"
+    end
+
+    def move_library
+      destination = File.join(Icons.configuration.icons_path, @name)
+
+      FileUtils.mkdir_p(destination)
+      FileUtils.mv(Dir.glob("#{@temp_directory}/*"), destination, force: true)
+
+      puts "[Icons] Synced '#{@name}' library #{%w[😃 🎉 ✨].sample}"
+    end
+
+    def purge_temp_directory
+      FileUtils.rm_rf(temp_directory_root)
+    end
+
+    def post_error_clean_up
+      print "Do you want to remove the temp files? ('#{@temp_directory}') [y/n]: "
+      response = $stdin.gets.chomp.downcase
+
+      if response == "y" || response == "yes"
+        puts "[Icons] Cleaning up…"
+        FileUtils.rm_rf(@temp_directory)
+      else
+        puts "[Icons] Keeping files at: '#{@temp_directory}'"
+      end
+    end
+  end
+end

data/lib/icons/version.rb

@@ -0,0 +1,3 @@
+module Icons
+  VERSION = "0.6.0"
+end

data/lib/icons.rb

@@ -1,3 +1,23 @@
+# frozen_string_literal: true
+
+require "icons/version"
+require "icons/errors"
+require "icons/libraries"
+require "icons/configuration"
+require "icons/icon"
+require "icons/sync"
+
 module Icons
-  # TBD
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def config
+      configuration || configure {}
+    end
+  end
 end

metadata

@@ -1,27 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: icons
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.6.0
 platform: ruby
 authors:
-- Rails Designer Developers
+- Rails Designer
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: Coming soon. Add any icon library to a Ruby app, from Heroicons, to Lucide
-  to Tabler (and others). Icons is library-agnostic, so you can add any library while
-  using the same interface.
-email: devs@railsdeigner.com
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.4
+description: Add any icon library to a Ruby app, from Heroicons, to Lucide to Phosphor
+  (and others). Icons is library-agnostic, so you can add any library while using
+  the same interface.
+email:
+- devs@railsdesigner.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/release
+- icons.gemspec
 - lib/icons.rb
-homepage: https://github.com/Rails-Designer/icons
+- lib/icons/assets/animated/bouncing-dots.svg
+- lib/icons/assets/animated/faded-spinner.svg
+- lib/icons/assets/animated/fading-dots.svg
+- lib/icons/assets/animated/trailing-spinner.svg
+- lib/icons/configuration.rb
+- lib/icons/configuration/animated.rb
+- lib/icons/configuration/boxicons.rb
+- lib/icons/configuration/feather.rb
+- lib/icons/configuration/flags.rb
+- lib/icons/configuration/heroicons.rb
+- lib/icons/configuration/linear.rb
+- lib/icons/configuration/lucide.rb
+- lib/icons/configuration/options.rb
+- lib/icons/configuration/phosphor.rb
+- lib/icons/configuration/radix.rb
+- lib/icons/configuration/sidekickicons.rb
+- lib/icons/configuration/tabler.rb
+- lib/icons/configuration/weather.rb
+- lib/icons/errors.rb
+- lib/icons/icon.rb
+- lib/icons/icon/attributes.rb
+- lib/icons/icon/file_path.rb
+- lib/icons/libraries.rb
+- lib/icons/sync.rb
+- lib/icons/sync/process_variants.rb
+- lib/icons/sync/transformations.rb
+- lib/icons/version.rb
+homepage: https://railsdesigner.com/icons/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://railsdesigner.com/icons/
+  source_code_uri: https://github.com/Rails-Designer/icons/
 rdoc_options: []
 require_paths:
 - lib
@@ -36,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Add any icon library to a Ruby app
 test_files: []