jekyll_todo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e30a9fe9e16fbadf014b44dd753d3e316a9a37144428fe0b84078869ca99ca3
+  data.tar.gz: '019eeae995cff67e6b3325a06febc188535c1eddaa0dc4d4a6d55c689f4e2f2b'
+SHA512:
+  metadata.gz: 627ed50f1bd935f268c3eab173df0ece8ce98726fd1cc721c6c6b0fb390817568a6f2f6fa2aa98b3571a26d26705f111c18205769731527cba2a9f6a1dac6eb2
+  data.tar.gz: a28bcdb4bbb27b84a9de6739a0f178b1b08bd9c51d95a76528eaef237e6c787f509b910f034a076a09bc8c092f9ad1714736856d99751891c6b69bbf4e7f9ef9

data/.rubocop.yml

@@ -0,0 +1,69 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+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_todo.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/SpecFilePathFormat:
+  IgnoreMethods: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0 / 2025-07-16
+
+* Initial release.

data/README.md

@@ -0,0 +1,109 @@
+# `Jekyll_todo` [![Gem Version](https://badge.fury.io/rb/jekyll_todo.svg)](https://badge.fury.io/rb/jekyll_todo)
+
+Generates a TODO block.
+
+## Options
+
+* `alert` - Apply the `alert` class to the generated HTML wrapper
+* `block` - Apply `display: block` to the generated HTML wrapper
+* `class` - Apply the given class to the generated HTML wrapper
+* `id` - Apply the given HTML id attribute to the generated HTML wrapper
+* `span` - Apply `display: inline` to the generated HTML wrapper
+* `style` - Apply the given CSS style to the generated HTML wrapper
+
+
+## Examples
+
+```html
+{% todo %}
+  blah blah blah
+{% endtodo %}
+```
+
+Example:
+
+```html
+{% todo id='todo1' %}
+  blah blah blah
+{% endtodo %}
+```
+
+See `demo/index.html` for more examples.
+
+
+## Installation
+
+Add the following to your Jekyll website's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_todo'
+end
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+
+## Usage
+
+Describe how to use this gem
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_todo.
+
+
+## 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,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_todo/version.rb'
+  system "gem push pkg/jekyll_todo-#{JekyllToDo::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_todo.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/jekyll_todo/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_todo'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Generate a TODO block.
+  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_todo'
+  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_todo'
+  spec.platform             = Gem::Platform::RUBY
+  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               = 'Generate a TODO block'
+  spec.version               = JekyllToDo::VERSION
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_draft'
+  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.3'
+end

data/lib/jekyll_todo/version.rb

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

data/lib/jekyll_todo.rb

@@ -0,0 +1,10 @@
+def require_directory(dir)
+  Dir[File.join(dir, '*.rb')]&.sort&.each do |file|
+    require file unless file == __FILE__
+  end
+end
+
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+require_directory __dir__

data/lib/jekyll_todo_module.rb

@@ -0,0 +1,6 @@
+# See https://mslinn.com/jekyll/10700-designing-for-testability.html
+module JekyllToDoModule
+  def a_method
+    "a_method says #{msg}"
+  end
+end

data/lib/todo.rb

@@ -0,0 +1,98 @@
+require 'jekyll_plugin_support'
+require 'helper/jekyll_plugin_helper'
+require_relative 'jekyll_todo/version'
+
+# Generate a TODO block
+# Options:
+#   `id`
+#
+# @example
+#   {% todo %}
+#     blah blah blah
+#   {% endtodo %}
+#
+# @example
+#   {% todo id='todo1' %}
+#     blah blah blah
+#   {% endtodo %}
+#
+# 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:
+#   Todo: debug
+
+module JekyllToDo
+  # This class implements the Jekyll  functionality
+  class ToDo < JekyllSupport::JekyllBlock
+    # Defines class methods, see https://mslinn.com/jekyll/10700-designing-for-testability.html:
+    extend JekyllToDoModule
+
+    PLUGIN_NAME = 'todo'.freeze
+    VERSION = JekyllToDo::VERSION
+
+    # See https://github.com/mslinn/jekyll_plugin_support#argument-parsing
+    #
+    # The following variables are predefined:
+    #   @argument_string, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site and @theme
+    #   @tag_name [String] is the name of the tag, which we already know.
+    #   @argument_string [String] the arguments from the web page.
+    #   @tokens [Liquid::ParseContext] tokenized command line
+    #
+    # @helper provides these read-only attributes:
+    #   argv, attribution, keys_values, liquid_context, logger, markup, no_arg_parsing, params, tag_name,
+    #   argv_original, excerpt_caller, keys_values_original, params_original
+    # @helper provides these class methods:
+    #   expand_env, register, remove_quotes
+    # @helper provides these instance methods:
+    #   attribution_string
+    #   default_attribution
+    #   delete_parameter
+    #   dereference_include_variable
+    #   dereference_variable
+    #   lookup_variable
+    #   parameter_specified?('option/keyword name') || 'default value' # parse option value/keyword
+    #   gem_file __FILE__ # Enables attribution
+    #   remaining_markup # unparsed markup passed to this plugin
+    #   reinitialize # Returns markup remaining after `parameter_specified?` has been invoked.
+    #   remaining_markup_original
+    #
+    # @return [string] markup to be rendered on web page
+    def render_impl(content)
+      @alert = @helper.parameter_specified? 'alert'
+      @alert_option = ' alert' if @alert
+
+      @block = @helper.parameter_specified? 'block'
+      @block_option = ' display: block;' if @block
+
+      @class = @helper.parameter_specified? 'class'
+      @class_option = " #{@class}"
+
+      @id = @helper.parameter_specified? 'id'
+      @id_option = " id='@id'" if @id
+
+      @span = @helper.parameter_specified? 'span' unless @block
+
+      @style = @helper.parameter_specified? 'style'
+      @style_option = " style='#{@style}#{@block_option}'" if @style || @block_option
+
+      if @span
+        <<~END_MSG
+          <span class="todo#{@alert_option}#{@class_option}"#{@id_option}#{@style_option}>#{content}</span>
+        END_MSG
+      else
+        <<~END_MSG
+          <fieldset class="todo#{@alert_option}#{@class_option} rounded shadow"#{@id_option}#{@style_option}>
+          <legend>TODO</legend>
+            #{content}
+          </fieldset>
+        END_MSG
+      end
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 3
+    end
+
+    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/spec/jekyll_todo/jekyll_to_do_module_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require_relative '../lib/jekyll_todo'
+
+RSpec.describe JekyllToDoModule do
+  extend described_class # Define class methods from JekyllToDoModule
+
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new } # Mock, may not be desired
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/jekyll_todo'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+  config.filter_run_when_matching focus: true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+end
+
+
+# None of the following is required if mocking Jekyll internal data structures is not required
+
+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(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,105 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_todo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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_draft
+  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'
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: 'Generate a TODO block.
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_todo.gemspec
+- lib/jekyll_todo.rb
+- lib/jekyll_todo/version.rb
+- lib/jekyll_todo_module.rb
+- lib/todo.rb
+- spec/jekyll_todo/jekyll_to_do_module_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mslinn/jekyll_todo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_todo/issues
+  changelog_uri: https://github.com/mslinn/jekyll_todo/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/jekyll_todo
+  source_code_uri: https://github.com/mslinn/jekyll_todo
+post_install_message: |2+
+
+  Thanks for installing jekyll_todo!
+
+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.7.0
+specification_version: 4
+summary: Generate a TODO block
+test_files: []
+...