node_mutation 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be47289a83fa7295154056c8c6adc404f4f190d580a47dc78660dcfd082917d1
-  data.tar.gz: 15f40478c899eb9b4e8fd809edc4ebec139f8d85a98bd7573103fee2b62ebde6
+  metadata.gz: 36b238099da8793f4d2e9df6c5e679ba4d4f7da2254c020606d73dfd93f3baf8
+  data.tar.gz: b44fbf6192513de334c03580a04b8fe30602697a2d8f7fc39a96f5776c046739
 SHA512:
-  metadata.gz: 25e98cb3610598d9a30de2f880c071a04020c4507c8700826aa047f48179b340ad0e8e258f2301738717c5a7dd809ed9b78d75f0f1b3f9b3f243371c3d132fa5
-  data.tar.gz: 0e615252351fa511f0e1be269c74fdd77bf1477ec97745bb5cfb747a9657356cdedde24357001fcfd4b879cb47b5daf603e7e3af0c82716156de1e531c68f2a3
+  metadata.gz: cbfb8d677df7896754afddf23e3fa880f6d6f16d646c9a93881b4e216c1a2adf83c4ba45a96dd4827aeb9800ea375ba5dd992a815bf2794e1b5d11206b956415
+  data.tar.gz: 3a0c2217d7b51a90bd2818a036e07b76f2e2df82295f5bed462e075198855325285513e344d97cc70ac0179b1fa6a77ca13f25558f12f0db982903cc52a65318

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # NodeMutation
 
+## 1.9.0 (2023-02-08)
+
+* Configure `tab_width`
+* Make use of `NodeMutation.tab_width`
+
 ## 1.8.2 (2023-01-17)
 
 * Drop `activesupport`

data/Gemfile.lock

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

data/README.md

@@ -63,14 +63,34 @@ result.conflicted
 result.new_source
 ```
 
-## Write Adapter
+## Configuration
+
+### adapter
 
 Different parsers, like parse and ripper, will generate different AST nodes, to make NodeMutation work for them all,
 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.
 
-```typescript
-NodeMutation.configure({ adapter: ParserAdapter.new })
+```ruby
+NodeMutation.configure(adapter: ParserAdapter.new) // default is ParserAdapter
+```
+
+### strategy
+
+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
+```
+
+### tab_width
+
+```ruby
+NodeMutation.configure(tab_width: 4); // default is 2
 ```
 
 ## Development

data/lib/node_mutation/action/append_action.rb

@@ -17,6 +17,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 + DEFAULT_INDENT)
+    ' ' *  (NodeMutation.adapter.get_start_loc(node).column + NodeMutation.tab_width)
   end
 end

data/lib/node_mutation/action/prepend_action.rb

@@ -20,6 +20,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 + DEFAULT_INDENT)
+    ' ' * (NodeMutation.adapter.get_start_loc(node).column + NodeMutation.tab_width)
   end
 end

data/lib/node_mutation/action.rb

@@ -2,8 +2,6 @@
 
 # Action defines rewriter action, insert, replace or delete code.
 class NodeMutation::Action
-  DEFAULT_INDENT = 2
-
   # @!attribute [r] start
   #   @return [Integer] start position
   # @!attribute [r] end

data/lib/node_mutation/version.rb

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

data/lib/node_mutation.rb

@@ -25,29 +25,42 @@ class NodeMutation
 
   attr_reader :actions
 
-  # Configure NodeMutation
-  # @param [Hash] options options to configure
-  # @option options [NodeMutation::Adapter] :adapter the adpater
-  def self.configure(options)
-    if options[:adapter]
-      @adapter = options[:adapter]
+  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
+      if options[:tab_width]
+        @tab_width = options[:tab_width]
+      end
     end
-    if options[:strategy]
-      @strategy = options[:strategy]
+
+    # Get the adapter
+    # @return [NodeMutation::Adapter] current adapter, by default is {NodeMutation::ParserAdapter}
+    def adapter
+      @adapter ||= ParserAdapter.new
     end
-  end
 
-  # Get the adapter
-  # @return [NodeMutation::Adapter] current adapter, by default is {NodeMutation::ParserAdapter}
-  def self.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}
+    def strategy
+      @strategy ||= Strategy::KEEP_RUNNING
+    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}
-  def self.strategy
-    @strategy ||= Strategy::KEEP_RUNNING
+    # Get tab width
+    # @return [Integer] tab width, by default is 2
+    def tab_width
+      @tab_width ||= 2
+    end
   end
 
   # Initialize a NodeMutation.

data/sig/node_mutation.rbs

@@ -13,12 +13,14 @@ module NodeMutation[T]
 
   attr_reader actions: Array[NodeMutation::Action]
 
-  def self.configure: (options: { adapter: NodeMutation::Adapter, strategy: Integer }) -> void
+  def self.configure: (options: { adapter: NodeMutation::Adapter, strategy: Integer, tab_width: Integer }) -> void
 
   def self.adapter: () -> NodeMutation::Adapter
 
   def self.strategy: () -> Integer
 
+  def self.tab_width: () -> Integer
+
   def initialize: (source: String) -> 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.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis