synvert-core 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e62c155c2171dfeda2631d99c88992f6ffbc9e0f50341d9db79262ef636ad2
-  data.tar.gz: 4dfec29835aa657065eb5aa35f16a804971674d81215f1b3c860dbe9b3db06fc
+  metadata.gz: bc8d09c26c005557ec18ab8d877a8cbf5af6ba0f9de0ab44efe40298419647fa
+  data.tar.gz: abcc824dfbf93e3aab1d3d3e33dd3862886015b899b79ce7ceb97066d2b47e85
 SHA512:
-  metadata.gz: a95b38e7f84022599442040b6717e4551b7333cb28cf4337f1d0ab47610ea6ea7cec761490871579a57e25928758e8fd8f3973b56291f3198b5074f5633b0af5
-  data.tar.gz: e841587f4b654b76e0790f1272f1ff8fa2bdb2c747d1aae9126d51c4c22978ab12b393725e03118b104f6d573bfb7f63bdd2fa9eab36032a56db75958f4b7ac1
+  metadata.gz: f46377a1cc5b7eb69bb69608b3f018eae1e4cd2f4aed6bf3e3200bfa1f1fa9527829ba2a64fb0c9dd909e0125028f6fef15100fb76b0a88acfb4f8c6b9e33879
+  data.tar.gz: 3de1571672cff28c01937d4f1281873592847578367320123d32e657429634cde392000b9400124be0ae90f3d896627763864eaabe7539df13e98886b1c00ce1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 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`

data/lib/synvert/core/rewriter.rb

@@ -18,14 +18,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 +176,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 +320,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/wrap_action.rb

@@ -0,0 +1,39 @@
+# 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)
+      @instance = instance
+      @code = with
+      @node = @instance.current_node
+      @indent = indent || @node.indent
+    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/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.50.0'
+    VERSION = '0.51.0'
   end
 end

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Richard Huang
@@ -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
@@ -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