jekyll_icon_list 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294f5dc753151d6747ad2bcef2a8f22093778670afa2e22f79694eef6e0cf5cd
-  data.tar.gz: 7e7581912633dcd57786f1cf8154c7b02d99ce84b72ee569d6991777dfc65de9
+  metadata.gz: 66af09ff271544ab5afed2a9e28e05769d75337d43dafa32747fc546d1f91f5f
+  data.tar.gz: 26ebee9c1b1fa4589a3587c2fa9169a5cc18304948e032d639e15cec76e132e9
 SHA512:
-  metadata.gz: 8e79caf7c62ec1785166e32564cebac56de016d72552420b73fb44f0f4e02537efe79f7a5412b38b327d8122fa683824637c47d0301b0a6311a93ce0537342cf
-  data.tar.gz: 755ab786b160630bf38271396d9ea0bafb8abc207b785ed62ebf81130ae71e05179de815a06da04c651d7911022dda56e2fe898f9bf8ff843fa616597de24109
+  metadata.gz: 1b507c5492ac70c6cd0aedd02e56e7f2efdf264733ee280315c086b9d09b734c480700b10c85f5ddb6c8d0903051260e00edc5896de608a93bebad6bf7c6575a
+  data.tar.gz: 38507a86625e2ec9ab637359bdeaad9ed195b7ede1c22885e5878ec1ff90a6cefa8123f325722ef61567edfc57bd2f6ed7b5085f3a5a559c9e221befec2f5d07

data/README.md

@@ -48,6 +48,10 @@ plugins:
 
 ```
 {% icon_list example example2 example3 %}
+
+# or: 
+
+{% icon_list {{ page.categories }} %}
 ```
 
 By default, with no configuration:
@@ -104,6 +108,30 @@ would like to use, which will be prepended by your default_path if you set one (
 
 If you set a `url:`, it'll wrap the `<li>` contents in an anchor tag.
 
+### Liquid Variables:
+
+It will parse liquid variables, as either a yaml array or a space-separated-list. Enclose them in
+double curly braces, like this: `{{ my_context.my_variable }}`. **If given multiword variables, it
+will attempt to build an item for each word.**
+
+Example: 
+
+```
+---
+category_list: 
+  - skydiving
+  - spelunking
+  - bouldering
+
+category_string: skydiving spelunking bouldering
+---
+
+{% icon_list {{ page.category_list }} %}
+
+{% icon_list {{ page.category_string }} %}
+```
+(Both icon_list tags will return the same output)
+
 ## Configuration
 
 * All of icon_list's configuration is under the `icon_list:` key in \_config.yml
@@ -199,13 +227,9 @@ At this point the dependency on jekyll-svg-inliner gets pretty tenuous; do we
 really need a plugin and an extra file to render 3 lines of simple code? In the
 future I'd like to streamline this.
 
-### Liquid variables
-
-You can't pass in liquid variables yet. It's on the to-do list.
-
 ## Contributing
 
-Bug reports and pull requests are welcome. https://github.com/rbuchberger/jekyll_icon_list
+Bug reports, feature requests, and pull requests are welcome. https://github.com/rbuchberger/jekyll_icon_list
 Contact: robert@robert-buchberger.com
 
 I've been using rubocop with the default settings, and would appreciate if pull requests did the

data/lib/jekyll_icon_list.rb

@@ -1,7 +1,10 @@
 require 'jekyll_icon_list/version'
+
 require 'jekyll'
 require 'jekyll-inline-svg'
+require 'jekyll/liquid_extensions'
 require 'objective_elements'
+
 # Title: Jekyll Icon List
 # Author: Robert Buchberger : robert@robert-buchberger.com
 # Description: Generates lists of icons + labels, useful for things like tag
@@ -15,6 +18,9 @@ module JekyllIconList
   # --ul, --li, --svg, and --img. Their arguments are inserted into their
   # respective HTML elements upon render.
   class IconList < Liquid::Tag
+    # Used for finding liquid variables in input
+    include Jekyll::LiquidExtensions
+
     def initialize(tag_name, raw_input, tokens)
       @raw_input = raw_input
       @tokens = tokens
@@ -37,22 +43,38 @@ module JekyllIconList
     end
 
     def build_settings
-      # raw_input will look something like this:
-      # 'item1 item2 item3 --ul attribute="value" --(...)'
-
       @attributes = @icon_list_settings['defaults'].dup || {}
       # {'ul' => 'class="awesome" (...)', (...)}
 
-      raw_input_array = @raw_input.split('--').map { |i| i.strip.split(' ') }
+      # raw_input will look something like this:
+      # 'item1 item2 item3 --ul attribute="value" --(...)'
+      raw_input_array = liquid_lookup(@raw_input).split('--').map do |i|
+        i.strip.split(' ')
+      end
       # [['item1', 'item2', 'item3'], ['ul', 'attr="value', 'value2"'],(...)]
 
       @item_shortnames = raw_input_array.shift
-      # ['ul, 'attribute="value1 value2"', (...)]
+      # item_shortnames = ['item1', 'item2', 'item3']
+      # raw_input_array = ['ul, 'attribute="value1 value2"', (...)]
 
       raw_input_array.each { |a| @attributes[a.shift] = a.join ' ' }
       # {'ul' => 'attribute="value1 value2 value3"'}
     end
 
+    LIQUID_REGEX = /\{\{\s*([\w]+\.?[\w]*)\s*\}\}/i
+    def liquid_lookup(input)
+      # I mostly stole this method from SVG Inliner. There may be a better way,
+      # but this works well enough.
+      input.scan LIQUID_REGEX do |match|
+        value = lookup_variable(@context, match.first)
+        value = value.join(' ') if value.is_a? Array
+
+        input = input.sub(LIQUID_REGEX, value)
+      end
+
+      input
+    end
+
     def build_html(all_items_data)
       list = DoubleTag.new 'ul', attributes: @attributes['ul']
 
@@ -134,13 +156,10 @@ module JekyllIconList
     end
 
     def build_anchor(url, content)
-      a = DoubleTag.new(
-        'a',
-        attributes: { href: url },
-        oneline: true,
-        content: content
-      )
+      a = DoubleTag.new 'a', attributes: { href: url }, oneline: true
+      a.add_content content
       a.add_attributes @attributes['a'] if @attributes['a']
+      a
     end
   end
 end

data/lib/jekyll_icon_list/version.rb

@@ -1,3 +1,3 @@
 module JekyllIconList
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_icon_list
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Buchberger