synvert-core 1.22.1 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a767738290801342257194e72b784fa8d1849f5a7a2098dabf5776cc33735b
-  data.tar.gz: 7e6a0b109c9c281a3ead5e623107c30417288dc4ca694d0bdafcd71ccac67fc8
+  metadata.gz: 6590e4796366364169c7e2cc65779406ce8a8f88221ffcd7f0ad05df4487f78b
+  data.tar.gz: b1792cc8d6744fbef809d43ba428f0d5592702c6abee4653fe8160a87261acd4
 SHA512:
-  metadata.gz: 7abe8e7fbe261f1739974eb51b70cbf86a4a674bcdd8c2fcadce42962deb0a2be2532d28bdb808a211dd4e86c8bbd7150fb6d8def0ac263e9fcceba491f4b240
-  data.tar.gz: 906b75c024ca0464d60bdadaf8dcf761f2e18d3df2704d66423eefcf1bdf98cae57804b368358ac0838053f76fee4a36c4989f774b630489291aaf5e05933f4a
+  metadata.gz: ec759f01184a5730b99742f28310b72df7e5c844fcafa535238dcfacaca8582e9e13b695219ec76f3b8a45194d15aec2caed1e714848cad33263de53a6a56be2
+  data.tar.gz: eef33bbc2623a9ff16e908722ef358cbec51188911e07e1c9c8e44bcb4029c4e73cc1c0da54581d557c3d1edde0f8ed224fff75dffca5b2fcd347e1eed3f83f8

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 1.23.0 (2023-04-05)
+
+* 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
+
+##  1.22.2 (2023-03-31)
+
+* Do not replace white space characters in erb engine
+* Check erb source in `ReplaceErbStmtWithExprAction`
+* Update `node_mutation` to 1.13.1
+
 ## 1.22.1 (2023-03-31)
 
 * Fix indent when `insert_after` or `insert_before` to a child node

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.22.1)
+    synvert-core (1.23.0)
       activesupport (< 7.0.0)
-      node_mutation (>= 1.13.0)
+      node_mutation (>= 1.14.0)
       node_query (>= 1.12.0)
       parallel
       parser
@@ -22,7 +22,6 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    erubis (2.7.0)
     fakefs (2.4.0)
     ffi (1.15.5)
     formatador (1.1.0)
@@ -49,14 +48,13 @@ GEM
     method_source (1.0.0)
     minitest (5.18.0)
     nenv (0.3.0)
-    node_mutation (1.13.0)
-      erubis
+    node_mutation (1.14.0)
     node_query (1.12.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.22.1)
-    parser (3.2.1.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     parser_node_ext (1.0.0)
       parser

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

@@ -9,9 +9,20 @@ module Synvert::Core
         # @param source [String] erb code.
         # @return [String] encoded ruby code.
         def encode(source)
-          source.gsub(/%>.*?<%=?/m) { |str| ' ' * str.size }
-                .sub(/^.*?<%=?/m) { |str| ' ' * str.size }
-                .sub(/%>.*?$/m) { |str| ' ' * str.size }
+          source.gsub(/%>.*?<%=?/m) { |str| replace_all_code_but_white_space_characters(str) }
+                .sub(/^.*?<%=?/m) { |str| replace_all_code_but_white_space_characters(str) }
+                .sub(/%>.*?$/m) { |str| replace_all_code_but_white_space_characters(str) }
+        end
+
+        # Generate an empty proc.
+        def generate_transform_proc(_encoded_source)
+          proc {}
+        end
+
+        private
+
+        def replace_all_code_but_white_space_characters(source)
+          source.gsub(/\S/, ' ')
         end
       end
     end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  module Engine
+    class Haml
+      class << self
+        END_LINE = "end\n"
+
+        # 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)
+          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
+              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
+              end
+            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
+
+              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
+
+        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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/synvert/core/engine.rb

@@ -4,5 +4,36 @@ module Synvert::Core
   # Engine defines how to encode / decode other files (like erb).
   module Engine
     autoload :Erb, 'synvert/core/engine/erb'
+    autoload :Haml, 'synvert/core/engine/haml'
+
+    # Register an engine
+    # @param [String] extension
+    # @param [Class] engine
+    def self.register(extension, engine)
+      @engines ||= {}
+      @engines[extension] = engine
+    end
+
+    # Encode source code by registered engine.
+    # @param [String] extension
+    # @param [String] source
+    # @return [String] encoded source
+    def self.encode(extension, source)
+      engine = @engines[extension]
+      engine ? engine.encode(source) : source
+    end
+
+    # Generate a transform_proc by registered engine,
+    # which is used to adjust start and end position of actions.
+    # @param [String] extension
+    # @param [String] encoded_source
+    # @return [Proc] transform_proc
+    def self.generate_transform_proc(extension, encoded_source)
+      engine = @engines[extension]
+      engine ? engine.generate_transform_proc(encoded_source) : proc {}
+    end
   end
+
+  Engine.register('.erb', Engine::Erb)
+  Engine.register('.haml', Engine::Haml)
 end

data/lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb

@@ -8,8 +8,9 @@ module Synvert::Core
     # Initialize a ReplaceErbStmtWithExprAction.
     #
     # @param node [Synvert::Core::Rewriter::Node]
-    def initialize(node)
+    def initialize(node, erb_source)
       super(node, nil)
+      @erb_source = erb_source
     end
 
     # The new erb expr code.
@@ -23,7 +24,12 @@ module Synvert::Core
 
     # Calculate the begin the end positions.
     def calculate_position
-      @start = NodeMutation.adapter.get_start(@node) - 1
+      @start = NodeMutation.adapter.get_start(@node)
+      loop do
+        @start -= 1
+        break if @erb_source[@start] == '%'
+      end
+      @start += 1
       @end = @start
     end
   end

data/lib/synvert/core/rewriter/instance.rb

@@ -44,10 +44,12 @@ module Synvert::Core
       absolute_file_path = File.join(Configuration.root_path, @file_path)
       while true
         source = read_source(absolute_file_path)
+        encoded_source = Engine.encode(File.extname(file_path), source)
         @current_mutation = NodeMutation.new(source)
+        @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
         @mutation_adapter = NodeMutation.adapter
         begin
-          node = parse_code(@file_path, source)
+          node = parse_code(@file_path, encoded_source)
 
           process_with_node(node) do
             instance_eval(&@block)
@@ -73,9 +75,11 @@ module Synvert::Core
       absolute_file_path = File.join(Configuration.root_path, file_path)
       source = read_source(absolute_file_path)
       @current_mutation = NodeMutation.new(source)
+      encoded_source = Engine.encode(File.extname(file_path), source)
+      @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
       @mutation_adapter = NodeMutation.adapter
       begin
-        node = parse_code(file_path, source)
+        node = parse_code(file_path, encoded_source)
 
         process_with_node(node) do
           instance_eval(&@block)
@@ -300,7 +304,9 @@ module Synvert::Core
     #     replace_erb_stmt_with_expr
     #   end
     def replace_erb_stmt_with_expr
-      action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node)
+      absolute_file_path = File.join(Configuration.root_path, @file_path)
+      erb_source = read_source(absolute_file_path)
+      action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node, erb_source)
       add_action(action)
     end
 
