hamlit 2.9.1-java

data/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in hamlit.gemspec
+gemspec
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
+  gem 'rack', '< 2'
+end
+
+gem 'benchmark-ips', '2.3.0'
+gem 'maxitest'
+
+if /java/ === RUBY_PLATFORM # JRuby
+  gem 'pandoc-ruby'
+else
+  gem 'pry-byebug'
+  gem 'redcarpet', github: 'vmg/redcarpet' # To resolve circular require warning
+
+  if RUBY_PLATFORM !~ /mswin|mingw/
+    gem 'faml'
+    gem 'stackprof'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,44 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Takashi Kokubun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+lib/hamlit/parser/*.rb and test/haml/* are:
+
+Copyright (c) 2006-2009 Hampton Catlin and Natalie Weizenbaum
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Hamlit
+
+[![Gem Version](https://badge.fury.io/rb/hamlit.svg)](http://badge.fury.io/rb/hamlit)
+[![Build Status](https://travis-ci.org/k0kubun/hamlit.svg?branch=master)](https://travis-ci.org/k0kubun/hamlit)
+
+Hamlit is a high performance [Haml](https://github.com/haml/haml) implementation.
+
+## Introduction
+
+### What is Hamlit?
+Hamlit is another implementation of [Haml](https://github.com/haml/haml).
+With some [limitations](REFERENCE.md#limitations) by design for performance,
+Hamlit is **2.39x times faster** than original haml gem in [this benchmark](benchmark/slim/run-benchmarks.rb),
+which is an HTML-escaped version of [slim-template/slim's one](https://github.com/slim-template/slim/blob/v3.0.8/benchmarks/run-benchmarks.rb) for fairness. ([Result on Travis](https://travis-ci.org/k0kubun/hamlit/jobs/236567391))
+
+<img src="https://i.gyazo.com/0f0c0362b6bd69f82715bec1d8caa191.png" width="600px" alt="Hamlit Benchmark"/>
+
+```
+       hamlit v2.8.1:   131048.9 i/s
+        erubi v1.6.0:   125445.4 i/s - 1.04x slower
+         slim v3.0.8:   121390.4 i/s - 1.08x slower
+         faml v0.8.1:   100750.5 i/s - 1.30x slower
+         haml v5.0.1:    54882.6 i/s - 2.39x slower
+```
+
+### Why is Hamlit faster?
+
+#### Less string concatenation by design
+As written in [limitations](REFERENCE.md#limitations), Hamlit drops some not-so-important features which require
+works on runtime. With the optimized language design, we can reduce the string concatenation
+to build attributes.
+
+#### Static analyzer
+Hamlit analyzes Ruby expressions with Ripper and render it on compilation if the expression
+is static. And Hamlit can also compile string literal with string interpolation to reduce
+string allocation and concatenation on runtime.
+
+#### C extension to build attributes
+While Hamlit has static analyzer and static attributes are rendered on compilation,
+dynamic attributes must be rendered on runtime. So Hamlit optimizes rendering on runtime
+with C extension.
+
+## Usage
+
+Hamlit currently supports Ruby 2.1 and higher. See [REFERENCE.md](REFERENCE.md) for detail features of Hamlit.
+
+### Rails
+
+Add this line to your application's Gemfile or just replace `gem "haml"` with `gem "hamlit"`.
+It enables rendering by Hamlit for \*.haml automatically.
+
+```rb
+gem 'hamlit'
+```
+
+If you want to use view generator, consider using [hamlit-rails](https://github.com/mfung/hamlit-rails).
+
+### Sinatra
+
+Replace `gem "haml"` with `gem "hamlit"` in Gemfile, and require "hamlit".
+
+While Haml disables `escape_html` option by default, Hamlit enables it for security.
+If you want to disable it, please write:
+
+```rb
+set :haml, { escape_html: false }
+```
+
+
+## Command line interface
+
+You can see compiled code or rendering result with "hamlit" command.
+
+```bash
+$ gem install hamlit
+$ hamlit --help
+Commands:
+  hamlit compile HAML    # Show compile result
+  hamlit help [COMMAND]  # Describe available commands or one specific command
+  hamlit parse HAML      # Show parse result
+  hamlit render HAML     # Render haml template
+  hamlit temple HAML     # Show temple intermediate expression
+
+$ cat in.haml
+- user_id = 123
+%a{ href: "/users/#{user_id}" }
+
+# Show compiled code
+$ hamlit compile in.haml
+_buf = [];  user_id = 123;
+; _buf << ("<a href='/users/".freeze); _buf << (::Hamlit::Utils.escape_html((user_id))); _buf << ("'></a>\n".freeze); _buf = _buf.join
+
+# Render html
+$ hamlit render in.haml
+<a href='/users/123'></a>
+```
+
+## Contributing
+
+### Test latest version
+
+```rb
+# Gemfile
+gem 'hamlit', github: 'k0kubun/hamlit', submodules: true
+```
+
+### Development
+
+Contributions are welcomed. It'd be good to see
+[Temple's EXPRESSIONS.md](https://github.com/judofyr/temple/blob/v0.7.6/EXPRESSIONS.md)
+to learn Temple which is a template engine framework used in Hamlit.
+
+```bash
+$ git clone --recursive https://github.com/k0kubun/hamlit
+$ cd hamlit
+$ bundle install
+
+# Run all tests
+$ bundle exec rake test
+
+# Run one test
+$ bundle exec ruby -Ilib:test -rtest_helper test/hamlit/line_number_test.rb -l 12
+
+# Show compiling/rendering result of some template
+$ bundle exec exe/hamlit compile in.haml
+$ bundle exec exe/hamlit render in.haml
+
+# Use rails app to debug Hamlit
+$ cd sample/rails
+$ bundle install
+$ bundle exec rails s
+```
+
+### Reporting an issue
+
+Please report an issue with following information:
+
+- Full error backtrace
+- Haml template
+- Ruby version
+- Hamlit version
+- Rails/Sinatra version
+
+## License
+
+Copyright (c) 2015 Takashi Kokubun

data/REFERENCE.md

@@ -0,0 +1,266 @@
+# Hamlit
+
+Basically Hamlit is the same as Haml.
+See [Haml's tutorial](http://haml.info/tutorial.html) if you are not familiar with Haml's syntax.
+
+[REFERENCE - Haml Documentation](http://haml.info/docs/yardoc/file.REFERENCE.html)
+
+## Supported features
+
+See [Haml's reference](http://haml.info/docs/yardoc/file.REFERENCE.html)
+for full features in original implementation.
+
+- [ ] Using Haml
+  - [x] Rails XSS Protection
+  - [x] Ruby Module
+  - [x] Options
+  - [ ] Encodings
+- [x] Plain Text
+  - [x] Escaping: \
+- [ ] HTML Elements
+  - [x] Element Name: %
+  - [ ] Attributes: `
+     - [x] :class and :id Attributes
+     - [x] HTML-style Attributes: ()
+     - [x] Ruby 1.9-style Hashes
+     - [ ] Attribute Methods
+     - [x] Boolean Attributes
+     - [x] HTML5 Custom Data Attributes
+  - [x] Class and ID: . and #
+     - Implicit Div Elements
+  - [x] Empty (void) Tags: /
+  - [x] Whitespace Removal: > and <
+  - [x] Object Reference: []
+- [x] Doctype: !!!
+- [x] Comments
+  - [x] HTML Comments: /
+     - [x] Conditional Comments: /[]
+  - [x] Haml Comments: -#
+- [x] Ruby Evaluation
+  - [x] Inserting Ruby: =
+  - [x] Running Ruby: -
+     - [x] Ruby Blocks
+  - [x] Whitespace Preservation: ~
+  - [x] Ruby Interpolation: #{}
+  - [x] Escaping HTML: &=
+  - [x] Unescaping HTML: !=
+- [ ] Filters
+  - [x] :cdata
+  - [x] :coffee
+  - [x] :css
+  - [x] :erb
+  - [x] :escaped
+  - [x] :javascript
+  - [x] :less
+  - [x] :markdown
+  - [ ] :maruku
+  - [x] :plain
+  - [x] :preserve
+  - [x] :ruby
+  - [x] :sass
+  - [x] :scss
+  - [ ] :textile
+  - [ ] Custom Filters
+- [x] Helper Methods
+  - [x] preserve
+  - [x] surround
+  - [x] precede
+  - [x] succeed
+- [x] Multiline: |
+- [x] Whitespace Preservation
+- [ ] Helpers
+
+
+## Limitations
+
+### No Haml buffer
+Hamlit uses `Array` as buffer for performance. So you can't touch Haml::Buffer from template when using Hamlit.
+
+### Haml helpers are still in development
+At the same time, because some methods in `Haml::Helpers` require `Haml::Buffer`, they are not supported now.
+But some helpers are supported on Rails. Some of not-implemented methods are planned to be supported.
+
+### Limited attributes hyphenation
+In Haml, `%a{ foo: { bar: 'baz' } }` is rendered as `<a foo-bar='baz'></a>`, whatever foo is.
+In Hamlit, this feature is supported only for aria and data attribute. Hamlit renders `%a{ data: { foo: 'bar' } }`
+as `<a data-foo='bar'></a>` because it's data attribute. This design allows us to reduce work on runtime
+and the idea is originally in [Faml](https://github.com/eagletmt/faml).
+
+### Limited boolean attributes
+In Haml, `%a{ foo: false }` is rendered as `<a></a>`, whatever `foo` is.
+In Hamlit, this feature is supported for only boolean attributes, which are defined by
+http://www.w3.org/TR/xhtml1/guidelines.html or https://html.spec.whatwg.org/.
+The list is the same as `ActionView::Helpers::TagHelper::BOOLEAN_ATTRIBUTES`.
+In addition, aria-\* and data-\* is also regarded as boolean.
+
+Since `foo` is not boolean attribute, `%a{ foo: false }` is rendered as `<a foo='false'></a>`
+This is the same behavior as Rails helpers. Also for `%a{ foo: nil }`,
+Hamlit does not remove non-boolean attributes and render `<a foo=''></a>`
+(`foo` is not removed). This design allows us to reduce string concatenation and
+is the only difference between Faml and Hamlit.
+
+## 5 Types of Attributes
+
+Haml has 3 types of attributes: id, class and others.
+In addition, Hamlit treats aria/data and boolean attributes specially.
+So there are 5 types of attributes in Hamlit.
+
+### id attribute
+Almost the same behavior as Haml, except no hyphenation and boolean support.
+Arrays are flattened, falsey values are removed (but attribute itself is not removed)
+and merging multiple ids results in concatenation by "\_".
+
+```rb
+# Input
+#foo{ id: 'bar' }
+%div{ id: %w[foo bar] }
+%div{ id: ['foo', false, ['bar', nil]] }
+%div{ id: false }
+
+# Output
+<div id='foo_bar'></span>
+<div id='foo_bar'></span>
+<div id='foo_bar'></span>
+<div id=''></span>
+```
+
+### class attribute
+Almost the same behavior as Haml, except no hyphenation and boolean support.
+Arrays are flattened, falsey values are removed (but attribute itself is not removed)
+and merging multiple classes results in unique alphabetical sort.
+
+```rb
+# Input
+.d.a(class='b c'){ class: 'c a' }
+%div{ class: 'd c b a' }
+%div{ class: ['d', nil, 'c', [false, 'b', 'a']] }
+%div{ class: false }
+
+# Output
+<div class='a b c d'></div>
+<div class='d c b a'></div>
+<div class='d c b a'></div>
+<div class=''></div>
+```
+
+### aria / data attribute
+Completely compatible with Haml, hyphenation and boolean are supported.
+
+```rb
+# Input
+%div{ data: { disabled: true } }
+%div{ data: { foo: 'bar' } }
+
+# Output
+<div data-disabled></div>
+<div data-foo='bar'></div>
+```
+
+aria attribute works in the same way as data attribute.
+
+### boolean attributes
+No hyphenation but complete boolean support.
+
+```rb
+# Input
+%div{ disabled: 'foo' }
+%div{ disabled: true }
+%div{ disabled: false }
+
+# Output
+<div disabled='foo'></div>
+<div disabled></div>
+<div></div>
+```
+
+List of boolean attributes is:
+
+```
+disabled readonly multiple checked autobuffer autoplay controls loop selected hidden scoped async
+defer reversed ismap seamless muted required autofocus novalidate formnovalidate open pubdate
+itemscope allowfullscreen default inert sortable truespeed typemustmatch
+```
+
+"data-\*" is also regarded as boolean.
+
+### other attributes
+No hyphenation and boolean support. `false` is rendered as "false" (like Rails helpers).
+
+```rb
+# Input
+%input{ value: true }
+%input{ value: false }
+
+# Output
+<input value='true'>
+<input value='false'>
+```
+
+## Engine options
+
+| Option | Default | Feature |
+|:-------|:--------|:--------|
+| escape\_html | true | HTML-escape for Ruby script and interpolation. This is false in Haml. |
+| escape\_attrs | true | HTML-escape for Html attributes. |
+| format | :html | You can set :xhtml to change boolean attribute's format. |
+| attr\_quote | `'` | You can change attribute's wrapper to `"` or something. |
+
+### Set options for Rails
+
+```rb
+# config/initializers/hamlit.rb or somewhere
+Hamlit::RailsTemplate.set_options attr_quote: '"'
+```
+
+### Set options for Sinatra
+
+```rb
+set :haml, { attr_quote: '"' }
+```
+
+## Creating a custom filter
+
+Currently it doesn't have filter registering interface compatible with Haml.
+But you can easily define and register a filter using Tilt like this.
+
+```rb
+module Hamlit
+  class Filters
+    class Es6 < TiltBase
+      def compile(node)
+        # branch with `@format` here if you want
+        compile_html(node)
+      end
+
+      private
+
+      def compile_html(node)
+        temple = [:multi]
+        temple << [:static, "<script>\n"]
+        temple << compile_with_tilt(node, 'es6', indent_width: 2)
+        temple << [:static, "\n</script>"]
+        temple
+      end
+    end
+
+    register :es6, Es6
+  end
+end
+```
+
+After requiring the script, you can do:
+
+```haml
+:es6
+  const a = 1;
+```
+
+and it's rendered as:
+
+```html
+<script>
+  "use strict";
+
+  var a = 1;
+</script>
+```