synvert-core 0.59.0 → 0.61.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '093f0af943a24314d55691d222fb181ab0526c4e1e8c557a38824609773a17a4'
-  data.tar.gz: 96b272edcb8ed63b346bfc30c76210aee11e7cab618045b0fed27107edbe5bfd
+  metadata.gz: 7f5de89db1e920d9a0f1f55543f5e68121daaadec9c28558438561a303e1ef52
+  data.tar.gz: b7b491df1978ab9a628b4230753332044b1fe6d4fd53426b80d4047c3da9fbf7
 SHA512:
-  metadata.gz: 6cd336f74ddcbd5342811670824cf0f821c693a3b331f82dfb1f756f7deed41ae2f6d32cbba208a138f96a240476182c674adb2a5ab4940acda70e7737024f09
-  data.tar.gz: 6e9f09306f30fbde3dc552df33d09e2bc1e0651dcda418640cbcdc648704e427e670b4d910ffdd7039f48262c7d4cd62197e18dd111f512d1591c31643746580
+  metadata.gz: 0b5957ba9a2812b7efeb224d0aa8776cdde9c664f35a35b1247e2445fe294c2c803c83eb4d6b4c7be4bde98ea0a196982ac7ae8974fc3c90874bf396b15d7d1c
+  data.tar.gz: e8d838167caff111711f4fc61cb431b52eb53817a268f65c920f915e31c6a0fb785f1bbaa43f43210657b2c93db7d33656f4c9338e887d5f0afdc1a004eb7167

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 0.61.2 (2021-12-21)
+
+* Restrict activesupport version to ~> 6
+
+## 0.61.1 (2021-12-12)
+
+* 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
+
 ## 0.59.0 (2021-11-17)
 
 * Use option `stop_when_match` instead of `recursive`

data/lib/synvert/core/node_ext.rb

@@ -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.
@@ -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
@@ -552,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/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.59.0'
+    VERSION = '0.61.2'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -554,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
@@ -720,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
@@ -827,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/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.59.0
+  version: 0.61.2
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-12-21 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
@@ -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.2.32
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.