rails_icons 0.4.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b822f3cdeb49bbe4e7d23109b89d0508e4b23e39c5da7b1c26a633977744b6f
-  data.tar.gz: 0becd12bf8f1a1ce9ae6f35877cb8c0ef936d8b6e2693d04849c8716fccb8c7e
+  metadata.gz: 628225582b62195c9f7bc3994d9fcad7aa37dc563b4d0e73069c5efdddd81332
+  data.tar.gz: 3241569575d809f7c6bbce51804cab8255df585f24a9473878432d2930596fcb
 SHA512:
-  metadata.gz: b34876d807ff8d3bb63faae9cb71d9a5527eee3543b1ce8b37034fe7719e8420149a202c3d1be2b0251d04fa7ebc0e52d0b6628570a045b8c469f84d56e3aace
-  data.tar.gz: 81f8bd92e599e2fa2ff1421ab75ff334728f06792063dfd7ae2a74a0559ae5b73778192e64c1d772ea1fb2e2cb32e43cecd809e0985d91f3386488f9f87d0810
+  metadata.gz: c4226fb17440c8eb8949ecce47be982b7dc17f022e33b1bccc640dbd16b700096e2f6867dceace37c597e56919be83621523ac8f842976365dc81517149bf4cc
+  data.tar.gz: 1c1b35579576475f1b06ccf56416850c3d333402ebfefc63b8b1250b4317a196b04b15512ca5ac17cd26faba7298439114b4f175803c564ecbf1d22123db3eba

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_icons (0.4.0)
+    rails_icons (1.1.0)
       nokogiri (~> 1.16, >= 1.16.4)
       rails (> 6.1)
 

data/README.md

@@ -1,112 +1,127 @@
 # Rails Icons
 
-Embed any library's icon in your Rails app. There are many icon gems for Rails already, but none are library-agnostic. This means you need to pull in other gems or add your logic to display that one specific icon.
+Add any icon library to a Rails app. Rails Icons has first-party support for a [handful of libraries](#first-party-libraries). It is library agnostic so it can be used with any icon library using the same interface.
 
-The first-party supported icons are stored in a seperate repo: [rails_icons_vault](https://github.com/Rails-Designer/rails_icons_vault). This allows you to pull in only the icon libraries you need, keeping the rails_icons gem lean and lightweight.
+```erb
+# Using the default icon library
+<%= icon "check", class: "text-gray-500" %>
+
+# Using any custom library
+<%= icon "apple", library: "simple_icons", class: "text-black" %>
+```
+
+The icons are sourced directly from their respective GitHub repositories, ensuring Rails Icons remain lightweight.
 
 
-## Sponsored By [Rails Designer](https://railsdesigner.com/)
+**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="300" />
+  <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>
 
 
 ## Install
 
-Add this line to your Gemfile:
-
-```ruby
-gem "rails_icons"
+Add the gem
+```bash
+bundle add rails_icons
 ```
 
-And run:
-
+Install, choosing one of the supported libraries
 ```bash
-bundle
+rails generate rails_icons:install --libraries=LIBRARY_NAME
 ```
 
-Sync any of the supported icon libraries from the
-[rails_icons_vault](https://github.com/Rails-Designer/rails_icons_vault):
-
+**Example**
 ```bash
-rails generate rails_icons:sync heroicons
+rails generate rails_icons:install --libraries=heroicons
+
+Or multiple at once
+rails generate rails_icons:install --libraries=heroicons lucide
 ```
 
 
 ## Usage
 
 ```ruby
-# The default library is Heroicons, with "outline" as the default set
+# Uses the default library and variant defined in config/initializer/rails_icons.rb
 icon "check"
 
-# Use another set (options are: outline, solid, mini, micro)
-icon "check", set: "solid"
+# Use another variant
+icon "check", variant: "solid"
 
-# Add CSS to the icon
+# Set library explictly
+icon "check", library: "heroicons"
+
+# Add CSS
 icon "check", class: "text-green-500"
 
+# Add CSS with class_names
+# article: https://railsdesigner.com/conditional-css-classes-in-rails/
+# docs: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-token_list
+icon "check", class: ["size-4", "bg-red-500": !verified?, "bg-green-500": verified?]
+
 # Add data attributes
 icon "check", data: { controller: "swap" }
 
-# Tweak the stroke-width
+# Set the stroke-width
 icon "check", stroke_width: 2
 ```
 
 
-## Initializer
+## First-party libraries
 
-```ruby
-RailsIcons.configure do |config|
-  # Set the default set for the library
-  config.default_library = "heroicons"
-  config.default_set = "outline"
+- [Boxicons](https://github.com/atisawd/boxicons) (1600+ icons)
+- [Feather](https://github.com/feathericons/feather) (280+ icons)
+- [Heroicons](https://github.com/tailwindlabs/heroicons) (300+ icons)
+- [Lucide](https://github.com/lucide-icons/lucide) (1500+ icons)
+- [Phosphor](https://github.com/phosphor-icons/core) (9000+ icons)
+- [Radix](https://github.com/radix-ui/icons/) (300+ icons)
+- [Tabler](https://github.com/tabler/tabler-icons) (5700+ icons)
 
-  config.libraries.heroicons.solid.default.css = "w-6 h-6"
-  config.libraries.heroicons.solid.default.data = {}
 
-  config.libraries.heroicons.outline.default.css = "w-6 h-6"
-  config.libraries.heroicons.outline.default.stroke_width = "1.5"
-  config.libraries.heroicons.outline.default.data = {}
+## Animated icons
 
-  config.libraries.heroicons.mini.default.css = "w-5 h-5"
-  config.libraries.heroicons.mini.default.data = {}
+Rails Icons also includes a few animated icons. Great for loading states and so on. These are currently included:
 
-  config.libraries.heroicons.micro.default.css = "w-4 h-4"
-  config.libraries.heroicons.micro.default.data = {}
-end
-```
+- `faded-spinner`
+- `trailing-spinner`
+- `fading-dots`
+- `bouncing-dots`
+
+Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as other libraries are available.
 
-Or run `rails generate rails_icons:initializer`.
 
+## Custom icon library
 
-## Add a custom icon library
+Need to use an icon from another library?
 
+1. run `rails generate rails_icons:initializer --custom=simple_icons`;
+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
-RailsIcons.configure do |config|
-  # …
-  config.libraries.merge!(
-    {
-      custom: {
-        simple_icons: {
-          solid: {
-            path: "app/assets/svg/simple_icons/solid", # optional: the default lookup path is: `app/assets/svg/#{library_name}/#{set}`
-            default: {
-              css: "w-6 h-6"
-            }
-          }
-        }
-      }
-    }
-  )
-  # …
-end
+icon "apple", library: "simple_icons", class: "text-black"
 ```
 
-You can now use any svg-icon in the `app/assets/svg/simple_icons/solid` folder as a first-party icon:
 
-```ruby
-icon "reddit", library: "simple_icons", set: "solid"
+## Sync icons
+
+To sync all installed libraries, run
+```bash
+rails generate rails_icons:sync
+```
+
+To sync only a specific library, run
+```bash
+rails generate rails_icons:sync --libraries=heroicons
+
+# Or multiple at once:
+rails generate rails_icons:sync --libraries=heroicons lucide
 ```
 
 

data/app/assets/svg/rails_icons/icons/animated/bouncing-dots.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><circle fill="currentColor" stroke="none" cx="4" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 3.6 ; 0 -3.6; 0 3.6" repeatCount="indefinite" begin="0.1"></animateTransform></circle><circle fill="currentColor" stroke="none" cx="12" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 2.4 ; 0 -2.4; 0 2.4" repeatCount="indefinite" begin="0.2"></animateTransform></circle><circle fill="currentColor" stroke="none" cx="20" cy="12" r="2.5"><animateTransform attributeName="transform" dur="1s" type="translate" values="0 1.2 ; 0 -1.2; 0 1.2" repeatCount="indefinite" begin="0.3"></animateTransform></circle></svg>

data/app/assets/svg/rails_icons/icons/animated/faded-spinner.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" ><defs><style>@keyframes spin {to{transform:rotate(360deg);}}</style></defs><g style="transform-origin:center;animation:spin 1s linear infinite"><circle style="opacity: 0.25" cx="12" cy="12" r="10" stroke="currentColor" stroke-width="4" fill="none"/><path style="opacity: 0.75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"/></g></svg>

data/app/assets/svg/rails_icons/icons/animated/fading-dots.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><circle fill="currentColor" stroke="none" cx="4" cy="12" r="2.5"> <animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.1"></animate></circle><circle fill="currentColor" stroke="none" cx="12" cy="12" r="2.5"><animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.2"></animate></circle><circle fill="currentColor" stroke="none" cx="20" cy="12" r="2.5"><animate attributeName="opacity" dur="1s" values="0;1;0" repeatCount="indefinite" begin="0.3"></animate></circle></svg>

data/app/assets/svg/rails_icons/icons/animated/trailing-spinner.svg

@@ -0,0 +1 @@
+<svg stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><style>.spinner{transform-origin:center; animation:spinner_outside 2s linear infinite}.spinner circle{stroke-linecap:round;animation:spinner_inside 1.5s ease-in-out infinite}@keyframes spinner_outside{100%{transform:rotate(360deg)}}@keyframes spinner_inside{0%{stroke-dasharray:0 150;stroke-dashoffset:0}47.5%{stroke-dasharray:42 150;stroke-dashoffset:-16}95%,100%{stroke-dasharray:42 150;stroke-dashoffset:-59}}</style><g class="spinner"><circle cx="12" cy="12" r="9.5" fill="none" stroke-width="4"></circle></g></svg>

data/lib/generators/rails_icons/initializer_generator.rb

@@ -1,12 +1,99 @@
 # frozen_string_literal: true
 
 module RailsIcons
-  # Copies the initializer template to your Rails project
   class InitializerGenerator < Rails::Generators::Base
     source_root File.expand_path("templates", __dir__)
 
+    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
-      copy_file "initializer.rb", "config/initializers/rails_icons.rb"
+      return if File.exist?(INITIALIZER)
+
+      copy_file "initializer.rb", INITIALIZER
+    end
+
+    def insert_default_configuration
+      return unless File.exist?(INITIALIZER)
+      return if default_configuration_exists?
+
+      if options[:libraries].present?
+        default_configuration = <<~RB.indent(2)
+          config.default_library = "#{options[: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
+
+    def setup_custom_configuration
+      return "" if options[:custom].blank?
+
+      insert_custom_configuration
+      create_custom_directory
+    end
+
+    private
+
+    INITIALIZER = "config/initializers/rails_icons.rb"
+
+    def insert_custom_configuration
+      unless File.read(INITIALIZER).include?("config.libraries.merge!")
+        custom_default_configuration = <<~RB.indent(2)
+          config.libraries.merge!(
+
+            {
+              custom: {
+              }
+            }
+          )
+        RB
+
+        insert_into_file INITIALIZER, custom_default_configuration, before: "end"
+      end
+
+      insert_into_file INITIALIZER, "\n#{custom_configuration}", after: "custom: {"
+    end
+
+    def create_custom_directory = FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
+
+    def library_configuration
+      options[:libraries].map { RailsIcons.libraries[_1.to_sym].initializer_config }.join("\n")
+    end
+
+    def custom_configuration
+      <<~RB.indent(8)
+        #{options[:custom]}: {
+          # path: "app/assets/svg/icons/#{options[:custom]}/",
+          default: {
+            css: "size-6"
+          }
+        }
+      RB
+    end
+
+    def default_configuration_exists?
+      line = /^\s*config\.default_library\s*=/
+
+      File.readlines(INITIALIZER).any? { _1.match?(line) }
     end
   end
 end

data/lib/generators/rails_icons/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Install Rails Icons with the choosen 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
+      generate("rails_icons:initializer", *attributes)
+    end
+
+    def sync_generator
+      return if options[:skip_sync] || options[:libraries].blank?
+
+      generate("rails_icons:sync", *attributes)
+    end
+
+    private
+
+    def attributes = ["--libraries=#{options[:libraries].join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+  end
+end

data/lib/generators/rails_icons/sync_generator.rb

@@ -1,52 +1,31 @@
-require "fileutils"
+# frozen_string_literal: true
+
+require "rails_icons/sync/engine"
 
 module RailsIcons
   class SyncGenerator < Rails::Generators::Base
-    ICON_VAULT_REPO_URL = "https://github.com/Rails-Designer/rails_icons_vault.git".freeze
-
-    argument :libraries, type: :array, default: [], banner: "heroicons lucide tabler"
-
-    class_option :destination, type: :string, default: nil,
-      desc: "Custom destination folder for icons (default: `app/assets/svg/icons/`)"
-
-    desc "Sync a specified icon set(s) from the Rails Icons Vault (https://github.com/Rails-Designer/rails_icons_vault)"
     source_root File.expand_path("templates", __dir__)
 
-    def sync_icons
-      icons_dir = options[:destination] || Rails.root.join("app/assets/svg/icons")
-      tmp_dir = Rails.root.join("tmp/icons")
-
-      FileUtils.rm_rf(tmp_dir) if Dir.exist?(tmp_dir)
-      FileUtils.mkdir_p(tmp_dir)
+    desc "Sync the choosen icon libraries from their respective git repos."
 
-      if system("git clone '#{ICON_VAULT_REPO_URL}' '#{tmp_dir}'")
-        say "Repository cloned successfully.", :green
-      else
-        say "Failed to clone repository.", :red
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
 
-        exit 1
-      end
-
-      libraries.each do |set|
-        set_path = File.join(tmp_dir, "icons", set)
+    def sync_icons
+      raise "[Rails Icons] Not a valid library" if libraries.empty?
 
-        if Dir.exist?(set_path)
-          destination_path = File.join(icons_dir, set)
+      libraries.each { Sync::Engine.new(_1).sync }
+    end
 
-          FileUtils.mkdir_p(destination_path)
-          FileUtils.cp_r(Dir.glob("#{set_path}/*"), destination_path)
+    private
 
-          say "Synced `#{set}` icons for set", :green
-        else
-          say "Icon set `#{set}` not found", :red
+    def libraries
+      options[:libraries].presence || synced_libraries
+    end
 
-          exit 1
-        end
+    def synced_libraries
+      RailsIcons.libraries.keys.map(&:to_s).select do |library|
+        Dir.exist?(File.join(RailsIcons.configuration.destination_path, library.to_s))
       end
-
-      FileUtils.rm_rf(tmp_dir)
-
-      say "Icons synced successfully", :green
     end
   end
 end

data/lib/generators/rails_icons/templates/initializer.rb.tt

@@ -1,18 +1,2 @@
 RailsIcons.configure do |config|
-  # Set the default set for the library
-  config.default_library = "heroicons" # https://heroicons.com/
-  config.default_set = "outline" # other sets for Heroicons are: solid, mini, micro
-
-  config.libraries.heroicons.solid.default.css = "w-6 h-6"
-  config.libraries.heroicons.solid.default.data = {}
-
-  config.libraries.heroicons.outline.default.css = "w-6 h-6"
-  config.libraries.heroicons.outline.default.stroke_width = "1.5"
-  config.libraries.heroicons.outline.default.data = {}
-
-  config.libraries.heroicons.mini.default.css = "w-5 h-5"
-  config.libraries.heroicons.mini.default.data = {}
-
-  config.libraries.heroicons.micro.default.css = "w-4 h-4"
-  config.libraries.heroicons.micro.default.data = {}
 end

data/lib/rails_icons/configuration/animated.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Animated
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default = default_options
+        end
+      end
+
+      private
+
+      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/boxicons.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Boxicons
+      extend self
+
+      def config
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.default_variant = :regular
+
+          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.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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    module Feather
+      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 Feather defaults
+          # 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
+        ActiveSupport::OrderedOptions.new.tap do |options|
+          options.stroke_width = "2"
+          options.css = "size-6"
+          options.data = {}
+        end
+      end
+    end
+  end
+end