heroicons_helper 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea79c1638e02674896f2f251375b879df8e289d10c39bd1b6550b35f65bb667e
-  data.tar.gz: 49e4f89e38f7ceec4e09970d9864f859424f4e59f314b40353df87e73ff128b9
+  metadata.gz: 32e795de2bdf5ffe8332a8e4d6cdb04def32910875e359606d5fcc65dc31f82d
+  data.tar.gz: ea6e061f06312b495ed529102e10972a06f10462134ef0d96f32de246ee7bd2e
 SHA512:
-  metadata.gz: c4c7715c0dc796769dd80fd26e38a56bbccadb1c00418ac0ff8911722679bd571e2a2cb058ecbf3931e9c6da3020628239ee5500ef90b05aed66c53f856bec5c
-  data.tar.gz: 0257f55a823a70b7147b4ac0d7c3051fd407febea7577b0ffd2cc9bb2e14b7582299daae2a425f273de59ca7bd4dd5ddd51181baeb5ac40cdd47c1006224a324
+  metadata.gz: 07b15015752f2446cd1939ad3a330bffa9a313142b55d291e4ed1941b68ee047f5591ef921978deb0cb3619da28ab66a1da9f7e1e1ac06faafd011df61ca46ba
+  data.tar.gz: dd8578a59db2b627bb809b59051e5d2f238c9c559f6cfe1d0ee91f7eb1ab56d2d5ab88e93f6be5e45f040089d5fb0332b767a7db3df367dcadc5ffe16e3d1ae6

data/README.md

@@ -1,6 +1,6 @@
 # HeroiconsHelper
 
-This gem helps you use Heroicons in your Ruby projects. It's inspired by [heroicons-ruby](https://github.com/chunlea/heroicons-ruby) and [octicons](https://github.com/primer/octicons).
+This gem helps you use Heroicons in your Ruby projects. It's inspired by [heroicons-ruby](https://github.com/chunlea/heroicons-ruby) and [octicons_gem](https://github.com/primer/octicons/tree/main/lib/octicons_gem).
 
 ## Installation
 
@@ -25,19 +25,19 @@ include HeroiconsHelper
 You'll have a brand new method called `heroicon` whose signature looks like this:
 
 ```ruby
-heroicon(symbol, variant, attributes: {})
+heroicon(icon, variant, attributes: {})
 ```
 
 where
 
-* `symbol` is the heroicons name
+* `icon` is the Heroicon name (eg. `:bell` or `"bell")
 * `variant` is the type of Heroicons (eg., `outline` or `solid`)
 * `attributes` are any additional HTML attributes to add on to the resulting `svg` element
 
 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 = heroicon("x", "outline")
+outline_icon = heroicon("x", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
 puts outline_icon.to_svg
 ```
 ```

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, :name, :variant, :keywords
 
     VARIANT_OUTLINE = "outline"
     VARIANT_SOLID = "solid"
     VARIANTS = [VARIANT_OUTLINE, VARIANT_SOLID].freeze
 
-    def initialize(symbol, variant, attributes: {})
-      @symbol = symbol
-      @variant = variant
-
-      icon = get_heroicon(@symbol, @variant)
-
-      @path = icon["path"]
-      @width = icon["width"]
-      @height = icon["height"]
-      @attributes = attributes.dup.merge!(default_attributes)
+    def initialize(name, variant, attributes: {})
+      @name = name.to_s
+      @variant = variant.to_s
+
+      heroicon = get_heroicon(@name, @variant)
+
+      @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,54 +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-#{@name}-#{@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?
+    # 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(name, variant)
+      raise ArgumentError, "Icon name can't be empty" if name.empty?
 
-      variant_s = variant.to_s
-      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant_s)
+      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_NAMES[name]
 
-      raise ArgumentError, "Couldn't find Heroicon for `#{symbol.inspect}`" unless icon
+      raise ArgumentError, "Couldn't find Heroicon for `#{name.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 `#{name.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.3.0"
+  VERSION = "0.4.2"
 end

data/lib/heroicons_helper.rb

@@ -7,9 +7,22 @@ require "json"
 
 module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
-  ICON_SYMBOLS = JSON.parse(file_data).freeze
+  ICON_NAMES = JSON.parse(file_data).freeze
 
-  def heroicon(symbol, variant, attributes: {})
-    ::HeroiconsHelper::Icon.new(symbol, variant, attributes: attributes)
+  def heroicon(name, variant:, **attributes)
+    cache_key = HeroiconsHelper::Cache.get_key(
+      name: name,
+      variant: variant,
+      height: attributes[:height],
+      width: attributes[:width]
+    )
+
+    cached_heroicon = HeroiconsHelper::Cache.read(cache_key)
+    return cached_heroicon unless cached_heroicon.nil?
+
+    heroicon = ::HeroiconsHelper::Icon.new(name, variant, attributes: attributes)
+    HeroiconsHelper::Cache.set(cache_key, heroicon)
+
+    heroicon
   end
 end

metadata

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