hamlit 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fe0ea3aa85087eba1b54add820de8b95ce7b3ef
-  data.tar.gz: be61e5714f27e596466db0295800460880f3f35f
+  metadata.gz: 89250564d274169193ab2b990498777705b31cf9
+  data.tar.gz: 154fd04373a7b7d574cb203187bd4c7f21172ab2
 SHA512:
-  metadata.gz: 8484c5952f4de0190805bc466f5e1b7e7540280cda0c1fa49dc611dba99149f3774aa6ad53c55bed1593b2306438eb1511e2625c9f72d360a1abc243744446d6
-  data.tar.gz: d3b8fa05c6c6e9468d44bea6499a67c3e439954c982b600da1f2aab7a70aa0fbf0511f84cafa5f3ef8a6dc47de88470d528646057248f80e904699877c1b3791
+  metadata.gz: 92799f8c4f1bea17c85e5e2911c9430f2193226c3a835deb77acd348b21240eb5bb837351760ae1eeb426312bda7bf8e9c574bd89c7c25585c4dcc9635646a39
+  data.tar.gz: b0381cb98e2987dff4574e707a181bfc97d5261b1e3e071d9f336f2914ab89df2d5a0cf681a94c43d6a5b8b6fe5f467338d0119459db6e3ab5ffdc1e7a59d1e8

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v1.3.0
+
+- Resurrect escape_html option
+  - Still enabled by default
+  - This has been dropped since v0.6.0
+  - https://github.com/k0kubun/hamlit/issues/25
+  - Thanks to @resistorsoftware
+
 ## v1.2.1
 
 - Fix the list of boolean attributes

data/README.md

@@ -49,9 +49,16 @@ Hamlit is used on [githubranking.com](http://githubranking.com/).
 Basically the same as [haml](https://github.com/haml/haml).
 Check out the [reference documentation](http://haml.info/docs/yardoc/file.REFERENCE.html) for details.
 
-### Rails, Sinatra
+### Rails
+Just update Gemfile.
 
-Just update Gemfile. Html escaping is enabled by default.
+### Sinatra
+Update Gemfile. Html escaping is enabled by default.
+If you want to disable it, add following code.
+
+```rb
+set :haml, { escape_html: false }
+```
 
 ## Why high performance?
 ### Less work on runtime

data/lib/hamlit/compilers/attributes.rb

@@ -1,6 +1,7 @@
 require 'hamlit/compilers/new_attribute'
 require 'hamlit/compilers/old_attribute'
 require 'hamlit/compilers/runtime_attribute'
+require 'hamlit/concerns/escapable'
 require 'hamlit/concerns/included'
 
 module Hamlit
@@ -12,6 +13,8 @@ module Hamlit
       include Compilers::RuntimeAttribute
 
       included do
+        include Concerns::Escapable
+
         define_options :format, :attr_quote
       end
 
@@ -38,7 +41,7 @@ module Hamlit
           type, arg = value
           next attr unless name && type && type && arg
 
-          [:html, :attr, name, [:escape, true, value]]
+          [:html, :attr, name, escape_html(value, true)]
         end
       end
 

data/lib/hamlit/compilers/script.rb

@@ -1,11 +1,20 @@
+require 'hamlit/concerns/escapable'
+require 'hamlit/concerns/included'
+
 module Hamlit
   module Compilers
     module Script
+      extend Concerns::Included
+
+      included do
+        include Concerns::Escapable
+      end
+
       def on_haml_script(code, options, *exps)
         variable = result_identifier
 
         assign = [:code, "#{variable} = #{code}"]
-        result = [:escape, true, [:dynamic, variable]]
+        result = escape_html([:dynamic, variable], options[:force_escape])
         result = [:dynamic, variable] if options[:disable_escape]
         [:multi, assign, *exps.map { |exp| compile(exp) }, compile(result)]
       end

data/lib/hamlit/concerns/escapable.rb

@@ -0,0 +1,17 @@
+require 'hamlit/concerns/included'
+
+module Hamlit
+  module Concerns
+    module Escapable
+      extend Included
+
+      included do
+        define_options escape_html: false
+      end
+
+      def escape_html(exp, force_escape = false)
+        [:escape, force_escape || @options[:escape_html], exp]
+      end
+    end
+  end
+end

data/lib/hamlit/engine.rb

@@ -10,6 +10,7 @@ module Hamlit
       generator:   Temple::Generators::ArrayBuffer,
       format:      :html,
       attr_quote:  "'",
+      escape_html: true,
     )
 
     use Parser

data/lib/hamlit/parser.rb

@@ -86,7 +86,7 @@ module Hamlit
       if scanner.scan(/\\/) || scanner.match?(/\#{/)
         return parse_text(scanner)
       elsif scanner.match?(/&=/)
-        return parse_script(scanner)
+        return parse_script(scanner, force_escape: true)
       elsif scanner.match?(/!=/)
         return parse_script(scanner, disable_escape: true)
       elsif scanner.match?(/[.#](\Z|[^a-zA-Z0-9_-])/)

data/lib/hamlit/parsers/script.rb

@@ -1,14 +1,21 @@
+require 'hamlit/concerns/escapable'
 require 'hamlit/concerns/error'
+require 'hamlit/concerns/included'
 require 'hamlit/concerns/indentable'
 
 module Hamlit
   module Parsers
     module Script
+      extend Concerns::Included
       include Concerns::Error
       include Concerns::Indentable
 
       INTERNAL_STATEMENTS    = %w[else elsif when].freeze
-      DEFAULT_SCRIPT_OPTIONS = { disable_escape: false }.freeze
+      DEFAULT_SCRIPT_OPTIONS = { force_escape: false, disable_escape: false }.freeze
+
+      included do
+        include Concerns::Escapable
+      end
 
       def parse_script(scanner, options = {})
         assert_scan!(scanner, /=|&=|!=|~/)
@@ -18,7 +25,7 @@ module Hamlit
         return syntax_error("There's no Ruby code for = to evaluate.") if code.empty? && !with_comment
         unless has_block?
           return [:dynamic, code] if options[:disable_escape]
-          return [:escape, true, [:dynamic, code]]
+          return escape_html([:dynamic, code], options[:force_escape])
         end
 
         ast = [:haml, :script, code, options]

data/lib/hamlit/railtie.rb

@@ -8,6 +8,7 @@ module Hamlit
         Hamlit::Engine,
         generator:   Temple::Generators::RailsOutputBuffer,
         register_as: :haml,
+        escape_html: true,
         streaming:   true,
       )
 

data/lib/hamlit/version.rb

@@ -1,3 +1,3 @@
 module Hamlit
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/Rakefile

@@ -10,23 +10,15 @@ def generate_spec(mode)
 
     # This is a spec converted by haml-spec.
     # See: https://github.com/haml/haml-spec
-    describe "haml #{mode} mode with escape_html" do
+    describe "haml #{mode} mode with ecape_html" do
       DEFAULT_OPTIONS = { ugly: true, escape_html: true }.freeze
 
       def assert_haml(haml, locals, options)
         engine  = Haml::Engine.new(haml, DEFAULT_OPTIONS.merge(options))
-        hamlit  = Hamlit::Template.new(suppress_warnings(options)) { haml }
+        hamlit  = Hamlit::Template.new(options) { haml }
         expect(hamlit.render(Object.new, locals)).to eq(engine.render(Object.new, locals))
       end
 
-      # NOTE: Hamlit only supports escape_html mode.
-      # Thus the option is not supporeted and prints noisy warnings.
-      def suppress_warnings(options)
-        options = options.dup
-        options.delete(:escape_html)
-        options
-      end
-
   SPEC
 
   url = 'https://raw.githubusercontent.com/haml/haml-spec/master/tests.json'

data/spec/hamlit/engine/script_spec.rb

@@ -76,7 +76,7 @@ describe Hamlit::Engine do
     end
 
     it 'renders !=' do
-      assert_render(<<-HAML, <<-HTML)
+      assert_render(<<-HAML, <<-HTML, escape_html: true)
         != '<"&>'
         != '<"&>'.tap do |str|
           -# no operation
@@ -87,7 +87,7 @@ describe Hamlit::Engine do
     end
 
     it 'renders &=' do
-      assert_render(<<-HAML, <<-HTML)
+      assert_render(<<-HAML, <<-HTML, escape_html: false)
         &= '<"&>'
         &= '<"&>'.tap do |str|
           -# no operation

data/spec/hamlit/haml_spec.rb

@@ -2,23 +2,15 @@ require "haml"
 
 # This is a spec converted by haml-spec.
 # See: https://github.com/haml/haml-spec
-describe "haml ugly mode with escape_html" do
+describe "haml ugly mode with ecape_html" do
   DEFAULT_OPTIONS = { ugly: true, escape_html: true }.freeze
 
   def assert_haml(haml, locals, options)
     engine  = Haml::Engine.new(haml, DEFAULT_OPTIONS.merge(options))
-    hamlit  = Hamlit::Template.new(suppress_warnings(options)) { haml }
+    hamlit  = Hamlit::Template.new(options) { haml }
     expect(hamlit.render(Object.new, locals)).to eq(engine.render(Object.new, locals))
   end
 
-  # NOTE: Hamlit only supports escape_html mode.
-  # Thus the option is not supporeted and prints noisy warnings.
-  def suppress_warnings(options)
-    options = options.dup
-    options.delete(:escape_html)
-    options
-  end
-
   context "headers" do
     specify "an XHTML XML prolog" do
       haml    = %q{!!! XML}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -332,6 +332,7 @@ files:
 - lib/hamlit/concerns/balanceable.rb
 - lib/hamlit/concerns/deprecation.rb
 - lib/hamlit/concerns/error.rb
+- lib/hamlit/concerns/escapable.rb
 - lib/hamlit/concerns/included.rb
 - lib/hamlit/concerns/indentable.rb
 - lib/hamlit/concerns/line_reader.rb