heroicons_helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 668ee3c4c63423a55043c27767e157662c42eae1b79dd983f2112482eee0f661
-  data.tar.gz: a73d673d85a739017cf0b98b383629418a6c8730b1dc98fd9367cb34b574e01f
+  metadata.gz: 95ec724478d383801f98ffeeb2bd8d0f5f14fea4c6eee777b59b9bc5e0337d78
+  data.tar.gz: 18e9be3121ca73f11a472a36ed35d31b2c157a12a4d177395e82ea7d5dacf993
 SHA512:
-  metadata.gz: 43c906d2e65a78ce00fc56c164788930d7e4a6c0c12edaf7c416357a927a5e50e2c8edb8ba210b6f033717761f3ddf6aa4fafb171158a4b81ee893c4971e2d40
-  data.tar.gz: 19adfe1de1ee6e9ca95cf225afd6d69b9ff9667e2307fb8080b5ca4b7547026800fcab3dbf374a231e9475e5e97aeebfefe61f5216755e0cd56313c1078e67a6
+  metadata.gz: 5ab5881814e673ef1d7ee9e24f454a05796c4558baaa780a3c0d7a1365dec92e67858c535b41e046b3cf548b9265a9446fbdb38fc10631e3e1475566f074a742
+  data.tar.gz: 4fee60bcdd51cb3109fc48acde1693a702f965ab3475f9f9ebce6ed9e26110f5cc668febde294e4d20f30cbe6de64d07aae1e686ec7f62d742987a3ca98aa111

data/Gemfile

@@ -6,10 +6,13 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
+  gem "amazing_print"
+  gem "debug"
   gem "rake", "~> 13.0"
   gem "rubocop-standard", "~> 7.0"
 end
 
 group :test do
   gem "minitest", "~> 5.15"
+  gem "minitest-focus", "~> 1.3"
 end

data/README.md

@@ -44,6 +44,32 @@ puts outline_icon.to_svg
 => <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M6 18L18 6M6 6l12 12"></path></svg>
 ```
 
+## Cache
+
+This gem also comes with a simple caching system, which can be useful to preload icons. It works like this:
+
+``` ruby
+icons_to_preload = [{
+    name: "thumb-down",
+    variant: "outline",
+}, {
+    name: "refresh",
+    variant: "solid",
+},]
+
+HeroiconsHelper::Cache.preload!(icons_to_preload) do |found, icon|
+    # An instance of `FakeClass` is stored in the cache
+    FakeClass.new(icon) unless found
+end
+```
+
+`HeroiconsHelper::Cache.preload!` does one of two things:
+
+* If, given the `icons_to_preload` array, an item is located in the cache, `found` is true and `icon` is the cached item
+* Otherwise, `found` is false, and `icon` is the element currently being iterated. Also, the last line of the block sets the cache
+
+The Hash elements within `icons_to_preload` can also take `height` and `width` keys.
+
 ## Development
 
 To update the Heroicons set:

data/lib/heroicons_helper/cache.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module HeroiconsHelper
+  # :nodoc:
+  class Cache
+    LOOKUP = {}
+
+    class << self
+      def get_key(name:, variant:, width: nil, height: nil)
+        attrs = { name: name, variant: variant, width: width, height: height }
+        attrs.compact!
+        attrs.hash
+      end
+
+      def read(key)
+        LOOKUP[key]
+      end
+
+      # Cache size limit.
+      def limit
+        500
+      end
+
+      def set(key, value)
+        LOOKUP[key] = value
+
+        # Remove first item when the cache is too large.
+        LOOKUP.shift if LOOKUP.size > limit
+      end
+
+      def clear!
+        LOOKUP.clear
+      end
+
+      # @param icons_to_preload [Array<Hash>] List of icons to render, in the format { name: :icon_name, variant: "variant" }.
+      def preload!(icons_to_preload, &block)
+        raise ArgumentError, "icons_to_preload must be an Array; it's #{icons_to_preload.class}" unless icons_to_preload.is_a?(Array)
+        raise ArgumentError, "icons_to_preload must have between 1 and 20 items; you have #{preload.count}" unless (1..20).cover?(icons_to_preload.count)
+
+        icons_to_preload.each do |icon|
+          height = icon["height"] || nil
+          width = icon["width"] || nil
+
+          # Don't allow sizes under 16px
+          if !height.nil? && height.to_i < 16
+            height = nil
+          end
+          if !width.nil? && width.to_i < 16
+            width = nil
+          end
+
+          cache_key = HeroiconsHelper::Cache.get_key(
+            name: icon["name"],
+            variant: icon["variant"],
+            height: height,
+            width: width
+          )
+
+          cache_icon = HeroiconsHelper::Cache.read(cache_key)
+          found = !cache_icon.nil?
+
+          result = yield found, cache_icon || icon
+
+          HeroiconsHelper::Cache.set(cache_key, result) unless found
+        end
+      end
+    end
+  end
+end