brakeman 4.5.1 → 4.7.1

data/bundle/ruby/2.6.0/gems/haml-5.1.2/lib/haml/compiler.rb

@@ -0,0 +1,330 @@
+# frozen_string_literal: true
+
+require 'haml/attribute_builder'
+require 'haml/attribute_compiler'
+require 'haml/temple_line_counter'
+
+module Haml
+  class Compiler
+    include Haml::Util
+
+    attr_accessor :options
+
+    def initialize(options)
+      @options     = Options.wrap(options)
+      @to_merge    = []
+      @temple      = [:multi]
+      @node        = nil
+      @filters     = Filters.defined.merge(options[:filters])
+      @attribute_compiler = AttributeCompiler.new(@options)
+    end
+
+    def call(node)
+      compile(node)
+      @temple
+    end
+
+    def compile(node)
+      parent, @node = @node, node
+      if node.children.empty?
+        send(:"compile_#{node.type}")
+      else
+        send(:"compile_#{node.type}") {node.children.each {|c| compile c}}
+      end
+    ensure
+      @node = parent
+    end
+
+    private
+
+    def compile_root
+      @output_line = 1
+      yield if block_given?
+      flush_merged_text
+    end
+
+    def compile_plain
+      push_text("#{@node.value[:text]}\n")
+    end
+
+    def nuke_inner_whitespace?(node)
+      if node.value && node.value[:nuke_inner_whitespace]
+        true
+      elsif node.parent
+        nuke_inner_whitespace?(node.parent)
+      else
+        false
+      end
+    end
+
+    def compile_script(&block)
+      push_script(@node.value[:text],
+                  :preserve_script       => @node.value[:preserve],
+                  :escape_html           => @node.value[:escape_html],
+                  :nuke_inner_whitespace => nuke_inner_whitespace?(@node),
+                  &block)
+    end
+
+    def compile_silent_script
+      return if @options.suppress_eval
+      push_silent(@node.value[:text])
+      keyword = @node.value[:keyword]
+
+      if block_given?
+        yield
+        push_silent("end", :can_suppress) unless @node.value[:dont_push_end]
+      elsif keyword == "end"
+        if @node.parent.children.last.equal?(@node)
+          # Since this "end" is ending the block,
+          # we don't need to generate an additional one
+          @node.parent.value[:dont_push_end] = true
+        end
+        # Don't restore dont_* for end because it isn't a conditional branch.
+      end
+    end
+
+    def compile_haml_comment; end
+
+    def compile_tag
+      t = @node.value
+
+      # Get rid of whitespace outside of the tag if we need to
+      rstrip_buffer! if t[:nuke_outer_whitespace]
+
+      if @options.suppress_eval
+        object_ref = :nil
+        parse = false
+        value = t[:parse] ? nil : t[:value]
+        dynamic_attributes = Haml::Parser::DynamicAttributes.new
+      else
+        object_ref = t[:object_ref]
+        parse = t[:parse]
+        value = t[:value]
+        dynamic_attributes = t[:dynamic_attributes]
+      end
+
+      if @options[:trace]
+        t[:attributes].merge!({"data-trace" => @options.filename.split('/views').last << ":" << @node.line.to_s})
+      end
+
+      push_text("<#{t[:name]}")
+      push_temple(@attribute_compiler.compile(t[:attributes], object_ref, dynamic_attributes))
+      push_text(
+        if t[:self_closing] && @options.xhtml?
+          " />#{"\n" unless t[:nuke_outer_whitespace]}"
+        else
+          ">#{"\n" unless (t[:self_closing] && @options.html?) ? t[:nuke_outer_whitespace] : (!block_given? || t[:preserve_tag] || t[:nuke_inner_whitespace])}"
+        end
+      )
+
+      if value && !parse
+        push_text("#{value}</#{t[:name]}>#{"\n" unless t[:nuke_outer_whitespace]}")
+      end
+
+      return if t[:self_closing]
+
+      if value.nil?
+        yield if block_given?
+        rstrip_buffer! if t[:nuke_inner_whitespace]
+        push_text("</#{t[:name]}>#{"\n" unless t[:nuke_outer_whitespace]}")
+        return
+      end
+
+      if parse
+        push_script(value, t.merge(:in_tag => true))
+        push_text("</#{t[:name]}>#{"\n" unless t[:nuke_outer_whitespace]}")
+      end
+    end
+
+    def compile_comment
+      condition = "#{@node.value[:conditional]}>" if @node.value[:conditional]
+      revealed = @node.value[:revealed]
+
+      open = "<!--#{condition}#{'<!-->' if revealed}"
+
+      close = "#{'<!--' if revealed}#{'<![endif]' if condition}-->"
+
+      unless block_given?
+        push_text("#{open} ")
+
+        if @node.value[:parse]
+          push_script(@node.value[:text], :in_tag => true, :nuke_inner_whitespace => true)
+        else
+          push_text(@node.value[:text])
+        end
+
+        push_text(" #{close}\n")
+        return
+      end
+
+      push_text("#{open}\n")
+      yield if block_given?
+      push_text("#{close}\n")
+    end
+
+    def compile_doctype
+      doctype = text_for_doctype
+      push_text("#{doctype}\n") if doctype
+    end
+
+    def compile_filter
+      unless (filter = @filters[@node.value[:name]])
+        name = @node.value[:name]
+        if ["maruku", "textile"].include?(name)
+          raise Error.new(Error.message(:install_haml_contrib, name), @node.line - 1)
+        else
+          raise Error.new(Error.message(:filter_not_defined, name), @node.line - 1)
+        end
+      end
+      filter.internal_compile(self, @node.value[:text])
+    end
+
+    def text_for_doctype
+      if @node.value[:type] == "xml"
+        return nil if @options.html?
+        wrapper = @options.attr_wrapper
+        return "<?xml version=#{wrapper}1.0#{wrapper} encoding=#{wrapper}#{@node.value[:encoding] || "utf-8"}#{wrapper} ?>"
+      end
+
+      if @options.html5?
+        '<!DOCTYPE html>'
+      elsif @options.xhtml?
+        if @node.value[:version] == "1.1"
+          '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'
+        elsif @node.value[:version] == "5"
+          '<!DOCTYPE html>'
+        else
+          case @node.value[:type]
+          when "strict";   '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
+          when "frameset"; '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">'
+          when "mobile";   '<!DOCTYPE html PUBLIC "-//WAPFORUM//DTD XHTML Mobile 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/xhtml-mobile12.dtd">'
+          when "rdfa";     '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">'
+          when "basic";    '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">'
+          else             '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+          end
+        end
+
+      elsif @options.html4?
+        case @node.value[:type]
+        when "strict";   '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">'
+        when "frameset"; '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'
+        else             '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">'
+        end
+      end
+    end
+
+    # Evaluates `text` in the context of the scope object, but
+    # does not output the result.
+    def push_silent(text, can_suppress = false)
+      flush_merged_text
+      return if can_suppress && @options.suppress_eval?
+      newline = (text == "end") ? ";" : "\n"
+      @temple << [:code, "#{resolve_newlines}#{text}#{newline}"]
+      @output_line = @output_line + text.count("\n") + newline.count("\n")
+    end
+
+    # Adds `text` to `@buffer`.
+    def push_text(text)
+      @to_merge << [:text, text]
+    end
+
+    def push_temple(temple)
+      flush_merged_text
+      @temple.concat([[:newline]] * resolve_newlines.count("\n"))
+      @temple << temple
+      @output_line += TempleLineCounter.count_lines(temple)
+    end
+
+    def flush_merged_text
+      return if @to_merge.empty?
+
+      @to_merge.each do |type, val|
+        case type
+        when :text
+          @temple << [:static, val]
+        when :script
+          @temple << [:dynamic, val]
+        else
+          raise SyntaxError.new("[HAML BUG] Undefined entry in Haml::Compiler@to_merge.")
+        end
+      end
+
+      @to_merge = []
+    end
+
+    # Causes `text` to be evaluated in the context of
+    # the scope object and the result to be added to `@buffer`.
+    #
+    # If `opts[:preserve_script]` is true, Haml::Helpers#find_and_preserve is run on
+    # the result before it is added to `@buffer`
+    def push_script(text, opts = {})
+      return if @options.suppress_eval?
+
+      no_format = !(opts[:preserve_script] || opts[:preserve_tag] || opts[:escape_html])
+
+      unless block_given?
+        push_generated_script(no_format ? "(#{text}\n).to_s" : build_script_formatter("(#{text}\n)", opts))
+        push_text("\n") unless opts[:in_tag] || opts[:nuke_inner_whitespace]
+        return
+      end
+
+      flush_merged_text
+      push_silent "haml_temp = #{text}"
+      yield
+      push_silent('end', :can_suppress) unless @node.value[:dont_push_end]
+      @temple << [:dynamic, no_format ? 'haml_temp.to_s;' : build_script_formatter('haml_temp', opts)]
+    end
+
+    def build_script_formatter(text, opts)
+      text = "(#{text}).to_s"
+      if opts[:escape_html]
+        text = "::Haml::Helpers.html_escape(#{text})"
+      end
+      if opts[:nuke_inner_whitespace]
+        text = "(#{text}).strip"
+      end
+      if opts[:preserve_tag]
+        text = "_hamlout.fix_textareas!(::Haml::Helpers.preserve(#{text}))"
+      elsif opts[:preserve_script]
+        text = "_hamlout.fix_textareas!(::Haml::Helpers.find_and_preserve(#{text}, _hamlout.options[:preserve]))"
+      end
+      "#{text};"
+    end
+
+    def push_generated_script(text)
+      @to_merge << [:script, resolve_newlines + text]
+      @output_line += text.count("\n")
+    end
+
+    def resolve_newlines
+      diff = @node.line - @output_line
+      return "" if diff <= 0
+      @output_line = @node.line
+      "\n" * diff
+    end
+
+    # Get rid of and whitespace at the end of the buffer
+    # or the merged text
+    def rstrip_buffer!(index = -1)
+      last = @to_merge[index]
+      if last.nil?
+        push_silent("_hamlout.rstrip!", false)
+        return
+      end
+
+      case last.first
+      when :text
+        last[1] = last[1].rstrip
+        if last[1].empty?
+          @to_merge.slice! index
+          rstrip_buffer! index
+        end
+      when :script
+        last[1].gsub!(/\(haml_temp, (.*?)\);$/, '(haml_temp.rstrip, \1);')
+        rstrip_buffer! index - 1
+      else
+        raise SyntaxError.new("[HAML BUG] Undefined entry in Haml::Compiler@to_merge.")
+      end
+    end
+  end
+end

