rails_icons 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cd203323e3d677c596eafcbc471b132b29bae354de297cdb96aee0da7a9b842
-  data.tar.gz: 777f5a17de05f8c66a7b5853af51b170bef1a55011fd9599cb397ef82aa34b0c
+  metadata.gz: 87983d78c763bf00cac5dfcff0cd432d9140643b12235dd3f549aa2d20a4a85f
+  data.tar.gz: 892fdb71667edd0e038265645e01a17757c5e16a8227b7265ed1dbb082d0213e
 SHA512:
-  metadata.gz: 1daf94a537ad62da679b0c09696beeaeb8d74e207d393f126b682d54f134eb39468ae943080079dd16b7caa80a97f6b8b6721dc626e8a4bdbb0bc318c1315c43
-  data.tar.gz: cafc3c92e4cc3b8146eab5879ea8549f6fbd5b0929487a18ed00c5a3f0c8a775f8d17289e61431e808a8b29fb9b41b7734e2ca976b4f72a5ed97106cbe05fbab
+  metadata.gz: 3f5c76f15631ed655d92d476c7c945f9a8e33981061fece4aed02ffc83b5cd84888d605c5e98b0b4496c97d7bf8b8a00798b6614010959799326ca10c67dea45
+  data.tar.gz: b9e806967af7a3aaf42d46e79dbc9433e4dd3d8ecd3781a66c24e33c15c54913ae95d31ad0de1dc87fb24a2431ef5e6fa9b6c07861ace8b2d51161af17564124

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rails_icons (1.9.0)
-      icons (~> 0.9.0)
+    rails_icons (1.10.0)
+      icons (~> 0.11.0)
       rails (>= 7.0)
 
 GEM
@@ -102,7 +102,7 @@ GEM
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    icons (0.9.0)
+    icons (0.11.0)
       nokogiri (~> 1.16, >= 1.16.4)
     io-console (0.8.1)
     irb (1.15.2)

data/README.md

@@ -44,6 +44,9 @@ rails generate rails_icons:install --library=heroicons
 
 # Or multiple at once
 rails generate rails_icons:install --libraries=heroicons lucide
+
+# Or only specific variants
+rails generate rails_icons:install --library=heroicons --variants solid outline
 ```
 
 The generator also mounts an icon preview at `/rails_icons` where you can browse and search all your available icons. This route is open by default, so restrict it in production if needed.
@@ -81,6 +84,7 @@ icon "check", stroke_width: 2
 
 Rails Icons supports SVG sprites for improved performance. Instead of inlining each icon's full SVG, sprite icons reference a shared set of `<symbol>` definitions via `<use href="…">`.
 
+
 ### Configuration
 
 ```ruby
@@ -145,7 +149,7 @@ config.default_sprite_location = nil
 
 You can also generate a sprite for a specific set of icons:
 ```erb
-<%= icons_sprite(["check", "search"], library: "heroicons", variant: "outline") %>
+<%= icons_sprite ["check", "search"], library: "heroicons", variant: "outline" %>
 ```
 
 
@@ -195,19 +199,6 @@ Rails Icons also includes a few animated icons. Great for loading states and so
 Use like this: `icon "faded-spinner", library: "animated"`. The same attributes as the other libraries are available.
 
 
