phlex-icons-hero 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9645e625496e726dab34a25538077ac8b31dae1f9ea3d49d7a619d2abad479fd
+  data.tar.gz: dbfdc0e3d8a3475faec42df32be64899aff0f90eac47e7633ff9fd31bfd1b8d5
+SHA512:
+  metadata.gz: 6fbda92fcec71617190282a3cd60ac75bdd922e501ca92993551b497c6d28fdb8cc450710c0d0512ac1303ede5ca93f9e405b1d18b925dd7f812bc76770e6175
+  data.tar.gz: 5c813b36b1d9ea03b35bfbb7626650aaf35832069071638d7a883ed41b6015e45e0d50af1f8ba352f3c3e91d697b3c54b14c797fda94f8f512ba54de5a0699bb

data/.devcontainer/devcontainer.json

@@ -0,0 +1,53 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "phlex-icons",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "ghcr.io/rails/devcontainer/images/ruby:3.3.4",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+    "ghcr.io/jungaretti/features/vim": {}
+  },
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/setup.sh",
+
+	// Configure tool-specific properties.
+	"customizations": {
+    "vscode": {
+      "settings": {
+        "workbench": {
+          "iconTheme": "vscode-icons"
+        },
+        "editor": {
+          "formatOnSave": true
+        },
+        "[ruby]": {
+          "editor": {
+            "formatOnType": false,
+            "tabSize": 2,
+            "useTabStops": false,
+            "defaultFormatter": "Shopify.ruby-lsp"
+          }
+        },
+        "rubyLsp": {
+          "rubyVersionManager": "rbenv",
+          "formatter": "rubocop"
+        }
+      },
+      "extensions": [
+        "bung87.vscode-gemfile",
+        "eamodio.gitlens",
+        "vscode-icons-team.vscode-icons",
+        "waderyan.gitblame"
+      ]
+    }
+  }
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.devcontainer/setup.sh

@@ -0,0 +1,5 @@
+mkdir -p .ruby-lsp
+cp .ruby-version .ruby-lsp/.ruby-version
+
+gem update --system
+bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
+  Exclude:
+    - '**/._*'
+    - 'vendor/bundle/**/*'
+
+Layout/LineLength:
+  AllowedPatterns:
+    - !ruby/regexp /\A *# /
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/QuotedSymbols:
+  EnforcedStyle: single_quotes
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'method_call']
+
+Metrics/ClassLength:
+  CountAsOne: ['array', 'method_call']

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ali Hamdi Ali Fadel
+
+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/README.md

