Parent

Files

Class/Module Index [+]

Quicksearch

Jekyll::Tags::IncludeTag

Public Class Methods

new(tag_name, markup, tokens) click to toggle source
# File lib/jekyll/tags/include.rb, line 22
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(' ', 2);
  end
  validate_params if @params
end

Public Instance Methods

file_read_opts(context) click to toggle source

Grab file read opts in the context

# File lib/jekyll/tags/include.rb, line 86
def file_read_opts(context)
  context.registers[:site].file_read_opts
end
parse_params(context) click to toggle source
# File lib/jekyll/tags/include.rb, line 34
def parse_params(context)
  params = {}
  markup = @params

  while match = VALID_SYNTAX.match(markup) do
    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
path_relative_to_source(dir, path) click to toggle source
# File lib/jekyll/tags/include.rb, line 127
def path_relative_to_source(dir, path)
  File.join(INCLUDES_DIR, path.sub(Regexp.new("^#{dir}"), ""))
end
realpath_prefixed_with?(path, dir) click to toggle source
# File lib/jekyll/tags/include.rb, line 131
def realpath_prefixed_with?(path, dir)
  File.exist?(path) && File.realpath(path).start_with?(dir)
end
render(context) click to toggle source
# File lib/jekyll/tags/include.rb, line 98
def render(context)
  dir = File.join(File.realpath(context.registers[:site].source), INCLUDES_DIR)

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

  path = File.join(dir, file)
  validate_path(path, dir, context.registers[:site].safe)

  begin
    partial = Liquid::Template.parse(source(path, context))

    context.stack do
      context['include'] = parse_params(context) if @params
      partial.render!(context)
    end
  rescue => e
    raise IncludeTagError.new e.message, File.join(INCLUDES_DIR, @file)
  end
end
render_variable(context) click to toggle source

Render the variable if required

# File lib/jekyll/tags/include.rb, line 91
def render_variable(context)
  if @file.match(VARIABLE_SYNTAX)
    partial = Liquid::Template.parse(@file)
    partial.render!(context)
  end
end
source(file, context) click to toggle source

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

# File lib/jekyll/tags/include.rb, line 136
def source(file, context)
  File.read(file, file_read_opts(context))
end
validate_file_name(file) click to toggle source
# File lib/jekyll/tags/include.rb, line 54
def validate_file_name(file)
  if file !~ /^[a-zA-Z0-9_\/\.-]+$/ || file =~ /\.\// || file =~ /\/\./
      raise ArgumentError.new Invalid syntax for include tag. File contains invalid characters or sequences:  #{file}Valid syntax:  #{SYNTAX_EXAMPLE}
  end
end
validate_params() click to toggle source
# File lib/jekyll/tags/include.rb, line 69
def validate_params
  full_valid_syntax = Regexp.compile('\A\s*(?:' + VALID_SYNTAX.to_s + '(?=\s|\z)\s*)*\z')
  unless @params =~ full_valid_syntax
    raise ArgumentError.new Invalid syntax for include tag:  #{@params}Valid syntax:  #{SYNTAX_EXAMPLE}
  end
end
validate_path(path, dir, safe) click to toggle source
# File lib/jekyll/tags/include.rb, line 119
def validate_path(path, dir, safe)
  if safe && !realpath_prefixed_with?(path, dir)
    raise IOError.new "The included file '#{path}' should exist and should not be a symlink"
  elsif !File.exist?(path)
    raise IOError.new "Included file '#{path_relative_to_source(dir, path)}' not found"
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.