synvert-core 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27baedce6ee22b8bac638cfab9caceb27f8fef82dd4af238b3b239ff64d9d19a
-  data.tar.gz: 8e0ef98086e9a0e74d87ea62899628bb0271fcf1a011b380bc51e224061606e4
+  metadata.gz: c463c762e05473bfe948bce32491283f192da99afd514d4a32d9e144e86562d8
+  data.tar.gz: 142b810da918430620441d636e050c08b69abd84d6b1a14db9c76874fc4ce665
 SHA512:
-  metadata.gz: 0aa91008955762f7a8f6362d0e23372651430e85eb6804b59c2cf9ea1577deda113c6dddf1ae92d44623bbd1bb3328f8414c0c8c8a910df9d575c294301e3c9a
-  data.tar.gz: 3ec198c9d26fd0e8166dbaf102f606e89f52751f1152a50aa6283d525e848970765cf04d67bcb5f7ca6008c029c3c7f876a8a087d9d5ffbce688b0b22f4b4be6
+  metadata.gz: 87953d43e4e0988a29197c708e6dc1a453de2fde0ebd1d3bd44dc7b8b191558bfd54e8637674a8bb8ce152eb2825a86c434737a5e889484e1654fb5aeef92417
+  data.tar.gz: d1d43308e1f1afb0e1547aa79c14365e379376a666e83b0508fdd525aa00c9078cb780be671f43ed27597bc087e57a451494d603a33eaea19337008fdf846401

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.14.0 (2022-10-25)
+
+* `insert_after` and `insert_before` accepts `to` option
+* Add `configure` dsl to configure the strategy
+
 ## 1.13.1 (2022-10-17)
 
 * Do not send hash to keyword arguments

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.13.1)
+    synvert-core (1.14.0)
       activesupport (< 7.0.0)
       erubis
       node_mutation
@@ -50,10 +50,10 @@ GEM
     method_source (1.0.0)
     minitest (5.16.3)
     nenv (0.3.0)
-    node_mutation (1.5.0)
+    node_mutation (1.7.0)
       activesupport (< 7.0.0)
       erubis
-    node_query (1.8.1)
+    node_query (1.9.0)
       activesupport (< 7.0.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -61,7 +61,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    parser_node_ext (0.4.0)
+    parser_node_ext (0.4.1)
       parser
     pry (0.14.1)
       coderay (~> 1.1)

data/README.md

@@ -59,6 +59,7 @@ Want to use the CLI, check out [synvert-ruby](https://github.com/xinminlabs/synv
 
 DSLs are as follows
 
+* [configure](./Synvert/Core/Rewriter.html#configure-instance_method) - configure the rewriter
 * [description](./Synvert/Core/Rewriter.html#description-instance_method) - set description of the rewriter
 * [if_ruby](./Synvert/Core/Rewriter.html#if_ruby-instance_method) - check if ruby version is greater than or equal to the specified ruby version
 * [if_gem](./Synvert/Core/Rewriter.html#if_gem-instance_method) - compare version of specified gem

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

@@ -8,6 +8,7 @@ module Synvert::Core
   # One instance can contain one or many {Synvert::Core::Rewriter::Scope} and {Synvert::Rewriter::Condition}.
   class Rewriter::Instance
     include Rewriter::Helper
+
     # Initialize an Instance.
     #
     # @param rewriter [Synvert::Core::Rewriter]
@@ -18,6 +19,11 @@ module Synvert::Core
       @actions = []
       @file_patterns = file_patterns
       @block = block
+      strategy = NodeMutation::Strategy::KEEP_RUNNING
+      if rewriter.options[:strategy] == Strategy::ALLOW_INSERT_AT_SAME_POSITION
+        strategy |=  NodeMutation::Strategy::ALLOW_INSERT_AT_SAME_POSITION
+      end
+      NodeMutation.configure({ strategy: strategy })
       rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
 
@@ -85,7 +91,7 @@ module Synvert::Core
     # DSL #
     #######
 
-    # Parse +within_node+ dsl, it creates a {Synvert::Core::Rewriter::WithinScope} to recursively find matching ast nodes,
+    # It creates a {Synvert::Core::Rewriter::WithinScope} to recursively find matching ast nodes,
     # then continue operating on each matching ast node.
     # @example
     #   # matches User.find_by_login('test')
@@ -109,7 +115,7 @@ module Synvert::Core
     alias with_node within_node
     alias find_node within_node
 
-    # Parse +goto_node+ dsl, it creates a {Synvert::Core::Rewriter::GotoScope} to go to a child node,
+    # It creates a {Synvert::Core::Rewriter::GotoScope} to go to a child node,
     # then continue operating on the child node.
     # @example
     #   # head status: 406
@@ -123,7 +129,7 @@ module Synvert::Core
       Rewriter::GotoScope.new(self, child_node_name, &block).process
     end
 
-    # Parse +if_exist_node+ dsl, it creates a {Synvert::Core::Rewriter::IfExistCondition} to check
+    # It creates a {Synvert::Core::Rewriter::IfExistCondition} to check
     # if matching nodes exist in the child nodes, if so, then continue operating on each matching ast node.
     # @example
     #   # Klass.any_instance.stub(:message)
@@ -137,7 +143,7 @@ module Synvert::Core
       Rewriter::IfExistCondition.new(self, nql_or_rules, &block).process
     end
 
-    # Parse +unless_exist_node+ dsl, it creates a {Synvert::Core::Rewriter::UnlessExistCondition} to check
+    # It creates a {Synvert::Core::Rewriter::UnlessExistCondition} to check
     # if matching nodes doesn't exist in the child nodes, if so, then continue operating on each matching ast node.
     # @example
     #   # obj.stub(:message)
@@ -151,7 +157,7 @@ module Synvert::Core
       Rewriter::UnlessExistCondition.new(self, nql_or_rules, &block).process
     end
 
-    # Parse +if_only_exist_node+ dsl, it creates a {Synvert::Core::Rewriter::IfOnlyExistCondition} to check
+    # It creates a {Synvert::Core::Rewriter::IfOnlyExistCondition} to check
     # if current node has only one child node and the child node matches,
     # if so, then continue operating on each matching ast node.
     # @example
@@ -166,7 +172,7 @@ module Synvert::Core
       Rewriter::IfOnlyExistCondition.new(self, nql_or_rules, &block).process
     end
 
-    # Parse +append+ dsl, it appends the code to the bottom of current node body.
+    # It appends the code to the bottom of current node body.
     # @example
     #   # def teardown
     #   #   clean_something
@@ -184,7 +190,7 @@ module Synvert::Core
       @current_mutation.append(@current_node, code)
     end
 
-    # Parse +prepend+ dsl, it prepends the code to the top of current node body.
+    # It prepends the code to the top of current node body.
     # @example
     #   # def setup
     #   #   do_something
@@ -202,7 +208,7 @@ module Synvert::Core
       @current_mutation.prepend(@current_node, code)
     end
 
-    # Parse +insert+ dsl, it inserts code.
+    # It inserts code.
     # @example
     #   # open('http://test.com')
     #   # =>
@@ -217,7 +223,7 @@ module Synvert::Core
       @current_mutation.insert(@current_node, code, at: at, to: to)
     end
 
-    # Parse +insert_after+ dsl, it inserts the code next to the current node.
+    # It inserts the code next to the current node.
     # @example
     #   # Synvert::Application.config.secret_token = "0447aa931d42918bfb934750bb78257088fb671186b5d1b6f9fddf126fc8a14d34f1d045cefab3900751c3da121a8dd929aec9bafe975f1cabb48232b4002e4e"
     #   # =>
@@ -227,12 +233,12 @@ module Synvert::Core
     #     insert_after "{{receiver}}.secret_key_base = \"#{SecureRandom.hex(64)}\""
     #   end
     # @param code [String] code need to be inserted.
-    def insert_after(code)
+    def insert_after(code, to: nil)
       column = ' ' * NodeMutation.adapter.get_start_loc(@current_node).column
-      @current_mutation.insert(@current_node, "\n#{column}#{code}", at: 'end')
+      @current_mutation.insert(@current_node, "\n#{column}#{code}", at: 'end', to: to)
     end
 
-    # Parse +insert_before+ dsl, it inserts the code previous to the current node.
+    # It inserts the code previous to the current node.
     # @example
     #   # Synvert::Application.config.secret_token = "0447aa931d42918bfb934750bb78257088fb671186b5d1b6f9fddf126fc8a14d34f1d045cefab3900751c3da121a8dd929aec9bafe975f1cabb48232b4002e4e"
     #   # =>
@@ -242,12 +248,12 @@ module Synvert::Core
     #     insert_before "{{receiver}}.secret_key_base = \"#{SecureRandom.hex(64)}\""
     #   end
     # @param code [String] code need to be inserted.
-    def insert_before(code)
+    def insert_before(code, to: nil)
       column = ' ' * NodeMutation.adapter.get_start_loc(@current_node).column
-      @current_mutation.insert(@current_node, "#{code}\n#{column}", at: 'beginning')
+      @current_mutation.insert(@current_node, "#{code}\n#{column}", at: 'beginning', to: to)
     end
 
-    # Parse +replace_erb_stmt_with_expr+ dsl, it replaces erb stmt code to expr code.
+    # It replaces erb stmt code to expr code.
     # @example
     #   # <% form_for post do |f| %>
     #   # <% end %>
@@ -261,7 +267,7 @@ module Synvert::Core
       @current_mutation.actions << Rewriter::ReplaceErbStmtWithExprAction.new(@current_node).process
     end
 
-    # Parse +replace_with+ dsl, it replaces the whole code of current node.
+    # It replaces the whole code of current node.
     # @example
     #   # obj.stub(:foo => 1, :bar => 2)
     #   # =>
@@ -274,7 +280,7 @@ module Synvert::Core
       @current_mutation.replace_with(@current_node, code)
     end
 
-    # Parse +replace+ dsl, it replaces the code of specified child nodes.
+    # It replaces the code of specified child nodes.
     # @example
     #   # assert(object.empty?)
     #   # =>
@@ -289,7 +295,7 @@ module Synvert::Core
       @current_mutation.replace(@current_node, *selectors, with: with)
     end
 
-    # Parse +remove+ dsl, it removes current node.
+    # It removes current node.
     # @example
     #   with_node type: 'send', message: { in: %w[puts p] } do
     #     remove
@@ -300,7 +306,7 @@ module Synvert::Core
       @current_mutation.remove(@current_node, **options)
     end
 
-    # Parse +delete+ dsl, it deletes child nodes.
+    # It deletes child nodes.
     # @example
     #   # FactoryBot.create(...)
     #   # =>
@@ -315,7 +321,7 @@ module Synvert::Core
       @current_mutation.delete(@current_node, *selectors, **options)
     end
 
-    # Parse +wrap+ dsl, it wraps current node with code.
+    # It wraps current node with code.
     # @example
     #   # class Foobar
     #   # end
@@ -332,12 +338,12 @@ module Synvert::Core
       @current_mutation.wrap(@current_node, with: with)
     end
 
-    # Parse +noop dsl.
+    # No operation.
     def noop
       @current_mutation.noop(@current_node)
     end
 
-    # Parse +warn+ dsl, it creates a {Synvert::Core::Rewriter::Warning} to save warning message.
+    # It creates a {Synvert::Core::Rewriter::Warning} to save warning message.
     # @example
     #   within_files 'vendor/plugins' do
     #     warn 'Rails::Plugin is deprecated and will be removed in Rails 4.0. Instead of adding plugins to vendor/plugins use gems or bundler with path or git dependencies.'

data/lib/synvert/core/rewriter.rb

@@ -163,8 +163,18 @@ module Synvert::Core
     # DSL #
     #######
 
-    # Parse +description+ dsl, it sets description of the rewrite.
-    # Or get description.
+    # Configure the rewriter
+    # @example
+    #   configure({ strategy: 'allow_insert_at_same_position' })
+    # @param options [Hash]
+    # @option strategy [String] allow_insert_at_same_position
+    def configure(options)
+      if options[:strategy]
+        @options[:strategy] = options[:strategy]
+      end
+    end
+
+    # It sets description of the rewrite or get description.
     # @example
     #   Synvert::Rewriter.new 'rspec', 'use_new_syntax' do
     #     description 'It converts rspec code to new syntax, it calls all rspec sub snippets.'
@@ -179,7 +189,7 @@ module Synvert::Core
       end
     end
 
-    # Parse +if_ruby+ dsl, it checks if ruby version is greater than or equal to the specified ruby version.
+    # It checks if ruby version is greater than or equal to the specified ruby version.
     # @example
     #   Synvert::Rewriter.new 'ruby', 'new_safe_navigation_operator' do
     #     if_ruby '2.3.0'
@@ -189,7 +199,7 @@ module Synvert::Core
       @ruby_version = Rewriter::RubyVersion.new(version)
     end
 
-    # Parse +if_gem+ dsl, it compares version of the specified gem.
+    # It compares version of the specified gem.
     # @example
     #   Synvert::Rewriter.new 'rails', 'upgrade_5_2_to_6_0' do
     #     if_gem 'rails', '>= 6.0'
@@ -200,7 +210,7 @@ module Synvert::Core
       @gem_spec = Rewriter::GemSpec.new(name, version)
     end
 
-    # Parse +within_files+ dsl, it finds specified files.
+    # It finds specified files.
     # It creates a {Synvert::Core::Rewriter::Instance} to rewrite code.
     # @example
     #   Synvert::Rewriter.new 'rspec', 'be_close_to_be_within' do
@@ -224,10 +234,10 @@ module Synvert::Core
       end
     end
 
-    # Parse +within_file+ dsl, it finds a specifiled file.
+    # It finds a specifiled file.
     alias within_file within_files
 
-    # Parses +add_file+ dsl, it adds a new file.
+    # It adds a new file.
     # @example
     #   Synvert::Rewriter.new 'rails', 'add_application_record' do
     #     add_file 'app/models/application_record.rb', <<~EOS
@@ -251,7 +261,7 @@ module Synvert::Core
       File.write(filepath, content)
     end
 
-    # Parses +remove_file+ dsl, it removes a file.
+    # It removes a file.
     # @example
     #   Synvert::Rewriter.new 'rails', 'upgrade_4_0_to_4_1' do
     #     remove_file 'config/initializers/secret_token.rb'
@@ -264,7 +274,7 @@ module Synvert::Core
       File.delete(file_path) if File.exist?(file_path)
     end
 
-    # Parse +add_snippet+ dsl, it calls anther rewriter.
+    # It calls anther rewriter.
     # @example
     #   Synvert::Rewriter.new 'minitest', 'better_syntax' do
     #     add_snippet 'minitest', 'assert_empty'
@@ -299,7 +309,7 @@ module Synvert::Core
       @sub_snippets << rewriter
     end
 
-    # Parse +helper_method+ dsl, it defines helper method for {Synvert::Core::Rewriter::Instance}.
+    # It defines helper method for {Synvert::Core::Rewriter::Instance}.
     # @example
     #   Synvert::Rewriter.new 'rails', 'convert_active_record_dirty_5_0_to_5_1' do
     #     helper_method :find_callbacks_and_convert do |callback_names, callback_changes|
@@ -316,7 +326,7 @@ module Synvert::Core
       @helpers << { name: name, block: block }
     end
 
-    # Parse +todo+ dsl, it sets todo of the rewriter.
+    # It sets todo of the rewriter.
     # Or get todo.
     # @example
     #   Synvert::Rewriter.new 'rails', 'upgrade_3_2_to_4_0' do

data/lib/synvert/core/strategy.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  class Strategy
+    ALLOW_INSERT_AT_SAME_POSITION = "allow_insert_at_same_position"
+  end
+end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.13.1'
+    VERSION = '1.14.0'
   end
 end

data/lib/synvert/core.rb

@@ -18,11 +18,13 @@ module Synvert
     autoload :Rewriter, 'synvert/core/rewriter'
     autoload :Engine, 'synvert/core/engine'
     autoload :Utils, 'synvert/core/utils'
+    autoload :Strategy, 'synvert/core/strategy'
   end
 end
 
 module Synvert
   Rewriter = Core::Rewriter
+  Strategy = Core::Strategy
 
   ALL_RUBY_FILES = %w[**/*.rb]
   ALL_RAKE_FILES = %w[**/*.rake]

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

@@ -128,7 +128,7 @@ module Synvert::Core
       instance.current_mutation = double
       instance.current_node = double
       expect(NodeMutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
-      expect(instance.current_mutation).to receive(:insert).with(instance.current_node, "\n  Foobar", at: 'end')
+      expect(instance.current_mutation).to receive(:insert).with(instance.current_node, "\n  Foobar", at: 'end', to: nil)
       instance.insert_after 'Foobar'
     end
 
@@ -136,7 +136,7 @@ module Synvert::Core
       instance.current_mutation = double
       instance.current_node = double
       expect(NodeMutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
-      expect(instance.current_mutation).to receive(:insert).with(instance.current_node, "Foobar\n  ", at: 'beginning')
+      expect(instance.current_mutation).to receive(:insert).with(instance.current_node, "Foobar\n  ", at: 'beginning', to: nil)
       instance.insert_before 'Foobar'
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,7 @@ files:
 - lib/synvert/core/rewriter/scope/goto_scope.rb
 - lib/synvert/core/rewriter/scope/within_scope.rb
 - lib/synvert/core/rewriter/warning.rb
+- lib/synvert/core/strategy.rb
 - lib/synvert/core/utils.rb
 - lib/synvert/core/version.rb
 - spec/spec_helper.rb