heroicons_helper 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbbab8ccd0d05be04deb3df081747364d962a5e21e581d427b0ebbeff67b54ae
-  data.tar.gz: fcff746233b82222604d54d5f5e01cfd5760de65892532c8cfb4ad4c5cc64505
+  metadata.gz: ac5d87867f1aefd58513112eca2bdf6f8e6e54800bedef9d34be407f06f9f36c
+  data.tar.gz: 51184fcc333b5dfe492a312677338c8035b5a0f5d658bbb7c4c1247388976311
 SHA512:
-  metadata.gz: e539907cca91fa6a1f9ed11651238721bb8b7949184d4f8270ea58a5b73855257714d5ed97378cc7613857e31dd1dbcf927be05bbb487dc1fbc462f3c8a990fa
-  data.tar.gz: 36b3b4fe61cd709b59e36c61f8a05d2a2ce024bc11d6ff6bd54bce07990954516eb63df36f4caeddb384153ae711aa496ad64d338391e1fcea0ee2cc1e79ee61
+  metadata.gz: ea63f9c2fb9d2983168f13bb9fc14e86c23c1e142c4a5d1e354a079038b00e82d51c0655d893c7bd913814963b9850b2df81d3627e51909932bdc91b4f9743e9
+  data.tar.gz: 331963ec48860c5eefb19461232da7628927ea7f7eac29856090559bb6b112f659551f02f9d55c2a6641d779e0adcc6eebc264cbf4143991eda9db506c821a90

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "[ruby]": {
+        "editor.defaultFormatter": "Shopify.ruby-lsp"
+    },
+    "[markdown]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    }
+}

data/Gemfile

@@ -5,6 +5,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in heroicons_helper.gemspec
 gemspec
 
+group :development do
+  gem "bundler", "~> 2.0"
+end
+
 group :development, :test do
   gem "amazing_print"
   gem "debug"

data/README.md

@@ -30,9 +30,9 @@ heroicon(icon, variant, attributes: {})
 
 where
 
-* `icon` is the Heroicon name (eg. `:bell` or `"bell")
-* `variant` is the type of Heroicons (eg., `outline`, `solid`, or `mini`)
-* `attributes` are any additional HTML attributes to add on to the resulting `svg` element
+- `icon` is the Heroicon name (eg. `:bell` or `"bell")
+- `variant` is the type of Heroicons (eg., `outline`, `solid`, or `mini`)
+- `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:
 
@@ -40,6 +40,7 @@ This one method call returns an object that represents the Heroicon, and you sho
 outline_icon = heroicon("x-mark", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
 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>
 ```
@@ -48,7 +49,7 @@ puts outline_icon.to_svg
 
 This gem also comes with a simple caching system, which can be useful to preload icons. It works like this:
 
-``` ruby
+```ruby
 icons_to_preload = [{
     name: "thumb-down",
     variant: "outline",
@@ -65,8 +66,8 @@ 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
+- 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.
 

data/Rakefile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rubygems/package_task"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
@@ -12,3 +13,8 @@ end
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
+
+GEMSPEC = Bundler.load_gemspec("heroicons_helper.gemspec")
+gem_path = Gem::PackageTask.new(GEMSPEC).define
+desc "Package the ruby gem"
+task "package" => [gem_path]

data/heroicons_helper.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata = {
+    "funding_uri" => "https://github.com/sponsors/gjtorikian/",
+    "rubygems_mfa_required" => "true",
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -28,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency("activesupport", ">= 6")
+
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
 

data/lib/heroicons_helper/cache.rb

@@ -6,8 +6,15 @@ module HeroiconsHelper
     LOOKUP = {}
 
     class << self
-      def get_key(name:, variant:, width: nil, height: nil)
-        attrs = { name: name, variant: variant, width: width, height: height }
+      def get_key(name:, variant:, unsafe: false, **attributes)
+        attrs = { name: name, variant: variant, unsafe: unsafe }.merge(attributes)
+        if unsafe
+          attrs[:unsafe] = true
+        else
+          attrs.delete(:unsafe)
+          attrs[:safe] = true
+        end
+
         attrs.compact!
         attrs.hash
       end
@@ -52,8 +59,9 @@ module HeroiconsHelper
           cache_key = HeroiconsHelper::Cache.get_key(
             name: icon["name"],
             variant: icon["variant"],
+            unsafe: icon["unsafe"] || false,
             height: height,
-            width: width
+            width: width,
           )
 
           cache_icon = HeroiconsHelper::Cache.read(cache_key)