synvert-core 0.34.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34cd9673c3a822eb4c9b41930aa069b8c8494d6e81091c37b0184864f302f94d
-  data.tar.gz: 852ff317acabb0d20528a168d6639b10b9ac576f1c70f64af2e17923762addaa
+  metadata.gz: bd079f46cc8d4a8097a794b11c02e98294c217d801538e4c9dafa4305fd3b6d8
+  data.tar.gz: 81018b9a711fca607aa4b2dc3170e9172531140392172b5cd27d4118383a6c31
 SHA512:
-  metadata.gz: 9a23ba7d43b7eef7a6508925a6d9aa2c925e12cd392999f0d2e263be5a5df7c934a735cb00e584f4cddbdccd8779d6eed1dddd338d9d1f9838d9d983c21f74dc
-  data.tar.gz: 92008bfc0d05c3d71d9948e0db6a3c8c09ca05b4aff4d2a1cafb6fd93fb0308554a738f2447d962d4751b82827f22aeee9f81d2c7727fb63190018984a7a8a6e
+  metadata.gz: 78fd6e0b7b28661b5d352a6835f35b713ca829a2a9ae4260e605541b00e9eb151b66b45018a954e1b98682b45bbbddaac359a582281904dd784b2004ded00c9b
+  data.tar.gz: 6a4a33419eafeac609f92d68593ee12b5e5608c24865289cd53f6bb631ef047dc83f1cb7648984d70fded95c9141b6c4a58056280675b55f321836e2b3005dbd

data/CHANGELOG.md

@@ -1,9 +1,25 @@
 # CHANGELOG
 
+## 0.39.0 (2021-06-23)
+
+* Add `prepend` dsl 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
+
 ## 0.34.0 (2021-05-16)
 
 * `child_node_name` supports [:def, :parentheses] and [:defs, :parentheses]
-* rename `pipe` to `pipes`
+* Rename `pipe` to `pipes`
 
 ## 0.33.0 (2021-05-10)
 

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]
@@ -399,7 +412,7 @@ module Parser::AST
     def match?(rules)
       flat_hash(rules).keys.all? do |multi_keys|
         case multi_keys.last
-        when :any
+        when :any, :contain
           actual_values = actual_value(self, multi_keys[0...-1])
           expected = expected_value(rules, multi_keys)
           actual_values.any? { |actual| match_value?(actual, expected) }

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # AddAction to add code to the node.
+  class Rewriter::AddAction < Rewriter::Action
+    # Begin position to insert code.
+    #
+    # @return [Integer] begin position.
+    def begin_pos
+      @node.loc.expression.end_pos
+    end
+
+    # End position, always same to begin position.
+    #
+    # @return [Integer] end position.
+    def end_pos
+      begin_pos
+    end
+
+    private
+
+    # The rewritten source code.
+    #
+    # @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.34.0'
+    VERSION = '0.39.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')
@@ -414,6 +426,12 @@ describe Parser::AST::Node do
       expect(node).to be_match(type: 'send', arguments: { any: 'Lifo::Cache' })
     end
 
+    it 'matches arguments contain' do
+      source = 'def slow(foo, bar, &block); end'
+      node = parse(source)
+      expect(node).to be_match(type: 'def', arguments: { contain: '&block' })
+    end
+
     it 'matches not' do
       source = 'class Synvert; end'
       node = parse(source)

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,6 +94,15 @@ 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,

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.34.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,10 +146,12 @@ files:
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
 - lib/synvert/core/rewriter/action.rb
+- lib/synvert/core/rewriter/action/add_action.rb
 - lib/synvert/core/rewriter/action/append_action.rb
 - 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 +178,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 +230,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