synvert-core 0.38.0 → 0.41.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02bb61b261f5a4b8a3f528736987402add733b18c98228b0e2345559d2694d63
-  data.tar.gz: 6dd428e975dcbcadbdc4b03dd3ed2b7a846ce37c1d9e13303a68ba33a6d4e6fa
+  metadata.gz: 9e9e29097976ca69f755a698d9a3a78769105c4043b07c96a7ac1e714ae659a0
+  data.tar.gz: 12d45e30a5de2ffc03bb440b503ff1a230e7baa55eb6a69e43518023e7d24f08
 SHA512:
-  metadata.gz: 7b374648741dc853387ff5c2f4bb5ad9518bee56a1646377e8cac22e7c208285f9c9db52882c05de823cf53cb3bdc6dbd365b9a1c505c88726eb3358651c1dc6
-  data.tar.gz: 8097ef7ad23287c35bf9d40a258a4d7c0b5d63ab0e99ab3667dc52d46cd7a51fa0e7f8d0cddee07054e87019bbf449704f3c01ba4cafcda425a30161894a5130
+  metadata.gz: 28802dbdd2f53b267c621f811b959a0041064f97ff4f54ee009f75d230eeb2a1ff3fbb9b1c3cee524d990f53b8e7447105fa57e86cb4ee2b042cd4e17ef63c9e
+  data.tar.gz: 8c0f5604e24d9ea0034214aa2b4d36f26d6c5f181d7d0d70f75a78fe71b0cab1868379953b2d071ea3ab922e62855a51ee5a0cb14ed7b4e26ebb8cc57adcb396

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 0.41.0 (2021-06-24)
+
+* Remove unused autoindent option
+* Add `insert 'xxx', at: 'beginning'`
+
+## 0.40.0 (2021-06-23)
+
+* Rewrite `insert` action
+
+## 0.39.0 (2021-06-23)
+
+* Add `prepend` action instead of `insert`
+
 ## 0.38.0 (2021-06-21)
 
 * Add `xxx_source` for `hash` node

data/lib/synvert/core/node_ext.rb

@@ -388,7 +388,7 @@ module Parser::AST
         end
 
         raise Synvert::Core::MethodNotSupported,
-              "child_node_range is not handled for #{evaluated.inspect}, child_name: #{child_name}"
+              "child_node_range is not handled for #{debug_info}, child_name: #{child_name}"
       end
     end
 
@@ -493,6 +493,8 @@ module Parser::AST
     # @return [Integer] -1, 0 or 1.
     # @raise [Synvert::Core::MethodNotSupported] if expected class is not supported.
     def match_value?(actual, expected)
+      return true if actual == expected
+
       case expected
       when Symbol
         if actual.is_a?(Parser::AST::Node)

data/lib/synvert/core/rewriter.rb

@@ -18,6 +18,7 @@ module Synvert::Core
   class Rewriter
     autoload :Action, 'synvert/core/rewriter/action'
     autoload :AppendAction, 'synvert/core/rewriter/action/append_action'
+    autoload :PrependAction, 'synvert/core/rewriter/action/prepend_action'
     autoload :InsertAction, 'synvert/core/rewriter/action/insert_action'
     autoload :InsertAfterAction, 'synvert/core/rewriter/action/insert_after_action'
     autoload :ReplaceWithAction, 'synvert/core/rewriter/action/replace_with_action'

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

@@ -3,18 +3,15 @@
 module Synvert::Core
   # Action defines rewriter action, add, replace or remove code.
   class Rewriter::Action
-    DEFAULT_OPTIONS = { autoindent: true }.freeze
     DEFAULT_INDENT = 2
 
     # Initialize an action.
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
     # @param code [String] new code to add, replace or remove.
-    # @param options [Hash] action options, it includes :autoindent.
-    def initialize(instance, code, options = {})
+    def initialize(instance, code)
       @instance = instance
       @code = code
-      @options = DEFAULT_OPTIONS.merge(options)
       @node = @instance.current_node
     end
 

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

@@ -1,25 +1,23 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # InsertAction to insert code to the top of node body.
+  # AddAction to add code to the node.
   class Rewriter::InsertAction < Rewriter::Action
-    DO_LENGTH = ' do'.length
+    def initialize(instance, code, at:)
+      @instance = instance
+      @code = code
+      @at = at
+      @node = @instance.current_node
+    end
 
     # Begin position to insert code.
     #
     # @return [Integer] begin position.
     def begin_pos