-## Custom icon library
-
-Need to use an icon from another library (for example [Simple Icons](https://simpleicons.org/))?
-
-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
-icon "apple", library: "simple_icons", class: "text-black"
-```
-
-
 ## Sync icons
 
 To sync all libraries, run:
@@ -223,13 +214,52 @@ rails generate rails_icons:sync --library=heroicons
 rails generate rails_icons:sync --libraries=heroicons lucide
 ```
 
+To sync only specific variants for a library:
+```bash
+rails generate rails_icons:sync --library=heroicons --variants solid outline
+```
+
+
+## Custom icon libraries
+
+Rails Icons pulls SVGs straight from the path `<icons_path>/<library_name>/<name>.svg`. No generator is required for custom icons. Configuration is optional and only used to define defaults.
+
+To add a custom library, create its directory and drop in your SVGs:
+
+```
+app/assets/svg/icons/simple_icons/apple.svg
+```
+
+(Alternatively, scaffold it with `rails generate rails_icons:install --library=simple_icons`, which creates the directory and adds `config.custom_library :simple_icons` in the initializer.)
+
+Use them like any other library:
+
+```ruby
+icon "apple", library: :simple_icons
+```
+
+To add a git source for syncing, edit the initializer:
+```ruby
+RailsIcons.configure do |config|
+  config.custom_library :my_icons, source: {
+    url: "https://github.com/user/icons.git",
+    variants: { default: "." }
+  }
+end
+```
+
+Then sync:
+```bash
+rails generate rails_icons:sync --library=my_icons
+```
+
 
 ## Projects using Rails Icons
 
 - [Rails Designer UI Components](https://railsdesigner.com/components/) — The first professionally-designed UI components library for Ruby on Rails apps
 - [Chirp Form](https://chirpform.com/) — Add forms to any site. Display responses anywhere
-- [Helptail](https://helptail.com/) — Put your routine tasks on autopilot
 - [Seal Static](https://sealstatic.com/) — Host sites for every need
+- [Spinal CMS](https://spinalcms.com/) — Minimal and beautiful CMS for static site generators
 
 
 ## Contributing

data/app/controllers/rails_icons/sprites_controller.rb

@@ -3,6 +3,8 @@
 module RailsIcons
   class SpritesController < ActionController::Base
     def show
+      expires_in RailsIcons.sprite_cache_expires_in, public: true
+
       respond_to do |format|
         format.svg { render plain: Icons::Sprite.new.svg, content_type: "image/svg+xml" }
       end

data/lib/generators/rails_icons/initializer_generator.rb

@@ -8,10 +8,9 @@ module RailsIcons
 
     desc "Create the Rails Icons initializer."
 
-    class_option :library, type: :string, desc: "Choose a library (#{RailsIcons.libraries.keys.join("/")})"
-    class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
+    class_option :library, type: :string, desc: "Choose a library"
+    class_option :libraries, type: :array, default: [], desc: "Choose libraries"
     class_option :destination, type: :string, default: RailsIcons.configuration&.icons_path, desc: "Specify icons folder"
-    class_option :custom, type: :string, desc: "Name of the custom library"
 
     def copy_initializer
       return if File.exist?(INITIALIZER)
@@ -44,49 +43,39 @@ module RailsIcons
     end
 
     def insert_libraries_configuration
+      return if first_party_libraries.empty?
+
       insert_into_file INITIALIZER, "\n#{library_configuration}", before: "end"
     end
 
-    def setup_custom_configuration
-      return if options[:custom].blank?
+    def setup_custom_libraries
+      return if custom_libraries.empty?
+
+      insert_into_file INITIALIZER, "\n#{custom_library_configuration}", before: "end"
 
-      insert_custom_configuration
-      create_custom_directory
+      custom_libraries.each do |name|
+        FileUtils.mkdir_p(File.join(options[:destination], name))
+      end
     end
 
     private
 
     INITIALIZER = "config/initializers/rails_icons.rb"
 
-    def insert_custom_configuration
-      unless file_contains?(INITIALIZER, "config.libraries.merge!")
-        custom_default_configuration = <<~RB.indent(2)
-
-          config.libraries.merge!(
-          )
-        RB
-
-        insert_into_file INITIALIZER, custom_default_configuration, before: "end"
-      end
-
-      insert_into_file INITIALIZER, "\n#{custom_configuration}", after: "config.libraries.merge!("
+    def library_configuration
+      first_party_libraries.map { |library| RailsIcons.libraries[library.to_sym].initializer_config }.join("\n")
     end
 
-    def create_custom_directory = FileUtils.mkdir_p(File.join(options[:destination], options[:custom]))
+    def custom_library_configuration
+      custom_libraries.map { |name| "config.custom_library :#{name}" }.join("\n")
+    end
 
-    def library_configuration
-      libraries.map { |library| RailsIcons.libraries[library.to_sym].initializer_config }.join("\n")
+    def first_party_libraries
+      libraries.select { |library| RailsIcons.libraries.key?(library.to_sym) }
     end
 
-    def custom_configuration
-      <<~RB.indent(4)
-        #{options[:custom]}: {
-          # path: "app/assets/svg/icons/#{options[:custom]}/",
-          default: {
-            css: "size-6"
-          }
-        }
-      RB
+    def custom_libraries
+      libraries.reject { |library| RailsIcons.libraries.key?(library.to_sym) }
     end
 
     def default_configuration_exists?

data/lib/generators/rails_icons/install_generator.rb

@@ -12,15 +12,16 @@ module RailsIcons
     class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
     class_option :destination, type: :string, default: RailsIcons.configuration.icons_path, desc: "Specify destination folder for icons"
     class_option :skip_sync, type: :boolean, default: false
+    class_option :variants, type: :array, desc: "Only sync specific variants (e.g. solid outline)"
 
     def initializer_generator
       generate("rails_icons:initializer", *attributes)
     end
 
     def sync_generator
-      return if options[:skip_sync] || libraries.blank?
+      return if options[:skip_sync] || sync_libraries.blank?
 
-      generate("rails_icons:sync", *attributes)
+      generate("rails_icons:sync", "--libraries=#{sync_libraries.map(&:downcase).join(" ")}")
     end
 
     def add_route
@@ -34,13 +35,19 @@ module RailsIcons
     private
 
     def attributes
-      ["--libraries=#{libraries.map(&:downcase).join(" ")}", "--destination=#{options[:destination]}"].join(" ")
+      ["--libraries=#{libraries.map(&:downcase).join(" ")}", "--destination=#{options[:destination]}"].tap do |parts|
+        parts << "--variants=#{options[:variants].join(" ")}" if options[:variants].present?
+      end.join(" ")
     end
 
     def libraries
       [*options.libraries, options.library].compact_blank
     end
 
+    def sync_libraries
+      libraries.select { |library| RailsIcons.libraries.key?(library.to_sym) }
+    end
+
     def validatable? = true
   end
 end

data/lib/generators/rails_icons/sync_generator.rb

@@ -10,13 +10,18 @@ module RailsIcons
 
     class_option :library, type: :string, desc: "Choose a library (#{RailsIcons.libraries.keys.join("/")})"
     class_option :libraries, type: :array, default: [], desc: "Choose libraries (#{RailsIcons.libraries.keys.join("/")})"
+    class_option :variants, type: :array, desc: "Only sync specific variants (e.g. solid outline)"
 
     def sync_icons
-      libraries.each { |library| Icons::Sync.new(library).now }
+      libraries.each { |library| Icons::Sync.new(library, variants: variants).now }
     end
 
     private
 
+    def variants
+      options[:variants]&.map(&:to_sym)
+    end
+
     def libraries
       [options[:library], *options[:libraries]]
         .compact_blank

data/lib/rails_icons/base_generator.rb

@@ -13,10 +13,7 @@ module RailsIcons
     private
 
     def validate!
-      return if custom_library?
-
-      raise Icons::LibraryNotFound.new("") if libraries.empty?
-      raise Icons::LibraryNotFound.new(invalid_libraries.join(", ")) if invalid_libraries.any?
+      raise Icons::LibraryNotFound.new if libraries.empty?
     end
 
     def validatable? = false
@@ -25,14 +22,6 @@ module RailsIcons
       [*options.libraries, options.library].compact_blank
     end
 
-    def invalid_libraries
-      libraries.map(&:to_sym).map(&:downcase).reject { |library| RailsIcons.libraries.key?(library) }
-    end
-
-    def custom_library?
-      options.custom.present?
-    end
-
     # Uses `gsub_file` as a read-only operation to check file content. This
     # approach is preferred over `File.read` because `gsub_file` is properly stubbed
     # in generator tests, while `File.read` would fail in the test environment.

data/lib/rails_icons/helpers/sprite_helper.rb

@@ -9,6 +9,7 @@ module RailsIcons
       #
       # @param name [String] The icon name
       # @param library [String] The icon library (defaults to RailsIcons configuration)
+      # @param from [String] Syntactic sugar for a cleanly readable view layer API (preferred over `library`)
       # @param variant [String] The icon variant (optional)
       # @param sprite_location [String] Override sprite URL (optional)
       # @param arguments [Hash] Additional arguments including class, data, stroke_width, etc.
@@ -21,10 +22,10 @@ module RailsIcons
       #   <%= sprite_icon "check", variant: "solid", library: "heroicons" %>
       #   <%= sprite_icon "heart", library: "lucide", data: { controller: "favorite" } %>
       #
-      def sprite_icon(name, library: nil, variant: nil, sprite_location: nil, **arguments)
+      def sprite_icon(name, library: nil, from: library, variant: nil, sprite_location: nil, **arguments)
         Icons::SpriteIcon.new(
           name: name,
-          library: library || RailsIcons.configuration.default_library,
+          library: from || library || RailsIcons.configuration.default_library,
           variant: variant,
           sprite_location: sprite_location,
           arguments: arguments

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end

data/lib/rails_icons.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/numeric/time"
 require "icons"
 
 require_relative "rails_icons/version"
@@ -7,6 +8,8 @@ require_relative "rails_icons/engine"
 
 module RailsIcons
   class << self
+    attr_accessor :sprite_cache_expires_in
+
     # @yield [config] Yields a configuration object
     # @yieldparam config [Icons::Configuration]
     #
@@ -21,4 +24,6 @@ module RailsIcons
     #
     def libraries = Icons.libraries
   end
+
+  self.sprite_cache_expires_in = 1.hour
 end

data/rails_icons.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   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.homepage = "https://railsdesigner.com/open-source/rails-icons/"
   spec.license = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.files = Dir["{bin,app,config,db,lib,public}/**/*", "Rakefile", "README.md", "rails_icons.gemspec", "Gemfile", "Gemfile.lock"]
 
   spec.add_dependency "rails", ">= 7.0"
-  spec.add_dependency "icons", "~> 0.9.0"
+  spec.add_dependency "icons", "~> 0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
 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.
@@ -87,11 +87,11 @@ files:
 - lib/rails_icons/version.rb
 - lib/ruby_lsp/rails_icons/addon.rb
 - rails_icons.gemspec
-homepage: https://railsdesigner.com/rails-icons/
+homepage: https://railsdesigner.com/open-source/rails-icons/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://railsdesigner.com/rails-icons/
+  homepage_uri: https://railsdesigner.com/open-source/rails-icons/
   source_code_uri: https://github.com/Rails-Designer/rails_icons/
 rdoc_options: []
 require_paths:
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.14
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Add any icon library to a Rails app
 test_files: []