class Jekyll::Tags::IncludeTag
Constants
- INCLUDES_DIR
- SYNTAX_EXAMPLE
- VALID_SYNTAX
Public Class Methods
new(tag_name, markup, tokens)
click to toggle source
Calls superclass method
# File lib/jekyll/tags/include.rb, line 20 def initialize(tag_name, markup, tokens) super @file, @params = markup.strip.split(' ', 2); validate_params if @params end
Public Instance Methods
blank?()
click to toggle source
# File lib/jekyll/tags/include.rb, line 123 def blank? false end
file_read_opts(context)
click to toggle source
Grab file read opts in the context
# File lib/jekyll/tags/include.rb, line 78 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 26 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
render(context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 89 def render(context) dir = File.join(context.registers[:site].source, INCLUDES_DIR) validate_dir(dir, context.registers[:site].safe) retrieve_variable(context) validate_file_name file = File.join(dir, @file) validate_file(file, context.registers[:site].safe) partial = Liquid::Template.parse(source(file, 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
retrieve_variable(context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 82 def retrieve_variable(context) if /\{\{([\w\-\.]+)\}\}/ =~ @file raise ArgumentError.new("No variable #{$1} was found in include tag") if context[$1].nil? @file = context[$1] 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 128 def source(file, context) File.read_with_options(file, file_read_opts(context)) end
validate_dir(dir, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 109 def validate_dir(dir, safe) if File.symlink?(dir) && safe raise IOError.new "Includes directory '#{dir}' cannot be a symlink" end end
validate_file(file, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 115 def validate_file(file, safe) if !File.exists?(file) raise IOError.new "Included file '#{@file}' not found in '#{INCLUDES_DIR}' directory" elsif File.symlink?(file) && safe raise IOError.new "The included file '#{INCLUDES_DIR}/#{@file}' should not be a symlink" end end
validate_file_name()
click to toggle source
# File lib/jekyll/tags/include.rb, line 46 def validate_file_name if @file !~ /^[a-zA-Z0-9_\/\.-]+$/ || @file =~ /\.\// || @file =~ /\/\./ raise ArgumentError.new <<-eos Invalid syntax for include tag. File contains invalid characters or sequences: #{@file} Valid syntax: #{SYNTAX_EXAMPLE} eos end end
validate_params()
click to toggle source
# File lib/jekyll/tags/include.rb, line 61 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 <<-eos Invalid syntax for include tag: #{@params} Valid syntax: #{SYNTAX_EXAMPLE} eos end end