data/bundle/ruby/{2.5.0/gems/haml-4.0.7 → 2.6.0/gems/haml-5.1.2}/lib/haml/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 require 'haml/parser'
@@ -7,6 +9,7 @@ require 'haml/helpers'
 require 'haml/buffer'
 require 'haml/filters'
 require 'haml/error'
+require 'haml/temple_engine'
 
 module Haml
   # This is the frontend for using Haml programmatically.
@@ -35,9 +38,6 @@ module Haml
     # @return [String]
     attr_accessor :indentation
 
-    attr_accessor :compiler
-    attr_accessor :parser
-
     # Tilt currently depends on these moved methods, provide a stable API
     def_delegators :compiler, :precompiled, :precompiled_method_return_value
 
@@ -52,25 +52,28 @@ module Haml
     #   see {file:REFERENCE.md#options the Haml options documentation}
     # @raise [Haml::Error] if there's a Haml syntax error in the template
     def initialize(template, options = {})
+      # Reflect changes of `Haml::Options.defaults` to `Haml::TempleEngine` options, but `#initialize_encoding`
+      # should be run against the arguemnt `options[:encoding]` for backward compatibility with old `Haml::Engine`.
+      options = Options.defaults.dup.tap { |o| o.delete(:encoding) }.merge!(options)
       @options = Options.new(options)
 
       @template = check_haml_encoding(template) do |msg, line|
         raise Haml::Error.new(msg, line)
       end
 
-      initialize_encoding options[:encoding]
-
-      @parser   = @options.parser_class.new(@template, @options)
-      @compiler = @options.compiler_class.new(@options)
+      @temple_engine = TempleEngine.new(options)
+      @temple_engine.compile(@template)
+    end
 
-      @compiler.compile(@parser.parse)
+    # Deprecated API for backword compatibility
+    def compiler
+      @temple_engine
     end
 
     # Processes the template and returns the result as a string.
     #
     # `scope` is the context in which the template is evaluated.
-    # If it's a `Binding` or `Proc` object,
-    # Haml uses it as the second argument to `Kernel#eval`;
+    # If it's a `Binding`, Haml uses it as the second argument to `Kernel#eval`;
     # otherwise, Haml just uses its `#instance_eval` context.
     #
     # Note that Haml modifies the evaluation context
@@ -95,23 +98,23 @@ module Haml
     # within the template.
     #
     # Due to some Ruby quirks,
-    # if `scope` is a `Binding` or `Proc` object and a block is given,
+    # if `scope` is a `Binding` object and a block is given,
     # the evaluation context may not be quite what the user expects.
     # In particular, it's equivalent to passing `eval("self", scope)` as `scope`.
     # This won't have an effect in most cases,
     # but if you're relying on local variables defined in the context of `scope`,
     # they won't work.
     #
