synvert-core 1.23.1 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862649a82e2cd9d14454b65b9c3e146c2c6adff96a03441624cca7d83f42a8f5
-  data.tar.gz: 167e5ee0a3ae617888af58dd40ee582d3427012a5e0daea881f13ffd51a07b8a
+  metadata.gz: b80b28538674cde89c7dc0098b53d736abb355874d4736654b48234c38c76e2b
+  data.tar.gz: 463e9b2616f07146ce551e904912dc2cbfb71e010ffa11eda8ff134c0ea1a5b3
 SHA512:
-  metadata.gz: dbf9a15e4e795edf0bedcb690b163b088ca00236545881744ef8ac004c68059cf90654d3804626e29e8b3ce4a9e3ccb3e9e7cf6d82ea05c98c941f6e59c77b8c
-  data.tar.gz: 916953fc304f4a2054b3722197ec0d194a958b2f502d5ea379411b1de970fc9691aaa3caf68c3458f99281a92d7c316bb084fe3deaba7af0fd03e0df7cbd31c9
+  metadata.gz: 2f25773c6887fe6b676dc1abd92df89b82dddab81e26841d3e1b566b1ab4f84666f7fde4563e864508814b49f7a54313014a88e412946b908e58976641a1223f
+  data.tar.gz: 13cadd41c39b742837a0b562626b1de9355e63f52f953133139f60c47f6341001f2442bca9276078bfdadea909ef5068db688444ed8e55ceaf9fc2511e7321d4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.24.0 (2023-04-16)
+
+* Add `Slim` engine
+* Abstract `Engine/Elegant` module
+* Rewrite `Haml` and `Slim` engine by StringScanner
+
 ## 1.23.1 (2023-04-06)
 
 * Fix array index name in `GotoScope`
@@ -7,7 +13,7 @@
 
 ## 1.23.0 (2023-04-05)
 
-* Add haml engine
+* Add `Haml` engine
 * Add `Engine.register` and `Engine.encode` and `Engine.generate_transform_proc`
 * Set NodeMutation `transform_proc`
 * Update `node_mutation` to 1.14.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.23.1)
+    synvert-core (1.24.0)
       activesupport (< 7.0.0)
       node_mutation (>= 1.14.0)
       node_query (>= 1.12.1)

data/lib/synvert/core/engine/elegant.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  module Engine
+    # Engine::Elegant provides some helper methods for engines
+    # who read block code without end.
+    # For those engines, it will try to insert `end\n` when encode,
+    # while delete `end\n` when generate_transform_proc.
+    module Elegant
+      END_LINE = "end\n"
+      WHITESPACE = ' '
+      DO_BLOCK_REGEX = / do(\s|\z|\n)/
+
+      IF_KEYWORDS = %w[if unless begin case for while until]
+      ELSE_KEYWORDS = %w[else elsif when in rescue ensure]
+
+      # Generate transform proc, it's used to adjust start and end position of actions.
+      # Due to the fact that we insert `end\n` when encode the source code, we need to adjust
+      # start and end position of actions to match the original source code.
+      # e.g. if end\n exists in position 10, action start position is 20 and end position is 30,
+      # then action start position should be 16 and end position should be 26.
+      #
+      # @param encoded_source [String] encoded source.
+      # @return [Proc] transform proc.
+      def generate_transform_proc(encoded_source)
+        proc do |actions|
+          start = 0
+          indices = []
+          loop do
+            index = encoded_source[start..-1].index(END_LINE)
+            break unless index
+
+            indices << (start + index)
+            start += index + END_LINE.length
+          end
+          indices.each do |index|
+            actions.each do |action|
+              action.start -= END_LINE.length if action.start > index
+              action.end -= END_LINE.length if action.end > index
+            end
+          end
+        end
+      end
+
+      # Check if the current leading_spaces_count is less than or equal to the last leading_spaces_count in leading_spaces_counts.
+      # If so, pop the last leading_spaces_count and return true.
+      def insert_end?(leading_spaces_counts, current_leading_spaces_count, equal = true)
+        operation = equal ? :<= : :<
+        if !leading_spaces_counts.empty? && current_leading_spaces_count.send(operation, leading_spaces_counts.last)
+          leading_spaces_counts.pop
+          true
+        else
+          false
+        end
+      end
+
+      def scan_ruby_statement(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+        new_code << scanner.scan(/\s*/)
+        keyword = scanner.scan(/\w+/)
+        rest = scanner.scan(/.*?(\z|\n)/)
+        if insert_end?(leading_spaces_counts, leading_spaces_count, !ELSE_KEYWORDS.include?(keyword))
+          new_code << END_LINE
+        end
+        if IF_KEYWORDS.include?(keyword) || rest =~ DO_BLOCK_REGEX
+          leading_spaces_counts << leading_spaces_count
+        end
+        new_code << keyword
+        new_code << rest
+
+        while rest.rstrip.end_with?(',')
+          rest = scanner.scan(/.*?(\z|\n)/)
+          new_code << rest
+        end
+      end
+
+      def scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+        if insert_end?(leading_spaces_counts, leading_spaces_count)
+          new_code << END_LINE
+        end
+        rest = scanner.scan(/.*?(\z|\n)/)
+        if rest =~ DO_BLOCK_REGEX
+          leading_spaces_counts << leading_spaces_count
+        end
+        new_code << rest
+
+        while rest.rstrip.end_with?(',')
+          rest = scanner.scan(/.*?(\z|\n)/)
+          new_code << rest
+        end
+      end
+
+      def scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+        if insert_end?(leading_spaces_counts, leading_spaces_count)
+          new_code << END_LINE
+        end
+        while scanner.scan(/(.*?)(\\*)#\{/) # it matches interpolation "  #{current_user.login}"
+          new_code << WHITESPACE * scanner.matched.size
+          unless scanner.matched[-3] == '\\'
+            count = 1
+            while scanner.scan(/.*?([\{\}])/)
+              if scanner.matched[-1] == '}'
+                count -= 1
+                if count == 0
+                  new_code << scanner.matched[0..-2] + ';'
+                  break
+                else
+                  new_code << scanner.matched
+                end
+              else
+                count += 1
+                new_code << scanner.matched
+              end
+            end
+          end
+        end
+        if scanner.scan(/.*?\z/)
+          new_code << WHITESPACE * scanner.matched.size
+        end
+        if scanner.scan(/.*?\n/)
+          new_code << WHITESPACE * (scanner.matched.size - 1) + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/synvert/core/engine/haml.rb

@@ -4,7 +4,7 @@ module Synvert::Core
   module Engine
     class Haml
       class << self
-        END_LINE = "end\n"
+        include Elegant
 
         # Encode haml string, leave only ruby code, replace other haml code with whitespace.
         # And insert `end\n` for each if, unless, begin, case to make it a valid ruby code.
@@ -12,70 +12,55 @@ module Synvert::Core
         # @param source [String] haml code.
         # @return [String] encoded ruby code.
         def encode(source)
-          tab_sizes = []
-          lines =
-            source.lines.map do |line|
-              if line =~ /\A(\s*)(- ?)(.*)/ # match "  - if currenet_user"
-                code = (' ' * ($1.size + $2.size)) + $3
-                new_line =
-                  $3.start_with?('else', 'elsif', 'when') ? code : check_and_insert_end(code, tab_sizes, $1.size)
-                tab_sizes.push($1.size) if $3.start_with?('if', 'unless', 'begin', 'case') || $3.include?(' do ')
-
-                new_line
+          leading_spaces_counts = []
+          new_code = []
+          scanner = StringScanner.new(source)
+          loop do
+            new_code << scanner.scan(/\s*/)
+            leading_spaces_count = scanner.matched.size
+            if scanner.scan('-') # it matches ruby statement "  - current_user"
+              new_code << WHITESPACE
+              scan_ruby_statement(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+            elsif scanner.scan('=') # it matches ruby expression "  = current_user.login"
+              new_code << WHITESPACE
+              scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+            elsif scanner.scan(/[%#\.][a-zA-Z0-9\-_%#\.]+/) # it matches element, id and class "  %span.user"
+              new_code << WHITESPACE * scanner.matched.size
+              scan_matching_wrapper(scanner, new_code, '{', '}')
+              if scanner.scan('=')
+                new_code << WHITESPACE
+                scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
               else
-                if line =~ /\A(\s*)([%#\.].*)?=(.*)/ # match "  %span= current_user.login"
-                  code = (' ' * ($1.size + ($2 || '').size + 1)) + $3
-                  new_line = check_and_insert_end(code, tab_sizes, $1.size)
-                  tab_sizes.push($1.size) if line.include?(' do ')
-                  new_line
-                elsif line =~ /\A(\s*)(.*)/ # match any other line
-                  check_and_insert_end(' ' * line.size, tab_sizes, $1.size)
-                end
+                scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
               end
+            else
+              scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
             end
-          lines.push(END_LINE) unless tab_sizes.empty?
-          lines.join("\n")
-        end
 
-        # Generate transform proc, it's used to adjust start and end position of actions.
-        # Due to the fact that we insert `end\n` when encode the source code, we need to adjust
-        # start and end position of actions to match the original source code.
-        # e.g. if end\n exists in position 10, action start position is 20 and end position is 30,
-        # then action start position should be 16 and end position should be 26.
-        #
-        # @param encoded_source [String] encoded source.
-        # @return [Proc] transform proc.
-        def generate_transform_proc(encoded_source)
-          proc do |actions|
-            start = 0
-            indices = []
-            loop do
-              index = encoded_source[start..-1].index(END_LINE)
-              break unless index
+            break if scanner.eos?
+          end
 
-              indices << (start + index)
-              start += index + END_LINE.length
-            end
-            indices.each do |index|
-              actions.each do |action|
-                action.start -= END_LINE.length if action.start > index
-                action.end -= END_LINE.length if action.end > index
-              end
-            end
+          while leading_spaces_counts.pop
+            new_code << END_LINE
           end
+          new_code.join
         end
 
         private
 
-        # Check if the current tab_size is less than or equal to the last tab_size in tab_sizes.
-        # If so, pop the last tab_size and insert "end\n" before code.
-        # otherwise, return code.
-        def check_and_insert_end(code, tab_sizes, current_tab_size)
-          if !tab_sizes.empty? && current_tab_size <= tab_sizes[-1]
-            tab_sizes.pop
-            "end\n" + code
-          else
-            code
+        def scan_matching_wrapper(scanner, new_code, start, ending)
+          if scanner.scan(start) # it matches attributes "  %span{:class => 'user'}"
+            new_code << start
+            count = 1
+            while scanner.scan(/.*?[#{Regexp.quote(start)}#{Regexp.quote(ending)}]/m)
+              new_code << scanner.matched
+              if scanner.matched[-1] == ending
+                count -= 1
+                break if count == 0
+              else
+                count += 1
+              end
+            end
           end
         end
       end

data/lib/synvert/core/engine/slim.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  module Engine
+    class Slim
+      class << self
+        include Elegant
+
+        ATTRIBUTES_PAIR = {
+          '{' => '}',
+          '[' => ']',
+          '(' => ')'
+        }
+
+        # Encode haml string, leave only ruby code, replace other haml code with whitespace.
+        # And insert `end\n` for each if, unless, begin, case to make it a valid ruby code.
+        #
+        # @param source [String] haml code.
+        # @return [String] encoded ruby code.
+        def encode(source)
+          leading_spaces_counts = []
+          new_code = []
+          scanner = StringScanner.new(source)
+          loop do
+            new_code << scanner.scan(/\s*/)
+            leading_spaces_count = scanner.matched.size
+            if scanner.scan('-') # it matches ruby statement "  - current_user"
+              new_code << WHITESPACE
+              scan_ruby_statement(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+            elsif scanner.scan(/==?/) # it matches ruby expression "  = current_user.login"
+              new_code << WHITESPACE * scanner.matched.size
+              scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+            elsif scanner.scan(/[a-z#\.][a-zA-Z0-9\-_%#\.]*/) # it matches element, id and class "  span.user"
+              new_code << WHITESPACE * scanner.matched.size
+              ATTRIBUTES_PAIR.each do |start, ending| # it matches attributes in brackets "  span[ class='user' ]"
+                scan_matching_wrapper(scanner, new_code, start, ending)
+              end
+              scan_attributes_between_whitespace(scanner, new_code)
+              if scanner.scan(/ ?==?/) # it matches ruby expression "  span= current_user.login"
+                new_code << WHITESPACE * scanner.matched.size
+                scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+              else
+                scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+              end
+            else
+              scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
+            end
+
+            break if scanner.eos?
+          end
+
+          while leading_spaces_counts.pop
+            new_code << END_LINE
+          end
+          new_code.join
+        end
+
+        private
+
+        def scan_matching_wrapper(scanner, new_code, start, ending)
+          if scanner.scan(start) # it matches attributes "  %span[ class='user' ]"
+            new_code << WHITESPACE
+            count = 1
+            while scanner.scan(/.*?[#{Regexp.quote(start)}#{Regexp.quote(ending)}]/m)
+              matched = scanner.matched.gsub(/(\A| ).*?=/) { |key| WHITESPACE * key.size }
+              if scanner.matched[-1] == ending
+                new_code << matched[0..-2] + ';'
+                count -= 1
+                break if count == 0
+              else
+                new_code << matched
+                count += 1
+              end
+            end
+          end
+        end
+
+        def scan_attributes_between_whitespace(scanner, new_code)
+          while scanner.scan(/ ?[\w\-_]+==?/) # it matches attributes split by space "  span class='user'"
+            new_code << WHITESPACE * scanner.matched.size
+            stack = []
+            while scanner.scan(/(.*?['"\(\)\[\]\{\}]|.+?\b)/)
+              matched = scanner.matched
+              new_code << matched
+              if ['(', '[', '{'].include?(matched[-1])
+                stack << matched[-1]
+              elsif [')', ']', '}'].include?(matched[-1])
+                stack.pop
+              elsif %w['  "].include?(matched[-1])
+                stack.last == matched[-1] ? stack.pop : stack << matched[-1]
+              end
+              break if stack.empty?
+            end
+            if scanner.scan(' ')
+              new_code << ';'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/synvert/core/engine.rb

@@ -3,8 +3,10 @@
 module Synvert::Core
   # Engine defines how to encode / decode other files (like erb).
   module Engine
+    autoload :Elegant, 'synvert/core/engine/elegant'
     autoload :Erb, 'synvert/core/engine/erb'
     autoload :Haml, 'synvert/core/engine/haml'
+    autoload :Slim, 'synvert/core/engine/slim'
 
     # Register an engine
     # @param [String] extension
@@ -36,4 +38,5 @@ module Synvert::Core
 
   Engine.register('.erb', Engine::Erb)
   Engine.register('.haml', Engine::Haml)
+  Engine.register('.slim', Engine::Slim)
 end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.23.1'
+    VERSION = '1.24.0'
   end
 end

data/lib/synvert/core.rb

@@ -2,6 +2,7 @@
 
 require 'synvert/core/version'
 require 'bundler'
+require 'strscan'
 require 'parser'
 require 'parser/current'
 require 'parser_node_ext'
@@ -29,8 +30,9 @@ module Synvert
   ALL_RUBY_FILES = %w[**/*.rb]
   ALL_ERB_FILES = %w[**/*.erb]
   ALL_HAML_FILES = %w[**/*.haml]
+  ALL_SLIM_FILES = %w[**/*.slim]
   ALL_RAKE_FILES = %w[**/*.rake]
-  ALL_FILES = ALL_RUBY_FILES + ALL_ERB_FILES + ALL_HAML_FILES + ALL_RAKE_FILES
+  ALL_FILES = ALL_RUBY_FILES + ALL_ERB_FILES + ALL_HAML_FILES + ALL_SLIM_FILES + ALL_RAKE_FILES
 
   RAILS_APP_FILES = %w[app/**/*.rb engines/*/app/**/*.rb]
   RAILS_CONTROLLER_FILES = %w[app/controllers/**/*.rb engines/*/app/controllers/**/*.rb]
@@ -47,7 +49,7 @@ module Synvert
     engines/*/config/routes.rb
     engines/*/config/routes/**/*.rb
   ]
-  RAILS_VIEW_FILES = ALL_ERB_FILES + ALL_HAML_FILES
+  RAILS_VIEW_FILES = ALL_ERB_FILES + ALL_HAML_FILES + ALL_SLIM_FILES
 
   RAILS_CONTROLLER_TEST_FILES = %w[
     test/functional/**/*.rb

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'pp'
 require 'synvert/core'
 require 'fakefs/spec_helpers'
 

data/spec/synvert/core/engine/haml_spec.rb

@@ -17,11 +17,11 @@ module Synvert::Core
               = "Hello!"
             - if current_admin?
               %strong= "Admin"
+              #error= error_message
+              .form-actions
+                = form_for @user do |f|
             - elsif current_user?
               %span= "User"
-          #error= error_message
-          .form-actions
-            = form_for @user do |f|
           Test
         EOS
         encoded_source = Engine::Haml.encode(source)
@@ -43,6 +43,164 @@ module Synvert::Core
         expect(encoded_source).not_to be_include 'Test'
         expect(encoded_source).not_to be_include '.form-actions'
       end
+
+      it 'encodes plain text' do
+        source = <<~EOS
+          %gee
+            %whiz
+              Wow this is cool!
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).not_to be_include '%gee'
+        expect(encoded_source).not_to be_include '%whiz'
+        expect(encoded_source).not_to be_include 'Wow this is cool!'
+      end
+
+      it 'encodes escaping' do
+        source = <<~EOS
+          %title
+            = @title
+            \\= @title
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source.scan('@title').length).to eq 1
+      end
+
+      it 'encodes attributes' do
+        source = <<~EOS
+          %html{:xmlns => "http://www.w3.org/1999/xhtml", "xml:lang" => "en", :lang => "en"}
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include '{:xmlns => "http://www.w3.org/1999/xhtml", "xml:lang" => "en", :lang => "en"}'
+      end
+
+      it 'encodes multiple lines attributes' do
+        source = <<~EOS
+          %script{
+            "type": "text/javascript",
+            "src": "javascripts/script_9",
+            "data": {
+              "controller": "reporter",
+            },
+          }
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include '"type": "text/javascript",'
+        expect(encoded_source).to be_include '"src": "javascripts/script_9",'
+        expect(encoded_source).to be_include '"controller": "reporter",'
+      end
+
+      it 'encodes prefixed attributes' do
+        source = <<~EOS
+          %a{:href=>"/posts", :data => {:author_id => 123, :category => 7}} Posts By Author
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include '{:href=>"/posts", :data => {:author_id => 123, :category => 7}}'
+      end
+
+      it 'encodes class and ID' do
+        source = <<~EOS
+          %div#things
+            %span#rice Chicken Fried
+            %p.beans{ :food => 'true' } The magical fruit
+            %h1.class.otherclass#id La La La
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).not_to be_include '%div'
+        expect(encoded_source).not_to be_include '#things'
+        expect(encoded_source).not_to be_include '.beans'
+        expect(encoded_source).not_to be_include '.class'
+        expect(encoded_source).not_to be_include '#id'
+        expect(encoded_source).to be_include "{ :food => 'true' }"
+      end
+
+      it 'encodes haml comments' do
+        source = <<~EOS
+          %p foo
+          -# This is a comment
+          %p bar
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).not_to be_include 'foo'
+        expect(encoded_source).not_to be_include 'bar'
+        expect(encoded_source).to be_include '# This is a comment'
+      end
+
+      it 'encodes ruby evaluation' do
+        source = <<~EOS
+          %p
+            = ['hi', 'there', 'reader!'].join " "
+            = "yo"
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include "['hi', 'there', 'reader!'].join \" \""
+        expect(encoded_source).to be_include '"yo"'
+      end
+
+      it 'encodes ruby evaluation in the same line' do
+        source = <<~EOS
+          %p= "hello"
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).not_to be_include '%p'
+        expect(encoded_source).to be_include '"hello"'
+      end
+
+      it 'encodes multiple lines ruby evaluation' do
+        source = <<~EOS
+          = link_to_remote "Add to cart",
+            :url => { :action => "add", :id => product.id },
+            :update => { :success => "cart", :failure => "error" }
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include 'link_to_remote "Add to cart",'
+        expect(encoded_source).to be_include ':url => { :action => "add", :id => product.id },'
+        expect(encoded_source).to be_include ':update => { :success => "cart", :failure => "error" }'
+      end
+
+      it 'encodes running ruby' do
+        source = <<~EOS
+          - foo = "hello"
+          - foo << " there"
+          - foo << " you!"
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include 'foo = "hello"'
+        expect(encoded_source).to be_include 'foo << " there"'
+        expect(encoded_source).to be_include 'foo << " you!"'
+      end
+
+      it 'encodes multiple line running ruby' do
+        source = <<~EOS
+          - links = {:home => "/",
+              :docs => "/docs",
+              :about => "/about"}
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include 'links = {:home => "/",'
+        expect(encoded_source).to be_include ':docs => "/docs",'
+        expect(encoded_source).to be_include ':about => "/about"}'
+      end
+
+      it 'encodes ruby block' do
+        source = <<~EOS
+          - (42...47).each do |i|
+            %p= i
+          %p See, I can count!
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include '(42...47).each do |i|'
+        expect(encoded_source).to be_include 'end'
+        expect(encoded_source).not_to be_include 'See, I can count!'
+      end
+
+      it 'encodes ruby interpolation' do
+        source = 'Look at #{h word} lack of backslash: \#{foo}'
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include 'h word;'
+        expect(encoded_source).not_to be_include 'foo'
+        expect(encoded_source).not_to be_include 'lack of backslash:'
+      end
     end
 
     describe '#generate_transform_proc' do

data/spec/synvert/core/engine/slim_spec.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  describe Engine::Slim do
+    describe '#encode' do
+      it 'encodes source' do
+        source = <<~EOS
+          doctype html
+          html
+            head
+              title Slim Examples
+              meta name="keywords" content="template language"
+              meta name="author" content=author
+              javascript:
+                alert('Slim supports embedded javascript!')
+
+            body
+              h1 Markup examples
+
+              #content
+                p This example shows you what a basic Slim file looks like.
+
+                == yield
+
+                - unless items.empty?
+                  table
+                    - items.each do |item|
+                      tr
+                        td.name = item.name
+                        td.price = item.price
+                - else
+                  p
+                  | No items found.  Please add some inventory.
+                    Thank you!
+
+              div id="footer"
+                = render 'footer'
+                | Copyright © \#{year} \#{author}
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'yield'
+        expect(encoded_source).to be_include 'unless items.empty?'
+        expect(encoded_source).to be_include 'items.each do |item|'
+        expect(encoded_source).to be_include 'item.name'
+        expect(encoded_source).to be_include 'item.price'
+        expect(encoded_source).to be_include "render 'footer'"
+        expect(encoded_source).to be_include 'year'
+        expect(encoded_source).to be_include 'author'
+        expect(encoded_source.scan("end\n").length).to eq 2
+        expect(encoded_source).not_to be_include 'html'
+        expect(encoded_source).not_to be_include 'meta'
+        expect(encoded_source).not_to be_include 'javascript:'
+        expect(encoded_source).not_to be_include 'Markup examples'
+        expect(encoded_source).not_to be_include 'td.name'
+        expect(encoded_source).not_to be_include 'td.price'
+        expect(encoded_source).not_to be_include 'Copyright'
+      end
+
+      it 'encodes control code' do
+        source = <<~EOS
+          body
+            - if articles.empty?
+              | No inventory
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'if articles.empty?'
+        expect(encoded_source).to be_include 'end'
+        expect(encoded_source).not_to be_include 'No inventory'
+      end
+
+      it 'encodes output' do
+        source = <<~EOS
+          = javascript_include_tag \
+              "jquery",
+              "application"
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'javascript_include_tag'
+        expect(encoded_source).to be_include '"jquery",'
+        expect(encoded_source).to be_include '"application"'
+      end
+
+      it 'encodes output without html escaping' do
+        source = <<~EOS
+          == yield
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'yield'
+      end
+
+      it 'encodes tags' do
+        source = <<~EOS
+          ul
+            li.first: a href="/a" A link
+            li: a href="/b" B link
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).not_to be_include 'ul'
+        expect(encoded_source).not_to be_include 'li'
+        expect(encoded_source).not_to be_include 'first'
+        expect(encoded_source).not_to be_include 'link'
+      end
+
+      it 'encodes text content' do
+        source = <<~EOS
+          body
+            h1 id="headline" Welcome to my site.
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).not_to be_include 'h1'
+        expect(encoded_source).not_to be_include 'id'
+        expect(encoded_source).not_to be_include 'Welcome'
+      end
+
+      it 'encodes dynamic content' do
+        source = <<~EOS
+          body
+            h1 id="headline" = page_headline
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'page_headline'
+        expect(encoded_source).not_to be_include 'h1'
+      end
+
+      it 'encodes attributes wrapper' do
+        source = <<~EOS
+          body
+            h1(id="logo") = page_logo
+            h2[id="tagline" class="small tagline"] = page_tagline
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'page_logo'
+        expect(encoded_source).to be_include 'page_tagline'
+        expect(encoded_source).not_to be_include 'h1'
+        expect(encoded_source).not_to be_include 'h2'
+        expect(encoded_source).not_to be_include 'id'
+        expect(encoded_source).not_to be_include 'class'
+      end
+
+      it 'encodes multiple lines attributes wrapper' do
+        source = <<~EOS
+          h2[id="tagline"
+              class="small tagline"] = page_tagline
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'page_tagline'
+        expect(encoded_source).not_to be_include 'h2'
+        expect(encoded_source).not_to be_include 'id'
+        expect(encoded_source).not_to be_include 'class'
+      end
+
+      it 'encodes ruby attributes' do
+        source = <<~EOS
+          body
+            table
+              - for user in users
+                td id="user_\#{user.id}" class=user.role
+                  a href=user_action(user, :edit) Edit \#{user.first_name}
+                  a href=(path_to_user user) = user.last_name
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'for user in users'
+        expect(encoded_source).to be_include 'user.id'
+        expect(encoded_source).to be_include 'user_action(user, :edit)'
+        expect(encoded_source).to be_include 'user.first_name'
+        expect(encoded_source).to be_include '(path_to_user user)'
+        expect(encoded_source).to be_include 'user.last_name'
+        expect(encoded_source).to be_include 'end'
+        expect(encoded_source).not_to be_include 'href'
+      end
+
+      it 'encodes ruby attributes with ==' do
+        source = 'a href==action_path(:start)'
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'action_path(:start)'
+        expect(encoded_source).not_to be_include 'href'
+        expect(encoded_source).not_to be_include '='
+      end
+
+      it 'encodes text interpolation' do
+        source = <<~EOS
+          body
+            h1 Welcome \#{current_user.name} to the show.
+        EOS
+        encoded_source = Engine::Slim.encode(source)
+        expect(encoded_source).to be_include 'current_user.name;'
+        expect(encoded_source).not_to be_include 'Welcome'
+      end
+    end
+
+    describe '#generate_transform_proc' do
+      it 'generates transform proc' do
+        encoded_source = <<~EOS
+          now = DateTime.now
+          if now > DateTime.parse("December 31, 2006")
+          else
+          end
+          if current_admin?
+          elsif current_user?
+          end
+          DateTime.now - now
+        EOS
+        proc = Engine::Slim.generate_transform_proc(encoded_source)
+        actions = [
+          NodeMutation::Struct::Action.new(50, 55, ''),
+          # first end position is 69
+          NodeMutation::Struct::Action.new(100, 105, ''),
+          # second end position is 111
+          NodeMutation::Struct::Action.new(120, 125, '')
+        ]
+        proc.call(actions)
+        expect(actions.first.start).to eq 50
+        expect(actions.first.end).to eq 55
+        expect(actions.second.start).to eq 96
+        expect(actions.second.end).to eq 101
+        expect(actions.third.start).to eq 112
+        expect(actions.third.end).to eq 117
+      end
+    end
+  end
+end

data/spec/synvert/core/rewriter/instance_spec.rb

@@ -385,6 +385,26 @@ module Synvert::Core
         expect(File).to receive(:write).with('./app/views/posts/_form.html.haml', output)
         instance.process
       end
+
+      it 'updates slim file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.slim' do
+            with_node node_type: 'ivar' do
+              replace_with 'post'
+            end
+          end
+        input = <<~EOS
+          = form_for @post do |f|
+          = form_for @post do |f|
+        EOS
+        output = <<~EOS
+          = form_for post do |f|
+          = form_for post do |f|
+        EOS
+        allow(File).to receive(:read).with('./app/views/posts/_form.html.slim', encoding: 'UTF-8').and_return(input)
+        expect(File).to receive(:write).with('./app/views/posts/_form.html.slim', output)
+        instance.process
+      end
     end
 
     describe '#test' do
@@ -477,6 +497,34 @@ module Synvert::Core
           ),
         ]
       end
+
+      it 'updates slim file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.slim' do
+            with_node node_type: 'ivar' do
+              replace_with 'post'
+            end
+          end
+        input = <<~EOS
+          = form_for @post do |f|
+          = form_for @post do |f|
+        EOS
+        output = <<~EOS
+          = form_for post do |f|
+          = form_for post do |f|
+        EOS
+        allow(File).to receive(:read).with('./app/views/posts/_form.html.slim', encoding: 'UTF-8').and_return(input)
+        result = instance.test
+        expect(result.file_path).to eq 'app/views/posts/_form.html.slim'
+        expect(result.actions).to eq [
+          NodeMutation::Struct::Action.new("= form_for ".length, "= form_for @post".length, 'post'),
+          NodeMutation::Struct::Action.new(
+            "= form_for @post do |f|\n= form_for ".length,
+            "= form_for @post do |f|\n= form_for @post".length,
+            'post'
+          ),
+        ]
+      end
     end
 
     describe '#process_with_node' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.23.1
+  version: 1.24.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,8 +115,10 @@ files:
 - lib/synvert/core.rb
 - lib/synvert/core/configuration.rb
 - lib/synvert/core/engine.rb
+- lib/synvert/core/engine/elegant.rb
 - lib/synvert/core/engine/erb.rb
 - lib/synvert/core/engine/haml.rb
+- lib/synvert/core/engine/slim.rb
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
@@ -140,6 +142,7 @@ files:
 - spec/support/parser_helper.rb
 - spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/engine/haml_spec.rb
+- spec/synvert/core/engine/slim_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb
@@ -185,6 +188,7 @@ test_files:
 - spec/support/parser_helper.rb
 - spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/engine/haml_spec.rb
+- spec/synvert/core/engine/slim_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb