rails_icons 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9fa03b4c4eba2685fe4aec786f3c242f63b7b31768a5aa57787b0d8d6df62a3
-  data.tar.gz: 40ed83028f4f8e0f34e9236c89fa0b99141bef97d5d52289b3977d9589a40f50
+  metadata.gz: 6c3ee60bafe9a9cffae818c8304e8a69abf56d8de147ff607db5d775137ab5ea
+  data.tar.gz: afacf89281c87e029a0866860ef6edf1a738e06d5918b5254524c2bbe803bbd3
 SHA512:
-  metadata.gz: fe86f0d2d97bc7df912b7f0c7d74999550f3a83c217739c7ae3476b9cacaed44659d05c19a2e2b3bf950f1cc0fef1e95bfa5b30a8debe56619e4c1a787de19e4
-  data.tar.gz: 170d73d5eec70f42b1eab1367d6f6faa145f6e5f5a8c645c875be939dd90efa0639b50936adfcc5f675f34d232eddb83804496f208522410c5fdc26eec4d5b8c
+  metadata.gz: f1f4ed187c437220dc0b081dbddb95f1204f65a30dca2b89c4b72aba7574888d5adee9766a69821ecb26d2f9e9adff2e78d8b585ec7f639dd8d9754b0cb9296f
+  data.tar.gz: e195bd6ade61e3018a478852d293c8437d0c0490c5d8727d774098c98a10189b4be7d982f73ebb191ce5486a947f46c424265f46fe79fec3fe03ae3e45be543a

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_icons.gemspec
+gemspec
+
+gem "rails", "~> 7.0.6"
+gem "propshaft"
+
+group :development do
+  gem "standard"
+end
+
+group :development, :test do
+  gem "minitest"
+  gem "debug", "~> 1.9", ">= 1.9.2"
+end

data/Gemfile.lock

@@ -0,0 +1,228 @@
+PATH
+  remote: .
+  specs:
+    rails_icons (0.3.0)
+      nokogiri (~> 1.16, >= 1.16.4)
+      rails (> 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      activejob (= 7.0.8.1)
+      activerecord (= 7.0.8.1)
+      activestorage (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      actionview (= 7.0.8.1)
+      activejob (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.8.1)
+      actionview (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      activerecord (= 7.0.8.1)
+      activestorage (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.8.1)
+      activesupport (= 7.0.8.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.8.1)
+      activesupport (= 7.0.8.1)
+      globalid (>= 0.3.6)
+    activemodel (7.0.8.1)
+      activesupport (= 7.0.8.1)
+    activerecord (7.0.8.1)
+      activemodel (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+    activestorage (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      activejob (= 7.0.8.1)
+      activerecord (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    crass (1.0.6)
+    date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.22.3)
+    net-imap (0.4.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.1)
+    nokogiri (1.16.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    propshaft (0.8.0)
+      actionpack (>= 7.0.0)
+      activesupport (>= 7.0.0)
+      rack
+      railties (>= 7.0.0)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (2.2.9)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.8.1)
+      actioncable (= 7.0.8.1)
+      actionmailbox (= 7.0.8.1)
+      actionmailer (= 7.0.8.1)
+      actionpack (= 7.0.8.1)
+      actiontext (= 7.0.8.1)
+      actionview (= 7.0.8.1)
+      activejob (= 7.0.8.1)
+      activemodel (= 7.0.8.1)
+      activerecord (= 7.0.8.1)
+      activestorage (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      bundler (>= 1.15.0)
+      railties (= 7.0.8.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8.1)
+      actionpack (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.5.0)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  debug (~> 1.9, >= 1.9.2)
+  minitest
+  propshaft
+  rails (~> 7.0.6)
+  rails_icons!
+  standard
+
+BUNDLED WITH
+   2.5.9

data/README.md

@@ -1,39 +1,115 @@
-# RailsIcons
+# Rails Icons
 
-TODO: Delete this and the text below, and describe your gem
+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.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_icons`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
-## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Sponsored By [Rails Designer](https://railsdesigner.com/)
 
-Install the gem and add to the application's Gemfile by executing:
+<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" />
+</a>
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Install
+
+Add this line to your Gemfile:
+
+```ruby
+gem "rails_icons"
+```
+
+And run:
+
+```bash
+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
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# The default library is Heroicons, with "outline" as the default set
+icon "check"
 
-## Development
+# Use another set (options are: outline, solid, mini, micro)
+icon "check", set: "solid"
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Add CSS to the icon
+icon "check", class: "text-green-500"
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Add data attributes
+icon "check", data: { controller: "swap" }
 
-## Contributing
+# Tweak the stroke-width
+icon "check", stroke_width: 2
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eelcoj/rails_icons. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/eelcoj/rails_icons/blob/main/CODE_OF_CONDUCT.md).
 
-## License
+## Initializer
+
+```ruby
+RailsIcons.configure do |config|
+  # Set the default set for the library
+  config.default_library = "heroicons"
+  config.default_set = "outline"
+
+  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 = {}
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+  config.libraries.heroicons.mini.default.css = "w-5 h-5"
+  config.libraries.heroicons.mini.default.data = {}
 
-## Code of Conduct
+  config.libraries.heroicons.micro.default.css = "w-4 h-4"
+  config.libraries.heroicons.micro.default.data = {}
+end
+```
+
+Or run `rails generate rails_icons:initializer`.
+
+
+## Add a custom icon library
+
+```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
+```
+
+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"
+```
+
+
+## License
 
-Everyone interacting in the RailsIcons project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eelcoj/rails_icons/blob/main/CODE_OF_CONDUCT.md).
+Rails Icons is released under the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_icons"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

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/bin/release

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+if [ -z "$VERSION" ]; then
+  echo "Error: The version number is required."
+  echo "Usage: $0 <version-number>"
+  exit 1
+fi
+
+printf "module RailsIcons\n  VERSION = \"$VERSION\"\nend\n" > ./lib/rails_icons/version.rb
+bundle
+git add Gemfile.lock lib/rails_icons/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+gem build rails_icons.gemspec
+gem push "rails_icons-$VERSION.gem"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rails_icons/initializer_generator.rb

@@ -0,0 +1,9 @@
+module RailsIcons
+  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,51 @@
+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"
+
+    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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Configuration
+    def initialize
+      @config = ActiveSupport::OrderedOptions.new
+
+      set_default_config
+      set_libraries_config
+    end
+
+    def method_missing(method_name, ...)
+      if @config.respond_to?(method_name)
+        @config.send(method_name, ...)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name)
+      @config.respond_to?(method_name) || super
+    end
+
+    private
+
+    def set_default_config
+      @config.helper_name = "icon"
+      @config.default_library = "heroicons"
+      @config.default_set = "outline"
+    end
+
+    def set_libraries_config
+      @config.libraries = ActiveSupport::OrderedOptions.new
+
+      heroicons_config
+      lucide_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 = {}
+    end
+
+    def lucide_config
+      @config.libraries.lucide = ActiveSupport::OrderedOptions.new
+
+      @config.libraries.lucide.outline = ActiveSupport::OrderedOptions.new
+      @config.libraries.lucide.outline.default = ActiveSupport::OrderedOptions.new
+      @config.libraries.lucide.outline.default.stroke_width = 2
+      @config.libraries.lucide.outline.default.css = "w-6 h-6"
+      @config.libraries.lucide.outline.default.data = {}
+    end
+  end
+end

data/lib/rails_icons/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsIcons
+  end
+end

data/lib/rails_icons/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsIcons
+  class NotFound < StandardError; end
+end

data/lib/rails_icons/helpers/icon_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../configuration"
+
+module RailsIcons
+  module Helpers
+    module IconHelper
+      def icon(name, library: RailsIcons.configuration.default_library, set: nil, **args)
+        RailsIcons::Icon.new(
+          name: name,
+          library: library,
+          set: set,
+          args: args
+        ).svg
+      end
+    end
+  end
+end

data/lib/rails_icons/icon/attributes.rb

@@ -0,0 +1,39 @@
+module RailsIcons
+  class Icon
+    class Attributes
+      def initialize(default_attributes: {}, args: {})
+        @merged_attributes = default_attributes.merge(args)
+      end
+
+      def attach(to:)
+        @merged_attributes.each do |key, value|
+          if value.is_a?(Hash)
+            hash_attributes(key, value, to)
+          else
+            string_attributes(key, value, to)
+          end
+        end
+      end
+
+      private
+
+      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/rails_icons/icon.rb

@@ -0,0 +1,82 @@
+require "rails_icons/icon/attributes"
+
+class RailsIcons::Icon
+  def initialize(name:, library:, set:, args:)
+    @name = name
+    @library = library.to_s
+    @set = set
+    @args = args
+  end
+
+  def svg
+    raise RailsIcons::NotFound, error_message unless File.exist?(file_path)
+
+    svg_file = Nokogiri::HTML::DocumentFragment.parse(File.read(file_path)).at_css("svg")
+
+    attach_attributes to: svg_file
+
+    svg_file.to_html.html_safe
+  end
+
+  private
+
+  def error_message
+    "Icon not found: `#{@library} / #{set} / #{@name}`"
+  end
+
+  def file_path
+    custom_library.dig("path") ||
+      Rails.root.join("app", "assets", "svg", "icons", @library, set, "#{@name}.svg")
+  end
+
+  def custom_library?
+    custom_library.present?
+  end
+
+  def attach_attributes(to:)
+    RailsIcons::Icon::Attributes
+      .new(default_attributes: default_attributes, args: @args)
+      .attach(to: to)
+  end
+
+  def default_attributes
+    {
+      "stroke-width": default_stroke_width,
+      class: default_css,
+      data: default_data
+    }
+  end
+
+  def set
+    return @set if @set.present?
+
+    RailsIcons.configuration.default_set
+  end
+
+  def default_css
+    library_set_attributes.dig(:default, :css)
+  end
+
+  def default_data
+    library_set_attributes.dig(:default, :data)
+  end
+
+  def default_stroke_width
+    library_set_attributes.dig(:default, :stroke_width)
+  end
+
+  def library_set_attributes
+    return custom_library || {} if custom_library?
+
+    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/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_icons/helpers/icon_helper"
+
+module RailsIcons
+  class Railtie < Rails::Railtie
+    initializer "rails_icons.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include RailsIcons::Helpers::IconHelper
+      end
+    end
+  end
+end

data/lib/rails_icons/version.rb

@@ -1,3 +1,3 @@
 module RailsIcons
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/rails_icons.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
 require_relative "rails_icons/version"
+require_relative "rails_icons/engine"
+require_relative "rails_icons/configuration"
+require_relative "rails_icons/errors"
+require_relative "rails_icons/railtie"
+require_relative "rails_icons/icon"
 
 module RailsIcons
-  class Error < StandardError; end
-  # Your code goes here...
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.icons_directory
+    File.join("lib", "assets", "rails_icons")
+  end
 end

data/rails_icons.gemspec

@@ -6,33 +6,19 @@ Gem::Specification.new do |spec|
   spec.name = "rails_icons"
   spec.version = RailsIcons::VERSION
   spec.authors = ["Rails Designer Developers"]
-  spec.email = ["developers@railsdesigner.com"]
+  spec.email = ["devs@railsdesigner.com"]
 
   spec.summary = "Add icons from multiple icons in your Rails app"
   spec.description = "Add SVG icons from multiple libraries, or your own custom icon set with this one gem."
-  spec.homepage = "https://github.com/Rails-Designer/rails_icons/"
+  spec.homepage = "https://railsdesigner.com/rails-icons/"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Rails-Designer/rails_icons/"
-  spec.metadata["changelog_uri"] = "https://github.com/Rails-Designer/rails_icons/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.files = Dir["{bin,app,config,db,lib,public}/**/*", "Rakefile", "README.md", "rails_icons.gemspec", "Gemfile", "Gemfile.lock"]
 
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.add_dependency "rails", "> 6.1"
+  spec.add_runtime_dependency "nokogiri", "~> 1.16", ">= 1.16.4"
 end

metadata

@@ -1,40 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: rails_icons
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
-dependencies: []
+date: 2024-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !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 SVG icons from multiple libraries, or your own custom icon set with
   this one gem.
 email:
-- developers@railsdesigner.com
+- devs@railsdesigner.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
+- bin/console
+- bin/rails
+- bin/release
+- bin/setup
+- lib/generators/rails_icons/initializer_generator.rb
+- lib/generators/rails_icons/sync_generator.rb
+- lib/generators/rails_icons/templates/initializer.rb.tt
 - lib/rails_icons.rb
+- lib/rails_icons/configuration.rb
+- lib/rails_icons/engine.rb
+- lib/rails_icons/errors.rb
+- lib/rails_icons/helpers/icon_helper.rb
+- lib/rails_icons/icon.rb
+- lib/rails_icons/icon/attributes.rb
+- lib/rails_icons/railtie.rb
 - lib/rails_icons/version.rb
 - rails_icons.gemspec
-- sig/rails_icons.rbs
-homepage: https://github.com/Rails-Designer/rails_icons/
+homepage: https://railsdesigner.com/rails-icons/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Rails-Designer/rails_icons/
+  homepage_uri: https://railsdesigner.com/rails-icons/
   source_code_uri: https://github.com/Rails-Designer/rails_icons/
-  changelog_uri: https://github.com/Rails-Designer/rails_icons/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -50,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Add icons from multiple icons in your Rails app

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 3.0

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-02-28
-
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at git@eelcoj.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 eelco
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/sig/rails_icons.rbs

@@ -1,4 +0,0 @@
-module RailsIcons
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end