node_mutation 1.21.6 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae5572567e82e089eefff7f7f696230a17e77fbf0af051dd3a4a46ad21bf9a8
-  data.tar.gz: 8448ddd41dadbee697ee58a2d506bd7832fe9792d601e3a969cdc5b8869651fb
+  metadata.gz: d1ced556aff645a4d23e98bc7d544ac8d48d89909112fbd875132a97417a7e2b
+  data.tar.gz: 9efd16a9ff97cb146b0b3750a53a57721700377d98a9e8c310a9435d6c42d279
 SHA512:
-  metadata.gz: 603b93346813a1e4a0e6a2fed2c3fb5a0569f592b69de6d3f580b055ad1cae301c03c1984c50e567612f9b9f32b6fe706cd1c8276691b895d387044349c9fb93
-  data.tar.gz: 7c2ac5164feb10bbb01d0f355c831032dbccbdb6a80eb341884dc350f33dc95409cec2ced8ead61862fadde4ae71f2244414a43b4cd42ea23b70dc62f1082566
+  metadata.gz: 0337aee07465f0c897bf23180b6f114a3e1aa08b580040ab787e7df36f69947d8f68b644235fce64b1ea78db44aae8d2e58d5e9349b783c02a8d1499f7514507
+  data.tar.gz: c8fdcf2857e1dfddcf36653dddcf48e6d19a10d7d9f99994a7551c9e146dd034e80576e0bf1b58d3b8aad784a11e1edd858ad9e9dae3b9122723c8242122f768

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # NodeMutation
 
+## 1.22.0 (2023-11-27)
+
+* Add `adapter` parameter to `NodeMutation`
+* Add `adapter` parameter to `NodeMutation::Action`
+* Do not allow to configure an `adapter` globally
+
 ## 1.21.6 (2023-11-20)
 
 * Flat and sort actions after filtering actions when processing

data/Gemfile.lock

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

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ```ruby
 require 'node_mutation'
 
-mutation = NodeMutation.new(source)
+mutation = NodeMutation.new(source, adapter: :parser)
 ```
 
 2. call the rewrite apis:
@@ -91,10 +91,6 @@ Different parsers, like parse and ripper, will generate different AST nodes, to
 we define an [Adapter](https://github.com/xinminlabs/node-mutation-ruby/blob/main/lib/node_mutation/adapter.rb) interface,
 if you implement the Adapter interface, you can set it as NodeMutation's adapter.
 
-```ruby
-NodeMutation.configure(adapter: SyntaxTreeAdapter.new) // default is ParserAdapter
-```
-
 ### strategy
 
 It provides 3 strategies to handle conflicts when processing actions:

data/lib/node_mutation/action/append_action.rb

@@ -2,8 +2,13 @@
 
 # AppendAction appends code to the bottom of node body.
 class NodeMutation::AppendAction < NodeMutation::Action
-  def initialize(node, code)
-    super(node, code)
+  # Initialize an AppendAction.
+  #
+  # @param node [Node]
+  # @param code [String] new code to append.
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, code, adapter:)
+    super(node, code, adapter: adapter)
     @type = :insert
   end
 
@@ -13,7 +18,7 @@ class NodeMutation::AppendAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = NodeMutation.adapter.get_end(@node) - NodeMutation.adapter.get_start_loc(@node).column - END_LENGTH
+    @start = @adapter.get_end(@node) - @adapter.get_start_loc(@node).column - END_LENGTH
     @end = @start
   end
 
@@ -22,6 +27,6 @@ class NodeMutation::AppendAction < NodeMutation::Action
   # @param node [Parser::AST::Node]
   # @return [String] n times whitesphace
   def indent(node)
-    ' ' *  (NodeMutation.adapter.get_start_loc(node).column + NodeMutation.tab_width)
+    ' ' *  (@adapter.get_start_loc(node).column + NodeMutation.tab_width)
   end
 end

data/lib/node_mutation/action/delete_action.rb

@@ -6,9 +6,10 @@ class NodeMutation::DeleteAction < NodeMutation::Action
   #
   # @param node [Node]
   # @param selectors [Array<Symbol, String>] used to select child nodes
-  # @option and_comma [Boolean] delete extra comma.
-  def initialize(node, *selectors, and_comma: false)
-    super(node, nil)
+  # @param and_comma [Boolean] delete extra comma.
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, *selectors, adapter:, and_comma: false)
+    super(node, nil, adapter: adapter)
     @selectors = selectors
     @and_comma = and_comma
     @type = :delete
@@ -23,9 +24,9 @@ class NodeMutation::DeleteAction < NodeMutation::Action
 
   # Calculate the begin and end positions.
   def calculate_position
-    @start = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector) }
+    @start = @selectors.map { |selector| @adapter.child_node_range(@node, selector) }
                        .compact.map(&:start).min
-    @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector) }
+    @end = @selectors.map { |selector| @adapter.child_node_range(@node, selector) }
                      .compact.map(&:end).max
     remove_comma if @and_comma
     remove_whitespace

data/lib/node_mutation/action/group_action.rb

@@ -4,6 +4,7 @@
 class NodeMutation::GroupAction < NodeMutation::Action
   DEFAULT_START = 2**30
 
+  # Initialize a GroupAction.
   def initialize
     @actions = []
     @type = :group

data/lib/node_mutation/action/indent_action.rb

@@ -6,8 +6,9 @@ class NodeMutation::IndentAction < NodeMutation::Action
   #
   # @param node [Node]
   # @param tab_size [Integer] tab size
-  def initialize(node, tab_size = 1)
-    super(node, nil)
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, tab_size = 1, adapter:)
+    super(node, nil, adapter: adapter)
     @tab_size = tab_size
     @type = :replace
   end
@@ -16,7 +17,7 @@ class NodeMutation::IndentAction < NodeMutation::Action
   #
   # @return [String] rewritten code.
   def new_code
-    source = NodeMutation.adapter.get_source(@node)
+    source = @adapter.get_source(@node)
     source.each_line.map { |line| (' ' * NodeMutation.tab_width * @tab_size) + line }
           .join
   end
@@ -25,7 +26,7 @@ class NodeMutation::IndentAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = NodeMutation.adapter.get_start(@node)
-    @end = NodeMutation.adapter.get_end(@node)
+    @start = @adapter.get_start(@node)
+    @end = @adapter.get_end(@node)
   end
 end

data/lib/node_mutation/action/insert_action.rb

@@ -9,8 +9,9 @@ class NodeMutation::InsertAction < NodeMutation::Action
   # @param at [String] position to insert, beginning or end
   # @param to [<nil|String>] name of child node
   # @param and_comma [Boolean] insert extra comma.
-  def initialize(node, code, at: 'end', to: nil, and_comma: false)
-    super(node, code)
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, code, adapter:, at: 'end', to: nil, and_comma: false)
+    super(node, code, adapter: adapter)
     @at = at
     @to = to
     @and_comma = and_comma
@@ -35,15 +36,15 @@ class NodeMutation::InsertAction < NodeMutation::Action
     @start =
       if @at == 'end'
         if @to
-          NodeMutation.adapter.child_node_range(@node, @to).end
+          @adapter.child_node_range(@node, @to).end
         else
-          NodeMutation.adapter.get_end(@node)
+          @adapter.get_end(@node)
         end
       else
         if @to
-          NodeMutation.adapter.child_node_range(@node, @to).start
+          @adapter.child_node_range(@node, @to).start
         else
-          NodeMutation.adapter.get_start(@node)
+          @adapter.get_start(@node)
         end
       end
     @end = @start

data/lib/node_mutation/action/noop_action.rb

@@ -2,9 +2,12 @@
 
 # NoopAction to do no operation.
 class NodeMutation::NoopAction < NodeMutation::Action
-  # Create a NoopAction
-  def initialize(node)
-    super(node, nil)
+  # Initialize a NoopAction.
+  #
+  # @param node [Node]
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, adapter:)
+    super(node, nil, adapter: adapter)
   end
 
   # The rewritten source code with proper indent.
@@ -18,7 +21,7 @@ class NodeMutation::NoopAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = NodeMutation.adapter.get_start(@node)
-    @end = NodeMutation.adapter.get_end(@node)
+    @start = @adapter.get_start(@node)
+    @end = @adapter.get_end(@node)
   end
 end

data/lib/node_mutation/action/prepend_action.rb

@@ -2,8 +2,13 @@
 
 # PrependAction to prepend code to the top of node body.
 class NodeMutation::PrependAction < NodeMutation::Action
-  def initialize(node, code)
-    super(node, code)
+  # Initialize an PrependAction.
+  #
+  # @param node [Node]
+  # @param code [String] new code to prepend.
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, code, adapter:)
+    super(node, code, adapter: adapter)
     @type = :insert
   end
 
@@ -11,8 +16,8 @@ class NodeMutation::PrependAction < NodeMutation::Action
 
   # Calculate the begin and end positions.
   def calculate_position
-    node_start = NodeMutation.adapter.get_start(@node)
-    node_source = NodeMutation.adapter.get_source(@node)
+    node_start = @adapter.get_start(@node)
+    node_source = @adapter.get_source(@node)
     first_line = node_source.split("\n").first
     @start = first_line.end_with?("do") ? node_start + first_line.rindex("do") + "do".length : node_start + first_line.length
     @end = @start
@@ -23,6 +28,6 @@ class NodeMutation::PrependAction < NodeMutation::Action
   # @param node [Parser::AST::Node]
   # @return [String] n times whitesphace
   def indent(node)
-    ' ' * (NodeMutation.adapter.get_start_loc(node).column + NodeMutation.tab_width)
+    ' ' * (@adapter.get_start_loc(node).column + NodeMutation.tab_width)
   end
 end

data/lib/node_mutation/action/remove_action.rb

@@ -5,10 +5,10 @@ class NodeMutation::RemoveAction < NodeMutation::Action
   # Initialize a RemoveAction.
   #
   # @param node [Node]
-  # @param options [Hash] options.
-  # @option and_comma [Boolean] delete extra comma.
-  def initialize(node, and_comma: false)
-    super(node, nil)
+  # @param and_comma [Boolean] delete extra comma.
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, adapter:, and_comma: false)
+    super(node, nil, adapter: adapter)
     @and_comma = and_comma
     @type = :delete
   end
@@ -22,8 +22,8 @@ class NodeMutation::RemoveAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = NodeMutation.adapter.get_start(@node)
-    @end = NodeMutation.adapter.get_end(@node)
+    @start = @adapter.get_start(@node)
+    @end = @adapter.get_end(@node)
     remove_comma if @and_comma
     remove_whitespace
     if take_whole_line?
@@ -36,7 +36,7 @@ class NodeMutation::RemoveAction < NodeMutation::Action
   #
   # @return [Boolean]
   def take_whole_line?
-    NodeMutation.adapter.get_source(@node) == file_source[@start...@end].strip.chomp(',')
+    @adapter.get_source(@node) == file_source[@start...@end].strip.chomp(',')
   end
 
   def remove_newline
@@ -73,8 +73,8 @@ class NodeMutation::RemoveAction < NodeMutation::Action
 
   def squeeze_lines
     lines = file_source.split("\n")
-    begin_line = NodeMutation.adapter.get_start_loc(@node).line
-    end_line = NodeMutation.adapter.get_end_loc(@node).line
+    begin_line = @adapter.get_start_loc(@node).line
+    end_line = @adapter.get_end_loc(@node).line
     before_line_is_blank = begin_line == 1 || lines[begin_line - 2] == ''
     after_line_is_blank = lines[end_line] == ''
 

data/lib/node_mutation/action/replace_action.rb

@@ -7,8 +7,9 @@ class NodeMutation::ReplaceAction < NodeMutation::Action
   # @param node [Node]
   # @param selectors [Array<Symbol|String>] used to select child nodes
   # @param with [String] the new code
-  def initialize(node, *selectors, with:)
-    super(node, with)
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, *selectors, adapter:, with:)
+    super(node, with, adapter: adapter)
     @selectors = selectors
     @type = :replace
   end
@@ -24,9 +25,9 @@ class NodeMutation::ReplaceAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector).start }
+    @start = @selectors.map { |selector| @adapter.child_node_range(@node, selector).start }
                        .min
-    @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector).end }
+    @end = @selectors.map { |selector| @adapter.child_node_range(@node, selector).end }
                      .max
   end
 end

data/lib/node_mutation/action/replace_with_action.rb

@@ -2,8 +2,13 @@
 
 # ReplaceWithAction to replace code.
 class NodeMutation::ReplaceWithAction < NodeMutation::Action
-  def initialize(node, code)
-    super(node, code)
+  # Initailize a ReplaceWithAction.
+  #
+  # @param node [Node]
+  # @param code [String] the new code.
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, code, adapter:)
+    super(node, code, adapter: adapter)
     @type = :replace
   end
 
@@ -26,14 +31,14 @@ class NodeMutation::ReplaceWithAction < NodeMutation::Action
 
   # Calculate the begin the end positions.
   def calculate_position
-    @start = NodeMutation.adapter.get_start(@node)
-    @end = NodeMutation.adapter.get_end(@node)
+    @start = @adapter.get_start(@node)
+    @end = @adapter.get_end(@node)
   end
 
   # Indent of the node
   #
   # @return [String] n times whitesphace
   def indent
-    ' ' * NodeMutation.adapter.get_start_loc(@node).column
+    ' ' * @adapter.get_start_loc(@node).column
   end
 end

data/lib/node_mutation/action.rb

@@ -16,9 +16,11 @@ class NodeMutation::Action
   #
   # @param node [Node]
   # @param code [String] new code to insert, replace or delete.
-  def initialize(node, code)
+  # @param adapter [NodeMutation::Adapter]
+  def initialize(node, code, adapter:)
     @node = node
     @code = code
+    @adapter = adapter
   end
 
   # Calculate begin and end positions, and return self.
@@ -59,7 +61,7 @@ class NodeMutation::Action
   #
   # @return [String] rewritten source code.
   def rewritten_source
-    @rewritten_source ||= NodeMutation.adapter.rewritten_source(@node, @code)
+    @rewritten_source ||= @adapter.rewritten_source(@node, @code)
   end
 
   # remove unused whitespace.
@@ -115,6 +117,6 @@ class NodeMutation::Action
   #
   # @return [String]
   def file_source
-    @file_source ||= NodeMutation.adapter.file_source(@node)
+    @file_source ||= @adapter.file_source(@node)
   end
 end

data/lib/node_mutation/adapter/parser.rb

@@ -82,7 +82,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
           if lines_count > 1 && lines_count == evaluated.size
             new_code = []
             lines.each_with_index { |line, index|
-              new_code << (index == 0 ? line : line[NodeMutation.adapter.get_indent(evaluated.first) - NodeMutation.tab_width..-1])
+              new_code << (index == 0 ? line : line[get_indent(evaluated.first) - NodeMutation.tab_width..-1])
             }
             new_code.join("\n")
           else

data/lib/node_mutation/adapter/syntax_tree.rb

@@ -74,7 +74,7 @@ class NodeMutation::SyntaxTreeAdapter < NodeMutation::Adapter
           if lines_count > 1 && lines_count == evaluated.size
             new_code = []
             lines.each_with_index { |line, index|
-              new_code << (index == 0 ? line : line[NodeMutation.adapter.get_indent(evaluated.first) - NodeMutation.tab_width..-1])
+              new_code << (index == 0 ? line : line[get_indent(evaluated.first) - NodeMutation.tab_width..-1])
             }
             new_code.join("\n")
           else

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -5,6 +5,7 @@ require_relative "node_mutation/version"
 class NodeMutation
   class MethodNotSupported < StandardError; end
   class ConflictActionError < StandardError; end
+  class InvalidAdapterError < StandardError; end
 
   autoload :Adapter, "node_mutation/adapter"
   autoload :ParserAdapter, "node_mutation/adapter/parser"
@@ -27,7 +28,7 @@ class NodeMutation
 
   # @!attribute [r] actions
   #   @return [Array<NodeMutation::Struct::Action>]
-  attr_reader :actions
+  attr_reader :actions, :adapter
 
   # @!attribute [rw] transform_proc
   #  @return [Proc] proc to transfor the actions
@@ -36,13 +37,9 @@ class NodeMutation
   class << self
     # Configure NodeMutation
     # @param [Hash] options options to configure
-    # @option options [NodeMutation::Adapter] :adapter the adpater
     # @option options [NodeMutation::Strategy] :strategy the strategy
     # @option options [Integer] :tab_width the tab width
     def configure(options)
-      if options[:adapter]
-        @adapter = options[:adapter]
-      end
       if options[:strategy]
         @strategy = options[:strategy]
       end
@@ -51,12 +48,6 @@ class NodeMutation
       end
     end
 
-    # Get the adapter
-    # @return [NodeMutation::Adapter] current adapter, by default is {NodeMutation::ParserAdapter}
-    def adapter
-      @adapter ||= ParserAdapter.new
-    end
-
     # Get the strategy
     # @return [Integer] current strategy, could be {NodeMutation::Strategy::KEEP_RUNNING} or {NodeMutation::Strategy::THROW_ERROR},
     # by default is {NodeMutation::Strategy::KEEP_RUNNING}
@@ -73,9 +64,11 @@ class NodeMutation
 
   # Initialize a NodeMutation.
   # @param source [String] file source
-  def initialize(source)
+  # @param adapter [Symbol] :parser or :syntax_tree
+  def initialize(source, adapter:)
     @source = source
     @actions = []
+    @adapter = get_adapter_instance(adapter)
   end
 
   # Append code to the ast node.
@@ -94,7 +87,7 @@ class NodeMutation
   #       super
   #     end
   def append(node, code)
-    @actions << AppendAction.new(node, code).process
+    @actions << AppendAction.new(node, code, adapter: @adapter).process
   end
 
   # Delete source code of the child ast node.
@@ -109,7 +102,7 @@ class NodeMutation
   # the source code will be rewritten to
   #     create(...)
   def delete(node, *selectors, and_comma: false)
-    @actions << DeleteAction.new(node, *selectors, and_comma: and_comma).process
+    @actions << DeleteAction.new(node, *selectors, and_comma: and_comma, adapter: @adapter).process
   end
 
   # Insert code to the ast node.
@@ -126,7 +119,7 @@ class NodeMutation
   # 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).process
+    @actions << InsertAction.new(node, code, at: at, to: to, and_comma: and_comma, adapter: @adapter).process
   end
 
   # Prepend code to the ast node.
@@ -145,7 +138,7 @@ class NodeMutation
   #       do_something
   #     end
   def prepend(node, code)
-    @actions << PrependAction.new(node, code).process
+    @actions << PrependAction.new(node, code, adapter: @adapter).process
   end
 
   # Remove source code of the ast node.
@@ -158,7 +151,7 @@ class NodeMutation
   #     mutation.remove(node)
   # the source code will be removed
   def remove(node, and_comma: false)
-    @actions << RemoveAction.new(node, and_comma: and_comma).process
+    @actions << RemoveAction.new(node, and_comma: and_comma, adapter: @adapter).process
   end
 
   # Replace child node of the ast node with new code.
@@ -174,7 +167,7 @@ class NodeMutation
   # the source code will be rewritten to
   #     assert_empty(object)
   def replace(node, *selectors, with:)
-    @actions << ReplaceAction.new(node, *selectors, with: with).process
+    @actions << ReplaceAction.new(node, *selectors, with: with, adapter: @adapter).process
   end
 
   # Replace source code of the ast node with new code.
@@ -188,7 +181,7 @@ class NodeMutation
   # 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).process
+    @actions << ReplaceWithAction.new(node, code, adapter: @adapter).process
   end
 
   # Wrap source code of the ast node with prefix and suffix code.
@@ -209,7 +202,7 @@ class NodeMutation
   #     end
   def wrap(node, prefix:, suffix:, newline: false)
     if newline
-      indentation = NodeMutation.adapter.get_start_loc(node).column
+      indentation = @adapter.get_start_loc(node).column
       group do
         insert node, prefix + "\n" + (' ' * indentation), at: 'beginning'
         insert node, "\n" + (' ' * indentation) + suffix, at: 'end'
@@ -235,13 +228,13 @@ class NodeMutation
   #       class Foobar
   #       end
   def indent(node)
-    @actions << IndentAction.new(node).process
+    @actions << IndentAction.new(node, adapter: @adapter).process
   end
 
   # No operation.
   # @param node [Node] ast node
   def noop(node)
-    @actions << NoopAction.new(node).process
+    @actions << NoopAction.new(node, adapter: @adapter).process
   end
 
   # group multiple actions
@@ -424,4 +417,15 @@ class NodeMutation
   def strategy?(strategy)
     NodeMutation.strategy & strategy == strategy
   end
+
+  def get_adapter_instance(adapter)
+    case adapter.to_sym
+    when :parser
+      ParserAdapter.new
+    when :syntax_tree
+      SyntaxTreeAdapter.new
+    else
+      raise InvalidAdapterError, "adapter #{adapter} is not supported"
+    end
+  end
 end

data/sig/node_mutation.rbs

@@ -9,15 +9,13 @@ class NodeMutation[T]
 
   attr_reader actions: Array[NodeMutation::Action]
 
-  def self.configure: (options: { adapter: NodeMutation::Adapter, strategy: Integer, tab_width: Integer }) -> void
-
-  def self.adapter: () -> NodeMutation::Adapter
+  def self.configure: (options: { strategy: Integer, tab_width: Integer }) -> void
 
   def self.strategy: () -> Integer
 
   def self.tab_width: () -> Integer
 
-  def initialize: (source: String) -> NodeMutation
+  def initialize: (source: String, adapter: Symbol) -> NodeMutation
 
   def append: (node: T, code: String) -> void
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.21.6
+  version: 1.22.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies: []
 description: ast node mutation apis
 email: