phlex-icons-remix 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2d66c30eab49173a6a6a18e85ca7884ac484350bebf6f465cc5df2dcb7080d7
-  data.tar.gz: 9bac12577d0d2b5a0dc7ee28c643609f11624d6816677fb82dc3158b12fc6d17
+  metadata.gz: f6c21eca776c471d855307fec09079b679cdcf48791101eb8507c72ca0e0e301
+  data.tar.gz: 11667fb9034a1516d5ca339d256896bd342cff93b8d740ff70c760b85073db29
 SHA512:
-  metadata.gz: 5a39e56dcd0e8ec49195b3051709335d5b6813bef0bc6fb49314dae4a4887902528c7cc545b0cf3906d1c2090377287bdf579b1d7bb937359580891bdac6ad38
-  data.tar.gz: 4387ccc4702f2314fb57ea6d110daa06d50a18686ca38d0c9e0fea0e8eac022590be0aeb6d3c14ded4f9e4d8ad6d6ac481867332c54e185642efcc09f7f5d6d6
+  metadata.gz: e7fbede384fae5afb92579012f853798b9a83ecca222d127a4ac94bfedc4192a1a961dfaf01a58de5e809517207ef044351a1dd7af87e028438e43eacdfa4b20
+  data.tar.gz: c98480dab4e08aa020d2c73a93c41be4ccf1dc0d765dba42f2a8260c47455abf4dd44ccf5105e20e525f7c16d312f3f38acaec24d668242af9fd5cf075f599ce

data/README.md

@@ -10,13 +10,14 @@
 
 # Phlex::Icons
 
-General icons extension for [Phlex](https://phlex.fun). Includes more than 🎨 7,300 icons from:
+General icons extension for [Phlex](https://phlex.fun). Includes more than 🎨 12,000 icons from:
 - [Bootstrap Icons](https://icons.getbootstrap.com) (2,000+)
 - [Flag Icons](https://flagicons.lipis.dev) (250+)
 - [Heroicons](https://heroicons.com) (300+)
 - [Lucide Icons](https://lucide.dev/icons) (1,500+)
 - [RadixUI Icons](https://radix-ui.com/icons) (300+)
 - [Remix Icons](https://remixicon.com) (2,800+)
+- [Tabler Icons](https://tabler.io/icons) (4,800+)
 
 And happy to extend to other icon packs!
 
@@ -40,6 +41,16 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install phlex-icons
 ```
 
+If you don't want to add all icon packs to your application, you can add a specific icon pack by using one (or multiple) of the following gems:
+
+- [phlex-icons-bootstrap](https://rubygems.org/gems/phlex-icons-bootstrap)
+- [phlex-icons-flag](https://rubygems.org/gems/phlex-icons-flag)
+- [phlex-icons-hero](https://rubygems.org/gems/phlex-icons-hero)
+- [phlex-icons-lucide](https://rubygems.org/gems/phlex-icons-lucide)
+- [phlex-icons-radix](https://rubygems.org/gems/phlex-icons-radix)
+- [phlex-icons-remix](https://rubygems.org/gems/phlex-icons-remix)
+- [phlex-icons-tabler](https://rubygems.org/gems/phlex-icons-tabler)
+
 ## Configuration
 
 The gem provides global configuration options, and per icons pack configuration options.
@@ -96,8 +107,44 @@ Nothing to configure for RadixUI Icons.
 
 Nothing to configure for Remix Icons.
 
+### Tabler Icons configuration
+
+```ruby
+Phlex::Icons::Tabler.configure do |config|
+  config.default_variant = :outline # or :filled
+end
+
+# OR
+
+Phlex::Icons::Tabler.configuration.default_variant = :outline # or :filled
+```
+
 ## Usage
 
+### With `Phlex::Kit`
+
+```ruby
+require 'phlex_icons'
+
+class PhlexIcons < Phlex::HTML
+  include Phlex::Icons
+
+  def view_template
+    div do
+      Bootstrap::House(classes: 'size-4')
+      Flag::Sa(variant: :rectangle, classes: 'size-4')
+      Hero::Home(variant: :solid, classes: 'size-4')
+      Lucide::House(classes: 'size-4')
+      Radix::Home(classes: 'size-4')
+      Remix::HomeLine(classes: 'size-4')
+      Tabler::Home(variant: :filled, classes: 'size-4')
+    end
+  end
+end
+```
+
+### Without `Phlex::Kit`
+
 ```ruby
 require 'phlex_icons'
 
@@ -110,6 +157,7 @@ class PhlexIcons < Phlex::HTML
       render Phlex::Icons::Lucide::House.new(classes: 'size-4')
       render Phlex::Icons::Radix::Home.new(classes: 'size-4')
       render Phlex::Icons::Remix::HomeLine.new(classes: 'size-4')
+      render Phlex::Icons::Tabler::Home.new(variant: :filled, classes: 'size-4')
     end
   end
 end

data/generators/helper.rb

@@ -2,6 +2,7 @@
 
 require 'erb'
 require 'fileutils'
+require 'zeitwerk' # Needed by Phlexing
 require 'phlexing'
 require 'tqdm'
 
@@ -19,8 +20,9 @@ def run_generator(&block)
 
   print '⌛ Creating icon components...'
   yield block
-  puts "\r🎉 Icon components created successfully!"
+  puts "\e[2K\r🎉 Icon components created successfully!"
 
+  make_components_lazy_loadable(ICONS_PACK_PATH)
   run_rubocop(ICONS_PACK_PATH)
   delete_repo(REPO_NAME)
 end
@@ -29,14 +31,14 @@ def clone_repo(repo_url, repo_name)
   print "⌛ Cloning '#{repo_name}' repo..."
 
   if Dir.exist?("generators/#{repo_name}")
-    puts "\r✅ '#{repo_name}' repo already exists"
+    puts "\e[2K\r✅ '#{repo_name}' repo already exists"
 
     return
   end
 
   system!("git clone #{repo_url} generators/#{repo_name}")
 
-  puts "\r🎉 '#{repo_name}' repo cloned successfully!"
+  puts "\e[2K\r🎉 '#{repo_name}' repo cloned successfully!"
 end
 
 def prepare_phlex_icons_pack_directory(icons_pack_path)
@@ -50,13 +52,13 @@ def prepare_phlex_icons_pack_directory(icons_pack_path)
     File.delete(file)
   end
 
-  puts "\r🎉 '#{icons_pack_path}' directory prepared successfully!"
+  puts "\e[2K\r🎉 '#{icons_pack_path}' directory prepared successfully!"
 end
 
 def component_file_name(icon_file_name, replacements = nil)
   replacements ||= {}
 
-  icon_name = File.basename(icon_file_name, '.svg')
+  icon_name = File.basename(icon_file_name, File.extname(icon_file_name))
 
   replacements.each do |key, value|
     icon_name = icon_name.gsub(key, value) if icon_name.start_with?(key)
@@ -68,13 +70,32 @@ end
 def component_class_name(icon_file_name, replacements = nil)
   replacements ||= {}
 
-  icon_name = File.basename(icon_file_name, '.svg')
+  icon_name = File.basename(icon_file_name, File.extname(icon_file_name))
 
   replacements.each do |key, value|
     icon_name = icon_name.gsub(key, value) if icon_name.start_with?(key)
   end
 
-  icon_name.gsub('-', ' ').split.map(&:capitalize).join
+  icon_name.gsub(/[-_]/, ' ').split.map(&:capitalize).join
+end
+
+def make_components_lazy_loadable(path)
+  print '⌛ Making components lazy-loadable...'
+
+  autoload_lines = Dir.glob("#{path}/*.rb").map do |file|
+    next if ['base.rb', 'configuration.rb'].include?(File.basename(file))
+
+    "      autoload :#{component_class_name(file)}, '#{file.split('/', 2).last.chomp(File.extname(file))}'"
+  end.compact.join("\n")
+
+  new_content = File.read("#{path}.rb").gsub(
+    /# auto-generated autoload: start.*# auto-generated autoload: end/m,
+    "# auto-generated autoload: start\n#{autoload_lines}\n      # auto-generated autoload: end"
+  )
+
+  File.write("#{path}.rb", new_content)
+
+  puts "\e[2K\r🎉 Components are lazy-loadable!"
 end
 
 def run_rubocop(path)
@@ -86,7 +107,7 @@ def run_rubocop(path)
     File.write(file, File.read(file).gsub('rubocop:enable ,', 'rubocop:enable '))
   end
 
-  puts "\r🎉 RuboCop ran successfully!"
+  puts "\e[2K\r🎉 RuboCop ran successfully!"
 end
 
 def delete_repo(repo_name)
@@ -94,7 +115,7 @@ def delete_repo(repo_name)
 
   FileUtils.rm_rf("generators/#{repo_name}")
 
-  puts "\r🎉 '#{repo_name}' repo deleted successfully!"
+  puts "\e[2K\r🎉 '#{repo_name}' repo deleted successfully!"
 end
 
 def system!(command)

data/generators/tabler.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+REPO_URL = 'https://github.com/tabler/tabler-icons.git'
+REPO_NAME = 'tabler-tabler-icons'
+ICONS_PACK_PATH = 'lib/phlex/icons/tabler'
+
+TEMPLATE = ERB.new <<~TEMPLATE
+  # frozen_string_literal: true
+
+  # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
+  module Phlex
+    module Icons
+      module Tabler
+        class <%= icon_name %> < Base
+          def filled
+            <%= filled_icon %>
+          end
+
+          def outline
+            <%= outline_icon %>
+          end
+        end
+      end
+    end
+  end
+  # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
+TEMPLATE
+
+def main
+  run_generator { icon_file_names.tqdm.each { create_icon_component(_1) } }
+end
+
+def icon_file_names
+  Dir.glob("generators/#{REPO_NAME}/icons/outline/*").map { |file| File.basename(file) }
+end
+
+def create_icon_component(icon_file_name)
+  File.write(
+    File.join(ICONS_PACK_PATH, component_file_name(icon_file_name)),
+    TEMPLATE.result_with_hash(
+      icon_name: component_class_name(icon_file_name),
+      filled_icon: read_and_convert_icon(filled_icon_file_path(icon_file_name)),
+      outline_icon: read_and_convert_icon(outline_icon_file_path(icon_file_name))
+    )
+  )
+end
+
+def read_and_convert_icon(icon_file_path)
+  return 'raise NotImplementedError' unless File.exist?(icon_file_path)
+
+  icon_file_content = File.read(icon_file_path)
+                          .gsub!(/<!--.*?-->/m, '')
+                          .sub('width="24"', '')
+                          .sub('height="24"', '')
+
+  Phlexing::Converter.convert(icon_file_content).sub('svg(', "svg(\nclass: classes,")
+end
+
+def filled_icon_file_path(icon_file_name)
+  "generators/#{REPO_NAME}/icons/filled/#{icon_file_name}"
+end
+
+def outline_icon_file_path(icon_file_name)
+  "generators/#{REPO_NAME}/icons/outline/#{icon_file_name}"
+end
+
+main if __FILE__ == $PROGRAM_NAME