himl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6bf41980a84e9ae83b46f6bc7066ae6b8e8eacbd52ad8df5da3fbb3a23d9617
+  data.tar.gz: aa083fd9b6d315151b4549e9de289a0c5a31d4c199e697482dcb3ce475aac9b1
+SHA512:
+  metadata.gz: 79df19e4b753f89b853457026a9065f63a02272745056e65b2e93d01fc5fb3b5a228254ff74b0902f3c9f451db3407fd00191a0372c5c49348f562de77fe9781
+  data.tar.gz: fe1df061276d7696d73bb15356500cf17980976510eeda51a564508f9abc4adf10e665c9d6565960d2c8cad3ac70fbc2c866d3f746b1c50945c3400a82df1652

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.byebug_history

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in himl.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Akira Matsuda
+
+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,195 @@
+# Himl
+
+Himl is an HTML-based Indented Markup Language for Ruby.
+
+
+## What's This?
+
+Himl is a yet another template engine for Haml-lovers and non Haml lovers, deriving HTML validity from Haml and syntax intuitiveness from ERB.
+
+
+## Motivation
+
+Haml is a great template engine that liberates us from annoying HTML bugs.
+By automatically closing the HTML tags, Haml always produces perfectly structured 100% valid HTML responses.
+Actually, I've never experienced the HTML closing tag mismatch error over the past 10 years or so, thanks to Haml.
+
+However, the Haml (or Slim or whatever equivalent) syntax is very much different from that of HTML.
+And to be honest, I still rarely can complete my template markup works without consulting the Haml online reference manual.
+
+Oh, why do we have to learn another markup language syntax where we just want to generate HTML documents?
+HTML has tags. HTML has indentations. Why can't we just use them?
+
+
+## Syntax
+
+Himl syntax is a hybrid of ERB and Haml.
+Himl is besically just a kind of ERB. Indeed, Himl documents are compiled to ERB internally, then rendered by the ERB handler.
+
+So, the following Himl template opening and closing a tag will be compiled to exactly the same ERB template.
+
+Himl
+```erb
+<div>
+</div>
+```
+
+ERB
+```erb
+<div>
+</div>
+```
+
+You can omit closing tags. Then Himl auto-closes them, just like Haml does.
+
+Himl
+```erb
+<div>
+```
+ERB
+```erb
+<div>
+</div>
+```
+
+For nesting tags, use whitespaces just like you do in the Haml templates.
+
+Himl
+```erb
+<section>
+  <div>
+```
+
+ERB
+```erb
+<section>
+  <div>
+  </div>
+</section>
+```
+
+Of course you can include dynamic Ruby code in the ERB way.
+
+Himl
+```erb
+<section>
+  <div>
+    <%= post.content %>
+```
+
+ERB
+```erb
+<section>
+  <div>
+    <%= post.content %>
+  </div>
+</section>
+```
+
+You can open and close tags in the same line.
+
+Himl
+```erb
+<section>
+  <h1><%= post.title %></h1>
+```
+
+ERB
+```erb
+<section>
+  <h1><%= post.title %></h1>
+</section>
+```
+
+There's no special syntax for adding HTML attributes to the tags. You see, it's just ERB.
+
+Himl
+```erb
+<section class="container">
+  <div class="content">
+```
+
+ERB
+```erb
+<section class="container">
+  <div class="content">
+  </div>
+</section>
+```
+
+
+## Example
+
+Following is a comparison of ERB, Haml, and Himl templates that renderes similar HTML results (the Haml example is taken from the [Haml documentation](http://haml.info/)).
+You'll notice that Himl consumes the same LOC with the Haml version for expressing the structure of this document, without introducing any new syntax from the ERB version.
+
+### ERB Template
+```erb
+<section class="container">
+  <h1><%= post.title %></h1>
+  <h2><%= post.subtitle %></h2>
+  <div class="content">
+    <%= post.content %>
+  </div>
+</section>
+
+```
+
+### Haml Template
+```haml
+%section.container
+  %h1= post.title
+  %h2= post.subtitle
+  .content
+    = post.content
+```
+
+### Himl Template
+```erb
+<section class="container">
+  <h1><%= post.title %></h1>
+  <h2><%= post.subtitle %></h2>
+  <div class="content">
+    <%= post.content %>
+```
+
+
+## Installation
+
+Bundle 'himl' gem to your project.
+
+
+## Usage
+
+The gem contains the Himl template handler for Rails.
+You need no extra configurations for your Rails app to render `*.himl` templates.
+
+
+## Runtime Performance
+
+Since every Himl template is converted to ERB, then cached as a Ruby method inside the view frameworks (such as Action View in Rails), Himl runtime performance in production is exactly the same with that of ERB.
+
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/himl.
+
+
+## Other Template Engines That I Maintain
+
+### [jb](https://github.com/amatsuda/jb)
+
+A faster and simpler and stronger alternative to Jbuilder.
+
+### [string_template](https://github.com/amatsuda/string_template)
+
+The ultimate fastest template engine for Rails in the world.
+
+### [Haml](https://github.com/haml/haml)
+
+The one that you may be currently using everyday.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "himl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/himl.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "himl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "himl"
+  spec.version       = Himl::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'HTML-based Indented Markup Language'
+  spec.description   = 'HTML + ERB + Haml = Himl'
+  spec.homepage      = 'https://github.com/amatsuda/himl'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'byebug'
+end

data/lib/himl.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'himl/version'
+require_relative 'himl/parser'
+require_relative 'himl/railtie'

data/lib/himl/handler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Himl
+  class Handler
+    ERB_HANDLER = ActionView::Template.handler_for_extension('erb')
+
+    def self.call(template, source = nil)
+      new.call(template, source || template.source)
+    end
+
+    def call(template, source)
+      parser = Himl::Parser.new
+      parser.call(source)
+      erb = parser.to_erb
+
+      escape = ERB_HANDLER.respond_to?(:escape_ignore_list) ? ERB_HANDLER.escape_ignore_list.include?(template.type) : ERB_HANDLER.escape_whitelist.include?(template.type)
+
+      ERB_HANDLER.erb_implementation.new(
+        erb,
+        escape: escape,
+        trim: (ERB_HANDLER.erb_trim_mode == "-")
+      ).src
+    end
+  end
+end

data/lib/himl/parser.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Himl
+  class Parser
+    class Document < Nokogiri::XML::SAX::Document
+      Tag = Struct.new(:name, :indentation, :line, :block_end) do
+        def end_tag
+          if has_block?
+            "#{' ' * indentation}<% #{block_end} %>\n"
+          else
+            "#{' ' * indentation}</#{name}>\n"
+          end
+        end
+
+        def erb_tag?
+          name == ERB_TAG
+        end
+
+        def has_block?
+          block_end
+        end
+
+        def block_start=(start)
+          self.block_end = case start
+          when 'do'
+            'end'
+          when '{'
+            '}'
+          end
+        end
+      end
+
+      ErbEndMarker = Class.new(Tag)
+      ErbBlockStartMarker = Class.new(Tag)
+
+      ROOT_NODE = 'THE_HIML_ROOT_NODE'
+      ERB_TAG = 'HIML_ERB_TAG'
+      ERB_TAG_REGEXP = /<%(?:=|==|-|#|%)?(.*?)(?:[-=])?%>/
+      BLOCK_REGEXP = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
+      VOID_TAGS = %w(area base br col command embed hr img input keygen link meta param source track wbr).freeze  # https://www.w3.org/TR/2011/WD-html-markup-20110113/syntax.html#syntax-elements
+
+      # Copied from Haml
+      MID_BLOCK_KEYWORDS = %w[else elsif rescue ensure end when]
+      START_BLOCK_KEYWORDS = %w[if begin case unless]
+      START_BLOCK_KEYWORD_REGEX = /(?:\w+(?:,\s*\w+)*\s*=\s*)?(#{START_BLOCK_KEYWORDS.join('|')})/
+      BLOCK_KEYWORD_REGEX = /^-?\s*(?:(#{MID_BLOCK_KEYWORDS.join('|')})|#{START_BLOCK_KEYWORD_REGEX.source})\b/
+
+      attr_accessor :context
+
+      def initialize(template)
+        @original_template, @tags, @end_tags = template, [], []
+        template = template.gsub(ERB_TAG_REGEXP, "<#{ERB_TAG}>\\1</#{ERB_TAG}>")
+        @lines = "<#{ROOT_NODE}>\n#{template}</#{ROOT_NODE}>\n".lines
+      end
+
+      def template
+        @lines.join
+      end
+
+      def erb_template
+        lines = @original_template.lines
+
+        @end_tags.reverse_each do |index, tag|
+          lines.insert index - 1, tag
+        end
+
+        lines.join
+      end
+
+      def start_element(name, *)
+        @current_tag = name
+
+        close_tags unless name == ROOT_NODE
+
+        @tags << Tag.new(name, current_indentation, current_line) unless VOID_TAGS.include? name.downcase
+      end
+
+      def end_element(name)
+        last_tag = @tags.last
+        return if last_tag.name == ROOT_NODE
+
+        if (name == ERB_TAG) && last_tag.is_a?(ErbEndMarker)
+          raise SyntaxError "end of block indentation mismatch at line: #{current_line}, column: #{current_indentation}" if last_tag.indentation != @tags[-2].indentation
+
+          @tags.pop
+          @tags.pop
+        end
+
+        if name == last_tag.name
+          if ((last_tag.indentation == current_indentation) || (last_tag.line == current_line))
+            @tags.pop
+          else
+            raise SyntaxError, "end tag indentation mismatch for <#{name}> at line: #{current_line}, column: #{current_indentation}"
+          end
+        end
+        @tags << ErbBlockStartMarker.new(nil, last_tag.indentation, last_tag.line, last_tag.block_end) if (last_tag.name == ERB_TAG) && last_tag.has_block?
+      end
+
+      def characters(string)
+        if (last_tag = @tags.last).erb_tag?
+          case string.strip
+          when 'end', '}'
+            @tags.pop
+            @tags << ErbEndMarker.new(nil, last_tag.indentation, last_tag.line)
+          when BLOCK_KEYWORD_REGEX
+            @tags.pop
+            @tags.pop if (ErbBlockStartMarker === @tags.last) && (@tags.last.indentation == last_tag.indentation)
+            @tags << ErbBlockStartMarker.new(nil, last_tag.indentation, last_tag.line, 'end')
+          end
+        end
+
+        erb_tag = @tags.reverse_each.detect(&:erb_tag?)
+        if erb_tag && (match = BLOCK_REGEXP.match(string))
+          erb_tag.block_start = match[1].strip
+        end
+      end
+
+      def close_document!
+        @current_tag = nil
+        close_tags
+
+        raise SyntaxError, "Unclosed tag: #{@tags.last}" if @tags.last.name != ROOT_NODE
+      end
+
+      private
+
+      def current_indentation
+        line = @lines[current_line]
+        line.slice(0, context.column).rindex('<')
+      end
+
+      def current_line
+        (context.column == 1) && (context.line > 1) ? context.line - 2 : context.line - 1
+      end
+
+      def last_non_empty_line
+        @lines[0, current_line].each_with_index.reverse_each {|str, i| break i + 1 unless str.chomp.empty? }
+      end
+
+      def close_tags
+        while (@tags.last.name != ROOT_NODE) && (current_indentation <= @tags.last.indentation)
+          if (@current_tag == ERB_TAG) && (ErbBlockStartMarker === @tags.last) && (@tags.last.indentation == current_indentation)
+            break
+          else
+            @end_tags << [last_non_empty_line, @tags.last.end_tag]
+            @tags.pop
+          end
+        end
+      end
+    end
+
+    def call(template)
+      parse_template template
+    end
+
+    def to_erb
+      @document.erb_template
+    end
+
+    private
+
+    def parse_template(template)
+      @document = Document.new template
+      @parser = Nokogiri::XML::SAX::Parser.new(@document)
+      @parser.parse @document.template do |ctx|
+        @document.context = ctx
+      end
+
+      @document.close_document!
+    end
+  end
+end

data/lib/himl/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+begin
+  require 'rails'
+
+  module Himl
+    class Railtie < ::Rails::Railtie
+      initializer 'himl' do
+        ActiveSupport.on_load :action_view do
+          require_relative 'handler'
+
+          ActionView::Template.register_template_handler :himl, Himl::Handler
+        end
+      end
+    end
+  end
+rescue LoadError
+  # do nothing
+end

data/lib/himl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Himl
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: himl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTML + ERB + Haml = Himl
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- himl.gemspec
+- lib/himl.rb
+- lib/himl/handler.rb
+- lib/himl/parser.rb
+- lib/himl/railtie.rb
+- lib/himl/version.rb
+homepage: https://github.com/amatsuda/himl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: HTML-based Indented Markup Language
+test_files: []