synvert-core 1.21.4 → 1.21.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ffea2bd16746fbf2e7fffe597c4b9a6996e9b8eb3ca2442a9afe1716440e625
-  data.tar.gz: bb894317de6b8e8457f945bb62f8f0d6904b161c6ade75666403e3ca9e901771
+  metadata.gz: be03ea2206a20768b84cfc41ae93146510c561b1ae271ae4f1d1e6edc1a5c0c8
+  data.tar.gz: fa219393c0c4db9e4b2080d9e6a53245e525a29f12416e013c0afaaaa2c3629c
 SHA512:
-  metadata.gz: 52f123ef58bcd08859bb0639303e50a06d7d5f62e078824cf89e54413ca98ef555dc460da2df00cbe5c76470f73c1fe3b7136c37448e1d74697d573409da4738
-  data.tar.gz: 1123a15c06c6dd61bc8d84ceed412ca61ff15feef50257771701c2a1b1e504b56a00eda9b7f1c798fb0767f86da7dcf979b9570a38a5cb7f7e4f06858a13de60
+  metadata.gz: e9700c9b08ea11158f741634883e1cec3a69c5b18b15dd80424e42d6541f605aa16ac494dfd4bc25b4d2aa88b61b976e76d1a2e8b9f09c4a4e7a870bb9d5b43a
+  data.tar.gz: e382f8066407aa95c8079ced3e08bc453574e8329779c1d80c425441fbb72882cca60b217a482c4c691dd0ed02d1d7a3c88a712ff5b53c8f64a6dda922a8ec59

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 1.21.6 (2023-02-16)
+
+* `RAILS_VIEW_FILES` do not check `haml` and `slim` files until we support them
+* Add constants `ALL_FILES` and `ALL_ERB_FILES`
+
+## 1.21.5 (2023-02-15)
+
+* Rewrite erb engine, no need to decode
+* Rewrite `ReplaceErbStmtWithExprAction` to insert "=" instead
+* Erb encoded source passed to `node_query`, but not `node_mutation`
+
 ## 1.21.4 (2023-02-13)
 
 * Do not rescue `NoMethodError` and output debug info

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.21.4)
+    synvert-core (1.21.6)
       activesupport (< 7.0.0)
       erubis
       node_mutation (>= 1.9.2)
@@ -50,7 +50,7 @@ GEM
     method_source (1.0.0)
     minitest (5.17.0)
     nenv (0.3.0)
-    node_mutation (1.9.2)
+    node_mutation (1.9.3)
       erubis
     node_query (1.12.0)
     notiffany (0.1.3)

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

@@ -4,9 +4,6 @@ require 'erubis'
 
 module Synvert::Core
   module Engine
-    ERUBY_EXPR_SPLITTER = ';  ;'
-    ERUBY_STMT_SPLITTER = ';   ;'
-
     class Erb
       class << self
         # convert erb to ruby code.
@@ -14,135 +11,9 @@ module Synvert::Core
         # @param source [String] erb source code.
         # @return [String] ruby source code.
         def encode(source)
-          Erubis.new(source.gsub('-%>', '%>'), escape: false, trim: false).src
-        end
-
-        # convert ruby code to erb.
-        #
-        # @param source [String] ruby source code.
-        # @return [String] erb source code.
-        def decode(source)
-          source = decode_ruby_stmt(source)
-          source = decode_ruby_output(source)
-          source = decode_html_output(source)
-          source = remove_erubis_buf(source)
-        end
-
-        private
-
-        def decode_ruby_stmt(source)
-          source.gsub(/#{ERUBY_STMT_SPLITTER}(.+?)#{ERUBY_STMT_SPLITTER}/mo) { "<%#{Regexp.last_match(1)}%>" }
-        end
-
-        def decode_ruby_output(source)
-          source.gsub(/@output_buffer.append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo) {
-            "<%=#{Regexp.last_match(1)}%>"
-          }.gsub(/@output_buffer.append= (.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo) { |m|
-            "<%=#{m.sub('@output_buffer.append= ', '').sub(ERUBY_EXPR_SPLITTER, '')}%>"
-          }
-        end
-
-        def decode_html_output(source)
-          source.gsub(/@output_buffer.safe_append='(.+?)'.freeze;/m) { reverse_escape_text(Regexp.last_match(1)) }
-                .gsub(
-                  /@output_buffer.safe_append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo
-                ) { reverse_escape_text(Regexp.last_match(1)) }
-                .gsub(
-                  /@output_buffer.safe_append=(.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo
-                ) { reverse_escape_text(Regexp.last_match(1)) }
-        end
-
-        def remove_erubis_buf(source)
-          source
-            .sub('@output_buffer = output_buffer || ActionView::OutputBuffer.new;', '')
-            .sub('@output_buffer.to_s', '')
-        end
-
-        def reverse_escape_text(source)
-          source.gsub("\\\\", "\\").gsub("\\'", "'")
-        end
-      end
-    end
-
-    # borrowed from rails
-    class Erubis < ::Erubis::Eruby
-      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
-      def add_preamble(src)
-        @newline_pending = 0
-        src << '@output_buffer = output_buffer || ActionView::OutputBuffer.new;'
-      end
-
-      def add_text(src, text)
-        return if text.empty?
-
-        if text == "\n"
-          @newline_pending += 1
-        else
-          src << "@output_buffer.safe_append='"
-          src << ("\n" * @newline_pending) if @newline_pending > 0
-          src << escape_text(text)
-          src << "'.freeze;"
-
-          @newline_pending = 0
-        end
-      end
-
-      # Erubis toggles <%= and <%== behavior when escaping is enabled.
-      # We override to always treat <%== as escaped.
-      def add_expr(src, code, indicator)
-        case indicator
-        when '=='
-          add_expr_escaped(src, code)
-        else
-          super
-        end
-      end
-
-      def add_expr_literal(src, code)
-        flush_newline_if_pending(src)
-        if BLOCK_EXPR.match?(code)
-          src << '@output_buffer.append= ' << code << ERUBY_EXPR_SPLITTER
-        else
-          src << '@output_buffer.append=(' << code << ');' << ERUBY_EXPR_SPLITTER
-        end
-      end
-
-      def add_expr_escaped(src, code)
-        flush_newline_if_pending(src)
-        if BLOCK_EXPR.match?(code)
-          src << '@output_buffer.safe_append= ' << code << ERUBY_EXPR_SPLITTER
-        else
-          src << '@output_buffer.safe_append=(' << code << ');' << ERUBY_EXPR_SPLITTER
-        end
-      end
-
-      def add_stmt(src, code)
-        flush_newline_if_pending(src)
-        if code != "\n" && code != ''
-          index =
-            case code
-            when /\A(\s*)\r?\n/
-              Regexp.last_match(1).length
-            when /\A(\s+)/
-              Regexp.last_match(1).end_with?(' ') ? Regexp.last_match(1).length - 1 : Regexp.last_match(1).length
-            else
-              0
-            end
-          code.insert(index, ERUBY_STMT_SPLITTER)
-          code.insert(-1, ERUBY_STMT_SPLITTER[0...-1])
-        end
-        super
-      end
-
-      def add_postamble(src)
-        flush_newline_if_pending(src)
-        src << '@output_buffer.to_s'
-      end
-
-      def flush_newline_if_pending(src)
-        if @newline_pending > 0
-          src << "@output_buffer.safe_append='#{"\n" * @newline_pending}'.freeze;"
-          @newline_pending = 0
+          source.gsub(/^.*?<%=?/m) { |str| ' ' * str.size }
+                .gsub(/%>.*?$/m) { |str| ' ' * str.size }
+                .gsub(/%>.*?<%=?/m) { |str| ' ' * str.size }
         end
       end
     end

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

@@ -16,28 +16,15 @@ module Synvert::Core
     #
     # @return [String] new code.
     def new_code
-      NodeMutation.adapter.file_content(@node)[@start...@end]
-        .sub(Engine::ERUBY_STMT_SPLITTER, '@output_buffer.append= ')
-        .sub(Engine::ERUBY_STMT_SPLITTER, Engine::ERUBY_EXPR_SPLITTER)
+      '='
     end
 
     private
 
     # Calculate the begin the end positions.
     def calculate_position
-      node_start = NodeMutation.adapter.get_start(@node)
-      node_source = NodeMutation.adapter.get_source(@node)
-      file_content = NodeMutation.adapter.file_content(@node)
-
-      whitespace_index = node_start
-      while file_content[whitespace_index -= 1] == ' '
-      end
-      @start = whitespace_index - Engine::ERUBY_STMT_SPLITTER.length + 1
-
-      at_index = node_start + node_source.index('do')
-      while file_content[at_index += 1] != '@'
-      end
-      @end = at_index
+      @start = NodeMutation.adapter.get_start(@node) - 1
+      @end = @start
     end
   end
 end

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

@@ -296,7 +296,8 @@ module Synvert::Core
     #     replace_erb_stmt_with_expr
     #   end
     def replace_erb_stmt_with_expr
-      @current_mutation.actions << Rewriter::ReplaceErbStmtWithExprAction.new(@current_node).process
+      action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node)
+      add_action(action)
     end
 
     # It replaces the whole code of current node.
@@ -421,16 +422,13 @@ module Synvert::Core
     # @param file_path [String] file path
     # @return [String] file source
     def read_source(file_path)
-      source = File.read(file_path, encoding: 'UTF-8')
-      source = Engine::Erb.encode(source) if /\.erb$/.match?(file_path)
-      source
+      File.read(file_path, encoding: 'UTF-8')
     end
 
     # Write file source to file.
     # @param file_path [String] file path
     # @param source [String] file source
     def write_source(file_path, source)
-      source = Engine::Erb.decode(source) if /\.erb/.match?(file_path)
       File.write(file_path, source.gsub(/ +\n/, "\n"))
     end
 
@@ -441,7 +439,7 @@ module Synvert::Core
     # @return [Node] ast node for file
     def parse_code(file_path, source)
       buffer = Parser::Source::Buffer.new file_path
-      buffer.source = source
+      buffer.source = /\.erb/.match?(file_path) ? Engine::Erb.encode(source) : source
 
       parser = Parser::CurrentRuby.new
       parser.reset

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.21.4'
+    VERSION = '1.21.6'
   end
 end

data/lib/synvert/core.rb

@@ -29,7 +29,9 @@ module Synvert
   Strategy = Core::Strategy
 
   ALL_RUBY_FILES = %w[**/*.rb]
+  ALL_ERB_FILES = %w[**/*.erb]
   ALL_RAKE_FILES = %w[**/*.rake]
+  ALL_FILES = ALL_RUBY_FILES + ALL_ERB_FILES + ALL_RAKE_FILES
 
   RAILS_APP_FILES = %w[app/**/*.rb engines/*/app/**/*.rb]
   RAILS_CONTROLLER_FILES = %w[app/controllers/**/*.rb engines/*/app/controllers/**/*.rb]
@@ -46,7 +48,7 @@ module Synvert
     engines/*/config/routes.rb
     engines/*/config/routes/**/*.rb
   ]
-  RAILS_VIEW_FILES = %w[app/views/**/*.html.{erb,haml,slim}]
+  RAILS_VIEW_FILES = %w[app/views/**/*.html.{erb}]
 
   RAILS_CONTROLLER_TEST_FILES = %w[
     test/functional/**/*.rb

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

@@ -6,13 +6,13 @@ module Synvert::Core
   describe Engine::Erb do
     it 'encodes / decodes' do
       source = <<~EOF
-        <%content_for :head do%>
+        <% content_for :head do %>
           <style>
             body {
               background-image: url(<%= asset_path('bg.png') %>);
             }
           </style>
-        <%end%>
+        <% end %>
 
         <%
           foo = 'bar'
@@ -34,14 +34,11 @@ module Synvert::Core
           <% end %>
         <% end %>
       EOF
-      encoded_source = Engine::Erb.encode(source)
-      buffer = Parser::Source::Buffer.new '(test)'
-      buffer.source = encoded_source
-      parser = Parser::CurrentRuby.new
-      parser.reset
-      parser.parse buffer
-
-      expect(Engine::Erb.decode(encoded_source)).to eq source
+      encoded_lines = Engine::Erb.encode(source).split("\n")
+      expect(encoded_lines[0]).to eq '   content_for :head do   '
+      expect(encoded_lines[1]).to eq "                                                     asset_path('bg.png')     "
+      expect(encoded_lines[-2]).to eq '     end   '
+      expect(encoded_lines[-1]).to eq '   end   '
     end
   end
 end

data/spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb

@@ -8,20 +8,20 @@ module Synvert::Core
       subject {
         source = "<% form_for post do |f| %>\n<% end %>"
         source = Engine::Erb.encode(source)
-        node = Parser::CurrentRuby.parse(source).children[1]
+        node = Parser::CurrentRuby.parse(source).children.first
         described_class.new(node).process
       }
 
       it 'gets start' do
-        expect(subject.start).to eq '@output_buffer = output_buffer || ActionView::OutputBuffer.new;'.length
+        expect(subject.start).to eq '<%'.length
       end
 
       it 'gets end' do
-        expect(subject.end).to eq '@output_buffer = output_buffer || ActionView::OutputBuffer.new;;   ; form_for post do |f| ;   ;'.length
+        expect(subject.end).to eq '<%'.length
       end
 
       it 'gets new_code' do
-        expect(subject.new_code).to eq '@output_buffer.append=  form_for post do |f| ;  ;'
+        expect(subject.new_code).to eq '='
       end
     end
   end

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

@@ -287,12 +287,32 @@ module Synvert::Core
         instance.process
         expect(rewriter.affected_files).to be_include('spec/models/post_spec.rb')
       end
+
+      it 'updates erb file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.erb' do
+            with_node type: 'send', receiver: nil, message: 'form_for' do
+              replace_erb_stmt_with_expr
+            end
+          end
+        input = <<~EOS
+          <% form_for @post do |f| %>
+          <% end %>
+        EOS
+        output = <<~EOS
+          <%= 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)
+        expect(File).to receive(:write).with('./app/views/posts/_form.html.erb', output)
+        instance.process
+      end
     end
 
     describe '#test' do
       let(:rewriter) { Rewriter.new('foo', 'bar') }
 
-      it 'writes new code to file' do
+      it 'gets actions if afected' do
         instance =
           Rewriter::Instance.new rewriter, 'spec/models/post_spec.rb' do
             with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
@@ -315,7 +335,7 @@ module Synvert::Core
         ]
       end
 
-      it 'does not write if file content is not changed' do
+      it 'gets nothing if not affected' do
         instance =
           Rewriter::Instance.new rewriter, 'spec/spec_helper.rb' do
             with_node type: 'block', caller: { receiver: 'RSpec', message: 'configure' } do
@@ -334,6 +354,23 @@ module Synvert::Core
         expect(result.file_path).to eq 'spec/spec_helper.rb'
         expect(result.actions).to eq []
       end
+
+      it 'updates erb file' do
+        instance =
+          Rewriter::Instance.new rewriter, 'app/views/posts/_form.html.erb' do
+            with_node type: 'send', receiver: nil, message: 'form_for' do
+              replace_erb_stmt_with_expr
+            end
+          end
+        input = <<~EOS
+          <% 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)
+        result = instance.test
+        expect(result.file_path).to eq 'app/views/posts/_form.html.erb'
+        expect(result.actions).to eq [OpenStruct.new(start: 2, end: 2, new_code: '=')]
+      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.21.4
+  version: 1.21.6
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport