node_mutation 1.22.1 → 1.22.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1039c5eaf805a6938a0470e3dbafd304b9b7c2a84c3f321fc040f030e0314dea
-  data.tar.gz: fd7895425980b04494de197902a84bef9dcdb6153255654ccc2a5c28b31badb7
+  metadata.gz: 235e331a54f9181d9986ccb6ee62ef172b399a323b697b8090c954e685a117f0
+  data.tar.gz: 11e838f63be7a940176ad6880300aeebde419e3bb923016039a821496648b9ca
 SHA512:
-  metadata.gz: 0ebb7d1aaf7ffd54e8f99bc1064caaa23c3f76e131260acf58dc43eb23de49a3d3d09482e19754b43ab19c699b313370fdd17ae5dfd02c1e3964470df002ffa8
-  data.tar.gz: 674438f94176b2ed7e77283e7238ab96edefc49a4423f9bb967904137a964d2d72228fd7f815fdb102b3ed0823820ef4e99fe54a0863b2144a98d3a240a2ccdb
+  metadata.gz: 0cd144acfbcc3db98c407332f3408bde088ad14156bd5a9c07bc1d1042872339cc71b25b5896c76ff720d8efe80add83789f6889125e55dd7bcb39cc0cf43512
+  data.tar.gz: cdd66a6fa04ba9ad54d788e2f5680045b497a94b48875d4a98efb3a57dfc5a864f9f666a12ab687c16f5a2a59013b39b7d5ec8ead6264e63e22b6faf1edf527a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # NodeMutation
 
+## 1.22.3 (2024-01-30)
+
+* `child_node_range` supports `arg` `name`
+* Add `action` methods to `GroupAction`
+
+## 1.22.2 (2023-12-04)
+
+* `str` child node range does not include quotes
+
 ## 1.22.1 (2023-12-04)
 
 * `child_node_range` supports int/float/str/sym `value`
@@ -131,7 +140,7 @@
 
 ## 1.13.1 (2023-03-31)
 
-* Remove both whitespaces only when next char is nil
+* Remove both whitespace only when next char is nil
 
 ## 1.13.0 (2023-03-31)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.22.1)
+    node_mutation (1.22.3)
 
 GEM
   remote: https://rubygems.org/
@@ -71,6 +71,7 @@ GEM
 PLATFORMS
   x86_64-darwin-21
   x86_64-darwin-22
+  x86_64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/lib/node_mutation/action/group_action.rb

@@ -2,18 +2,27 @@
 
 # GroupAction is compose of multiple actions.
 class NodeMutation::GroupAction < NodeMutation::Action
+  include NodeMutation::Actionable
+
   DEFAULT_START = 2**30
 
   # Initialize a GroupAction.
-  def initialize
+  def initialize(adapter:, &block)
     @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/actionable.rb

@@ -0,0 +1,181 @@
+# 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

data/lib/node_mutation/adapter/parser.rb

@@ -175,7 +175,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
           node.arguments.last.loc.expression.end_pos + 1
         )
       end
-    when %i[class name], %i[const name], %i[cvar name], %i[def name], %i[defs name],
+    when %i[arg name], %i[class name], %i[const name], %i[cvar name], %i[def name], %i[defs name],
          %i[gvar name], %i[ivar name], %i[lvar name]
 
       NodeMutation::Struct::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
@@ -185,7 +185,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       NodeMutation::Struct::Range.new(node.loc.operator.begin_pos, node.loc.operator.end_pos) if node.loc.operator
     when %i[defs self]
       NodeMutation::Struct::Range.new(node.loc.operator.begin_pos - 'self'.length, node.loc.operator.begin_pos)
-    when %i[float value], %i[int value], %i[rational value], %i[str value], %i[sym value]
+    when %i[float value], %i[int value], %i[sym value]
       NodeMutation::Struct::Range.new(node.loc.expression.begin_pos, node.loc.expression.end_pos)
     when %i[lvasgn variable], %i[ivasgn variable], %i[cvasgn variable], %i[gvasgn variable]
       NodeMutation::Struct::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
@@ -201,6 +201,8 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       if node.loc.begin && node.loc.end
         NodeMutation::Struct::Range.new(node.loc.begin.begin_pos, node.loc.end.end_pos)
       end
+    when %i[str value]
+      NodeMutation::Struct::Range.new(node.loc.expression.begin_pos + 1, node.loc.expression.end_pos - 1)
     else
       raise NodeMutation::MethodNotSupported,
             "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -7,6 +7,7 @@ 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"
@@ -26,6 +27,8 @@ 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
@@ -71,182 +74,6 @@ 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,
@@ -262,7 +89,6 @@ class NodeMutation
       return NodeMutation::Result.new(affected: false, conflicted: false)
     end
 
-    source = +@source
     @transform_proc.call(@actions) if @transform_proc
     sorted_actions = sort_flatten_actions(flatten_actions)
     conflict_actions = get_conflict_actions(sorted_actions)
@@ -271,7 +97,7 @@ class NodeMutation
     end
 
     actions = sort_flatten_actions(flat_actions(get_filter_actions(conflict_actions)))
-    new_source = rewrite_source(source, actions)
+    new_source = rewrite_source(+@source, actions)
     result = NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?)
     result.new_source = new_source
     result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.22.3
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies: []
 description: ast node mutation apis
 email:
@@ -37,6 +37,7 @@ 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
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: ast node mutation apis