node_mutation 1.22.3 → 1.22.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235e331a54f9181d9986ccb6ee62ef172b399a323b697b8090c954e685a117f0
-  data.tar.gz: 11e838f63be7a940176ad6880300aeebde419e3bb923016039a821496648b9ca
+  metadata.gz: 9485dffc945cb3b645d4abecc7f878550685459ccd2007845471651d6893e2f1
+  data.tar.gz: 0ab63429232abd2f357b2c791bb3e5bc66a4762ff4175d6444b8c51dbac99a5d
 SHA512:
-  metadata.gz: 0cd144acfbcc3db98c407332f3408bde088ad14156bd5a9c07bc1d1042872339cc71b25b5896c76ff720d8efe80add83789f6889125e55dd7bcb39cc0cf43512
-  data.tar.gz: cdd66a6fa04ba9ad54d788e2f5680045b497a94b48875d4a98efb3a57dfc5a864f9f666a12ab687c16f5a2a59013b39b7d5ec8ead6264e63e22b6faf1edf527a
+  metadata.gz: fc326b1af7d3f13bdd91f24c59d3be4991c20cc751de9bf0b8d48be98dc44fa78c93b4a5ffc75eac2535437ad478a206d54342195737989c17d7eb4121624c8a
+  data.tar.gz: 92cea72b3327755abb2b789cd704809b46258c3a6cc7f7e9f8bac678e2907e93d7fe59e5abfd33308029bc71dee24a1d8e23cbf976f2a1d7d9648876d6e24b78

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # NodeMutation
 
+## 1.22.4 (2024-01-30)
+
+* Revert "add action methods to GroupAction"
+
 ## 1.22.3 (2024-01-30)
 
 * `child_node_range` supports `arg` `name`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.22.3)
+    node_mutation (1.22.4)
 
 GEM
   remote: https://rubygems.org/

data/lib/node_mutation/action/group_action.rb

@@ -2,27 +2,18 @@
 
 # GroupAction is compose of multiple actions.
 class NodeMutation::GroupAction < NodeMutation::Action
-  include NodeMutation::Actionable
-
   DEFAULT_START = 2**30
 
   # Initialize a GroupAction.
-  def initialize(adapter:, &block)
+  def initialize
     @actions = []
     @type = :group
-    @adapter = adapter
-    @block = block
   end
 
   def new_code
     nil
   end
 
-  def process
-    instance_eval(&@block)
-    super
-  end
-
   private
 
   # Calculate the begin and end positions.

data/lib/node_mutation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class NodeMutation
-  VERSION = "1.22.3"
+  VERSION = "1.22.4"
 end

data/lib/node_mutation.rb

@@ -7,7 +7,6 @@ class NodeMutation
   class ConflictActionError < StandardError; end
   class InvalidAdapterError < StandardError; end
 
-  autoload :Actionable, "node_mutation/actionable"
   autoload :Adapter, "node_mutation/adapter"
   autoload :ParserAdapter, "node_mutation/adapter/parser"
   autoload :SyntaxTreeAdapter, "node_mutation/adapter/syntax_tree"
@@ -27,8 +26,6 @@ class NodeMutation
   autoload :Struct, 'node_mutation/struct'
   autoload :Helper, 'node_mutation/helper'
 
-  include Actionable
-
   # @!attribute [r] actions
   #   @return [Array<NodeMutation::Struct::Action>]
   attr_reader :actions, :adapter
@@ -74,6 +71,182 @@ class NodeMutation
     @adapter = get_adapter_instance(adapter)
   end
 
+  # Append code to the ast node.
+  # @param node [Node] ast node
+  # @param code [String] new code to append
+  # @example
+  # source code of the ast node is
+  #     def teardown
+  #       clean_something
+  #     end
+  # then we call
+  #     mutation.append(node, 'super')
+  # the source code will be rewritten to
+  #     def teardown
+  #       clean_something
+  #       super
+  #     end
+  def append(node, code)
+    @actions << AppendAction.new(node, code, adapter: @adapter).process
+  end
+
+  # Delete source code of the child ast node.
+  # @param node [Node] ast node
+  # @param selectors [Array<Symbol>] selector names of child node.
+  # @param and_comma [Boolean] delete extra comma.
+  # @example
+  # source code of the ast node is
+  #     FactoryBot.create(...)
+  # then we call
+  #     mutation.delete(node, :receiver, :dot)
+  # the source code will be rewritten to
+  #     create(...)
+  def delete(node, *selectors, and_comma: false)
+    @actions << DeleteAction.new(node, *selectors, and_comma: and_comma, adapter: @adapter).process
+  end
+
+  # Insert code to the ast node.
+  # @param node [Node] ast node
+  # @param code [String] code need to be inserted.
+  # @param at [String] insert position, beginning or end
+  # @param to [String] where to insert, if it is nil, will insert to current node.
+  # @param and_comma [Boolean] insert extra comma.
+  # @example
+  # source code of the ast node is
+  #     open('http://test.com')
+  # then we call
+  #     mutation.insert(node, 'URI.', at: 'beginning')
+  # the source code will be rewritten to
+  #     URI.open('http://test.com')
+  def insert(node, code, at: 'end', to: nil, and_comma: false)
+    @actions << InsertAction.new(node, code, at: at, to: to, and_comma: and_comma, adapter: @adapter).process
+  end
+
+  # Prepend code to the ast node.
+  # @param node [Node] ast node
+  # @param code [String] new code to prepend.
+  # @example
+  # source code of the ast node is
+  #     def setup
+  #       do_something
+  #     end
+  # then we call
+  #     mutation.prepend(node, 'super')
+  # the source code will be rewritten to
+  #     def setup
+  #       super
+  #       do_something
+  #     end
+  def prepend(node, code)
+    @actions << PrependAction.new(node, code, adapter: @adapter).process
+  end
+
+  # Remove source code of the ast node.
+  # @param node [Node] ast node
+  # @param and_comma [Boolean] delete extra comma.
+  # @example
+  # source code of the ast node is
+  #     puts "test"
+  # then we call
+  #     mutation.remove(node)
+  # the source code will be removed
+  def remove(node, and_comma: false)
+    @actions << RemoveAction.new(node, and_comma: and_comma, adapter: @adapter).process
+  end
+
+  # Replace child node of the ast node with new code.
+  # @param node [Node] ast node
+  # @param selectors [Array<Symbol>] selector names of child node.
+  # @param with [String] code need to be replaced with.
+  # @example
+  # source code of the ast node is
+  #     assert(object.empty?)
+  # then we call
+  #     mutation.replace(node, :message, with: 'assert_empty')
+  #     mutation.replace(node, :arguments, with: '{{arguments.first.receiver}}')
+  # the source code will be rewritten to
+  #     assert_empty(object)
+  def replace(node, *selectors, with:)
+    @actions << ReplaceAction.new(node, *selectors, with: with, adapter: @adapter).process
+  end
+
+  # Replace source code of the ast node with new code.
+  # @param node [Node] ast node
+  # @param code [String] code need to be replaced with.
+  # @example
+  # source code of the ast node is
+  #     obj.stub(:foo => 1, :bar => 2)
+  # then we call
+  #     replace_with 'allow({{receiver}}).to receive_messages({{arguments}})'
+  # the source code will be rewritten to
+  #     allow(obj).to receive_messages(:foo => 1, :bar => 2)
+  def replace_with(node, code)
+    @actions << ReplaceWithAction.new(node, code, adapter: @adapter).process
+  end
+
+  # Wrap source code of the ast node with prefix and suffix code.
+  # @param node [Node] ast node
+  # @param prefix [String] prefix code need to be wrapped with.
+  # @param suffix [String] suffix code need to be wrapped with.
+  # @param newline [Boolean] add newline after prefix and before suffix.
+  # @example
+  # source code of the ast node is
+  #     class Foobar
+  #     end
+  # then we call
+  #     wrap(node, prefix: 'module Synvert', suffix: 'end', newline: true)
+  # the source code will be rewritten to
+  #     module Synvert
+  #       class Foobar
+  #       end
+  #     end
+  def wrap(node, prefix:, suffix:, newline: false)
+    if newline
+      indentation = @adapter.get_start_loc(node).column
+      group do
+        insert node, prefix + "\n" + (' ' * indentation), at: 'beginning'
+        insert node, "\n" + (' ' * indentation) + suffix, at: 'end'
+        indent node
+      end
+    else
+      group do
+        insert node, prefix, at: 'beginning'
+        insert node, suffix, at: 'end'
+      end
+    end
+  end
+
+  # Indent source code of the ast node
+  # @param node [Node] ast node
+  # @example
+  # source code of ast node is
+  #     class Foobar
+  #     end
+  # then we call
+  #     indent(node)
+  # the source code will be rewritten to
+  #       class Foobar
+  #       end
+  def indent(node)
+    @actions << IndentAction.new(node, adapter: @adapter).process
+  end
+
+  # No operation.
+  # @param node [Node] ast node
+  def noop(node)
+    @actions << NoopAction.new(node, adapter: @adapter).process
+  end
+
+  # group multiple actions
+  def group
+    current_actions = @actions
+    group_action = GroupAction.new
+    @actions = group_action.actions
+    yield
+    @actions = current_actions
+    @actions << group_action.process
+  end
+
   # Process actions and return the new source.
   #
   # If there's an action range conflict,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.22.3
