# frozen_string_literal: true require "strscan" require "active_support/core_ext/erb/util" module ActionView class Template module Handlers class ERB autoload :Erubi, "action_view/template/handlers/erb/erubi" # Specify trim mode for the ERB compiler. Defaults to '-'. # See ERB documentation for suitable values. class_attribute :erb_trim_mode, default: "-" # Default implementation used. class_attribute :erb_implementation, default: Erubi # Do not escape templates of these mime types. class_attribute :escape_ignore_list, default: ["text/plain"] # Strip trailing newlines from rendered output class_attribute :strip_trailing_newlines, default: false ENCODING_TAG = Regexp.new("\\A(<%#{ENCODING_FLAG}-?%>)[ \\t]*") LocationParsingError = Class.new(StandardError) # :nodoc: def self.call(template, source) new.call(template, source) end def supports_streaming? true end def handles_encoding? true end # Translate an error location returned by ErrorHighlight to the correct # source location inside the template. def translate_location(spot, backtrace_location, source) # Tokenize the source line tokens = ::ERB::Util.tokenize(source.lines[backtrace_location.lineno - 1]) new_first_column = find_offset(spot[:snippet], tokens, spot[:first_column]) lineno_delta = spot[:first_lineno] - backtrace_location.lineno spot[:first_lineno] -= lineno_delta spot[:last_lineno] -= lineno_delta column_delta = spot[:first_column] - new_first_column spot[:first_column] -= column_delta spot[:last_column] -= column_delta spot[:script_lines] = source.lines spot rescue NotImplementedError, LocationParsingError nil end def call(template, source) # First, convert to BINARY, so in case the encoding is # wrong, we can still find an encoding tag # (<%# encoding %>) inside the String using a regular # expression template_source = source.b erb = template_source.gsub(ENCODING_TAG, "") encoding = $2 erb.force_encoding valid_encoding(source.dup, encoding) # Always make sure we return a String in the default_internal erb.encode! # Strip trailing newlines from the template if enabled erb.chomp! if strip_trailing_newlines options = { escape: (self.class.escape_ignore_list.include? template.type), trim: (self.class.erb_trim_mode == "-") } if ActionView::Base.annotate_rendered_view_with_filenames && template.format == :html options[:preamble] = "@output_buffer.safe_append='';" options[:postamble] = "@output_buffer.safe_append='';@output_buffer" end self.class.erb_implementation.new(erb, options).src end private def valid_encoding(string, encoding) # If a magic encoding comment was found, tag the # String with this encoding. This is for a case # where the original String was assumed to be, # for instance, UTF-8, but a magic comment # proved otherwise string.force_encoding(encoding) if encoding # If the String is valid, return the encoding we found return string.encoding if string.valid_encoding? # Otherwise, raise an exception raise WrongEncodingError.new(string, string.encoding) end def find_offset(compiled, source_tokens, error_column) compiled = StringScanner.new(compiled) passed_tokens = [] while tok = source_tokens.shift tok_name, str = *tok case tok_name when :TEXT loop do break if compiled.match?(str) compiled.getch end raise LocationParsingError unless compiled.scan(str) when :CODE if compiled.pos > error_column raise LocationParsingError, "We went too far" end if compiled.pos + str.bytesize >= error_column offset = error_column - compiled.pos return passed_tokens.map(&:last).join.bytesize + offset else unless compiled.scan(str) raise LocationParsingError, "Couldn't find code snippet" end end when :OPEN next_tok = source_tokens.first.last loop do break if compiled.match?(next_tok) compiled.getch end when :CLOSE next_tok = source_tokens.first.last loop do break if compiled.match?(next_tok) compiled.getch end else raise LocationParsingError, "Not implemented: #{tok.first}" end passed_tokens << tok end end end end end end