-    # @param scope [Binding, Proc, Object] The context in which the template is evaluated
+    # @param scope [Binding, Object] The context in which the template is evaluated
     # @param locals [{Symbol => Object}] Local variables that will be made available
     #   to the template
     # @param block [#to_proc] A block that can be yielded to within the template
     # @return [String] The rendered template
     def render(scope = Object.new, locals = {}, &block)
-      parent = scope.instance_variable_defined?('@haml_buffer') ? scope.instance_variable_get('@haml_buffer') : nil
+      parent = scope.instance_variable_defined?(:@haml_buffer) ? scope.instance_variable_get(:@haml_buffer) : nil
       buffer = Haml::Buffer.new(parent, @options.for_buffer)
 
-      if scope.is_a?(Binding) || scope.is_a?(Proc)
+      if scope.is_a?(Binding)
         scope_object = eval("self", scope)
         scope = scope_object.instance_eval{binding} if block_given?
       else
@@ -121,20 +124,16 @@ module Haml
 
       set_locals(locals.merge(:_hamlout => buffer, :_erbout => buffer.buffer), scope, scope_object)
 
-      scope_object.instance_eval do
-        extend Haml::Helpers
-        @haml_buffer = buffer
-      end
+      scope_object.extend(Haml::Helpers)
+      scope_object.instance_variable_set(:@haml_buffer, buffer)
       begin
-        eval(@compiler.precompiled_with_return_value, scope, @options[:filename], @options[:line])
+        eval(@temple_engine.precompiled_with_return_value, scope, @options.filename, @options.line)
       rescue ::SyntaxError => e
         raise SyntaxError, e.message
       end
     ensure
       # Get rid of the current buffer
-      scope_object.instance_eval do
-        @haml_buffer = buffer.upper if buffer
-      end
+      scope_object.instance_variable_set(:@haml_buffer, buffer.upper) if buffer
     end
     alias_method :to_html, :render
 
@@ -159,11 +158,11 @@ module Haml
     #
     # The proc doesn't take a block; any yields in the template will fail.
     #
-    # @param scope [Binding, Proc, Object] The context in which the template is evaluated
+    # @param scope [Binding, Object] The context in which the template is evaluated
     # @param local_names [Array<Symbol>] The names of the locals that can be passed to the proc
     # @return [Proc] The proc that will run the template
     def render_proc(scope = Object.new, *local_names)
-      if scope.is_a?(Binding) || scope.is_a?(Proc)
+      if scope.is_a?(Binding)
         scope_object = eval("self", scope)
       else
         scope_object = scope
@@ -171,8 +170,13 @@ module Haml
       end
 
       begin
-        eval("Proc.new { |*_haml_locals| _haml_locals = _haml_locals[0] || {};" +
-             compiler.precompiled_with_ambles(local_names) + "}\n", scope, @options[:filename], @options[:line])
+        str = @temple_engine.precompiled_with_ambles(local_names)
+        eval(
+          "Proc.new { |*_haml_locals| _haml_locals = _haml_locals[0] || {}; #{str}}\n",
+          scope,
+          @options.filename,
+          @options.line
+        )
       rescue ::SyntaxError => e
         raise SyntaxError, e.message
       end
@@ -182,7 +186,7 @@ module Haml
     # that renders the template and returns the result as a string.
     #
     # If `object` is a class or module,
-    # the method will instead by defined as an instance method.
+    # the method will instead be defined as an instance method.
     # For example:
     #
     #     t = Time.now
@@ -219,25 +223,14 @@ module Haml
     def def_method(object, name, *local_names)
       method = object.is_a?(Module) ? :module_eval : :instance_eval
 
-      object.send(method, "def #{name}(_haml_locals = {}); #{compiler.precompiled_with_ambles(local_names)}; end",
-                  @options[:filename], @options[:line])
+      object.send(method, "def #{name}(_haml_locals = {}); #{@temple_engine.precompiled_with_ambles(local_names)}; end",
+                  @options.filename, @options.line)
     end
 
     private
 
-    if RUBY_VERSION < "1.9"
-      def initialize_encoding(given_value)
-      end
-    else
-      def initialize_encoding(given_value)
-        unless given_value
-          @options.encoding = Encoding.default_internal || @template.encoding
-        end
-      end
-    end
-
     def set_locals(locals, scope, scope_object)
-      scope_object.send(:instance_variable_set, '@_haml_locals', locals)
+      scope_object.instance_variable_set :@_haml_locals, locals
       set_locals = locals.keys.map { |k| "#{k} = @_haml_locals[#{k.inspect}]" }.join("\n")
       eval(set_locals, scope)
     end