@@ -0,0 +1,138 @@
+<div align="center">
+  <img src="phlex-icons.png" alt="Phlex Icons" width="500">
+
+  [![Gem Version](https://badge.fury.io/rb/phlex-icons.svg)](https://badge.fury.io/rb/phlex-icons)
+  ![rubocop](https://github.com/AliOsm/phlex-icons/actions/workflows/rubocop.yml/badge.svg?branch=main)
+  [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+  ![Ruby Version](https://img.shields.io/badge/ruby_version->=_3.0.0-blue.svg)
+
+</div>
+
+# Phlex::Icons
+
+General icons extension for [Phlex](https://phlex.fun). Includes more than 🎨 7,300 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+)
+
+And happy to extend to other icon packs!
+
+Thanks [nejdetkadir](https://github.com/nejdetkadir) for creating [Phlex::Heroicons](https://github.com/nejdetkadir/phlex-heroicons) as it was the base for this gem.
+
+Other Phlex icon gems:
+- [phlex-remixicon](https://github.com/danieldocki/phlex-remixicon)
+- [phlex-lucide](https://github.com/akodkod/phlex-lucide)
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+```bash
+bundle add phlex-icons
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install phlex-icons
+```
+
+## Configuration
+
+The gem provides global configuration options, and per icons pack configuration options.
+
+### Global configuration
+
+```ruby
+Phlex::Icons.configure do |config|
+  config.default_classes = 'size-6'
+end
+
+# OR
+
+Phlex::Icons.configuration.default_classes = 'size-6'
+```
+
+### Bootstrap Icons configuration
+
+Nothing to configure for Bootstrap Icons.
+
+### Flag Icons configuration
+
+```ruby
+Phlex::Icons::Flag.configure do |config|
+  config.default_variant = :square # or :rectangle
+end
+
+# OR
+
+Phlex::Icons::Flag.configuration.default_variant = :square # or :rectangle
+```
+
+### Heroicons configuration
+
+```ruby
+Phlex::Icons::Hero.configure do |config|
+  config.default_variant = :solid # or :outline
+end
+
+# OR
+
+Phlex::Icons::Hero.configuration.default_variant = :solid # or :outline
+```
+
+### Lucide Icons configuration
+
+Nothing to configure for Lucide Icons.
+
+### RadixUI Icons configuration
+
+Nothing to configure for RadixUI Icons.
+
+### Remix Icons configuration
+
+Nothing to configure for Remix Icons.
+
+## Usage
+
+```ruby
+require 'phlex_icons'
+
+class PhlexIcons < Phlex::HTML
+  def view_template
+    div do
+      render Phlex::Icons::Bootstrap::House.new(classes: 'size-4')
+      render Phlex::Icons::Flag::Sa.new(variant: :rectangle, classes: 'size-4')
+      render Phlex::Icons::Hero::Home.new(variant: :solid, classes: 'size-4')
+      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')
+    end
+  end
+end
+```
+
+## Update icon packs
+
+All icon packs provided in this gem are auto-generated by their generator under [`generators`](/generators) directory. You just need to clone the repo and run the generator for the icon pack you want to update. In future, I'm planning to add GitHub Actions to automatically generate the icon packs and update the gem.
+
+## Development
+
+After checking out the repo, open it in VSCode and click `Reopen in Container` to start a development container. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AliOsm/phlex-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/AliOsm/phlex-icons/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/generators/bootstrap.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+REPO_URL = 'https://github.com/twbs/icons.git'
+REPO_NAME = 'twbs-icons'
+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
+        end
+      end
+    end
+  end
+  # rubocop:enable #{ROBOCOP_DISABLE_WARNINGS}
+TEMPLATE
+
+REPLACEMENTS = {
+  '0-' => 'zero-',
+  '1-' => 'one-',
+  '2-' => 'two-',
+  '3-' => 'three-',
+  '4-' => 'four-',
+  '5-' => 'five-',
+  '6-' => 'six-',
+  '7-' => 'seven-',
+  '8-' => 'eight-',
+  '9-' => 'nine-',
+  '123' => 'one-two-three'
+}.freeze
+
+def main
+  run_generator { icon_file_paths.tqdm.each { create_icon_component(_1) } }
+end
+
+def icon_file_paths
+  Dir.glob("generators/#{REPO_NAME}/icons/*")
+end
+
+def create_icon_component(icon_file_path)
+  File.write(
+    File.join(ICONS_PACK_PATH, component_file_name(icon_file_path, REPLACEMENTS)),
+    TEMPLATE.result_with_hash(
+      icon_name: component_class_name(icon_file_path, REPLACEMENTS),
+      icon: read_and_convert_icon(icon_file_path)
+    )
+  )
+end
+
+def read_and_convert_icon(icon_file_path)
+  icon_file_content = File.read(icon_file_path)
+                          .sub(/class="bi [^"]*"/, '')
+                          .sub('width="16"', '')
+                          .sub('height="16"', '')
+
+  Phlexing::Converter.convert(icon_file_content)
+                     .sub('svg(', "svg(\nclass: classes,")
+end
+
+main if __FILE__ == $PROGRAM_NAME

data/generators/flag.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+REPO_URL = 'https://github.com/lipis/flag-icons.git'
+REPO_NAME = 'lipis-flag-icons'
+ICONS_PACK_PATH = 'lib/phlex/icons/flag'
+
+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
+        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}/flags/1x1/*").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),
+      square_icon: read_and_convert_icon(square_icon_file_path(icon_file_name)),
+      rectangle_icon: read_and_convert_icon(rectangle_icon_file_path(icon_file_name))
+    )
+  )
+end
+
+def read_and_convert_icon(icon_file_path)
+  icon_file_content = File.read(icon_file_path)
+                          .sub(/id="flag-icons-[^"]*"/, '')
+
+  Phlexing::Converter.convert(icon_file_content)
+                     .sub('svg(', "svg(\nclass: classes,")
+                     .sub('xmlns:xlink:', '"xmlns:xlink":')
+                     .gsub('xlink:href:', '"xlink:href":')
+end
+
+def square_icon_file_path(icon_file_name)
+  "generators/#{REPO_NAME}/flags/1x1/#{icon_file_name}"
+end
+
+def rectangle_icon_file_path(icon_file_name)
+  "generators/#{REPO_NAME}/flags/4x3/#{icon_file_name}"
+end
+
+main if __FILE__ == $PROGRAM_NAME

data/generators/helper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'fileutils'
+require 'phlexing'
+require 'tqdm'
+
+ROBOCOP_DISABLE_WARNINGS = %w[
+  Layout/LineLength
+  Metrics/AbcSize
+  Metrics/BlockLength
+  Metrics/ClassLength
+  Metrics/MethodLength
+].join(',')
+
+def run_generator(&block)
+  clone_repo(REPO_URL, REPO_NAME)
+  prepare_phlex_icons_pack_directory(ICONS_PACK_PATH)
+
+  print '⌛ Creating icon components...'
+  yield block
+  puts "\r🎉 Icon components created successfully!"
+
+  run_rubocop(ICONS_PACK_PATH)
+  delete_repo(REPO_NAME)
+end
+
+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"
+
+    return
+  end
+
+  system!("git clone #{repo_url} generators/#{repo_name}")
+
+  puts "\r🎉 '#{repo_name}' repo cloned successfully!"
+end
+
+def prepare_phlex_icons_pack_directory(icons_pack_path)
+  print "⌛ Preparing '#{icons_pack_path}' directory..."
+
+  FileUtils.mkdir_p(icons_pack_path)
+
+  Dir.glob("#{icons_pack_path}/*").each do |file|
+    next if ['base.rb', 'configuration.rb'].include?(File.basename(file))
+
+    File.delete(file)
+  end
+
+  puts "\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')
+
+  replacements.each do |key, value|
+    icon_name = icon_name.gsub(key, value) if icon_name.start_with?(key)
+  end
+
+  "#{icon_name.gsub('-', '_')}.rb"
+end
+
+def component_class_name(icon_file_name, replacements = nil)
+  replacements ||= {}
+
+  icon_name = File.basename(icon_file_name, '.svg')
+
+  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
+end
+
+def run_rubocop(path)
+  print '⌛ Running RuboCop...'
+
+  system("rubocop -A #{path}", out: File::NULL, err: File::NULL)
+
+  Dir.glob("#{path}/*.rb").each do |file|
+    File.write(file, File.read(file).gsub('rubocop:enable ,', 'rubocop:enable '))
+  end
+
+  puts "\r🎉 RuboCop ran successfully!"
+end
+
+def delete_repo(repo_name)
+  print "⌛ Deleting '#{repo_name}' repo..."
+
+  FileUtils.rm_rf("generators/#{repo_name}")
+
+  puts "\r🎉 '#{repo_name}' repo deleted successfully!"
+end
+
+def system!(command)
+  system(command, out: File::NULL, err: File::NULL) || raise("❌ Command failed: '#{command}'")
+end