+  version: 1.22.4
 platform: ruby
 authors:
 - Richard Huang
@@ -37,7 +37,6 @@ files:
 - lib/node_mutation/action/remove_action.rb
 - lib/node_mutation/action/replace_action.rb
 - lib/node_mutation/action/replace_with_action.rb
-- lib/node_mutation/actionable.rb
 - lib/node_mutation/adapter.rb
 - lib/node_mutation/adapter/parser.rb
 - lib/node_mutation/adapter/syntax_tree.rb

data/lib/node_mutation/actionable.rb

@@ -1,181 +0,0 @@
-# frozen_string_literal: true
-
-module NodeMutation::Actionable
-  # Append code to the ast node.
-  # @param node [Node] ast node
-  # @param code [String] new code to append
-  # @example
-  # source code of the ast node is
-  #     def teardown
-  #       clean_something
-  #     end
-  # then we call
-  #     mutation.append(node, 'super')
-  # the source code will be rewritten to
-  #     def teardown
-  #       clean_something
-  #       super
-  #     end
-  def append(node, code)
-    @actions << NodeMutation::AppendAction.new(node, code, adapter: @adapter).process
-  end
-
-  # Delete source code of the child ast node.
-  # @param node [Node] ast node
-  # @param selectors [Array<Symbol>] selector names of child node.
-  # @param and_comma [Boolean] delete extra comma.
-  # @example
-  # source code of the ast node is
-  #     FactoryBot.create(...)
-  # then we call
-  #     mutation.delete(node, :receiver, :dot)
-  # the source code will be rewritten to
-  #     create(...)
-  def delete(node, *selectors, and_comma: false)
-    @actions << NodeMutation::DeleteAction.new(node, *selectors, and_comma: and_comma, adapter: @adapter).process
-  end
-
-  # Insert code to the ast node.
-  # @param node [Node] ast node
-  # @param code [String] code need to be inserted.
-  # @param at [String] insert position, beginning or end
-  # @param to [String] where to insert, if it is nil, will insert to current node.
-  # @param and_comma [Boolean] insert extra comma.
-  # @example
-  # source code of the ast node is
-  #     open('http://test.com')
-  # then we call
-  #     mutation.insert(node, 'URI.', at: 'beginning')
-  # the source code will be rewritten to
-  #     URI.open('http://test.com')
-  def insert(node, code, at: 'end', to: nil, and_comma: false)
-    @actions << NodeMutation::InsertAction.new(
-      node,
-      code,
-      at: at,
-      to: to,
-      and_comma: and_comma,
-      adapter: @adapter
-    ).process
-  end
-
-  # Prepend code to the ast node.
-  # @param node [Node] ast node
-  # @param code [String] new code to prepend.
-  # @example
-  # source code of the ast node is
-  #     def setup
-  #       do_something
-  #     end
-  # then we call
-  #     mutation.prepend(node, 'super')
-  # the source code will be rewritten to
-  #     def setup
-  #       super
-  #       do_something
-  #     end
-  def prepend(node, code)
-    @actions << NodeMutation::PrependAction.new(node, code, adapter: @adapter).process
-  end
-
-  # Remove source code of the ast node.
-  # @param node [Node] ast node
-  # @param and_comma [Boolean] delete extra comma.
-  # @example
-  # source code of the ast node is
-  #     puts "test"
-  # then we call
-  #     mutation.remove(node)
-  # the source code will be removed
-  def remove(node, and_comma: false)
-    @actions << NodeMutation::RemoveAction.new(node, and_comma: and_comma, adapter: @adapter).process
-  end
-
-  # Replace child node of the ast node with new code.
-  # @param node [Node] ast node
-  # @param selectors [Array<Symbol>] selector names of child node.
-  # @param with [String] code need to be replaced with.
-  # @example
-  # source code of the ast node is
-  #     assert(object.empty?)
-  # then we call
-  #     mutation.replace(node, :message, with: 'assert_empty')
-  #     mutation.replace(node, :arguments, with: '{{arguments.first.receiver}}')
-  # the source code will be rewritten to
-  #     assert_empty(object)
-  def replace(node, *selectors, with:)
-    @actions << NodeMutation::ReplaceAction.new(node, *selectors, with: with, adapter: @adapter).process
-  end
-
-  # Replace source code of the ast node with new code.
-  # @param node [Node] ast node
-  # @param code [String] code need to be replaced with.
-  # @example
-  # source code of the ast node is
-  #     obj.stub(:foo => 1, :bar => 2)
-  # then we call
-  #     replace_with 'allow({{receiver}}).to receive_messages({{arguments}})'
-  # the source code will be rewritten to
-  #     allow(obj).to receive_messages(:foo => 1, :bar => 2)
-  def replace_with(node, code)
-    @actions << NodeMutation::ReplaceWithAction.new(node, code, adapter: @adapter).process
-  end
-
-  # Wrap source code of the ast node with prefix and suffix code.
-  # @param node [Node] ast node
-  # @param prefix [String] prefix code need to be wrapped with.
-  # @param suffix [String] suffix code need to be wrapped with.
-  # @param newline [Boolean] add newline after prefix and before suffix.
-  # @example
-  # source code of the ast node is
-  #     class Foobar
-  #     end
-  # then we call
-  #     wrap(node, prefix: 'module Synvert', suffix: 'end', newline: true)
-  # the source code will be rewritten to
-  #     module Synvert
-  #       class Foobar
-  #       end
-  #     end
-  def wrap(node, prefix:, suffix:, newline: false)
-    if newline
-      indentation = @adapter.get_start_loc(node).column
-      group do
-        insert node, prefix + "\n" + (' ' * indentation), at: 'beginning'
-        insert node, "\n" + (' ' * indentation) + suffix, at: 'end'
-        indent node
-      end
-    else
-      group do
-        insert node, prefix, at: 'beginning'
-        insert node, suffix, at: 'end'
-      end
-    end
-  end
-
-  # Indent source code of the ast node
-  # @param node [Node] ast node
-  # @example
-  # source code of ast node is
-  #     class Foobar
-  #     end
-  # then we call
-  #     indent(node)
-  # the source code will be rewritten to
-  #       class Foobar
-  #       end
-  def indent(node)
-    @actions << NodeMutation::IndentAction.new(node, adapter: @adapter).process
-  end
-
-  # No operation.
-  # @param node [Node] ast node
-  def noop(node)
-    @actions << NodeMutation::NoopAction.new(node, adapter: @adapter).process
-  end
-
-  # group multiple actions
-  def group(&block)
-    @actions << NodeMutation::GroupAction.new(adapter: @adapter, &block).process
-  end
-end