aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_view/template/handlers/erb.rb
blob: bbf012ab154c7db17c3fbadb064e0eea4c9dcd6c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/string/output_safety'
require "action_view/template"
require 'erubis'

module ActionView
  class OutputBuffer < ActiveSupport::SafeBuffer
    def initialize(*)
      super
      encode!
    end

    def <<(value)
      super(value.to_s)
    end
    alias :append= :<<

    def append_if_string=(value)
      if value.is_a?(String) && !value.is_a?(NonConcattingString)
        ActiveSupport::Deprecation.warn("<% %> style block helpers are deprecated. Please use <%= %>", caller)
        self << value
      end
    end
  end

  class Template
    module Handlers
      class Erubis < ::Erubis::Eruby
        def add_preamble(src)
          src << "@output_buffer = ActionView::OutputBuffer.new;"
        end

        def add_text(src, text)
          return if text.empty?
          src << "@output_buffer.safe_concat('" << escape_text(text) << "');"
        end

        BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/

        def add_expr_literal(src, code)
          if code =~ BLOCK_EXPR
            src << '@output_buffer.append= ' << code
          else
            src << '@output_buffer.append= (' << code << ');'
          end
        end

        def add_stmt(src, code)
          if code =~ BLOCK_EXPR
            src << '@output_buffer.append_if_string= ' << code
          else
            super
          end
        end

        def add_expr_escaped(src, code)
          src << '@output_buffer.append= ' << escaped_expr(code) << ';'
        end

        def add_postamble(src)
          src << '@output_buffer.to_s'
        end
      end

      class ERB < Handler
        include Compilable

        ##
        # :singleton-method:
        # Specify trim mode for the ERB compiler. Defaults to '-'.
        # See ERb documentation for suitable values.
        cattr_accessor :erb_trim_mode
        self.erb_trim_mode = '-'

        self.default_format = Mime::HTML

        cattr_accessor :erb_implementation
        self.erb_implementation = Erubis

        ENCODING_TAG = Regexp.new("\\A(<%#{ENCODING_FLAG}-?%>)[ \\t]*")

        def self.accepts_binary?
          true
        end

        def compile(template)
          if template.source.encoding_aware?
            # Even though Rails has given us a String tagged with the
            # default_internal encoding (likely UTF-8), it is possible
            # that the String is actually encoded using a different
            # encoding, specified via an ERB magic comment. If the
            # String is not actually UTF-8, the regular expression
            # engine will (correctly) raise an exception. For now,
            # we'll reset the String to BINARY so we can run regular
            # expressions against it
            template_source = template.source.dup.force_encoding("BINARY")

            # Erubis does not have direct support for encodings.
            # As a result, we will extract the ERB-style magic
            # comment, give the String to Erubis as BINARY data,
            # and then tag the resulting String with the extracted
            # encoding later
            erb = template_source.gsub(ENCODING_TAG, '')
            encoding = $2

            if !encoding && (template.source.encoding == Encoding::BINARY)
              raise WrongEncodingError.new(template_source, Encoding.default_external)
            end
          end

          result = self.class.erb_implementation.new(
            erb,
            :trim => (self.class.erb_trim_mode == "-")
          ).src

          # If an encoding tag was found, tag the String
          # we're returning with that encoding. Otherwise,
          # return a BINARY String, which is what ERB
          # returns. Note that if a magic comment was
          # not specified, we will return the data to
          # Rails as BINARY, which will then use its
          # own encoding logic to create a UTF-8 String.
          result = "\n#{result}".force_encoding(encoding).encode if encoding
          result
        end
      end
    end
  end
end