-      case @node.type
-      when :block
-        if @node.children[1].children.empty?
-          @node.children[0].loc.expression.end_pos + DO_LENGTH
-        else
-          @node.children[1].loc.expression.end_pos
-        end
-      when :class
-        @node.children[1] ? @node.children[1].loc.expression.end_pos : @node.children[0].loc.expression.end_pos
+      if @at == 'end'
+        @node.loc.expression.end_pos
       else
-        @node.children.last.loc.expression.end_pos
+        @node.loc.expression.begin_pos
       end
     end
 
@@ -30,18 +28,11 @@ module Synvert::Core
       begin_pos
     end
 
-    private
-
-    # Indent of the node.
+    # The rewritten source code.
     #
-    # @param node [Parser::AST::Node]
-    # @return [String] n times whitesphace
-    def indent(node)
-      if %i[block class].include? node.type
-        ' ' * (node.indent + DEFAULT_INDENT)
-      else
-        ' ' * node.indent
-      end
+    # @return [String] rewritten code.
+    def rewritten_code
+      rewritten_source
     end
   end
 end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # PrependAction to prepend code to the top of node body.
+  class Rewriter::PrependAction < Rewriter::Action
+    DO_LENGTH = ' do'.length
+
+    # Begin position to prepend code.
+    #
+    # @return [Integer] begin position.
+    def begin_pos
+      case @node.type
+      when :block
+        if @node.children[1].children.empty?
+          @node.children[0].loc.expression.end_pos + DO_LENGTH
+        else
+          @node.children[1].loc.expression.end_pos
+        end
+      when :class
+        @node.children[1] ? @node.children[1].loc.expression.end_pos : @node.children[0].loc.expression.end_pos
+      else
+        @node.children.last.loc.expression.end_pos
+      end
+    end
+
+    # End position, always same to begin position.
+    #
+    # @return [Integer] end position.
+    def end_pos
+      begin_pos
+    end
+
+    private
+
+    # Indent of the node.
+    #
+    # @param node [Parser::AST::Node]
+    # @return [String] n times whitesphace
+    def indent(node)
+      if %i[block class].include? node.type
+        ' ' * (node.indent + DEFAULT_INDENT)
+      else
+        ' ' * node.indent
+      end
+    end
+  end
+end

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

@@ -21,11 +21,11 @@ module Synvert::Core
     #
     # @return [String] rewritten code.
     def rewritten_code
-      if rewritten_source.split("\n").length > 1
+      if rewritten_source.include?("\n")
         new_code = []
-        rewritten_source.split("\n").each_with_index { |line, index|
-          new_code << (index == 0 || !@options[:autoindent] ? line : indent(@node) + line)
-        }
+        rewritten_source.split("\n").each_with_index do |line, index|
+          new_code << (index == 0 ? line : indent(@node) + line)
+        end
         new_code.join("\n")
       else
         rewritten_source

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

@@ -219,36 +219,41 @@ module Synvert::Core
     # append the code to the bottom of current node body.
     #
     # @param code [String] code need to be appended.
-    # @param options [Hash] action options.
-    def append(code, options = {})
-      @actions << Rewriter::AppendAction.new(self, code, options)
+    def append(code)
+      @actions << Rewriter::AppendAction.new(self, code)
+    end
+
+    # Parse prepend dsl, it creates a [Synvert::Core::Rewriter::PrependAction] to
+    # prepend the code to the top of current node body.
+    #
+    # @param code [String] code need to be prepended.
+    def prepend(code)
+      @actions << Rewriter::PrependAction.new(self, code)
     end
 
     # Parse insert dsl, it creates a [Synvert::Core::Rewriter::InsertAction] to
     # insert the code to the top of current node body.
     #
     # @param code [String] code need to be inserted.
-    # @param options [Hash] action options.
-    def insert(code, options = {})
-      @actions << Rewriter::InsertAction.new(self, code, options)
+    # @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)
     end
 
     # Parse insert_after dsl, it creates a [Synvert::Core::Rewriter::InsertAfterAction] to
     # insert the code next to the current node.
     #
     # @param code [String] code need to be inserted.
-    # @param options [Hash] action options.
-    def insert_after(node, options = {})
-      @actions << Rewriter::InsertAfterAction.new(self, node, options)
+    def insert_after(node)
+      @actions << Rewriter::InsertAfterAction.new(self, node)
     end
 
     # Parse replace_with dsl, it creates a [Synvert::Core::Rewriter::ReplaceWithAction] to
     # replace current node with code.
     #
     # @param code [String] code need to be replaced with.
-    # @param options [Hash] action options.
-    def replace_with(code, options = {})
-      @actions << Rewriter::ReplaceWithAction.new(self, code, options)
+    def replace_with(code)
+      @actions << Rewriter::ReplaceWithAction.new(self, code)
     end
 
     # Parse replace with dsl, it creates a [Synvert::Core::Rewriter::ReplaceAction] to

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.38.0'
+    VERSION = '0.41.2'
   end
 end

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

@@ -4,87 +4,45 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::InsertAction do
-    describe 'block node without args' do
+    context 'at end' do
       subject {
-        source = "Synvert::Application.configure do\nend"
-        block_node = Parser::CurrentRuby.parse(source)
-        instance = double(current_node: block_node)
-        Rewriter::InsertAction.new(instance, 'config.eager_load = true')
+        source = "  User.where(username: 'Richard')"
+        node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: node)
+        Rewriter::InsertAction.new(instance, '.first', at: 'end')
       }
 
       it 'gets begin_pos' do
-        expect(subject.begin_pos).to eq 'Synvert::Application.configure do'.length
+        expect(subject.begin_pos).to eq "  User.where(username: 'Richard')".length
       end
 
       it 'gets end_pos' do
-        expect(subject.end_pos).to eq 'Synvert::Application.configure do'.length
+        expect(subject.end_pos).to eq "  User.where(username: 'Richard')".length
       end
 
       it 'gets rewritten_code' do
-        expect(subject.rewritten_code).to eq "\n  config.eager_load = true"
+        expect(subject.rewritten_code).to eq '.first'
       end
     end
 
-    describe 'block node with args' do
+    context 'at beginning' do
       subject {
-        source = "RSpec.configure do |config|\nend"
-        block_node = Parser::CurrentRuby.parse(source)
-        instance = double(current_node: block_node)
-        Rewriter::InsertAction.new(instance, '{{arguments.first}}.include FactoryGirl::Syntax::Methods')
+        source = "  open('http://test.com')"
+        node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: node)
+        Rewriter::InsertAction.new(instance, 'URI.', at: 'beginning')
       }
 
       it 'gets begin_pos' do
-        expect(subject.begin_pos).to eq 'RSpec.configure do |config|'.length
+        expect(subject.begin_pos).to eq 2
       end
 
       it 'gets end_pos' do
-        expect(subject.end_pos).to eq 'RSpec.configure do |config|'.length
+        expect(subject.end_pos).to eq 2
       end
 
       it 'gets rewritten_code' do
-        expect(subject.rewritten_code).to eq "\n  config.include FactoryGirl::Syntax::Methods"
-      end
-    end
-
-    describe 'class node without superclass' do
-      subject {
-        source = "class User\n  has_many :posts\nend"
-        class_node = Parser::CurrentRuby.parse(source)
-        instance = double(current_node: class_node)
-        Rewriter::InsertAction.new(instance, 'include Deletable')
-      }
-
-      it 'gets begin_pos' do
-        expect(subject.begin_pos).to eq 'class User'.length
-      end
-
-      it 'gets end_pos' do
-        expect(subject.end_pos).to eq 'class User'.length
-      end
-
-      it 'gets rewritten_code' do
-        expect(subject.rewritten_code).to eq "\n  include Deletable"
-      end
-    end
-
-    describe 'class node with superclass' do
-      subject {
-        source = "class User < ActiveRecord::Base\n  has_many :posts\nend"
-        class_node = Parser::CurrentRuby.parse(source)
-        instance = double(current_node: class_node)
-        Rewriter::InsertAction.new(instance, 'include Deletable')
-      }
-
-      it 'gets begin_pos' do
-        expect(subject.begin_pos).to eq 'class User < ActionRecord::Base'.length
-      end
-
-      it 'gets end_pos' do
-        expect(subject.end_pos).to eq 'class User < ActionRecord::Base'.length
-      end
-
-      it 'gets rewritten_code' do
-        expect(subject.rewritten_code).to eq "\n  include Deletable"
+        expect(subject.rewritten_code).to eq 'URI.'
       end
     end
   end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  describe Rewriter::PrependAction do
+    describe 'block node without args' do
+      subject {
+        source = "Synvert::Application.configure do\nend"
+        block_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: block_node)
+        Rewriter::PrependAction.new(instance, 'config.eager_load = true')
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'Synvert::Application.configure do'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'Synvert::Application.configure do'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  config.eager_load = true"
+      end
+    end
+
+    describe 'block node with args' do
+      subject {
+        source = "RSpec.configure do |config|\nend"
+        block_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: block_node)
+        Rewriter::PrependAction.new(instance, '{{arguments.first}}.include FactoryGirl::Syntax::Methods')
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'RSpec.configure do |config|'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'RSpec.configure do |config|'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  config.include FactoryGirl::Syntax::Methods"
+      end
+    end
+
+    describe 'class node without superclass' do
+      subject {
+        source = "class User\n  has_many :posts\nend"
+        class_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: class_node)
+        Rewriter::PrependAction.new(instance, 'include Deletable')
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'class User'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'class User'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  include Deletable"
+      end
+    end
+
+    describe 'class node with superclass' do
+      subject {
+        source = "class User < ActiveRecord::Base\n  has_many :posts\nend"
+        class_node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: class_node)
+        Rewriter::PrependAction.new(instance, 'include Deletable')
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq 'class User < ActionRecord::Base'.length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq 'class User < ActionRecord::Base'.length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq "\n  include Deletable"
+      end
+    end
+  end
+end

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

@@ -30,14 +30,12 @@ module Synvert::Core
         source = '  its(:size) { should == 1 }'
         send_node = Parser::CurrentRuby.parse(source)
         instance = double(current_node: send_node)
-        Rewriter::ReplaceWithAction.new(
-          instance,
-          "describe '#size' do
-  subject { super().size }
-  it { {{body}} }
-end",
-          autoindent: false
-        )
+        Rewriter::ReplaceWithAction.new(instance, <<~EOS)
+          describe '#size' do
+            subject { super().size }
+            it { {{body}} }
+          end
+        EOS
       }
 
       it 'gets begin_pos' do
@@ -49,10 +47,12 @@ end",
       end
 
       it 'gets rewritten_code' do
-        expect(subject.rewritten_code).to eq "describe '#size' do
-  subject { super().size }
-  it { should == 1 }
-end"
+        expect(subject.rewritten_code).to eq <<~EOS.strip
+          describe '#size' do
+              subject { super().size }
+              it { should == 1 }
+            end
+        EOS
       end
     end
   end

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

@@ -90,30 +90,38 @@ module Synvert::Core
     end
 
     it 'parses append' do
-      expect(Rewriter::AppendAction).to receive(:new).with(instance, 'include FactoryGirl::Syntax::Methods', {})
+      expect(Rewriter::AppendAction).to receive(:new).with(instance, 'include FactoryGirl::Syntax::Methods')
       instance.append 'include FactoryGirl::Syntax::Methods'
     end
 
-    it 'parses insert' do
-      expect(Rewriter::InsertAction).to receive(:new).with(
+    it 'parses prepend' do
+      expect(Rewriter::PrependAction).to receive(:new).with(
         instance,
-        '{{arguments.first}}.include FactoryGirl::Syntax::Methods',
-        {}
+        '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
       )
-      instance.insert '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
+      instance.prepend '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
+    end
+
+    it 'parses insert' do
+      expect(Rewriter::InsertAction).to receive(:new).with(instance, '.first', at: 'end')
+      instance.insert '.first'
+    end
+
+    it 'parses insert' do
+      expect(Rewriter::InsertAction).to receive(:new).with(instance, 'URI.', at: 'beginning')
+      instance.insert 'URI.', at: 'beginning'
     end
 
     it 'parses insert_after' do
       expect(Rewriter::InsertAfterAction).to receive(:new).with(
         instance,
-        '{{arguments.first}}.include FactoryGirl::Syntax::Methods',
-        {}
+        '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
       )
       instance.insert_after '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
     end
 
     it 'parses replace_with' do
-      expect(Rewriter::ReplaceWithAction).to receive(:new).with(instance, 'create {{arguments}}', {})
+      expect(Rewriter::ReplaceWithAction).to receive(:new).with(instance, 'create {{arguments}}')
       instance.replace_with 'create {{arguments}}'
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.41.2
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,7 @@ files:
 - lib/synvert/core/rewriter/action/delete_action.rb
 - lib/synvert/core/rewriter/action/insert_action.rb
 - lib/synvert/core/rewriter/action/insert_after_action.rb
+- lib/synvert/core/rewriter/action/prepend_action.rb
 - lib/synvert/core/rewriter/action/remove_action.rb
 - lib/synvert/core/rewriter/action/replace_action.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
@@ -176,6 +177,7 @@ files:
 - spec/synvert/core/rewriter/action/delete_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_after_action_spec.rb
+- spec/synvert/core/rewriter/action/prepend_action_spec.rb
 - spec/synvert/core/rewriter/action/remove_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
@@ -227,6 +229,7 @@ test_files:
 - spec/synvert/core/rewriter/action/delete_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_after_action_spec.rb
+- spec/synvert/core/rewriter/action/prepend_action_spec.rb
 - spec/synvert/core/rewriter/action/remove_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_action_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb