haml 4.0.2 → 4.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad1bdf5a3b2dd7640c52431d20dfb27e66abe5c
+  data.tar.gz: 65f0b74296b54a195fc96ee9a38b981a17044d73
+SHA512:
+  metadata.gz: 80b52becc93a09815980961c99e5c8cea42fddd48eb21c6d446f840e1271459bc71f72d21cee9ab05954eb5bbbad21cab5ce3449b73892873880b9407aedeed3
+  data.tar.gz: 18f0b05ebaf47f777b76ee5979d9cb2253be69f0918b797fab8afb22b440275aea29c3e51b1fb02981646665cb29b85377484062c9ce9b5e888092f4ecaafed8

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Haml Changelog
 
+## 4.0.3
+
+Released May 21, 2013 ([diff](https://github.com/haml/haml/compare/4.0.2...4.0.3)).
+
+* Compatibility with newer versions of Rails's Erubis handler.
+* Fix Erubis handler for compatibility with Tilt 1.4.x, too.
+* Small performance optimization for html_escape.
+(thanks [Lachlan Sylvester](https://github.com/lsylvester))
+* Documentation fixes.
+* Documented some helper methods that were left out of the reference.
+(thanks [Shane Riley](https://github.com/shaneriley))
+
 ## 4.0.2
 
 Released April 5, 2013 ([diff](https://github.com/haml/haml/compare/4.0.1...4.0.2)).

data/FAQ.md

@@ -5,9 +5,8 @@
 ### Why is my markup indented properly in development mode, but not in production?
 {#q-indentation-in-production}
 
-To improve performance, Haml defaults to {file:HAML_REFERENCE.md#ugly-option "ugly" mode} in Rails
-apps running in production.
-
+To improve performance, Haml defaults to {Haml::Options#ugly "ugly" mode} in
+Rails apps running in production.
 
 ### How do I put a punctuation mark after an element, like "`I like <strong>cake</strong>!`"?
 {#q-punctuation}
@@ -50,7 +49,7 @@ which Haml does using the {Haml::Helpers#preserve} and {Haml::Helpers#find_and_p
 
 Normally, Haml will do this for you automatically
 when you're using a tag that needs it
-(this can be customized using the {file:HAML_REFERENCE.md#preserve-option `:preserve`} option.
+(this can be customized using the {Haml::Options#preserve `:preserve`} option).
 For example,
 
     %p

data/REFERENCE.md

@@ -514,9 +514,10 @@ when the format is `:html4` or `:html5`, and to
 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`, `script`, `br`, and `hr` tags
-are treated as empty by default. This list can be customized by setting the
-{Haml::Options#autoclose `:autoclose`} option.
+content in the Haml source. `meta`, `img`, `link`, `br`, `hr`, `input`,
+`area`, `param`, `col` and `base` tags are treated as empty by default. This
+list can be customized by setting the {Haml::Options#autoclose `:autoclose`}
+option.
 
 ### Whitespace Removal: `>` and `<`
 
@@ -1179,6 +1180,42 @@ default. This filter is implemented using Tilt.
 
 You can also define your own filters. See {Haml::Filters} for details.
 
+## Helper Methods {#helper-methods}
+
+Sometimes you need to manipulate whitespace in a more precise fashion than what
+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
+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.
+
+    = surround "(", ")" do
+      = link_to "learn more", "#"
+
+{#precede}
+### precede
+Prepends a Haml block with text. Expects 1 argument.
+
+    = precede "*" do
+      %span Required
+
+{#succeed}
+### succeed
+Appends a Haml block with text. Expects 1 argument.
+
+    Begin by
+    = succeed "," do
+      = link_to "filling out your profile", "#"
+    = succeed "," do
+      = link_to "adding a bio", "#"
+    and
+    = succeed "." do
+      = link_to "inviting friends", "#"
+
 ## Multiline: `|` {#multiline}
 
 The pipe character designates a multiline string.

data/lib/haml/helpers.rb

@@ -527,38 +527,52 @@ MESSAGE
     # Characters that need to be escaped to HTML entities from user input
     HTML_ESCAPE = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
 
-    # Returns a copy of `text` with ampersands, angle brackets and quotes
-    # escaped into HTML entities.
-    #
-    # Note that if ActionView is loaded and XSS protection is enabled
-    # (as is the default for Rails 3.0+, and optional for version 2.3.5+),
-    # this won't escape text declared as "safe".
-    #
-    # @param text [String] The string to sanitize
-    # @return [String] The sanitized string
-    def html_escape(text)
-      pattern = '[\"><&]'
-      regex = if RUBY_VERSION >= '1.9'
-        Regexp.new(pattern.force_encoding(text.encoding), Regexp::FIXEDENCODING)
-      else
-        Regexp.new(pattern)
+    HTML_ESCAPE_REGEX = /[\"><&]/
+
+    if RUBY_VERSION >= '1.9'
+      # Include docs here so they are picked up by Yard
+
+      # Returns a copy of `text` with ampersands, angle brackets and quotes
+      # escaped into HTML entities.
+      #
+      # Note that if ActionView is loaded and XSS protection is enabled
+      # (as is the default for Rails 3.0+, and optional for version 2.3.5+),
+      # this won't escape text declared as "safe".
+      #
+      # @param text [String] The string to sanitize
+      # @return [String] The sanitized string
+      def html_escape(text)
+        text = text.to_s
+        text.gsub(HTML_ESCAPE_REGEX, HTML_ESCAPE)
+      end
+    else
+      def html_escape(text)
+        text = text.to_s
+        text.gsub(HTML_ESCAPE_REGEX) {|s| HTML_ESCAPE[s]}
       end
-      text.to_s.gsub(regex) {|s| HTML_ESCAPE[s]}
     end
 
-    # Escapes HTML entities in `text`, but without escaping an ampersand
-    # that is already part of an escaped entity.
-    #
-    # @param text [String] The string to sanitize
-    # @return [String] The sanitized string
-    def escape_once(text)
-      pattern = '[\"><]|&(?!(?:[a-zA-Z]+|(#\d+));)'
-      regex = if RUBY_VERSION >= '1.9'
-        Regexp.new(pattern.force_encoding(text.encoding), Regexp::FIXEDENCODING)
-      else
-        Regexp.new(pattern)
+    HTML_ESCAPE_ONCE_REGEX = /[\"><]|&(?!(?:[a-zA-Z]+|(#\d+));)/
+
+    if RUBY_VERSION >= '1.9'
+      # Include docs here so they are picked up by Yard
+
+      # Escapes HTML entities in `text`, but without escaping an ampersand
+      # that is already part of an escaped entity.
+      #
+      # @param text [String] The string to sanitize
+      # @return [String] The sanitized string
+      def escape_once(text)
+        text = text.to_s
+        text.gsub!(HTML_ESCAPE_ONCE_REGEX, HTML_ESCAPE)
+        text
+      end
+    else
+      def escape_once(text)
+        text = text.to_s
+        text.gsub!(HTML_ESCAPE_ONCE_REGEX){|s| HTML_ESCAPE[s]}
+        text
       end
-      text.to_s.gsub(regex) {|s| HTML_ESCAPE[s]}
     end
 
     # Returns whether or not the current template is a Haml template.

data/lib/haml/helpers/safe_erubis_template.rb

@@ -1,20 +1,29 @@
 module Haml
+
+  class ErubisTemplateHandler < ActionView::Template::Handlers::Erubis
+
+    def initialize(*args, &blk)
+      @newline_pending = 0
+      super
+    end
+  end
+
   class SafeErubisTemplate < Tilt::ErubisTemplate
 
     def initialize_engine
     end
 
     def prepare
-      @options.merge! :engine_class => ActionView::Template::Handlers::Erubis
+      @options.merge! :engine_class => Haml::ErubisTemplateHandler
       super
     end
 
     def precompiled_preamble(locals)
-      [super, "@output_buffer = ActionView::OutputBuffer.new;"]
+      [super, "@output_buffer = ActionView::OutputBuffer.new;"].join("\n")
     end
 
     def precompiled_postamble(locals)
-      [super, '@output_buffer.to_s']
+      [super, '@output_buffer.to_s'].join("\n")
     end
   end
 end

data/lib/haml/version.rb

@@ -1,3 +1,3 @@
 module Haml
-  VERSION = "4.0.2"
+  VERSION = "4.0.3"
 end

data/test/gemfiles/Gemfile.rails-3.2.x.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: /Users/norman/work/haml
+  specs:
+    haml (4.0.3)
+      tilt
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    minitest (4.7.4)
+    multi_json (1.7.3)
+    nokogiri (1.5.9)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rbench (0.2.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml!
+  minitest
+  nokogiri
+  rails (>= 3.2.0, < 3.3.0)
+  rbench

data/test/gemfiles/Gemfile.rails-4.0.x

@@ -1,5 +1,5 @@
 source "http://rubygems.org"
 
 gem 'bundler', '~> 1.3.0'
-gem 'rails', '~> 4.0.0.beta.1'
+gem 'rails', '~> 4.0.0.rc1'
 gemspec :path => '../..'

data/test/gemfiles/Gemfile.rails-4.0.x.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: ../../..
+  specs:
+    rails (4.0.0.beta1)
+      actionmailer (= 4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activerecord (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.beta1)
+      sprockets-rails (~> 2.0.0.rc4)
+
+PATH
+  remote: /Users/norman/work/haml
+  specs:
+    haml (4.0.3)
+      tilt
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.beta1)
+      activemodel (= 4.0.0.beta1)
+      activerecord-deprecated_finders (~> 0.0.3)
+      activesupport (= 4.0.0.beta1)
+      arel (~> 4.0.0.beta1)
+    activerecord-deprecated_finders (0.0.3)
+    activesupport (4.0.0.beta1)
+      i18n (~> 0.6.2)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.33)
+    arel (4.0.0)
+    atomic (1.1.9)
+    builder (3.1.4)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    minitest (4.7.4)
+    multi_json (1.7.3)
+    nokogiri (1.5.9)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.17.0, < 2.0)
+    rake (10.0.4)
+    rbench (0.2.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.9.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0.rc4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.0)
+  haml!
+  minitest
+  nokogiri
+  rails (~> 4.0.0.beta1)!
+  rbench

data/test/helper_test.rb

@@ -497,6 +497,14 @@ HAML
     assert_equal "&quot;&gt;&lt;&amp;", Haml::Helpers.html_escape('"><&')
   end
 
+  def test_html_escape_should_work_on_frozen_strings
+    begin
+      assert Haml::Helpers.html_escape('foo'.freeze)
+    rescue => e
+      flunk e.message
+    end
+  end
+
   def test_html_escape_encoding
     old_stderr, $stderr = $stderr, StringIO.new
     string = "\"><&\u00e9" # if you're curious, u00e9 is "LATIN SMALL LETTER E WITH ACUTE"
@@ -506,6 +514,11 @@ HAML
     $stderr = old_stderr
   end
 
+  def test_html_escape_non_string
+    assert_equal('4.58', Haml::Helpers.html_escape(4.58))
+    assert_equal('4.58', Haml::Helpers.html_escape_without_haml_xss(4.58))
+  end
+
   def test_escape_once
     assert_equal "&quot;&gt;&lt;&amp;", Haml::Helpers.escape_once('"><&')
   end

data/test/template_test.rb

@@ -111,7 +111,7 @@ class TemplateTest < MiniTest::Unit::TestCase
   end
 
   TEMPLATES.each do |template|
-    define_method "test_template_should_render_correctly [template: #{template}] " do
+    define_method "test_template_should_render_correctly [template: #{template}]" do
       assert_renders_correctly template
     end
   end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Nathan Weizenbaum
@@ -11,100 +10,84 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: tilt
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: rails
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: rbench
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rbench
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: minitest
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: nokogiri
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Haml (HTML Abstraction Markup Language) is a layer on top of HTML
-  or XML that''s
-
+description: |
+  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.
-
-'
 email:
 - haml@googlegroups.com
 - norman@njclarke.com
@@ -145,7 +128,9 @@ files:
 - test/gemfiles/Gemfile.rails-3.0.x
 - test/gemfiles/Gemfile.rails-3.1.x
 - test/gemfiles/Gemfile.rails-3.2.x
+- test/gemfiles/Gemfile.rails-3.2.x.lock
 - test/gemfiles/Gemfile.rails-4.0.x
+- test/gemfiles/Gemfile.rails-4.0.x.lock
 - test/helper_test.rb
 - test/markaby/standard.mab
 - test/mocks/article.rb
@@ -213,53 +198,41 @@ files:
 homepage: http://haml.info/
 licenses:
 - MIT
-post_install_message: ! '
+metadata: {}
+post_install_message: |2+
 
   HEADS UP! Haml 4.0 has many improvements, but also has changes that may break
-
   your application:
 
-
   * Support for Ruby 1.8.6 dropped
-
   * Support for Rails 2 dropped
-
   * Sass filter now always outputs <style> tags
-
   * Data attributes are now hyphenated, not underscored
-
   * html2haml utility moved to the html2haml gem
-
   * Textile and Maruku filters moved to the haml-contrib gem
 
-
   For more info see:
 
-
   http://rubydoc.info/github/haml/haml/file/CHANGELOG.md
 
-
-'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An elegant, structured (X)HTML/XML templating engine.
 test_files:
 - test/engine_test.rb