RubyGems - brakeman - Versions diffs - 4.4.0 → 5.0.0 - Mend

brakeman 4.4.0 → 5.0.0

Files changed (732) hide show

data/bundle/ruby/{2.5.0/gems/haml-4.0.7 → 2.7.0/gems/haml-5.2.1}/REFERENCE.md RENAMED Viewed

@@ -115,13 +115,18 @@ Haml::Options.defaults:
     Haml::Options.defaults[:format] = :html5
+In sinatra specifically, you can set them in global config with:
+```ruby
+set :haml, { escape_html: true }
+```
 Finally, you can also set them by passing an options hash to
 {Haml::Engine#initialize}. For the complete list of available options, please
 see {Haml::Options}.
 ### Encodings
-When using Ruby 1.9 or later, Haml supports the same sorts of
+Haml supports the same sorts of
 encoding-declaration comments that Ruby does. Although both Ruby and Haml
 support several different styles, the easiest it just to add `-# coding:
 encoding-name` at the beginning of the Haml template (it must come before all
@@ -223,18 +228,21 @@ is compiled to:
     <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'></html>
 Attribute hashes can also be stretched out over multiple lines to accommodate
-many attributes. However, newlines may only be placed immediately after commas.
-For example:
+many attributes.
-    %script{:type => "text/javascript",
-            :src  => "javascripts/script_#{2 + 7}"}
+    %script{
+      "type": text/javascript",
+      "src": javascripts/script_#{2 + 7}",
+      "data": {
+        "controller": "reporter",
+      },
+    }
 is compiled to:
-    <script src='javascripts/script_9' type='text/javascript'></script>
+    <script src='javascripts/script_9' type='text/javascript' data-controller='reporter'></script>
-#### `:class` and `:id` Attributes
-{#class-and-id-attributes}
+#### `:class` and `:id` Attributes {#class-and-id-attributes}
 The `:class` and `:id` attributes can also be specified as a Ruby array whose
 elements will be joined together. A `:class` array is joined with `" "` and an
@@ -306,7 +314,7 @@ hash-style attributes:
 #### Ruby 1.9-style Hashes
-On Ruby 1.9, Haml also supports Ruby's new hash syntax:
+Haml also supports Ruby's new hash syntax:
     %a{title: @title, href: href} Stuff
@@ -389,27 +397,49 @@ or using `true` and `false`:
     %input(selected=true)
-#### HTML5 Custom Data Attributes
+<!-- The title to the next section (Prefixed Attributes) has changed. This
+<a> tag is so old links to here still work. -->
+<a id="html5_custom_data_attributes" style="border:0;"></a>
-HTML5 allows for adding [custom non-visible data
-attributes](http://www.whatwg.org/specs/web-apps/current-work/multipage/elements.html#embedding-custom-non-visible-data)
-to elements using attribute names beginning with `data-`. Custom data attributes
-can be used in Haml by using the key `:data` with a Hash value in an attribute
-hash. Each of the key/value pairs in the Hash will be transformed into a custom
-data attribute. For example:
+#### Prefixed Attributes
-    %a{:href=>"/posts", :data => {:author_id => 123}} Posts By Author
+HTML5 allows for adding
+[custom non-visible data attributes](http://www.whatwg.org/specs/web-apps/current-work/multipage/elements.html#embedding-custom-non-visible-data-with-the-data-*-attributes)
+to elements using attribute names beginning with `data-`. The
+[Accessible Rich Internet Applications](http://www.w3.org/WAI/intro/aria)
+specification makes use of attributes beginning with `aria-`. There are also
+frameworks that use non-standard attributes with a common prefix.
+Haml can help generate collections of attributes that share a prefix like
+these. Any entry in an attribute hash that has a Hash as its value is expanded
+into a series of attributes, one for each key/value pair in the hash, with the
+attribute name formed by joining the “parent” key name to the key name with a
+hyphen.
+For example:
+    %a{:href=>"/posts", :data => {:author_id => 123, :category => 7}} Posts By Author
 will render as:
-    <a data-author-id='123' href='/posts'>Posts By Author</a>
+    <a data-author-id='123' data-category='7' href='/posts'>Posts By Author</a>
 Notice that the underscore in `author_id` was replaced by a hyphen. If you wish
 to suppress this behavior, you can set Haml's
 {Haml::Options#hyphenate_data_attrs `:hyphenate_data_attrs` option} to `false`,
 and the output will be rendered as:
-    <a data-author_id='123' href='/posts'>Posts By Author</a>
+    <a data-author_id='123' data-category='7' href='/posts'>Posts By Author</a>
+This expansion of hashes is recursive – any value of the child hash that is
+itself a hash will create an attribute for each entry, with the attribute name
+prefixed with all ancestor keys. For example:
+    .book-info{:data => {:book => {:id => 123, :genre => 'programming'}, :category => 7}}
+will render as:
+    <div class='book-info' data-book-genre='programming' data-book-id='123' data-category='7'></div>
 ### Class and ID: `.` and `#`
@@ -491,28 +521,46 @@ and is compiled to:
       </div>
     </div>
+#### Class Name Merging and Ordering
+Class names are ordered in the following way:
+1) Tag identifiers in order (aka, ".alert.me" => "alert me")
+2) Classes appearing in HTML-style attributes
+3) Classes appearing in Hash-style attributes
+For instance, this is a complicated and unintuitive test case illustrating the ordering
+    .foo.moo{:class => ['bar', 'alpha']}(class='baz')
+The resulting HTML would be as follows:
+    <div class='foo moo baz bar alpha'></div>
+*Versions of Haml prior to 5.0 would alphabetically sort class names.*
 ### Empty (void) Tags: `/`
 The forward slash character, when placed at the end of a tag definition, causes
 Haml to treat it as being an empty (or void) element. Depending on the format,
 the tag will be rendered either without a closing tag (`:html4` or `:html5`), or
-as a self-closing tag (`:xhtml`). For example:
+as a self-closing tag (`:xhtml`).
+Taking the following as an example:
     %br/
     %meta{'http-equiv' => 'Content-Type', :content => 'text/html'}/
-is compiled to:
+When the format is `:html4` or `:html5` this is compiled to:
     <br>
     <meta content='text/html' http-equiv='Content-Type'>
-when the format is `:html4` or `:html5`, and to
+and when the format is `:xhtml` it is compiled to:
     <br />
     <meta content='text/html' http-equiv='Content-Type' />
-when the format is `:xhtml`.
 Some tags are automatically treated as being empty, as long as they have no
 content in the Haml source. `meta`, `img`, `link`, `br`, `hr`, `input`,
 `area`, `param`, `col` and `base` tags are treated as empty by default. This
@@ -779,6 +827,21 @@ is compiled to:
       </a>
     <![endif]-->
+To generate “downlevel-revealed” conditional comments, where the content is
+hidden from IE but not other browsers,  add a `!` before the brackets: `/![]`.
+Haml will produce valid HTML when generating this kind of conditional comment.
+For example:
+    /![if !IE]
+      You are not using Internet Explorer, or are using version 10+.
+is compiled to:
+    <!--[if !IE]><!-->
+      You are not using Internet Explorer, or are using version 10+.
+    <!--<![endif]-->
 ### Haml Comments: `-#`
 The hyphen followed immediately by the pound sign signifies a silent comment.
@@ -812,7 +875,7 @@ is compiled to:
 ## Ruby Evaluation
-### Inserting Ruby: `=`
+### Inserting Ruby: `=` {#inserting_ruby}
 The equals character is followed by Ruby code. This code is evaluated and the
 output is inserted into the document. For example:
@@ -985,6 +1048,21 @@ might compile to:
       //]]>
     </script>
+#### Gotchas
+Haml uses an overly simplistic regular expression to identify string
+interpolation rather than a full-blown Ruby parser. This is fast and works for
+most code but you may have errors with code like the following:
+    %span #{'{'}
+This code will generate a syntax error, complaining about unbalanced brackets.
+In cases like this, the recommended workaround is output the code as a Ruby
+string to force Haml to parse the code with Ruby.
+    %span= "#{'{'}"
 ### Escaping HTML: `&=` {#escaping_html}
 An ampersand followed by one or two equals characters evaluates Ruby code just
@@ -1069,8 +1147,8 @@ is compiled to
       <p>I <strong>really</strong> prefer <em>raspberry</em> jam.</p>
     </div>
-Currently, filters ignore the {Haml::Options#escape_html `:escape_html`} option.
-This means that `#{}` interpolation within filters is never HTML-escaped.
+Note that `#{}` interpolation within filters is HTML-escaped if you specify true to
+{Haml::Options#escape_filter_interpolations `:escape_filter_interpolations`} option.
 The functionality of some filters such as Markdown can be provided by many
 different libraries. Usually you don't have to worry about this - you can just
@@ -1087,53 +1165,53 @@ more info.
 Haml comes with the following filters defined:
-{#cdata-filter}
-### `:cdata`
+### `:cdata` {#cdata-filter}
 Surrounds the filtered text with CDATA tags.
-{#coffee-filter}
-### `:coffee`
-Compiles the filtered text to Javascript using Cofeescript. You can also
-reference this filter as `:coffeescript`. This filter is implemented using
-Tilt.
+### `:coffee` {#coffee-filter}
+Compiles the filtered text to JavaScript in `<script>` tag using CoffeeScript.
+You can also reference this filter as `:coffeescript`. This filter is
+implemented using Tilt.
+### `:css` {#css-filter}
-{#css-filter}
-### `:css`
 Surrounds the filtered text with `<style>` and (optionally) CDATA tags. Useful
 for including inline CSS. Use the {Haml::Options#cdata `:cdata` option} to
 control when CDATA tags are added.
-{#erb-filter}
-### `:erb`
-Parses the filtered text with ERb, like an RHTML template. Not available if the
+### `:erb` {#erb-filter}
+Parses the filtered text with ERB, like an RHTML template. Not available if the
 {Haml::Options#suppress_eval `:suppress_eval`} option is set to true. Embedded
 Ruby code is evaluated in the same context as the Haml template. This filter is
 implemented using Tilt.
-{#escaped-filter}
-### `:escaped`
+### `:escaped` {#escaped-filter}
 Works the same as plain, but HTML-escapes the text
 before placing it in the document.
-{#javascript-filter}
-### `:javascript`
+### `:javascript` {#javascript-filter}
 Surrounds the filtered text with `<script>` and (optionally) CDATA tags.
 Useful for including inline Javascript. Use the {Haml::Options#cdata `:cdata`
 option} to control when CDATA tags are added.
-{#less-filter}
-### `:less`
-Parses the filtered text with [Less](http://lesscss.org/) to produce CSS output.
+### `:less` {#less-filter}
+Parses the filtered text with [Less](http://lesscss.org/) to produce CSS output in `<style>` tag.
 This filter is implemented using Tilt.
-{#markdown-filter}
-### `:markdown`
+### `:markdown` {#markdown-filter}
 Parses the filtered text with
 [Markdown](http://daringfireball.net/projects/markdown). This filter is
 implemented using Tilt.
-{#maruku-filter}
-### `:maruku`
+### `:maruku` {#maruku-filter}
 Parses the filtered text with [Maruku](https://github.com/nex3/maruku), which
 has some non-standard extensions to Markdown.
@@ -1142,39 +1220,40 @@ contrib](https://github.com/haml/haml-contrib) but is loaded automatically for
 historical reasons. In future versions of Haml it will likely not be loaded by
 default. This filter is implemented using Tilt.
-{#plain-filter}
-### `:plain`
+### `:plain` {#plain-filter}
 Does not parse the filtered text. This is useful for large blocks of text
 without HTML tags, when you don't want lines starting with `.` or `-` to be
 parsed.
-{#preserve-filter}
-### `:preserve`
+### `:preserve` {#preserve-filter}
 Inserts the filtered text into the template with whitespace preserved.
 `preserve`d blocks of text aren't indented, and newlines are replaced with the
 HTML escape code for newlines, to preserve nice-looking output. See also
 [Whitespace Preservation](#whitespace_preservation).
-{#ruby-filter}
-### `:ruby`
+### `:ruby` {#ruby-filter}
 Parses the filtered text with the normal Ruby interpreter. Creates an `IO`
 object named `haml_io`, anything written to it is output into the Haml document.
 Not available if the {Haml::Options#suppress_eval `:suppress_eval`} option is
 set to true. The Ruby code is evaluated in the same context as the Haml
 template.
-{#sass-filter}
-### `:sass`
+### `:sass` {#sass-filter}
 Parses the filtered text with [Sass](http://sass-lang.com/) to produce CSS
-output. This filter is implemented using Tilt.
+output in `<style>` tag. This filter is implemented using Tilt.
+### `:scss` {#scss-filter}
-{#scss-filter}
-### `:scss`
 Parses the filtered text with Sass like the `:sass` filter, but uses the newer
-SCSS syntax to produce CSS output. This filter is implemented using Tilt.
+SCSS syntax to produce CSS output in `<style>` tag. This filter is implemented
+using Tilt.
+### `:textile` {#textile-filter}
-{#textile-filter}
-### `:textile`
 Parses the filtered text with [Textile](http://www.textism.com/tools/textile).
 Only works if [RedCloth](http://redcloth.org) is installed.
@@ -1194,8 +1273,8 @@ the whitespace removal methods allow. There are a few helper methods that are
 useful when dealing with inline content. All these methods take a Haml block to
 modify.
-{#surround}
-### surround
+### surround {#surround}
 Surrounds a Haml block with text. Expects 1 or 2 string arguments used to
 surround the Haml block. If a second argument is not provided, the first
 argument is used as the second.
@@ -1203,15 +1282,15 @@ argument is used as the second.
     = surround "(", ")" do
       = link_to "learn more", "#"
-{#precede}
-### precede
+### precede {#precede}
 Prepends a Haml block with text. Expects 1 argument.
     = precede "*" do
       %span Required
-{#succeed}
-### succeed
+### succeed {#succeed}
 Appends a Haml block with text. Expects 1 argument.
     Begin by
@@ -1266,7 +1345,7 @@ that just need a lot of template information.
 So data structures and  functions that require lots of arguments
 can be wrapped over multiple lines,
 as long as each line but the last ends in a comma
-(see [Inserting Ruby](#inserting_ruby_)).
+(see [Inserting Ruby](#inserting_ruby)).
 ## Whitespace Preservation

data/bundle/ruby/2.7.0/gems/haml-5.2.1/TODO ADDED Viewed

@@ -0,0 +1,24 @@
+# -*- mode: org -*-
+#+STARTUP: nofold
+* Documentation
+  Redo tutorial?
+  Using helpers
+    haml_concat and haml_tag in particular
+  Syntax highlighting?
+* Code
+  Keep track of error offsets everywhere
+    Use this to show error location in messages
+** Haml
+   Support finer-grained HTML-escaping in filters
+   Speed
+     Make tags with dynamic attributes pre-render as much as possible
+     Including the attribute name where doable
+   :html improvements
+     Ignore closing tags where we can
+       http://code.google.com/speed/articles/optimizing-html.html
+       Requires Haml parsing refactor
+     Don't quote attributes that don't require it
+       http://www.w3.org/TR/REC-html40/intro/sgmltut.html#h-3.2.2
+       http://www.w3.org/TR/html5/syntax.html#attributes

data/bundle/ruby/2.7.0/gems/haml-5.2.1/haml.gemspec ADDED Viewed

@@ -0,0 +1,45 @@
+($LOAD_PATH << File.expand_path("../lib", __FILE__)).uniq!
+require "haml/version"
+Gem::Specification.new do |spec|
+  spec.name        = 'haml'
+  spec.summary     = "An elegant, structured (X)HTML/XML templating engine."
+  spec.version     = Haml::VERSION
+  spec.authors     = ['Natalie Weizenbaum', 'Hampton Catlin', 'Norman Clarke', 'Akira Matsuda']
+  spec.email       = ['haml@googlegroups.com', 'ronnie@dio.jp']
+  spec.executables = ['haml']
+  spec.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{\Atest/})
+  end
+  spec.homepage    = 'http://haml.info/'
+  spec.license     = "MIT"
+  spec.metadata    = {
+    "bug_tracker_uri"   => "https://github.com/haml/haml/issues",
+    "changelog_uri"     => "https://github.com/haml/haml/blob/main/CHANGELOG.md",
+    "documentation_uri" => "http://haml.info/docs.html",
+    "homepage_uri"      => "http://haml.info",
+    "mailing_list_uri"  => "https://groups.google.com/forum/?fromgroups#!forum/haml",
+    "source_code_uri"   => "https://github.com/haml/haml"
+  }
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'temple', '>= 0.8.0'
+  spec.add_dependency 'tilt'
+  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rbench'
+  spec.add_development_dependency 'minitest', '>= 4.0'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'simplecov'
+  spec.description = <<-END
+Haml (HTML Abstraction Markup Language) is a layer on top of HTML or XML that's
+designed to express the structure of documents in a non-repetitive, elegant, and
+easy way by using indentation rather than closing tags and allowing Ruby to be
+embedded with ease. It was originally envisioned as a plugin for Ruby on Rails,
+but it can function as a stand-alone templating engine.
+END
+end