heroicons_helper 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a4fd38721f8363f1f2b36b45cec732c0dba30f7ac3ad5d1cb243a8e5a722bda
-  data.tar.gz: 59333a78638dacbc4690bc22d231382d79addea64d4bb703b2efbdb4ccc052df
+  metadata.gz: fa8cbd61b03ddc8aab60aa75caad4b4a0fa7ca42c7b4c808c0900cbcffdbc918
+  data.tar.gz: 4ddab3edb1ccca807b67c19c4c04dc7c7d58749175a1e8c8ecc6ae50fa410010
 SHA512:
-  metadata.gz: 1aef948793f04e86a224734f44da163f037a26c74f392757c0cb0b7546ae26edbfb00ef6ef0bd5bed5bea6b93be49933f3c432f28c94b9654b2905028dced010
-  data.tar.gz: 40c2239119dc8de51e43e55260e2bd9190faaad885ae1e53f4a5b4a24eb2420f5cc5d0e5fb13658c9a5cae55563d319fd858895a23dedbb5611da192d87bb654
+  metadata.gz: 16156c67a9b80aef825dde4c4a6f5e331bc0fe23223ba385ecae02867a586ea759eadf8dd2484581b4f51d66aee2489e210de0030b0d88f1bb73d7f3d2ec09d4
+  data.tar.gz: b222c12def03a08771c1282fff023a707565e93c4695f678af4c8da4aa69b13d3f5d33f1281abfdd6e88b9bfb7754e17fd810c9176ace2d03d392344438e2018

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,12 +25,12 @@ 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
 

data/lib/heroicons_helper/icon.rb

@@ -3,23 +3,23 @@
 module HeroiconsHelper
   # Icon to show heroicons by name and variant.
   class Icon
-    attr_reader :path, :attributes, :width, :height, :symbol, :variant, :keywords
+    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.to_s
+    def initialize(name, variant, attributes: {})
+      @name = name.to_s
       @variant = variant.to_s
 
-      heroicon = get_heroicon(@symbol, @variant)
+      heroicon = get_heroicon(@name, @variant)
 
       @path = heroicon["path"]
       @width = heroicon["width"]
       @height = heroicon["height"]
       @keywords = heroicon["keywords"]
-      @attributes = attributes.dup
+      @attributes = attributes.dup.compact
       @attributes[:class] = classes
       @attributes[:viewBox] = viewbox
       @attributes.merge!(size)
@@ -30,7 +30,7 @@ module HeroiconsHelper
 
     # Returns an string representing a <svg> tag
     def to_svg
-      "<svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
+      "<!-- Heroicon name: #{@variant}/#{@name} --><svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
     end
 
     private def html_attributes
@@ -54,7 +54,7 @@ module HeroiconsHelper
 
     # prepare the octicon class
     private def classes
-      "heroicon heroicon-#{@symbol}-#{@variant} #{@attributes[:class]} ".strip
+      "heroicon heroicon-#{@name}-#{@variant} #{@attributes[:class]} ".strip
     end
 
     private def variant_attributes
@@ -101,17 +101,17 @@ module HeroiconsHelper
       (width.to_i * @height) / @width
     end
 
-    private def get_heroicon(symbol, variant)
-      raise ArgumentError, "Icon name can't be empty" if symbol.empty?
+    private def get_heroicon(name, variant)
+      raise ArgumentError, "Icon name can't be empty" if name.empty?
 
       raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant)
 
-      icon = HeroiconsHelper::ICON_SYMBOLS[symbol]
+      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_variant = icon["variants"][variant]
-      raise ArgumentError, "Heroicon for `#{symbol.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_variant
+      raise ArgumentError, "Heroicon for `#{name.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_variant
 
       {
         "name" => icon["name"],

data/lib/heroicons_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeroiconsHelper
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies: []
 description: A package that distributes Heroicons as a gem, for easy inclusion in
   Ruby projects.