class Liquid::Tags::Include
Constants
- SYNTAX_EXAMPLE
- VALID_SYNTAX
- VARIABLE_SYNTAX
Public Class Methods
new(tag_name, markup, tokens)
click to toggle source
Calls superclass method
# File lib/liquid/tags/lr_include.rb, line 27 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
includes_dir()
click to toggle source
# File lib/liquid/tags/lr_include.rb, line 23 def includes_dir File.join(File.realpath(Limitedrun::Themekit::Config.theme_path), Limitedrun::Themekit::Config.snippets_dir) end
parse_params(context)
click to toggle source
# File lib/liquid/tags/lr_include.rb, line 39 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/liquid/tags/lr_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/liquid/tags/lr_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/liquid/tags/lr_include.rb, line 98 def render(context) dir = includes_dir file = render_variable(context) || @file validate_file_name(file) path = File.join(dir, file[1...-1]) validate_path(path, dir, true) 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/liquid/tags/lr_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/liquid/tags/lr_include.rb, line 136 def source(file, context) File.read(file) end
validate_file_name(file)
click to toggle source
# File lib/liquid/tags/lr_include.rb, line 59 def validate_file_name(file) 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/liquid/tags/lr_include.rb, line 74 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
validate_path(path, dir, safe)
click to toggle source
# File lib/liquid/tags/lr_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