synvert-core 0.58.2 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5580dae81209573a74a22792f5f50f329805eb67d74c67d28beb9438115a6ba
-  data.tar.gz: 3e97957ff1b4af95a5506ff240c0e500ccf69242d4c03a5db16c84ae03917520
+  metadata.gz: ff83abb1009ca5d9fe97a1c2e64701c31942a1c235e2b5a9bfe6cec1875f0956
+  data.tar.gz: b983862aa7a7861801104d43dc19cd794a5b83e4c2be5b137888b2e92a6f8068
 SHA512:
-  metadata.gz: 6829aded4d70daf81fa7cab074c7029ee945997434d357cc251cd993ba89ec56bb1b74b4d98964a150cad0d8f3fbb0f9781f31c5eab760b3c5ba392dffac17f1
-  data.tar.gz: 57d35f30118d60e234595d66b65580f29b205e7f09115ce3b44c1085d6845ff02c831855e2cd7267983b9e7a87a1480080f28a4cb533a0520b944e445bccd15b
+  metadata.gz: 6978c684ad91c8a59c9774129c5ab21162b66f4f3b4eb043337a008c2dd5a5df3634b7781442d03147ae8829b250bd73f279b31379f6b3861e852da75209ba26
+  data.tar.gz: 96299eb5b9b6254a3781abaff6e3d9f2ac6e1da8e1216b17990471558408bf6ceecb439175183819f3aadd860de94754639c4434705910469318e91abd57f124

data/CHANGELOG.md

@@ -1,8 +1,21 @@
 # CHANGELOG
 
-## 0.58.2 (2021-10-23)
+## 0.61.0 (2021-12-10)
 
-* Do not break the whole `recursive_children`
+* Add `Node#child_node_by_name`
+* Fix `Node#child_node_range` for array
+
+## 0.60.0 (2021-12-02)
+
+* Add `to_string` to `sym` node
+
+## 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)
 

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.
@@ -336,6 +343,43 @@ module Parser::AST
       loc.expression.line
     end
 
+    # Get child node by child name.
+    #
+    # @param [String] name of child node.
+    # @return [Parser::AST::Node] the child node.
+    def child_node_by_name(child_name)
+      direct_child_name, nested_child_name = child_name.to_s.split('.', 2)
+      if respond_to?(direct_child_name)
+        child_node = send(direct_child_name)
+
+        if nested_child_name
+          if child_node.is_a?(Array)
+            child_direct_child_name, child_nested_child_name = nested_child_name.split('.', 2)
+            child_direct_child_node = child_direct_child_name =~ /\A\d+\z/ ? child_node[child_direct_child_name.to_i - 1] : child_node.send(child_direct_child_name)
+            return child_direct_child_node.child_node_by_name(child_nested_child_name) if child_nested_child_name
+            return child_direct_child_node if child_direct_child_node
+
+            raise Synvert::Core::MethodNotSupported,
+                  "child_node_by_name is not handled for #{debug_info}, child_name: #{child_name}"
+          end
+
+          return child_node.child_node_by_name(nested_child_name)
+        end
+
+        return nil if child_node.nil?
+
+        return child_node if child_node.is_a?(Parser::AST::Node)
+
+        # arguments
+        return nil if child_node.empty?
+
+        return child_node
+      end
+
+      raise Synvert::Core::MethodNotSupported,
+            "child_node_by_name is not handled for #{debug_info}, child_name: #{child_name}"
+    end
+
     # Get the source range of child node.
     #
     # @param [String] name of child node.
@@ -375,10 +419,10 @@ module Parser::AST
 
           if nested_child_name
             if child_node.is_a?(Array)
