slimi 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b30b237b1d1e68744ac90e65d148397a5099a4702482286768afd6db8409a484
-  data.tar.gz: 055a9e297a5467e35c01d7468ab5d5083df89ef8762bb8c92d3074956751675b
+  metadata.gz: 05cfa3a429ac2da0e1241e65e69a40f9171079cddb9451a6d7186726a5cb498c
+  data.tar.gz: 68826c3fe78dc87bfd704cc38a9222da1adeed36a8c0d0e903bb4f3077ed698d
 SHA512:
-  metadata.gz: 43d27cd7dc20e1de1d744ae87110bec52727d30786c252cd02de8f31cdc7f86fe4d7cc08d005b5c430c73d1ab68176dc0a73e5ae2376722febfb12f4193dfd68
-  data.tar.gz: 4ab35e06cb00a9b50cbca0dd34797ad281777fba885141cf41709c6e15f24c8c87a99b55d466ce8c31546a464d507e1a476a3b1d6aa5345a770572a9151b5cd0
+  metadata.gz: 9c729933bc060a21df2e55db525d28a8e519526995ec5b7fb3defd17ecb11c71fc7e6ec664c162396f6a8be9175549dd842c7c5f9be76c68afadadc9e3e442be
+  data.tar.gz: 60b3b1ad54a01bcbc2154e83b11efe3ac1b3fb5723773f04aabff9d1957dec60cb8afd431630b78dc8e13fa86d109d86a78c66005bafb10c23e0965368d9bd80

data/.rubocop.yml

@@ -6,6 +6,9 @@ AllCops:
 Layout/LineLength:
   Enabled: false
 
+Lint/InterpolationCheck:
+  Enabled: false
+
 Metrics:
   Enabled: false
 

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 ## Unreleased
 
+## 0.4.0 - 2021-12-25
+
+### Added
+
+- Support :file option on parser for showing correct file path on syntax error.
+
+### Fixed
+
+- Fix NameError on unknown line indicator.
+- Fix bug that default parser options are not used.
+
+## 0.3.0 - 2021-12-24
+
+### Added
+
+- Support unquoted attributes.
+
+### Fixed
+
+- Fix bug about blank line handling.
+
+## 0.2.0 - 2021-12-23
+
+### Added
+
+- Support embedded template.
+- Show useful message at syntax error.
+
+## 0.1.1 - 2021-12-21
+
+### Fixed
+
+- Fix bug that Slimi::Interpolation was not working.
+
 ## 0.1.0 - 2021-12-20
 
+### Added
+
 - Initial release.

data/Gemfile.lock

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

data/README.md

@@ -1,10 +1,11 @@
 # Slimi
 
 [![test](https://github.com/r7kamura/slimi/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/slimi/actions/workflows/test.yml)
+[![](https://badge.fury.io/rb/slimi.svg)](https://rubygems.org/gems/slimi)
 
 Yet another implementation for [Slim](https://github.com/slim-template/slim) template language.
 
-The current goal is to generate AST with detailed location information so that the embedded Ruby code in slim templates can be auto-corrected by Linter such as RuboCop.
+Slimi is used by [Slimcop](https://github.com/r7kamura/slimcop).
 
 ## Installation
 
@@ -29,21 +30,3 @@ gem install slimi
 ## Usage
 
 TBD.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/slimi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/r7kamura/slimi/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Slimi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/r7kamura/slimi/blob/main/CODE_OF_CONDUCT.md).

data/lib/slimi/errors.rb

@@ -5,25 +5,59 @@ module Slimi
     class BaseError < StandardError
     end
 
-    class ParserError < BaseError
+    class SlimSyntaxError < BaseError
+      # @param [Integer] column
+      # @param [String] file_path
+      # @param [String] line
+      # @param [Integer] line_number
+      def initialize(column:, file_path:, line:, line_number:)
+        super()
+        @column = column
+        @file_path = file_path
+        @line = line
+        @line_number = line_number
+      end
+
+      # @note Override.
+      # @return [String]
+      def to_s
+        <<~TEXT
+          #{error_type} at #{@file_path}:#{@line_number}:#{@column}
+          #{@line}
+          #{' ' * (@column - 1)}^
+        TEXT
+      end
+
+      private
+
+      # @return [String]
+      def error_type
+        self.class.to_s.split('::').last
+      end
+    end
+
+    class InvalidEmptyAttributeError < SlimSyntaxError
+    end
+
+    class LineEndingNotFoundError < SlimSyntaxError
     end
 
-    class LineEndingNotFoundError < ParserError
+    class MalformedIndentationError < SlimSyntaxError
     end
 
-    class MalformedIndentationError < ParserError
+    class RubyAttributeClosingDelimiterNotFoundError < SlimSyntaxError
     end
 
-    class UnexpectedEosError < ParserError
+    class UnexpectedEosError < SlimSyntaxError
     end
 
-    class UnexpectedIndentationError < ParserError
+    class UnexpectedIndentationError < SlimSyntaxError
     end
 
-    class UnexpectedTextAfterClosedTagError < ParserError
+    class UnexpectedTextAfterClosedTagError < SlimSyntaxError
     end
 
-    class UnknownLineIndicator < ParserError
+    class UnknownLineIndicatorError < SlimSyntaxError
     end
   end
 end

data/lib/slimi/filters/interpolation.rb

@@ -1,34 +1,55 @@
 # frozen_string_literal: true
 
 require 'strscan'
-require 'temple'
 
 module Slimi
   module Filters
-    class Interpolation < ::Temple::Filter
+    class Interpolation
+      def initialize(*); end
+
+      def call(node)
+        convert(node)
+      end
+
+      private
+
+      def convert(value)
+        if value.instance_of?(::Array)
+          if value[0] == :slimi && value[1] == :interpolate
+            on_slimi_interpolate(value[2], value[3], value[4])
+          else
+            value.map do |element|
+              call(element)
+            end
+          end
+        else
+          value
+        end
+      end
+
       # @param [Integer] begin_
       # @param [Integer] end_
       # @return [Array] S-expression.
-      def on_slimi_interpolate(begin_, end_, string)
+      def on_slimi_interpolate(begin_, _end_, string)
         block = [:multi]
         scanner = ::StringScanner.new(string)
         until scanner.eos?
           charpos = scanner.charpos
-          if (value = scanner.scan(/\\#\{/) || scanner.scan(/([#\\]?[^#\\]*([#\\][^\\\#{][^#\\]*)*)/))
+          if (value = scanner.scan(/\\#\{/))
             block << [:static, value]
           elsif scanner.scan(/#\{((?>[^{}]|(\{(?>[^{}]|\g<1>)*\}))*)\}/)
             code = scanner[1]
             begin2 = begin_ + charpos + 2
-            end2 = end_ + scanner.charpos - 1
             if code.start_with?('{') && code.end_with?('}')
               escape = true
               code = code[1..-2]
               begin2 -= 1
-              end2 -= 1
             else
               escape = false
             end
-            block << [:slimi, :position, begin2, end2, [:slim, :output, escape, code, [:multi]]]
+            block << [:slimi, :position, begin2, begin2 + code.length, [:slim, :output, escape, code, [:multi]]]
+          elsif (value = scanner.scan(/([#\\]?[^#\\]*([#\\][^\\\#{][^#\\]*)*)/)) # rubocop:disable Lint/DuplicateBranch
+            block << [:static, value]
           end
         end
         block

data/lib/slimi/parser.rb

@@ -6,22 +6,30 @@ require 'temple'
 module Slimi
   class Parser < ::Temple::Parser
     define_options(
+      :file,
       attr_list_delims: {
         '(' => ')',
         '[' => ']',
         '{' => '}'
       },
+      code_attr_delims: {
+        '(' => ')',
+        '[' => ']',
+        '{' => '}'
+      },
       shortcut: {
         '#' => { attr: 'id' },
         '.' => { attr: 'class' }
       }
     )
 
-    def initialize(options = {})
+    def initialize(_options = {})
       super
+      @file_path = options[:file] || '(__TEMPLATE__)'
       factory = Factory.new(
         attribute_delimiters: options[:attr_list_delims] || {},
         default_tag: options[:default_tag] || 'div',
+        ruby_attribute_delimiters: options[:code_attr_delims] || {},
         shortcut: options[:shortcut] || {}
       )
       @attribute_delimiters = factory.attribute_delimiters
@@ -32,6 +40,10 @@ module Slimi
       @quoted_attribute_regexp = factory.quoted_attribute_regexp
       @tag_name_regexp = factory.tag_name_regexp
       @attribute_name_regexp = factory.attribute_name_regexp
+      @ruby_attribute_regexp = factory.ruby_attribute_regexp
+      @ruby_attribute_delimiter_regexp = factory.ruby_attribute_delimiter_regexp
+      @ruby_attribute_delimiters = factory.ruby_attribute_delimiters
+      @embedded_template_regexp = factory.embedded_template_regexp
     end
 
     def call(source)
@@ -45,19 +57,32 @@ module Slimi
     private
 
     def parse_block
+      return if parse_blank_line
+
       parse_indent
 
-      parse_line_ending ||
-        parse_html_comment ||
+      parse_html_comment ||
         parse_html_conditional_comment ||
         parse_slim_comment_block ||
         parse_verbatim_text_block ||
         parse_inline_html ||
         parse_code_block ||
         parse_output_block ||
+        parse_embedded_template ||
         parse_doctype ||
         parse_tag ||
-        raise(Errors::UnknownLineIndicatorError)
+        syntax_error!(Errors::UnknownLineIndicatorError)
+    end
+
+    # Parse blank line.
+    # @return [Boolean] True if it could parse a blank line.
+    def parse_blank_line
+      if @scanner.skip(/[ \t]*$/)
+        parse_line_ending
+        true
+      else
+        false
+      end
     end
 
     def parse_indent
@@ -66,7 +91,7 @@ module Slimi
       @indents << indent if @indents.empty?
 
       if indent > @indents.last
-        raise Errors::UnexpectedIndentationError unless expecting_indentation?
+        syntax_error!(Errors::UnexpectedIndentationError) unless expecting_indentation?
 
         @indents << indent
       else
@@ -77,10 +102,22 @@ module Slimi
           @stacks.pop
         end
 
-        raise Errors::MalformedIndentationError if indent != @indents.last
+        syntax_error!(Errors::MalformedIndentationError) if indent != @indents.last
       end
     end
 
+    # Parse embedded template lines.
+    #   e.g.
+    #     ruby:
+    #       a = b + c
+    def parse_embedded_template
+      return unless @scanner.skip(@embedded_template_regexp)
+
+      embedded_template_engine_name = @scanner[1]
+      attributes = parse_attributes
+      @stacks.last << [:slim, :embedded, embedded_template_engine_name, parse_text_block, attributes]
+    end
+
     # @return [Boolean]
     def parse_tag
       parse_tag_inner && expect_line_ending
@@ -117,7 +154,7 @@ module Slimi
           @stacks.last << [:static, ' '] if with_trailing_white_space2
           @stacks << block
         elsif @scanner.skip(%r{[ \t]*/[ \t]*})
-          raise Errors::UnexpectedTextAfterClosedTagError unless @scanner.match?(/\r?\n/)
+          syntax_error!(Errors::UnexpectedTextAfterClosedTagError) unless @scanner.match?(/\r?\n/)
         else
           @scanner.skip(/[ \t]+/)
           tag << [:slim, :text, :inline, parse_text_block]
@@ -163,8 +200,6 @@ module Slimi
         marker = @scanner[1]
         attribute_value = @scanner[2]
         attribute_names = @attribute_shortcuts[marker]
-        raise 'Illegal shortcut' unless attribute_names
-
         attribute_names.map do |attribute_name|
           result << [:html, :attr, attribute_name.to_s, [:static, attribute_value]]
         end
@@ -218,12 +253,19 @@ module Slimi
         attribute_delimiter_closing_part_regexp = /[ \t]*#{attribute_delimiter_closing_regexp}/
       end
 
+      # TODO: Support splat attributes.
       loop do
         if @scanner.skip(@quoted_attribute_regexp)
           attribute_name = @scanner[1]
           escape = @scanner[2].empty?
           quote = @scanner[3]
           attributes << [:html, :attr, attribute_name, [:escape, escape, parse_quoted_attribute_value(quote)]]
+        elsif @scanner.skip(@ruby_attribute_regexp)
+          attribute_name = @scanner[1]
+          escape = @scanner[2].empty?
+          attribute_value = parse_ruby_attribute_value(attribute_delimiter_closing)
+          syntax_error!(Errors::InvalidEmptyAttributeError) if attribute_value.empty?
+          attributes << [:html, :attr, attribute_name, [:slim, :attrvalue, escape, attribute_value]]
         elsif !attribute_delimiter_closing_part_regexp
           break
         elsif @scanner.skip(boolean_attribute_regexp)
@@ -238,6 +280,46 @@ module Slimi
       attributes
     end
 
+    # Parse Ruby attribute value part.
+    #   e.g. div class=foo
+    #                  ^^^
+    #                     `- Ruby attribute value
+    # @param [String] attribute_delimiter_closing
+    # @return [String]
+    def parse_ruby_attribute_value(attribute_delimiter_closing)
+      ending_regexp = /\s/
+      ending_regexp = ::Regexp.union(ending_regexp, attribute_delimiter_closing) if attribute_delimiter_closing
+      count = 0
+      attribute_value = +''
+      opening_delimiter = nil
+      closing_delimiter = nil
+      loop do
+        break if count.zero? && @scanner.match?(ending_regexp)
+
+        if @scanner.skip(/([,\\])\r?\n/)
+          attribute_value << @scanner[1] << "\n"
+        else
+          if count.positive?
+            if opening_delimiter && @scanner.skip(::Regexp.escape(opening_delimiter))
+              count += 1
+            elsif closing_delimiter && @scanner.skip(::Regexp.escape(closing_delimiter))
+              count -= 1
+            end
+          elsif @scanner.skip(@ruby_attribute_delimiter_regexp)
+            count = 1
+            opening_delimiter = @scanner.matched
+            closing_delimiter = @ruby_attribute_delimiters[opening_delimiter]
+          end
+          if (character = @scanner.scan(/./))
+            attribute_value << character
+          end
+        end
+      end
+      syntax_error!(Errors::RubyAttributeClosingDelimiterNotFoundError) if count != 0
+
+      attribute_value
+    end
+
     # @return [Boolean]
     def parse_html_comment
       if @scanner.skip(%r{/!})
@@ -452,7 +534,7 @@ module Slimi
       result = +''
       result << @scanner.scan(/.*/)
       while result.end_with?(',') || result.end_with?('\\')
-        raise Errors::UnexpectedEosError unless @scanner.scan(/\r?\n/)
+        syntax_error!(Errors::UnexpectedEosError) unless @scanner.scan(/\r?\n/)
 
         result << "\n"
         result << @scanner.scan(/.*/)
@@ -468,17 +550,47 @@ module Slimi
       [:slimi, :position, begin_, end_, inner]
     end
 
+    # @param [Class] syntax_error_class A child class of Slimi::Errors::SlimSyntaxError.
+    # @raise [Slimi::Errors::SlimSyntaxError]
+    def syntax_error!(syntax_error_class)
+      range = Range.new(index: @scanner.charpos, source: @scanner.string)
+      raise syntax_error_class.new(
+        column: range.column,
+        file_path: @file_path,
+        line: range.line,
+        line_number: range.line_number
+      )
+    end
+
     # Convert human-friendly options into machine-friendly objects.
     class Factory
+      EMBEDDED_TEMPLAE_ENGINE_NAMES = %w[
+        coffee
+        css
+        javascript
+        less
+        markdown
+        rdoc
+        ruby
+        sass
+        scss
+        textile
+      ].freeze
+
       # @return [Hash]
       attr_reader :attribute_delimiters
 
+      # @return [Hash]
+      attr_reader :ruby_attribute_delimiters
+
       # @param [Hash] attribute_delimiters
       # @param [String] default_tag
+      # @param [Hash] ruby_attribute_delimiters
       # @param [Hash] shortcut
-      def initialize(attribute_delimiters:, default_tag:, shortcut:)
+      def initialize(attribute_delimiters:, default_tag:, ruby_attribute_delimiters:, shortcut:)
         @attribute_delimiters = attribute_delimiters
         @default_tag = default_tag
+        @ruby_attribute_delimiters = ruby_attribute_delimiters
         @shortcut = shortcut
       end
 
@@ -534,11 +646,26 @@ module Slimi
         %r{(#{markers_regexp}+)((?:\p{Word}|-|/\d+|:(\w|-)+)*)}
       end
 
+      # @return [Regexp]
+      def ruby_attribute_regexp
+        /#{attribute_name_regexp}[ \t]*=(=?)[ \t]*/
+      end
+
+      # @return [Regexp]
+      def embedded_template_regexp
+        /(#{::Regexp.union(EMBEDDED_TEMPLAE_ENGINE_NAMES)})(?:[ \t]*(?:(.*)))?:([ \t]*)/
+      end
+
       # @return [Regexp]
       def quoted_attribute_regexp
         /#{attribute_name_regexp}[ \t]*=(=?)[ \t]*("|')/
       end
 
+      # @return [Regexp]
+      def ruby_attribute_delimiter_regexp
+        ::Regexp.union(@ruby_attribute_delimiters.keys)
+      end
+
       # @return [Regexp] Pattern that matches to tag header part.
       def tag_name_regexp
         markers = tag_shortcuts.keys.sort_by { |marker| -marker.size }

data/lib/slimi/range.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Slimi
+  # Get line-based information from source code and its index.
+  class Range
+    # @param [Integer] index 0-indexed per-character index.
+    # @param [String] source
+    def initialize(index:, source:)
+      @index = index
+      @source = source
+    end
+
+    # @return [Integer] 1-indexed column index.
+    def column
+      (@index - line_beginning_index) + 1
+    end
+
+    def line
+      @source[line_beginning_index...line_ending_index]
+    end
+
+    # @return [Integer] 1-indexed line index.
+    def line_number
+      @source[0..@index].scan(/^/).length
+    end
+
+    private
+
+    # @return [Integer]
+    def line_beginning_index
+      @source.rindex(/^/, @index) || 0
+    end
+
+    # @return [Integer]
+    def line_ending_index
+      @source.index(/$/, @index)
+    end
+  end
+end

data/lib/slimi/version.rb

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

data/lib/slimi.rb

@@ -6,4 +6,5 @@ module Slimi
   autoload :Errors, 'slimi/errors'
   autoload :Filters, 'slimi/filters'
   autoload :Parser, 'slimi/parser'
+  autoload :Range, 'slimi/range'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -48,6 +48,7 @@ files:
 - lib/slimi/filters/interpolation.rb
 - lib/slimi/filters/unposition.rb
 - lib/slimi/parser.rb
+- lib/slimi/range.rb
 - lib/slimi/version.rb
 - slimi.gemspec
 homepage: https://github.com/r7kamura/slimi