synvert-core 0.49.1 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b694eae9a3ae1910d61accf8d93a52511c49cfa7493ccfb0d8d55f9c42d5b88
-  data.tar.gz: fed8c019f692ad9a4846961558459bf302aa72266fe06c870ba4cdeb1f17d7a8
+  metadata.gz: 346c7567c1fec413a81afbe2ec5348f9cd66ac03ed08e8a6cf0fbf47ba049d08
+  data.tar.gz: c4a274d516c1301eb0be17777bd26a16561943077260508925cc3c5eae43e799
 SHA512:
-  metadata.gz: fb38d31674706ffe1bece171664e05869a66b8362e1e5021b7981c52b04185709afa7b986fd8efcb1070d28bd4e405926a09f73553721f9b9af0c543293377d6
-  data.tar.gz: 93eecc39d451a9d2cbff536db0f99e78dbb0eb405943743c78f39bd8827c002e022ce323e1641d72336158e9eb8e2f73135e2d7e3c9eb12455ce975a369dd854
+  metadata.gz: ee568051d2872db9f81c7d9a3609379eba74db82862ad55976b962e0c4b835dca9f7af74c67014554f6ee919edde2dab050a77fc248bc71ed2c4969009cede1d
+  data.tar.gz: 80dd4085d700581a02dd9507e88e0cbf28e978cbbd61d0e0906c73d2f713abbdd9393caec13d6854b3727d1b1fdd87a673d67323b4b315990a00f06fa23a1f44

data/CHANGELOG.md

@@ -1,7 +1,19 @@
 # CHANGELOG
 
-## 0.49.1 (2021-08-04)
+## 0.52.0 (2021-08-21)
 
+* ``Node#child_node_range`` supports nested child
+* Require `fileutils`
+* Rename `Node#indent` to `Node#column`
+
+## 0.51.0 (2021-08-12)
+
+* Add `wrap` action
+* Add new dsl `redo_until_no_change`
+
+## 0.50.0 (2021-08-11)
+
+* Support `:module` in `body`
 * Fix symbol match
 
 ## 0.49.0 (2021-08-04)

data/lib/synvert/core/node_ext.rb

@@ -110,7 +110,7 @@ module Parser::AST
       case type
       when :begin
         children
-      when :def, :block, :class
+      when :def, :block, :class, :module
         return [] if children[2].nil?
 
         :begin == children[2].type ? children[2].body : children[2..-1]
@@ -322,10 +322,10 @@ module Parser::AST
       loc.expression&.source
     end
 
-    # Get the indent of current node.
+    # Get the column of current node.
     #
-    # @return [Integer] indent.
-    def indent
+    # @return [Integer] column.
+    def column
       loc.expression.column
     end
 
@@ -369,34 +369,35 @@ module Parser::AST
           Parser::Source::Range.new('(string)', loc.begin.begin_pos, loc.end.end_pos)
         end
       else
-        if respond_to?(child_name)
-          child_node = send(child_name)
-          return nil if child_node.nil?
-
-          if child_node.is_a?(Parser::AST::Node)
-            return(
-              Parser::Source::Range.new(
-                '(string)',
-                child_node.loc.expression.begin_pos,
-                child_node.loc.expression.end_pos
-              )
-            )
+        child_node = self
+        child_name.to_s.split('.').each do |key|
+          if child_node.respond_to?(key)
+            child_node = child_node.send(key)
+            return nil if child_node.nil?
+          else
+            raise Synvert::Core::MethodNotSupported,
+                  "child_node_range is not handled for #{child_node.debug_info}, child_name: #{child_name}"
           end
+        end
 
-          # arguments
-          return nil if child_node.empty?
-
+        if child_node.is_a?(Parser::AST::Node)
           return(
             Parser::Source::Range.new(
               '(string)',
-              child_node.first.loc.expression.begin_pos,
-              child_node.last.loc.expression.end_pos
+              child_node.loc.expression.begin_pos,
+              child_node.loc.expression.end_pos
             )
           )
         end
 
