ascona 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8287078537d984be67b63cfdce58534dbe6614bb5c917c8051caa4b9ee6183f4
+  data.tar.gz: 1393e656146786b20803a5723a2df72568bb32e1a5da3259e869e7f282b7ad1d
+SHA512:
+  metadata.gz: e7aa21e79c9d161f1be827e30920842e8d7caf7425fa79cc27b593228a7b5f94259fd910cfba83144df8403da8efdef82fa735a4f9dfe9e6c492701e65a4c256
+  data.tar.gz: f7acf773a8c162fed5170d03efb7026b9a013734c6bfce73aea2bef1e91677d51b6e83c40a5ba18703beffe0e09059d1903e4c7e4f649cff3074869479b5115d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Samuenti
+
+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,97 @@
+# Ascona
+
+Use SVG icons in Ruby.
+
+Ascona loads your SVG icons into memory at boot. Fast lookups, simple helper.
+
+## Installation
+
+```ruby
+gem 'ascona'
+```
+
+Then `bundle install`.
+
+## Setup
+
+Generate the initializer:
+
+```bash
+rails generate ascona:install
+```
+
+Or create `config/initializers/ascona.rb` manually:
+
+```ruby
+Ascona.configure do |config|
+  config.icon_path = "app/assets/icons"
+  config.default_library = :lucide
+end
+```
+
+## Supported Libraries
+
+| Library | Link |
+|---------|------|
+| Lucide | [lucide.dev](https://lucide.dev) |
+
+
+## Downloading Icons
+
+```bash
+ascona list                          # Show available libraries
+ascona download lucide               # Download all icons
+ascona download heroicons --variant=outline  # Download specific variant
+```
+
+## Folder Structure
+
+Each SVG library should be stored in separate folders (create custom libraries by adding a new folder):
+
+```
+app/assets/icons/
+  lucide/
+    star.svg
+    arrow-left.svg
+  heroicons/
+    outline/
+      check.svg
+    solid/
+      check.svg
+```
+
+The name of the folder will be used as the library name.
+
+## Usage
+
+```erb
+<%= icon "star" %>
+<%= icon "star", class: "w-5 h-5" %>
+<%= icon "star", library: :heroicons, variant: :outline %>
+```
+
+Attributes are added directly to the `<svg>` tag.
+
+## Variants
+
+Some libraries have variants. Set defaults per library (for rendering only):
+
+```ruby
+config.default_variants = { heroicons: :outline }
+```
+
+Note: Some libraries have no default variant. You must specify one when downloading (`--variant=outline`) and when rendering (`variant: :outline`) unless set in config.
+
+## Non-Rails
+
+Include the helper manually:
+
+```ruby
+include Ascona::Helper
+```
+
+Call `Ascona.load` before using icons.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/exe/ascona

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ascona"
+require "ascona/cli"
+
+Ascona::CLI.start(ARGV)

data/lib/ascona/cli.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "library"
+
+module Ascona
+  class CLI < Thor
+    desc "list", "List available icon libraries"
+    def list
+      libraries = Library.available
+      if libraries.empty?
+        puts "No libraries available"
+      else
+        puts "Available libraries:"
+        libraries.each { |lib| puts "  - #{lib}" }
+      end
+    end
+
+    desc "download LIBRARY", "Download icons from a library"
+    option :variant, type: :string, desc: "Download specific variant only"
+    def download(library)
+      unless Library.available.include?(library)
+        puts "Unknown library: #{library}"
+        puts "Run 'ascona list' to see available libraries"
+        return
+      end
+
+      destination = File.join(Ascona.configuration.icon_path, library)
+      puts "Downloading #{library} icons to #{destination}..."
+      Library.download(library, destination, variant: options[:variant])
+      puts "Done!"
+    end
+  end
+end

data/lib/ascona/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ascona
+  class Configuration
+    attr_accessor :icon_path, :default_library, :default_variants
+
+    def initialize
+      @icon_path = "app/assets/icons"
+      @default_library = nil
+      @default_variants = {}
+    end
+  end
+end

data/lib/ascona/helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ascona
+  module Helper
+    def icon(name, library: nil, variant: nil, **attributes)
+      library ||= Ascona.configuration.default_library
+      raise ArgumentError, "No library specified and no default set" unless library
+
+      variant ||= Ascona.configuration.default_variants[library.to_sym]
+      svg = Ascona.registry.get(name.to_sym, library: library.to_sym, variant: variant)
+      raise ArgumentError, "Icon '#{name}' not found in library '#{library}'" unless svg
+
+      return svg if attributes.empty?
+
+      inject_attributes(svg, attributes)
+    end
+
+    private
+
+    def inject_attributes(svg, attributes)
+      attrs_string = attributes.map { |k, v| %(#{k.to_s.gsub("_", "-")}="#{v}") }.join(" ")
+      svg.sub("<svg", "<svg #{attrs_string}")
+    end
+  end
+end

data/lib/ascona/libraries/lucide.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ascona
+  module Libraries
+    module Lucide
+      CONFIG = {
+        repo: "lucide-icons/lucide",
+        path: "icons",
+        branch: "main"
+      }.freeze
+    end
+  end
+end

data/lib/ascona/library.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "fileutils"
+require "tmpdir"
+require "rubygems/package"
+require "zlib"
+
+module Ascona
+  module Library
+    def self.available
+      Dir.glob(File.join(__dir__, "libraries", "*.rb")).map do |f|
+        File.basename(f, ".rb")
+      end
+    end
+
+    def self.config_for(name)
+      require_relative "libraries/#{name}"
+      Ascona::Libraries.const_get(name.capitalize)::CONFIG
+    end
+
+    def self.download(name, destination, variant: nil)
+      config = config_for(name)
+
+      Dir.mktmpdir do |tmp_dir|
+        extracted_dir = download_and_extract(config, tmp_dir)
+        copy_to_destination(config, extracted_dir, destination, variant)
+      end
+    end
+
+    def self.download_and_extract(config, tmp_dir)
+      tar_path = File.join(tmp_dir, "repo.tar.gz")
+      download_tar(config[:repo], config[:branch], tar_path)
+      extract_tar(tar_path, tmp_dir)
+      Dir.glob(File.join(tmp_dir, "*")).find { |f| File.directory?(f) }
+    end
+
+    def self.copy_to_destination(config, extracted_dir, destination, variant)
+      if config[:variants]
+        copy_variants(extracted_dir, config[:variants], destination, variant)
+      else
+        copy_icons(extracted_dir, config[:path], destination)
+      end
+    end
+
+    def self.download_tar(repo, branch, tar_path)
+      uri = URI("https://github.com/#{repo}/archive/refs/heads/#{branch}.tar.gz")
+      response = Net::HTTP.get_response(uri)
+      response = Net::HTTP.get_response(URI(response["location"])) while response.is_a?(Net::HTTPRedirection)
+      File.binwrite(tar_path, response.body)
+    end
+
+    def self.extract_tar(tar_path, tmp_dir)
+      File.open(tar_path, "rb") do |file|
+        Zlib::GzipReader.wrap(file) do |gz|
+          Gem::Package::TarReader.new(gz) { |tar| extract_entries(tar, tmp_dir) }
+        end
+      end
+    end
+
+    def self.extract_entries(tar, tmp_dir)
+      tar.each do |entry|
+        next unless entry.file?
+
+        path = File.join(tmp_dir, entry.full_name)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.binwrite(path, entry.read)
+      end
+    end
+
+    def self.copy_variants(extracted_dir, variants, destination, only_variant)
+      variants.each do |variant_name, variant_path|
+        next if only_variant && only_variant != variant_name
+
+        variant_dest = File.join(destination, variant_name)
+        copy_icons(extracted_dir, variant_path, variant_dest)
+      end
+    end
+
+    def self.copy_icons(extracted_dir, icons_path, destination)
+      source = File.join(extracted_dir, icons_path)
+
+      FileUtils.mkdir_p(destination)
+      Dir.glob(File.join(source, "*.svg")).each do |svg|
+        FileUtils.cp(svg, destination)
+      end
+    end
+
+    private_class_method :download_and_extract, :copy_to_destination,
+                         :download_tar, :extract_tar, :extract_entries, :copy_variants, :copy_icons
+  end
+end

data/lib/ascona/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ascona
+  class Railtie < Rails::Railtie
+    initializer "ascona.load_icons" do
+      Ascona.load
+    end
+
+    initializer "ascona.helper" do
+      ActiveSupport.on_load(:action_view) do
+        include Ascona::Helper
+      end
+    end
+  end
+end

data/lib/ascona/registry.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Ascona
+  class Registry
+    def initialize
+      @icons = {}
+    end
+
+    def load(path)
+      Dir.glob(File.join(path, "*")).each do |library_dir|
+        next unless File.directory?(library_dir)
+
+        library_name = File.basename(library_dir).to_sym
+        @icons[library_name] = {}
+
+        load_library(library_dir, library_name)
+      end
+    end
+
+    def get(name, library:, variant: nil)
+      library_icons = @icons[library]
+      return nil unless library_icons
+
+      if variant
+        library_icons.dig(variant.to_sym, name)
+      else
+        library_icons[name]
+      end
+    end
+
+    def libraries
+      @icons.keys
+    end
+
+    private
+
+    def load_library(library_dir, library_name)
+      has_variants = Dir.glob(File.join(library_dir, "*")).any? { |f| File.directory?(f) }
+
+      if has_variants
+        load_variants(library_dir, library_name)
+      else
+        load_flat(library_dir, library_name)
+      end
+    end
+
+    def load_variants(library_dir, library_name)
+      Dir.glob(File.join(library_dir, "*")).each do |variant_dir|
+        next unless File.directory?(variant_dir)
+
+        load_variant(variant_dir, library_name)
+      end
+    end
+
+    def load_variant(variant_dir, library_name)
+      variant_name = File.basename(variant_dir).to_sym
+      @icons[library_name][variant_name] = {}
+
+      Dir.glob(File.join(variant_dir, "*.svg")).each do |file|
+        icon_name = File.basename(file, ".svg").to_sym
+        @icons[library_name][variant_name][icon_name] = File.read(file)
+      end
+    end
+
+    def load_flat(library_dir, library_name)
+      Dir.glob(File.join(library_dir, "*.svg")).each do |file|
+        icon_name = File.basename(file, ".svg").to_sym
+        @icons[library_name][icon_name] = File.read(file)
+      end
+    end
+  end
+end

data/lib/ascona/version.rb

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

data/lib/ascona.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "ascona/version"
+require_relative "ascona/configuration"
+require_relative "ascona/registry"
+require_relative "ascona/helper"
+
+module Ascona
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def registry
+      @registry ||= Registry.new
+    end
+
+    def load
+      registry.load(configuration.icon_path)
+    end
+  end
+end
+
+require_relative "ascona/railtie" if defined?(Rails)

data/lib/generators/ascona/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ascona
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        copy_file "initializer.rb", "config/initializers/ascona.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Ascona.configure do |config|
+  # config.icon_path = "app/assets/icons"
+  # config.default_library = :lucide
+
+  # Set default variants per library (only for libraries with variants):
+  # config.default_variants = { heroicons: :outline }
+end

data/sig/ascona.rbs

@@ -0,0 +1,4 @@
+module Ascona
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ascona
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuenti
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby gem for using SVG icons.
+email:
+- contact@samuenti.com
+executables:
+- ascona
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/ascona
+- lib/ascona.rb
+- lib/ascona/cli.rb
+- lib/ascona/configuration.rb
+- lib/ascona/helper.rb
+- lib/ascona/libraries/lucide.rb
+- lib/ascona/library.rb
+- lib/ascona/railtie.rb
+- lib/ascona/registry.rb
+- lib/ascona/version.rb
+- lib/generators/ascona/install_generator.rb
+- lib/generators/ascona/templates/initializer.rb
+- sig/ascona.rbs
+homepage: https://github.com/samuenti/ascona
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/samuenti/ascona
+  source_code_uri: https://github.com/samuenti/ascona
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Use SVG icons in Ruby
+test_files: []