rails_icons 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50dffad405d19a7a365d8dd5684422ac4b0b31fc5e8c9e001d841c2625ed0f66
-  data.tar.gz: ac27f4feb6a7dae8d240896cbcad704675f566080aea2a1df4bad68608bcd0ae
+  metadata.gz: 6413197bc61eb646096a2c6abbf25696fd6eb8c986d85cc08519509066f83e85
+  data.tar.gz: e1a1f952e9f499a39adba3958be58fc7f7aafbd779397ce5b7d62c4e1d16cb9c
 SHA512:
-  metadata.gz: 1b3b458095eb630a39f217be671c6bf58dc400c6e5caea9e7eee7ceebc51df6329dced01d3451f483b936f3fb5d59aaeea05de519565e36c12de3aa80abfbeb3
-  data.tar.gz: 60a93aed59ef5c518c39d95b3814062a02240aa86cbfe34ca771164504747ea965fae97a3456cc50dc06e620c04ccc2c5d7825d7724ec7f3850abd583be0cf91
+  metadata.gz: 37de7ecd41860ff20570285ba3910192c5e52273a0991ae06f51a6d823078031bb0304fce7fae49a8866d5b71c2caf3a99f6123b1cfa9209b61b35acf86e1018
+  data.tar.gz: 4590aceead66f68e8b890a53823eb9fe8c959c58678631f854bedf49c763c81deda9de0175763b26fb2ad135be3d561e8ab3dd5a2c19b921cd06fad710330884

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_icons (1.0.0)
+    rails_icons (1.2.0)
       nokogiri (~> 1.16, >= 1.16.4)
       rails (> 6.1)
 
@@ -104,7 +104,7 @@ GEM
     marcel (1.0.4)
     method_source (1.0.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.5)
+    mini_portile2 (2.8.8)
     minitest (5.22.3)
     net-imap (0.4.10)
       date
@@ -116,10 +116,10 @@ GEM
     net-smtp (0.5.0)
       net-protocol
     nio4r (2.7.1)
-    nokogiri (1.16.4)
+    nokogiri (1.18.3)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.4-arm64-darwin)
+    nokogiri (1.18.3-arm64-darwin)
       racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.0.5)
@@ -132,7 +132,7 @@ GEM
       railties (>= 7.0.0)
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rack (2.2.9)
     rack-test (2.1.0)
       rack (>= 1.3)
@@ -215,6 +215,7 @@ GEM
 PLATFORMS
   arm64-darwin-22
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   debug (~> 1.9, >= 1.9.2)

data/README.md

@@ -16,7 +16,11 @@ The icons are sourced directly from their respective GitHub repositories, ensuri
 **Sponsored By [Rails Designer](https://railsdesigner.com/)**
 
 <a href="https://railsdesigner.com/" target="_blank">
-  <img src="https://raw.githubusercontent.com/Rails-Designer/rails_icons/main/docs/rails_designer_icon.jpg" alt="Rails Designer logo"  width="240" />
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Rails-Designer/rails_icons/HEAD/.github/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Rails-Designer/rails_icons/HEAD/.github/logo-light.svg">
+    <img alt="Rails Designer" src="https://raw.githubusercontent.com/Rails-Designer/rails_icons/HEAD/.github/logo-light.svg" width="240" style="max-width: 100%;">
+  </picture>
 </a>
 
 
@@ -36,7 +40,7 @@ rails generate rails_icons:install --libraries=LIBRARY_NAME
 ```bash
 rails generate rails_icons:install --libraries=heroicons
 
-Or multiple at once
+# Or multiple at once
 rails generate rails_icons:install --libraries=heroicons lucide
 ```
 
@@ -50,12 +54,17 @@ icon "check"
 # Use another variant
 icon "check", variant: "solid"
 
-# Set library explictly
+# Set library explicitly
 icon "check", library: "heroicons"
 
 # Add CSS
 icon "check", class: "text-green-500"
 
+# Add CSS with class_names
+icon "check", class: ["size-4", "bg-red-500": !verified?, "bg-green-500": verified?]
+# ↳ Article: https://railsdesigner.com/conditional-css-classes-in-rails/
+# ↳ Documentation: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-token_list
+
 # Add data attributes
 icon "check", data: { controller: "swap" }
 
@@ -66,10 +75,17 @@ icon "check", stroke_width: 2
 
 ## First-party libraries
 
-- [Feather](https://github.com/feathericons/feather)
-- [Heroicons](https://github.com/tailwindlabs/heroicons)
-- [Lucide](https://github.com/lucide-icons/lucide)
-- [Tabler](https://github.com/tabler/tabler-icons)
+- [Boxicons](https://railsdesigner.com/rails-icons/boxicons/) (1600+ icons)
+- [Feather](https://railsdesigner.com/rails-icons/feather/) (280+ icons)
+- [Flags](https://railsdesigner.com/rails-icons/flags/) (540+ icons)
+- [Heroicons](https://railsdesigner.com/rails-icons/heroicons/) (300+ icons)
+- [Linear](https://railsdesigner.com/rails-icons/linear/) (170+ icons)
+- [Lucide](https://railsdesigner.com/rails-icons/lucide/) (1500+ icons)
+- [Phosphor](https://railsdesigner.com/rails-icons/phosphor/) (9000+ icons)
+- [Radix](https://railsdesigner.com/rails-icons/radix/) (300+ icons)
+- [SidekickIcons](https://railsdesigner.com/rails-icons/sidekickicons/) (49 icons, complementing [Heroicons](https://railsdesigner.com/rails-icons/heroicons/))
+- [Tabler](https://railsdesigner.com/rails-icons/tabler/) (5700+ icons)
+- [Weather](https://railsdesigner.com/rails-icons/weather/) (215+ icons)
 
 
 ## Animated icons
@@ -81,7 +97,7 @@ Rails Icons also includes a few animated icons. Great for loading states and so
 - `fading-dots`
 - `bouncing-dots`
 
-Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as other libraries are available.
+Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as the others libraries are available.
 
 
 ## Custom icon library
@@ -92,7 +108,6 @@ Need to use an icon from another library?
 2. add the (SVG) icons to the created directory **app/assets/svg/icons/simple_icons**;
 
 Every custom icon can now be used with the same interface as first-party icon libraries.
-
 ```ruby
 icon "apple", library: "simple_icons", class: "text-black"
 ```
@@ -100,13 +115,12 @@ icon "apple", library: "simple_icons", class: "text-black"
 
 ## Sync icons
 
-If a library gets updated, sync the icons to your app by running
-
+To sync all libraries, run
 ```bash
-rails generate rails_icons:sync --libraries=LIBRARY_NAME
+rails generate rails_icons:sync
 ```
 
-**Example**
+To sync only a specific library, run
 ```bash
 rails generate rails_icons:sync --libraries=heroicons
 

data/lib/generators/rails_icons/initializer_generator.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "rails_icons/base_generator"
+
 module RailsIcons
-  class InitializerGenerator < Rails::Generators::Base
+  class InitializerGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
-    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
-    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
+    desc "Create the Rails Icons initializer."
+
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
+    class_option :destination, type: :string, default: RailsIcons.configuration.destination_path, desc: "Specify destination folder for icons"
     class_option :custom, type: :string, desc: "Name of the custom library"
 
     def copy_initializer
@@ -18,16 +22,26 @@ module RailsIcons
       return unless File.exist?(INITIALIZER)
       return if default_configuration_exists?
 
-      if options[:libraries].present?
+      if libraries.present?
         default_configuration = <<~RB.indent(2)
-          config.default_library = "#{options[:libraries].first}"
-          # config.default_variant = "" # Set a default variant if multiple exist
+          config.default_library = "#{libraries.first}"
+          # config.default_variant = "" # Set a default variant for all libraries
         RB
 
         insert_into_file INITIALIZER, default_configuration, after: "RailsIcons.configure do |config|\n"
       end
     end
 
+    def insert_custom_destination_path
+      return if options[:destination] && options[:destination] == RailsIcons.configuration.destination_path
+
+      insert_into_file INITIALIZER, <<~RB.indent(2), after: "RailsIcons.configure do |config|\n"
+        # Default destination path
+        config.destination_path = "#{options[:destination]}"
+
+      RB
+    end
+
     def insert_libraries_configuration
       insert_into_file INITIALIZER, "\n#{library_configuration}", before: "end"
     end
@@ -61,67 +75,10 @@ module RailsIcons
       insert_into_file INITIALIZER, "\n#{custom_configuration}", after: "custom: {"
     end
 
-    def create_custom_directory
-      FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
-    end
+    def create_custom_directory = FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
 
     def library_configuration
-      configs = {
-        feather: feather_config,
-        heroicons: heroicons_config,
-        lucide: lucide_config,
-        tabler: tabler_config
-      }
-
-      options[:libraries].map { configs[_1.to_sym] }.join("\n")
-    end
-
-    def feather_config
-      <<~RB.indent(2)
-        # Override Feather defaults
-        # config.libraries.feather.default.css = "size-6"
-        # config.libraries.feather.default.stroke_width = "2"
-        # config.libraries.feather.default.data = {}
-      RB
-    end
-
-    def heroicons_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 lucide_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 tabler_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
+      libraries.map { RailsIcons.libraries[_1.to_sym].initializer_config }.join("\n")
     end
 
     def custom_configuration
@@ -140,5 +97,7 @@ module RailsIcons
 
       File.readlines(INITIALIZER).any? { _1.match?(line) }
     end
+
+    def libraries = options[:libraries].map(&:downcase)
   end
 end

data/lib/generators/rails_icons/install_generator.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "rails_icons/base_generator"
+
 module RailsIcons
-  class InstallGenerator < Rails::Generators::Base
+  class InstallGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
-    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
-    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
+    desc "Install Rails Icons with the chosen libraries. This creates the configuration initializer and will sync the icons."
+
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
+    class_option :destination, type: :string, default: RailsIcons.configuration.destination_path, desc: "Specify destination folder for icons"
     class_option :skip_sync, type: :boolean, default: false
 
     def initializer_generator
@@ -20,6 +24,6 @@ module RailsIcons
 
     private
 
-    def attributes = ["--libraries=#{options[:libraries].join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+    def attributes = ["--libraries=#{options[:libraries].map(&:downcase).join(" ")}", "--destination=#{options[:destination]}"].join(" ")
   end
 end

data/lib/generators/rails_icons/sync_generator.rb

@@ -1,59 +1,28 @@
 # frozen_string_literal: true
 
-require "fileutils"
-require_relative "sync/engine"
+require "rails_icons/base_generator"
+require "rails_icons/sync/engine"
 
 module RailsIcons
-  class SyncGenerator < Rails::Generators::Base
-    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons::Libraries.all.keys.join("/")})"
-    class_option :destination, type: :string, default: "app/assets/svg/icons/", desc: "Specify destination folder for icons"
-
-    desc "Sync an icon library(s) from their respective git repos."
+  class SyncGenerator < RailsIcons::BaseGenerator
     source_root File.expand_path("templates", __dir__)
 
-    def sync_icons
-      raise "[Rails Icons] Not a valid library" if options[:libraries].empty?
-
-      clean_temp_directory
+    desc "Sync the chosen icon libraries from their respective git repos."
 
-      options[:libraries].each { |library| sync(library) }
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
 
-      clean_temp_directory
-    end
+    def sync_icons = libraries.each { Sync::Engine.new(_1).sync }
 
     private
 
-    def clean_temp_directory
-      FileUtils.rm_rf(temp_directory) if Dir.exist?(temp_directory)
-    end
-
-    def sync(name)
-      library = RailsIcons::Libraries.all.fetch(name.to_sym)
-      library_path = File.join(temp_directory, library[:name])
-
-      Sync::Engine.new(temp_directory, library).sync
-
-      raise_library_not_found(name) unless Dir.exist?(library_path)
-      copy_library(library[:name], library_path)
-    end
-
-    def temp_directory
-      Rails.root.join("tmp/icons")
-    end
-
-    def copy_library(library, source)
-      destination = File.join(options[:destination], library)
-
-      FileUtils.mkdir_p(destination)
-
-      FileUtils.cp_r(Dir.glob("#{source}/*"), destination)
-
-      say "[Rails Icons] Synced '#{library}' library successfully #{%w[😃 🎉 ✨].sample}", :green
+    def libraries
+      options[:libraries].map(&:downcase).presence || synced_libraries
     end
 
-    def raise_library_not_found(library)
-      say "[Rails Icons] Could not find '#{library}' library 🤷", :red
-      exit 1
+    def synced_libraries
+      RailsIcons.libraries.keys.map(&:to_s).select do |library|
+        Dir.exist?(File.join(RailsIcons.configuration.destination_path, library.to_s))
+      end
     end
   end
 end

data/lib/rails_icons/base_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class BaseGenerator < Rails::Generators::Base
+    def initialize(*arguments)
+      super(*arguments)
+
+      validate!
+    end
+
+    private
+
+    def validate!
+      raise RailsIcons::LibraryNotFound.new("") if options.libraries.empty?
+      raise RailsIcons::LibraryNotFound.new(invalid_libraries.join(", ")) if invalid_libraries.any?
+    end
+
+    def invalid_libraries = options.libraries.map(&:to_sym).map(&:downcase).reject { RailsIcons.libraries.key?(_1) }
+  end
+end

data/lib/rails_icons/configuration/animated.rb

@@ -2,7 +2,9 @@
 
 module RailsIcons
   class Configuration
-    class Animated
+    module Animated
+      extend self
+
       def config
         ActiveSupport::OrderedOptions.new.tap do |options|
           options.default = default_options

data/lib/rails_icons/configuration/boxicons.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Boxicons
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :regular
+          options.exclude_variants = []
+
+          setup_regular_config(options)
+          setup_solid_config(options)
+          setup_logos_config(options)
+        end
+      end
+
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Boxicons defaults
+          # config.libraries.boxicons.exclude_variants = [] # Exclude specific variants
+
+          # config.libraries.boxicons.solid.css = "size-6"
+          # config.libraries.boxicons.solid.data = {}
+
+          # config.libraries.boxicons.regular.css = "size-6"
+          # config.libraries.boxicons.regular.data = {}
+
+          # config.libraries.boxicons.logos.css = "size-6"
+          # config.libraries.boxicons.logos.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/atisawd/boxicons.git",
+          variants: {
+            logos: "svg/logos",
+            regular: "svg/regular",
+            solid: "svg/solid"
+          }
+        }
+      end
+
+      def transformations
+        {
+          filenames: {
+            delete_prefix: ["bxl-", "bx-", "bxs-"]
+          }
+        }
+      end
+
+      def setup_regular_config(options)
+        options.regular = ActiveSupport::OrderedOptions.new
+        options.regular.default = default_options
+      end
+
+      def setup_solid_config(options)
+        options.solid = ActiveSupport::OrderedOptions.new
+        options.solid.default = default_options
+      end
+
+      def setup_logos_config(options)
+        options.logos = ActiveSupport::OrderedOptions.new
+        options.logos.default = default_options
+      end
+
+      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/feather.rb

@@ -2,15 +2,38 @@
 
 module RailsIcons
   class Configuration
-    class Feather
+    module Feather
+      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 Feather defaults
+          # config.libraries.feather.exclude_variants = [] # Feather has no variants, this is provided for backwards compatibility
+
+          # config.libraries.feather.default.css = "size-6"
+          # config.libraries.feather.default.stroke_width = "2"
+          # config.libraries.feather.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/feathericons/feather.git",
+          variants: {
+            ".": "icons" # Feather has no variants, store in the top directory
+          }
+        }
+      end
+
       private
 
       def default_options

data/lib/rails_icons/configuration/flags.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Flags
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = "landscape"
+          options.exclude_variants = []
+
+          setup_square_config(options)
+          setup_landscape_config(options)
+        end
+      end
+
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Flags defaults
+          # config.libraries.flags.exclude_variants = [:square, :landscape]
+
+          # config.libraries.flags.square.default.css = "size-6"
+          # config.libraries.flags.square.default.data = {}
+
+          # config.libraries.flags.landscape.default.css = "size-6"
+          # config.libraries.flags.landscape.default.data = {}
+        RB
+      end
+
+      def source
+        {
+          url: "https://github.com/lipis/flag-icons.git",
+          variants: {
+            square: "flags/1x1",
+            landscape: "flags/4x3"
+          }
+        }
+      end
+
+      private
+
+      def setup_square_config(options)
+        options.square = ActiveSupport::OrderedOptions.new
+        options.square.default = default_square_options
+      end
+
+      def setup_landscape_config(options)
+        options.landscape = ActiveSupport::OrderedOptions.new
+        options.landscape.default = default_landscape_options
+      end
+
+      def default_square_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+
+      def default_landscape_options
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end

data/lib/rails_icons/configuration/heroicons.rb

@@ -2,10 +2,13 @@
 
 module RailsIcons
   class Configuration
-    class Heroicons
+    module Heroicons
+      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)
@@ -14,6 +17,38 @@ module RailsIcons
         end
       end
 
+      def initializer_config
+        <<~RB.indent(2)
+          # Override Heroicon defaults
+          # config.libraries.heroicons.exclude_variants = [:mini, :micro] # Exclude specific variants
+
+          # 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)
@@ -36,16 +71,16 @@ module RailsIcons
         options.micro.default = default_micro_options
       end
 
-      def default_solid_options
+      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_outline_options
+      def default_solid_options
         ActiveSupport::OrderedOptions.new.tap do |options|
-          options.stroke_width = 1.5
           options.css = "size-6"
           options.data = {}
         end