-        raise Synvert::Core::MethodNotSupported,
-              "child_node_range is not handled for #{debug_info}, child_name: #{child_name}"
+        # arguments
+        return nil if child_node.empty?
+
+        Parser::Source::Range.new(
+          '(string)',
+          child_node.first.loc.expression.begin_pos,
+          child_node.last.loc.expression.end_pos
+        )
       end
     end
 

data/lib/synvert/core/rewriter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module Synvert::Core
   # Rewriter is the top level namespace in a snippet.
   #
@@ -18,14 +20,15 @@ module Synvert::Core
   class Rewriter
     autoload :Action, 'synvert/core/rewriter/action'
     autoload :AppendAction, 'synvert/core/rewriter/action/append_action'
-    autoload :PrependAction, 'synvert/core/rewriter/action/prepend_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 :ReplaceWithAction, 'synvert/core/rewriter/action/replace_with_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 :RemoveAction, 'synvert/core/rewriter/action/remove_action'
-    autoload :DeleteAction, 'synvert/core/rewriter/action/delete_action'
+    autoload :ReplaceWithAction, 'synvert/core/rewriter/action/replace_with_action'
+    autoload :WrapAction, 'synvert/core/rewriter/action/wrap_action'
 
     autoload :Warning, 'synvert/core/rewriter/warning'
 
@@ -175,13 +178,18 @@ module Synvert::Core
       @sub_snippets = []
       @warnings = []
       @affected_files = Set.new
+      @redo_until_no_change = false
       self.class.register(@group, @name, self)
     end
 
     # Process the rewriter.
     # It will call the block.
     def process
+      @affected_files = Set.new
       instance_eval(&@block)
+      if !@affected_files.empty? && @redo_until_no_change
+        process
+      end
     end
 
     # Process rewriter with sandbox mode.
@@ -314,5 +322,10 @@ module Synvert::Core
         @todo
       end
     end
+
+    # Rerun the snippet until no change.
+    def redo_until_no_change
+      @redo_until_no_change = true
+    end
   end
 end

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

@@ -12,7 +12,7 @@ module Synvert::Core
       if :begin == @node.type
         @node.loc.expression.end_pos
       else
-        @node.loc.expression.end_pos - @node.indent - END_LENGTH
+        @node.loc.expression.end_pos - @node.column - END_LENGTH
       end
     end
 
@@ -31,9 +31,9 @@ module Synvert::Core
     # @return [String] n times whitesphace
     def indent(node)
       if %i[block class].include? node.type
-        ' ' * (node.indent + DEFAULT_INDENT)
+        ' ' * (node.column + DEFAULT_INDENT)
       else
-        ' ' * node.indent
+        ' ' * node.column
       end
     end
   end

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

@@ -4,10 +4,8 @@ module Synvert::Core
   # AddAction to add code to the node.
   class Rewriter::InsertAction < Rewriter::Action
     def initialize(instance, code, at:)
-      @instance = instance
-      @code = code
+      super(instance, code)
       @at = at
-      @node = @instance.current_node
     end
 
     # Begin position to insert code.

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

@@ -24,7 +24,7 @@ module Synvert::Core
     # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
     def indent(node)
-      ' ' * node.indent
+      ' ' * node.column
     end
   end
 end

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

@@ -38,9 +38,9 @@ module Synvert::Core
     # @return [String] n times whitesphace
     def indent(node)
       if %i[block class].include? node.type
-        ' ' * (node.indent + DEFAULT_INDENT)
+        ' ' * (node.column + DEFAULT_INDENT)
       else
-        ' ' * node.indent
+        ' ' * node.column
       end
     end
   end

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

@@ -4,10 +4,8 @@ module Synvert::Core
   # ReplaceAction to replace child node with code.
   class Rewriter::ReplaceAction < Rewriter::Action
     def initialize(instance, *selectors, with:)
-      @instance = instance
+      super(instance, with)
       @selectors = selectors
-      @code = with
-      @node = @instance.current_node
     end
 
     # Begin position of code to replace.

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

@@ -24,7 +24,7 @@ module Synvert::Core
       if rewritten_source.include?("\n")
         new_code = []
         rewritten_source.split("\n").each_with_index do |line, index|
-          new_code << (index == 0 ? line : indent(@node) + line)
+          new_code << (index == 0 ? line : indent + line)
         end
         new_code.join("\n")
       else
@@ -36,10 +36,9 @@ module Synvert::Core
 
     # Indent of the node
     #
-    # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
-    def indent(node)
-      ' ' * node.indent
+    def indent
+      ' ' * @node.column
     end
   end
 end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # WrapAction to warp node within a block, class or module.
+  #
+  # Note: if WrapAction is conflicted with another action (begin_pos and end_pos are overlapped),
+  # we have to put those 2 actions into 2 within_file scopes.
+  class Rewriter::WrapAction < Rewriter::Action
+    def initialize(instance, with:, indent: nil)
+      super(instance, with)
+      @indent = indent || @node.column
+    end
+
+    # Begin position of code to wrap.
+    #
+    # @return [Integer] begin position.
+    def begin_pos
+      @node.loc.expression.begin_pos
+    end
+
+    # End position of code to wrap.
+    #
+    # @return [Integer] end position.
+    def end_pos
+      @node.loc.expression.end_pos
+    end
+
+    # The rewritten source code.
+    #
+    # @return [String] rewritten code.
+    def rewritten_code
+      "#{@code}\n#{' ' * @indent}" +
+      @node.to_source.split("\n").map { |line| "  #{line}" }.join("\n") +
+      "\n#{' ' * @indent}end"
+    end
+  end
+end

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

@@ -279,6 +279,15 @@ module Synvert::Core
       @actions << Rewriter::DeleteAction.new(self, *selectors)
     end
 
+    # Parse wrap with dsl, it creates a [Synvert::Core::Rewriter::WrapAction] to
+    # wrap current node with code.
+    #
+    # @param with [String] code need to be wrapped with.
+    # @param indent [Integer] number of whitespaces.
+    def wrap(with:, indent: nil)
+      @actions << Rewriter::WrapAction.new(self, with: with, indent: indent)
+    end
+
     # Parse warn dsl, it creates a [Synvert::Core::Rewriter::Warning] to save warning message.
     #
     # @param message [String] warning message.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # WithinScope finds out nodes which match rules, then change its scope to matching node.
+  # WithinScope finds out nodes which match rules, then changes its scope to matching node.
   class Rewriter::WithinScope < Rewriter::Scope
     # Initialize a scope
     #
@@ -16,8 +16,9 @@ module Synvert::Core
       @block = block
     end
 
-    # Find out the matching nodes. It checks the current node and iterates all child nodes,
-    # then run the block code with each matching node.
+    # Find out the matching nodes.
+    # It checks the current node and iterates all child nodes,
+    # then run the block code on each matching node.
     def process
       current_node = @instance.current_node
       return unless current_node

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.49.1'
+    VERSION = '0.52.0'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -151,6 +151,11 @@ describe Parser::AST::Node do
       expect(node.body).to be_empty
     end
 
+    it 'gets empty for module node' do
+      node = parse('module Admin; end')
+      expect(node.body).to be_empty
+    end
+
     it 'gets one line for class node' do
       node = parse('class User; attr_accessor :email; end')
       expect(node.body).to eq [parse('attr_accessor :email')]
@@ -354,10 +359,10 @@ describe Parser::AST::Node do
     end
   end
 
-  describe '#indent' do
+  describe '#column' do
     it 'gets column number' do
       node = parse('  FactoryGirl.create :post')
-      expect(node.indent).to eq 2
+      expect(node.column).to eq 2
     end
   end
 
@@ -515,6 +520,12 @@ describe Parser::AST::Node do
         range = node.child_node_range(:pipes)
         expect(range.to_range).to eq(24...30)
       end
