synvert-core 0.57.1 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d308267b7dc3f8561869a44ab25b6ffb329f4dfbc04ae66e960de167faa1ee4a
-  data.tar.gz: c6863adae12f49e7d8c0eb79c336f11b5dfaead8b7679a32c32a2131a0cd2ccf
+  metadata.gz: '093f0af943a24314d55691d222fb181ab0526c4e1e8c557a38824609773a17a4'
+  data.tar.gz: 96b272edcb8ed63b346bfc30c76210aee11e7cab618045b0fed27107edbe5bfd
 SHA512:
-  metadata.gz: ce3db59d4d4d047c4abafbe3130252615bf601fc980c601d93552777105c646eb76174e04ae5e7af16004570f4d091c7549c40c5b5b0e803ab8eb916607ae34a
-  data.tar.gz: 2095af835a69d267a8d78112752aa553c002cb0699f3ca082b2ef0600e95b772eba9aae76cbd863ae3e8d7a7101c92942e03ae89e34d0c3abd6a636a5b65ac29
+  metadata.gz: 6cd336f74ddcbd5342811670824cf0f821c693a3b331f82dfb1f756f7deed41ae2f6d32cbba208a138f96a240476182c674adb2a5ab4940acda70e7737024f09
+  data.tar.gz: 6e9f09306f30fbde3dc552df33d09e2bc1e0651dcda418640cbcdc648704e427e670b4d910ffdd7039f48262c7d4cd62197e18dd111f512d1591c31643746580

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # CHANGELOG
 
-## 0.57.1 (2021-10-18)
+## 0.59.0 (2021-11-17)
+
+* Use option `stop_when_match` instead of `recursive`
+* Add file pattern constants
+* Instance supports array of file patterns
+* Return block value by `next`
+* Add `Node#filename` method
+
+## 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)
 

data/lib/synvert/core/node_ext.rb

@@ -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

@@ -72,13 +72,13 @@ module Synvert::Core
     # Initialize an instance.
     #
     # @param rewriter [Synvert::Core::Rewriter]
-    # @param file_pattern [String] pattern to find files, e.g. spec/**/*_spec.rb
+    # @param file_patterns [Array<String>] pattern list to find files, e.g. ['spec/**/*_spec.rb']
     # @param block [Block] block code to find nodes, match conditions and rewrite code.
     # @return [Synvert::Core::Rewriter::Instance]
-    def initialize(rewriter, file_pattern, &block)
+    def initialize(rewriter, file_patterns, &block)
       @rewriter = rewriter
       @actions = []
-      @file_pattern = file_pattern
+      @file_patterns = file_patterns
       @block = block
       rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
@@ -87,41 +87,42 @@ module Synvert::Core
     # It finds all files, for each file, it executes the block code, gets all rewrite actions,
     # and rewrite source code back to original file.
     def process
-      file_pattern = File.join(Configuration.path, @file_pattern)
-      Dir.glob(file_pattern).each do |file_path|
-        next if Configuration.skip_files.include? file_path
-
-        begin
-          puts file_path if Configuration.show_run_process
-          conflict_actions = []
-          source = +self.class.file_source(file_path)
-          ast = self.class.file_ast(file_path)
-
-          @current_file = file_path
-
-          process_with_node ast do
-            begin
-              instance_eval(&@block)
-            rescue NoMethodError
-              puts @current_node.debug_info
-              raise
-            end
-          end
+      @file_patterns.each do |file_pattern|
+        Dir.glob(File.join(Configuration.path, file_pattern)).each do |file_path|
+          next if Configuration.skip_files.include? file_path
 
-          if @actions.length > 0
-            @actions.sort_by! { |action| [action.begin_pos, action.end_pos] }
-            conflict_actions = get_conflict_actions
-            @actions.reverse_each do |action|
-              source[action.begin_pos...action.end_pos] = action.rewritten_code
+          begin
+            puts file_path if Configuration.show_run_process
+            conflict_actions = []
+            source = +self.class.file_source(file_path)
+            ast = self.class.file_ast(file_path)
+
+            @current_file = file_path
+
+            process_with_node ast do
+              begin
+                instance_eval(&@block)
+              rescue NoMethodError
+                puts @current_node.debug_info
+                raise
+              end
             end
-            @actions = []
 
-            update_file(file_path, source)
-          end
-        rescue Parser::SyntaxError
-          puts "[Warn] file #{file_path} was not parsed correctly."
-          # do nothing, iterate next file
-        end while !conflict_actions.empty?
+            if @actions.length > 0
+              @actions.sort_by! { |action| [action.begin_pos, action.end_pos] }
+              conflict_actions = get_conflict_actions
+              @actions.reverse_each do |action|
+                source[action.begin_pos...action.end_pos] = action.rewritten_code
+              end
+              @actions = []
+
+              update_file(file_path, source)
+            end
+          rescue Parser::SyntaxError
+            puts "[Warn] file #{file_path} was not parsed correctly."
+            # do nothing, iterate next file
+          end while !conflict_actions.empty?
+        end
       end
     end
 
@@ -161,9 +162,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 stop_when_match 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 ||= { stop_when_match: false }
+      Rewriter::WithinScope.new(self, rules, options, &block).process
     end
 
     alias with_node within_node
@@ -174,7 +177,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[:stop_when_match]
+          find_matching_nodes(current_node)
+        else
+          find_recursive_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/rewriter.rb

@@ -231,13 +231,13 @@ module Synvert::Core
     # Parse within_files dsl, it finds specified files.
     # It creates a [Synvert::Core::Rewriter::Instance] to rewrite code.
     #
-    # @param file_pattern [String] pattern to find files, e.g. spec/**/*_spec.rb
+    # @param file_patterns [String|Array<String>] string pattern or list of string pattern to find files, e.g. ['spec/**/*_spec.rb']
     # @param block [Block] the block to rewrite code in the matching files.
-    def within_files(file_pattern, &block)
+    def within_files(file_patterns, &block)
       return if @sandbox
 
       if (!@ruby_version || @ruby_version.match?) && (!@gem_spec || @gem_spec.match?)
-        Rewriter::Instance.new(self, file_pattern, &block).process
+        Rewriter::Instance.new(self, Array(file_patterns), &block).process
       end
     end
 

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.57.1'
+    VERSION = '0.59.0'
   end
 end

data/lib/synvert/core.rb

@@ -24,4 +24,35 @@ end
 
 module Synvert
   Rewriter = Core::Rewriter
+
+  ALL_RUBY_FILES = %w[**/*.rb]
+  ALL_RAKE_FILES = %w[**/*.rake]
+
+  RAILS_APP_FILES = %w[app/**/*.rb engines/*/app/**/*.rb]
+  RAILS_CONTROLLER_FILES = %w[app/controllers/**/*.rb engines/*/app/controllers/**/*.rb]
+  RAILS_JOB_FILES = %w[app/jobs/**/*.rb engines/*/app/jobs/**/*.rb]
+  RAILS_OBSERVER_FILES = %w[app/observers/**/*.rb engines/*/app/observers/**/*.rb]
+  RAILS_HELPER_FILES = %w[app/helpers/**/*.rb]
+  RAILS_LIB_FILES = %w[lib/**/*.rb engines/*/lib/**/*.rb]
+  RAILS_MAILER_FILES = %w[app/mailers/**/*.rb engines/*/app/mailers/**/*.rb]
+  RAILS_MIGRATION_FILES = %w[db/migrate/**/*.rb engines/*/db/migrate/**/*.rb]
+  RAILS_MODEL_FILES = %w[app/models/**/*.rb engines/*/app/models/**/*.rb]
+  RAILS_ROUTE_FILES = %w[config/routes.rb config/routes/**/*.rb engines/*/config/routes.rb engines/*/config/routes/**/*.rb]
+  RAILS_VIEW_FILES = %w[app/views/**/*.html.{erb,haml,slim}]
+
+  RAILS_CONTROLLER_TEST_FILES = %w[
+    test/functional/**/*.rb test/controllers/**/*.rb engines/*/test/functional/**/*.rb engines/*/test/controllers/**/*.rb
+    spec/functional/**/*.rb spec/controllers/**/*.rb engines/*/spec/functional/**/*.rb engines/*/spec/controllers/**/*.rb
+  ]
+  RAILS_INTEGRATION_TEST_FILES = %w[test/integration/**/*.rb spec/integration/**/*.rb]
+  RAILS_MODEL_TEST_FILES = %w[
+    test/unit/**/*.rb engines/*/test/unit/**/*.rb test/models/**/*.rb engines/*/test/models/**/*.rb
+    spec/models/**/*.rb engines/*/spec/models/**/*.rb
+  ]
+
+  RAILS_FACTORY_FILES = %w[test/factories/**/*.rb spec/factories/**/*.rb]
+  RAILS_RSPEC_FILES = %w[spec/**/*.rb engines/*/spec/**/*.rb]
+  RAILS_MINITEST_FILES = %w[test/**/*.rb engines/*/test/**/*.rb]
+  RAILS_CUCUMBER_FILES = %w[features/**/*.rb]
+  RAILS_TEST_FILES = RAILS_MINITEST_FILES + RAILS_RSPEC_FILES + RAILS_CUCUMBER_FILES
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -396,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

@@ -8,14 +8,14 @@ module Synvert::Core
 
     let(:instance) {
       rewriter = Rewriter.new('foo', 'bar')
-      Rewriter::Instance.new(rewriter, 'file pattern')
+      Rewriter::Instance.new(rewriter, ['file pattern'])
     }
 
     it 'parses within_node' do
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { recursive: true }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.within_node(type: 'send', message: 'create', &block)
@@ -25,17 +25,27 @@ module Synvert::Core
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { recursive: true }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.with_node(type: 'send', message: 'create', &block)
     end
 
+    it 'parses within_node with recursive false' do
+      scope = double
+      block = proc {}
+      expect(Rewriter::WithinScope).to receive(:new)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: true }, &block)
+        .and_return(scope)
+      expect(scope).to receive(:process)
+      instance.within_node({ type: 'send', message: 'create' }, { stop_when_match: true }, &block)
+    end
+
     it 'parses within_direct_node' do
       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.within_direct_node(type: 'send', message: 'create', &block)
@@ -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)
@@ -175,7 +185,7 @@ module Synvert::Core
 
       it 'writes new code to file' do
         instance =
-          Rewriter::Instance.new rewriter, 'spec/**/*_spec.rb' do
+          Rewriter::Instance.new rewriter, ['spec/**/*_spec.rb'] do
             with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
               replace_with 'create {{arguments}}'
             end
@@ -202,7 +212,7 @@ module Synvert::Core
 
       it 'does not write if file content is not changed' do
         instance =
-          Rewriter::Instance.new rewriter, 'spec/spec_helper.rb' do
+          Rewriter::Instance.new rewriter, ['spec/spec_helper.rb'] do
             with_node type: 'block', caller: { receiver: 'RSpec', message: 'configure' } do
               unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
                 insert '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
@@ -227,7 +237,7 @@ module Synvert::Core
 
       it 'does not read file if already read' do
         instance =
-          Rewriter::Instance.new rewriter, 'spec/spec_helper.rb' do
+          Rewriter::Instance.new rewriter, ['spec/spec_helper.rb'] do
             with_node type: 'block', caller: { receiver: 'RSpec', message: 'configure' } do
               unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
                 insert '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
@@ -253,7 +263,7 @@ module Synvert::Core
 
       it 'updates file_source and file_ast when writing a file' do
         instance =
-          Rewriter::Instance.new rewriter, 'spec/**/*_spec.rb' do
+          Rewriter::Instance.new rewriter, ['spec/**/*_spec.rb'] do
             with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
               replace_with 'create {{arguments}}'
             end
@@ -289,7 +299,7 @@ module Synvert::Core
         action1 = double(begin_pos: 10, end_pos: 20)
         action2 = double(begin_pos: 30, end_pos: 40)
         action3 = double(begin_pos: 50, end_pos: 60)
-        instance = Rewriter::Instance.new rewriter, 'spec/spec_helper.rb'
+        instance = Rewriter::Instance.new rewriter, ['spec/spec_helper.rb']
         instance.instance_variable_set :@actions, [action1, action2, action3]
         conflict_actions = instance.send(:get_conflict_actions)
         expect(conflict_actions).to eq []
@@ -300,7 +310,7 @@ module Synvert::Core
         action1 = double(begin_pos: 30, end_pos: 40)
         action2 = double(begin_pos: 50, end_pos: 60)
         action3 = double(begin_pos: 10, end_pos: 20)
-        instance = Rewriter::Instance.new rewriter, 'spec/spec_helper.rb'
+        instance = Rewriter::Instance.new rewriter, ['spec/spec_helper.rb']
         instance.instance_variable_set :@actions, [action1, action2, action3]
         conflict_actions = instance.send(:get_conflict_actions)
         expect(conflict_actions).to eq [action2, action1]

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' }, { stop_when_match: false }) 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' } , { stop_when_match: true }) 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.1
+  version: 0.59.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport