node_mutation 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97dd9f7362d033a9572811a001fcda89634580d2af15bd7736209dbb7228ba56
-  data.tar.gz: e7d4eb04cd7c0d739622105b8aedf85bc8e1e72c8e4e278bf87d840d05787fea
+  metadata.gz: 377cc05adfb7a9f55647b1850a325d9ddcb20004e2574af39657248bd05a51b4
+  data.tar.gz: 233c08e3fa49855270f62c11e1d9587b77886e9a6edded54f27096a9dc951849
 SHA512:
-  metadata.gz: 0e44b67cb7c1dc8ef15ed16ac92c10400639704df32d0a06f2db40a68b8ea6259fe73d7c0dda2df8c5dd07c03137e95d7eca62ae0948c27b2e93b36fa5752cc3
-  data.tar.gz: f07ebe6b3712ae3d13b9cf06b7b5dd3e45d68ee7cb7571a9e227f2318de16271f4db2aea0a1ec62a48bc71e6666f8c91e9fda00628cf32d685af083890f70b41
+  metadata.gz: 593a0319dc715d587137e840d66694ed6f8c5d4a73312eb20847eee8383b4f47910f25d1d14f1e3fb95bee3ee1ab6627a08fdd2fa40c837c1a4d8e3422237066
+  data.tar.gz: 9aca39fb58ae4b02687a310fdcc3a7f388ebc86bcdce29b8efff24069077e3ed9194c9556bd833737160c8a220af87c010eedfd588e71f98c5b3bdae0d578cd3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # NodeMutation
 
+## 1.12.1 (2023-03-23)
+
+* Define `Action`, `Location` and `Range` in `NodeMutation::Struct`
+
 ## 1.12.0 (2023-03-23)
 
 * Support `{key}_pair` for a `hash` node

data/Gemfile.lock

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

data/lib/node_mutation/parser_adapter.rb

@@ -65,7 +65,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
               "#{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 NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
+        return NodeMutation::Struct::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
       end
 
       raise NodeMutation::MethodNotSupported,
@@ -74,36 +74,39 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       child_node = node.send(direct_child_name)
       return child_node_range(child_node, nested_child_name) if nested_child_name
 
-      return NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
+      return NodeMutation::Struct::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]
-      NodeMutation::Range.new(
+      NodeMutation::Struct::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)
+      NodeMutation::Struct::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]
-      NodeMutation::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
+      NodeMutation::Struct::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
     when %i[defs dot]
-      NodeMutation::Range.new(node.loc.operator.begin_pos, node.loc.operator.end_pos) if node.loc.operator
+      NodeMutation::Struct::Range.new(node.loc.operator.begin_pos, node.loc.operator.end_pos) if node.loc.operator
     when %i[defs self]
-      NodeMutation::Range.new(node.loc.operator.begin_pos - 'self'.length, node.loc.operator.begin_pos)
+      NodeMutation::Struct::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)
+      NodeMutation::Struct::Range.new(node.loc.name.begin_pos, node.loc.name.end_pos)
     when %i[send dot], %i[csend dot]
-      NodeMutation::Range.new(node.loc.dot.begin_pos, node.loc.dot.end_pos) if node.loc.dot
+      NodeMutation::Struct::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
-        NodeMutation::Range.new(node.loc.selector.begin_pos, node.loc.operator.end_pos)
+        NodeMutation::Struct::Range.new(node.loc.selector.begin_pos, node.loc.operator.end_pos)
       else
-        NodeMutation::Range.new(node.loc.selector.begin_pos, node.loc.selector.end_pos)
+        NodeMutation::Struct::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
-        NodeMutation::Range.new(node.loc.begin.begin_pos, node.loc.end.end_pos)
+        NodeMutation::Struct::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')
@@ -112,7 +115,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
               "#{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)
+        return NodeMutation::Struct::Range.new(pair_node.loc.expression.begin_pos, pair_node.loc.expression.end_pos)
       end
 
       raise NodeMutation::MethodNotSupported,
@@ -126,7 +129,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
 
       if child_node.is_a?(Parser::AST::Node)
         return(
-          NodeMutation::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
+          NodeMutation::Struct::Range.new(child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
         )
       end
 
@@ -134,7 +137,10 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       return nil if child_node.empty?
 
       return(
-        NodeMutation::Range.new(child_node.first.loc.expression.begin_pos, child_node.last.loc.expression.end_pos)
+        NodeMutation::Struct::Range.new(
+          child_node.first.loc.expression.begin_pos,
+          child_node.last.loc.expression.end_pos
+        )
       )
     end
   end
@@ -149,12 +155,12 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
 
   def get_start_loc(node)
     begin_loc = node.loc.expression.begin
-    NodeMutation::Location.new(begin_loc.line, begin_loc.column)
+    NodeMutation::Struct::Location.new(begin_loc.line, begin_loc.column)
   end
 
   def get_end_loc(node)
     end_loc = node.loc.expression.end
-    NodeMutation::Location.new(end_loc.line, end_loc.column)
+    NodeMutation::Struct::Location.new(end_loc.line, end_loc.column)
   end
 
   def get_indent(node)

data/lib/node_mutation/result.rb

@@ -1,41 +1,31 @@
 # frozen_string_literal: true
 
 class NodeMutation::Result
-  attr_accessor :file_path
+  attr_accessor :file_path, :new_source
+  attr_reader :actions
 
-  def initialize(options)
-    @options = options
+  def initialize(affected:, conflicted:)
+    @affected = affected
+    @conflicted = conflicted
+    @actions = []
   end
 
   def affected?
-    @options[:affected]
+    @affected
   end
 
   def conflicted?
-    @options[:conflicted]
+    @conflicted
   end
 
-  def actions
-    @options[:actions]
-  end
-
-  def new_source
-    @options[:new_source]
+  def actions=(actions)
+    @actions = actions.map { |action| NodeMutation::Struct::Action.new(action.start, action.end, action.new_code) }
   end
 
   def to_json(*args)
-    to_hash.to_json(*args)
-  end
-
-  def to_hash
-    hash = { file_path: file_path }
-    @options.each do |key, 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
+    data = { affected: affected?, conflicted: conflicted? }
+    data[:new_source] = new_source if new_source
+    data[:actions] = actions unless actions.empty?
+    data.to_json(*args)
   end
 end

data/lib/node_mutation/struct.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class NodeMutation::Struct
+  Action = Struct.new(:start, :end, :new_code)
+  Location = Struct.new(:line, :column)
+  Range = Struct.new(:start, :end)
+end

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -18,10 +18,9 @@ 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'
+  autoload :Struct, 'node_mutation/struct'
 
   attr_reader :actions
 
@@ -229,7 +228,9 @@ class NodeMutation
     @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)
+    result = NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?)
+    result.new_source = source
+    result
   end
 
   # Test actions and return the actions.
@@ -241,7 +242,7 @@ class NodeMutation
   # @return {NodeMutation::Result}
   def test
     if @actions.length == 0
-      return NodeMutation::Result.new(affected: false, conflicted: false, actions: [])
+      return NodeMutation::Result.new(affected: false, conflicted: false)
     end
 
     @actions.sort_by! { |action| [action.start, action.end] }
@@ -250,7 +251,9 @@ class NodeMutation
       raise ConflictActionError, "mutation actions are conflicted"
     end
 
-    NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?, actions: @actions)
+    result = NodeMutation::Result.new(affected: true, conflicted: !conflict_actions.empty?)
+    result.actions = @actions
+    result
   end
 
   private

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) -> NodeMutation::Range
+  def child_node_range: (node: T, child_name: String) -> NodeMutation::Struct::Range
 
   def get_start: (node: T) -> Integer
 
   def get_end: (node: T) -> Integer
 
-  def get_start_loc: (node: T) -> NodeMutation::Location
+  def get_start_loc: (node: T) -> NodeMutation::Struct::Location
 
-  def get_end_loc: (node: T) -> NodeMutation::Location
+  def get_end_loc: (node: T) -> NodeMutation::Struct::Location
 
   def get_indent: (node: T) -> Integer
 end

data/sig/node_mutation/result.rbs

@@ -1,5 +1,7 @@
 class NodeMutation::Result
   attr_accessor file_path (): String
+  attr_accessor new_source (): String
+  attr_accessor actions (): Array[NodeMutation::Struct::Action]
 
   def initialize: (source: String) -> NodeMutation::Result
 
@@ -7,9 +9,5 @@ class NodeMutation::Result
 
   def conflicted?: () -> bool
 
-  def new_source: () -> String
-
-  def actions: () -> Array[Hash]
-
   def to_json: (*args) -> String
 end

data/sig/node_mutation/strategy.rbs

@@ -0,0 +1,7 @@
+class NodeMutation::Strategy
+  KEEP_RUNNING: Integer
+
+  THROW_ERROR: Integer
+
+  ALLOW_INSERT_AT_SAME_POSITION: Integer
+end

data/sig/node_mutation/struct.rbs

@@ -0,0 +1,17 @@
+class NodeMutation::Struct
+  class Action < ::Struct
+    prop :start, Integer
+    prop :end, Integer
+    prop :new_code, String
+  end
+
+  class Location < ::Struct
+    prop :line, Integer
+    prop :column, Integer
+  end
+
+  class Range < ::Struct
+    prop :start, Integer
+    prop :end, Integer
+  end
+end

data/sig/node_mutation.rbs

@@ -1,5 +1,5 @@
 module NodeMutation[T]
-  VERSION: Stringo
+  VERSION: String
 
   class MethodNotSupported < StandardError
   end
@@ -7,10 +7,6 @@ module NodeMutation[T]
   class ConflictActionError < StandardError
   end
 
-  KEEP_RUNNING: Integer
-
-  THROW_ERROR: Integer
-
   attr_reader actions: Array[NodeMutation::Action]
 
   def self.configure: (options: { adapter: NodeMutation::Adapter, strategy: Integer, tab_width: Integer }) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Richard Huang
@@ -51,16 +51,17 @@ 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/struct.rb
 - lib/node_mutation/version.rb
 - node_mutation.gemspec
 - sig/node_mutation.rbs
 - sig/node_mutation/adapter.rbs
 - sig/node_mutation/result.rbs
+- sig/node_mutation/strategy.rbs
+- sig/node_mutation/struct.rbs
 homepage: https://github.com/xinminlabs/node-mutation-ruby
 licenses: []
 metadata:
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: ast node mutation apis

data/lib/node_mutation/location.rb

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

data/lib/node_mutation/range.rb

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