heroicons_helper 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80e090d354ed7b42e47a7436e723b4bd438a75aaa558856a830ed78a3fcbb3d5
-  data.tar.gz: 475b59fd40ed8e85775eb620131fa0425f17608d6d1c8f2d1f4aa90c8327735b
+  metadata.gz: 32e795de2bdf5ffe8332a8e4d6cdb04def32910875e359606d5fcc65dc31f82d
+  data.tar.gz: ea6e061f06312b495ed529102e10972a06f10462134ef0d96f32de246ee7bd2e
 SHA512:
-  metadata.gz: d45fea85415d4fac7ed79f0cf1563dd3fd7dabf87780714dc41d5e3bc09ca3d9581d58f1312db7be08f9803fad2389417b90d3aea1fb74acb18c0ffe8b4ad1ff
-  data.tar.gz: 703138870cb157f666d37d3df838dfaccd1b5d12d20c2e98c78ec7db2b57ed804c074c00a220d61e431104b62ae9168eb9eb9c12c88805ab9a24581fe8c53d09
+  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,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,17 +3,17 @@
 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"]
@@ -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.1"
+  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.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-11 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.