synvert-core 0.64.0 → 1.0.1

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

@@ -34,7 +34,8 @@ module Synvert::Core
     # @return [String] rewritten code.
     def rewritten_code
       if rewritten_source.split("\n").length > 1
-        "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }.join("\n")
+        "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }
+                                 .join("\n")
       else
         "\n" + indent(@node) + rewritten_source
       end

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

@@ -65,7 +65,9 @@ module Synvert::Core
     #
     #   strip_brackets("(1..100)") #=> "1..100"
     def strip_brackets(code)
-      code.sub(/^\((.*)\)$/) { Regexp.last_match(1) }.sub(/^\[(.*)\]$/) { Regexp.last_match(1) }.sub(/^{(.*)}$/) {
+      code.sub(/^\((.*)\)$/) { Regexp.last_match(1) }
+          .sub(/^\[(.*)\]$/) { Regexp.last_match(1) }
+          .sub(/^{(.*)}$/) {
         Regexp.last_match(1).strip
       }
     end
@@ -81,7 +83,8 @@ module Synvert::Core
     #   hash_node = Parser::CurrentRuby.parse("{ key1: 'value1', key2: 'value2' }")
     #   reject_keys_from_hash(hash_node, :key1) => "key2: 'value2'"
     def reject_keys_from_hash(hash_node, *keys)
-      hash_node.children.reject { |pair_node| keys.include?(pair_node.key.to_value) }.map(&:to_source).join(', ')
+      hash_node.children.reject { |pair_node| keys.include?(pair_node.key.to_value) }
+               .map(&:to_source).join(', ')
     end
   end
 end

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

@@ -7,6 +7,18 @@ module Synvert::Core
   # One instance can contain one or many {Synvert::Core::Rewriter::Scope} and {Synvert::Rewriter::Condition}.
   class Rewriter::Instance
     include Rewriter::Helper
+    # Initialize an Instance.
+    #
+    # @param rewriter [Synvert::Core::Rewriter]
+    # @param file_patterns [Array<String>] pattern list to find files, e.g. ['spec/**/*_spec.rb']
+    # @yield block code to find nodes, match conditions and rewrite code.
+    def initialize(rewriter, file_patterns, &block)
+      @rewriter = rewriter
+      @actions = []
+      @file_patterns = file_patterns
+      @block = block
+      rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
+    end
 
     class << self
       # Get file source.
@@ -69,19 +81,6 @@ module Synvert::Core
       self.class.file_source(current_file)
     end
 
-    # Initialize an Instance.
-    #
-    # @param rewriter [Synvert::Core::Rewriter]
-    # @param file_patterns [Array<String>] pattern list to find files, e.g. ['spec/**/*_spec.rb']
-    # @yield block code to find nodes, match conditions and rewrite code.
-    def initialize(rewriter, file_patterns, &block)
-      @rewriter = rewriter
-      @actions = []
-      @file_patterns = file_patterns
-      @block = block
-      rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
-    end
-
     # Process the instance.
     # It finds specified files, for each file, it executes the block code, rewrites the original code,
     # then write the code back to the original file.
@@ -127,6 +126,19 @@ module Synvert::Core
     # DSL #
     #######
 
+    # Parse +find_node+ dsl, it creates {Synvert::Core::Rewriter::QueryScope} to recursively find matching ast nodes,
+    # then continue operating on each matching ast node.
+    # @example
+    #   # matches FactoryBot.create(:user)
+    #   find_node '.send[receiver=FactoryBot][message=create][arguments.size=1]' do
+    #   end
+    # @param query_string [String] query string to find matching ast nodes.
+    # @yield run on the matching nodes.
+    # @raise [Synvert::Core::NodeQuery::Compiler::ParseError] if query string is invalid.
+    def find_node(query_string, &block)
+      Rewriter::QueryScope.new(self, query_string, &block).process
+    end
+
     # Parse +within_node+ dsl, it creates a {Synvert::Core::Rewriter::WithinScope} to recursively find matching ast nodes,
     # then continue operating on each matching ast node.
     # @example

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # QueryScope finds out nodes by using node query language, then changes its scope to matching node.
+  class Rewriter::QueryScope < Rewriter::Scope
+    # Initialize a QueryScope.
+    #
+    # @param instance [Synvert::Core::Rewriter::Instance]
+    # @param query_string [String]
+    # @yield run on all matching nodes
+    def initialize(instance, query_string, &block)
+      super(instance, &block)
+      @query_string = query_string
+    end
+
+    # Find out the matching nodes.
+    #
+    # It checks the current node and iterates all child nodes,
+    # then run the block code on each matching node.
+    # @raise [Synvert::Core::NodeQuery::Compiler::ParseError] if the query string is invalid.
+    def process
+      current_node = @instance.current_node
+      return unless current_node
+
+      @instance.process_with_node(current_node) do
+        NodeQuery::Parser.new.parse(@query_string).query_nodes(current_node).each do |node|
+          @instance.process_with_node(node) do
+            @instance.instance_eval(&@block)
+          end
+        end
+      end
+    rescue NodeQuery::Lexer::ScanError, Racc::ParseError => e
+      raise NodeQuery::Compiler::ParseError, "Invalid query string: #{@query_string}"
+    end
+  end
+end

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

@@ -116,4 +116,4 @@ module Synvert::Core
       matching_nodes
     end
   end
-end
+end

data/lib/synvert/core/rewriter.rb

@@ -25,6 +25,7 @@ module Synvert::Core
     autoload :Instance, 'synvert/core/rewriter/instance'
 
     autoload :Scope, 'synvert/core/rewriter/scope'
+    autoload :QueryScope, 'synvert/core/rewriter/scope/query_scope'
     autoload :WithinScope, 'synvert/core/rewriter/scope/within_scope'
     autoload :GotoScope, 'synvert/core/rewriter/scope/goto_scope'
 

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.64.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/synvert/core.rb

@@ -10,6 +10,7 @@ require 'active_support/core_ext/object'
 require 'active_support/core_ext/array'
 require 'erubis'
 require 'set'
+require 'synvert/core/array_ext'
 require 'synvert/core/node_ext'
 
 module Synvert
@@ -19,6 +20,7 @@ module Synvert
     autoload :Engine, 'synvert/core/engine'
     autoload :RewriterNotFound, 'synvert/core/exceptions'
     autoload :MethodNotSupported, 'synvert/core/exceptions'
+    autoload :NodeQuery, 'synvert/core/node_query'
   end
 end
 
@@ -37,17 +39,32 @@ module Synvert
   RAILS_MAILER_FILES = %w[app/mailers/**/*.rb engines/*/app/mailers/**/*.rb]
   RAILS_MIGRATION_FILES = %w[db/migrate/**/*.rb engines/*/db/migrate/**/*.rb]
   RAILS_MODEL_FILES = %w[app/models/**/*.rb engines/*/app/models/**/*.rb]
-  RAILS_ROUTE_FILES = %w[config/routes.rb config/routes/**/*.rb engines/*/config/routes.rb engines/*/config/routes/**/*.rb]
+  RAILS_ROUTE_FILES = %w[
+    config/routes.rb
+    config/routes/**/*.rb
+    engines/*/config/routes.rb
+    engines/*/config/routes/**/*.rb
+  ]
   RAILS_VIEW_FILES = %w[app/views/**/*.html.{erb,haml,slim}]
 
   RAILS_CONTROLLER_TEST_FILES = %w[
-    test/functional/**/*.rb test/controllers/**/*.rb engines/*/test/functional/**/*.rb engines/*/test/controllers/**/*.rb
-    spec/functional/**/*.rb spec/controllers/**/*.rb engines/*/spec/functional/**/*.rb engines/*/spec/controllers/**/*.rb
+    test/functional/**/*.rb
+    test/controllers/**/*.rb
+    engines/*/test/functional/**/*.rb
+    engines/*/test/controllers/**/*.rb
+    spec/functional/**/*.rb
+    spec/controllers/**/*.rb
+    engines/*/spec/functional/**/*.rb
+    engines/*/spec/controllers/**/*.rb
   ]
   RAILS_INTEGRATION_TEST_FILES = %w[test/integration/**/*.rb spec/integration/**/*.rb]
   RAILS_MODEL_TEST_FILES = %w[
-    test/unit/**/*.rb engines/*/test/unit/**/*.rb test/models/**/*.rb engines/*/test/models/**/*.rb
-    spec/models/**/*.rb engines/*/spec/models/**/*.rb
+    test/unit/**/*.rb
+    engines/*/test/unit/**/*.rb
+    test/models/**/*.rb
+    engines/*/test/models/**/*.rb
+    spec/models/**/*.rb
+    engines/*/spec/models/**/*.rb
   ]
 
   RAILS_FACTORY_FILES = %w[test/factories/**/*.rb spec/factories/**/*.rb]

data/spec/synvert/core/engine/erb_spec.rb

@@ -13,13 +13,13 @@ module Synvert::Core
             }
           </style>
         <%end%>
-        
+
         <%
           foo = 'bar'
           post = Post.find(:first)
           bar = 'foo'
         %>
-        
+
         <% if User.current &&
               User.current.admin %>
           <%= rounded_content("page") do %>

data/spec/synvert/core/node_ext_spec.rb

@@ -3,6 +3,25 @@
 require 'spec_helper'
 
 describe Parser::AST::Node do
+  describe '#parent' do
+    it 'gets parent node' do
+      node = parse('FactoryBot.create(:user)')
+      child_node = node.children.first
+      expect(child_node.parent).to eq node
+    end
+  end
+
+  describe '#siblings' do
+    it 'gets sibling nodes' do
+      node = parse(<<~EOS)
+        def foobar; end
+        def foo; end
+        def bar; end
+      EOS
+      expect(node.children.first.siblings).to eq [node.children.second, node.children.last]
+    end
+  end
+
   describe '#name' do
     it 'gets for class node' do
       node = parse('class Synvert; end')
@@ -129,17 +148,17 @@ describe Parser::AST::Node do
   describe '#arguments' do
     it 'gets for def node' do
       node = parse('def test(foo, bar); foo + bar; end')
-      expect(node.arguments.type).to eq :args
+      expect(node.arguments.map(&:type)).to eq [:arg, :arg]
     end
 
     it 'gets for defs node' do
       node = parse('def self.test(foo, bar); foo + bar; end')
-      expect(node.arguments.type).to eq :args
+      expect(node.arguments.map(&:type)).to eq [:arg, :arg]
     end
 
     it 'gets for block node' do
       node = parse('RSpec.configure do |config|; end')
-      expect(node.arguments.type).to eq :args
+      expect(node.arguments.map(&:type)).to eq [:arg]
     end
 
     it 'gets for send node' do
@@ -388,6 +407,11 @@ describe Parser::AST::Node do
       expect(node.to_value).to be_falsey
     end
 
+    it 'gets for nil' do
+      node = parse('nil')
+      expect(node.to_value).to be_nil
+    end
+
     it 'gets for irange' do
       node = parse('(1..10)')
       expect(node.to_value).to eq(1..10)
@@ -534,7 +558,14 @@ describe Parser::AST::Node do
     it 'matches arguments with nested hash' do
       source = '{ user_id: user.id }'
       node = parse(source)
-      expect(node).to be_match(type: 'hash', user_id_value: { type: 'send', receiver: { type: 'send', message: 'user' }, message: 'id' })
+      expect(node).to be_match(
+        type: 'hash',
+        user_id_value: {
+          type: 'send',
+          receiver: { type: 'send', message: 'user' },
+          message: 'id'
+        }
+      )
     end
 
     it 'matches arguments contain' do
@@ -862,7 +893,7 @@ describe Parser::AST::Node do
         expect(range.to_range).to eq(16...27)
       end
 
-      it "checks array' value" do
+      it "checks array's 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)