hamli 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a825c4ad1a1e140b7c8020a0137a278c2844356c0f5ab166fcca716c0f21a88
-  data.tar.gz: e603ee2dd8d1698447bf4eb20729b0087b174f679171d2a4d94efd4f2117e580
+  metadata.gz: ff0371e95f3c87b4519036500b8ff6b5a7de3a91f9509f05240a9a23d53105ff
+  data.tar.gz: f96c2b0b84ad2d546433934ebe40e6973effe559896e0bacda88a0d769e462fc
 SHA512:
-  metadata.gz: 759e52536c4111473a6a46d22a44a027db0e96590d2367e9bbd64395bf91cd72c5984cc4341e457f493c99c27f878d5f2142a42f4a26c77175a245c1e242b269
-  data.tar.gz: 914d1aa219cba92b697455223ba65bd140336bb7e20fdc5378eaadf6825630d9d392f56e797b84b160a0d96ad84296042e74468b2a6c1b093c4898f05165ce7e
+  metadata.gz: 60c15036fe01fc5c4716cf49f8969dca86055628c42ba7c299a66de3102f08b7520d1c296f58b032840bfd925b5fcefaae068add96cc9f7d9370a68667d27c1e
+  data.tar.gz: a6c1a3d3b777ef1fd46f4928d2c045f57051169d84d2643050e1b917cb49cc0db0b9a20f9dee049a9fed8a1ad172ed74bae20fa4b94ab6616405d66d814970b2

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 ## Unreleased
 
+## 0.5.0 - 2022-01-30
+
+### Added
+
+- Support escaped output line.
+- Support non-escaped output line.
+
+## 0.4.0 - 2022-01-26
+
+### Added
+
+- Add :file option for better error report.
+
+### Fixed
+
+- Fix error from parse_text_block on some case.
+- Fix filter bug on :text node.
+- Fix parse_interpolate_line bug.
+- Fix haml comment parser bug.
+- Fix pipe multi-line handling.
+
+## 0.3.0 - 2022-01-26
+
+### Added
+
+- Support output block in tag line.
+- Support HTML comment line.
+- Support HTML conditional comment line.
+- Support Haml comment line.
+- Support output line.
+- Support control line.
+
+## 0.2.0 - 2022-01-25
+
+### Added
+
+- Add Interpolation Filter.
+
+### Changed
+
+- Use :position node.
+
 ## 0.1.0 - 2022-01-25
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hamli (0.1.0)
+    hamli (0.5.0)
       temple
 
 GEM

data/README.md

@@ -1,9 +1,12 @@
 # Hamli
 
 [![test](https://github.com/r7kamura/hamli/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/hamli/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/hamli.svg)](https://rubygems.org/gems/hamli)
 
 Yet another implementation for [Haml](https://github.com/haml/haml) template language.
 
+Hamli is used by [Hamlcop](https://github.com/r7kamura/hamlcop).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/hamli/filters/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'temple'
+
+module Hamli
+  module Filters
+    # Pass-through some expressions which are unknown for Temple.
+    class Base < ::Temple::HTML::Filter
+      # @param [Integer] begin_
+      # @param [Integer] end_
+      # @param [Array] expression
+      # @return [Array]
+      def on_hamli_position(begin_, end_, expression)
+        [:hamli, :position, begin_, end_, compile(expression)]
+      end
+
+      # @param [Array] expression
+      # @return [Array]
+      def on_hamli_text(expression)
+        [:hamli, :text, compile(expression)]
+      end
+    end
+  end
+end

data/lib/hamli/filters/interpolation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Hamli
+  module Filters
+    class Interpolation < Base
+      # @param [Integer] begin_
+      # @param [Integer] end_
+      # @return [Array] S-expression.
+      def on_hamli_interpolate(begin_, _end_, string)
+        block = [:multi]
+        scanner = ::StringScanner.new(string)
+        until scanner.eos?
+          charpos = scanner.charpos
+          if (value = scanner.scan(/\\#\{/))
+            block << [:static, value]
+          elsif scanner.scan(/#\{((?>[^{}]|(\{(?>[^{}]|\g<1>)*\}))*)\}/)
+            code = scanner[1]
+            begin2 = begin_ + charpos + 2
+            if code.start_with?('{') && code.end_with?('}')
+              escape = true
+              code = code[1..-2]
+              begin2 -= 1
+            else
+              escape = false
+            end
+            block << [:hamli, :position, begin2, begin2 + code.length, [:hamli, :output, escape, code, [:multi]]]
+          elsif (value = scanner.scan(/([#\\]?[^#\\]*([#\\][^\\\#{][^#\\]*)*)/)) # rubocop:disable Lint/DuplicateBranch
+            block << [:static, value]
+          end
+        end
+        block
+      end
+    end
+  end
+end

data/lib/hamli/filters.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Hamli
+  module Filters
+    autoload :Base, 'hamli/filters/base'
+    autoload :Interpolation, 'hamli/filters/interpolation'
+  end
+end

data/lib/hamli/parser.rb

@@ -4,6 +4,15 @@ require 'temple'
 
 module Hamli
   class Parser < ::Temple::Parser
+    define_options(
+      :file
+    )
+
+    def initialize(_options = {})
+      super
+      @file_path = options[:file] || '(__TEMPLATE__)'
+    end
+
     # @param [String] source Haml template source.
     # @return [Array]
     def call(source)
@@ -25,6 +34,20 @@ module Hamli
         parse_tag_line
       elsif @scanner.match?(/[#.]/)
         parse_div_line
+      elsif @scanner.match?(%r{/\[})
+        parse_html_conditional_comment_line
+      elsif @scanner.match?(%r{/})
+        parse_html_comment_line
+      elsif @scanner.match?(/-#/)
+        parse_haml_comment_line
+      elsif @scanner.match?(/-/)
+        parse_control_line
+      elsif @scanner.match?(/=/)
+        parse_output_line
+      elsif @scanner.match?(/&=/)
+        parse_escaped_output_line
+      elsif @scanner.match?(/!=/)
+        parse_non_escaped_output_line
       else
         parse_text_line
       end
@@ -110,10 +133,19 @@ module Hamli
         content = [:multi]
         tag << content
         @stacks << content
-      elsif @scanner.scan(/[ \t]*=([<>])*/)
-        # TODO
+      elsif @scanner.scan(/[ \t]*([<>]*)=/)
+        # white_space_marker = @scanner[1]
+        # without_outer_white_space = white_space_marker.include?('>') # TODO
+        # without_inner_white_space = white_space_marker.include?('<') # TODO
+        @scanner.skip(/[ \t]+/)
+        begin_ = @scanner.charpos
+        content = parse_broken_lines
+        end_ = @scanner.charpos
+        block = [:multi]
+        tag << [:hamli, :position, begin_, end_, [:hamli, :output, false, content, block]]
+        @stacks << block
       elsif @scanner.scan(%r{[ \t]*/[ \t]*})
-        # TODO
+        # Does nothing.
       else
         @scanner.scan(/[ \t]+/)
         tag << [:hamli, :text, parse_text_block]
@@ -274,7 +306,7 @@ module Hamli
           )
         /x
       )
-      [:hamli, :object_reference, begin_, @scanner.charpos, value]
+      [:hamli, :object_reference, [:hamli, :position, begin_, @scanner.charpos, value]]
     end
 
     # Parse ruby attributes part.
@@ -292,7 +324,51 @@ module Hamli
           )
         /x
       )
-      [:hamli, :ruby_attributes, begin_, @scanner.charpos, value]
+      [:hamli, :ruby_attributes, [:hamli, :position, begin_, @scanner.charpos, value]]
+    end
+
+    # Parse HTML comment part.
+    #   e.g. /[if IE]
+    #        ^^^^^^^^
+    def parse_html_conditional_comment_line
+      @scanner.pos += 1
+      condition = @scanner.scan(
+        /
+          (?<brackets>
+            \[
+              (?:[^\[\]] | \g<brackets>)*
+            \]
+          )
+        /x
+      )
+      block = [:multi]
+      @stacks.last << [:html, :condcomment, condition, block]
+      @stacks << block
+      parse_line_ending
+    end
+
+    # Parse HTML comment part.
+    #   e.g. / abc
+    #        ^^^^^
+    def parse_html_comment_line
+      @scanner.pos += 1
+      block = [:multi]
+      block << [:static, @scanner.scan(/[^\r\n]*/)]
+      @stacks.last << [:html, :comment, block]
+      @stacks << block
+      parse_line_ending
+    end
+
+    # Parse Haml comment part.
+    #   e.g. -# abc
+    #        ^^^^^^
+    def parse_haml_comment_line
+      @scanner.pos += 2
+      @scanner.scan(/[^\r\n]*/)
+      while !@scanner.eos? && (@scanner.match?(/[ \t]*(?=\r|$)/) || peek_indent > @indents.last)
+        @scanner.scan(/[^\r\n]*/)
+        parse_line_ending
+      end
     end
 
     # Parse text block part.
@@ -325,7 +401,7 @@ module Hamli
 
     # @return [Array, nil]
     def parse_interpolate_line
-      return unless @scanner.match?(/[^\r\n]/)
+      return unless @scanner.match?(/[^\r\n]+/)
 
       begin_ = @scanner.charpos
       value = @scanner.matched
@@ -334,6 +410,70 @@ module Hamli
       [:hamli, :interpolate, begin_, end_, value]
     end
 
+    # Parse escaped output line part.
+    #   e.g. != abc
+    #        ^^^^^^
+    # @todo Support :escape_html option on this parser, then rethink about escaping.
+    def parse_non_escaped_output_line
+      @scanner.pos += 1
+      parse_output_line
+    end
+
+    # Parse escaped output line part.
+    #   e.g. &= abc
+    #        ^^^^^^
+    def parse_escaped_output_line
+      @scanner.pos += 2
+      @scanner.scan(/[ \t]*/)
+      parse_ruby_line(escaped: true, name: :output)
+    end
+
+    # Parse output line part.
+    #   e.g. = abc
+    #        ^^^^^
+    def parse_output_line
+      @scanner.pos += 1
+      @scanner.scan(/[ \t]*/)
+      parse_ruby_line(escaped: false, name: :output)
+    end
+
+    # Parse control line part.
+    #   e.g. - abc
+    #        ^^^^^
+    def parse_control_line
+      @scanner.pos += 1
+      @scanner.scan(/[ \t]*/)
+      parse_ruby_line(escaped: false, name: :control)
+    end
+
+    # @param [Boolean] escaped
+    # @param [Symbol] name
+    def parse_ruby_line(escaped:, name:)
+      @scanner.scan(/[ \t]*/)
+      block = [:multi]
+      begin_ = @scanner.charpos
+      content = parse_broken_lines
+      end_ = @scanner.charpos
+      @stacks.last << [:hamli, :position, begin_, end_, [:hamli, name, escaped, content, block]]
+      @stacks << block
+    end
+
+    # @note Broken line means line-breaked lines, separated by trailing "," or "|".
+    # @return [String]
+    def parse_broken_lines
+      result = +''
+      result << @scanner.scan(/[^\r\n]*/)
+      while result.end_with?(',') || result.end_with?('|')
+        syntax_error!(Errors::UnexpectedEosError) unless @scanner.scan(/\r?\n/)
+
+        result << "\n"
+        result << @scanner.scan(/[^\r\n]*/)
+      end
+      lines = result.lines
+      result.gsub!(/\|$/, '') if lines.length >= 2 && lines.all? { |line| line.end_with?("|\n") }
+      result.delete_suffix("\n")
+    end
+
     # @param [Class] syntax_error_class A child class of Hamli::Errors::HamlSyntaxError.
     # @raise [Hamli::Errors::HamlSyntaxError]
     def syntax_error!(syntax_error_class)
@@ -348,7 +488,7 @@ module Hamli
 
     # @return [Integer]
     def indent_from_last_match
-      @scanner.matched.chars.map do |char|
+      (@scanner.matched || '').chars.map do |char|
         case char
         when "\t"
           4
@@ -364,5 +504,11 @@ module Hamli
     def expecting_indentation?
       @stacks.length > @indents.length
     end
+
+    # @return [Integer] Indent level.
+    def peek_indent
+      @scanner.match?(/[ \t]*/)
+      indent_from_last_match
+    end
   end
 end

data/lib/hamli/version.rb

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

data/lib/hamli.rb

@@ -4,6 +4,7 @@ require_relative 'hamli/version'
 
 module Hamli
   autoload :Errors, 'hamli/errors'
+  autoload :Filters, 'hamli/filters'
   autoload :Parser, 'hamli/parser'
   autoload :Range, 'hamli/range'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -43,6 +43,9 @@ files:
 - hamli.gemspec
 - lib/hamli.rb
 - lib/hamli/errors.rb
+- lib/hamli/filters.rb
+- lib/hamli/filters/base.rb
+- lib/hamli/filters/interpolation.rb
 - lib/hamli/parser.rb
 - lib/hamli/range.rb
 - lib/hamli/version.rb