synvert-core 0.61.0 → 0.62.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff83abb1009ca5d9fe97a1c2e64701c31942a1c235e2b5a9bfe6cec1875f0956
-  data.tar.gz: b983862aa7a7861801104d43dc19cd794a5b83e4c2be5b137888b2e92a6f8068
+  metadata.gz: 79777679e6001f32c8b4bc587e2f007f396eeecd9c0c7e29926e01a3628b4244
+  data.tar.gz: df4d3eda62e9b2f49ec1cf8da96bd98952d7d5af70fd4d6861b206bbc923cca9
 SHA512:
-  metadata.gz: 6978c684ad91c8a59c9774129c5ab21162b66f4f3b4eb043337a008c2dd5a5df3634b7781442d03147ae8829b250bd73f279b31379f6b3861e852da75209ba26
-  data.tar.gz: 96299eb5b9b6254a3781abaff6e3d9f2ac6e1da8e1216b17990471558408bf6ceecb439175183819f3aadd860de94754639c4434705910469318e91abd57f124
+  metadata.gz: c9744e62dc972253304018ac041aa1f4cd01efd8a80a207a77145e088d4d69713ef4ec10ade9fe4d251811b6a8166d8e33b575ea91265fbec4f989a9e29ac376
+  data.tar.gz: cad73e2d256e25370b535a0f623fee47c02f4d5a56e3feaed50f81a798cf3c1dbb0ffd4d6ad04ab167be78fc390703a2a01f0377b79ea621f1674399aa2c7534

data/.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -29,4 +29,4 @@ jobs:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 0.62.1 (2022-01-14)
+
+* Add `to` option to `InsertAction`
+
+## 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`

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
@@ -400,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
@@ -593,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/insert_action.rb

@@ -3,13 +3,15 @@
 module Synvert::Core
   # InsertAction to add code to the node.
   class Rewriter::InsertAction < Rewriter::Action
-    def initialize(instance, code, at:)
+    def initialize(instance, code, at:, to: nil)
       super(instance, code)
       @at = at
+      @to = to
     end
 
     def calculate_position
-      @begin_pos = @at == 'end' ? @node.loc.expression.end_pos : @node.loc.expression.begin_pos
+      node_range = @to ? @node.child_node_range(@to) : @node.loc.expression
+      @begin_pos = @at == 'end' ? node_range.end_pos : node_range.begin_pos
       @end_pos = @begin_pos
     end
 

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/instance.rb

@@ -240,8 +240,9 @@ module Synvert::Core
     #
     # @param code [String] code need to be inserted.
     # @param at [String] insert position, beginning or end, end is the default.
-    def insert(code, at: 'end')
-      @actions << Rewriter::InsertAction.new(self, code, at: at).process
+    # @param to [String] where to insert, if it is nil, will insert to current node.
+    def insert(code, at: 'end', to: nil)
+      @actions << Rewriter::InsertAction.new(self, code, at: at, to: to).process
     end
 
     # Parse insert_after dsl, it creates a [Synvert::Core::Rewriter::InsertAfterAction] to

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.61.0'
+    VERSION = '0.62.1'
   end
 end

data/lib/synvert/core.rb

@@ -5,6 +5,7 @@ require 'bundler'
 require 'parser'
 require 'parser/current'
 require 'ast'
+require 'active_support'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/array'
 require 'erubis'

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')]
@@ -653,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')

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/insert_action_spec.rb

@@ -45,5 +45,26 @@ module Synvert::Core
         expect(subject.rewritten_code).to eq 'URI.'
       end
     end
+
+    context 'to receiver' do
+      subject {
+        source = "User.where(username: 'Richard')"
+        node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: node)
+        Rewriter::InsertAction.new(instance, '.active', to: 'receiver', at: 'end').process
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq "User".length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq "User".length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq '.active'
+      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/spec/synvert/core/rewriter/instance_spec.rb

@@ -118,14 +118,14 @@ module Synvert::Core
 
     it 'parses insert at end' do
       action = double
-      expect(Rewriter::InsertAction).to receive(:new).with(instance, '.first', at: 'end').and_return(action)
+      expect(Rewriter::InsertAction).to receive(:new).with(instance, '.first', at: 'end', to: 'receiver').and_return(action)
       expect(action).to receive(:process)
-      instance.insert '.first'
+      instance.insert '.first', to: 'receiver'
     end
 
     it 'parses insert at beginning' do
       action = double
-      expect(Rewriter::InsertAction).to receive(:new).with(instance, 'URI.', at: 'beginning').and_return(action)
+      expect(Rewriter::InsertAction).to receive(:new).with(instance, 'URI.', at: 'beginning', to: nil).and_return(action)
       expect(action).to receive(:process)
       instance.insert 'URI.', at: 'beginning'
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.61.0
+  version: 0.62.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.