node_mutation 1.9.3 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e20b2ab8c6e7c9f01e01b97dfd8b0315d6fb6e474e8176a2f83609ff4e565da
-  data.tar.gz: cc6bcbb6ddbb098b2dbe9090e20cb6d9b7466eea2041a6ae6a0880470e0f8d01
+  metadata.gz: 3f69bebea36b4152c7edb233d2d179bfee796988977c36f6375a12a240a77615
+  data.tar.gz: af1a35eb1b9ec9b3c657d976dd9b0b392d24288de6083f5d98c3d00dc036ff61
 SHA512:
-  metadata.gz: 22b95e80c34f121736637a069cebc2d8e717e1e6cc9461937a9c00dff9253db473dccb945d6463edaee4a3c54df9392597fe6b65e1825a56425742f1beaf80b2
-  data.tar.gz: 7134108cd2d15fd4dd6a4ee73a23f31917bfff251f403297be2f636fa0e4ab580482da4971c87815c22e2b3e182ec585b39fc688963b6495f38781e764372bdf
+  metadata.gz: b07a1795e19142226bd48215514d67cf0f3428ec1b03dbcfe49ed4f9825c962427943b6a1f633bc7d1627178354c3c30989af1a5e63dcbe125af54c98f280a45
+  data.tar.gz: f87aed954b86a4948939528ce1af8bbb779f4673ef8795cd498d015bce84d3abb271db2b44ffd65fdac2f571acbe8d03cfb2ae0cf54a8bd9d97780799e75a521

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # NodeMutation
 
+## 1.10.1 (2023-03-13)
+
+* Remove `OpenStruct`, use `Struct` instead
+
+## 1.10.0 (2023-03-01)
+
+* Support `variable` of `lvasgn`, `ivasgn`, `cvasgn`, and `gvasgn` node in `child_node_range`
+* Update `parser_node_ext` to 1.0.0
+
 ## 1.9.3 (2023-02-15)
 
 * Remove engine

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.9.3)
+    node_mutation (1.10.1)
       erubis
 
 GEM
@@ -36,9 +36,9 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (3.1.2.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    parser_node_ext (0.4.0)
+    parser_node_ext (1.0.0)
       parser
     pry (0.14.1)
       coderay (~> 1.1)

data/lib/node_mutation/action/delete_action.rb

@@ -23,9 +23,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) }
-                            .compact.map(&:start).min
+                       .compact.map(&:start).min
     @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector) }
-                          .compact.map(&:end).max
+                     .compact.map(&:end).max
     squeeze_spaces
     remove_comma if @and_comma
   end

data/lib/node_mutation/action/replace_action.rb

@@ -23,7 +23,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 }.min
-    @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector).end }.max
+    @start = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector).start }
+                       .min
+    @end = @selectors.map { |selector| NodeMutation.adapter.child_node_range(@node, selector).end }
+                     .max
   end
 end

data/lib/node_mutation/action/wrap_action.rb

@@ -20,7 +20,7 @@ class NodeMutation::WrapAction < NodeMutation::Action
   def new_code
     "#{@code}\n#{' ' * @indent}" +
       NodeMutation.adapter.get_source(@node).split("\n").map { |line| "  #{line}" }
-            .join("\n") +
+                  .join("\n") +
       "\n#{' ' * @indent}end"
   end
 

data/lib/node_mutation/action.rb

@@ -30,7 +30,8 @@ class NodeMutation::Action
   # @return [String] rewritten code.
   def new_code
     if rewritten_source.split("\n").length > 1
-      "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }.join("\n")
+      "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }
+                               .join("\n")
     else
       "\n" + indent(@node) + rewritten_source
     end

data/lib/node_mutation/location.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+NodeMutation::Location = Struct.new(:line, :column)

data/lib/node_mutation/parser_adapter.rb

@@ -64,51 +64,50 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
     if node.is_a?(Array)
       if direct_child_name =~ INDEX_REGEXP
         child_node = node[direct_child_name.to_i]
-        raise NodeMutation::MethodNotSupported, "#{direct_child_name} is not supported for #{get_source(node)}" unless child_node
+        raise NodeMutation::MethodNotSupported,
+              "#{direct_child_name} is not supported for #{get_source(node)}" unless child_node
         return child_node_range(child_node, nested_child_name) if nested_child_name
-        return OpenStruct.new(start: child_node.loc.expression.begin_pos, end: child_node.loc.expression.end_pos)
+
+        return NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_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)
+      raise NodeMutation::MethodNotSupported,
+            "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
+
       child_node = node.send(direct_child_name)
       return child_node_range(child_node, nested_child_name) if nested_child_name
-      return OpenStruct.new(
-        start: child_node.loc.expression.begin_pos,
-        end: child_node.loc.expression.end_pos
-      )
+
+      return NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
     end
 
     case [node.type, child_name.to_sym]
     when %i[block pipes], %i[def parentheses], %i[defs parentheses]
-      OpenStruct.new(
-        start: node.arguments.first.loc.expression.begin_pos - 1,
-        end: 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]
-      OpenStruct.new(
-        start: node.arguments.first.loc.expression.begin_pos,
-        end: node.arguments.last.loc.expression.end_pos
-      )
+      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]
-      OpenStruct.new(start: node.loc.name.begin_pos, end: node.loc.name.end_pos)
+      NodeMutation::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
     when %i[defs dot]
-      OpenStruct.new(start: node.loc.operator.begin_pos, end: node.loc.operator.end_pos) if node.loc.operator
+      NodeMutation::Range.new(node.loc.operator.begin_pos, node.loc.operator.end_pos) if node.loc.operator
     when %i[defs self]
-      OpenStruct.new(start: node.loc.operator.begin_pos - 'self'.length, end: node.loc.operator.begin_pos)
+      NodeMutation::Range.new(node.loc.operator.begin_pos - 'self'.length, node.loc.operator.begin_pos)
+    when %i[lvasgn variable], %i[ivasgn variable], %i[cvasgn variable], %i[gvasgn variable]
+      NodeMutation::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
     when %i[send dot], %i[csend dot]
-      OpenStruct.new(start: node.loc.dot.begin_pos, end: node.loc.dot.end_pos) if node.loc.dot
+      NodeMutation::Range.new(node.loc.dot.begin_pos, node.loc.dot.end_pos) if node.loc.dot
     when %i[send message], %i[csend message]
       if node.loc.operator
-        OpenStruct.new(start: node.loc.selector.begin_pos, end: node.loc.operator.end_pos)
+        NodeMutation::Range.new(node.loc.selector.begin_pos, node.loc.operator.end_pos)
       else
-        OpenStruct.new(start: node.loc.selector.begin_pos, end: node.loc.selector.end_pos)
+        NodeMutation::Range.new(node.loc.selector.begin_pos, node.loc.selector.end_pos)
       end
     when %i[send parentheses], %i[csend parentheses]
       if node.loc.begin && node.loc.end
-        OpenStruct.new(start: node.loc.begin.begin_pos, end: node.loc.end.end_pos)
+        NodeMutation::Range.new(node.loc.begin.begin_pos, node.loc.end.end_pos)
       end
     else
-      raise NodeMutation::MethodNotSupported, "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
+      raise NodeMutation::MethodNotSupported,
+            "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
 
       child_node = node.send(direct_child_name)
 
@@ -118,10 +117,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
 
       if child_node.is_a?(Parser::AST::Node)
         return(
-          OpenStruct.new(
-            start: child_node.loc.expression.begin_pos,
-            end: child_node.loc.expression.end_pos
-          )
+          NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
         )
       end
 
@@ -129,10 +125,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       return nil if child_node.empty?
 
       return(
-        OpenStruct.new(
-          start: child_node.first.loc.expression.begin_pos,
-          end: child_node.last.loc.expression.end_pos
-        )
+        NodeMutation::Range.new(child_node.first.loc.expression.begin_pos, child_node.last.loc.expression.end_pos)
       )
     end
   end
@@ -147,12 +140,12 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
 
   def get_start_loc(node)
     begin_loc = node.loc.expression.begin
-    OpenStruct.new(line: begin_loc.line, column: begin_loc.column)
+    NodeMutation::Location.new(begin_loc.line, begin_loc.column)
   end
 
   def get_end_loc(node)
     end_loc = node.loc.expression.end
-    OpenStruct.new(line: end_loc.line, column: end_loc.column)
+    NodeMutation::Location.new(end_loc.line, end_loc.column)
   end
 
   def get_indent(node)
@@ -167,14 +160,19 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
     if node.is_a?(Array)
       if direct_child_name =~ INDEX_REGEXP
         child_node = node[direct_child_name.to_i]
-        raise NodeMutation::MethodNotSupported, "#{direct_child_name} is not supported for #{get_source(node)}" unless child_node
+        raise NodeMutation::MethodNotSupported,
+              "#{direct_child_name} is not supported for #{get_source(node)}" unless child_node
         return child_node_by_name(child_node, nested_child_name) if nested_child_name
+
         return child_node
       end
 
-      raise NodeMutation::MethodNotSupported, "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
+      raise NodeMutation::MethodNotSupported,
+            "#{direct_child_name} is not supported for #{get_source(node)}" unless node.respond_to?(direct_child_name)
+
       child_node = node.send(direct_child_name)
       return child_node_by_name(child_node, nested_child_name) if nested_child_name
+
       return child_node
     end
 

data/lib/node_mutation/range.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+NodeMutation::Range = Struct.new(:start, :end)

data/lib/node_mutation/result.rb

@@ -30,8 +30,12 @@ class NodeMutation::Result
   def to_hash
     hash = { file_path: file_path }
     @options.each do |key, value|
-      hash[key] = value.is_a?(Array) ? value.map { |action| action.to_h } : value
+      if key == :actions
+        hash[:actions] = value.map { |action| { start: action.start, end: action.end, new_code: action.new_code } }
+      else
+        hash[key] = value
+      end
     end
     hash
   end
-end
+end

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 require_relative "node_mutation/version"
 
 class NodeMutation
@@ -20,12 +18,14 @@ class NodeMutation
   autoload :ReplaceWithAction, 'node_mutation/action/replace_with_action'
   autoload :WrapAction, 'node_mutation/action/wrap_action'
   autoload :NoopAction, 'node_mutation/action/noop_action'
+  autoload :Range, 'node_mutation/range'
+  autoload :Location, 'node_mutation/location'
   autoload :Result, 'node_mutation/result'
   autoload :Strategy, 'node_mutation/strategy'
 
   attr_reader :actions
 
-  class <<self
+  class << self
     # Configure NodeMutation
     # @param [Hash] options options to configure
     # @option options [NodeMutation::Adapter] :adapter the adpater
@@ -220,21 +220,17 @@ class NodeMutation
       return NodeMutation::Result.new(affected: false, conflicted: false)
     end
 
-    conflict_actions = []
     source = +@source
     @actions.sort_by! { |action| [action.start, action.end] }
     conflict_actions = get_conflict_actions
     if conflict_actions.size > 0 && strategy?(Strategy::THROW_ERROR)
       raise ConflictActionError, "mutation actions are conflicted"
     end
+
     @actions.reverse_each do |action|
       source[action.start...action.end] = action.new_code if action.new_code
     end
-    NodeMutation::Result.new(
-      affected: true,
-      conflicted: !conflict_actions.empty?,
-      new_source: source
-    )
+    NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?, new_source: source)
   end
 
   # Test actions and return the actions.
@@ -249,17 +245,13 @@ class NodeMutation
       return NodeMutation::Result.new(affected: false, conflicted: false, actions: [])
     end
 
-    conflict_actions = []
     @actions.sort_by! { |action| [action.start, action.end] }
     conflict_actions = get_conflict_actions
     if conflict_actions.size > 0 && strategy?(Strategy::THROW_ERROR)
       raise ConflictActionError, "mutation actions are conflicted"
     end
-    NodeMutation::Result.new(
-      affected: true,
-      conflicted: !conflict_actions.empty?,
-      actions: format_actions(@actions)
-    )
+
+    NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?, actions: @actions)
   end
 
   private
@@ -294,8 +286,4 @@ class NodeMutation
   def strategy?(strategy)
     NodeMutation.strategy & strategy == strategy
   end
-
-  def format_actions(actions)
-    actions.map { |action| OpenStruct.new(start: action.start, end: action.end, new_code: action.new_code ) }
-  end
 end

data/node_mutation.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      end
     end
-  end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/sig/node_mutation/adapter.rbs

@@ -5,15 +5,15 @@ class NodeMutation::Adapter[T]
 
   def file_content: (node: T) -> String
 
-  def child_node_range: (node: T, child_name: String) -> OpenStruct
+  def child_node_range: (node: T, child_name: String) -> NodeMutation::Range
 
   def get_start: (node: T) -> Integer
 
   def get_end: (node: T) -> Integer
 
-  def get_start_loc: (node: T) -> OpenStruct
+  def get_start_loc: (node: T) -> NodeMutation::Location
 
-  def get_end_loc: (node: T) -> OpenStruct
+  def get_end_loc: (node: T) -> NodeMutation::Location
 
   def get_indent: (node: T) -> Integer
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.9.3
+  version: 1.10.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -51,7 +51,9 @@ files:
 - lib/node_mutation/action/replace_with_action.rb
 - lib/node_mutation/action/wrap_action.rb
 - lib/node_mutation/adapter.rb
+- lib/node_mutation/location.rb
 - lib/node_mutation/parser_adapter.rb
+- lib/node_mutation/range.rb
 - lib/node_mutation/result.rb
 - lib/node_mutation/strategy.rb
 - lib/node_mutation/version.rb
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: ast node mutation apis