heroicons_helper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ec724478d383801f98ffeeb2bd8d0f5f14fea4c6eee777b59b9bc5e0337d78
-  data.tar.gz: 18e9be3121ca73f11a472a36ed35d31b2c157a12a4d177395e82ea7d5dacf993
+  metadata.gz: ea79c1638e02674896f2f251375b879df8e289d10c39bd1b6550b35f65bb667e
+  data.tar.gz: 49e4f89e38f7ceec4e09970d9864f859424f4e59f314b40353df87e73ff128b9
 SHA512:
-  metadata.gz: 5ab5881814e673ef1d7ee9e24f454a05796c4558baaa780a3c0d7a1365dec92e67858c535b41e046b3cf548b9265a9446fbdb38fc10631e3e1475566f074a742
-  data.tar.gz: 4fee60bcdd51cb3109fc48acde1693a702f965ab3475f9f9ebce6ed9e26110f5cc668febde294e4d20f30cbe6de64d07aae1e686ec7f62d742987a3ca98aa111
+  metadata.gz: c4c7715c0dc796769dd80fd26e38a56bbccadb1c00418ac0ff8911722679bd571e2a2cb058ecbf3931e9c6da3020628239ee5500ef90b05aed66c53f856bec5c
+  data.tar.gz: 0257f55a823a70b7147b4ac0d7c3051fd407febea7577b0ffd2cc9bb2e14b7582299daae2a425f273de59ca7bd4dd5ddd51181baeb5ac40cdd47c1006224a324

data/README.md

@@ -22,10 +22,10 @@ require "heroicons_helper"
 include HeroiconsHelper
 ```
 
-You'll have a brand new method called `heroicons` whose signature looks like this:
+You'll have a brand new method called `heroicon` whose signature looks like this:
 
 ```ruby
-heroicons(symbol, variant, attributes: {})
+heroicon(symbol, variant, attributes: {})
 ```
 
 where
@@ -37,7 +37,7 @@ where
 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 = heroicons("x", "outline")
+outline_icon = heroicon("x", "outline")
 puts outline_icon.to_svg
 ```
 ```
@@ -58,7 +58,7 @@ icons_to_preload = [{
 },]
 
 HeroiconsHelper::Cache.preload!(icons_to_preload) do |found, icon|
-    # An instance of `FakeClass` is stored in the cache
+    # An instance of `FakeClass` will be stored in the cache
     FakeClass.new(icon) unless found
 end
 ```

data/lib/heroicons_helper/icon.rb

@@ -55,15 +55,22 @@ module HeroiconsHelper
     end
 
     def get_heroicon(symbol, variant)
-      icon = HeroiconsHelper::ICON_SYMBOLS[symbol]
-      raise "Couldn't find heroicons symbol for #{@symbol.inspect}" unless icon
+      symbol_s = symbol.to_s
+      raise ArgumentError, "Icon name can't be empty" if symbol_s.empty?
 
-      icon_in_variant = icon["variants"][variant]
-      raise "Heroicons symbol for #{@symbol.inspect} doesn't have variant #{@variant.inspect}" unless icon_in_variant
+      variant_s = variant.to_s
+      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant_s)
+
+      icon = HeroiconsHelper::ICON_SYMBOLS[symbol_s]
+
+      raise ArgumentError, "Couldn't find Heroicon for `#{symbol.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
 
       {
         "name" => icon["name"],
-        "variant" => variant,
+        "variant" => variant_s,
         "width" => icon_in_variant["width"],
         "height" => icon_in_variant["height"],
         "path" => icon_in_variant["path"],

data/lib/heroicons_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeroiconsHelper
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/heroicons_helper.rb

@@ -9,7 +9,7 @@ module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
   ICON_SYMBOLS = JSON.parse(file_data).freeze
 
-  def heroicons(symbol, variant, attributes: {})
+  def heroicon(symbol, variant, attributes: {})
     ::HeroiconsHelper::Icon.new(symbol, variant, attributes: attributes)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroicons_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen J. Torikian
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Heroicons port for Ruby