unmagic-icon 0.1.0

data/lib/unmagic/icon/web.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "rack"
+require "rack/utils"
+
+require "erb"
+require "cgi"
+
+module Unmagic
+  class Icon
+    class Web
+      def self.call(env)
+        app.call(env)
+      end
+
+      def self.app
+        @app ||= Rack::Builder.new do
+          public_path = File.expand_path("web/public", __dir__)
+          use Rack::Static, urls: [ "/public" ], root: File.dirname(public_path)
+          run Unmagic::Icon::Web.new
+        end.to_app
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        @libraries = Unmagic::Icon::Library::Registry.all
+
+        case @request.path_info
+        when "/"
+          # Redirect to first library
+          first_library = @libraries.first.name.to_param
+          if first_library.nil?
+            [ 404, { "content-type" => "text/plain" }, [ "No libraries found" ] ]
+          else
+            [ 302, { "location" => url(first_library, @request.params) }, [] ]
+          end
+        else
+          library_name = @request.path_info.delete_prefix("/")
+
+          begin
+            @selected_library = Unmagic::Icon::Library::Registry.find(library_name)
+          rescue Unmagic::Icon::LibraryNotError
+            return [ 404, { "content-type" => "text/plain" }, [ "Library not found: #{@selected_library}" ] ]
+          end
+
+          template_path = File.expand_path("web/views/layout.html.erb", __dir__)
+          template = ERB.new(File.read(template_path))
+          html = template.result(binding)
+
+          [ 200, { "content-type" => "text/html; charset=utf-8" }, [ html ] ]
+        end
+      end
+
+      def escape(text)
+        CGI.escapeHTML(text.to_s)
+      end
+
+      def url(path_parts, params_hash = nil)
+        url = [ @request.env["SCRIPT_NAME"], *path_parts ].compact.join("/")
+        url = url.gsub(/\/\//, "/")
+
+        if params_hash
+          "#{url}?#{Rack::Utils.build_query(params_hash)}"
+        else
+          url
+        end
+      end
+    end
+  end
+end

data/lib/unmagic/icon.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/output_safety"
+require "active_support/core_ext/string/inflections"
+
+require_relative "icon/version"
+require_relative "icon/configuration"
+require_relative "icon/library"
+require_relative "icon/library/registry"
+require_relative "icon/action_view_helpers"
+require_relative "icon/engine" if defined?(Rails)
+
+module Unmagic
+  class Icon
+    class Error < StandardError; end
+    class LibraryNotFoundError < Error; end
+    class IconNotFoundError < Error; end
+
+    class << self
+      def init
+        yield(configuration) if block_given?
+        @initialized = true
+      end
+
+      def initialized?
+        @initialized == true
+      end
+
+      def configure
+        yield(configuration) if block_given?
+        configuration
+      end
+
+      def configuration
+        @configuration ||= Unmagic::Icon::Configuration.new
+      end
+
+      def libraries
+        Unmagic::Icon::Library::Registry.all
+      end
+
+      def find(reference)
+        library_path, icon_name = parse_reference(reference)
+
+        Unmagic::Icon::Library::Registry.find(library_path).find(icon_name)
+      end
+
+      # Parse a "library/name" reference into [library, name], tolerating the
+      # emoji-style ":library/name:" decoration so both kinds share one syntax.
+      def parse_reference(reference)
+        *library_parts, name = reference.to_s.gsub(/\A:|:\z/, "").split("/")
+        [ library_parts.join("/"), name ]
+      end
+    end
+
+    attr_reader :name, :path
+
+    def initialize(name:, path:)
+      @name = name
+      @path = path
+    end
+
+    def doc
+      Nokogiri::XML(raw_svg_content)
+    end
+
+    def attributes
+      extracted_svg[:attributes]
+    end
+
+    def contents
+      extracted_svg[:contents].strip
+    end
+
+    def as_json
+      { name: name, svg: to_svg }
+    end
+
+    # Render the asset to HTML, dispatching on its kind. SVG inlines today; a
+    # future raster asset (png/gif) would emit an <img> here, so callers stay
+    # render-agnostic.
+    def render(options = {})
+      case File.extname(@path).downcase
+      when ".svg" then to_svg(options)
+      else
+        raise Unmagic::Icon::Error, "Don't know how to render #{@path}"
+      end
+    end
+
+    # Render the SVG with a `unmagic-icon` class (plus any caller class) and a
+    # `data-unmagic-icon` marker. Any other options are merged verbatim as
+    # attributes on the <svg> — so the caller controls accessibility
+    # (`aria-hidden`, `aria-label`, `role`), `id`, `data-*`, etc.
+    def to_svg(options = {})
+      return @svg_cache if options.empty? && @svg_cache
+
+      attributes = options.transform_keys(&:to_s)
+      css_classes = [ "unmagic-icon", attributes.delete("class") ].compact.join(" ")
+
+      svg = raw_svg_content.dup
+      svg.sub!(/<svg(\s+[^>]*)?>/i) do
+        existing = (::Regexp.last_match(1) || "").gsub(/\sclass=["'][^"']*["']/, "")
+        extra = attributes.map { |name, value| %(#{name}="#{CGI.escapeHTML(value.to_s)}") }
+        %(<svg#{existing} class="#{css_classes}" data-unmagic-icon="#{@name}"#{extra.empty? ? "" : " #{extra.join(' ')}"}>)
+      end
+
+      svg = svg.html_safe
+      @svg_cache = svg if options.empty?
+      svg
+    end
+
+    private
+
+    def raw_svg_content
+      @raw_svg_content ||= File.read(@path)
+    end
+
+    def extracted_svg
+      @xml ||=
+        begin
+          root = doc.at_css("//svg")
+          {
+            attributes: root.attributes.inject({}) do |hash, (key, value)|
+              hash[key] = value.value
+              hash
+            end,
+            contents: root.children.to_xml
+          }
+        end
+    end
+  end
+end

data/lib/unmagic_icon.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "unmagic/icon"

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: unmagic-icon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Pitt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Render SVG icons inline in Rails views, resolve them through library/name
+  references and aliases, and download popular icon sets (Heroicons, Lucide, Tabler,
+  Feather, and more)
+email:
+- keith@unreasonable-magic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/tasks/unmagic/icon/download.rake
+- lib/tasks/unmagic/icon/install.rake
+- lib/unmagic/icon.rb
+- lib/unmagic/icon/action_view_helpers.rb
+- lib/unmagic/icon/configuration.rb
+- lib/unmagic/icon/engine.rb
+- lib/unmagic/icon/library.rb
+- lib/unmagic/icon/library/registry.rb
+- lib/unmagic/icon/library/source.rb
+- lib/unmagic/icon/library/source/devicons.rb
+- lib/unmagic/icon/library/source/feather.rb
+- lib/unmagic/icon/library/source/heroicons.rb
+- lib/unmagic/icon/library/source/lucide.rb
+- lib/unmagic/icon/library/source/material_file_icons.rb
+- lib/unmagic/icon/library/source/silk.rb
+- lib/unmagic/icon/library/source/simple_icons.rb
+- lib/unmagic/icon/library/source/tabler.rb
+- lib/unmagic/icon/version.rb
+- lib/unmagic/icon/web.rb
+- lib/unmagic/icon/web/public/favicon.png
+- lib/unmagic/icon/web/views/layout.html.erb
+- lib/unmagic_icon.rb
+homepage: https://github.com/unreasonable-magic/unmagic-icon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unreasonable-magic/unmagic-icon
+  source_code_uri: https://github.com/unreasonable-magic/unmagic-icon
+  changelog_uri: https://github.com/unreasonable-magic/unmagic-icon/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Inline SVG icons for Rails, with downloadable icon libraries
+test_files: []