jekyll_emoji_tag 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fcbd2d4d07f48b73b88309e826023eca537c472e7d2b9924a02d72e41fb9aa3
-  data.tar.gz: fb1b823f3f23fdbefe64ada67e22bfb0d75cfe23be4b40835e67f3c5e9a368f3
+  metadata.gz: 6eb6b23f31b0027e1c56bd56cb401e238f306b68446f90f5099f6b54865771cc
+  data.tar.gz: 5f7db9dde9f792bce5ab4b254187de9fc4388ba6b28eb8b5bf36189f136cfc4d
 SHA512:
-  metadata.gz: 2054b06c3c37341f6609788c7611cb1c45fd87f57c625a722190660134a14529e949ebef091a3f5680e66913758b66a84c897da7130790b520953d2a157b984b
-  data.tar.gz: 0c29401d2878048954c58117c63ac041d3b356e50c40b46aaa7e4a248673ef5681f4add7b36cf128d6250f39bfe00285d48c5af0e0a3dfea18e546d8f6af51a7
+  metadata.gz: 9f6ea9272747a6e5db45df59756cdaac437c87cf4e3d00a7e3db3aaa868585776439aec0c6620823bc48f038c06ac769f7e72b7867618e0bbdf52e4392fec280
+  data.tar.gz: 60eda292128ef83af1bfa225adbc824a493d31d3f3d5689580d9f690c08db67e81e92a576f696bdd282fd40378c551ce2e817f905c55ca46775fde3a481c0a94

data/.rubocop.yml

@@ -8,11 +8,10 @@ require:
 AllCops:
   Exclude:
     - binstub/**/*
-    - exe/**/*
+    - binstub/**/*
     - vendor/**/*
     - Gemfile*
   NewCops: enable
-  TargetRubyVersion: 3.1.3
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
@@ -20,6 +19,9 @@ Gemspec/DeprecatedAttributeAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table

data/CHANGELOG.md

@@ -1,2 +1,10 @@
+# Change Log
+
+## 0.1.1 / 2024-01-23
+
+* Added the `class`, `div` and `style` optional parameters.
+
+
 ## 0.1.0
-  * Initial release.
+
+* Initial release.

data/README.md

@@ -1,6 +1,4 @@
-`jekyll_emoji_tag`
-[![Gem Version](https://badge.fury.io/rb/jekyll_emoji_tag.svg)](https://badge.fury.io/rb/jekyll_emoji_tag)
-===========
+# `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.
@@ -18,6 +16,7 @@ end
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
@@ -28,13 +27,17 @@ $ bundle
 ```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)
+- `align` - `left`, `right` or `inline` (default is inline)
+- `class` - CSS style to add to the generated emoji
+- `div`   - Wrap the emoji in a <div> instead of a <span>
+- `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)
+- `style` - Additional CSS styles for the generated emoji
 
 `list` and `name` are mutually exclusive; only specify one of them.
 
@@ -42,7 +45,7 @@ If neither `list` nor `name` is specified, the `smiley` emoji is output.
 
 The names of all supported emojis are:
 
-```
+```text
 angry
 boom
 grin
@@ -88,7 +91,7 @@ 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.
+Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_emoji_tag.
 
 
 ## License

data/lib/emoji.rb

@@ -1,5 +1,5 @@
 require 'jekyll_plugin_support'
-require_relative 'jekyll_emoji_tag/version.rb'
+require_relative 'jekyll_emoji_tag/version'
 
 # This Jekyll tag plugin creates an emoji of the desired size and alignment.
 #
@@ -24,9 +24,13 @@ module JekyllEmojiTag
     PLUGIN_NAME = 'emoji'.freeze
     VERSION = JekyllEmojiTag::VERSION
 
+    class << self
+      attr_accessor :emojis
+    end
+
     # 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 = {
+    Emoji.emojis = {
       'angry'      => '&#x1F620;',
       'boom'       => '&#x1F4A5;', # used when requested emoji is not recognized
       'grin'       => '&#128512;',
@@ -46,12 +50,15 @@ module JekyllEmojiTag
     # @param tokens [Liquid::ParseContext] tokenized command line
     # @return [void]
     def render_impl
+      @klass          = @helper.parameter_specified? 'class'
+      @tag            = @helper.parameter_specified?('div') ? 'div' : 'span'
+      @style          = @helper.parameter_specified? 'style'
       @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']
+      @emoji_and_name = @helper.parameter_specified? 'emoji_and_name'
+      @list           = @helper.parameter_specified? 'list'
+      @emoji_hex_code = Emoji.emojis[@emoji_name] if @emoji_name || Emoji.emojis['boom']
 
       # variables defined in pages are stored as hash values in liquid_context
       # _assigned_page_variable = @liquid_context['assigned_page_variable']
@@ -64,7 +71,7 @@ module JekyllEmojiTag
           mode="#{@mode}"
           page attributes:
             #{@page.sort
-                   .reject { |k, _| REJECTED_ATTRIBUTES.include? k }
+                   .except(*REJECTED_ATTRIBUTES)
                    .map { |k, v| "#{k}=#{v}" }
                    .join("\n  ")}
         HEREDOC
@@ -81,25 +88,26 @@ module JekyllEmojiTag
     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
+      align = case @emoji_align
+              when 'inline'
+                ''
+              when 'right'
+                ' float: right; margin-left: 5px;'
+              when 'left'
+                ' float: left; margin-right: 5px;'
+              else
+                @logger.error { "Invalid emoji alignment #{@emoji_align}" }
+                ''
+              end
 
       name = " <code>#{emoji_name}</code>" if @emoji_and_name
+      klass = @klass ? " class='#{@klass}'" : ''
 
-      "<span style='font-size: #{@emoji_size};#{align}'>#{emoji_hex_code}</span>#{name}"
+      "<#{@tag}#{klass} style='font-size: #{@emoji_size};#{align};#{@style}'>#{emoji_hex_code}</#{@tag}>#{name}"
     end
 
     def list
-      items = @@emojis.map do |ename, hex_code|
+      items = Emoji.emojis.map do |ename, hex_code|
         "  <li>#{assemble_emoji(ename, hex_code)}</li>"
       end
       <<~END_RESULT

data/lib/jekyll_emoji_tag/version.rb

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

data/lib/jekyll_emoji_tag.rb

@@ -6,5 +6,7 @@ require_relative 'jekyll_emoji_tag/version'
 
 # Require all Ruby files in 'lib/', except this file
 Dir[File.join(__dir__, '*.rb')].each do |file|
+  # puts "About to require #{file}"
   require file unless file.end_with?('/jekyll_emoji_tag.rb')
+  # puts "Required #{file}"
 end

data/spec/jekyll_emoji_tag/emoji_spec.rb

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

data/spec/spec_helper.rb

@@ -3,12 +3,10 @@ require 'jekyll_plugin_logger'
 require 'liquid'
 require 'fileutils'
 require 'yaml'
-require_relative '../lib/<%= @gem_name %>'
+require_relative '../lib/jekyll_emoji_tag'
 
 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'
@@ -30,7 +28,7 @@ class SiteMock
   attr_reader :config
 
   def initialize
-    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config = YAML.safe_load_file('../demo/_config.yml')
     @config['env'] = { 'JEKYLL_ENV' => 'development' }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_emoji_tag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -55,7 +55,7 @@ files:
 - lib/emoji.rb
 - lib/jekyll_emoji_tag.rb
 - lib/jekyll_emoji_tag/version.rb
-- spec/jekyll_emoji_tag_spec.rb
+- spec/jekyll_emoji_tag/emoji_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mslinn/jekyll_emoji_tag
 licenses:
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Inserts an emoji

data/spec/jekyll_emoji_tag_spec.rb

@@ -1,13 +0,0 @@
-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