does-octicons 1.0.0

data/lib/octicons/octicon.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Octicons
+  class Octicon
+    DEFAULT_HEIGHT = 16
+
+    attr_reader :path, :options, :width, :height, :symbol, :keywords
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if octicon = get_octicon(@symbol, options)
+        @path = octicon["path"]
+        @width = octicon["width"]
+        @height = octicon["height"]
+        @keywords = octicon["keywords"]
+        @options = options.dup
+        @options.merge!({
+          class:   classes,
+          viewBox: viewbox,
+          version: "1.1"
+        })
+        @options.merge!(size)
+        @options.merge!(a11y)
+      else
+        raise "Couldn't find octicon symbol for #{@symbol.inspect}"
+      end
+    end
+
+    # Returns an string representing a <svg> tag
+    def to_svg
+      "<svg #{html_attributes}>#{@path}</svg>"
+    end
+
+    private
+
+    def html_attributes
+      attrs = ""
+      @options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
+      attrs.strip
+    end
+
+    # add some accessibility features to svg
+    def a11y
+      accessible = {}
+
+      if @options[:"aria-label"].nil? && @options["aria-label"].nil?
+        accessible[:"aria-hidden"] = "true"
+      else
+        accessible[:role] = "img"
+      end
+
+      accessible
+    end
+
+    # prepare the octicon class
+    def classes
+      "octicon octicon-#{@symbol} #{@options[:class]} ".strip
+    end
+
+    def viewbox
+      "0 0 #{@width} #{@height}"
+    end
+
+    # determine the height and width of the octicon based on :size option
+    def size
+      size = {
+        width:  @width,
+        height: @height
+      }
+
+      # Specific size
+      unless @options[:width].nil? && @options[:height].nil?
+        size[:width]  = @options[:width].nil?  ? calculate_width(@options[:height]) : @options[:width]
+        size[:height] = @options[:height].nil? ? calculate_height(@options[:width]) : @options[:height]
+      end
+
+      size
+    end
+
+    def calculate_width(height)
+      (height.to_i * @width) / @height
+    end
+
+    def calculate_height(width)
+      (width.to_i * @height) / @width
+    end
+
+    def get_octicon(symbol, options = {})
+      if octicon = Octicons::OCTICON_SYMBOLS[symbol]
+        # We're using width as an approximation for height if the height option is not passed in
+        height = options[:height] || options[:width] || DEFAULT_HEIGHT
+        natural_height = closest_natural_height(octicon["heights"].keys, height)
+        return {
+          "name" => octicon["name"],
+          "keywords" => octicon["keywords"],
+          "width" => octicon["heights"][natural_height.to_s]["width"].to_i,
+          "height" => natural_height,
+          "path" => octicon["heights"][natural_height.to_s]["path"]
+        }
+      end
+    end
+
+    def closest_natural_height(natural_heights, height)
+      return natural_heights.reduce(natural_heights[0].to_i) do |acc, natural_height|
+        natural_height.to_i <= height.to_i ? natural_height.to_i : acc
+      end
+    end
+  end
+end

data/lib/octicons/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Octicons
+  VERSION = "1.0.0".freeze
+end

data/lib/octicons.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "octicons/version"
+require "octicons/octicon"
+require "json"
+
+module Octicons
+  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
+  OCTICON_SYMBOLS = JSON.parse(file_data).freeze
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: does-octicons
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Does Work LLC
+- GitHub Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-13 00:00:00.000000000 Z
+dependencies: []
+description: A fork of GitHub's octicons gem with custom icons added
+email:
+- mark@does.work
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/build/data.json
+- lib/octicons.rb
+- lib/octicons/data.json
+- lib/octicons/octicon.rb
+- lib/octicons/version.rb
+homepage: https://github.com/doeswork/octicons
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/doeswork/octicons
+  source_code_uri: https://github.com/doeswork/octicons
+  changelog_uri: https://github.com/doeswork/octicons/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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Custom octicons gem with additional icons
+test_files: []