synvert-core 0.49.0 → 0.51.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7201f9f25e9092d5bebf6359bf5fb7889d37dae90187666fc208a2a688d01d
-  data.tar.gz: 6ff9746cef63978f4cbd62cdc9862dabab9f8ba10512f12bbc1292dda19d6483
+  metadata.gz: e3a46917323dc90674ad343c09d06621ac8817a3700c4b4ff205dbfb96a4ad7f
+  data.tar.gz: 1a72f62df4f1711af2b17e2ac2c556ac57bb5cf984cfc9f00d74ce4c7d540442
 SHA512:
-  metadata.gz: e7b44b09b43013829adeb097eafbf143da5d2acbeb731eeb6239388e39dd596c6946ae9cccd91c6e6c9d795bd8118e7a375794f18692461b572bad425b076c9b
-  data.tar.gz: 3b14e2a314d04bb0699125c69bef1a5ed46e2ebf79123017c342dccf66ccf6eb1b1f39f27cca3fa817e5eae51ab41d587b606c0a714bd6df1cbb862b3b9e4646
+  metadata.gz: 8a150ae7cd1eef26c911c29a20911d370ec227405671218c2a4fee51b05ab5cc963002b719c2380c621fa603cd9082500eed91ace57fea6294e16a026e70193b
+  data.tar.gz: 78b9d45a11f131d20790a84d40c4547582d043fc779b77d398660ca35cc0eb415c4b55d8aba3e8b1d949cc864e7c71fe7ad5565af7e47ec4e5a5079b5cd095fc

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 0.51.1 (2021-08-19)
+
+* Require `fileutils`
+
+## 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)
 
 * Support :erange in to_value

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]
@@ -550,7 +550,7 @@ module Parser::AST
       case expected
       when Symbol
         if actual.is_a?(Parser::AST::Node)
-          actual.to_source == ":#{expected}"
+          actual.to_source == ":#{expected}" || actual.to_source == expected.to_s
         else
           actual.to_sym == expected
         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/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/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/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.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.49.0'
+    VERSION = '0.51.1'
   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')]
@@ -423,6 +428,12 @@ describe Parser::AST::Node do
       expect(node).to be_match(type: 'send', receiver: 'params', message: '[]', arguments: [:user])
     end
 
+    it 'matches pair key with symbol' do
+      source = '{ type: :model }'
+      node = parse(source).children[0]
+      expect(node).to be_match(type: 'pair', key: :type)
+    end
+
     it 'matches assign number' do
       source = 'at_least(0)'
       node = parse(source)

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.0
+  version: 0.51.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-19 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