+
+      it 'checks caller.receiver' do
+        node = parse('Factory.define :user do |user|; end')
+        range = node.child_node_range('caller.receiver')
+        expect(range.to_range).to eq(0...7)
+      end
     end
 
     context 'class node' do

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  describe Rewriter::WrapAction do
+    subject {
+      source = "class Bar\nend"
+      node = Parser::CurrentRuby.parse(source)
+      instance = double(current_node: node)
+      Rewriter::WrapAction.new(instance, with: 'module Foo')
+    }
+
+    it 'gets begin_pos' do
+      expect(subject.begin_pos).to eq 0
+    end
+
+    it 'gets end_pos' do
+      expect(subject.end_pos).to eq "class Bar\nend".length
+    end
+
+    it 'gets rewritten_code' do
+      expect(subject.rewritten_code).to eq <<~EOS.strip
+        module Foo
+          class Bar
+          end
+        end
+      EOS
+    end
+  end
+end

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

@@ -140,6 +140,11 @@ module Synvert::Core
       instance.delete :dot, :message
     end
 
+    it 'parses wrap with' do
+      expect(Rewriter::WrapAction).to receive(:new).with(instance, with: 'module Foo', indent: nil)
+      instance.wrap with: 'module Foo'
+    end
+
     it 'parses warn' do
       expect(Rewriter::Warning).to receive(:new).with(instance, 'foobar')
       instance.warn 'foobar'

data/spec/synvert/core/rewriter_spec.rb

@@ -214,6 +214,15 @@ module Synvert::Core
       expect(rewriter.todo).to eq "this rewriter doesn't do blah blah blah"
     end
 
+    it 'parses redo_until_no_change' do
+      rewriter =
+        Rewriter.new 'group', 'name' do
+          redo_until_no_change
+        end
+      rewriter.process
+      expect(rewriter.instance_variable_get('@redo_until_no_change')).to be_truthy
+    end
+
     describe 'class methods' do
       before :each do
         Rewriter.clear

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.49.1
+  version: 0.52.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,6 +155,7 @@ files:
 - lib/synvert/core/rewriter/action/replace_action.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
 - lib/synvert/core/rewriter/action/replace_with_action.rb
+- lib/synvert/core/rewriter/action/wrap_action.rb
 - lib/synvert/core/rewriter/any_value.rb
 - lib/synvert/core/rewriter/condition.rb
 - lib/synvert/core/rewriter/condition/if_exist_condition.rb
@@ -182,6 +183,7 @@ files:
 - spec/synvert/core/rewriter/action/replace_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_with_action_spec.rb
+- spec/synvert/core/rewriter/action/wrap_action_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb
 - spec/synvert/core/rewriter/condition/if_only_exist_condition_spec.rb
@@ -192,7 +194,7 @@ files:
 - spec/synvert/core/rewriter/instance_spec.rb
 - spec/synvert/core/rewriter/ruby_version_spec.rb
 - spec/synvert/core/rewriter/scope/goto_scope_spec.rb
-- spec/synvert/core/rewriter/scope/within_scope.rb
+- spec/synvert/core/rewriter/scope/within_scope_spec.rb
 - spec/synvert/core/rewriter/scope_spec.rb
 - spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb
@@ -216,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.
@@ -234,6 +236,7 @@ test_files:
 - spec/synvert/core/rewriter/action/replace_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_with_action_spec.rb
+- spec/synvert/core/rewriter/action/wrap_action_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb
 - spec/synvert/core/rewriter/condition/if_only_exist_condition_spec.rb
@@ -244,7 +247,7 @@ test_files:
 - spec/synvert/core/rewriter/instance_spec.rb
 - spec/synvert/core/rewriter/ruby_version_spec.rb
 - spec/synvert/core/rewriter/scope/goto_scope_spec.rb
-- spec/synvert/core/rewriter/scope/within_scope.rb
+- spec/synvert/core/rewriter/scope/within_scope_spec.rb
 - spec/synvert/core/rewriter/scope_spec.rb
 - spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb