heroicons_helper 0.2.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1567311352d143cb38d0ebf41388ab02cffa75dde06c9aa02694d06dfde7e3ef
-  data.tar.gz: b865c9123848efdf54afda2336491a15f7289a9e2f91a2a005731436e248c01a
+  metadata.gz: 80e090d354ed7b42e47a7436e723b4bd438a75aaa558856a830ed78a3fcbb3d5
+  data.tar.gz: 475b59fd40ed8e85775eb620131fa0425f17608d6d1c8f2d1f4aa90c8327735b
 SHA512:
-  metadata.gz: 9461351e92db53399116d07f77cbcde4094f50201f550b02d8dcaa125e9671a90b84300c831610be743c6be72d7f578c1069f9ec6e505af484481797225f9c91
-  data.tar.gz: 67d4d42f881e0d435494eaa79890b55022d6187d2f99b26dea652d5a0517203ffcc4f531da01a64ed04b8a15f405f9e080539b25999ca823804b49148c7164aa
+  metadata.gz: d45fea85415d4fac7ed79f0cf1563dd3fd7dabf87780714dc41d5e3bc09ca3d9581d58f1312db7be08f9803fad2389417b90d3aea1fb74acb18c0ffe8b4ad1ff
+  data.tar.gz: 703138870cb157f666d37d3df838dfaccd1b5d12d20c2e98c78ec7db2b57ed804c074c00a220d61e431104b62ae9168eb9eb9c12c88805ab9a24581fe8c53d09

data/README.md

@@ -22,10 +22,10 @@ require "heroicons_helper"
 include HeroiconsHelper
 ```
 
-You'll have a brand new method called `heroicons` whose signature looks like this:
+You'll have a brand new method called `heroicon` whose signature looks like this:
 
 ```ruby
-heroicons(symbol, variant, attributes: {})
+heroicon(symbol, variant, attributes: {})
 ```
 
 where
@@ -37,7 +37,7 @@ where
 This one method call returns an object that represents the Heroicon, and you should call `to_svg` to get the resulting SVG string:
 
 ```ruby
-outline_icon = heroicons("x", "outline")
+outline_icon = heroicon("x", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
 puts outline_icon.to_svg
 ```
 ```
@@ -58,7 +58,7 @@ icons_to_preload = [{
 },]
 
 HeroiconsHelper::Cache.preload!(icons_to_preload) do |found, icon|
-    # An instance of `FakeClass` is stored in the cache
+    # An instance of `FakeClass` will be stored in the cache
     FakeClass.new(icon) unless found
 end
 ```

data/lib/heroicons_helper/icon.rb

@@ -3,22 +3,29 @@
 module HeroiconsHelper
   # Icon to show heroicons by name and variant.
   class Icon
-    attr_reader :path, :attributes, :width, :height, :symbol, :variant
+    attr_reader :path, :attributes, :width, :height, :symbol, :variant, :keywords
 
     VARIANT_OUTLINE = "outline"
     VARIANT_SOLID = "solid"
     VARIANTS = [VARIANT_OUTLINE, VARIANT_SOLID].freeze
 
     def initialize(symbol, variant, attributes: {})
-      @symbol = symbol
-      @variant = variant
+      @symbol = symbol.to_s
+      @variant = variant.to_s
 
-      icon = get_heroicon(@symbol, @variant)
+      heroicon = get_heroicon(@symbol, @variant)
 
-      @path = icon["path"]
-      @width = icon["width"]
-      @height = icon["height"]
-      @attributes = attributes.dup.merge!(default_attributes)
+      @path = heroicon["path"]
+      @width = heroicon["width"]
+      @height = heroicon["height"]
+      @keywords = heroicon["keywords"]
+      @attributes = attributes.dup.compact
+      @attributes[:class] = classes
+      @attributes[:viewBox] = viewbox
+      @attributes.merge!(size)
+      @attributes[:version] = "1.1"
+      @attributes.merge!(variant_attributes)
+      @attributes.merge!(a11y)
     end
 
     # Returns an string representing a <svg> tag
@@ -26,53 +33,93 @@ module HeroiconsHelper
       "<svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
     end
 
-    private
-
-    def html_attributes
+    private def html_attributes
       attrs = []
       @attributes.each_pair { |attr, value| attrs << "#{attr}=\"#{value}\"" }
       attrs.map(&:strip).join(" ")
     end
 
-    def default_attributes
+    # add some accessibility features to svg
+    private def a11y
+      accessible = {}
+
+      if @attributes[:"aria-label"].nil? && @attributes["aria-label"].nil?
+        accessible[:"aria-hidden"] = "true"
+      else
+        accessible[:role] = "img"
+      end
+
+      accessible
+    end
+
+    # prepare the octicon class
+    private def classes
+      "heroicon heroicon-#{@symbol}-#{@variant} #{@attributes[:class]} ".strip
+    end
+
+    private def variant_attributes
       case @variant
       when VARIANT_OUTLINE
         {
-          viewBox: viewbox,
           fill: "none",
           stroke: "currentColor",
         }
       when VARIANT_SOLID
         {
-          viewBox: viewbox,
           fill: "currentColor",
         }
       end
     end
 
-    def viewbox
+    private def viewbox
       "0 0 #{@width} #{@height}"
     end
 
-    def get_heroicon(symbol, variant)
-      symbol_s = symbol.to_s
-      raise ArgumentError, "Icon name can't be empty" if symbol_s.empty?
-      variant_s = variant.to_s
-      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant_s)
+    # determine the height and width of the octicon based on :size option
+    private def size
+      size = {
+        width: @width,
+        height: @height,
+      }
+
+      # Specific size
+      unless @attributes[:width].nil? && @attributes[:height].nil?
+        size[:width]  = @attributes[:width].nil? ? calculate_width(@attributes[:height]) : @attributes[:width]
+        size[:height] = @attributes[:height].nil? ? calculate_height(@attributes[:width]) : @attributes[:height]
+        @width = size[:width]
+        @height = size[:height]
+      end
+
+      size
+    end
+
+    private def calculate_width(height)
+      (height.to_i * @width) / @height
+    end
+
+    private def calculate_height(width)
+      (width.to_i * @height) / @width
+    end
+
+    private def get_heroicon(symbol, variant)
+      raise ArgumentError, "Icon name can't be empty" if symbol.empty?
+
+      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant)
 
-      icon = HeroiconsHelper::ICON_SYMBOLS[symbol_s]
+      icon = HeroiconsHelper::ICON_SYMBOLS[symbol]
 
       raise ArgumentError, "Couldn't find Heroicon for `#{symbol.inspect}`" unless icon
 
-      icon_in_variant = icon["variants"][variant_s]
-      raise ArgumentError, "Heroicon for `#{symbol.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_in_variant
+      icon_variant = icon["variants"][variant]
+      raise ArgumentError, "Heroicon for `#{symbol.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_variant
 
       {
         "name" => icon["name"],
-        "variant" => variant_s,
-        "width" => icon_in_variant["width"],
-        "height" => icon_in_variant["height"],
-        "path" => icon_in_variant["path"],
+        "variant" => variant,
+        "keywords" => icon["keywords"] || [],
+        "width" => icon_variant["width"],
+        "height" => icon_variant["height"],
+        "path" => icon_variant["path"],
       }
     end
   end

data/lib/heroicons_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeroiconsHelper
-  VERSION = "0.2.2"
+  VERSION = "0.4.1"
 end

data/lib/heroicons_helper.rb

@@ -9,7 +9,7 @@ module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
   ICON_SYMBOLS = JSON.parse(file_data).freeze
 
-  def heroicons(symbol, variant, attributes: {})
+  def heroicon(symbol, variant:, **attributes)
     ::HeroiconsHelper::Icon.new(symbol, variant, attributes: attributes)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroicons_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies: []
 description: A package that distributes Heroicons as a gem, for easy inclusion in
   Ruby projects.