class Jekyll::Tags::IncludeTag

Constants

FULL_VALID_SYNTAX
INVALID_SEQUENCES
VALID_FILENAME_CHARS
VALID_SYNTAX
VARIABLE_SYNTAX

Public Class Methods

new(tag_name, markup, tokens) click to toggle source
Calls superclass method
# File lib/ngage/jekyll/tags/include.rb, line 19
def initialize(tag_name, markup, tokens)
  super
  matched = markup.strip.match(VARIABLE_SYNTAX)
  if matched
    @file = matched["variable"].strip
    @params = matched["params"].strip
  else
    @file, @params = markup.strip.split(%r!\s+!, 2)
  end
  validate_params if @params
  @tag_name = tag_name
end

Public Instance Methods

add_include_to_dependency(site, path, context) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 140
def add_include_to_dependency(site, path, context)
  if context.registers[:page]&.key?("path")
    site.regenerator.add_dependency(
      site.in_source_dir(context.registers[:page]["path"]),
      path
    )
  end
end
file_read_opts(context) click to toggle source

Grab file read opts in the context

# File lib/ngage/jekyll/tags/include.rb, line 87
def file_read_opts(context)
  context.registers[:site].file_read_opts
end
load_cached_partial(path, context) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 149
def load_cached_partial(path, context)
  context.registers[:cached_partials] ||= {}
  cached_partial = context.registers[:cached_partials]

  if cached_partial.key?(path)
    cached_partial[path]
  else
    unparsed_file = context.registers[:site]
      .liquid_renderer
      .file(path)
    begin
      cached_partial[path] = unparsed_file.parse(read_file(path, context))
    rescue Liquid::Error => e
      e.template_name = path
      e.markup_context = "included " if e.markup_context.nil?
      raise e
    end
  end
end
locate_include_file(context, file, safe) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 106
def locate_include_file(context, file, safe)
  includes_dirs = tag_includes_dirs(context)
  includes_dirs.each do |dir|
    path = File.join(dir.to_s, file.to_s)
    return path if valid_include_file?(path, dir.to_s, safe)
  end
  raise IOError, could_not_locate_message(file, includes_dirs, safe)
end
outside_site_source?(path, dir, safe) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 173
def outside_site_source?(path, dir, safe)
  safe && !realpath_prefixed_with?(path, dir)
end
parse_params(context) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 36
def parse_params(context)
  params = {}
  markup = @params

  while (match = VALID_SYNTAX.match(markup))
    markup = markup[match.end(0)..-1]

    value = if match[2]
              match[2].gsub('\\"', '"')
            elsif match[3]
              match[3].gsub("\\'", "'")
            elsif match[4]
              context[match[4]]
            end

    params[match[1]] = value
  end
  params
end
read_file(file, context) click to toggle source

This method allows to modify the file content by inheriting from the class.

# File lib/ngage/jekyll/tags/include.rb, line 184
def read_file(file, context)
  File.read(file, file_read_opts(context))
end
realpath_prefixed_with?(path, dir) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 177
def realpath_prefixed_with?(path, dir)
  File.exist?(path) && File.realpath(path).start_with?(dir)
rescue StandardError
  false
end
render(context) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 115
def render(context)
  site = context.registers[:site]

  file = render_variable(context) || @file
  validate_file_name(file)

  path = locate_include_file(context, file, site.safe)
  return unless path

  add_include_to_dependency(site, path, context)

  partial = load_cached_partial(path, context)

  context.stack do
    context["include"] = parse_params(context) if @params
    begin
      partial.render!(context)
    rescue Liquid::Error => e
      e.template_name = path
      e.markup_context = "included " if e.markup_context.nil?
      raise e
    end
  end
end
render_variable(context) click to toggle source

Render the variable if required

# File lib/ngage/jekyll/tags/include.rb, line 92
def render_variable(context)
  if @file =~ VARIABLE_SYNTAX
    partial = context.registers[:site]
      .liquid_renderer
      .file("(variable)")
      .parse(@file)
    partial.render!(context)
  end
end
syntax_example() click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 32
def syntax_example
  "{% #{@tag_name} file.ext param='value' param2='value' %}"
end
tag_includes_dirs(context) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 102
def tag_includes_dirs(context)
  context.registers[:site].includes_load_paths.freeze
end
valid_include_file?(path, dir, safe) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 169
def valid_include_file?(path, dir, safe)
  !outside_site_source?(path, dir, safe) && File.file?(path)
end
validate_file_name(file) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 56
      def validate_file_name(file)
        if file =~ INVALID_SEQUENCES || file !~ VALID_FILENAME_CHARS
          raise ArgumentError, <<~MSG
            Invalid syntax for include tag. File contains invalid characters or sequences:

              #{file}

            Valid syntax:

              #{syntax_example}

          MSG
        end
      end
validate_params() click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 71
      def validate_params
        unless @params =~ FULL_VALID_SYNTAX
          raise ArgumentError, <<~MSG
            Invalid syntax for include tag:

            #{@params}

            Valid syntax:

            #{syntax_example}

          MSG
        end
      end

Private Instance Methods

could_not_locate_message(file, includes_dirs, safe) click to toggle source
# File lib/ngage/jekyll/tags/include.rb, line 190
def could_not_locate_message(file, includes_dirs, safe)
  message = "Could not locate the included file '#{file}' in any of "\
    "#{includes_dirs}. Ensure it exists in one of those directories and"
  message + if safe
              " is not a symlink as those are not allowed in safe mode."
            else
              ", if it is a symlink, does not point outside your site source."
            end
end