jekyll_emoji_tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fcbd2d4d07f48b73b88309e826023eca537c472e7d2b9924a02d72e41fb9aa3
+  data.tar.gz: fb1b823f3f23fdbefe64ada67e22bfb0d75cfe23be4b40835e67f3c5e9a368f3
+SHA512:
+  metadata.gz: 2054b06c3c37341f6609788c7611cb1c45fd87f57c625a722190660134a14529e949ebef091a3f5680e66913758b66a84c897da7130790b520953d2a157b984b
+  data.tar.gz: 0c29401d2878048954c58117c63ac041d3b356e50c40b46aaa7e4a248673ef5681f4add7b36cf128d6250f39bfe00285d48c5af0e0a3dfea18e546d8f6af51a7

data/.rubocop.yml

@@ -0,0 +1,71 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 3.1.3
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_emoji_tag.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  * Initial release.

data/README.md

@@ -0,0 +1,96 @@
+`jekyll_emoji_tag`
+[![Gem Version](https://badge.fury.io/rb/jekyll_emoji_tag.svg)](https://badge.fury.io/rb/jekyll_emoji_tag)
+===========
+
+Inserts the specified emoji into the document.
+You can specify the size and alignment of the emoji.
+If you specify an emoji name that does not exist, the `undefined` emoji is shown.
+
+
+## Installation
+
+Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_emoji_tag'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Syntax
+
+```text
+{% emoji OPTIONS %}
+```
+`OPTIONS` are:
+
+ - `align` - `left`, `right` or `inline` (default is inline)
+ - `emoji_and_name` - causes the name of the emoji to be output along with the image (default is false)
+ - `list` - output all emojis (default is false)
+ - `name` - name of emoji (defaults to smiley)
+ - `size` - height of emoji (defaults to 3em)
+
+`list` and `name` are mutually exclusive; only specify one of them.
+
+If neither `list` nor `name` is specified, the `smiley` emoji is output.
+
+The names of all supported emojis are:
+
+```
+angry
+boom
+grin
+horns
+kiss
+open
+poop
+sad
+scream
+smiley
+smirk
+two_hearts
+```
+
+## Example Usage
+
+```text
+{% emoji name='boom' %}
+{% emoji align='right' name='grin' %}
+{% emoji name='sad' size='12pt' %}
+{% emoji align='right' name='horns' size='12pt' %}
+{% emoji emoji_and_name name='poop' %}
+{% emoji align='right' emoji_and_name name='scream' %}
+{% emoji list %}
+{% emoji list size='1em' %}
+```
+
+See the [demo](demo/index.html) for more examples.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec 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, run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags,
+and push the `.gem` file to https://rubygems.org.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on #<struct Creategem::Repository::Host domain="github.com", camel_case="GitHub", id=:github> at https://github.com/mslinn/jekyll_emoji_tag.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'jekyll_emoji_tag/version.rb'
+  system "gem push pkg/jekyll_emoji_tag-#{JekyllEmojiTag::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/jekyll_emoji_tag.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/jekyll_emoji_tag/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_emoji_tag'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Inserts an emoji
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://github.com/mslinn/jekyll_emoji_tag'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'jekyll_emoji_tag'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.summary               = 'Inserts an emoji'
+  spec.version               = JekyllEmojiTag::VERSION
+
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+end

data/lib/emoji.rb

@@ -0,0 +1,114 @@
+require 'jekyll_plugin_support'
+require_relative 'jekyll_emoji_tag/version.rb'
+
+# This Jekyll tag plugin creates an emoji of the desired size and alignment.
+#
+# @example Float Smiley emoji right, sized 3em
+#     {% tag_template name='smile' align='right' size='5em' %}
+#   The above results in the following HTML:
+#     <span style="float: right; font-size: 5em;">&#x1F601;</span>
+#
+# @example Defaults
+#     {% tag_template name='smile' %}
+#   The above results in the following HTML:
+#     <span style="font-size: 3em;">&#x1F601;</span>
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entery into _config.yml, like this:
+# plugin_loggers:
+#   MyTag: debug
+module JekyllEmojiTag
+  # This class implements the Jekyll emoji functionality
+  class Emoji < JekyllSupport::JekyllTag
+    PLUGIN_NAME = 'emoji'.freeze
+    VERSION = JekyllEmojiTag::VERSION
+
+    # Supported emojis (GitHub symbol, hex code) - see https://gist.github.com/rxaviers/7360908 and
+    # https://www.quackit.com/character_sets/emoji/emoji_v3.0/unicode_emoji_v3.0_characters_all.cfm
+    @@emojis = {
+      'angry'      => '&#x1F620;',
+      'boom'       => '&#x1F4A5;', # used when requested emoji is not recognized
+      'grin'       => '&#128512;',
+      'horns'      => '&#128520;',
+      'kiss'       => '&#x1F619;',
+      'open'       => '&#128515;',
+      'poop'       => '&#x1F4A9;',
+      'sad'        => '&#128546;',
+      'scream'     => '&#x1F631;',
+      'smiley'     => '&#x1F601;', # default emoji
+      'smirk'      => '&#x1F60F;',
+      'two_hearts' => '&#x1F495;',
+    }.sort_by { |k, _v| [k] }.to_h
+
+    # @param tag_name [String] is the name of the tag, which we already know.
+    # @param argument_string [String] the arguments from the web page.
+    # @param tokens [Liquid::ParseContext] tokenized command line
+    # @return [void]
+    def render_impl
+      @emoji_name     = @helper.parameter_specified?('name')  || 'smiley' # Ignored if `list` is specified
+      @emoji_align    = @helper.parameter_specified?('align') || 'inline' # Allowable values are: inline, right or left
+      @emoji_size     = @helper.parameter_specified?('size')  || '3em'
+      @emoji_and_name = @helper.parameter_specified?('emoji_and_name')
+      @list           = @helper.parameter_specified?('list')
+      @emoji_hex_code = @@emojis[@emoji_name] if @emoji_name || @@emojis['boom']
+
+      # variables defined in pages are stored as hash values in liquid_context
+      # _assigned_page_variable = @liquid_context['assigned_page_variable']
+
+      @layout_hash = @page['layout']
+
+      @logger.debug do
+        <<~HEREDOC
+          liquid_context.scopes=#{@liquid_context.scopes}
+          mode="#{@mode}"
+          page attributes:
+            #{@page.sort
+                   .reject { |k, _| REJECTED_ATTRIBUTES.include? k }
+                   .map { |k, v| "#{k}=#{v}" }
+                   .join("\n  ")}
+        HEREDOC
+      end
+
+      # Return the value of this Jekyll tag
+      if @list
+        list
+      else
+        assemble_emoji(@emoji_name, @emoji_hex_code)
+      end
+    end
+
+    private
+
+    def assemble_emoji(emoji_name, emoji_hex_code)
+      case @emoji_align
+      when 'inline'
+        align = ''
+      when 'right'
+        align = ' float: right; margin-left: 5px;'
+      when 'left'
+        align = ' float: left; margin-right: 5px;'
+      else
+        @logger.error { "Invalid emoji alignment #{@emoji_align}" }
+        align = ''
+      end
+
+      name = " <code>#{emoji_name}</code>" if @emoji_and_name
+
+      "<span style='font-size: #{@emoji_size};#{align}'>#{emoji_hex_code}</span>#{name}"
+    end
+
+    def list
+      items = @@emojis.map do |ename, hex_code|
+        "  <li>#{assemble_emoji(ename, hex_code)}</li>"
+      end
+      <<~END_RESULT
+        <ul class='emoji_list'>
+          #{items.join("\n  ")}
+        </ul>
+      END_RESULT
+    end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/lib/jekyll_emoji_tag/version.rb

@@ -0,0 +1,3 @@
+module JekyllEmojiTag
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/jekyll_emoji_tag.rb

@@ -0,0 +1,10 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+
+require_relative 'jekyll_emoji_tag/version'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join(__dir__, '*.rb')].each do |file|
+  require file unless file.end_with?('/jekyll_emoji_tag.rb')
+end

data/spec/jekyll_emoji_tag_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/jekyll_emoji_tag'
+
+RSpec.describe JekyllEmojiTag::JekyllEmojiTag do
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/<%= @gem_name %>'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+
+  config.filter_run_when_matching focus: true
+end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_emoji_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: 'Inserts an emoji
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_emoji_tag.gemspec
+- lib/emoji.rb
+- lib/jekyll_emoji_tag.rb
+- lib/jekyll_emoji_tag/version.rb
+- spec/jekyll_emoji_tag_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mslinn/jekyll_emoji_tag
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_emoji_tag/issues
+  changelog_uri: https://github.com/mslinn/jekyll_emoji_tag/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/jekyll_emoji_tag
+  source_code_uri: https://github.com/mslinn/jekyll_emoji_tag
+post_install_message: |2+
+
+  Thanks for installing jekyll_emoji_tag!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Inserts an emoji
+test_files: []
+...