lucide-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7121a5e1bf057cb09391cf6425b903e51ceccc8372604727cda37d0d4b0958da
+  data.tar.gz: 035bec245fc1d9194ec40fbc3559eb4493813e0488072d0c7f1f22d8621d475f
+SHA512:
+  metadata.gz: 3a4efc318ae365fec0836206b9930d846a876ec0d08f18bc6c6f724a09d66d35ce771dcc1338ac8d183fb946d9cfd539762615de1e9b9e4d236dab978fa74636
+  data.tar.gz: 016af3c5224cea4fb2804216862532e05998e8d834b6d0f8a74707015531e525e0f8990ba19f8eb4bd83f1cf68a4e9fee26839bde07cdfa9a1db2fcafd6ebbe8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 lucide-ruby contributors
+
+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,113 @@
+# LucideRuby
+
+Rails view helpers for rendering [Lucide](https://lucide.dev) SVG icons inline.
+
+Icons are **not bundled** in the gem. A rake task syncs them from official Lucide GitHub releases into your Rails app's filesystem.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "lucide-ruby"
+```
+
+Then run:
+
+```bash
+bundle install
+rails generate lucide_ruby:install
+rake lucide:sync
+```
+
+This will:
+
+1. Create a config initializer at `config/initializers/lucide_ruby.rb`
+2. Create the icon directory at `app/assets/icons/lucide/`
+3. Download all Lucide SVG icons from the latest release
+
+Commit the icons to version control so deploys don't need to re-sync.
+
+## Usage
+
+```erb
+<%= lucide_icon("arrow-down") %>
+<%= lucide_icon(:check, size: 16, class: "text-green-500") %>
+<%= lucide_icon("menu", data: { action: "click->menu#toggle" }) %>
+<%= lucide_icon("user", aria: { label: "User profile" }) %>
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `size` | Sets both `width` and `height` |
+| `class` | CSS class (appended to `default_class` if configured) |
+| `data` | Data attributes hash |
+| `aria` | Aria attributes hash (disables auto `aria-hidden`) |
+| `stroke-width` | Override stroke width |
+| `fill` | Override fill color |
+| `stroke` | Override stroke color |
+| Any SVG attribute | Passed through to the `<svg>` element |
+
+### Accessibility
+
+By default, icons render with `aria-hidden="true"`. When you pass any `aria` attribute (e.g., `aria: { label: "..." }`), `aria-hidden` is omitted so screen readers can access the icon.
+
+## Configuration
+
+```ruby
+# config/initializers/lucide_ruby.rb
+LucideRuby.configure do |config|
+  config.default_class = "icon"
+  config.default_size = 20
+  config.default_stroke_width = 1.5
+  config.default_fill = "none"
+  config.default_stroke = "currentColor"
+  config.icon_path = Rails.root.join("app/assets/icons/lucide").to_s
+  config.default_attributes = {}
+end
+```
+
+## Rake Tasks
+
+### `rake lucide:sync`
+
+Downloads and extracts Lucide icons from GitHub releases.
+
+```bash
+# Sync latest version
+rake lucide:sync
+
+# Pin to a specific version
+LUCIDE_VERSION=0.575.0 rake lucide:sync
+```
+
+### `rake lucide:info`
+
+Shows info about currently synced icons.
+
+```bash
+rake lucide:info
+# Lucide Icons
+#   Path:    /path/to/app/assets/icons/lucide
+#   Version: 0.575.0
+#   Icons:   1458
+```
+
+## Caching
+
+Icons are cached in memory after first use. For production, you can preload all icons at boot:
+
+```ruby
+# config/initializers/lucide_ruby.rb
+LucideRuby.configure do |config|
+  # ...
+end
+
+LucideRuby.cache.preload! if Rails.env.production?
+```
+
+## License
+
+MIT License. See [LICENSE.txt](LICENSE.txt).

data/lib/generators/lucide_ruby/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates a LucideRuby initializer"
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/lucide_ruby.rb"
+      end
+
+      def create_icon_directory
+        empty_directory "app/assets/icons/lucide"
+        create_file "app/assets/icons/lucide/.keep"
+      end
+
+      def show_next_steps
+        say ""
+        say "LucideRuby installed! Next steps:", :green
+        say "  1. Run `rake lucide:sync` to download Lucide icons"
+        say "  2. Use `lucide_icon(\"icon-name\")` in your views"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/lucide_ruby/templates/initializer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+LucideRuby.configure do |config|
+  # Path where Lucide icons are stored (default: app/assets/icons/lucide)
+  # config.icon_path = Rails.root.join("app", "assets", "icons", "lucide").to_s
+
+  # Default CSS class added to all icons
+  # config.default_class = "icon"
+
+  # Default icon size in pixels (default: 24)
+  # config.default_size = 24
+
+  # Default stroke width (default: 2)
+  # config.default_stroke_width = 2
+
+  # Default fill color (default: "none")
+  # config.default_fill = "none"
+
+  # Default stroke color (default: "currentColor")
+  # config.default_stroke = "currentColor"
+
+  # Additional default attributes applied to all icons
+  # config.default_attributes = {}
+end

data/lib/lucide_ruby/cache.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  class Cache
+    def initialize
+      @store = {}
+      @mutex = Mutex.new
+    end
+
+    def read(name)
+      @mutex.synchronize { @store[name] }
+    end
+
+    def write(name, value)
+      @mutex.synchronize { @store[name] = value }
+    end
+
+    def fetch(name)
+      cached = read(name)
+      return cached if cached
+
+      value = yield
+      write(name, value)
+      value
+    end
+
+    def clear!
+      @mutex.synchronize { @store.clear }
+    end
+
+    def size
+      @mutex.synchronize { @store.size }
+    end
+
+    def preload!
+      icon_path = LucideRuby.configuration.resolved_icon_path
+
+      unless Dir.exist?(icon_path)
+        raise IconsNotSynced.new(icon_path)
+      end
+
+      Dir.glob(File.join(icon_path, "*.svg")).each do |file|
+        name = File.basename(file, ".svg")
+        inner_html = Icon.extract_inner_html(File.read(file))
+        write(name, inner_html)
+      end
+
+      size
+    end
+  end
+end

data/lib/lucide_ruby/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  class Configuration
+    attr_accessor :icon_path, :default_class, :default_size,
+                  :default_stroke_width, :default_fill, :default_stroke,
+                  :default_attributes
+
+    def initialize
+      @icon_path = nil
+      @default_class = nil
+      @default_size = 24
+      @default_stroke_width = 2
+      @default_fill = "none"
+      @default_stroke = "currentColor"
+      @default_attributes = {}
+    end
+
+    def resolved_icon_path
+      @icon_path || default_icon_path
+    end
+
+    private
+
+    def default_icon_path
+      if defined?(Rails)
+        Rails.root.join("app", "assets", "icons", "lucide").to_s
+      else
+        File.join(Dir.pwd, "app", "assets", "icons", "lucide")
+      end
+    end
+  end
+end

data/lib/lucide_ruby/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  class Error < StandardError; end
+
+  class IconNotFound < Error
+    def initialize(name, path)
+      super("Lucide icon '#{name}' not found at #{path}")
+    end
+  end
+
+  class IconsNotSynced < Error
+    def initialize(path)
+      super("Lucide icons not found at #{path}. Run `rake lucide:sync` to download icons.")
+    end
+  end
+
+  class SyncError < Error; end
+end

data/lib/lucide_ruby/icon.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  class Icon
+    SVG_CONTENT_REGEX = /<svg[^>]*>(.*)<\/svg>/m
+
+    attr_reader :name, :options
+
+    def initialize(name, **options)
+      @name = self.class.normalize_name(name)
+      @options = options
+    end
+
+    def render
+      inner_html = load_inner_html
+      attributes = svg_attributes
+      build_svg(inner_html, attributes)
+    end
+
+    def self.normalize_name(name)
+      name.to_s.strip.downcase.tr("_", "-")
+    end
+
+    def self.extract_inner_html(svg_content)
+      match = svg_content.match(SVG_CONTENT_REGEX)
+      match ? match[1].strip : ""
+    end
+
+    private
+
+    def load_inner_html
+      LucideRuby.cache.fetch(name) do
+        icon_path = LucideRuby.configuration.resolved_icon_path
+        file_path = File.join(icon_path, "#{name}.svg")
+
+        unless Dir.exist?(icon_path)
+          raise IconsNotSynced.new(icon_path)
+        end
+
+        unless File.exist?(file_path)
+          raise IconNotFound.new(name, file_path)
+        end
+
+        self.class.extract_inner_html(File.read(file_path))
+      end
+    end
+
+    def svg_attributes
+      config = LucideRuby.configuration
+      attrs = {
+        xmlns: "http://www.w3.org/2000/svg",
+        width: config.default_size,
+        height: config.default_size,
+        viewBox: "0 0 24 24",
+        fill: config.default_fill,
+        stroke: config.default_stroke,
+        "stroke-width": config.default_stroke_width,
+        "stroke-linecap": "round",
+        "stroke-linejoin": "round"
+      }
+
+      # Merge default_attributes from config
+      attrs.merge!(config.default_attributes) if config.default_attributes.any?
+
+      # Merge caller options
+      caller_opts = options.dup
+
+      # Handle size shorthand
+      if caller_opts[:size]
+        size = caller_opts.delete(:size)
+        caller_opts[:width] = size
+        caller_opts[:height] = size
+      end
+
+      # Handle class merging (append, don't replace)
+      if caller_opts[:class] && config.default_class
+        caller_opts[:class] = "#{config.default_class} #{caller_opts[:class]}"
+      elsif config.default_class && !caller_opts.key?(:class)
+        caller_opts[:class] = config.default_class
+      end
+
+      # Auto aria-hidden unless aria attributes provided
+      has_aria = caller_opts.key?(:aria) ||
+                 caller_opts.keys.any? { |k| k.to_s.start_with?("aria") }
+      attrs[:"aria-hidden"] = "true" unless has_aria
+
+      attrs.merge!(caller_opts)
+      attrs
+    end
+
+    def build_svg(inner_html, attributes)
+      attr_string = attributes.map { |k, v|
+        if v.is_a?(Hash)
+          v.map { |sub_k, sub_v| "#{k}-#{sub_k}=\"#{escape(sub_v.to_s)}\"" }.join(" ")
+        else
+          "#{k}=\"#{escape(v.to_s)}\""
+        end
+      }.join(" ")
+
+      "<svg #{attr_string}>#{inner_html}</svg>".html_safe
+    end
+
+    def escape(value)
+      ERB::Util.html_escape(value)
+    end
+  end
+end

data/lib/lucide_ruby/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  class Railtie < Rails::Railtie
+    initializer "lucide_ruby.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include LucideRuby::ViewHelpers
+      end
+    end
+
+    rake_tasks do
+      load File.expand_path("tasks/lucide.rake", __dir__)
+    end
+  end
+end

data/lib/lucide_ruby/tasks/lucide.rake

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "fileutils"
+require "tmpdir"
+require "zip"
+
+namespace :lucide do
+  desc "Sync Lucide icons from GitHub releases"
+  task sync: :environment do
+    version = ENV["LUCIDE_VERSION"]
+    icon_path = LucideRuby.configuration.resolved_icon_path
+
+    puts "Fetching Lucide icons..."
+
+    # Determine download URL
+    if version
+      download_url = "https://github.com/lucide-icons/lucide/releases/download/#{version}/lucide-icons-#{version}.zip"
+      puts "Pinned version: #{version}"
+    else
+      puts "Fetching latest release..."
+      latest_url = fetch_latest_release_url
+      version = latest_url[/\/([^\/]+)\/lucide-icons-/, 1]
+      download_url = latest_url
+      puts "Latest version: #{version}"
+    end
+
+    Dir.mktmpdir("lucide-sync") do |tmpdir|
+      zip_path = File.join(tmpdir, "lucide-icons.zip")
+      extract_path = File.join(tmpdir, "extracted")
+
+      # Download
+      puts "Downloading #{download_url}..."
+      download_file(download_url, zip_path)
+      puts "Downloaded #{File.size(zip_path)} bytes"
+
+      # Extract
+      FileUtils.mkdir_p(extract_path)
+      extract_zip(zip_path, extract_path)
+
+      # Find SVG files in extracted archive
+      svg_source = find_svg_directory(extract_path)
+
+      if svg_source.nil?
+        raise LucideRuby::SyncError, "No SVG files found in the downloaded archive"
+      end
+
+      svg_files = Dir.glob(File.join(svg_source, "*.svg"))
+      puts "Found #{svg_files.size} icons"
+
+      # Atomic replace: write to temp dir, then swap
+      staging_path = "#{icon_path}.staging"
+      backup_path = "#{icon_path}.backup"
+
+      FileUtils.rm_rf(staging_path)
+      FileUtils.mkdir_p(staging_path)
+
+      svg_files.each do |svg_file|
+        FileUtils.cp(svg_file, staging_path)
+      end
+
+      # Write version file
+      File.write(File.join(staging_path, ".lucide-version"), version)
+
+      # Swap directories
+      FileUtils.rm_rf(backup_path)
+      FileUtils.mv(icon_path, backup_path) if Dir.exist?(icon_path)
+      FileUtils.mv(staging_path, icon_path)
+      FileUtils.rm_rf(backup_path)
+
+      # Clear cache
+      LucideRuby.cache.clear!
+
+      puts "Synced #{svg_files.size} Lucide icons (#{version}) to #{icon_path}"
+    end
+  end
+
+  desc "Show info about synced Lucide icons"
+  task info: :environment do
+    icon_path = LucideRuby.configuration.resolved_icon_path
+
+    unless Dir.exist?(icon_path)
+      puts "No icons found at #{icon_path}"
+      puts "Run `rake lucide:sync` to download icons."
+      next
+    end
+
+    svg_count = Dir.glob(File.join(icon_path, "*.svg")).size
+    version_file = File.join(icon_path, ".lucide-version")
+    version = File.exist?(version_file) ? File.read(version_file).strip : "unknown"
+
+    puts "Lucide Icons"
+    puts "  Path:    #{icon_path}"
+    puts "  Version: #{version}"
+    puts "  Icons:   #{svg_count}"
+  end
+end
+
+def fetch_latest_release_url
+  uri = URI("https://api.github.com/repos/lucide-icons/lucide/releases/latest")
+  response = make_request(uri)
+
+  data = JSON.parse(response.body)
+  asset = data["assets"]&.find { |a| a["name"]&.match?(/^lucide-icons-.*\.zip$/) }
+
+  unless asset
+    raise LucideRuby::SyncError, "Could not find lucide-icons zip in latest release"
+  end
+
+  asset["browser_download_url"]
+end
+
+def download_file(url, destination, redirect_limit = 5)
+  raise LucideRuby::SyncError, "Too many redirects" if redirect_limit == 0
+
+  uri = URI(url)
+  response = make_request(uri)
+
+  case response
+  when Net::HTTPSuccess
+    File.binwrite(destination, response.body)
+  when Net::HTTPRedirection
+    download_file(response["location"], destination, redirect_limit - 1)
+  else
+    raise LucideRuby::SyncError, "Download failed: #{response.code} #{response.message}"
+  end
+end
+
+def make_request(uri)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = (uri.scheme == "https")
+  http.open_timeout = 15
+  http.read_timeout = 60
+
+  request = Net::HTTP::Get.new(uri)
+  request["User-Agent"] = "lucide-ruby/#{LucideRuby::VERSION}"
+  request["Accept"] = "application/octet-stream, application/json"
+
+  http.request(request)
+end
+
+def extract_zip(zip_path, extract_path)
+  Zip::File.open(zip_path) do |zip_file|
+    zip_file.each do |entry|
+      entry_path = File.join(extract_path, entry.name)
+
+      # Prevent zip slip
+      unless entry_path.start_with?(File.realpath(extract_path))
+        raise LucideRuby::SyncError, "Zip slip detected: #{entry.name}"
+      end
+
+      if entry.directory?
+        FileUtils.mkdir_p(entry_path)
+      else
+        FileUtils.mkdir_p(File.dirname(entry_path))
+        entry.extract(entry_path)
+      end
+    end
+  end
+end
+
+def find_svg_directory(extract_path)
+  # Look for SVGs directly or in subdirectories
+  if Dir.glob(File.join(extract_path, "*.svg")).any?
+    return extract_path
+  end
+
+  Dir.glob(File.join(extract_path, "**", "*.svg")).first&.then { |f| File.dirname(f) }
+end

data/lib/lucide_ruby/version.rb

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

data/lib/lucide_ruby/view_helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LucideRuby
+  module ViewHelpers
+    def lucide_icon(name, **options)
+      Icon.new(name, **options).render
+    end
+  end
+end

data/lib/lucide_ruby.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "erb"
+require "active_support/core_ext/string/output_safety"
+
+require_relative "lucide_ruby/version"
+require_relative "lucide_ruby/configuration"
+require_relative "lucide_ruby/errors"
+require_relative "lucide_ruby/cache"
+require_relative "lucide_ruby/icon"
+require_relative "lucide_ruby/view_helpers"
+require_relative "lucide_ruby/railtie" if defined?(Rails)
+
+module LucideRuby
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+      cache.clear!
+    end
+
+    def cache
+      @cache ||= Cache.new
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: lucide-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lucide-ruby contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Provides Rails view helpers for rendering Lucide SVG icons inline. Icons
+  are synced from official Lucide GitHub releases via a rake task.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/lucide_ruby/install_generator.rb
+- lib/generators/lucide_ruby/templates/initializer.rb
+- lib/lucide_ruby.rb
+- lib/lucide_ruby/cache.rb
+- lib/lucide_ruby/configuration.rb
+- lib/lucide_ruby/errors.rb
+- lib/lucide_ruby/icon.rb
+- lib/lucide_ruby/railtie.rb
+- lib/lucide_ruby/tasks/lucide.rake
+- lib/lucide_ruby/version.rb
+- lib/lucide_ruby/view_helpers.rb
+homepage: https://github.com/lucide-ruby/lucide-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lucide-ruby/lucide-ruby
+  source_code_uri: https://github.com/lucide-ruby/lucide-ruby
+  changelog_uri: https://github.com/lucide-ruby/lucide-ruby/blob/main/CHANGELOG.md
+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: 4.0.6
+specification_version: 4
+summary: Rails view helpers for rendering Lucide SVG icons inline
+test_files: []