slimi 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7aed4b0083f7ec850df87f869b5687873dcf98fd6f80ab93854c101e0d03098
-  data.tar.gz: bfa813fce529081b2eb876e00a9b722feecf914a5741c9ca341ec2aa8d1463ac
+  metadata.gz: ce4329befc9d19fb756c5609a28a3169c4f5a5aa2698771df14541b88b792da1
+  data.tar.gz: d99512e7191942f2fabb8667cb4de369dcad5d773c1e162cc039f2911b4b1dc9
 SHA512:
-  metadata.gz: bcd9e3abde25cca87e45eb7244658ed6a99d56e458d2b0b3e1199252eb5621480fb7afc12f6246f3760e13a07a2efaabd80f45e5deb868212228cbf96b582a01
-  data.tar.gz: 9fd6030053873163c81f12646461cb502a4d3632e9de4bd8ec77081546081e50fd7e088ad93f23b15666d54007ca1b298f44dd63eeb74b2f5778e716e5e3d6fc
+  metadata.gz: 6c1b46a4afdfc4ce2a8ce816898a17e6bd448e0e76a001efbebfe7fc498375a2c1c71aaa5f40cce11012f28e7e87f5c7eef06b70b6dbcd560a6343d5494ee71c
+  data.tar.gz: 7554a443efa9d30952d3446b92c494dd6ecf1caeb78d77aea347eef1ab862e64c35e93d4ef76c1423728734eb3b23913e75497c3358b0df2543229e05b177c07

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 0.2.0 - 2021-12-23
+
+### Added
+
+- Support embedded template.
+- Show useful message at syntax error.
+
 ## 0.1.1 - 2021-12-21
 
 ### Fixed

data/Gemfile.lock

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

data/README.md

@@ -5,7 +5,7 @@
 
 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
 
@@ -30,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,53 @@ 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 LineEndingNotFoundError < ParserError
+    class LineEndingNotFoundError < SlimSyntaxError
     end
 
-    class MalformedIndentationError < ParserError
+    class MalformedIndentationError < 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 UnknownLineIndicator < SlimSyntaxError
     end
   end
 end

data/lib/slimi/parser.rb

@@ -32,6 +32,7 @@ module Slimi
       @quoted_attribute_regexp = factory.quoted_attribute_regexp
       @tag_name_regexp = factory.tag_name_regexp
       @attribute_name_regexp = factory.attribute_name_regexp
+      @embedded_template_regexp = factory.embedded_template_regexp
     end
 
     def call(source)
@@ -55,6 +56,7 @@ module Slimi
         parse_inline_html ||
         parse_code_block ||
         parse_output_block ||
+        parse_embedded_template ||
         parse_doctype ||
         parse_tag ||
         raise(Errors::UnknownLineIndicatorError)
@@ -66,7 +68,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 +79,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 +131,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]
@@ -452,7 +466,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,8 +482,33 @@ 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: '(__TEMPLATE__)',
+        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
 
@@ -534,6 +573,11 @@ module Slimi
         %r{(#{markers_regexp}+)((?:\p{Word}|-|/\d+|:(\w|-)+)*)}
       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]*("|')/

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.1'
+  VERSION = '0.2.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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2021-12-22 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