haml 5.1.2 → 6.3.0

data/lib/haml/helpers/xss_mods.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module Haml
-  module Helpers
-    # This module overrides Haml helpers to work properly
-    # in the context of ActionView.
-    # Currently it's only used for modifying the helpers
-    # to work with Rails' XSS protection methods.
-    module XssMods
-      def self.included(base)
-        %w[html_escape find_and_preserve preserve list_of surround
-           precede succeed capture_haml haml_concat haml_internal_concat haml_indent
-           escape_once].each do |name|
-          base.send(:alias_method, "#{name}_without_haml_xss", name)
-          base.send(:alias_method, name, "#{name}_with_haml_xss")
-        end
-      end
-
-      # Don't escape text that's already safe,
-      # output is always HTML safe
-      def html_escape_with_haml_xss(text)
-        str = text.to_s
-        return text if str.html_safe?
-        Haml::Util.html_safe(html_escape_without_haml_xss(str))
-      end
-
-      # Output is always HTML safe
-      def find_and_preserve_with_haml_xss(*args, &block)
-        Haml::Util.html_safe(find_and_preserve_without_haml_xss(*args, &block))
-      end
-
-      # Output is always HTML safe
-      def preserve_with_haml_xss(*args, &block)
-        Haml::Util.html_safe(preserve_without_haml_xss(*args, &block))
-      end
-
-      # Output is always HTML safe
-      def list_of_with_haml_xss(*args, &block)
-        Haml::Util.html_safe(list_of_without_haml_xss(*args, &block))
-      end
-
-      # Input is escaped, output is always HTML safe
-      def surround_with_haml_xss(front, back = front, &block)
-        Haml::Util.html_safe(
-          surround_without_haml_xss(
-            haml_xss_html_escape(front),
-            haml_xss_html_escape(back),
-            &block))
-      end
-
-      # Input is escaped, output is always HTML safe
-      def precede_with_haml_xss(str, &block)
-        Haml::Util.html_safe(precede_without_haml_xss(haml_xss_html_escape(str), &block))
-      end
-
-      # Input is escaped, output is always HTML safe
-      def succeed_with_haml_xss(str, &block)
-        Haml::Util.html_safe(succeed_without_haml_xss(haml_xss_html_escape(str), &block))
-      end
-
-      # Output is always HTML safe
-      def capture_haml_with_haml_xss(*args, &block)
-        Haml::Util.html_safe(capture_haml_without_haml_xss(*args, &block))
-      end
-
-      # Input will be escaped unless this is in a `with_raw_haml_concat`
-      # block. See #Haml::Helpers::ActionViewExtensions#with_raw_haml_concat.
-      def haml_concat_with_haml_xss(text = "")
-        raw = instance_variable_defined?(:@_haml_concat_raw) ? @_haml_concat_raw : false
-        if raw
-          haml_internal_concat_raw text
-        else
-          haml_internal_concat text
-        end
-        ErrorReturn.new("haml_concat")
-      end
-
-      # Input is escaped
-      def haml_internal_concat_with_haml_xss(text="", newline=true, indent=true)
-        haml_internal_concat_without_haml_xss(haml_xss_html_escape(text), newline, indent)
-      end
-      private :haml_internal_concat_with_haml_xss
-
-      # Output is always HTML safe
-      def haml_indent_with_haml_xss
-        Haml::Util.html_safe(haml_indent_without_haml_xss)
-      end
-
-      # Output is always HTML safe
-      def escape_once_with_haml_xss(*args)
-        Haml::Util.html_safe(escape_once_without_haml_xss(*args))
-      end
-
-      private
-
-      # Escapes the HTML in the text if and only if
-      # Rails XSS protection is enabled *and* the `:escape_html` option is set.
-      def haml_xss_html_escape(text)
-        return text unless Haml::Util.rails_xss_safe? && haml_buffer.options[:escape_html]
-        html_escape(text)
-      end
-    end
-
-    class ErrorReturn
-      # Any attempt to treat ErrorReturn as a string should cause it to blow up.
-      alias_method :html_safe, :to_s
-      alias_method :html_safe?, :to_s
-      alias_method :html_safe!, :to_s
-    end
-  end
-end

data/lib/haml/options.rb

@@ -1,273 +0,0 @@
-# frozen_string_literal: true
-
-module Haml
-  # This class encapsulates all of the configuration options that Haml
-  # understands. Please see the {file:REFERENCE.md#options Haml Reference} to
-  # learn how to set the options.
-  class Options
-    @valid_formats = [:html4, :html5, :xhtml]
-    @buffer_option_keys = [:autoclose, :preserve, :attr_wrapper, :format,
-      :encoding, :escape_html, :escape_filter_interpolations, :escape_attrs, :hyphenate_data_attrs, :cdata]
-
-    class << self
-      # The default option values.
-      # @return Hash
-      def defaults
-        @defaults ||= Haml::TempleEngine.options.to_hash.merge(encoding: 'UTF-8')
-      end
-
-      # An array of valid values for the `:format` option.
-      # @return Array
-      attr_reader :valid_formats
-
-      # An array of keys that will be used to provide a hash of options to
-      # {Haml::Buffer}.
-      # @return Hash
-      attr_reader :buffer_option_keys
-
-      # Returns a subset of defaults: those that {Haml::Buffer} cares about.
-      # @return [{Symbol => Object}] The options hash
-      def buffer_defaults
-        @buffer_defaults ||= buffer_option_keys.inject({}) do |hash, key|
-          hash.merge(key => defaults[key])
-        end
-      end
-
-      def wrap(options)
-        if options.is_a?(Options)
-          options
-        else
-          Options.new(options)
-        end
-      end
-    end
-
-    # The character that should wrap element attributes. This defaults to `'`
-    # (an apostrophe). Characters of this type within the attributes will be
-    # escaped (e.g. by replacing them with `&apos;`) if the character is an
-    # apostrophe or a quotation mark.
-    attr_reader :attr_wrapper
-
-    # A list of tag names that should be automatically self-closed if they have
-    # no content. This can also contain regular expressions that match tag names
-    # (or any object which responds to `#===`). Defaults to `['meta', 'img',
-    # 'link', 'br', 'hr', 'input', 'area', 'param', 'col', 'base']`.
-    attr_accessor :autoclose
-
-    # The encoding to use for the HTML output.
-    # This can be a string or an `Encoding` Object. Note that Haml **does not**
-    # automatically re-encode Ruby values; any strings coming from outside the
-    # application should be converted before being passed into the Haml
-    # template. Defaults to `Encoding.default_internal`; if that's not set,
-    # defaults to the encoding of the Haml template; if that's `US-ASCII`,
-    # defaults to `"UTF-8"`.
-    attr_reader :encoding
-
-    # Sets whether or not to escape HTML-sensitive characters in attributes. If
-    # this is true, all HTML-sensitive characters in attributes are escaped. If
-    # it's set to false, no HTML-sensitive characters in attributes are escaped.
-    # If it's set to `:once`, existing HTML escape sequences are preserved, but
-    # other HTML-sensitive characters are escaped.
-    #
-    # Defaults to `true`.
-    attr_accessor :escape_attrs
-
-    # Sets whether or not to escape HTML-sensitive characters in script. If this
-    # is true, `=` behaves like {file:REFERENCE.md#escaping_html `&=`};
-    # otherwise, it behaves like {file:REFERENCE.md#unescaping_html `!=`}. Note
-    # that if this is set, `!=` should be used for yielding to subtemplates and
-    # rendering partials. See also {file:REFERENCE.md#escaping_html Escaping HTML} and
-    # {file:REFERENCE.md#unescaping_html Unescaping HTML}.
-    #
-    # Defaults to false.
-    attr_accessor :escape_html
-
-    # Sets whether or not to escape HTML-sensitive characters in interpolated strings.
-    # See also {file:REFERENCE.md#escaping_html Escaping HTML} and
-    # {file:REFERENCE.md#unescaping_html Unescaping HTML}.
-    #
-    # Defaults to the current value of `escape_html`.
-    attr_accessor :escape_filter_interpolations
-
-    # The name of the Haml file being parsed.
-    # This is only used as information when exceptions are raised. This is
-    # automatically assigned when working through ActionView, so it's really
-    # only useful for the user to assign when dealing with Haml programatically.
-    attr_accessor :filename
-
-    # If set to `true`, Haml will convert underscores to hyphens in all
-    # {file:REFERENCE.md#html5_custom_data_attributes Custom Data Attributes} As
-    # of Haml 4.0, this defaults to `true`.
-    attr_accessor :hyphenate_data_attrs
-
-    # The line offset of the Haml template being parsed. This is useful for
-    # inline templates, similar to the last argument to `Kernel#eval`.
-    attr_accessor :line
-
-    # Determines the output format. The default is `:html5`. The other options
-    # are `:html4` and `:xhtml`. If the output is set to XHTML, then Haml
-    # automatically generates self-closing tags and wraps the output of the
-    # Javascript and CSS-like filters inside CDATA. When the output is set to
-    # `:html5` or `:html4`, XML prologs are ignored. In all cases, an appropriate
-    # doctype is generated from `!!!`.
-    #
-    # If the mime_type of the template being rendered is `text/xml` then a
-    # format of `:xhtml` will be used even if the global output format is set to
-    # `:html4` or `:html5`.
-    attr :format
-
-    # The mime type that the rendered document will be served with. If this is
-    # set to `text/xml` then the format will be overridden to `:xhtml` even if
-    # it has set to `:html4` or `:html5`.
-    attr_accessor :mime_type
-
-    # A list of tag names that should automatically have their newlines
-    # preserved using the {Haml::Helpers#preserve} helper. This means that any
-    # content given on the same line as the tag will be preserved. For example,
-    # `%textarea= "Foo\nBar"` compiles to `<textarea>Foo&#x000A;Bar</textarea>`.
-    # Defaults to `['textarea', 'pre']`. See also
-    # {file:REFERENCE.md#whitespace_preservation Whitespace Preservation}.
-    attr_accessor :preserve
-
-    # If set to `true`, all tags are treated as if both
-    # {file:REFERENCE.md#whitespace_removal__and_ whitespace removal} options
-    # were present. Use with caution as this may cause whitespace-related
-    # formatting errors.
-    #
-    # Defaults to `false`.
-    attr_accessor :remove_whitespace
-
-    # Whether or not attribute hashes and Ruby scripts designated by `=` or `~`
-    # should be evaluated. If this is `true`, said scripts are rendered as empty
-    # strings.
-    #
-    # Defaults to `false`.
-    attr_accessor :suppress_eval
-
-    # Whether to include CDATA sections around javascript and css blocks when
-    # using the `:javascript` or `:css` filters.
-    #
-    # This option also affects the `:sass`, `:scss`, `:less` and `:coffeescript`
-    # filters.
-    #
-    # Defaults to `false` for html, `true` for xhtml. Cannot be changed when using
-    # xhtml.
-    attr_accessor :cdata
-
-    # The parser class to use. Defaults to Haml::Parser.
-    attr_accessor :parser_class
-
-    # The compiler class to use. Defaults to Haml::Compiler.
-    attr_accessor :compiler_class
-
-    # Enable template tracing. If true, it will add a 'data-trace' attribute to
-    # each tag generated by Haml. The value of the attribute will be the
-    # source template name and the line number from which the tag was generated,
-    # separated by a colon. On Rails applications, the path given will be a
-    # relative path as from the views directory. On non-Rails applications,
-    # the path will be the full path.
-    attr_accessor :trace
-
-    # Key is filter name in String and value is Class to use. Defaults to {}.
-    attr_accessor :filters
-
-    def initialize(values = {})
-      defaults.each {|k, v| instance_variable_set :"@#{k}", v}
-      values.each {|k, v| send("#{k}=", v) if defaults.has_key?(k) && !v.nil?}
-      yield if block_given?
-    end
-
-    # Retrieve an option value.
-    # @param key The value to retrieve.
-    def [](key)
-      send key
-    end
-
-    # Set an option value.
-    # @param key The key to set.
-    # @param value The value to set for the key.
-    def []=(key, value)
-      send "#{key}=", value
-    end
-
-    [:escape_attrs, :hyphenate_data_attrs, :remove_whitespace, :suppress_eval].each do |method|
-      class_eval(<<-END)
-        def #{method}?
-          !! @#{method}
-        end
-      END
-    end
-
-    # @return [Boolean] Whether or not the format is XHTML.
-    def xhtml?
-      not html?
-    end
-
-    # @return [Boolean] Whether or not the format is any flavor of HTML.
-    def html?
-      html4? or html5?
-    end
-
-    # @return [Boolean] Whether or not the format is HTML4.
-    def html4?
-      format == :html4
-    end
-
-    # @return [Boolean] Whether or not the format is HTML5.
-    def html5?
-      format == :html5
-    end
-
-    def attr_wrapper=(value)
-      @attr_wrapper = value || self.class.defaults[:attr_wrapper]
-    end
-
-    # Undef :format to suppress warning. It's defined above with the `:attr`
-    # macro in order to make it appear in Yard's list of instance attributes.
-    undef :format
-    def format
-      mime_type == "text/xml" ? :xhtml : @format
-    end
-
-    def format=(value)
-      unless self.class.valid_formats.include?(value)
-        raise Haml::Error, "Invalid output format #{value.inspect}"
-      end
-      @format = value
-    end
-
-    undef :cdata
-    def cdata
-      xhtml? || @cdata
-    end
-
-    def encoding=(value)
-      return unless value
-      @encoding = value.is_a?(Encoding) ? value.name : value.to_s
-      @encoding = "UTF-8" if @encoding.upcase == "US-ASCII"
-    end
-
-    # Returns a non-default subset of options: those that {Haml::Buffer} cares about.
-    # All of the values here are such that when `#inspect` is called on the hash,
-    # it can be `Kernel#eval`ed to get the same result back.
-    #
-    # See {file:REFERENCE.md#options the Haml options documentation}.
-    #
-    # @return [{Symbol => Object}] The options hash
-    def for_buffer
-      self.class.buffer_option_keys.inject({}) do |hash, key|
-        value = public_send(key)
-        if self.class.buffer_defaults[key] != value
-          hash[key] = value
-        end
-        hash
-      end
-    end
-
-    private
-
-    def defaults
-      self.class.defaults
-    end
-  end
-end

data/lib/haml/plugin.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Haml
-
-  # This module makes Haml work with Rails using the template handler API.
-  class Plugin
-    def handles_encoding?; true; end
-
-    def compile(template, source)
-      options = Haml::Template.options.dup
-      if template.respond_to?(:type)
-        options[:mime_type] = template.type
-      elsif template.respond_to? :mime_type
-        options[:mime_type] = template.mime_type
-      end
-      options[:filename] = template.identifier
-      Haml::Engine.new(source, options).compiler.precompiled_with_ambles(
-        [],
-        after_preamble: '@output_buffer = output_buffer ||= ActionView::OutputBuffer.new if defined?(ActionView::OutputBuffer)',
-      )
-    end
-
-    def self.call(template, source = nil)
-      source ||= template.source
-
-      new.compile(template, source)
-    end
-
-    def cache_fragment(block, name = {}, options = nil)
-      @view.fragment_for(block, name, options) do
-        eval("_hamlout.buffer", block.binding)
-      end
-    end
-  end
-end
-
-ActionView::Template.register_template_handler(:haml, Haml::Plugin)

data/lib/haml/sass_rails_filter.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Haml
-  module Filters
-    # This is an extension of Sass::Rails's SassTemplate class that allows
-    # Rails's asset helpers to be used inside Haml Sass filter.
-    class SassRailsTemplate < ::Sass::Rails::SassTemplate
-      if Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('3.0.0')
-        def render(scope=Object.new, locals={}, &block)
-          environment = ::Sprockets::Railtie.build_environment(::Rails.application)
-          scope = environment.context_class.new(
-            environment: environment,
-            filename: "/",
-            metadata: {}
-          )
-          super
-        end
-      else
-        def render(scope=Object.new, locals={}, &block)
-          scope = ::Rails.application.assets.context_class.new(::Rails.application.assets, "/", "/")
-          super
-        end
-      end
-
-      def sass_options(scope)
-        options = super
-        options[:custom][:resolver] = ::ActionView::Base.new
-        options
-      end
-    end
-
-    # This is an extension of Sass::Rails's SassTemplate class that allows
-    # Rails's asset helpers to be used inside a Haml SCSS filter.
-    class ScssRailsTemplate < SassRailsTemplate
-      self.default_mime_type = 'text/css'
-
-      def syntax
-        :scss
-      end
-    end
-
-    remove_filter :Sass
-    remove_filter :Scss
-    register_tilt_filter "Sass", :extend => "Css", :template_class => SassRailsTemplate
-    register_tilt_filter "Scss", :extend => "Css", :template_class => ScssRailsTemplate
-  end
-end

data/lib/haml/template/options.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# We keep options in its own self-contained file
-# so that we can load it independently in Rails 3,
-# where the full template stuff is lazy-loaded.
-
-module Haml
-  module Template
-    extend self
-
-    class Options < Hash
-      def []=(key, value)
-        super
-        if Haml::Options.buffer_defaults.key?(key)
-          Haml::Options.buffer_defaults[key] = value
-        end
-      end
-    end
-
-    @options = ::Haml::Template::Options.new
-    # The options hash for Haml when used within Rails.
-    # See {file:REFERENCE.md#options the Haml options documentation}.
-    #
-    # @return [Haml::Template::Options<Symbol => Object>]
-    attr_accessor :options
-  end
-end

data/lib/haml/temple_engine.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-require 'temple'
-require 'haml/escapable'
-require 'haml/generator'
-
-module Haml
-  class TempleEngine < Temple::Engine
-    define_options(
-      attr_wrapper:         "'",
-      autoclose:            %w(area base basefont br col command embed frame
-                               hr img input isindex keygen link menuitem meta
-                               param source track wbr),
-      encoding:             nil,
-      escape_attrs:         true,
-      escape_html:          false,
-      escape_filter_interpolations: nil,
-      filename:             '(haml)',
-      format:               :html5,
-      hyphenate_data_attrs: true,
-      line:                 1,
-      mime_type:            'text/html',
-      preserve:             %w(textarea pre code),
-      remove_whitespace:    false,
-      suppress_eval:        false,
-      cdata:                false,
-      parser_class:         ::Haml::Parser,
-      compiler_class:       ::Haml::Compiler,
-      trace:                false,
-      filters:              {},
-    )
-
-    use :Parser,   -> { options[:parser_class] }
-    use :Compiler, -> { options[:compiler_class] }
-    use Escapable
-    filter :ControlFlow
-    filter :MultiFlattener
-    filter :StaticMerger
-    use Generator
-
-    def compile(template)
-      initialize_encoding(template, options[:encoding])
-      @precompiled = call(template)
-    end
-
-    # The source code that is evaluated to produce the Haml document.
-    #
-    # This is automatically converted to the correct encoding
-    # (see {file:REFERENCE.md#encodings the `:encoding` option}).
-    #
-    # @return [String]
-    def precompiled
-      encoding = Encoding.find(@encoding || '')
-      return @precompiled.dup.force_encoding(encoding) if encoding == Encoding::ASCII_8BIT
-      return @precompiled.encode(encoding)
-    end
-
-    def precompiled_with_return_value
-      "#{precompiled};#{precompiled_method_return_value}".dup
-    end
-
-    # The source code that is evaluated to produce the Haml document.
-    #
-    # This is automatically converted to the correct encoding
-    # (see {file:REFERENCE.md#encodings the `:encoding` option}).
-    #
-    # @return [String]
-    def precompiled_with_ambles(local_names, after_preamble: '')
-      preamble = <<END.tr("\n", ';')
-begin
-extend Haml::Helpers
-_hamlout = @haml_buffer = Haml::Buffer.new(haml_buffer, #{Options.new(options).for_buffer.inspect})
-_erbout = _hamlout.buffer
-#{after_preamble}
-END
-      postamble = <<END.tr("\n", ';')
-#{precompiled_method_return_value}
-ensure
-@haml_buffer = @haml_buffer.upper if @haml_buffer
-end
-END
-      "#{preamble}#{locals_code(local_names)}#{precompiled}#{postamble}".dup
-    end
-
-    private
-
-    def initialize_encoding(template, given_value)
-      if given_value
-        @encoding = given_value
-      else
-        @encoding = Encoding.default_internal || template.encoding
-      end
-    end
-
-    # Returns the string used as the return value of the precompiled method.
-    # This method exists so it can be monkeypatched to return modified values.
-    def precompiled_method_return_value
-      "_erbout"
-    end
-
-    def locals_code(names)
-      names = names.keys if Hash === names
-
-      names.map do |name|
-        # Can't use || because someone might explicitly pass in false with a symbol
-        sym_local = "_haml_locals[#{inspect_obj(name.to_sym)}]"
-        str_local = "_haml_locals[#{inspect_obj(name.to_s)}]"
-        "#{name} = #{sym_local}.nil? ? #{str_local} : #{sym_local};"
-      end.join
-    end
-
-    def inspect_obj(obj)
-      case obj
-      when String
-        %Q!"#{obj.gsub(/[\x00-\x7F]+/) {|s| s.inspect[1...-1]}}"!
-      when Symbol
-        ":#{inspect_obj(obj.to_s)}"
-      else
-        obj.inspect
-      end
-    end
-  end
-end

data/yard/default/.gitignore

@@ -1 +0,0 @@
-*.css

data/yard/default/fulldoc/html/css/common.sass

@@ -1,15 +0,0 @@
-#filecontents
-  *:target, dt:target + dd
-    background-color: #ccf
-    border: 1px solid #88b
-  dt
-    font-weight: bold
-  dd
-    margin:
-      left: 0
-      bottom: 0.7em
-    padding-left: 3em
-  dt:target
-    border-bottom-style: none
-    & + dd
-      border-top-style: none

data/yard/default/layout/html/footer.erb

@@ -1,12 +0,0 @@
-<%= superb :footer %>
-<% if ENV["ANALYTICS"] %>
-  <script type="text/javascript">
-  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-  </script>
-  <script type="text/javascript">
-  try {
-  var pageTracker = _gat._getTracker("<%= ENV["ANALYTICS"] %>");
-  pageTracker._trackPageview();
-  } catch(err) {}</script>
-<% end %>