synvert-core 0.35.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c718983fb8e6e6216ac660fba2aa1b9beeacf96db451d65b4df3df827a396c0
-  data.tar.gz: a6fd2918b8de9d92bfe4a50f1c135154d5b94eacd21b3e88c740e1869e4c4686
+  metadata.gz: 5c729d2f456550a622a39f2e43d6d6c7f701f8b1330af038c436a03ec162d828
+  data.tar.gz: 8f5e7642d9073bfa38798dbd237a416037047991d530f4ff862623007ffa81f7
 SHA512:
-  metadata.gz: 8a828ec38b3d152a6620dd8fb5101a4fa0594da95eaede5612dd805f8b719bc52ebcaa1c00de48bb17fb306ebcf0cd6a7beb109dc91602afd5e305aafe521e47
-  data.tar.gz: 496d20ef84817d2e8073573b67635f8cb520fc430a647eba909ff9a49dce8fa4f9f5c99245123aa390d7b7d0356c955ca1f78c8073ee17984e1dfa14a8914e51
+  metadata.gz: 1187929417e2611b85d95dad5cc2f985d86cc4a1638d0ebecc4baeacc8dfa124ed5ec6595845a941fe7fe13c1666255333aa9f4249f297899c84ab8518a1b809
+  data.tar.gz: 729ff991e4a120d655faaa5517915d6d2614396668f08268a93b70c86f00ce038ec12ff09cf7d5cc060e34b7af8604689f3e4948b32a26bf4fc85ae520da1d21

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 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
+
+## 0.36.0 (2021-06-21)
+
+* Require `active_support/core_ext/array`
+
 ## 0.35.0 (2021-05-17)
 
 * Add `contain` rule

data/lib/synvert/core.rb

@@ -6,6 +6,7 @@ require 'parser'
 require 'parser/current'
 require 'ast'
 require 'active_support/core_ext/object'
+require 'active_support/core_ext/array'
 require 'erubis'
 require 'set'
 require 'synvert/core/node_ext'

data/lib/synvert/core/node_ext.rb

@@ -269,6 +269,12 @@ module Parser::AST
         return hash_value(key.to_sym)&.to_value if key?(key.to_sym)
         return hash_value(key.to_s)&.to_value if key?(key.to_s)
 
+        return nil
+      elsif :hash == type && method_name.to_s.include?('_source')
+        key = method_name.to_s.sub('_source', '')
+        return hash_value(key.to_sym)&.to_source if key?(key.to_sym)
+        return hash_value(key.to_s)&.to_source if key?(key.to_s)
+
         return nil
       end
 
@@ -281,6 +287,9 @@ module Parser::AST
       elsif :hash == type && method_name.to_s.include?('_value')
         key = method_name.to_s.sub('_value', '')
         return true if key?(key.to_sym) || key?(key.to_s)
+      elsif :hash == type && method_name.to_s.include?('_source')
+        key = method_name.to_s.sub('_source', '')
+        return true if key?(key.to_sym) || key?(key.to_s)
       end
 
       super
@@ -332,7 +341,11 @@ module Parser::AST
       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]
-        Parser::Source::Range.new('(string)', arguments.first.loc.expression.begin_pos, arguments.last.loc.expression.end_pos)
+        Parser::Source::Range.new(
+          '(string)',
+          arguments.first.loc.expression.begin_pos,
+          arguments.last.loc.expression.end_pos
+        )
       when %i[class name], %i[def name], %i[defs name]
         loc.name
       when %i[defs dot]

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

@@ -1,26 +1,13 @@
 # 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
-
     # 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
-      else
-        @node.children.last.loc.expression.end_pos
-      end
+      @node.loc.expression.end_pos
     end
 
     # End position, always same to begin position.
@@ -30,18 +17,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/instance.rb

@@ -224,6 +224,15 @@ module Synvert::Core
       @actions << Rewriter::AppendAction.new(self, code, options)
     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.
+    # @param options [Hash] action options.
+    def prepend(code, options = {})
+      @actions << Rewriter::PrependAction.new(self, code, options)
+    end
+
     # Parse insert dsl, it creates a [Synvert::Core::Rewriter::InsertAction] to
     # insert the code to the top of current node body.
     #

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

@@ -37,9 +37,18 @@ module Synvert::Core
     def find_matching_nodes(current_node)
       matching_nodes = []
       if @options[:recursive]
-        matching_nodes << current_node if current_node.match? @rules
-        current_node.recursive_children do |child_node|
-          matching_nodes << child_node if child_node.match? @rules
+        if current_node.is_a?(Parser::AST::Node)
+          matching_nodes << current_node if current_node.match? @rules
+          current_node.recursive_children do |child_node|
+            matching_nodes << child_node if child_node.match? @rules
+          end
+        else
+          current_node.each do |node|
+            matching_nodes << node if node.match? @rules
+            node.recursive_children do |child_node|
+              matching_nodes << child_node if child_node.match? @rules
+            end
+          end
         end
       elsif current_node.is_a?(Parser::AST::Node)
         if current_node.type == :begin

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.35.0'
+    VERSION = '0.40.0'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -360,6 +360,18 @@ describe Parser::AST::Node do
     end
   end
 
+  describe 'key value source by method_missing' do
+    it 'gets for key value source' do
+      node = parse('{:foo => :bar}')
+      expect(node.foo_source).to eq ':bar'
+
+      node = parse("{'foo' => 'bar'}")
+      expect(node.foo_source).to eq "'bar'"
+
+      expect(node.bar_source).to be_nil
+    end
+  end
+
   describe '#recursive_children' do
     it 'iterates all children recursively' do
       node = parse('class Synvert; def current_node; @node; end; end')

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

@@ -4,88 +4,23 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::InsertAction 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::InsertAction.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::InsertAction.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
+    subject {
+      source = "User.where(username: 'Richard')"
+      node = Parser::CurrentRuby.parse(source)
+      instance = double(current_node: node)
+      Rewriter::InsertAction.new(instance, '.first')
+    }
+
+    it 'gets begin_pos' do
+      expect(subject.begin_pos).to eq "User.where(username: 'Richard')".length
     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
+    it 'gets end_pos' do
+      expect(subject.end_pos).to eq "User.where(username: 'Richard')".length
     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"
-      end
+    it 'gets rewritten_code' do
+      expect(subject.rewritten_code).to eq ".first"
     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/instance_spec.rb

@@ -94,13 +94,22 @@ module Synvert::Core
       instance.append 'include FactoryGirl::Syntax::Methods'
     end
 
+    it 'parses prepend' do
+      expect(Rewriter::PrependAction).to receive(:new).with(
+        instance,
+        '{{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,
-        '{{arguments.first}}.include FactoryGirl::Syntax::Methods',
+        '.first',
         {}
       )
-      instance.insert '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
+      instance.insert '.first'
     end
 
     it 'parses insert_after' do

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

@@ -8,16 +8,16 @@ module Synvert::Core
       rewriter = Rewriter.new('foo', 'bar')
       Rewriter::Instance.new(rewriter, 'file pattern')
     }
-    let(:source) {
-      "
-describe Post do
-  it 'gets post' do
-    FactoryGirl.create :post
-  end
-end
-    "
-    }
+    let(:source) { <<~EOS }
+      describe Post do
+        it 'gets post' do
+          FactoryGirl.create :post
+        end
+      end
+    EOS
+
     let(:node) { Parser::CurrentRuby.parse(source) }
+
     before do
       Rewriter::Instance.reset
       instance.current_node = node

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-06-23 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