jekyll_icon_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f1da75e2e118c485c03c07af94262febe7aefe650715dbc72db46802a739594
+  data.tar.gz: 2f6185d3706196a24b561dd317e39ff45230690e2a3fb850730cc3448e632334
+SHA512:
+  metadata.gz: 9b62e7b479c2a44e29e605d96e4121d5cd06cc8f354613123e6c83a56b50c39887d483cf443b0b8b66d50a1a7dd09084267d37af33d4553050b673397d38805c
+  data.tar.gz: 91991f9474658ba39c33012cfe0325f1c516e6d367e4824dcb0eb4c2852b0c9d5742cc07118df8822904b01d0ee8eaf08356a9188dd2cb969a5ad5ee6d5971ce

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll_icon_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robert Buchberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# Jekyll Icon List
+
+**This plugin works, but I haven't had time to test it very thoroughly. Use with caution, and please
+report bugs if you find them.**
+
+## What is it? 
+
+It's a jekyll tag that lets you build unordered lists of items that follow the "Icon + label"
+format.
+
+Write a tag like this: 
+```
+{% icon_list rails bootstrap heroku aws %}
+```
+
+Add some icons, configuration, and a little CSS, and you get something like this: 
+
+![imgur screenshot]( https://i.imgur.com/9m6qCRB.png )
+
+I use it on [my portfolio](https://robert-buchberger.com/projects.html)
+([ github ](https://github.com/rbuchberger/robert-buchberger.com)) if you want to see an example.
+(Actually, currently my master branch doesn't use the gem. Yet. Check the other branches.)
+
+You could use it to build category lists, or tag lists, or a bunch of other stuff.  You can pass
+element attributes in the tag itself, or set default attributes in the config. It only generates
+markup; the styling is up to you. 
+
+It integrates with (and requires) [jekyll-svg-inliner](https://github.com/sdumetz/jekyll-inline-svg)
+to inline your SVGs for you. If you don't use inline SVGs (even though you should), it sets your file
+as an img src attribute (with alt text!).
+
+## Installation
+
+(I don't have it hosted on rubygems yet. It will be once I've cleaned it up a bit further. .)
+
+```ruby
+# Gemfile
+
+group :jekyll_plugins do
+  gem 'jekyll_icon_list', git: 'https://github.com/rbuchberger/jekyll_icon_list.git'
+end
+```
+
+```yml
+# _config.yml
+
+plugins: 
+  -jekyll_icon_list
+```
+
+You'll also want some css. Here's an example that should get you close to the screenshot:
+```css
+
+ul.icon-list {
+  margin: 0;
+  font-size: 1.1em;
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: center;
+  list-style: none;
+}
+
+ul.icon-list li {
+    display: flex;
+    align-items: center;
+    margin: 0 .5em;
+}
+
+.icon {
+  height: 1em;
+  margin-right: .2em;
+}
+
+```
+
+## Usage
+
+Basic usage: 
+
+```
+{% icon_list example_shortname example2 %}
+```
+
+By default, with no configuration:
+
+* It will look for icons in images/icons/ with the same name as your shortname, grabbing the first result which matches (shortname).*
+
+* It will take your shortname, swap dashes for spaces, and titleize it for the label.
+
+So for example, if you write `{% icon_list ruby-on-rails %}`, with `ruby-on-rails.png` located in
+`images/icons/`, it will generate markup like this:
+```
+<ul>
+  <li><img src="/images/icons/ruby-on-rails.png">Ruby On Rails</li>
+<ul>
+```
+
+You can specify attributes to add with --(element) arguments: 
+```
+{% icon_list example example2 example3 --ul class="stumpy" --li class="mopey" %}
+
+```
+
+Available arguments:
+`--ul, --li, --img, --svg, --a`
+These will overwrite any global defaults you have set.
+
+in your \_config.yml there are a few optional settings you can add. Here's an example:
+```
+# _config.yml
+
+icon_list:
+  default_path: images/here/
+  defaults:
+    ul: class="icon-list"
+    li: class="icon-list-item"
+    svg: overflow="visible" class="icon"
+    img: class="wish-i-had-inline-svgs"
+    a: example-attribute="example-value"
+
+svg: 
+  optimize: true # Tells svg-inliner to clean up your SVGs.
+
+```
+
+* `default_path:`- Prepended to the filenames specified in your data file.
+* `defaults:` - Optional HTML attributes to include with your markup, if none are specified in the
+    tag.
+
+If the default filenames and labels don't work for you, create:
+`/_data/icon_list.yml`
+
+And fill it with your icons in the following format: 
+```
+# /_data/icon_list.yml
+
+example1:
+  icon: example_logo.svg 
+  label: My Nicely Formatted, Long Name
+  url: https://example1.com
+example2:
+  icon: sloppy.svg
+  label: Here's Another Label I Don't Have To Type Again
+```
+
+The default directory setting in config.yml will be prepended to your
+filenames. You'll obviously need some icons, I hear you can find them on the
+internet.
+
+If you set a url: for an item in the data file, it'll wrap the li's contents in
+an anchor tag for you.
+
+## Contributing
+
+Bug reports and pull requests are welcome. https://github.com/rbuchberger/jekyll_icon_list
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jekyll_icon_list'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll_icon_list.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_icon_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_icon_list'
+  spec.version       = JekyllIconList::VERSION
+  spec.authors       = ['Robert Buchberger']
+  spec.email         = ['robert@robert-buchberger.com']
+
+  spec.summary       = 'Builds lists of Icons and labels'
+  spec.homepage      = 'https://github.com/rbuchberger/jekyll_icon_list'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.  if spec.respond_to?(:metadata)
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else raise 'RubyGems 2.0 or newer is required to protect against ' \ 'public
+  # gem pushes.' end
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'jekyll-inline-svg'
+end

data/lib/jekyll_icon_list.rb

@@ -0,0 +1,162 @@
+require 'jekyll_icon_list/version'
+require 'jekyll'
+require 'jekyll-inline-svg'
+# Title: Jekyll Icon List
+# Author: Robert Buchberger : robert@robert-buchberger.com
+# Description: Generates lists of icons + labels, useful for things like tag
+# lists.
+
+module JekyllIconList
+  # This tag looks for commands in the following format:
+  # {% icon_list item1 item2 item3 --ul class="example" --li class="example2" %}
+  # And renders an unordered list of icons and labels.  Items are a space
+  # separated list of names defined in _data/icons.yml. Acceptable commands are
+  # --ul, --li, --svg, and --img. Their arguments are inserted into their
+  # respective HTML elements upon render.
+  class IconList < Liquid::Tag
+    # \.     -  dot
+    # [\w]+  -  One or more letters, numbers, or underscores
+    # $      -  End of string
+    FILE_EXT_REGEX = /\.([\w]+)\z/
+
+    def initialize(tag_name, raw_input, tokens)
+      @raw_input = raw_input
+      @tokens = tokens
+      super
+    end
+
+    def initialize_attributes
+      {
+        'ul' => '',
+        'li' => '',
+        'img' => '',
+        'svg' => '',
+        'a' => ''
+      }
+    end
+
+    def attribute_defaults
+      attributes = initialize_attributes
+
+      attributes.each_key do |k|
+        if @li_settings['defaults'] && @li_settings['defaults'][k]
+          attributes[k] = @li_settings['defaults'][k].dup
+        end
+      end
+
+      attributes
+    end
+
+    def parse_input(raw_input)
+      # raw_input will look something like this:
+      # 'item1 item2 item3 --ul attribute="value" --(...) "'
+
+      raw_input_array = raw_input.split('--').map { |i| i.strip.split(' ') }
+      # [['item1', 'item2', 'item3'], ['ul', 'attribute="value"'], (...) ]
+
+      @item_shortnames = raw_input_array.shift
+
+      raw_input_array.each do |a|
+        key = a.shift
+        @attributes[key] = a.join ' '
+      end
+    end
+
+    def build_image_tag(icon_filename)
+      file_ext = FILE_EXT_REGEX.match(icon_filename)[1]
+
+      element = if file_ext == 'svg'
+                  Jekyll::Tags::JekyllInlineSvg.send(
+                    :new,
+                    'svg',
+                    "#{icon_filename} #{@attributes['svg']}",
+                    @tokens
+                  ).render(@context)
+                else
+                  "<img src=\"#{icon_filename}\" "\
+                    "alt=\"icon for #{icon_data['label']}\" "\
+                    "#{@attributes['img']}>"
+                end
+
+      element << "\n"
+    end
+
+    def find_icon(item_shortname, this_item_data)
+      # This line gave me an interesting bug: jekyll data files are apparently
+      # mutable and persistent between tag calls. If I had the same item
+      # multiple times on a page (which is the entire point of this plugin), the
+      # default path would be prepended each time. .dup is very important!
+      icon_data_filename = this_item_data['icon'].dup
+      default_path = @li_settings['default_path'] || '/images/icons/'
+
+      if icon_data_filename && default_path
+        default_path + icon_data_filename
+      elsif icon_data_filename
+        icon_data_filename
+      elsif default_path
+        f = Dir.glob(Dir.pwd + default_path + item_shortname + '.*')
+        unless f.any?
+          raise "No icon for #{item_shortname} set in _data/icon_list.yml"\
+          ", and default filename #{default_path + item_shortname}.* not found"
+        end
+
+        f.first # Returns the first matching result. May improve in the future
+      else
+        raise "No icon for #{item_shortname} specified in _data/icon_list.yml"\
+          'And no default directory specified in _config.yml.'\
+          'Must have one, the other, or both.'
+      end
+    end
+
+    def build_label(shortname, this_item_data)
+      this_item_data['label'] ||
+        shortname.split('-').map(&:capitalize).join(' ')
+    end
+
+    def build_li(this_item_data, icon_location, label)
+      li = "  <li #{@attributes['li']}>"
+      if this_item_data && this_item_data['url']
+        li << "<a href=\"#{this_item_data['url']}\" #{@attributes['a']}>"
+      end
+      li << build_image_tag(icon_location)
+      li << label
+      li << '</a>' if this_item_data['url']
+      li << '</li>'
+    end
+
+    def build_html(all_items_data)
+      list = "<ul #{@attributes['ul']}>\n"
+
+      @item_shortnames.each do |n|
+        this_icon_data = all_items_data[n] || {}
+
+        icon_location = find_icon n, this_icon_data
+
+        label = build_label(n, this_icon_data)
+
+        list << build_li(this_icon_data, icon_location, label)
+      end
+
+      list << "</ul>\n"
+    end
+
+    def render(context)
+      @context = context
+
+      site_settings = @context.registers[:site]
+      raise 'could not load website configuration data' unless site_settings
+
+      @li_settings = site_settings.config['icon_list'] || {}
+
+      all_items_data = site_settings.data['icon_list'] || {}
+
+      @attributes = attribute_defaults
+
+      parse_input(@raw_input)
+
+      build_html(all_items_data)
+    end
+  end
+end
+
+Liquid::Template.register_tag('icon_list', JekyllIconList::IconList)

data/lib/jekyll_icon_list/version.rb

@@ -0,0 +1,3 @@
+module JekyllIconList
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_icon_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Buchberger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-inline-svg
+  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: 
+email:
+- robert@robert-buchberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_icon_list.gemspec
+- lib/jekyll_icon_list.rb
+- lib/jekyll_icon_list/version.rb
+homepage: https://github.com/rbuchberger/jekyll_icon_list
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Builds lists of Icons and labels
+test_files: []