-              child_direct_child_name, *child_nested_child_name = nested_child_name
-              child_direct_child_node = child_direct_child_name =~ /\A\d+\z/ ? child_node[child_direct_child_name] : child_node.send(child_direct_child_name)
-              if child_nested_child_name.length > 0
-                return child_direct_child_node.child_node_range(child_nested_child_name.join('.'))
+              child_direct_child_name, child_nested_child_name = nested_child_name.split('.', 2)
+              child_direct_child_node = child_direct_child_name =~ /\A\d+\z/ ? child_node[child_direct_child_name.to_i - 1] : child_node.send(child_direct_child_name)
+              if child_nested_child_name
+                return child_direct_child_node.child_node_range(child_nested_child_name)
               elsif child_direct_child_node
                 return (
                   Parser::Source::Range.new(
@@ -479,8 +523,8 @@ module Parser::AST
     def rewritten_source(code)
       code.gsub(/{{(.*?)}}/m) do
         old_code = Regexp.last_match(1)
-        if respond_to? old_code.split(/\.|\[/).first
-          evaluated = instance_eval old_code
+        if respond_to?(old_code.split('.').first)
+          evaluated = child_node_by_name(old_code)
           case evaluated
           when Parser::AST::Node
             if evaluated.type == :args
@@ -545,6 +589,13 @@ module Parser::AST
       ":#{to_value}"
     end
 
+    # convert symbol to string
+    def to_string
+      return to_source unless type == :sym
+
+      "#{to_value}"
+    end
+
     # convert lambda {} to -> {}
     def to_lambda_literal
       if type == :block && caller.type == :send && caller.receiver.nil? && caller.message == :lambda

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,10 +162,10 @@ 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 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, options = nil, &block)
-      options ||= { recursive: true }
+      options ||= { stop_when_match: false }
       Rewriter::WithinScope.new(self, rules, options, &block).process
     end
 

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

@@ -26,10 +26,10 @@ module Synvert::Core
       matching_nodes =
         if @options[:direct]
           find_direct_matching_nodes(current_node)
-        elsif @options[:recursive]
-          find_recursive_matching_nodes(current_node)
-        else
+        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|
@@ -89,12 +89,10 @@ module Synvert::Core
           return matching_nodes
         end
         current_node.recursive_children do |child_node|
-          stop = nil
           if child_node.match?(@rules)
             matching_nodes << child_node
-            stop = :stop
+            next :stop
           end
-          stop
         end
       else
         current_node.each do |node|
@@ -103,12 +101,10 @@ module Synvert::Core
             next
           end
           node.recursive_children do |child_node|
-            stop = nil
             if child_node.match?(@rules)
               matching_nodes << child_node
-              stop = :stop
+              next :stop
             end
-            stop
           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.58.2'
+    VERSION = '0.61.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]'
@@ -546,6 +554,54 @@ describe Parser::AST::Node do
     end
   end
 
+  describe '#child_node_by_name' do
+    context 'block node' do
+      it 'checks caller' do
+        node = parse('Factory.define :user do |user|; end')
+        child_node = node.child_node_by_name(:caller)
+        expect(child_node).to eq node.caller
+      end
+
+      it 'checks arguments' do
+        node = parse('Factory.define :user do |user|; end')
+        child_node = node.child_node_by_name(:arguments)
+        expect(child_node).to eq node.arguments
+      end
+
+      it 'checks caller.receiver' do
+        node = parse('Factory.define :user do |user|; end')
+        child_node = node.child_node_by_name('caller.receiver')
+        expect(child_node).to eq node.caller.receiver
+      end
+
+      it 'checks caller.message' do
+        node = parse('Factory.define :user do |user|; end')
+        child_node = node.child_node_by_name('caller.message')
+        expect(child_node).to eq node.caller.message
+      end
+    end
+
+    context 'array' do
+      it 'checks array by index' do
+        node = parse('factory :admin, class: User do; end')
+        child_node = node.child_node_by_name('caller.arguments.2')
+        expect(child_node).to eq node.caller.arguments[1]
+      end
+
+      it 'checks array by method' do
+        node = parse('factory :admin, class: User do; end')
+        child_node = node.child_node_by_name('caller.arguments.second')
+        expect(child_node).to eq node.caller.arguments[1]
+      end
+
+      it "checks array' value" do
+        node = parse('factory :admin, class: User do; end')
+        child_node = node.child_node_by_name('caller.arguments.second.class_value')
+        expect(child_node).to eq node.caller.arguments[1].class_value
+      end
+    end
+  end
+
   describe '#child_node_range' do
     context 'block node' do
       it 'checks caller' do
@@ -712,6 +768,26 @@ describe Parser::AST::Node do
         expect(range).to be_nil
       end
     end
+
+    context 'array' do
+      it 'checks array by index' do
+        node = parse('factory :admin, class: User do; end')
+        range = node.child_node_range('caller.arguments.2')
+        expect(range.to_range).to eq(16...27)
+      end
+
+      it 'checks array by method' do
+        node = parse('factory :admin, class: User do; end')
+        range = node.child_node_range('caller.arguments.second')
+        expect(range.to_range).to eq(16...27)
+      end
+
+      it "checks array' value" do
+        node = parse('factory :admin, class: User do; end')
+        range = node.child_node_range('caller.arguments.second.class_value')
+        expect(range.to_range).to eq(23...27)
+      end
+    end
   end
 
   describe '#rewritten_source' do
@@ -819,6 +895,22 @@ describe Parser::AST::Node do
     end
   end
 
+  describe '#to_string' do
+    context 'sym node' do
+      it 'converts symbol to string' do
+        node = parse(':foobar')
+        expect(node.to_string).to eq 'foobar'
+      end
+    end
+
+    context 'other node' do
+      it 'does nothing' do
+        node = parse("'foobar'")
+        expect(node.to_string).to eq "'foobar'"
+      end
+    end
+  end
+
   describe '#to_lambda_literal' do
     context 'lambda node' do
       it 'converts to lambda literal without arguments' do

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,7 +25,7 @@ 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)
@@ -35,10 +35,10 @@ 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' }, { stop_when_match: true }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
-      instance.within_node({ type: 'send', message: 'create' }, { recursive: false }, &block)
+      instance.within_node({ type: 'send', message: 'create' }, { stop_when_match: true }, &block)
     end
 
     it 'parses within_direct_node' do
@@ -185,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
@@ -212,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'
@@ -237,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'
@@ -263,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
@@ -299,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 []
@@ -310,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

@@ -54,7 +54,7 @@ module Synvert::Core
 
       it 'matches multiple block nodes' do
         block_nodes = []
-        scope = Rewriter::WithinScope.new(instance, { type: 'block' }, { recursive: true }) do
+        scope = Rewriter::WithinScope.new(instance, { type: 'block' }, { stop_when_match: false }) do
           block_nodes << node
         end
         scope.process
@@ -63,7 +63,7 @@ module Synvert::Core
 
       it 'matches only one block node if no recursive' do
         block_nodes = []
-        scope = Rewriter::WithinScope.new(instance, { type: 'block' } , { recursive: false }) do
+        scope = Rewriter::WithinScope.new(instance, { type: 'block' } , { stop_when_match: true }) do
           block_nodes << node
         end
         scope.process

metadata

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