phlex-icons-flag 1.8.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc355e911e22fe94843ca4c6f4eb06a5addd2950a51e9b1776883eac6b323af5
-  data.tar.gz: aafc256dbf5a491bff523937624a88c2a6fa7618b10efd99dbfcb420a223234b
+  metadata.gz: 6701db72f7274a2c0bc051a4db9e1f3dfdb2f9edff0371f37f1db79d89a99369
+  data.tar.gz: c3da9c764cdbb98dc87a2b82b1760d9a117e713d8b1a8e8234be23364eef784a
 SHA512:
-  metadata.gz: e17edd4bc20508079243f772eee783109f350e8e703d55e9e39ed81f9e4360cd037863436596317e52af41f93b1101be605252344ad111f0899ad9c500ad7bb6
-  data.tar.gz: bbc19a86223de39bd6d0106eee905fd45001566553ad3bc20649d1f29e8c208b1d05786e552298722292c5c74729fd467e76fd17589fd7b7cb89e73000f3f309
+  metadata.gz: e0cf2cf40812fd92c5e20b90894d1a37d998154a0bfec5f0d848552456863a8a0960fd3ecea2cf228aad55f55a8f2552bf6da10ab84621694a4bd98d750438ec
+  data.tar.gz: 5294124a1c80043e1ab0305794491f47e1ae48a4a3a3e7ebd2402d39a94ba739764d386cfdd2f83b4841a403ce7f1e7416d5c6dff9eeb6059af51e37bde1ea86

data/README.md

@@ -8,7 +8,7 @@
 
 </div>
 
-# Phlex::Icons
+# PhlexIcons
 
 General icons extension for [Phlex](https://phlex.fun). Includes more than 🎨 12,000 icons from:
 - [Bootstrap Icons](https://icons.getbootstrap.com) (2,000+)
@@ -58,13 +58,13 @@ The gem provides global configuration options, and per icons pack configuration
 ### Global configuration
 
 ```ruby
-Phlex::Icons.configure do |config|
+PhlexIcons.configure do |config|
   config.default_classes = 'size-6'
 end
 
 # OR
 
-Phlex::Icons.configuration.default_classes = 'size-6'
+PhlexIcons.configuration.default_classes = 'size-6'
 ```
 
 ### Bootstrap Icons configuration
@@ -74,25 +74,25 @@ Nothing to configure for Bootstrap Icons.
 ### Flag Icons configuration
 
 ```ruby
-Phlex::Icons::Flag.configure do |config|
+PhlexIcons::Flag.configure do |config|
   config.default_variant = :square # or :rectangle
 end
 
 # OR
 
-Phlex::Icons::Flag.configuration.default_variant = :square # or :rectangle
+PhlexIcons::Flag.configuration.default_variant = :square # or :rectangle
 ```
 
 ### Heroicons configuration
 
 ```ruby
-Phlex::Icons::Hero.configure do |config|
+PhlexIcons::Hero.configure do |config|
   config.default_variant = :solid # or :outline
 end
 
 # OR
 
-Phlex::Icons::Hero.configuration.default_variant = :solid # or :outline
+PhlexIcons::Hero.configuration.default_variant = :solid # or :outline
 ```
 
 ### Lucide Icons configuration
@@ -110,13 +110,13 @@ Nothing to configure for Remix Icons.
 ### Tabler Icons configuration
 
 ```ruby
-Phlex::Icons::Tabler.configure do |config|
+PhlexIcons::Tabler.configure do |config|
   config.default_variant = :outline # or :filled
 end
 
 # OR
 
-Phlex::Icons::Tabler.configuration.default_variant = :outline # or :filled
+PhlexIcons::Tabler.configuration.default_variant = :outline # or :filled
 ```
 
 ## Usage
@@ -127,7 +127,7 @@ Phlex::Icons::Tabler.configuration.default_variant = :outline # or :filled
 require 'phlex-icons' # No need to require the gem if you are using it in a Rails application.
 
 class PhlexIcons < Phlex::HTML
-  include Phlex::Icons
+  include PhlexIcons
 
   def view_template
     div do
@@ -151,13 +151,13 @@ require 'phlex-icons' # No need to require the gem if you are using it in a Rail
 class PhlexIcons < Phlex::HTML
   def view_template
     div do
-      render Phlex::Icons::Bootstrap::House.new(class: 'size-4')
-      render Phlex::Icons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
-      render Phlex::Icons::Hero::Home.new(variant: :solid, class: 'size-4')
-      render Phlex::Icons::Lucide::House.new(class: 'size-4')
-      render Phlex::Icons::Radix::Home.new(class: 'size-4')
-      render Phlex::Icons::Remix::HomeLine.new(class: 'size-4')
-      render Phlex::Icons::Tabler::Home.new(variant: :filled, class: 'size-4')
+      render PhlexIcons::Bootstrap::House.new(class: 'size-4')
+      render PhlexIcons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
+      render PhlexIcons::Hero::Home.new(variant: :solid, class: 'size-4')
+      render PhlexIcons::Lucide::House.new(class: 'size-4')
+      render PhlexIcons::Radix::Home.new(class: 'size-4')
+      render PhlexIcons::Remix::HomeLine.new(class: 'size-4')
+      render PhlexIcons::Tabler::Home.new(variant: :filled, class: 'size-4')
     end
   end
 end
@@ -176,7 +176,7 @@ require 'phlex-icons-flag' # No need to require the gem if you are using it in a
 require 'phlex-icons-hero' # No need to require the gem if you are using it in a Rails application.
 
 class PhlexIcons < Phlex::HTML
-  include Phlex::Icons # If you want to use Phlex::Kit.
+  include PhlexIcons # If you want to use Phlex::Kit.
 
   def view_template
     div do
@@ -185,8 +185,8 @@ class PhlexIcons < Phlex::HTML
       Hero::Home(variant: :solid, class: 'size-4')
 
       # Without Phlex::Kit.
-      render Phlex::Icons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
-      render Phlex::Icons::Hero::Home.new(variant: :solid, class: 'size-4')
+      render PhlexIcons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
+      render PhlexIcons::Hero::Home.new(variant: :solid, class: 'size-4')
     end
   end
 end
@@ -194,34 +194,30 @@ end
 
 ### Add custom icons to your Rails application
 
-You can extend the gem in your Rails application to add new icons by creating a `phlex/icons/custom` directory inside `views/components` directory. Then, you can create a new component for each icon you want to add. For example:
+You can extend the gem in your Rails application to add new icons by creating a `phlex-icons/custom` directory inside `views/components` directory. Then, you can create a new component for each icon you want to add. For example:
 
 ```ruby
-# app/views/components/phlex/icons/custom/icon_class_name.rb
-
-module Phlex
-  module Icons
-    module Custom
-      class IconClassName < Phlex::Icons::Base
-        def view_template
-          # SVG code here.
-        end
+# app/views/components/phlex-icons/custom/icon_class_name.rb
+
+module PhlexIcons
+  module Custom
+    class IconClassName < PhlexIcons::Base
+      def view_template
+        # SVG code here.
       end
     end
   end
 end
 ```
 
-Finally, you will need to create a `Phlex::Icons::Custom` module in `phlex/icons/custom.rb` file to include your custom icons and make them a `Phlex::Kit`:
+Finally, you will need to create a `PhlexIcons::Custom` module in `phlex-icons/custom.rb` file to include your custom icons and make them a `Phlex::Kit`:
 
 ```ruby
-# app/views/components/phlex/icons/custom.rb
+# app/views/components/phlex-icons/custom.rb
 
-module Phlex
-  module Icons
-    module Custom
-      extend Phlex::Kit
-    end
+module PhlexIcons
+  module Custom
+    extend Phlex::Kit
   end
 end
 ```
@@ -234,7 +230,7 @@ All icon packs provided in this gem are auto-generated by their generator under
 
 ## What is the icon pack version used in the gem?
 
-Each icon pack contains a `VERSION` constant in its module represents the version of the icon pack used in the gem. So, for example, to get the Bootstrap version used in the gem you can access it by `Phlex::Icons::Bootstrap::VERSION`.
+Each icon pack contains a `VERSION` constant in its module represents the version of the icon pack used in the gem. So, for example, to get the Bootstrap version used in the gem you can access it by `PhlexIcons::Bootstrap::VERSION`.
 
 ## Development
 
@@ -252,4 +248,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Phlex::Icons project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AliOsm/phlex-icons/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PhlexIcons project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AliOsm/phlex-icons/blob/master/CODE_OF_CONDUCT.md).

data/generators/bootstrap.rb

@@ -4,20 +4,18 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/twbs/icons.git'
 REPO_NAME = 'twbs-icons'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/bootstrap.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/bootstrap'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/bootstrap.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/bootstrap'
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Bootstrap
-        class <%= icon_name %> < Base
-          def view_template
-            <%= icon %>
-          end
+  module PhlexIcons
+    module Bootstrap
+      class <%= icon_name %> < Base
+        def view_template
+          <%= icon %>
         end
       end
     end

data/generators/flag.rb

@@ -4,24 +4,23 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/lipis/flag-icons.git'
 REPO_NAME = 'lipis-flag-icons'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/flag.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/flag'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/flag.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/flag'
+VARIANTS = %i[square rectangle].freeze
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Flag
-        class <%= icon_name %> < Base
-          def square
-            <%= square_icon %>
-          end
-
-          def rectangle
-            <%= rectangle_icon %>
-          end
+  module PhlexIcons
+    module Flag
+      class <%= icon_name %> < Base
+        def square
+          <%= square_icon %>
+        end
+
+        def rectangle
+          <%= rectangle_icon %>
         end
       end
     end
@@ -29,6 +28,22 @@ TEMPLATE = ERB.new <<~TEMPLATE
   # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
 TEMPLATE
 
+VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
+  # frozen_string_literal: true
+
+  # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
+  module PhlexIcons
+    module Flag
+      class <%= icon_name %><%= variant.to_s.capitalize %> < Base
+        def view_template
+          render <%= icon_name %>.new(variant: :<%= variant %>)
+        end
+      end
+    end
+  end
+  # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
+VARIANT_TEMPLATE
+
 def main
   run_generator do
     new_version = JSON.parse(File.read("generators/#{REPO_NAME}/package.json"))['version']
@@ -51,6 +66,16 @@ def create_icon_component(icon_file_name)
       rectangle_icon: read_and_convert_icon(rectangle_icon_file_path(icon_file_name))
     )
   )
+
+  VARIANTS.each do |variant|
+    File.write(
+      File.join(ICONS_PACK_PATH, variant_component_file_name(icon_file_name, variant)),
+      VARIANT_TEMPLATE.result_with_hash(
+        icon_name: component_class_name(icon_file_name),
+        variant: variant
+      )
+    )
+  end
 end
 
 def read_and_convert_icon(icon_file_path)

data/generators/helper.rb

@@ -73,6 +73,10 @@ def component_file_name(icon_file_name, replacements = nil)
   "#{icon_name.gsub('-', '_')}.rb"
 end
 
+def variant_component_file_name(icon_file_name, variant)
+  "#{component_file_name(icon_file_name).gsub('.rb', '')}_#{variant.to_s.downcase}.rb"
+end
+
 def component_class_name(icon_file_name, replacements = nil)
   replacements ||= {}
 
@@ -91,12 +95,12 @@ def make_components_lazy_loadable(path)
   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))}'"
+    "    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"
+    "# auto-generated autoload: start\n#{autoload_lines}\n    # auto-generated autoload: end"
   )
 
   File.write("#{path}.rb", new_content)

data/generators/hero.rb

@@ -4,24 +4,23 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/tailwindlabs/heroicons.git'
 REPO_NAME = 'tailwindlabs-heroicons'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/hero.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/hero'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/hero.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/hero'
+VARIANTS = %i[solid outline].freeze
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Hero
-        class <%= icon_name %> < Base
-          def solid
-            <%= solid_icon %>
-          end
-
-          def outline
-            <%= outline_icon %>
-          end
+  module PhlexIcons
+    module Hero
+      class <%= icon_name %> < Base
+        def solid
+          <%= solid_icon %>
+        end
+
+        def outline
+          <%= outline_icon %>
         end
       end
     end
@@ -29,6 +28,22 @@ TEMPLATE = ERB.new <<~TEMPLATE
   # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
 TEMPLATE
 
+VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
+  # frozen_string_literal: true
+
+  # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
+  module PhlexIcons
+    module Hero
+      class <%= icon_name %><%= variant.to_s.capitalize %> < Base
+        def view_template
+          render <%= icon_name %>.new(variant: :<%= variant %>)
+        end
+      end
+    end
+  end
+  # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
+VARIANT_TEMPLATE
+
 def main
   run_generator do
     new_version = JSON.parse(File.read("generators/#{REPO_NAME}/package.json"))['version']
@@ -51,6 +66,16 @@ def create_icon_component(icon_file_name)
       outline_icon: read_and_convert_icon(outline_icon_file_path(icon_file_name))
     )
   )
+
+  VARIANTS.each do |variant|
+    File.write(
+      File.join(ICONS_PACK_PATH, variant_component_file_name(icon_file_name, variant)),
+      VARIANT_TEMPLATE.result_with_hash(
+        icon_name: component_class_name(icon_file_name),
+        variant: variant
+      )
+    )
+  end
 end
 
 def read_and_convert_icon(icon_file_path)

