phosphor_icons 0.1.0

data/lib/phosphor_icons/helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "action_view"
+
+module PhosphorIcons
+  module Helper
+    include ActionView::Helpers::TagHelper
+
+    mattr_accessor :phosphor_icons_helper_cache, default: {}
+
+    # rubocop:disable Style/IdenticalConditionalBranches
+    def phosphor_icon(symbol, options = {})
+      return "" if symbol.nil?
+
+      cache_key = [symbol, options]
+
+      if (tag = phosphor_icons_helper_cache[cache_key])
+        tag
+      else
+        icon = PhosphorIcons::Icon.new(symbol, options)
+
+        tag = content_tag(:svg, icon.path.html_safe, icon.options).freeze
+        phosphor_icons_helper_cache[cache_key] = tag
+        tag
+      end
+    end
+    # rubocop:enable Style/IdenticalConditionalBranches
+  end
+end

data/lib/phosphor_icons/icon.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module PhosphorIcons
+  class Icon
+    DEFAULT_STYLE = "regular"
+    SUPPORTED_STYLES = [DEFAULT_STYLE, "bold", "light", "duotone", "fill", "thin"]
+
+    attr_reader :symbol, :style, :options, :path
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      @style = options[:style] || DEFAULT_STYLE
+      if (phosphor_icon = get_phosphor_icon(@symbol, options))
+        @path = phosphor_icon["path"]
+        @options = {
+          class: "phosphor-icon #{options[:class]}".strip,
+          viewBox: viewbox,
+          xmlns: "http://www.w3.org/2000/svg",
+          fill: "currentColor",
+        }
+      else
+        raise IconNotFoundError, "Couldn't find #{self}"
+      end
+    end
+
+    def to_svg
+      "<svg #{html_attributes}>#{path}</svg>"
+    end
+
+    def to_s
+      "Phosphor Icon for #{symbol.inspect} with style #{style.inspect}"
+    end
+
+    private
+
+    def html_attributes
+      attrs = ""
+      options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
+      attrs.strip
+    end
+
+    def viewbox
+      "0 0 256 256"
+    end
+
+    def get_phosphor_icon(symbol, options = {})
+      if (phosphor_icon = PhosphorIcons::ICON_SYMBOLS[symbol])
+        style = get_style(options[:style])
+
+        {
+          "name" => phosphor_icon["name"],
+          "path" => phosphor_icon["styles"][style.to_s]["path"],
+        }
+      end
+    rescue
+      nil
+    end
+
+    def get_style(style)
+      SUPPORTED_STYLES.include?(style.to_s) ? style : DEFAULT_STYLE
+    end
+  end
+end

data/lib/phosphor_icons/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module PhosphorIcons
+  class Railtie < Rails::Railtie
+    initializer "phosphor_icons_helper.helper" do
+      ActionView::Base.send(:include, PhosphorIcons::Helper)
+    end
+  end
+end

data/lib/phosphor_icons/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PhosphorIcons
+  VERSION = "0.1.0"
+end

data/lib/phosphor_icons.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "phosphor_icons/version"
+require "phosphor_icons/icon"
+require "phosphor_icons/helper"
+require "phosphor_icons/railtie" if defined?(Rails)
+require "json"
+
+module PhosphorIcons
+  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
+  ICON_SYMBOLS = JSON.parse(file_data).freeze
+
+  class IconNotFoundError < StandardError; end
+end

data/lib/tasks/transform.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+desc "Transform icons to JSON object"
+namespace :transform do
+  task :icons do
+    require "ox"
+    require "json"
+
+    REGEX_FILENAME = /^(.+?)(?:-(bold|light|duotone|fill|thin))?\.svg$/
+    INPUT_ARG = "core/assets/**/*.svg"
+    OUTPUT_FILE = "lib/build/data.json"
+
+    def build_path(obj)
+      doc = Ox::Document.new
+      obj.each do |k, v|
+        top = Ox::Element.new(k)
+        v.each do |pk|
+          pk.each { |jk, jv| top[jk] = jv }
+        end
+        doc << top
+      end
+      Ox.dump(doc).strip
+    end
+
+    def recursive_merge(origin, other)
+      origin.merge(other) { |_k, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? recursive_merge(v1, v2) : v2 }
+    end
+
+    icons = Dir[INPUT_ARG].map do |filepath|
+      filename = File.basename(filepath)
+      match_filename = REGEX_FILENAME.match(filename)
+      svg_element = Ox.load(File.read(filepath), mode: :hash)[:svg]
+      svg_path = svg_element[1..].map { |s| build_path(s) }.join("")
+
+      {
+        name: match_filename[1],
+        style: match_filename[2] || "regular",
+        path: svg_path,
+      }
+    end
+
+    icons_by_name = icons.reduce({}) do |acc, icon|
+      recursive_merge(acc, {
+        icon[:name] => {
+          name: icon[:name],
+          styles: {
+            icon[:style] => { path: icon[:path] },
+          },
+        },
+      })
+    end
+
+    folder_path = File.dirname(OUTPUT_FILE)
+    FileUtils.mkdir_p(folder_path)
+
+    File.open(OUTPUT_FILE, "w") do |f|
+      f.write(icons_by_name.to_json)
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: phosphor_icons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maful Prayoga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A package that distributes Phosphor Icons in a gem
+email:
+- me@maful.web.id
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/build/data.json
+- lib/phosphor_icons.rb
+- lib/phosphor_icons/helper.rb
+- lib/phosphor_icons/icon.rb
+- lib/phosphor_icons/railtie.rb
+- lib/phosphor_icons/version.rb
+- lib/tasks/transform.rake
+homepage: https://github.com/maful/ruby-phosphor-icons
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Phosphor Icons for Ruby and Rails
+test_files: []