@@ -438,11 +444,11 @@ module Synvert::Core
     # Parse code ast node.
     #
     # @param file_path [String] file path
-    # @param file_path [String] file path
+    # @param encoded_source [String] encoded source code
     # @return [Node] ast node for file
-    def parse_code(file_path, source)
+    def parse_code(file_path, encoded_source)
       buffer = Parser::Source::Buffer.new file_path
-      buffer.source = /\.erb/.match?(file_path) ? Engine::Erb.encode(source) : source
+      buffer.source = encoded_source
 
       parser = Parser::CurrentRuby.new
       parser.reset

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.22.1'
+    VERSION = '1.23.0'
   end
 end

data/lib/synvert/core.rb

@@ -8,7 +8,6 @@ require 'parser_node_ext'
 require_relative './core/node_ext'
 require 'active_support'
 require 'active_support/core_ext'
-require 'erubis'
 require 'node_query'
 require 'node_mutation'
 
@@ -29,8 +28,9 @@ module Synvert
 
   ALL_RUBY_FILES = %w[**/*.rb]
   ALL_ERB_FILES = %w[**/*.erb]
+  ALL_HAML_FILES = %w[**/*.haml]
   ALL_RAKE_FILES = %w[**/*.rake]
-  ALL_FILES = ALL_RUBY_FILES + ALL_ERB_FILES + ALL_RAKE_FILES
+  ALL_FILES = ALL_RUBY_FILES + ALL_ERB_FILES + ALL_HAML_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 +47,7 @@ module Synvert
     engines/*/config/routes.rb
     engines/*/config/routes/**/*.rb
   ]
-  RAILS_VIEW_FILES = %w[app/views/**/*.html.{erb}]
+  RAILS_VIEW_FILES = ALL_ERB_FILES + ALL_HAML_FILES
 
   RAILS_CONTROLLER_TEST_FILES = %w[
     test/functional/**/*.rb

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  describe Engine::Haml do
+    describe '#encode' do
+      it 'encodes source' do
+        source = <<~EOS
+          %p
+            Date/Time:
+            - now = DateTime.now
+            %strong= now
+            - if now > DateTime.parse("December 31, 2006")
+              = "Happy new " + "year!"
+            - else
+              = "Hello!"
+            - if current_admin?
+              %strong= "Admin"
+            - elsif current_user?
+              %span= "User"
+          #error= error_message
+          .form-actions
+            = form_for @user do |f|
+          Test
+        EOS
+        encoded_source = Engine::Haml.encode(source)
+        expect(encoded_source).to be_include 'now = DateTime.now'
+        expect(encoded_source).to be_include 'now'
+        expect(encoded_source).to be_include 'if now > DateTime.parse("December 31, 2006")'
+        expect(encoded_source).to be_include '"Happy new " + "year!"'
+        expect(encoded_source).to be_include '"Hello!"'
+        expect(encoded_source).to be_include 'if current_admin?'
+        expect(encoded_source).to be_include '"Admin"'
+        expect(encoded_source).to be_include 'if current_user?'
+        expect(encoded_source).to be_include '"User"'
+        expect(encoded_source).to be_include 'error_message'
+        expect(encoded_source).to be_include 'form_for @user do |f|'
+        expect(encoded_source.scan("end\n").length).to eq 3
+        expect(encoded_source).not_to be_include '%p'
+        expect(encoded_source).not_to be_include 'strong'
+        expect(encoded_source).not_to be_include '#error'
+        expect(encoded_source).not_to be_include 'Test'
+        expect(encoded_source).not_to be_include '.form-actions'
+      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::Haml.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/action/replace_erb_stmt_with_expr_action_spec.rb

@@ -4,12 +4,33 @@ require 'spec_helper'
 
 module Synvert::Core
   RSpec.describe Rewriter::ReplaceErbStmtWithExprAction do
-    context 'replace with single line' do
+    context 'replace with whitespace' do
       subject {
-        source = "<% form_for post do |f| %>\n<% end %>"
-        source = Engine::Erb.encode(source)
+        erb_source = "<% form_for post do |f| %>\n<% end %>"
+        source = Engine::Erb.encode(erb_source)
         node = Parser::CurrentRuby.parse(source).children.first
-        described_class.new(node).process
+        described_class.new(node, erb_source).process
+      }
+
+      it 'gets start' do
+        expect(subject.start).to eq '<%'.length
+      end
+
+      it 'gets end' do
+        expect(subject.end).to eq '<%'.length
+      end
+
+      it 'gets new_code' do
+        expect(subject.new_code).to eq '='
+      end
+    end
+
+    context 'replace without whitespace' do
+      subject {
+        erb_source = "<%form_for post do |f|%>\n<%end%>"
+        source = Engine::Erb.encode(erb_source)
+        node = Parser::CurrentRuby.parse(source).children.first
+        described_class.new(node, erb_source).process
       }
 
       it 'gets start' do

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

@@ -179,8 +179,13 @@ module Synvert::Core
       instance.instance_variable_set(:@current_mutation, double)
       instance.current_node = double
       action = double
+      erb_source = '<% form_for @post do |f| %><% end %>'
+      allow(File).to receive(:read).and_return(erb_source)
       expect(instance.instance_variable_get(:@current_mutation)).to receive(:actions).and_return([])
-      expect(Rewriter::ReplaceErbStmtWithExprAction).to receive(:new).with(instance.current_node).and_return(action)
+      expect(Rewriter::ReplaceErbStmtWithExprAction).to receive(:new).with(
+        instance.current_node,
+        erb_source
+      ).and_return(action)
       expect(action).to receive(:process)
       instance.replace_erb_stmt_with_expr
     end
@@ -356,10 +361,30 @@ module Synvert::Core
           <%= form_for @post do |f| %>
           <% end %>
         EOS
-        expect(File).to receive(:read).with('./app/views/posts/_form.html.erb', encoding: 'UTF-8').and_return(input)
+        allow(File).to receive(:read).with('./app/views/posts/_form.html.erb', encoding: 'UTF-8').and_return(input)
         expect(File).to receive(:write).with('./app/views/posts/_form.html.erb', output)
         instance.process
       end
+
+      it 'updates haml file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.haml' 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.haml', encoding: 'UTF-8').and_return(input)
+        expect(File).to receive(:write).with('./app/views/posts/_form.html.haml', output)
+        instance.process
+      end
     end
 
     describe '#test' do
@@ -419,11 +444,39 @@ module Synvert::Core
           <% form_for @post do |f| %>
           <% end %>
         EOS
-        expect(File).to receive(:read).with('./app/views/posts/_form.html.erb', encoding: 'UTF-8').and_return(input)
+        allow(File).to receive(:read).with('./app/views/posts/_form.html.erb', encoding: 'UTF-8').and_return(input)
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.erb'
         expect(result.actions).to eq [NodeMutation::Struct::Action.new(2, 2, '=')]
       end
+
+      it 'updates haml file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.haml' 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.haml', encoding: 'UTF-8').and_return(input)
+        result = instance.test
+        expect(result.file_path).to eq 'app/views/posts/_form.html.haml'
+        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

data/synvert-core-ruby.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport", "< 7.0.0"
   spec.add_runtime_dependency "node_query", ">= 1.12.0"
-  spec.add_runtime_dependency "node_mutation", ">= 1.13.0"
+  spec.add_runtime_dependency "node_mutation", ">= 1.14.0"
   spec.add_runtime_dependency "parser"
   spec.add_runtime_dependency "parser_node_ext", ">= 1.0.0"
   spec.add_runtime_dependency "parallel"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.23.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ files:
 - lib/synvert/core/configuration.rb
 - lib/synvert/core/engine.rb
 - lib/synvert/core/engine/erb.rb
+- lib/synvert/core/engine/haml.rb
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
@@ -138,6 +139,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
 - spec/synvert/core/engine/erb_spec.rb
+- spec/synvert/core/engine/haml_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
@@ -182,6 +184,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
 - spec/synvert/core/engine/erb_spec.rb
+- spec/synvert/core/engine/haml_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