synvert-core 1.4.0 → 1.6.0

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

@@ -4,37 +4,40 @@ module Synvert::Core
   # ReplaceErbStmtWithExprAction to replace erb stmt code to expr,
   # @example
   #   e.g. <% form_for ... %> => <%= form_for ... %>.
-  class Rewriter::ReplaceErbStmtWithExprAction < Rewriter::Action
+  class Rewriter::ReplaceErbStmtWithExprAction < NodeMutation::Action
     # Initialize a ReplaceErbStmtWithExprAction.
     #
-    # @param instance [Synvert::Core::Rewriter::Instance]
-    def initialize(instance)
-      super(instance, nil)
+    # @param node [Synvert::Core::Rewriter::Node]
+    def initialize(node)
+      super(node, nil)
     end
 
-    # The rewritten erb expr code.
+    # The new erb expr code.
     #
-    # @return [String] rewritten code.
-    def rewritten_code
-      @node.loc.expression.source_buffer.source[begin_pos...end_pos]
-           .sub(Engine::ERUBY_STMT_SPLITTER, '@output_buffer.append= ')
-           .sub(Engine::ERUBY_STMT_SPLITTER, Engine::ERUBY_EXPR_SPLITTER)
+    # @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_begin_pos = @node.loc.expression.begin_pos
-      while @node.loc.expression.source_buffer.source[node_begin_pos -= 1] == ' '
+      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
-      @begin_pos = node_begin_pos - Engine::ERUBY_STMT_SPLITTER.length + 1
+      @start = whitespace_index - Engine::ERUBY_STMT_SPLITTER.length + 1
 
-      node_begin_pos = @node.loc.expression.begin_pos
-      node_begin_pos += @node.loc.expression.source.index 'do'
-      while @node.loc.expression.source_buffer.source[node_begin_pos += 1] != '@'
+      at_index = node_start + node_source.index('do')
+      while file_content[at_index += 1] != '@'
       end
-      @end_pos = node_begin_pos
+      @end = at_index
     end
   end
 end

data/lib/synvert/core/rewriter/condition/if_exist_condition.rb

@@ -9,11 +9,7 @@ module Synvert::Core
     #
     # @return [Boolean]
     def match?
-      match = false
-      @instance.current_node.recursive_children do |child_node|
-        match ||= child_node&.match?(@rules)
-      end
-      match
+      @node_query.query_nodes(target_node, including_self: false, stop_at_first_match: true).size > 0
     end
   end
 end

data/lib/synvert/core/rewriter/condition/if_only_exist_condition.rb

@@ -9,7 +9,7 @@ module Synvert::Core
     #
     # @return [Boolean]
     def match?
-      @instance.current_node.body.size == 1 && @instance.current_node.body.first.match?(@rules)
+      target_node.body.size == 1 && @node_query.match_node?(target_node.body.first)
     end
   end
 end

data/lib/synvert/core/rewriter/condition/unless_exist_condition.rb

@@ -9,11 +9,7 @@ module Synvert::Core
     #
     # return [Boolean]
     def match?
-      match = false
-      @instance.current_node.recursive_children do |child_node|
-        match ||= child_node&.match?(@rules)
-      end
-      !match
+      @node_query.query_nodes(target_node, including_self: false, stop_at_first_match: true).size == 0
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Synvert::Core
     # @yield run when condition matches
     def initialize(instance, rules, &block)
       @instance = instance
-      @rules = rules
+      @node_query = NodeQuery.new(rules)
       @block = block
     end
 
@@ -27,5 +27,9 @@ module Synvert::Core
     def match?
       raise NotImplementedError, 'must be implemented by subclasses'
     end
+
+    def target_node
+      @instance.current_node
+    end
   end
 end

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

@@ -20,66 +20,13 @@ module Synvert::Core
       rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
 
-    class << self
-      # Get file source.
-      #
-      # @param file_path [String] file path
-      # @return [String] file source
-      def file_source(file_path)
-        @file_source ||= {}
-        @file_source[file_path] ||=
-          begin
-            source = File.read(file_path, encoding: 'UTF-8')
-            source = Engine::ERB.encode(source) if /\.erb$/.match?(file_path)
-            source
-          end
-      end
-
-      # Get file ast.
-      #
-      # @param file_path [String] file path
-      # @return [String] ast node for file
-      def file_ast(file_path)
-        @file_ast ||= {}
-        @file_ast[file_path] ||=
-          begin
-            buffer = Parser::Source::Buffer.new file_path
-            buffer.source = file_source(file_path)
-
-            parser = Parser::CurrentRuby.new
-            parser.reset
-            parser.parse buffer
-          end
-      end
-
-      # Write source to file and remove cached file source and ast.
-      #
-      # @param file_path [String] file path
-      # @param source [String] file source
-      def write_file(file_path, source)
-        source = Engine::ERB.decode(source) if /\.erb/.match?(file_path)
-        File.write(file_path, source.gsub(/ +\n/, "\n"))
-        @file_source[file_path] = nil
-        @file_ast[file_path] = nil
-      end
-
-      # Reset file source and ast.
-      def reset
-        @file_source = {}
-        @file_ast = {}
-      end
-    end
-
     # @!attribute [rw] current_node
     #   @return current parsing node
     # @!attribute [rw] current_file
     #   @return current filename
