jekyll-heroicons 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 322cd61f2d8878a54eb79e17095b92481ab9c61e4ae901c34a89bef592601644
-  data.tar.gz: 1ea45b683425828a15df226a591143b8d85afc0b59099730de462189d5f60d1c
+  metadata.gz: d75f8059ea7aa63207d3554a911705015944ad140535354c3488869f1b2c1276
+  data.tar.gz: 3fa2aa1a5127b87a6c209d26e2a868eaf8eb4987a790f59401db1789f71e043d
 SHA512:
-  metadata.gz: d627303c0bf01da17aee0e56408ce006f3634909e8b296ffc1278228371af74e0fa57ca8f6c35a0f570c9c55b343b48669d18fb2a9d2c9516de601a6d4e0cd41
-  data.tar.gz: 48d3fac6c1c06de615b73e4a13ef3327dd172f83d09bd76c94f0fa8bbc101f39e629cd954d043a9cd9ce1a10b75fd5bc8e107b62b4c574183ace9140c5e63c6b
+  metadata.gz: 57e8044b126bd1fb9839ff9c8eed9e6e33d247c0ef376a2311d6cbbc409cf2d1d9fe619ad9a651d9384b400544f87e9123a34107cfb602bf1681ec99dfabc5c1
+  data.tar.gz: 1091d7b8bd64b141ac8bb1ebf900f9be812179bf48f9198e6c45140c8e2a5e18dcb2d76da98810ce6199cb22d1b56c23d5a7e72ec7873e21c89023f99626a3c8

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Jekyll-Heroicons
 
+## 0.2.0
+- Introduce Icon class to deal with different parameters that could be passed to vsg code.
 ## 0.1.1
 - Include icons/ directory with a gem
 ## 0.1

data/README.md

@@ -30,6 +30,12 @@ Configure default settings in `_config.yml`:
 ```ruby
 heroicons:
   variant: 'solid'
+  default_class: {
+    solid: "size-6",
+    outline: "size-6",
+    mini: "size-5",
+    micro: "size-4",
+  }
 ```
 
 And then you can use:

data/lib/jekyll-heroicons/icon.rb

@@ -0,0 +1,44 @@
+require "nokogiri"
+
+module Jekyll
+  class Heroicons < Liquid::Tag
+    class Icon
+      def initialize(symbol, variant, options = {})
+        @symbol = symbol
+        @variant = variant
+        @options = options
+      end
+
+      def raw
+        doc = Nokogiri::HTML::DocumentFragment.parse(file)
+        svg = doc.at_css "svg"
+
+        prepend_default_classes
+
+        @options.each do |key, value|
+          svg[key.to_s] = value
+        end
+
+        doc
+      end
+
+      private
+
+      def prepend_default_classes
+        if @options[:class]
+          @options[:class] += " size-6"
+        else
+          @options[:class] = "size-6"
+        end
+      end
+
+      def file
+        @file ||= File.read(file_path).force_encoding("UTF-8")
+      end
+
+      def file_path
+        File.join(Jekyll::Heroicons.root, "icons/#{@variant}/#{@symbol}.svg")
+      end
+    end
+  end
+end

data/lib/jekyll-heroicons/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-#prevent bundler errors
+# prevent bundler errors
 module Liquid; class Tag; end; end
 
 module Jekyll
   class Heroicons < Liquid::Tag
-    VERSION = "0.1.1"
+    VERSION = "0.2"
   end
 end

data/lib/jekyll-heroicons.rb

@@ -1,39 +1,44 @@
 # frozen_string_literal: true
 
-require_relative 'jekyll-heroicons/version'
-require 'liquid'
-require 'jekyll/liquid_extensions'
+require_relative "jekyll-heroicons/version"
+require_relative "jekyll-heroicons/icon"
+require "liquid"
+require "jekyll/liquid_extensions"
 
 module Jekyll
   class Heroicons < Liquid::Tag
     include Jekyll::LiquidExtensions
 
+    def self.root
+      File.dirname(__dir__)
+    end
+
     # Syntax for the heroicon symbol
-    Syntax = /\A(#{Liquid::VariableSignature}+)/
+    SYNTAX = /\A(#{Liquid::VariableSignature}+)/
 
     # For interpolation, look for liquid variables
-    Variable = /\{\{\s*([\w]+\.?[\w]*)\s*\}\}/i
+    VARIABLE = /\{\{\s*([\w]+\.?[\w]*)\s*\}\}/i
 
     # Copied from Liquid::TagAttributes to allow dashes in tag names:
     #
     #   {% heroicon alert area-label:"Hello World!" %}
     #
-    TagAttributes = /([\w-]+)\s*\:\s*(#{Liquid::QuotedFragment})/o
+    TAG_ATTRIBUTES = /([\w-]+)\s*:\s*(#{Liquid::QuotedFragment})/o
 
     def initialize(tag_name, markup, options)
       super
       @markup = markup
 
       # If there's interpolation going on, we need to do this in render
-      prepare(markup) unless markup.match(Variable)
+      prepare(markup) unless markup.match(VARIABLE)
     end
 
     def render(context)
-      prepare(interpolate(@markup, context)) if @markup.match(Variable)
+      prepare(interpolate(@markup, context)) if @markup.match(VARIABLE)
 
       return nil if @symbol.nil?
 
-      File.read(File.expand_path("../icons/#{@variant}/#{@symbol}.svg", __dir__))
+      Icon.new(@symbol, @variant, @options.except(:variant)).raw
     end
 
     private
@@ -41,16 +46,16 @@ module Jekyll
     def prepare(markup)
       @symbol = symbol(markup)
       @options = string_to_hash(markup)
-      @variant = if (match = markup.split('/')).length > 1
-                   match.first
-                 elsif @options.key?(:variant)
-                   @options[:variant]
-                 end
+      @variant = if (match = markup.split("/")).length > 1
+        match.first
+      elsif @options.key?(:variant)
+        @options[:variant]
+      end
     end
 
     def interpolate(markup, context)
-      markup.scan Variable do |variable|
-        markup = markup.gsub(Variable, lookup_variable(context, variable.first))
+      markup.scan VARIABLE do |variable|
+        markup = markup.gsub(VARIABLE, lookup_variable(context, variable.first))
       end
       markup
     end
@@ -59,9 +64,9 @@ module Jekyll
     def string_to_hash(markup)
       options = {}
 
-      if markup.match(Syntax)
-        markup.scan(TagAttributes) do |key, value|
-          options[key.to_sym] = value.gsub(/\A"|"\z/, '')
+      if markup.match(SYNTAX)
+        markup.scan(TAG_ATTRIBUTES) do |key, value|
+          options[key.to_sym] = value.gsub(/\A"|"\z/, "")
         end
       end
 
@@ -69,13 +74,13 @@ module Jekyll
     end
 
     def symbol(markup)
-      if (match = markup.split('/')).length > 1
-        match[1].match(Syntax)
+      if (match = markup.split("/")).length > 1
+        match[1].match(SYNTAX)
       else
-        markup.match(Syntax)
+        markup.match(SYNTAX)
       end
     end
   end
 end
 
-Liquid::Template.register_tag('heroicon', Jekyll::Heroicons)
+Liquid::Template.register_tag("heroicon", Jekyll::Heroicons)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-heroicons
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Jekyll liquid tags for the beautiful hand-crafted SVG icons, Heroicons.
 email:
 - github@skatkov.com
@@ -1326,6 +1340,7 @@ files:
 - icons/solid/x-circle.svg
 - icons/solid/x-mark.svg
 - lib/jekyll-heroicons.rb
+- lib/jekyll-heroicons/icon.rb
 - lib/jekyll-heroicons/version.rb
 homepage: https://github.com/skatkov/jekyll-heroicons
 licenses: