node_mutation 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e468a837b5ab1417a0675f92ae5848b87b66cfe9605a3ce56142f58859ba7036
-  data.tar.gz: 898a9e080a406c84027b3ea84bf76826c8deb2ea36c406a767774c7610809dea
+  metadata.gz: 36b238099da8793f4d2e9df6c5e679ba4d4f7da2254c020606d73dfd93f3baf8
+  data.tar.gz: b44fbf6192513de334c03580a04b8fe30602697a2d8f7fc39a96f5776c046739
 SHA512:
-  metadata.gz: 40498dd85e42e77268ed72851692c906221e2ea167765867155a30c0e992b6e4a8c4e89cfee7295743dd94f6d3405dcaeabeb845be3a3dc1a7cb473983ba6bf2
-  data.tar.gz: f99ba22c58428b002285e9dd6e959b993725216265457d2df8a4b7fd934537861ca04ce6955bedc8dea0fb29efb0174e44a53a7ae6e07c9aad2e68daa2dab154
+  metadata.gz: cbfb8d677df7896754afddf23e3fa880f6d6f16d646c9a93881b4e216c1a2adf83c4ba45a96dd4827aeb9800ea375ba5dd992a815bf2794e1b5d11206b956415
+  data.tar.gz: 3a0c2217d7b51a90bd2818a036e07b76f2e2df82295f5bed462e075198855325285513e344d97cc70ac0179b1fa6a77ca13f25558f12f0db982903cc52a65318

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # NodeMutation
 
+## 1.9.0 (2023-02-08)
+
+* Configure `tab_width`
+* Make use of `NodeMutation.tab_width`
+
+## 1.8.2 (2023-01-17)
+
+* Drop `activesupport`
+
 ## 1.8.1 (2022-12-26)
 
 * `child_node_by_name` index starts from `0`

data/Gemfile.lock

@@ -1,22 +1,14 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.8.1)
-      activesupport (< 7.0.0)
+    node_mutation (1.9.0)
       erubis
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     erubis (2.7.0)
     ffi (1.15.5)
@@ -35,14 +27,11 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.16.3)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -73,9 +62,6 @@ GEM
     rspec-support (3.11.0)
     shellany (0.0.1)
     thor (1.2.1)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.6.6)
 
 PLATFORMS
   x86_64-darwin-21

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.1"
+  VERSION = "1.9.0"
 end

data/lib/node_mutation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'ostruct'
-require 'active_support/core_ext/array'
 
 require_relative "node_mutation/version"
 
@@ -26,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/node_mutation.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activesupport", "< 7.0.0"
   spec.add_dependency "erubis"
 
   # For more information and examples about making a new gem, check out our

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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: ast node mutation apis