-    attr_accessor :current_node, :current_file
-
-    # Current file source
-    def file_source
-      self.class.file_source(current_file)
-    end
+    # @!attribute [rw] current_mutation
+    #   @return current mutation
+    attr_accessor :current_node, :current_file, :current_mutation
 
     # Process the instance.
     # It finds specified files, for each file, it executes the block code, rewrites the original code,
@@ -132,11 +79,13 @@ module Synvert::Core
     #   # matches FactoryBot.create(:user)
     #   find_node '.send[receiver=FactoryBot][message=create][arguments.size=1]' do
     #   end
-    # @param query_string [String] query string to find matching ast nodes.
+    # @param nql [String] node query language to find matching ast nodes.
     # @yield run on the matching nodes.
     # @raise [Synvert::Core::NodeQuery::Compiler::ParseError] if query string is invalid.
-    def find_node(query_string, &block)
-      Rewriter::QueryScope.new(self, query_string, &block).process
+    def find_node(nql, options = {}, &block)
+      Rewriter::QueryScope.new(self, nql, options, &block).process
+    rescue NodeQueryLexer::ScanError, Racc::ParseError => e
+      raise NodeQuery::Compiler::ParseError, "Invalid query string: #{nql}"
     end
 
     # Parse +within_node+ dsl, it creates a {Synvert::Core::Rewriter::WithinScope} to recursively find matching ast nodes,
@@ -147,12 +96,11 @@ module Synvert::Core
     #   end
     # @param rules [Hash] rules to find mathing ast nodes.
     # @param options [Hash] optional
-    # @option stop_when_match [Boolean] set if stop when match, default is false
-    # @option direct [Boolean] set if find direct matching ast nodes, default is false
+    # @option including_self [Boolean] set if query the current node, default is true
+    # @option stop_at_first_match [Boolean] set if stop at first match, default is false
+    # @option recursive [Boolean] set if recursively query child nodes, default is true
     # @yield run on the matching nodes.
     def within_node(rules, options = {}, &block)
-      options[:stop_when_match] ||= false
-      options[:direct] ||= false
       Rewriter::WithinScope.new(self, rules, options, &block).process
     end
 
@@ -231,7 +179,7 @@ module Synvert::Core
     #   end
     # @param code [String] code need to be appended.
     def append(code)
-      @actions << Rewriter::AppendAction.new(self, code).process
+      @current_mutation.append(@current_node, code)
     end
 
     # Parse +prepend+ dsl, it creates a {Synvert::Core::Rewriter::PrependAction} to
@@ -250,7 +198,7 @@ module Synvert::Core
     #   end
     # @param code [String] code need to be prepended.
     def prepend(code)
-      @actions << Rewriter::PrependAction.new(self, code).process
+      @current_mutation.prepend(@current_node, code)
     end
 
     # Parse +insert+ dsl, it creates a {Synvert::Core::Rewriter::InsertAction} to insert code.
@@ -265,7 +213,7 @@ module Synvert::Core
     # @param at [String] insert position, beginning or end
     # @param to [String] where to insert, if it is nil, will insert to current node.
     def insert(code, at: 'end', to: nil)
-      @actions << Rewriter::InsertAction.new(self, code, at: at, to: to).process
+      @current_mutation.insert(@current_node, code, at: at, to: to)
     end
 
     # Parse +insert_after+ dsl, it creates a {Synvert::Core::Rewriter::InsertAfterAction} to
@@ -280,7 +228,22 @@ module Synvert::Core
     #   end
     # @param code [String] code need to be inserted.
     def insert_after(code)
-      @actions << Rewriter::InsertAfterAction.new(self, code).process
+      @current_mutation.insert_after(@current_node, code)
+    end
+
+    # Parse +replace_erb_stmt_with_expr+ dsl, it creates a {Synvert::Core::Rewriter::ReplaceErbStmtWithExprAction} to
+    # replace erb stmt code to expr code.
+    # @example
+    #   # <% form_for post do |f| %>
+    #   # <% end %>
+    #   # =>
+    #   # <%= form_for post do |f| %>
+    #   # <% end %>
+    #   with_node type: 'block', caller: { type: 'send', receiver: nil, message: 'form_for' } do
+    #     replace_erb_stmt_with_expr
+    #   end
+    def replace_erb_stmt_with_expr
+      @current_mutation.actions << Rewriter::ReplaceErbStmtWithExprAction.new(@current_node).process
     end
 
     # Parse +replace_with+ dsl, it creates a {Synvert::Core::Rewriter::ReplaceWithAction} to
@@ -294,7 +257,7 @@ module Synvert::Core
     #   end
     # @param code [String] code need to be replaced with.
     def replace_with(code)
-      @actions << Rewriter::ReplaceWithAction.new(self, code).process
+      @current_mutation.replace_with(@current_node, code)
     end
 
     # Parse +replace+ dsl, it creates a {Synvert::Core::Rewriter::ReplaceAction} to
@@ -310,22 +273,7 @@ module Synvert::Core
     # @param selectors [Array<Symbol>] selector names of child node.
     # @param with [String] code need to be replaced with.
     def replace(*selectors, with:)
-      @actions << Rewriter::ReplaceAction.new(self, *selectors, with: with).process
-    end
-
-    # Parse +replace_erb_stmt_with_expr+ dsl, it creates a {Synvert::Core::Rewriter::ReplaceErbStmtWithExprAction} to
-    # replace erb stmt code to expr code.
-    # @example
-    #   # <% form_for post do |f| %>
-    #   # <% end %>
-    #   # =>
-    #   # <%= form_for post do |f| %>
-    #   # <% end %>
-    #   with_node type: 'block', caller: { type: 'send', receiver: nil, message: 'form_for' } do
-    #     replace_erb_stmt_with_expr
-    #   end
-    def replace_erb_stmt_with_expr
-      @actions << Rewriter::ReplaceErbStmtWithExprAction.new(self).process
+      @current_mutation.replace(@current_node, *selectors, with: with)
     end
 
     # Parse +remove+ dsl, it creates a {Synvert::Core::Rewriter::RemoveAction} to remove current node.
@@ -336,7 +284,7 @@ module Synvert::Core
     # @param options [Hash] options.
     # @option and_comma [Boolean] delete extra comma.
     def remove(**options)
-      @actions << Rewriter::RemoveAction.new(self, **options).process
+      @current_mutation.remove(@current_node, **options)
     end
 
     # Parse +delete+ dsl, it creates a {Synvert::Core::Rewriter::DeleteAction} to delete child nodes.
@@ -351,7 +299,7 @@ module Synvert::Core
     # @param options [Hash]
     # @option and_comma [Boolean] delete extra comma.
     def delete(*selectors, **options)
-      @actions << Rewriter::DeleteAction.new(self, *selectors, **options).process
+      @current_mutation.delete(@current_node, *selectors, **options)
     end
 
     # Parse +wrap+ dsl, it creates a {Synvert::Core::Rewriter::WrapAction} to
@@ -368,9 +316,8 @@ module Synvert::Core
     #     wrap with: 'module Synvert'
     #   end
     # @param with [String] code need to be wrapped with.
-    # @param indent [Integer, nil] number of whitespaces.
-    def wrap(with:, indent: nil)
-      @actions << Rewriter::WrapAction.new(self, with: with, indent: indent).process
+    def wrap(with:)
+      @current_mutation.wrap(@current_node, with: with)
     end
 
     # Parse +warn+ dsl, it creates a {Synvert::Core::Rewriter::Warning} to save warning message.
@@ -397,65 +344,69 @@ module Synvert::Core
     #
     # @param file_path [String]
     def process_file(file_path)
-      begin
-        puts file_path if Configuration.show_run_process
-        conflict_actions = []
-        source = +self.class.file_source(file_path)
-        ast = self.class.file_ast(file_path)
-
-        @current_file = file_path
-
-        process_with_node(ast) do
-          instance_eval(&@block)
-        rescue NoMethodError
-          puts @current_node.debug_info
-          raise
-        end
-
-        if @actions.length > 0
-          @actions.sort_by! { |action| [action.begin_pos, action.end_pos] }
-          conflict_actions = get_conflict_actions
-          @actions.reverse_each do |action|
-            source[action.begin_pos...action.end_pos] = action.rewritten_code
+      puts file_path if Configuration.show_run_process
+
+      @current_file = file_path
+      while true
+        source = read_source(file_path)
+        @current_mutation = NodeMutation.new(source)
+        begin
+          node = parse_code(file_path, source)
+
+          process_with_node(node) do
+            instance_eval(&@block)
+          rescue NoMethodError => e
+            puts [
+              "error: #{e.message}",
+              "file: #{file_path}",
+              "source: #{source}",
+              "line: #{current_node.line}"
+            ].join("\n")
+            raise
           end
-          @actions = []
 
-          update_file(file_path, source)
+          result = @current_mutation.process
+          if result.affected?
+            @rewriter.add_affected_file(file_path)
+            write_source(file_path, result.new_source)
+          end
+          break unless result.conflicted?
+        rescue Parser::SyntaxError
+          puts "[Warn] file #{file_path} was not parsed correctly."
+          # do nothing, iterate next file
         end
-      rescue Parser::SyntaxError
-        puts "[Warn] file #{file_path} was not parsed correctly."
-        # do nothing, iterate next file
-      end while !conflict_actions.empty?
+      end
     end
 
-    # It changes source code from bottom to top, and it can change source code twice at the same time,
-    # So if there is an overlap between two actions, it removes the conflict actions and operate them in the next loop.
-    def get_conflict_actions
-      i = @actions.length - 1
-      j = i - 1
-      conflict_actions = []
-      return if i < 0
-
-      begin_pos = @actions[i].begin_pos
-      while j > -1
-        if begin_pos < @actions[j].end_pos
-          conflict_actions << @actions.delete_at(j)
-        else
-          i = j
-          begin_pos = @actions[i].begin_pos
-        end
-        j -= 1
-      end
-      conflict_actions
+    # Read file source.
+    # @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
+    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
 
-    # It updates a file with new source code.
+    # Parse code ast node.
     #
-    # @param file_path [String] the file path
-    # @param source [String] the new source code
-    def update_file(file_path, source)
-      self.class.write_file(file_path, source)
-      @rewriter.add_affected_file(file_path)
+    # @param file_path [String] file path
+    # @param file_path [String] file path
+    # @return [Node] ast node for file
+    def parse_code(file_path, source)
+      buffer = Parser::Source::Buffer.new file_path
+      buffer.source = source
+
+      parser = Parser::CurrentRuby.new
+      parser.reset
+      parser.parse buffer
     end
   end
 end

data/lib/synvert/core/rewriter/scope/query_scope.rb

@@ -6,11 +6,14 @@ module Synvert::Core
     # Initialize a QueryScope.
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
-    # @param query_string [String]
+    # @param nql [String]
+    # @param options [Hash]
     # @yield run on all matching nodes
-    def initialize(instance, query_string, &block)
+    def initialize(instance, nql, options = {}, &block)
       super(instance, &block)
-      @query_string = query_string
+
+      @options = { including_self: true, stop_at_first_match: false, recursive: true }.merge(options)
+      @node_query = NodeQuery.new(nql)
     end
 
     # Find out the matching nodes.
@@ -22,15 +25,14 @@ module Synvert::Core
       current_node = @instance.current_node
       return unless current_node
 
+      matching_nodes = @node_query.query_nodes(current_node, @options)
       @instance.process_with_node(current_node) do
-        NodeQuery::Parser.new.parse(@query_string).query_nodes(current_node).each do |node|
+        matching_nodes.each do |node|
           @instance.process_with_node(node) do
             @instance.instance_eval(&@block)
           end
         end
       end
-    rescue NodeQuery::Lexer::ScanError, Racc::ParseError => e
-      raise NodeQuery::Compiler::ParseError, "Invalid query string: #{@query_string}"
     end
   end
 end

data/lib/synvert/core/rewriter/scope/within_scope.rb

@@ -11,8 +11,9 @@ module Synvert::Core
     # @yield run on all matching nodes
     def initialize(instance, rules, options = {}, &block)
       super(instance, &block)
-      @rules = rules
-      @options = options
+
+      @options = { including_self: true, stop_at_first_match: false, recursive: true }.merge(options)
+      @node_query = NodeQuery.new(rules)
     end
 
     # Find out the matching nodes.
@@ -22,14 +23,7 @@ module Synvert::Core
       current_node = @instance.current_node
       return unless current_node
 
-      matching_nodes =
-        if @options[:direct]
-          find_direct_matching_nodes(current_node)
-        elsif @options[:stop_when_match]
-          find_matching_nodes(current_node)
-        else
-          find_recursive_matching_nodes(current_node)
-        end
+      matching_nodes = @node_query.query_nodes(current_node, @options)
       @instance.process_with_node current_node do
         matching_nodes.each do |matching_node|
           @instance.process_with_node matching_node do
@@ -38,82 +32,5 @@ module Synvert::Core
         end
       end
     end
-
-    private
-
-    # Find the matching nodes only in current or direct children.
-    #
-    # @param current_node [Parser::AST::Node]
-    def find_direct_matching_nodes(current_node)
-      matching_nodes = []
-      if current_node.is_a?(Parser::AST::Node)
-        if current_node.type == :begin
-          current_node.children.each do |child_node|
-            matching_nodes << child_node if child_node.match?(@rules)
-          end
-        elsif current_node.match?(@rules)
-          matching_nodes << current_node
-        end
-      else
-        current_node.each do |child_node|
-          matching_nodes << child_node if child_node.match?(@rules)
-        end
-      end
-      matching_nodes
-    end
-
-    # Find matching nodes in all recursive children.
-    #
-    # @param current_node [Parser::AST::Node]
-    def find_recursive_matching_nodes(current_node)
-      matching_nodes = []
-      if current_node.is_a?(Parser::AST::Node)
-        matching_nodes << current_node if current_node.match?(@rules)
-        current_node.recursive_children do |child_node|
-          matching_nodes << child_node if child_node.match?(@rules)
-        end
-      else
-        current_node.each do |node|
-          matching_nodes << node if node.match?(@rules)
-          node.recursive_children do |child_node|
-            matching_nodes << child_node if child_node.match?(@rules)
-          end
-        end
-      end
-      matching_nodes
-    end
-
-    # Find matching nodes in recursive children but do not continue on matching nodes.
-    #
-    # @param current_node [Parser::AST::Node]
-    def find_matching_nodes(current_node)
-      matching_nodes = []
-      if current_node.is_a?(Parser::AST::Node)
-        if current_node.match?(@rules)
-          matching_nodes << current_node
-          return matching_nodes
-        end
-        current_node.recursive_children do |child_node|
-          if child_node.match?(@rules)
-            matching_nodes << child_node
-            next :stop
-          end
-        end
-      else
-        current_node.each do |node|
-          if node.match?(@rules)
-            matching_nodes << node
-            next
-          end
-          node.recursive_children do |child_node|
-            if child_node.match?(@rules)
-              matching_nodes << child_node
-              next :stop
-            end
-          end
-        end
-      end
-      matching_nodes
-    end
   end
 end

data/lib/synvert/core/rewriter.rb

@@ -8,17 +8,7 @@ module Synvert::Core
   # One Rewriter checks if the depndency version matches, and it can contain one or many {Synvert::Core::Rewriter::Instance},
   # which define the behavior what files and what codes to detect and rewrite to what code.
   class Rewriter
-    autoload :Action, 'synvert/core/rewriter/action'
-    autoload :AppendAction, 'synvert/core/rewriter/action/append_action'
-    autoload :DeleteAction, 'synvert/core/rewriter/action/delete_action'
-    autoload :InsertAction, 'synvert/core/rewriter/action/insert_action'
-    autoload :InsertAfterAction, 'synvert/core/rewriter/action/insert_after_action'
-    autoload :RemoveAction, 'synvert/core/rewriter/action/remove_action'
-    autoload :PrependAction, 'synvert/core/rewriter/action/prepend_action'
-    autoload :ReplaceAction, 'synvert/core/rewriter/action/replace_action'
     autoload :ReplaceErbStmtWithExprAction, 'synvert/core/rewriter/action/replace_erb_stmt_with_expr_action'
-    autoload :ReplaceWithAction, 'synvert/core/rewriter/action/replace_with_action'
-    autoload :WrapAction, 'synvert/core/rewriter/action/wrap_action'
 
     autoload :Warning, 'synvert/core/rewriter/warning'
 

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.4.0'
+    VERSION = '1.6.0'
   end
 end

data/lib/synvert/core.rb

@@ -4,14 +4,13 @@ require 'synvert/core/version'
 require 'bundler'
 require 'parser'
 require 'parser/current'
-require 'ast'
+require 'parser_node_ext'
+require_relative './core/node_ext'
 require 'active_support'
-require 'active_support/core_ext/object'
-require 'active_support/core_ext/array'
 require 'erubis'
 require 'set'
-require 'synvert/core/array_ext'
-require 'synvert/core/node_ext'
+require 'node_query'
+require 'node_mutation'
 
 module Synvert
   module Core
@@ -20,7 +19,6 @@ module Synvert
     autoload :Engine, 'synvert/core/engine'
     autoload :RewriterNotFound, 'synvert/core/exceptions'
     autoload :MethodNotSupported, 'synvert/core/exceptions'
-    autoload :NodeQuery, 'synvert/core/node_query'
   end
 end