Class: Jekyll::Tags::IncludeAbsoluteTag
- Inherits:
-
Liquid::Tag
- Object
- Liquid::Tag
- Jekyll::Tags::IncludeAbsoluteTag
- Defined in:
- flexible_include.rb
Constant Summary collapse
- VALID_SYNTAX =
%r! ([\w-]+)\s*=\s* (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+)) !x
- VARIABLE_SYNTAX =
%r! (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+) (?<params>.*) !mx
- FULL_VALID_SYNTAX =
%r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
- VALID_FILENAME_CHARS =
%r!^[\w/\.-]+$!
Instance Method Summary collapse
-
#expand_env(str) ⇒ Object
-
#file_read_opts(context) ⇒ Object
Grab file read opts in the context.
-
#initialize(tag_name, markup, tokens) ⇒ IncludeAbsoluteTag
constructor
A new instance of IncludeAbsoluteTag.
-
#outside_site_source?(path, dir, safe) ⇒ Boolean
-
#parse_params(context) ⇒ Object
-
#read_file(file, context) ⇒ Object
This method allows to modify the file content by inheriting from the class.
-
#realpath_prefixed_with?(path, dir) ⇒ Boolean
-
#render(context) ⇒ Object
-
#render_variable(context) ⇒ Object
Render the variable if required.
-
#syntax_example ⇒ Object
-
#valid_include_file?(path, dir, safe) ⇒ Boolean
-
#validate_file_name(file) ⇒ Object
TODO allow filenames relative to home directory.
-
#validate_params ⇒ Object
Constructor Details
#initialize(tag_name, markup, tokens) ⇒ IncludeAbsoluteTag
Returns a new instance of IncludeAbsoluteTag.
34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'flexible_include.rb', line 34 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 |
Instance Method Details
#expand_env(str) ⇒ Object
117 118 119 120 |
# File 'flexible_include.rb', line 117 def (str) # Expands environment variable references in str str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) { ENV[$1] } end |
#file_read_opts(context) ⇒ Object
Grab file read opts in the context
102 103 104 |
# File 'flexible_include.rb', line 102 def file_read_opts(context) context.registers[:site].file_read_opts end |
#outside_site_source?(path, dir, safe) ⇒ Boolean
181 182 183 |
# File 'flexible_include.rb', line 181 def outside_site_source?(path, dir, safe) safe && !realpath_prefixed_with?(path, dir) end |
#parse_params(context) ⇒ Object
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'flexible_include.rb', line 51 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(%r!\\"!, '"') elsif match[3] match[3].gsub(%r!\\'!, "'") elsif match[4] context[match[4]] end params[match[1]] = value end params end |
#read_file(file, context) ⇒ Object
This method allows to modify the file content by inheriting from the class.
192 193 194 |
# File 'flexible_include.rb', line 192 def read_file(file, context) File.read(file, **file_read_opts(context)) end |
#realpath_prefixed_with?(path, dir) ⇒ Boolean
185 186 187 188 189 |
# File 'flexible_include.rb', line 185 def realpath_prefixed_with?(path, dir) File.exist?(path) && File.realpath(path).start_with?(dir) rescue StandardError false end |
#render(context) ⇒ Object
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'flexible_include.rb', line 122 def render(context) site = context.registers[:site] file = render_variable(context) || @file file = file.gsub(/\A'|'\Z/, '') # Strip leading and trailing quotes file = (file) # Expand environment variable references #validate_file_name(file) # TODO uncomment and fix validate_file_name path = file if /^\//.match(file) # Is the file absolute? #puts "********** render path=#{path}, file=#{file} *************" elsif /~/.match(file) # Is the file relative to user's home directory? #puts "********** render original file=#{file}, path=#{path} *************" file.slice! "~/" path = File.join(ENV['HOME'], file) #puts "********** render path=#{path}, file=#{file} *************" elsif /\!/.match(file) # Is the file on the PATH? #puts "********** render original file=#{file}, path=#{path} *************" file.slice! "!" path = File.which(file) #puts "********** render path=#{path}, file=#{file} *************" else # The file is relative source = File.(context.registers[:site].config['source']).freeze # website root directory path = File.join(source, file) # Fully qualified path of include file #puts "********** render file=#{file}, path=#{path}, source=#{source} *************" end return unless path context.stack do do_not_escape = false if @params context["include"] = parse_params(context) # puts "context['include']['do_not_escape'] = #{context['include']['do_not_escape']}" do_not_escape = context['include'].fetch('do_not_escape', 'false') # puts "do_not_escape=#{do_not_escape}" # puts "do_not_escape=='false' = #{do_not_escape=='false'}" end begin contents = read_file(path, context) escaped_contents = do_not_escape=='false' ? contents.gsub("{", "{").gsub("}", "}").gsub("<", "<") : contents partial = Liquid::Template.parse(escaped_contents) rescue StandardError => e abort "flexible_include.rb: #{e.}" end 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) ⇒ Object
Render the variable if required
107 108 109 110 111 112 113 114 115 |
# File 'flexible_include.rb', line 107 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 ⇒ Object
47 48 49 |
# File 'flexible_include.rb', line 47 def syntax_example "{% #{@tag_name} 'file.ext' do_not_escape='true' %}" end |
#valid_include_file?(path, dir, safe) ⇒ Boolean
177 178 179 |
# File 'flexible_include.rb', line 177 def valid_include_file?(path, dir, safe) !outside_site_source?(path, dir, safe) && File.file?(path) end |
#validate_file_name(file) ⇒ Object
TODO allow filenames relative to home directory
71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'flexible_include.rb', line 71 def validate_file_name(file) # TODO allow filenames relative to home directory if file !~ VALID_FILENAME_CHARS raise ArgumentError, <<-MSG Invalid syntax for the flexible_ include tag. The included file contains invalid characters or sequences: #{file} Valid syntax: #{syntax_example} MSG end end |
#validate_params ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'flexible_include.rb', line 86 def validate_params unless @params =~ FULL_VALID_SYNTAX raise ArgumentError, <<-MSG Invalid syntax for the flexible_include tag: #{@params} Valid syntax: #{syntax_example} MSG end end |