node_mutation 1.10.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f69bebea36b4152c7edb233d2d179bfee796988977c36f6375a12a240a77615
-  data.tar.gz: af1a35eb1b9ec9b3c657d976dd9b0b392d24288de6083f5d98c3d00dc036ff61
+  metadata.gz: 97dd9f7362d033a9572811a001fcda89634580d2af15bd7736209dbb7228ba56
+  data.tar.gz: e7d4eb04cd7c0d739622105b8aedf85bc8e1e72c8e4e278bf87d840d05787fea
 SHA512:
-  metadata.gz: b07a1795e19142226bd48215514d67cf0f3428ec1b03dbcfe49ed4f9825c962427943b6a1f633bc7d1627178354c3c30989af1a5e63dcbe125af54c98f280a45
-  data.tar.gz: f87aed954b86a4948939528ce1af8bbb779f4673ef8795cd498d015bce84d3abb271db2b44ffd65fdac2f571acbe8d03cfb2ae0cf54a8bd9d97780799e75a521
+  metadata.gz: 0e44b67cb7c1dc8ef15ed16ac92c10400639704df32d0a06f2db40a68b8ea6259fe73d7c0dda2df8c5dd07c03137e95d7eca62ae0948c27b2e93b36fa5752cc3
+  data.tar.gz: f07ebe6b3712ae3d13b9cf06b7b5dd3e45d68ee7cb7571a9e227f2318de16271f4db2aea0a1ec62a48bc71e6666f8c91e9fda00628cf32d685af083890f70b41

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # NodeMutation
 
+## 1.12.0 (2023-03-23)
+
+* Support `{key}_pair` for a `hash` node
+
+## 1.11.0 (2023-03-20)
+
+* Calculate position properly for `add_comma`
+* Add `and_comma` param to `insert` dsl
+
 ## 1.10.1 (2023-03-13)
 
 * Remove `OpenStruct`, use `Struct` instead

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.10.1)
+    node_mutation (1.12.0)
       erubis
 
 GEM

data/lib/node_mutation/action/delete_action.rb

@@ -26,7 +26,7 @@ class NodeMutation::DeleteAction < NodeMutation::Action
                        .compact.map(&:start).min
     @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector) }
                      .compact.map(&:end).max
-    squeeze_spaces
     remove_comma if @and_comma
+    remove_whitespace
   end
 end

data/lib/node_mutation/action/insert_action.rb

@@ -8,17 +8,23 @@ class NodeMutation::InsertAction < NodeMutation::Action
   # @param code [String] to be inserted
   # @param at [String] position to insert, beginning or end
   # @param to [<nil|String>] name of child node
-  def initialize(node, code, at: 'end', to: nil)
+  # @param and_comma [Boolean] insert extra comma.
+  def initialize(node, code, at: 'end', to: nil, and_comma: false)
     super(node, code)
     @at = at
     @to = to
+    @and_comma = and_comma
   end
 
   # The rewritten source code.
   #
   # @return [String] rewritten code.
   def new_code
-    rewritten_source
+    if @and_comma
+      @at == 'end' ? ", #{rewritten_source}" : "#{rewritten_source}, "
+    else
+      rewritten_source
+    end
   end
 
   private

data/lib/node_mutation/action/remove_action.rb

@@ -21,15 +21,13 @@ 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)
+    remove_comma if @and_comma
+    remove_whitespace
     if take_whole_line?
-      @start = start_index
-      @end = end_index
+      remove_newline
       squeeze_lines
-    else
-      @start = NodeMutation.adapter.get_start(@node)
-      @end = NodeMutation.adapter.get_end(@node)
-      squeeze_spaces
-      remove_comma if @and_command
     end
   end
 
@@ -37,18 +35,50 @@ class NodeMutation::RemoveAction < NodeMutation::Action
   #
   # @return [Boolean]
   def take_whole_line?
-    NodeMutation.adapter.get_source(@node) == file_source[start_index...end_index].strip
+    NodeMutation.adapter.get_source(@node) == file_source[@start...@end].strip.chomp(',')
   end
 
-  # Get the start position of the line
-  def start_index
-    index = file_source[0..NodeMutation.adapter.get_start(@node)].rindex("\n")
-    index ? index + "\n".length : NodeMutation.adapter.get_start(@node)
+  def remove_newline
+    leading_count = 1
+    loop do
+      if file_source[@start - leading_count] == "\n"
+        break
+      elsif ["\t", ' '].include?(file_source[@start - leading_count])
+        leading_count += 1
+      else
+        break
+      end
+    end
+
+    trailing_count = 0
+    loop do
+      if file_source[@end + trailing_count] == "\n"
+        break
+      elsif ["\t", ' '].include?(file_source[@end + trailing_count])
+        trailing_count += 1
+      else
+        break
+      end
+    end
+
+    if file_source[@end + trailing_count] == "\n"
+      @end += trailing_count + 1
+    end
+
+    if file_source[@start - leading_count] == "\n"
+      @start -= leading_count - 1
+    end
   end
 
-  # Get the end position of the line
-  def end_index
-    index = file_source[NodeMutation.adapter.get_end(@node)..-1].index("\n")
-    index ? NodeMutation.adapter.get_end(@node) + index + "\n".length : NodeMutation.adapter.get_end(@node)
+  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
+    before_line_is_blank = begin_line == 1 || lines[begin_line - 2] == ''
+    after_line_is_blank = lines[end_line] == ''
+
+    if lines.length > 1 && before_line_is_blank && after_line_is_blank
+      @end += "\n".length
+    end
   end
 end

data/lib/node_mutation/action.rb

@@ -53,23 +53,14 @@ class NodeMutation::Action
     @rewritten_source ||= NodeMutation.adapter.rewritten_source(@node, @code)
   end
 
-  # Squeeze spaces from source code.
-  def squeeze_spaces
-    if file_source[@start - 1] == ' ' && [' ', "\n", ';'].include?(file_source[@end])
-      @start -= 1
-    end
-  end
-
-  # Squeeze empty lines from source code.
-  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
-    before_line_is_blank = begin_line == 1 || lines[begin_line - 2] == ''
-    after_line_is_blank = lines[end_line] == ''
+  # remove unused whitespace.
+  # e.g. `foobar(foo, bar)`, if we remove `foo`, the whitespace should also be removed,
+  # the code should be changed to `foobar(bar)`.
+  def remove_whitespace
+    return unless [' ', '('].include?(file_source[@start - 1])
 
-    if lines.length > 1 && before_line_is_blank && after_line_is_blank
-      @end += "\n".length
+    while file_source[@end] == ' '
+      @end += 1
     end
   end
 
@@ -77,14 +68,28 @@ class NodeMutation::Action
   # e.g. `foobar(foo, bar)`, if we remove `foo`, the comma should also be removed,
   # the code should be changed to `foobar(bar)`.
   def remove_comma
-    if ',' == file_source[@start - 1]
-      @start -= 1
-    elsif ', ' == file_source[@start - 2, 2]
-      @start -= 2
-    elsif ', ' == file_source[@end, 2]
-      @end += 2
-    elsif ',' == file_source[@end]
-      @end += 1
+    leading_count = 1
+    loop do
+      if file_source[@start - leading_count] == ','
+        @start -= leading_count
+        return
+      elsif ["\n", "\r", "\t", ' '].include?(file_source[@start - leading_count])
+        leading_count += 1
+      else
+        break
+      end
+    end
+
+    trailing_count = 0
+    loop do
+      if file_source[@end + trailing_count] == ','
+        @end += trailing_count + 1
+        return
+      elsif file_source[@end + trailing_count] == ' '
+        trailing_count += 1
+      else
+        break
+      end
     end
   end
 

data/lib/node_mutation/parser_adapter.rb

@@ -5,6 +5,8 @@ INDEX_REGEXP = /\A-?\d+\z/
 class NodeMutation::ParserAdapter < NodeMutation::Adapter
   def get_source(node)
     if node.is_a?(Array)
+      return "" if node.empty?
+
       source = file_content(node.first)
       source[node.first.loc.expression.begin_pos...node.last.loc.expression.end_pos]
     else
@@ -15,41 +17,36 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
   def rewritten_source(node, code)
     code.gsub(/{{(.+?)}}/m) do
       old_code = Regexp.last_match(1)
-      first_key = old_code.split('.').first
-      if node.respond_to?(first_key)
-        evaluated = child_node_by_name(node, old_code)
-        case evaluated
-        when Parser::AST::Node
-          if evaluated.type == :args
-            evaluated.loc.expression.source[1...-1]
+      evaluated = child_node_by_name(node, old_code)
+      case evaluated
+      when Parser::AST::Node
+        if evaluated.type == :args
+          evaluated.loc.expression.source[1...-1]
+        else
+          evaluated.loc.expression.source
+        end
+      when Array
+        if evaluated.size > 0
+          file_source = file_content(evaluated.first)
+          source = file_source[evaluated.first.loc.expression.begin_pos...evaluated.last.loc.expression.end_pos]
+          lines = source.split "\n"
+          lines_count = lines.length
+          if lines_count > 1 && lines_count == evaluated.size
+            new_code = []
+            lines.each_with_index { |line, index|
+              new_code << (index == 0 ? line : line[evaluated.first.indent - 2..-1])
+            }
+            new_code.join("\n")
           else
-            evaluated.loc.expression.source
-          end
-        when Array
-          if evaluated.size > 0
-            file_source = file_content(evaluated.first)
-            source = file_source[evaluated.first.loc.expression.begin_pos...evaluated.last.loc.expression.end_pos]
-            lines = source.split "\n"
-            lines_count = lines.length
-            if lines_count > 1 && lines_count == evaluated.size
-              new_code = []
-              lines.each_with_index { |line, index|
-                new_code << (index == 0 ? line : line[evaluated.first.indent - 2..-1])
-              }
-              new_code.join("\n")
-            else
-              source
-            end
+            source
           end
-        when String, Symbol, Integer, Float
-          evaluated
-        when NilClass
-          ''
-        else
-          raise "can not parse \"#{code}\""
         end
+      when String, Symbol, Integer, Float
+        evaluated
+      when NilClass
+        ''
       else
-        raise NodeMutation::MethodNotSupported, "#{first_key} is not supported for #{get_source(node)}"
+        raise "can not parse \"#{code}\""
       end
     end
   end
@@ -82,7 +79,10 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
 
     case [node.type, child_name.to_sym]
     when %i[block pipes], %i[def parentheses], %i[defs parentheses]
-      NodeMutation::Range.new(node.arguments.first.loc.expression.begin_pos - 1, node.arguments.last.loc.expression.end_pos + 1)
+      NodeMutation::Range.new(
+        node.arguments.first.loc.expression.begin_pos - 1,
+        node.arguments.last.loc.expression.end_pos + 1
+      )
     when %i[block arguments], %i[def arguments], %i[defs arguments]
       NodeMutation::Range.new(node.arguments.first.loc.expression.begin_pos, node.arguments.last.loc.expression.end_pos)
     when %i[class name], %i[const name], %i[def name], %i[defs name]
@@ -106,6 +106,15 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
         NodeMutation::Range.new(node.loc.begin.begin_pos, node.loc.end.end_pos)
       end
     else
+      if node.type == :hash && child_name.to_s.end_with?('_pair')
+        pair_node = node.pairs.find { |pair| pair.key.to_value.to_s == child_name.to_s[0..-6] }
+        raise NodeMutation::MethodNotSupported,
+              "#{direct_child_name} is not supported for #{get_source(node)}" unless pair_node
+        return child_node_range(pair, nested_child_name) if nested_child_name
+
+        return NodeMutation::Range.new(pair_node.loc.expression.begin_pos, pair_node.loc.expression.end_pos)
+      end
+
       raise NodeMutation::MethodNotSupported,
             "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
 
@@ -176,10 +185,19 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       return child_node
     end
 
+    if node.is_a?(Parser::AST::Node) && node.type == :hash && direct_child_name.end_with?('_pair')
+      pair_node = node.pairs.find { |pair| pair.key.to_value.to_s == direct_child_name[0..-6] }
+      raise NodeMutation::MethodNotSupported,
+            "#{direct_child_name} is not supported for #{get_source(node)}" unless pair_node
+      return child_node_by_name(pair_node, nested_child_name) if nested_child_name
+
+      return pair_node
+    end
+
     if node.respond_to?(direct_child_name)
       child_node = node.send(direct_child_name)
     elsif direct_child_name.include?('(') && direct_child_name.include?(')')
-      child_node = eval("node.#{direct_child_name}")
+      child_node = node.instance_eval(direct_child_name)
     else
       raise NodeMutation::MethodNotSupported, "#{direct_child_name} is not supported for #{get_source(node)}"
     end

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -92,8 +92,7 @@ class NodeMutation
   # Delete source code of the child ast node.
   # @param node [Node] ast node
   # @param selectors [Array<Symbol>] selector names of child node.
-  # @param options [Hash]
-  # @option and_comma [Boolean] delete extra comma.
+  # @param and_comma [Boolean] delete extra comma.
   # @example
   # source code of the ast node is
   #     FactoryBot.create(...)
@@ -101,8 +100,8 @@ class NodeMutation
   #     mutation.delete(node, :receiver, :dot)
   # the source code will be rewritten to
   #     create(...)
-  def delete(node, *selectors, **options)
-    @actions << DeleteAction.new(node, *selectors, **options).process
+  def delete(node, *selectors, and_comma: false)
+    @actions << DeleteAction.new(node, *selectors, and_comma: and_comma).process
   end
 
   # Insert code to the ast node.
@@ -110,6 +109,7 @@ class NodeMutation
   # @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')
@@ -117,8 +117,8 @@ class NodeMutation
   #     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)
-    @actions << InsertAction.new(node, code, at: at, to: to).process
+  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
   end
 
   # Prepend code to the ast node.
@@ -142,16 +142,15 @@ class NodeMutation
 
   # Remove source code of the ast node.
   # @param node [Node] ast node
-  # @param options [Hash] options.
-  # @option and_comma [Boolean] delete extra comma.
+  # @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, **options)
-    @actions << RemoveAction.new(node, **options).process
+  def remove(node, and_comma: false)
+    @actions << RemoveAction.new(node, and_comma: and_comma).process
   end
 
   # Replace child node of the ast node with new code.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis