synvert-core 0.60.0 → 0.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e00ecd8d7f5d6ff82a17580d088cc323d0e94b53a1488e6be50cbeb4a44b13
-  data.tar.gz: 9e3f9dbb81cb07a27fdb8d0f2888d1c7827270d9b5bf9434ff0f649245de65a5
+  metadata.gz: 4e6217815771ca45d3fc81030b42ae126252ab800e127518e72c2f2b4dd2eb5c
+  data.tar.gz: 266cc5cda364f6df8100a290d393f879075b433acfd7ee70c780b37d23a83292
 SHA512:
-  metadata.gz: 6c777f93827fa6485a6636571500f8def9cd0c8b7d910f61da7c309a84124e70415d8d86e97037ec4ee574ae783936267e446e6e1b870523fdb0ea4abea09f03
-  data.tar.gz: 4fa8ef96adce5932eed3d927d0f878684c1bff3896829c9297df8cb20eda98f4324aed12a066e8c5b2b60996f87929cd31d911b2961414dc2e8c0356edfb3f35
+  metadata.gz: 89c3f93da22298305839c57fadb4963ea0973e16de10b2d2260c76e63927d25c302bbcd2c74515e79adeb24d2440ecba53025aaeeab0b173c6176adccb5d0875
+  data.tar.gz: df7a75da7a8bbecee35d4cc1afb862f6aa0184e96d484a6f207a88510dfac70098ea17cca794aefaac0938e37e96d8a91f7ba21738f2f116554238f02344e4c1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.62.0 (2021-12-24)
+
+* Support `csend` node
+* Restrict `activesupport` version to `~> 6`
+* Fix `prepend` action for `def` and `defs` nodes
+* Fix `append` action for `def` and `defs` nodes
+
+## 0.61.0 (2021-12-10)
+
+* 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

data/lib/synvert/core/node_ext.rb

@@ -49,7 +49,7 @@ module Parser::AST
     # @return [Parser::AST::Node] receiver node.
     # @raise [Synvert::Core::MethodNotSupported] if calls on other node.
     def receiver
-      if :send == type
+      if %i[csend send].include?(type)
         children[0]
       else
         raise Synvert::Core::MethodNotSupported, "receiver is not handled for #{debug_info}"
@@ -64,7 +64,7 @@ module Parser::AST
       case type
       when :super, :zsuper
         :super
-      when :send
+      when :send, :csend
         children[1]
       else
         raise Synvert::Core::MethodNotSupported, "message is not handled for #{debug_info}"
@@ -81,7 +81,7 @@ module Parser::AST
         children[1]
       when :defs
         children[2]
-      when :send
+      when :send, :csend
         children[2..-1]
       when :defined?
         children
@@ -343,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.
@@ -363,15 +400,15 @@ module Parser::AST
         loc.operator
       when %i[defs self]
         Parser::Source::Range.new('(string)', loc.operator.begin_pos - 'self'.length, loc.operator.begin_pos)
-      when %i[send dot]
+      when %i[send dot], %i[csend dot]
         loc.dot
-      when %i[send message]
+      when %i[send message], %i[csend message]
         if loc.operator
           Parser::Source::Range.new('(string)', loc.selector.begin_pos, loc.operator.end_pos)
         else
           loc.selector
         end
-      when %i[send parentheses]
+      when %i[send parentheses], %i[csend parentheses]
         if loc.begin && loc.end
           Parser::Source::Range.new('(string)', loc.begin.begin_pos, loc.end.end_pos)
         end
@@ -382,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(
@@ -486,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
@@ -556,7 +593,7 @@ module Parser::AST
     def to_string
       return to_source unless type == :sym
 
-      "#{to_value}"
+      to_value.to_s
     end
 
     # convert lambda {} to -> {}

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

@@ -17,7 +17,7 @@ module Synvert::Core
     # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
     def indent(node)
-      if %i[block class].include? node.type
+      if %i[block class def defs].include? node.type
         ' ' * (node.column + DEFAULT_INDENT)
       else
         ' ' * node.column

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

@@ -16,6 +16,10 @@ module Synvert::Core
           end
         when :class
           @node.children[1] ? @node.children[1].loc.expression.end_pos : @node.children[0].loc.expression.end_pos
+        when :def
+          @node.children[1].empty? ? @node.loc.name.end_pos : @node.children[1].loc.expression.end_pos
+        when :defs
+          @node.children[2].empty? ? @node.loc.name.end_pos : @node.children[2].loc.expression.end_pos
         else
           @node.children.last.loc.expression.end_pos
         end
@@ -29,7 +33,7 @@ module Synvert::Core
     # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
     def indent(node)
-      if %i[block class].include? node.type
+      if %i[block class def defs].include?(node.type)
         ' ' * (node.column + DEFAULT_INDENT)
       else
         ' ' * node.column

data/lib/synvert/core/rewriter.rb

@@ -81,11 +81,10 @@ module Synvert::Core
       def fetch(group, name)
         group = group.to_s
         name = name.to_s
-        if rewriters[group] && rewriters[group][name]
-          rewriters[group][name]
-        else
-          raise RewriterNotFound, "Rewriter #{group} #{name} not found"
-        end
+        rewriter = rewriters.dig(group, name)
+        raise RewriterNotFound, "Rewriter #{group} #{name} not found" unless rewriter
+
+        rewriter
       end
 
       # Get a registered rewriter by group and name, then process that rewriter.
@@ -166,9 +165,8 @@ module Synvert::Core
     def process
       @affected_files = Set.new
       instance_eval(&@block)
-      if !@affected_files.empty? && @redo_until_no_change
-        process
-      end
+
+      process if !@affected_files.empty? && @redo_until_no_change # redo
     end
 
     # Process rewriter with sandbox mode.
@@ -236,9 +234,10 @@ module Synvert::Core
     def within_files(file_patterns, &block)
       return if @sandbox
 
-      if (!@ruby_version || @ruby_version.match?) && (!@gem_spec || @gem_spec.match?)
-        Rewriter::Instance.new(self, Array(file_patterns), &block).process
-      end
+      return if @ruby_version && !@ruby_version.match?
+      return if @gem_spec && !@gem_spec.match?
+
+      Rewriter::Instance.new(self, Array(file_patterns), &block).process
     end
 
     # Parse within_file dsl, it finds a specifiled file.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.60.0'
+    VERSION = '0.62.0'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -80,6 +80,11 @@ describe Parser::AST::Node do
       node = parse('FactoryGirl.create :post')
       expect(node.receiver).to eq parse('FactoryGirl')
     end
+
+    it 'gets for csend node' do
+      node = parse('user&.update(name: name)')
+      expect(node.receiver).to eq parse('user')
+    end
   end
 
   describe '#message' do
@@ -88,6 +93,11 @@ describe Parser::AST::Node do
       expect(node.message).to eq :create
     end
 
+    it 'gets for csend node' do
+      node = parse('user&.update(name: name)')
+      expect(node.message).to eq :update
+    end
+
     it 'gets for super node' do
       node = parse('super(params)')
       expect(node.message).to eq :super
@@ -137,6 +147,11 @@ describe Parser::AST::Node do
       expect(node.arguments).to eq parse("[:post, title: 'post']").children
     end
 
+    it 'gets for csend node' do
+      node = parse('user&.update(name: name)')
+      expect(node.arguments).to eq parse('[name: name]').children
+    end
+
     it 'gets for defined? node' do
       node = parse('defined?(Bundler)')
       expect(node.arguments).to eq [parse('Bundler')]
@@ -554,6 +569,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
@@ -605,6 +668,50 @@ describe Parser::AST::Node do
       end
     end
 
+    context 'csend node' do
+      it 'checks receiver' do
+        node = parse('foo&.bar(test)')
+        range = node.child_node_range(:receiver)
+        expect(range.to_range).to eq(0...3)
+      end
+
+      it 'checks dot' do
+        node = parse('foo&.bar(test)')
+        range = node.child_node_range(:dot)
+        expect(range.to_range).to eq(3...5)
+      end
+
+      it 'checks message' do
+        node = parse('foo&.bar(test)')
+        range = node.child_node_range(:message)
+        expect(range.to_range).to eq(5...8)
+
+        node = parse('foo&.bar = test')
+        range = node.child_node_range(:message)
+        expect(range.to_range).to eq(5...10)
+      end
+
+      it 'checks arguments' do
+        node = parse('foo&.bar(test)')
+        range = node.child_node_range(:arguments)
+        expect(range.to_range).to eq(9...13)
+
+        node = parse('foo&.bar')
+        range = node.child_node_range(:arguments)
+        expect(range).to be_nil
+      end
+
+      it 'checks parentheses' do
+        node = parse('foo&.bar(test)')
+        range = node.child_node_range(:parentheses)
+        expect(range.to_range).to eq(8...14)
+
+        node = parse('foo&.bar')
+        range = node.child_node_range(:parentheses)
+        expect(range).to be_nil
+      end
+    end
+
     context 'def node' do
       it 'checks name' do
         node = parse('def foo(bar); end')
@@ -720,6 +827,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

data/spec/synvert/core/rewriter/action/append_action_spec.rb

@@ -45,5 +45,26 @@ module Synvert::Core
         expect(subject.rewritten_code).to eq "\ngem 'twitter'"
       end
     end
+
+    describe 'def node' do
+      subject do
+        source = "def teardown\n  do_something\nend"
+        class_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: class_node)
+        Rewriter::AppendAction.new(instance, 'super').process
+      end
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq "def teardown\n  do_something".length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq "def teardown\n  do_something".length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  super"
+      end
+    end
   end
 end

data/spec/synvert/core/rewriter/action/prepend_action_spec.rb

@@ -87,5 +87,89 @@ module Synvert::Core
         expect(subject.rewritten_code).to eq "\n  include Deletable"
       end
     end
+
+    describe 'def node without args' do
+      subject do
+        source = "def setup\n  do_something\nend"
+        def_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: def_node)
+        Rewriter::PrependAction.new(instance, 'super').process
+      end
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'def setup'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'def setup'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  super"
+      end
+    end
+
+    describe 'def node with args' do
+      subject do
+        source = "def setup(foobar)\n  do_something\nend"
+        def_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: def_node)
+        Rewriter::PrependAction.new(instance, 'super').process
+      end
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'def setup(foobar)'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'def setup(foobar)'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  super"
+      end
+    end
+
+    describe 'defs node without args' do
+      subject do
+        source = "def self.foo\n  do_something\nend"
+        def_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: def_node)
+        Rewriter::PrependAction.new(instance, 'do_something_first').process
+      end
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'def self.foo'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'def self.foo'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  do_something_first"
+      end
+    end
+
+    describe 'defs node with args' do
+      subject do
+        source = "def self.foo(bar)\n  do_something\nend"
+        def_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: def_node)
+        Rewriter::PrependAction.new(instance, 'do_something_first').process
+      end
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'def self.foo(bar)'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'def self.foo(bar)'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  do_something_first"
+      end
+    end
   end
 end

data/synvert-core-ruby.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "activesupport", "~> 6"
   spec.add_runtime_dependency "erubis"
   spec.add_runtime_dependency "parser"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.60.0
+  version: 0.62.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement