synvert-core 0.57.0 → 0.58.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01935a8e5222f3058d6bcca0057cbe684ce0a43dabeaeac97dac0aa17c230b79'
-  data.tar.gz: 427851e9745c4c960b1f437c397e9332ebf6a8df4126c58652927c9810db7d05
+  metadata.gz: 1c6266f727e24e5cd93cc1db656d84dc177dc0fceb0ab435a14164216d6dec80
+  data.tar.gz: 53e06769f132ac67ee113af6fecdb327184adc034b00aa58c0af8eab376ef45f
 SHA512:
-  metadata.gz: 50a73df1cb5034afeb269776f5e4bf76873b236e490fa54e6bffd91dabfb2726260b99bca95230022314be890454645b8c032c4006c22271a7a460c50b77e3dc
-  data.tar.gz: c7ca6e209b229a3951b6846173268d254034e3ff9480e47add2e7649326ab004d806f09ec784fdf86154c8414c7e9e947e6ea72e6fbc5c2d65018f1909928e18
+  metadata.gz: fb0db8ed1e6636145f25ec8ca3cc3653ce415e7381c8e5d2126e7da7174782c57a2a4d60a3693794ae93ac02bd178b40f55971ffbf721e0d86b7c73fd17b930a
+  data.tar.gz: ee6222b098f64dcc809d0d54ed9c1bad84f54816e05602b601c7ae8b0211f26fb41c05e46fe9728dc362536971021cc2a6e232a5e9f8ac34eff3f6ef55e94cb3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 0.58.3 (2021-11-16)
+
+* Return block value by `next`
+* Add `Node#filename` method
+
+## 0.58.2 (2021-10-23)
+
+* Do not break the whole `recursive_children`
+
+## 0.58.0 (2021-10-23)
+
+* Support `left_value` and `right_value` for `and` and `or` node
+* Rewrite `within_node` and `within_direct_node`, `WithinScope` accepts `recursive` and `direct` options
+
 ## 0.57.0 (2021-10-02)
 
 * Compare ruby version in `.ruby-version` or `.rvmrc`

data/lib/synvert/core/node_ext.rb

@@ -215,7 +215,7 @@ module Parser::AST
     # @return [Parser::AST::Node] variable nodes.
     # @raise [Synvert::Core::MethodNotSupported] if calls on other node.
     def left_value
-      if %i[masgn lvasgn ivasgn cvasgn].include? type
+      if %i[masgn lvasgn ivasgn cvasgn and or].include? type
         children[0]
       elsif :or_asgn == type
         children[0].children[0]
@@ -229,7 +229,7 @@ module Parser::AST
     # @return [Array<Parser::AST::Node>] variable nodes.
     # @raise [Synvert::Core::MethodNotSupported] if calls on other node.
     def right_value
-      if %i[masgn lvasgn ivasgn cvasgn or_asgn].include? type
+      if %i[masgn lvasgn ivasgn cvasgn or_asgn and or].include? type
         children[1]
       else
         raise Synvert::Core::MethodNotSupported, "right_value is not handled for #{debug_info}"
@@ -315,6 +315,13 @@ module Parser::AST
         ].join("\n")
     end
 
+    # Get the file name of the current node.
+    #
+    # @return [String] file name.
+    def filename
+      loc.expression&.source_buffer.name
+    end
+
     # Get the source code of current node.
     #
     # @return [String] source code.
@@ -432,8 +439,8 @@ module Parser::AST
     def recursive_children(&block)
       children.each do |child|
         if child.is_a?(Parser::AST::Node)
-          yield child
-          child.recursive_children(&block)
+          stop = yield child
+          child.recursive_children(&block) unless stop == :stop
         end
       end
     end

data/lib/synvert/core/rewriter/action.rb

@@ -55,7 +55,7 @@ module Synvert::Core
 
     def squeeze_spaces
       if file_source[@begin_pos - 1] == ' ' && file_source[@end_pos] == ' '
-        @begin_pos = @begin_pos - 1
+        @begin_pos -= 1
       end
     end
 
@@ -67,19 +67,19 @@ module Synvert::Core
       after_line_is_blank = lines[end_line] == ''
 
       if lines.length > 1 && before_line_is_blank && after_line_is_blank
-        @end_pos = @end_pos + "\n".length
+        @end_pos += "\n".length
       end
     end
 
     def remove_comma
       if ',' == file_source[@begin_pos - 1]
-        @begin_pos = @begin_pos - 1
+        @begin_pos -= 1
       elsif ', ' == file_source[@begin_pos - 2, 2]
-        @begin_pos = @begin_pos - 2
+        @begin_pos -= 2
       elsif ', ' == file_source[@end_pos, 2]
-        @end_pos = @end_pos + 2
+        @end_pos += 2
       elsif ',' == file_source[@end_pos]
-        @end_pos = @end_pos + 1
+        @end_pos += 1
       end
     end
 

data/lib/synvert/core/rewriter/instance.rb

@@ -161,9 +161,11 @@ module Synvert::Core
     # then continue operating on each matching ast node.
     #
     # @param rules [Hash] rules to find mathing ast nodes.
+    # @param options [Hash] optional, set if recursive or not.
     # @param block [Block] block code to continue operating on the matching nodes.
-    def within_node(rules, &block)
-      Rewriter::WithinScope.new(self, rules, { recursive: true }, &block).process
+    def within_node(rules, options = nil, &block)
+      options ||= { recursive: true }
+      Rewriter::WithinScope.new(self, rules, options, &block).process
     end
 
     alias with_node within_node
@@ -174,7 +176,7 @@ module Synvert::Core
     # @param rules [Hash] rules to find mathing ast nodes.
     # @param block [Block] block code to continue operating on the matching nodes.
     def within_direct_node(rules, &block)
-      Rewriter::WithinScope.new(self, rules, { recursive: false }, &block).process
+      Rewriter::WithinScope.new(self, rules, { direct: true }, &block).process
     end
 
     alias with_direct_node within_direct_node

data/lib/synvert/core/rewriter/ruby_version.rb

@@ -21,7 +21,7 @@ module Synvert::Core
       elsif File.exist?(File.join(Configuration.path, '.rvmrc'))
         versionFile = '.rvmrc'
       end
-      return true if !versionFile
+      return true unless versionFile
 
       version = File.read(File.join(Configuration.path, versionFile))
       Gem::Version.new(version) >= Gem::Version.new(@version)

data/lib/synvert/core/rewriter/scope/within_scope.rb

@@ -9,7 +9,7 @@ module Synvert::Core
     # @param rules [Hash]
     # @param options [Hash]
     # @param block [Block]
-    def initialize(instance, rules, options = { recursive: true }, &block)
+    def initialize(instance, rules, options = {}, &block)
       @instance = instance
       @rules = rules
       @options = options
@@ -23,7 +23,14 @@ module Synvert::Core
       current_node = @instance.current_node
       return unless current_node
 
-      matching_nodes = find_matching_nodes(current_node)
+      matching_nodes =
+        if @options[:direct]
+          find_direct_matching_nodes(current_node)
+        elsif @options[:recursive]
+          find_recursive_matching_nodes(current_node)
+        else
+          find_matching_nodes(current_node)
+        end
       @instance.process_with_node current_node do
         matching_nodes.each do |matching_node|
           @instance.process_with_node matching_node do
@@ -35,36 +42,73 @@ module Synvert::Core
 
     private
 
-    def find_matching_nodes(current_node)
+    # Find the matching nodes only in current or direct children.
+    def find_direct_matching_nodes(current_node)
       matching_nodes = []
-      if @options[:recursive]
-        if current_node.is_a?(Parser::AST::Node)
-          matching_nodes << current_node if current_node.match? @rules
-          current_node.recursive_children do |child_node|
-            matching_nodes << child_node if child_node.match? @rules
-          end
-        else
-          current_node.each do |node|
-            matching_nodes << node if node.match? @rules
-            node.recursive_children do |child_node|
-              matching_nodes << child_node if child_node.match? @rules
-            end
-          end
-        end
-      elsif current_node.is_a?(Parser::AST::Node)
+      if current_node.is_a?(Parser::AST::Node)
         if current_node.type == :begin
           current_node.children.each do |child_node|
-            matching_nodes << child_node if child_node.match? @rules
+            matching_nodes << child_node if child_node.match?(@rules)
           end
-        elsif current_node.match? @rules
+        elsif current_node.match?(@rules)
           matching_nodes << current_node
         end
       else
         current_node.each do |child_node|
-          matching_nodes << child_node if child_node.match? @rules
+          matching_nodes << child_node if child_node.match?(@rules)
+        end
+      end
+      matching_nodes
+    end
+
+    # Find matching nodes in all recursive children.
+    def find_recursive_matching_nodes(current_node)
+      matching_nodes = []
+      if current_node.is_a?(Parser::AST::Node)
+        matching_nodes << current_node if current_node.match?(@rules)
+        current_node.recursive_children do |child_node|
+          matching_nodes << child_node if child_node.match?(@rules)
+        end
+      else
+        current_node.each do |node|
+          matching_nodes << node if node.match?(@rules)
+          node.recursive_children do |child_node|
+            matching_nodes << child_node if child_node.match?(@rules)
+          end
+        end
+      end
+      matching_nodes
+    end
+
+    # Find matching nodes in recursive children but do not continue on matching nodes.
+    def find_matching_nodes(current_node)
+      matching_nodes = []
+      if current_node.is_a?(Parser::AST::Node)
+        if current_node.match?(@rules)
+          matching_nodes << current_node
+          return matching_nodes
+        end
+        current_node.recursive_children do |child_node|
+          if child_node.match?(@rules)
+            matching_nodes << child_node
+            next :stop
+          end
+        end
+      else
+        current_node.each do |node|
+          if node.match?(@rules)
+            matching_nodes << node
+            next
+          end
+          node.recursive_children do |child_node|
+            if child_node.match?(@rules)
+              matching_nodes << child_node
+              next :stop
+            end
+          end
         end
       end
       matching_nodes
     end
   end
-end
+end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.57.0'
+    VERSION = '0.58.3'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -291,6 +291,16 @@ describe Parser::AST::Node do
       node = parse('a ||= 1')
       expect(node.left_value).to eq :a
     end
+
+    it 'gets for and' do
+      node = parse('foo && bar')
+      expect(node.left_value).to eq parse('foo')
+    end
+
+    it 'gets for or' do
+      node = parse('foo || bar')
+      expect(node.left_value).to eq parse('foo')
+    end
   end
 
   describe '#right_value' do
@@ -323,6 +333,16 @@ describe Parser::AST::Node do
       node = parse('a ||= 1')
       expect(node.right_value).to eq parse('1')
     end
+
+    it 'gets for and' do
+      node = parse('foo && bar')
+      expect(node.right_value).to eq parse('bar')
+    end
+
+    it 'gets for or' do
+      node = parse('foo || bar')
+      expect(node.right_value).to eq parse('bar')
+    end
   end
 
   describe '#to_value' do
@@ -376,6 +396,14 @@ describe Parser::AST::Node do
     end
   end
 
+  describe '#filename' do
+    it 'gets file name' do
+      source = 'foobar'
+      node = parse(source)
+      expect(node.filename).to eq '(string)'
+    end
+  end
+
   describe '#to_source' do
     it 'gets for node' do
       source = 'params[:user][:email]'

data/spec/synvert/core/rewriter/instance_spec.rb

@@ -31,13 +31,23 @@ module Synvert::Core
       instance.with_node(type: 'send', message: 'create', &block)
     end
 
-    it 'parses within_direct_node' do
+    it 'parses within_node with recursive false' do
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
         .with(instance, { type: 'send', message: 'create' }, { recursive: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
+      instance.within_node({ type: 'send', message: 'create' }, { recursive: false }, &block)
+    end
+
+    it 'parses within_direct_node' do
+      scope = double
+      block = proc {}
+      expect(Rewriter::WithinScope).to receive(:new)
+        .with(instance, { type: 'send', message: 'create' }, { direct: true }, &block)
+        .and_return(scope)
+      expect(scope).to receive(:process)
       instance.within_direct_node(type: 'send', message: 'create', &block)
     end
 
@@ -45,7 +55,7 @@ module Synvert::Core
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { recursive: false }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { direct: true }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.with_direct_node(type: 'send', message: 'create', &block)

data/spec/synvert/core/rewriter/scope/within_scope_spec.rb

@@ -51,6 +51,33 @@ module Synvert::Core
         expect(type_in_scope).to eq :send
         expect(instance.current_node.type).to eq :block
       end
+
+      it 'matches multiple block nodes' do
+        block_nodes = []
+        scope = Rewriter::WithinScope.new(instance, { type: 'block' }, { recursive: true }) do
+          block_nodes << node
+        end
+        scope.process
+        expect(block_nodes.size).to eq 2
+      end
+
+      it 'matches only one block node if no recursive' do
+        block_nodes = []
+        scope = Rewriter::WithinScope.new(instance, { type: 'block' } , { recursive: false }) do
+          block_nodes << node
+        end
+        scope.process
+        expect(block_nodes.size).to eq 1
+      end
+
+      it 'matches only one direct node' do
+        block_nodes = []
+        scope = Rewriter::WithinScope.new(instance, { type: 'block' } , { direct: true }) do
+          block_nodes << node
+        end
+        scope.process
+        expect(block_nodes.size).to eq 1
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.58.3
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport