synvert-core 0.52.0 → 0.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346c7567c1fec413a81afbe2ec5348f9cd66ac03ed08e8a6cf0fbf47ba049d08
-  data.tar.gz: c4a274d516c1301eb0be17777bd26a16561943077260508925cc3c5eae43e799
+  metadata.gz: dce993d0b27272e83abe3bd3a1ff2a9917a2c9953bb30e57671216aed001292c
+  data.tar.gz: 0b65093ca670d59065707e122a9964f163fbca2e4201fd75005295b7841e4db1
 SHA512:
-  metadata.gz: ee568051d2872db9f81c7d9a3609379eba74db82862ad55976b962e0c4b835dca9f7af74c67014554f6ee919edde2dab050a77fc248bc71ed2c4969009cede1d
-  data.tar.gz: 80dd4085d700581a02dd9507e88e0cbf28e978cbbd61d0e0906c73d2f713abbdd9393caec13d6854b3727d1b1fdd87a673d67323b4b315990a00f06fa23a1f44
+  metadata.gz: 4bb49555a37b7778e37216f267b0e2ab938030ac5428f7bbef60d8462fb83597693bad9a5cd12c43c52a80330de48662151abbcc8edebb7572538f1520539bac
+  data.tar.gz: eaf5690913c21c3b043f5119f2b8b4afe08c16c5a9db8d9d209a42f0a64a72d4f19376da6dee6ed43b04b79d8077f4463a47acb5d18742a6dcb1499b3191db7a

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 0.54.1 (2021-09-08)
+
+* Rewrite `remove` action
+
+## 0.54.0 (2021-08-28)
+
+* Change `goto_scope` param from array to string
+
+## 0.53.0 (2021-08-22)
+
+* Fix nested child in Node#child_node_range
+* Rename synvert-core to synvert-core-ruby
+
 ## 0.52.0 (2021-08-21)
 
 * ``Node#child_node_range`` supports nested child

data/README.md

@@ -1,12 +1,11 @@
-# Synvert::Core
+# synvert-core-ruby
 
-<img src="https://xinminlabs.github.io/synvert/img/logo_96.png" alt="logo" width="32" height="32" />
+<img src="https://synvert.xinminlabs.com/img/logo_96.png" alt="logo" width="32" height="32" />
 
-![Main workflow](https://github.com/xinminlabs/synvert-core/actions/workflows/main.yml/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/xinminlabs/synvert-core/badge.png?branch=master)](https://coveralls.io/r/xinminlabs/synvert-core)
+![Main workflow](https://github.com/xinminlabs/synvert-core-ruby/actions/workflows/main.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/synvert-core.png)](http://badge.fury.io/rb/synvert-core)
 
-synvert-core provides a dsl to convert ruby source code.
+synvert-core-ruby provides a dsl to convert ruby source code.
 
 ## Installation
 
@@ -31,11 +30,11 @@ Or install it yourself as:
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/synvert-core/fork )
+1. Fork it ( https://github.com/[my-github-username]/synvert-core-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-[1]: https://xinminlabs.github.io/synvert/
-[2]: https://rubydoc.info/github/xinminlabs/synvert-core/master/frames
+[1]: https://synvert.xinminlabs.com
+[2]: https://rubydoc.info/github/xinminlabs/synvert-core-ruby/master/frames

data/lib/synvert/core/node_ext.rb

@@ -341,7 +341,7 @@ module Parser::AST
     # @param [String] name of child node.
     # @return [Parser::Source::Range] source range of child node.
     def child_node_range(child_name)
-      case [type, child_name]
+      case [type, child_name.to_sym]
       when %i[block pipes], %i[def parentheses], %i[defs parentheses]
         Parser::Source::Range.new('(string)', arguments.loc.expression.begin_pos, arguments.loc.expression.end_pos)
       when %i[block arguments], %i[def arguments], %i[defs arguments]
@@ -369,35 +369,38 @@ module Parser::AST
           Parser::Source::Range.new('(string)', loc.begin.begin_pos, loc.end.end_pos)
         end
       else
-        child_node = self
-        child_name.to_s.split('.').each do |key|
-          if child_node.respond_to?(key)
-            child_node = child_node.send(key)
-            return nil if child_node.nil?
-          else
-            raise Synvert::Core::MethodNotSupported,
-                  "child_node_range is not handled for #{child_node.debug_info}, child_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)
+
+          return child_node.child_node_range(nested_child_name) if nested_child_name
+
+          return nil if child_node.nil?
+
+          if child_node.is_a?(Parser::AST::Node)
+            return(
+              Parser::Source::Range.new(
+                '(string)',
+                child_node.loc.expression.begin_pos,
+                child_node.loc.expression.end_pos
+              )
+            )
           end
-        end
 
-        if child_node.is_a?(Parser::AST::Node)
+          # arguments
+          return nil if child_node.empty?
+
           return(
             Parser::Source::Range.new(
               '(string)',
-              child_node.loc.expression.begin_pos,
-              child_node.loc.expression.end_pos
+              child_node.first.loc.expression.begin_pos,
+              child_node.last.loc.expression.end_pos
             )
           )
         end
 
-        # arguments
-        return nil if child_node.empty?
-
-        Parser::Source::Range.new(
-          '(string)',
-          child_node.first.loc.expression.begin_pos,
-          child_node.last.loc.expression.end_pos
-        )
+        raise Synvert::Core::MethodNotSupported,
+              "child_node_range is not handled for #{debug_info}, child_name: #{child_name}"
       end
     end
 

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

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # RemoveAction to delete code.
+  # DeleteAction to delete child nodes.
   class Rewriter::DeleteAction < Rewriter::Action
     def initialize(instance, *selectors)
       super(instance, nil)
       @selectors = selectors
     end
 
-    # Begin position of code to replace.
+    # Begin position of code to delete.
     #
     # @return [Integer] begin position.
     def begin_pos
       @selectors.map { |selector| @node.child_node_range(selector) }.compact.map(&:begin_pos).min
     end
 
-    # End position of code to replace.
+    # End position of code to delete.
     #
     # @return [Integer] end position.
     def end_pos

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # AddAction to add code to the node.
+  # InsertAction to add code to the node.
   class Rewriter::InsertAction < Rewriter::Action
     def initialize(instance, code, at:)
       super(instance, code)

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

@@ -1,29 +1,55 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # RemoveAction to remove code.
+  # RemoveAction to remove current node.
   class Rewriter::RemoveAction < Rewriter::Action
-    def initialize(instance, code = nil)
-      super
+    def initialize(instance)
+      super(instance, nil)
     end
 
     # Begin position of code to replace.
     #
     # @return [Integer] begin position.
     def begin_pos
-      @node.loc.expression.begin_pos
+      if take_whole_line?
+        start_index
+      else
+        @node.loc.expression.begin_pos
+      end
     end
 
     # End position of code to replace.
     #
     # @return [Integer] end position.
     def end_pos
-      @node.loc.expression.end_pos
+      if take_whole_line?
+        end_index
+      else
+        @node.loc.expression.end_pos
+      end
     end
 
     # The rewritten code, always empty string.
     def rewritten_code
       ''
     end
+
+    private
+
+    def take_whole_line?
+      @node.to_source == file_source[start_index...end_index].strip
+    end
+
+    def start_index
+      file_source[0..@node.loc.expression.begin_pos].rindex("\n") + "\n".length
+    end
+
+    def end_index
+      file_source[@node.loc.expression.end_pos..-1].index("\n") + @node.loc.expression.end_pos + "\n".length
+    end
+
+    def file_source
+      @file_source ||= @instance.file_source
+    end
   end
 end

data/lib/synvert/core/rewriter/instance.rb

@@ -64,6 +64,11 @@ module Synvert::Core
     #   @return current filename
     attr_accessor :current_node, :current_file
 
+    # Current file source
+    def file_source
+      self.class.file_source(current_file)
+    end
+
     # Initialize an instance.
     #
     # @param rewriter [Synvert::Core::Rewriter]
@@ -107,7 +112,6 @@ module Synvert::Core
             conflict_actions = get_conflict_actions
             @actions.reverse_each do |action|
               source[action.begin_pos...action.end_pos] = action.rewritten_code
-              source = remove_code_or_whole_line(source, action.line)
             end
             @actions = []
 
@@ -139,7 +143,7 @@ module Synvert::Core
 
     # Set current_node properly, process and set current_node back to original current_node.
     #
-    # @param node [Parser::AST::Node] node set to current_node
+    # @param node [Parser::AST::Node] node set to other_node
     # @yield process
     def process_with_other_node(node)
       original_node = current_node
@@ -177,10 +181,10 @@ module Synvert::Core
     # Parse goto_node dsl, it creates a [Synvert::Core::Rewriter::GotoScope] to go to a child node,
     # then continue operating on the child node.
     #
-    # @param *child_node_names [Array] the name of the child nodes.
+    # @param child_node_name [Symbol|String] the name of the child nodes.
     # @param block [Block] block code to continue operating on the matching nodes.
-    def goto_node(*child_node_names, &block)
-      Rewriter::GotoScope.new(self, *child_node_names, &block).process
+    def goto_node(child_node_name, &block)
+      Rewriter::GotoScope.new(self, child_node_name, &block).process
     end
 
     # Parse if_exist_node dsl, it creates a [Synvert::Core::Rewriter::IfExistCondition] to check
@@ -323,25 +327,6 @@ module Synvert::Core
       conflict_actions
     end
 
-    # It checks if code is removed and that line is empty.
-    #
-    # @param source [String] source code of file
-    # @param line [String] the line number
-    def remove_code_or_whole_line(source, line)
-      newline_at_end_of_line = source[-1] == "\n"
-      source_arr = source.split("\n")
-      if source_arr[line - 1] && source_arr[line - 1].strip.empty?
-        source_arr.delete_at(line - 1)
-        if source_arr[line - 2] && source_arr[line - 2].strip.empty? && source_arr[line - 1] &&
-             source_arr[line - 1].strip.empty?
-          source_arr.delete_at(line - 1)
-        end
-        source_arr.join("\n") + (newline_at_end_of_line ? "\n" : '')
-      else
-        source
-      end
-    end
-
     # It updates a file with new source code.
     #
     # @param file_path [String] the file path

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

@@ -6,11 +6,11 @@ module Synvert::Core
     # Initialize a scope
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
-    # @param *child_node_names [Array]
+    # @param child_node_name [Symbol|string]
     # @param block [Block]
-    def initialize(instance, *child_node_names, &block)
+    def initialize(instance, child_node_name, &block)
       @instance = instance
-      @child_node_names = child_node_names
+      @child_node_name = child_node_name
       @block = block
     end
 
@@ -20,7 +20,7 @@ module Synvert::Core
       return unless current_node
 
       child_node = current_node
-      @child_node_names.each do |child_node_name|
+      @child_node_name.to_s.split('.').each do |child_node_name|
         child_node = child_node_name.is_a?(Parser::AST::Node) ? child_node_name : child_node.send(child_node_name)
       end
       @instance.process_with_other_node child_node do

data/lib/synvert/core/rewriter.rb

@@ -81,7 +81,7 @@ module Synvert::Core
       def fetch(group, name)
         group = group.to_s
         name = name.to_s
-        if exist? group, name
+        if rewriters[group] && rewriters[group][name]
           rewriters[group][name]
         else
           raise RewriterNotFound, "Rewriter #{group} #{name} not found"
@@ -96,34 +96,13 @@ module Synvert::Core
       # @return [Synvert::Core::Rewriter] the registered rewriter.
       # @raise [Synvert::Core::RewriterNotFound] if the registered rewriter is not found.
       def call(group, name, sandbox = false)
-        group = group.to_s
-        name = name.to_s
-        if exist? group, name
-          rewriter = rewriters[group][name]
-          if sandbox
-            rewriter.process_with_sandbox
-          else
-            rewriter.process
-          end
-          rewriter
-        else
-          raise RewriterNotFound, "Rewriter #{group}/#{name} not found"
-        end
-      end
-
-      # Check if one rewriter exist.
-      #
-      # @param group [String] the rewriter group.
-      # @param name [String] the rewriter name.
-      # @return [Boolean] true if the rewriter exist.
-      def exist?(group, name)
-        group = group.to_s
-        name = name.to_s
-        if rewriters[group] && rewriters[group][name]
-          true
+        rewriter = fetch(group, name)
+        if sandbox
+          rewriter.process_with_sandbox
         else
-          false
+          rewriter.process
         end
+        rewriter
       end
 
       # Get all available rewriters

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.52.0'
+    VERSION = '0.54.1'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -526,6 +526,12 @@ describe Parser::AST::Node do
         range = node.child_node_range('caller.receiver')
         expect(range.to_range).to eq(0...7)
       end
+
+      it 'checks caller.message' do
+        node = parse('Factory.define :user do |user|; end')
+        range = node.child_node_range('caller.message')
+        expect(range.to_range).to eq(8...14)
+      end
     end
 
     context 'class node' do

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

@@ -7,7 +7,7 @@ module Synvert::Core
     subject {
       source = "user = User.new params[:user]\nuser.save\nrender\n"
       send_node = Parser::CurrentRuby.parse(source).children[1]
-      instance = double(current_node: send_node)
+      instance = double(current_node: send_node, file_source: source)
       Rewriter::RemoveAction.new(instance)
     }
 
@@ -16,7 +16,7 @@ module Synvert::Core
     end
 
     it 'gets end_pos' do
-      expect(subject.end_pos).to eq "user = User.new params[:user]\nuser.save".length
+      expect(subject.end_pos).to eq "user = User.new params[:user]\nuser.save\n".length
     end
 
     it 'gets rewritten_code' do

data/spec/synvert/core/rewriter/instance_spec.rb

@@ -54,9 +54,9 @@ module Synvert::Core
     it 'parses goto_node' do
       scope = double
       block = proc {}
-      expect(Rewriter::GotoScope).to receive(:new).with(instance, :caller, :receiver, &block).and_return(scope)
+      expect(Rewriter::GotoScope).to receive(:new).with(instance, 'caller.receiver', &block).and_return(scope)
       expect(scope).to receive(:process)
-      instance.goto_node(:caller, :receiver, &block)
+      instance.goto_node('caller.receiver', &block)
     end
 
     it 'parses if_exist_node' do

data/spec/synvert/core/rewriter/scope/goto_scope_spec.rb

@@ -24,7 +24,7 @@ module Synvert::Core
         run = false
         type_in_scope = nil
         scope =
-          Rewriter::GotoScope.new instance, :caller, :receiver do
+          Rewriter::GotoScope.new instance, 'caller.receiver' do
             run = true
             type_in_scope = node.type
           end

data/spec/synvert/core/rewriter_spec.rb

@@ -249,17 +249,6 @@ module Synvert::Core
         expect { Rewriter.call 'group', 'rewriter' }.to raise_error(RewriterNotFound)
       end
 
-      context 'exist?' do
-        it 'returns true if rewriter exists' do
-          Rewriter.new 'group', 'rewriter'
-          expect(Rewriter.exist?('group', 'rewriter')).to be_truthy
-        end
-
-        it 'returns false if rewriter does not exist' do
-          expect(Rewriter.exist?('group', 'rewriter')).to be_falsey
-        end
-      end
-
       context 'available' do
         it 'lists empty rewriters' do
           expect(Rewriter.availables).to eq({})

data/{synvert-core.gemspec → synvert-core-ruby.gemspec}

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["flyerhzm@gmail.com"]
   spec.summary       = 'convert ruby code to better syntax.'
   spec.description   = 'convert ruby code to better syntax automatically.'
-  spec.homepage      = "https://github.com/xinminlabs/synvert-core"
+  spec.homepage      = "https://github.com/xinminlabs/synvert-core-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.54.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-21 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,8 +198,8 @@ files:
 - spec/synvert/core/rewriter/scope_spec.rb
 - spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb
-- synvert-core.gemspec
-homepage: https://github.com/xinminlabs/synvert-core
+- synvert-core-ruby.gemspec
+homepage: https://github.com/xinminlabs/synvert-core-ruby
 licenses:
 - MIT
 metadata: {}