Contents

# frozen_string_literal: true

require 'jekyll'
require 'jekyll_plugin_logger'
require_relative 'jekyll_plugin_support_helper'
require_relative 'jekyll_plugin_support/version'

# @author Copyright 2022 Michael Slinn
# @license SPDX-License-Identifier: Apache-2.0
module JekyllSupport
  # Base class for Jekyll block tags
  class JekyllBlock < Liquid::Block
    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site, :text

    # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
    # @param tag_name [String] the name of the tag, which we usually know.
    # @param argument_string [String] the arguments passed to the tag, as a single string.
    # @param parse_context [Liquid::ParseContext] hash that stores Liquid options.
    #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
    #        a boolean parameter that determines if error messages should display the line number the error occurred.
    #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
    #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
    # @return [void]
    def initialize(tag_name, argument_string, parse_context)
      super
      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
      @argument_string = argument_string
    end

    # Method prescribed by the Jekyll plugin lifecycle.
    # @return [String]
    def render(context)
      text = super
      render_impl text
    end

    # Jekyll plugins should override this method, not render, so their plugin can be tested more easily
    # @return [String]
    def render_impl(text)
      text
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jekyll_plugin_support-0.1.0	lib/jekyll_plugin_support.rb