heroicons_helper 0.7.1 → 0.9.0

data/lib/heroicons_helper/icon.rb

@@ -6,36 +6,37 @@ require "active_support/core_ext/string/output_safety"
 module HeroiconsHelper
   # Icon to show heroicons by name and variant.
   class Icon
-    attr_reader :path, :attributes, :width, :height, :name, :variant, :keywords
+    attr_reader :inner, :attributes, :width, :height, :name, :variant, :keywords
 
     VARIANT_OUTLINE = "outline"
     VARIANT_SOLID = "solid"
     VARIANT_MINI = "mini"
-    VALID_VARIANTS = Set.new([VARIANT_OUTLINE, VARIANT_SOLID, VARIANT_MINI]).freeze
+    VARIANT_MICRO = "micro"
+    VALID_VARIANTS = Set.new([VARIANT_OUTLINE, VARIANT_SOLID, VARIANT_MINI, VARIANT_MICRO]).freeze
 
-    def initialize(name, variant, unsafe: false, attributes: {})
+    def initialize(name, variant, size: nil, attributes: {})
       @name = name.to_s
       @variant = variant.to_s
-      @unsafe = unsafe
 
       heroicon = get_heroicon(@name, @variant)
 
-      @path = safe? ? ActiveSupport::SafeBuffer.new(heroicon["path"]) : heroicon["path"]
-      @width = heroicon["width"]
-      @height = heroicon["height"]
+      @inner = heroicon["inner"]
+      @width = size || heroicon["width"]
+      @height = size || heroicon["height"]
       @keywords = heroicon["keywords"]
-      @attributes = attributes.dup.compact
-      @attributes[:class] = classes
-      @attributes[:viewBox] = viewbox
-      @attributes.merge!(size)
-      @attributes[:version] = "1.1"
-      @attributes.merge!(variant_attributes)
-      @attributes.merge!(a11y)
+      @attributes = attributes.merge(heroicon["attributes"])
+      @attributes.merge!({
+        "class" => classes,
+        "viewBox" => viewbox,
+        "version" => "1.1",
+      })
+        .merge!(a11y)
+        .compact!
     end
 
     # Returns an string representing a <svg> tag
     def to_svg
-      "<!-- Heroicon name: #{@variant}/#{@name} --><svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
+      "<svg #{html_attributes}>#{@inner}</svg>"
     end
 
     private def safe?
@@ -53,9 +54,9 @@ module HeroiconsHelper
       accessible = {}
 
       if @attributes[:"aria-label"].nil? && @attributes["aria-label"].nil?
-        accessible[:"aria-hidden"] = "true"
+        accessible["aria-hidden"] = "true"
       else
-        accessible[:role] = "img"
+        accessible["role"] = "img"
       end
 
       accessible
@@ -63,44 +64,13 @@ module HeroiconsHelper
 
     # prepare the heroicon class
     private def classes
-      "heroicon heroicon-#{@name}-#{@variant} #{@attributes[:class]} ".strip
-    end
-
-    private def variant_attributes
-      case @variant
-      when VARIANT_OUTLINE
-        {
-          fill: "none",
-        }
-      when VARIANT_SOLID, VARIANT_MINI
-        {
-          fill: "currentColor",
-        }
-      end
+      "heroicon heroicon-#{@variant}-#{@name} #{@attributes[:class]} ".strip
     end
 
     private def viewbox
       "0 0 #{@width} #{@height}"
     end
 
-    # determine the height and width of the heroicon based on :size option
-    private def size
-      size = {
-        width: @width,
-        height: @height,
-      }
-
-      # Specific size
-      unless @attributes[:width].nil? && @attributes[:height].nil?
-        size[:width]  = @attributes[:width].nil? ? calculate_width(@attributes[:height]) : @attributes[:width]
-        size[:height] = @attributes[:height].nil? ? calculate_height(@attributes[:width]) : @attributes[:height]
-        @width = size[:width]
-        @height = size[:height]
-      end
-
-      size
-    end
-
     private def calculate_width(height)
       (height.to_i * @width) / @height
     end
@@ -114,7 +84,7 @@ module HeroiconsHelper
 
       raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VALID_VARIANTS.join(", ")}" unless VALID_VARIANTS.include?(variant)
 
-      icon = HeroiconsHelper::ICON_NAMES[name]
+      icon = HeroiconsHelper::ICONS[name]
 
       raise ArgumentError, "Couldn't find Heroicon for `#{name.inspect}`" unless icon
 
@@ -127,7 +97,8 @@ module HeroiconsHelper
         "keywords" => icon["keywords"] || [],
         "width" => icon_variant["width"],
         "height" => icon_variant["height"],
-        "path" => icon_variant["path"],
+        "attributes" => icon_variant["attributes"],
+        "inner" => icon_variant["inner"],
       }
     end
   end

data/lib/heroicons_helper/version.rb

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

data/lib/heroicons_helper.rb

@@ -7,20 +7,20 @@ require "json"
 
 module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
-  ICON_NAMES = JSON.parse(file_data).freeze
+  ICONS = JSON.parse(file_data).freeze
 
-  def heroicon(name, variant:, unsafe: false, **attributes)
+  def heroicon(name, variant:, size: nil, **attributes)
     cache_key = HeroiconsHelper::Cache.get_key(
       name: name,
       variant: variant,
-      unsafe: unsafe,
+      size: size,
       attributes: attributes,
     )
 
     cached_heroicon = HeroiconsHelper::Cache.read(cache_key)
     return cached_heroicon unless cached_heroicon.nil?
 
-    heroicon = ::HeroiconsHelper::Icon.new(name, variant, unsafe: unsafe, attributes: attributes)
+    heroicon = ::HeroiconsHelper::Icon.new(name, variant, size: size, attributes: attributes)
     HeroiconsHelper::Cache.set(cache_key, heroicon)
 
     heroicon