rails_icons 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 183c2ae878b4af7bf52a02fdedd8c4c9b2c4f9fe94b966e816c8096fbb5d21cb
-  data.tar.gz: 56dafa4a397e7dc1939f2e603ce9a4992d337cb40af86848bd7e019b403a5f38
+  metadata.gz: 3b822f3cdeb49bbe4e7d23109b89d0508e4b23e39c5da7b1c26a633977744b6f
+  data.tar.gz: 0becd12bf8f1a1ce9ae6f35877cb8c0ef936d8b6e2693d04849c8716fccb8c7e
 SHA512:
-  metadata.gz: 87524d0281d139697c38928df954c5103392d8aab8ef47b28143f558ad048233751b0404ad8360f576f68b4f295a23d4eb0a226368b63641d0f485ac602553bf
-  data.tar.gz: 8c2bf2f4e65a11916ccff08f2ec4ae85b593b18b09612e26db3604804eece1dcdf0632b88b7f3c37532aab8429607f7bb4f33b5fd8f70e4d4d4c3d1702397424
+  metadata.gz: b34876d807ff8d3bb63faae9cb71d9a5527eee3543b1ce8b37034fe7719e8420149a202c3d1be2b0251d04fa7ebc0e52d0b6628570a045b8c469f84d56e3aace
+  data.tar.gz: 81f8bd92e599e2fa2ff1421ab75ff334728f06792063dfd7ae2a74a0559ae5b73778192e64c1d772ea1fb2e2cb32e43cecd809e0985d91f3386488f9f87d0810

data/Gemfile.lock

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

data/README.md

@@ -1,19 +1,17 @@
 # Rails Icons
 
-Embed any library's icon in your Rails app. There are many icon gem's 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.
+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.
 
-Supported libraries:
-
-- [Heroicons](https://heroicons.com/)
-- …[more coming](https://github.com/rails-designer/rails_icons/issues)
+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.
 
 
 ## 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" />
+  <img src="https://raw.githubusercontent.com/Rails-Designer/rails_icons/main/docs/rails_designer_icon.jpg" alt="Rails Designer logo"  width="300" />
 </a>
 
+
 ## Install
 
 Add this line to your Gemfile:
@@ -28,6 +26,12 @@ And run:
 bundle
 ```
 
+Sync any of the supported icon libraries from the
+[rails_icons_vault](https://github.com/Rails-Designer/rails_icons_vault):
+
+```bash
+rails generate rails_icons:sync heroicons
+```
 
 
 ## Usage
@@ -55,8 +59,8 @@ icon "check", stroke_width: 2
 ```ruby
 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.default_library = "heroicons"
+  config.default_set = "outline"
 
   config.libraries.heroicons.solid.default.css = "w-6 h-6"
   config.libraries.heroicons.solid.default.data = {}
@@ -73,6 +77,8 @@ RailsIcons.configure do |config|
 end
 ```
 
+Or run `rails generate rails_icons:initializer`.
+
 
 ## Add a custom icon library
 
@@ -104,6 +110,11 @@ icon "reddit", library: "simple_icons", set: "solid"
 ```
 
 
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `be standardrb` before submitting pull requests. Run tests via `rails test`.
+
+
 ## License
 
 Rails Icons is released under the [MIT License](https://opensource.org/licenses/MIT).

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/rails_icons/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+
+require "action_controller/railtie"
+require "action_view/railtie"
+
+require "rails/engine/commands"

data/lib/generators/rails_icons/initializer_generator.rb

@@ -0,0 +1,12 @@
+# 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__)
+
+    def copy_initializer
+      copy_file "initializer.rb", "config/initializers/rails_icons.rb"
+    end
+  end
+end

data/lib/generators/rails_icons/sync_generator.rb

@@ -0,0 +1,52 @@
+require "fileutils"
+
+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)
+
+      if system("git clone '#{ICON_VAULT_REPO_URL}' '#{tmp_dir}'")
+        say "Repository cloned successfully.", :green
+      else
+        say "Failed to clone repository.", :red
+
+        exit 1
+      end
+
+      libraries.each do |set|
+        set_path = File.join(tmp_dir, "icons", set)
+
+        if Dir.exist?(set_path)
+          destination_path = File.join(icons_dir, set)
+
+          FileUtils.mkdir_p(destination_path)
+          FileUtils.cp_r(Dir.glob("#{set_path}/*"), destination_path)
+
+          say "Synced `#{set}` icons for set", :green
+        else
+          say "Icon set `#{set}` not found", :red
+
+          exit 1
+        end
+      end
+
+      FileUtils.rm_rf(tmp_dir)
+
+      say "Icons synced successfully", :green
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+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.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "icon_configs/heroicons_config"
+require_relative "icon_configs/lucide_config"
+require_relative "icon_configs/tabler_config"
+
 module RailsIcons
+  # Configuration defines the available configuration options available for each of the icons sets
+  # as well as sets the defaults to heroicons
   class Configuration
     def initialize
       @config = ActiveSupport::OrderedOptions.new
@@ -32,32 +38,9 @@ module RailsIcons
     def set_libraries_config
       @config.libraries = ActiveSupport::OrderedOptions.new
 
-      heroicons_config
-    end
-
-    def heroicons_config
-      @config.libraries.heroicons = ActiveSupport::OrderedOptions.new
-
-      @config.libraries.heroicons.solid = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.solid.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.solid.default.css = "w-6 h-6"
-      @config.libraries.heroicons.solid.default.data = {}
-
-      @config.libraries.heroicons.outline = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.outline.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.outline.default.stroke_width = 1.5
-      @config.libraries.heroicons.outline.default.css = "w-6 h-6"
-      @config.libraries.heroicons.outline.default.data = {}
-
-      @config.libraries.heroicons.mini = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.mini.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.mini.default.css = "w-5 h-5"
-      @config.libraries.heroicons.mini.default.data = {}
-
-      @config.libraries.heroicons.micro = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.micro.default = ActiveSupport::OrderedOptions.new
-      @config.libraries.heroicons.micro.default.css = "w-4 h-4"
-      @config.libraries.heroicons.micro.default.data = {}
+      @config.libraries.heroicons = HeroiconsConfig.new.config
+      @config.libraries.lucide = LucideConfig.new.config
+      @config.libraries.tabler = TablerConfig.new.config
     end
   end
 end

data/lib/rails_icons/helpers/icon_helper.rb

@@ -4,6 +4,7 @@ require_relative "../configuration"
 
 module RailsIcons
   module Helpers
+    # Define the "icon" helper to generate and display icons
     module IconHelper
       def icon(name, library: RailsIcons.configuration.default_library, set: nil, **args)
         RailsIcons::Icon.new(

data/lib/rails_icons/icon/attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsIcons
   class Icon
     class Attributes

data/lib/rails_icons/icon.rb

@@ -25,39 +25,20 @@ class RailsIcons::Icon
   end
 
   def file_path
-    if custom_library?
-      Rails.root.join(custom_path, "#{@name}.svg")
-    else
-      RailsIcons::Engine
-        .root
-        .join(RailsIcons.icons_directory, @library, set, "#{@name}.svg")
-    end
+    custom_library.dig("path") ||
+      Rails.root.join("app", "assets", "svg", "icons", @library, set, "#{@name}.svg")
   end
 
   def custom_library?
     custom_library.present?
   end
 
-  def custom_path
-    custom_library.dig("path") ||
-      Rails.root.join("app", "assets", "svg", @library, set)
-  end
-
   def attach_attributes(to:)
     RailsIcons::Icon::Attributes
       .new(default_attributes: default_attributes, args: @args)
       .attach(to: to)
   end
 
-  def custom_library
-    RailsIcons
-      .configuration
-      .libraries
-      .dig("custom")
-      &.with_indifferent_access
-      &.dig(@library, set)
-  end
-
   def default_attributes
     {
       "stroke-width": default_stroke_width,
@@ -89,4 +70,13 @@ class RailsIcons::Icon
 
     RailsIcons.configuration.libraries.dig(@library, set) || {}
   end
+
+  def custom_library
+    RailsIcons
+      .configuration
+      .libraries
+      .dig("custom")
+      &.with_indifferent_access
+      &.dig(@library, set) || {}
+  end
 end

data/lib/rails_icons/icon_configs/heroicons_config.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  # Defines the configuration options for the heroicons icon pack
+  class HeroiconsConfig
+    def config
+      options = ActiveSupport::OrderedOptions.new
+      setup_heroicons_outline_config(options)
+      setup_heroicons_solid_config(options)
+      setup_heroicons_mini_config(options)
+      setup_heroicons_micro_config(options)
+      options
+    end
+
+    private
+
+    def setup_heroicons_solid_config(options)
+      options.solid = ActiveSupport::OrderedOptions.new
+      options.solid.default = default_solid_options
+    end
+
+    def setup_heroicons_outline_config(options)
+      options.outline = ActiveSupport::OrderedOptions.new
+      options.outline.default = default_outline_options
+    end
+
+    def setup_heroicons_mini_config(options)
+      options.mini = ActiveSupport::OrderedOptions.new
+      options.mini.default = default_mini_options
+    end
+
+    def setup_heroicons_micro_config(options)
+      options.micro = ActiveSupport::OrderedOptions.new
+      options.micro.default = default_micro_options
+    end
+
+    def default_solid_options
+      options = ActiveSupport::OrderedOptions.new
+      options.css = "w-6 h-6"
+      options.data = {}
+      options
+    end
+
+    def default_outline_options
+      options = ActiveSupport::OrderedOptions.new
+      options.stroke_width = 1.5
+      options.css = "w-6 h-6"
+      options.data = {}
+      options
+    end
+
+    def default_mini_options
+      options = ActiveSupport::OrderedOptions.new
+      options.css = "w-5 h-5"
+      options.data = {}
+      options
+    end
+
+    def default_micro_options
+      options = ActiveSupport::OrderedOptions.new
+      options.css = "w-4 h-4"
+      options.data = {}
+      options
+    end
+  end
+end

data/lib/rails_icons/icon_configs/lucide_config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  # Defines the configuration options for the Lucide icon pack
+  class LucideConfig
+    def config
+      options = ActiveSupport::OrderedOptions.new
+      setup_lucide_outlined_config(options)
+
+      options
+    end
+
+    private
+
+    def setup_lucide_outlined_config(options)
+      options.outline = ActiveSupport::OrderedOptions.new
+      options.outline.default = default_outlined_options
+    end
+
+    def default_outlined_options
+      options = ActiveSupport::OrderedOptions.new
+      options.stroke_width = "1.5"
+      options.css = "w-6 h-6"
+      options.data = {}
+      options
+    end
+  end
+end

data/lib/rails_icons/icon_configs/tabler_config.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  # Defines the configuration options for the Tabler icon pack
+  class TablerConfig
+    def config
+      options = ActiveSupport::OrderedOptions.new
+      setup_tabler_filled_config(options)
+      setup_tabler_outline_config(options)
+
+      options
+    end
+
+    private
+
+    def setup_tabler_filled_config(options)
+      options.filled = ActiveSupport::OrderedOptions.new
+      options.filled.default = default_filled_options
+    end
+
+    def setup_tabler_outline_config(options)
+      options.outline = ActiveSupport::OrderedOptions.new
+      options.outline.default = default_outline_options
+    end
+
+    def default_filled_options
+      options = ActiveSupport::OrderedOptions.new
+      options.css = "w-6 h-6"
+      options.data = {}
+      options
+    end
+
+    def default_outline_options
+      options = ActiveSupport::OrderedOptions.new
+      options.stroke_width = 2
+      options.css = "w-6 h-6"
+      options.data = {}
+      options
+    end
+  end
+end

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end