node_mutation 1.13.2 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc332fd8345dc642414853ebc7f92ddf3f4d364c2bd5f5076d5de3a17368ce50
-  data.tar.gz: 4a5018954b0094f1dea13c4b4f7ce0237e368564b892a57cd680ec88fb062eb1
+  metadata.gz: 11054e72fcf35b7caeb2cee67b421206da2f980d4d1f23afa08f9db75f112f75
+  data.tar.gz: 4dde234a2f4716b82d042b7d9f094469da04942cdca669c40a7d745f75480b77
 SHA512:
-  metadata.gz: f2329f07950c9a97b1cb2729ffc9b617e146a56607476f03c8cb78e3047ebc52358e59ff4e80916e8bf521f4d8ff9e7e5801e2452b414f81ac447590e39ac9e6
-  data.tar.gz: b97de612f89f6d7e23a20e2bfaed7aa1c0ead95ba868c3535e9575161feb18a35b13a0a75623a814855ce149d7f56676ad1fc76836235ce5e4d8a503dc0147bb
+  metadata.gz: 5bfc255f3b2bf599debc4c8d882999d3083f89ec2e9cdb81aa2eb1d4245e65cafb61c9f9ee7db7286b4efddf66b96cb00742696f5215beab1b3cc847c2025b40
+  data.tar.gz: 7c9063056156b1ee4accd50ad204040209c55ca096f543ecccc5f66175b1213a5611a4815263058514d81466e440d6cdf36f65c7208d048c48c3f3736e516706

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # NodeMutation
 
+## 1.15.0 (2023-04-17)
+
+* Add `indent` action
+* Use two `InsertAction` and one `IndentAction` instead of `WrapAction`
+* Drop `ALLOW_INSERT_AT_SAME_POSITION` strategy
+
+## 1.14.0 (2023-04-04)
+
+* Add `transform_proc` to transform the actions
+* Allow to write `Action` `start` and `end` attributes
+
 ## 1.13.2 (2023-04-01)
 
 * Support `cvar`, `gvar`, `ivar`, and `lvar` name in `child_node_range`

data/Gemfile.lock

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

data/README.md

@@ -35,18 +35,20 @@ mutation = NodeMutation.new(source)
 mutation.append node, 'include FactoryGirl::Syntax::Methods'
 # delete source code of the child ast node
 mutation.delete node, :dot, :message, and_comma: true
+# indent code
+mutation.indent node, tab_size: 1
 # insert code to the ast node.
 mutation.insert node, 'URI.', at: 'beginning'
 # prepend code to the ast node.
 mutation.prepend node, '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
 # remove source code of the ast node
-mutation.remove(node: Node)
+mutation.remove node, and_comma: true
 # replace child node of the ast node with new code
 mutation.replace node, :message, with: 'test'
 # replace the ast node with new code
 mutation.replace_with node, 'create {{arguments}}'
-# wrap node within a block, class or module
-mutation.wrap node, with: 'module Foo'
+# wrap node with prefix and suffix code
+mutation.wrap node, prefix: 'module Foo', suffix: 'end', newline: true
 # no operation
 mutation.noop
 ```
@@ -81,10 +83,9 @@ It provides 3 strategies to handle conflicts when processing actions:
 
 1. `Strategy.KEEP_RUNNING`: keep running and ignore the conflict action.
 2. `Strategy.THROW_ERROR`: throw error when conflict action is found.
-3. `Strategy.ALLOW_INSERT_AT_SAME_POSITION`: allow insert action at the same position.
 
 ```ruby
-NodeMutation.configure(strategy: Strategy.KEEP_RUNNING | Strategy.ALLOW_INSERT_AT_SAME_POSITION); // default is Strategy.THROW_ERROR
+NodeMutation.configure(strategy: Strategy.KEEP_RUNNING); // default is Strategy.THROW_ERROR
 ```
 
 ### tab_width

data/lib/node_mutation/action/indent_action.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# IndentAction to indent code.
+class NodeMutation::IndentAction < NodeMutation::Action
+  # Initialize a IndentAction.
+  #
+  # @param node [Node]
+  # @param tab_size [Integer] tab size
+  def initialize(node, tab_size = 1)
+    super(node, nil)
+    @tab_size = tab_size
+  end
+
+  # The rewritten source code with proper indent.
+  #
+  # @return [String] rewritten code.
+  def new_code
+    source = NodeMutation.adapter.get_source(@node)
+    source.each_line.map { |line| ' ' * NodeMutation.tab_width * @tab_size + line }.join
+  end
+
+  private
+
+  # Calculate the begin the end positions.
+  def calculate_position
+    @start = NodeMutation.adapter.get_start(@node)
+    @end = NodeMutation.adapter.get_end(@node)
+  end
+end

data/lib/node_mutation/action.rb

@@ -2,11 +2,11 @@
 
 # Action defines rewriter action, insert, replace or delete code.
 class NodeMutation::Action
-  # @!attribute [r] start
+  # @!attribute [rw] start
   #   @return [Integer] start position
-  # @!attribute [r] end
+  # @!attribute [rw] end
   #   @return [Integer] end position
-  attr_reader :start, :end
+  attr_accessor :start, :end
 
   # Initialize an action.
   #

data/lib/node_mutation/strategy.rb

@@ -3,5 +3,4 @@
 class NodeMutation::Strategy
   KEEP_RUNNING = 0b1
   THROW_ERROR = 0b10
-  ALLOW_INSERT_AT_SAME_POSITION = 0b100
 end

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -11,19 +11,25 @@ class NodeMutation
   autoload :Action, 'node_mutation/action'
   autoload :AppendAction, 'node_mutation/action/append_action'
   autoload :DeleteAction, 'node_mutation/action/delete_action'
+  autoload :IndentAction, 'node_mutation/action/indent_action'
   autoload :InsertAction, 'node_mutation/action/insert_action'
   autoload :RemoveAction, 'node_mutation/action/remove_action'
   autoload :PrependAction, 'node_mutation/action/prepend_action'
   autoload :ReplaceAction, 'node_mutation/action/replace_action'
   autoload :ReplaceWithAction, 'node_mutation/action/replace_with_action'
-  autoload :WrapAction, 'node_mutation/action/wrap_action'
   autoload :NoopAction, 'node_mutation/action/noop_action'
   autoload :Result, 'node_mutation/result'
   autoload :Strategy, 'node_mutation/strategy'
   autoload :Struct, 'node_mutation/struct'
 
+  # @!attribute [r] actions
+  #   @return [Array<NodeMutation::Struct::Action>]
   attr_reader :actions
 
+  # @!attribute [rw] transform_proc
+  #  @return [Proc] proc to transfor the actions
+  attr_accessor :transform_proc
+
   class << self
     # Configure NodeMutation
     # @param [Hash] options options to configure
@@ -182,22 +188,26 @@ class NodeMutation
     @actions << ReplaceWithAction.new(node, code).process
   end
 
-  # Wrap source code of the ast node with new code.
+  # Wrap source code of the ast node with prefix and suffix code.
   # @param node [Node] ast node
-  # @param with [String] code need to be wrapped with.
+  # @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, with: 'module Synvert')
+  #     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, with:)
-    @actions << WrapAction.new(node, with: with).process
+  def wrap(node, prefix:, suffix:, newline: false)
+    @actions << InsertAction.new(node, prefix, at: 'beginning').process
+    @actions << InsertAction.new(node, suffix, at: 'end').process
+    @actions << IndentAction.new(node).process if newline
   end
 
   # No operation.
@@ -219,6 +229,7 @@ class NodeMutation
     end
 
     source = +@source
+    @transform_proc.call(@actions) if @transform_proc
     @actions.sort_by! { |action| [action.start, action.end] }
     conflict_actions = get_conflict_actions
     if conflict_actions.size > 0 && strategy?(Strategy::THROW_ERROR)
@@ -245,6 +256,7 @@ class NodeMutation
       return NodeMutation::Result.new(affected: false, conflicted: false)
     end
 
+    @transform_proc.call(@actions) if @transform_proc
     @actions.sort_by! { |action| [action.start, action.end] }
     conflict_actions = get_conflict_actions
     if conflict_actions.size > 0 && strategy?(Strategy::THROW_ERROR)
@@ -269,11 +281,8 @@ class NodeMutation
     begin_pos = @actions[i].start
     end_pos = @actions[i].end
     while j > -1
-      # if we have two insert actions at same position.
-      same_position = begin_pos == @actions[j].start && begin_pos == end_pos && @actions[j].start == @actions[j].end
       # if we have two actions with overlapped range.
-      overlapped_position = begin_pos < @actions[j].end
-      if (!strategy?(Strategy::ALLOW_INSERT_AT_SAME_POSITION) && same_position) || overlapped_position
+      if begin_pos < @actions[j].end
         conflict_actions << @actions.delete_at(j)
       else
         i = j

data/sig/node_mutation/strategy.rbs

@@ -2,6 +2,4 @@ class NodeMutation::Strategy
   KEEP_RUNNING: Integer
 
   THROW_ERROR: Integer
-
-  ALLOW_INSERT_AT_SAME_POSITION: Integer
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.13.2
+  version: 1.15.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies: []
 description: ast node mutation apis
 email:
@@ -29,13 +29,13 @@ files:
 - lib/node_mutation/action.rb
 - lib/node_mutation/action/append_action.rb
 - lib/node_mutation/action/delete_action.rb
+- lib/node_mutation/action/indent_action.rb
 - lib/node_mutation/action/insert_action.rb
 - lib/node_mutation/action/noop_action.rb
 - lib/node_mutation/action/prepend_action.rb
 - 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/action/wrap_action.rb
 - lib/node_mutation/adapter.rb
 - lib/node_mutation/parser_adapter.rb
 - lib/node_mutation/result.rb
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: ast node mutation apis

data/lib/node_mutation/action/wrap_action.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# WrapAction to wrap node within a block, class or module.
-#
-# Note: if WrapAction is conflicted with another action (start and end are overlapped),
-# we have to put those 2 actions into 2 within_file scopes.
-class NodeMutation::WrapAction < NodeMutation::Action
-  # Initialize a WrapAction.
-  #
-  # @param node [Node]
-  # @param with [String] new code to wrap
-  def initialize(node, with:)
-    super(node, with)
-    @indent = NodeMutation.adapter.get_start_loc(@node).column
-  end
-
-  # The rewritten source code.
-  #
-  # @return [String] rewritten code.
-  def new_code
-    "#{@code}\n#{' ' * @indent}" +
-      NodeMutation.adapter.get_source(@node).split("\n").map { |line| "  #{line}" }
-                  .join("\n") +
-      "\n#{' ' * @indent}end"
-  end
-
-  private
-
-  # Calculate the begin the end positions.
-  def calculate_position
-    @start = NodeMutation.adapter.get_start(@node)
-    @end = NodeMutation.adapter.get_end(@node)
-  end
-end