jekyll-heroicons 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d77e008bb48a22d63e708eab44eda2b9a8ff46f243a069d3361e1dc3ff246f13
+  data.tar.gz: cf9e93dcda6e3cc059db28541fe9049c5d6a5daaeee7f69de03bfdc3d2bc9c0c
+SHA512:
+  metadata.gz: e75f1c53b9a3fe08571672fddf4f029aa30d8e65ca8e13d6bea765ce739d83f0700e3d8ff0853d45ab935b4b3ae39b41f3ddc0b94e97f6cec401f4d912263bda
+  data.tar.gz: 5b823b0850cf33fc3022d2a427ddbad3c913115c4ccff6dcf79edd470cc419a561b09f651071e095207966acbb3c68899817dd4f545512f799d8155e2d299795

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stanislav (Stas) Katkov
+
+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,64 @@
+# Jekyll-heroicons
+
+Jekyll liquid tags for the beautiful hand-crafted SVG icons, Heroicons.
+
+This gem has no official affiliation with Tailwind CSS or the Heroicons team. Check out their sites:
+
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Tailwind UI](https://tailwindui.com/)
+- [Heroicons](https://heroicons.com/)
+
+This is heavily inspired by https://github.com/jclusso/heroicons
+
+## Installation
+
+1. Add this to `Gemfile`:
+
+  ```ruby
+  gem 'jekyll-heroicons'
+  ```
+2. Add this to your jekyll `_config.yml`:
+
+  ```yaml
+  plugins:
+    - jekyll-heroicons
+  ```
+
+## Usage
+Configure default settings in `_config.yml`:
+
+```ruby
+heroicons:
+  variant: 'solid'
+```
+
+And then you can use:
+
+```liquid
+{% heroicon alert class:"right left" %}
+```
+
+Another way to provide variant would be like so:
+```liquid
+{% heroicon solid/alert class:"right left"%}
+# or
+{% heroicon alert variant: "solid" class:"right left"%}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-heroicons. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-heroicons/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::Heroicons project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-heroicons/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/jekyll-heroicons/version.rb

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

data/lib/jekyll-heroicons.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative 'jekyll-heroicons/version'
+require 'liquid'
+require 'jekyll/liquid_extensions'
+
+module Jekyll
+  class Heroicons < Liquid::Tag
+    include Jekyll::LiquidExtensions
+
+    # Syntax for the heroicon symbol
+    Syntax = /\A(#{Liquid::VariableSignature}+)/
+
+    # For interpolation, look for liquid variables
+    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
+
+    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)
+    end
+
+    def render(context)
+      prepare(interpolate(@markup, context)) if @markup.match(Variable)
+
+      return nil if @symbol.nil?
+
+      File.read(File.expand_path("../icons/#{@variant}/#{@symbol}.svg", __dir__))
+    end
+
+    private
+
+    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
+    end
+
+    def interpolate(markup, context)
+      markup.scan Variable do |variable|
+        markup = markup.gsub(Variable, lookup_variable(context, variable.first))
+      end
+      markup
+    end
+
+    # Create a ruby hash from a string passed by the jekyll tag
+    def string_to_hash(markup)
+      options = {}
+
+      if markup.match(Syntax)
+        markup.scan(TagAttributes) do |key, value|
+          options[key.to_sym] = value.gsub(/\A"|"\z/, '')
+        end
+      end
+
+      options
+    end
+
+    def symbol(markup)
+      if (match = markup.split('/')).length > 1
+        match[1].match(Syntax)
+      else
+        markup.match(Syntax)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('heroicon', Jekyll::Heroicons)

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-heroicons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislav (Stas) Katkov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll-heroicons.rb
+- lib/jekyll-heroicons/version.rb
+homepage: https://github.com/skatkov/jekyll-heroicons
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skatkov/jekyll-heroicons
+  source_code_uri: https://github.com/skatkov/jekyll-heroicons
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Jekyll liquid tags for Heroicons.
+test_files: []