data/generators/lucide.rb

@@ -4,20 +4,18 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/lucide-icons/lucide.git'
 REPO_NAME = 'lucide-icons-lucide'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/lucide.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/lucide'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/lucide.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/lucide'
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Lucide
-        class <%= icon_name %> < Base
-          def view_template
-            <%= icon %>
-          end
+  module PhlexIcons
+    module Lucide
+      class <%= icon_name %> < Base
+        def view_template
+          <%= icon %>
         end
       end
     end

data/generators/radix.rb

@@ -4,20 +4,18 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/radix-ui/icons.git'
 REPO_NAME = 'radix-ui-icons'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/radix.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/radix'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/radix.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/radix'
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Radix
-        class <%= icon_name %> < Base
-          def view_template
-            <%= icon %>
-          end
+  module PhlexIcons
+    module Radix
+      class <%= icon_name %> < Base
+        def view_template
+          <%= icon %>
         end
       end
     end

data/generators/remix.rb

@@ -4,20 +4,18 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/Remix-Design/RemixIcon.git'
 REPO_NAME = 'remix-design-remixicon'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/remix.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/remix'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/remix.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/remix'
 
 TEMPLATE = ERB.new <<~TEMPLATE
   # frozen_string_literal: true
 
   # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
-  module Phlex
-    module Icons
-      module Remix
-        class <%= icon_name %> < Base
-          def view_template
-            <%= icon %>
-          end
+  module PhlexIcons
+    module Remix
+      class <%= icon_name %> < Base
+        def view_template
+          <%= icon %>
         end
       end
     end

data/generators/tabler.rb

@@ -4,24 +4,23 @@ require_relative 'helper'
 
 REPO_URL = 'https://github.com/tabler/tabler-icons.git'
 REPO_NAME = 'tabler-tabler-icons'
-ICONS_PACK_MODULE_PATH = 'lib/phlex/icons/tabler.rb'
-ICONS_PACK_PATH = 'lib/phlex/icons/tabler'
+ICONS_PACK_MODULE_PATH = 'lib/phlex-icons/tabler.rb'
+ICONS_PACK_PATH = 'lib/phlex-icons/tabler'
+VARIANTS = %i[filled outline].freeze
 
 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
+  module PhlexIcons
+    module Tabler
+      class <%= icon_name %> < Base
+        def filled
+          <%= filled_icon %>
+        end
+
+        def outline
+          <%= outline_icon %>
         end
       end
     end
@@ -29,6 +28,22 @@ TEMPLATE = ERB.new <<~TEMPLATE
   # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
 TEMPLATE
 
+VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
+  # frozen_string_literal: true
+
+  # rubocop:disable #{ROBOCOP_DISABLE_WARNINGS}
+  module PhlexIcons
+    module Tabler
+      class <%= icon_name %><%= variant.to_s.capitalize %> < Base
+        def view_template
+          render <%= icon_name %>.new(variant: :<%= variant %>)
+        end
+      end
+    end
+  end
+  # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
+VARIANT_TEMPLATE
+
 def main
   run_generator do
     new_version = JSON.parse(File.read("generators/#{REPO_NAME}/package.json"))['version']
@@ -51,6 +66,16 @@ def create_icon_component(icon_file_name)
       outline_icon: read_and_convert_icon(outline_icon_file_path(icon_file_name))
     )
   )
+
+  VARIANTS.each do |variant|
+    File.write(
+      File.join(ICONS_PACK_PATH, variant_component_file_name(icon_file_name, variant)),
+      VARIANT_TEMPLATE.result_with_hash(
+        icon_name: component_class_name(icon_file_name),
+        variant: variant
+      )
+    )
+  end
 end
 
 def read_and_convert_icon(icon_file_path)

data/lib/phlex-icons/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PhlexIcons
+  class Base < Phlex::SVG
+    attr_reader :attrs
+
+    def initialize(**attrs)
+      @attrs = attrs
+      attrs[:class] ||= PhlexIcons.configuration.default_classes
+
+      super()
+    end
+
+    def view_template
+      send(variant) if respond_to?(variant)
+    end
+  end
+end

data/lib/phlex-icons/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PhlexIcons
+  class Configuration
+    attr_accessor :default_variant, :default_classes
+
+    def initialize(default_classes: 'size-6')
+      @default_classes = default_classes
+    end
+  end
+end