forticons 0.0.2

data/lib/forticons/forticon.rb

@@ -0,0 +1,107 @@
+module Forticons
+  class Forticon
+    DEFAULT_HEIGHT = 16
+
+    attr_reader :path, :options, :width, :height, :symbol, :keywords
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if forticon = get_forticon(@symbol, options)
+        @path = forticon["path"]
+        @width = forticon["width"]
+        @height = forticon["height"]
+        @keywords = forticon["keywords"]
+        @options = options.dup
+        @options.merge!({
+          class:   classes,
+          viewBox: viewbox,
+          version: "1.1"
+        })
+        @options.merge!(size)
+        @options.merge!(a11y)
+      else
+        raise "Couldn't find forticon 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 forticon class
+    def classes
+      "forticon forticon-#{@symbol} #{@options[:class]} ".strip
+    end
+
+    def viewbox
+      "0 0 #{@width} #{@height}"
+    end
+
+    # determine the height and width of the forticon 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_forticon(symbol, options = {})
+      if forticon = Forticons::FORTICON_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(forticon["heights"].keys, height)
+        return {
+          "name" => forticon["name"],
+          "keywords" => forticon["keywords"],
+          "width" => forticon["heights"][natural_height.to_s]["width"].to_i,
+          "height" => natural_height,
+          "path" => forticon["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/forticons/version.rb

@@ -0,0 +1,3 @@
+module Forticons
+  VERSION = "0.0.2".freeze
+end

data/lib/forticons.rb

@@ -0,0 +1,8 @@
+require "forticons/version"
+require "forticons/forticon"
+require "json"
+
+module Forticons
+  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
+  FORTICON_SYMBOLS = JSON.parse(file_data).freeze
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: forticons
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- anosim114
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-02 00:00:00.000000000 Z
+dependencies: []
+description: A package that distributes FortAwesome icons in a gem
+email:
+- arnold_siemens@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/build/data.json
+- lib/forticons.rb
+- lib/forticons/forticon.rb
+- lib/forticons/version.rb
+homepage: https://github.com/anosim114/forticons
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Octicons like FortAwesome icon library
+test_files: []