synvert-core 0.15.1 → 0.18.0

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Instance is an execution unit, it finds specified ast nodes,
@@ -8,7 +8,7 @@ module Synvert::Core
   class Rewriter::Instance
     include Rewriter::Helper
 
-    class <<self
+    class << self
       # Cached file source.
       #
       # @param file_path [String] file path
@@ -64,7 +64,7 @@ module Synvert::Core
     #   @return current filename
     attr_accessor :current_node, :current_file
 
-    DEFAULT_OPTIONS = { sort_by: 'begin_pos' }
+    DEFAULT_OPTIONS = { sort_by: 'begin_pos' }.freeze
 
     # Initialize an instance.
     #
@@ -73,13 +73,13 @@ module Synvert::Core
     # @param options [Hash] instance options, it includes :sort_by.
     # @param block [Block] block code to find nodes, match conditions and rewrite code.
     # @return [Synvert::Core::Rewriter::Instance]
-    def initialize(rewriter, file_pattern, options={}, &block)
+    def initialize(rewriter, file_pattern, options = {}, &block)
       @rewriter = rewriter
       @actions = []
       @file_pattern = file_pattern
       @options = DEFAULT_OPTIONS.merge(options)
       @block = block
-      rewriter.helpers.each { |helper| self.singleton_class.send(:define_method, helper[:name], &helper[:block]) }
+      rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
 
     # Process the instance.
@@ -87,16 +87,19 @@ module Synvert::Core
     # and rewrite source code back to original file.
     def process
       file_pattern = File.join(Configuration.instance.get(:path), @file_pattern)
-      Dir.glob(file_pattern).each do |file_path|
-        unless Configuration.instance.get(:skip_files).include? file_path
+      Dir
+        .glob(file_pattern)
+        .each do |file_path|
+          next if Configuration.instance.get(:skip_files).include? file_path
+
           begin
             conflict_actions = []
-            source = self.class.file_source(file_path)
+            source = +self.class.file_source(file_path)
             ast = self.class.file_ast(file_path)
 
             @current_file = file_path
 
-            self.process_with_node ast do
+            process_with_node ast do
               begin
                 instance_eval &@block
               rescue NoMethodError
@@ -108,7 +111,7 @@ module Synvert::Core
             if @actions.length > 0
               @actions.sort_by! { |action| action.send(@options[:sort_by]) }
               conflict_actions = get_conflict_actions
-              @actions.reverse.each do |action|
+              @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
@@ -121,7 +124,6 @@ module Synvert::Core
             # do nothing, iterate next file
           end while !conflict_actions.empty?
         end
-      end
     end
 
     # Gets current node, it allows to get current node in block code.
@@ -146,7 +148,7 @@ module Synvert::Core
     # @param node [Parser::AST::Node] node set to current_node
     # @yield process
     def process_with_other_node(node)
-      original_node = self.current_node
+      original_node = current_node
       self.current_node = node
       yield
       self.current_node = original_node
@@ -156,15 +158,28 @@ module Synvert::Core
     # DSL #
     #######
 
-    # Parse within_node dsl, it creates a [Synvert::Core::Rewriter::WithinScope] to find matching ast nodes,
+    # Parse within_node dsl, it creates a [Synvert::Core::Rewriter::WithinScope] to find recursive matching ast nodes,
     # then continue operating on each matching ast node.
     #
     # @param rules [Hash] rules to find mathing ast nodes.
     # @param block [Block] block code to continue operating on the matching nodes.
     def within_node(rules, &block)
-      Rewriter::WithinScope.new(self, rules, &block).process
+      Rewriter::WithinScope.new(self, rules, { recursive: true }, &block).process
     end
 
+    alias with_node within_node
+
+    # Parse within_direct_node dsl, it creates a [Synvert::Core::Rewriter::WithinScope] to find direct matching ast nodes,
+    # then continue operating on each matching ast node.
+    #
+    # @param rules [Hash] rules to find mathing ast nodes.
+    # @param block [Block] block code to continue operating on the matching nodes.
+    def within_direct_node(rules, &block)
+      Rewriter::WithinScope.new(self, rules, { recursive: false }, &block).process
+    end
+
+    alias with_direct_node within_direct_node
+
     # Parse goto_node dsl, it creates a [Synvert::Core::Rewriter::GotoScope] to go to a child node,
     # then continue operating on the child node.
     #
@@ -174,8 +189,6 @@ module Synvert::Core
       Rewriter::GotoScope.new(self, child_node_name, &block).process
     end
 
-    alias_method :with_node, :within_node
-
     # Parse if_exist_node dsl, it creates a [Synvert::Core::Rewriter::IfExistCondition] to check
     # if matching nodes exist in the child nodes, if so, then continue operating on each matching ast node.
     #
@@ -209,7 +222,7 @@ module Synvert::Core
     #
     # @param code [String] code need to be appended.
     # @param options [Hash] action options.
-    def append(code, options={})
+    def append(code, options = {})
       @actions << Rewriter::AppendAction.new(self, code, options)
     end
 
@@ -218,7 +231,7 @@ module Synvert::Core
     #
     # @param code [String] code need to be inserted.
     # @param options [Hash] action options.
-    def insert(code, options={})
+    def insert(code, options = {})
       @actions << Rewriter::InsertAction.new(self, code, options)
     end
 
@@ -227,7 +240,7 @@ module Synvert::Core
     #
     # @param code [String] code need to be inserted.
     # @param options [Hash] action options.
-    def insert_after(node, options={})
+    def insert_after(node, options = {})
       @actions << Rewriter::InsertAfterAction.new(self, node, options)
     end
 
@@ -236,7 +249,7 @@ module Synvert::Core
     #
     # @param code [String] code need to be replaced with.
     # @param options [Hash] action options.
-    def replace_with(code, options={})
+    def replace_with(code, options = {})
       @actions << Rewriter::ReplaceWithAction.new(self, code, options)
     end
 
@@ -258,7 +271,7 @@ module Synvert::Core
       @rewriter.add_warning Rewriter::Warning.new(self, message)
     end
 
-  private
+    private
 
     # It changes source code from bottom to top, and it can change source code twice at the same time,
     # So if there is an overlap between two actions, it removes the conflict actions and operate them in the next loop.
@@ -290,7 +303,8 @@ module Synvert::Core
       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?
+        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" : '')

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # GemSpec checks and compares gem version.

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Scope finds out nodes which match rules.

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Go to and change its scope to a child node.
@@ -18,6 +18,7 @@ module Synvert::Core
     def process
       current_node = @instance.current_node
       return unless current_node
+
       child_node = current_node.send @child_node_name
       @instance.process_with_other_node child_node do
         @instance.instance_eval &@block

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # WithinScope finds out nodes which match rules, then change its scope to matching node.
@@ -7,10 +7,12 @@ module Synvert::Core
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
     # @param rules [Hash]
+    # @param options [Hash]
     # @param block [Block]
-    def initialize(instance, rules, &block)
+    def initialize(instance, rules, options = { recursive: true }, &block)
       @instance = instance
       @rules = rules
+      @options = options
       @block = block
     end
 
@@ -19,12 +21,9 @@ module Synvert::Core
     def process
       current_node = @instance.current_node
       return unless current_node
+
+      matching_nodes = find_matching_nodes(current_node)
       @instance.process_with_node current_node do
-        matching_nodes = []
-        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
         matching_nodes.each do |matching_node|
           @instance.process_with_node matching_node do
             @instance.instance_eval &@block
@@ -32,5 +31,22 @@ module Synvert::Core
         end
       end
     end
+
+    private
+
+    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
+        end
+      else
+        current_node.each do |child_node|
+          matching_nodes << child_node if child_node.match? @rules
+        end
+      end
+      matching_nodes
+    end
   end
 end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Warning is used to save warning message.

data/lib/synvert/core/version.rb

@@ -1,7 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Synvert
   module Core
-    VERSION = "0.15.1"
+    VERSION = '0.18.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert/core'
 

data/spec/support/parser_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ParserHelper
   def parse(code)
     Parser::CurrentRuby.parse code

data/spec/synvert/core/configuration_spec.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Synvert::Core
   describe Configuration do
     it 'sets / gets' do
       Configuration.instance.set :key, 'value'
-      expect(Configuration.instance.get :key).to eq 'value'
+      expect(Configuration.instance.get(:key)).to eq 'value'
     end
   end
 end

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

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Synvert::Core
   describe Engine::ERB do
-    it "encodes / decodes" do
-      source =<<-EOF
-<%content_for :head do%>
-  <style>
-    body {
-      background-image: url(<%= asset_path('bg.png') %>);
-    }
-  </style>
-<%end%>
-
-<%
-  foo = 'bar'
-  post = Post.find(:first)
-  bar = 'foo'
-%>
-
-<% if User.current &&
-      User.current.admin %>
-  <%= rounded_content("page") do %>
-  <div class='test'>
-    <% if post %>
-      <div id="title"><%= foo %></div>
-      <% form_for post do |f| %>
-        <label><%= link_to_function 'test', "confirm('test');" %></label>
-        <%= f.text_field 'bar' %>
-      <% end %>
-    <% end %></div>
-  <% end %>
-<% end %>
+    it 'encodes / decodes' do
+      source = <<~EOF
+        <%content_for :head do%>
+          <style>
+            body {
+              background-image: url(<%= asset_path('bg.png') %>);
+            }
+          </style>
+        <%end%>
+        
+        <%
+          foo = 'bar'
+          post = Post.find(:first)
+          bar = 'foo'
+        %>
+        
+        <% if User.current &&
+              User.current.admin %>
+          <%= rounded_content("page") do %>
+          <div class='test'>
+            <% if post %>
+              <div id="title"><%= foo %></div>
+              <% form_for post do |f| %>
+                <label><%= link_to_function 'test', "confirm('test');" %></label>
+                <%= f.text_field 'bar' %>
+              <% end %>
+            <% end %></div>
+          <% end %>
+        <% end %>
       EOF
       encoded_source = Engine::ERB.encode(source)
-      buffer = Parser::Source::Buffer.new "(test)"
+      buffer = Parser::Source::Buffer.new '(test)'
       buffer.source = encoded_source
       parser = Parser::CurrentRuby.new
       parser.reset

data/spec/synvert/core/node_ext_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Parser::AST::Node do
@@ -101,13 +103,13 @@ 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.map { |argument| argument.to_source }).to eq ['foo', 'bar']
+      node = parse('def test(foo, bar); foo + bar; end')
+      expect(node.arguments.map { |argument| argument.to_source }).to eq %w[foo bar]
     end
 
     it 'gets for defs node' do
-      node = parse("def self.test(foo, bar); foo + bar; end")
-      expect(node.arguments.map { |argument| argument.to_source }).to eq ['foo', 'bar']
+      node = parse('def self.test(foo, bar); foo + bar; end')
+      expect(node.arguments.map { |argument| argument.to_source }).to eq %w[foo bar]
     end
 
     it 'gets for block node' do
@@ -170,129 +172,129 @@ describe Parser::AST::Node do
     end
   end
 
-  describe "#keys" do
+  describe '#keys' do
     it 'gets for hash node' do
       node = parse("{:foo => :bar, 'foo' => 'bar'}")
       expect(node.keys).to eq [parse(':foo'), parse("'foo'")]
     end
   end
 
-  describe "#values" do
+  describe '#values' do
     it 'gets for hash node' do
       node = parse("{:foo => :bar, 'foo' => 'bar'}")
       expect(node.values).to eq [parse(':bar'), parse("'bar'")]
     end
   end
 
-  describe "#has_key?" do
-    it "gets true if key exists" do
-      node = parse("{:foo => :bar}")
+  describe '#has_key?' do
+    it 'gets true if key exists' do
+      node = parse('{:foo => :bar}')
       expect(node.has_key?(:foo)).to be_truthy
     end
 
-    it "gets false if key does not exist" do
-      node = parse("{:foo => :bar}")
+    it 'gets false if key does not exist' do
+      node = parse('{:foo => :bar}')
       expect(node.has_key?('foo')).to be_falsey
     end
   end
 
-  describe "#hash_value" do
-    it "gets value of specified key" do
-      node = parse("{:foo => :bar}")
+  describe '#hash_value' do
+    it 'gets value of specified key' do
+      node = parse('{:foo => :bar}')
       expect(node.hash_value(:foo)).to eq parse(':bar')
     end
 
-    it "gets nil if key does not exist" do
-      node = parse("{:foo => :bar}")
+    it 'gets nil if key does not exist' do
+      node = parse('{:foo => :bar}')
       expect(node.hash_value(:bar)).to be_nil
     end
   end
 
-  describe "#key" do
+  describe '#key' do
     it 'gets for pair node' do
       node = parse("{:foo => 'bar'}").children[0]
       expect(node.key).to eq parse(':foo')
     end
   end
 
-  describe "#value" do
+  describe '#value' do
     it 'gets for hash node' do
       node = parse("{:foo => 'bar'}").children[0]
       expect(node.value).to eq parse("'bar'")
     end
   end
 
-  describe "#condition" do
+  describe '#condition' do
     it 'gets for if node' do
       node = parse('if defined?(Bundler); end')
       expect(node.condition).to eq parse('defined?(Bundler)')
     end
   end
 
-  describe "#left_value" do
+  describe '#left_value' do
     it 'gets for masgn' do
-      node = parse("a, b = 1, 2")
+      node = parse('a, b = 1, 2')
       expect(node.left_value.to_source).to eq 'a, b'
     end
 
     it 'gets for lvasgn' do
-      node = parse("a = 1")
+      node = parse('a = 1')
       expect(node.left_value).to eq :a
     end
 
     it 'gets for ivasgn' do
-      node = parse("@a = 1")
+      node = parse('@a = 1')
       expect(node.left_value).to eq :@a
     end
   end
 
-  describe "#right_value" do
+  describe '#right_value' do
     it 'gets for masgn' do
-      node = parse("a, b = 1, 2")
+      node = parse('a, b = 1, 2')
       expect(node.right_value).to eq parse('[1, 2]')
     end
 
     it 'gets for masgn' do
-      node = parse("a, b = params")
-      expect(node.right_value).to eq parse("params")
+      node = parse('a, b = params')
+      expect(node.right_value).to eq parse('params')
     end
 
     it 'gets for lvasgn' do
-      node = parse("a = 1")
-      expect(node.right_value).to eq parse("1")
+      node = parse('a = 1')
+      expect(node.right_value).to eq parse('1')
     end
 
     it 'gets for ivasgn' do
-      node = parse("@a = 1")
-      expect(node.right_value).to eq parse("1")
+      node = parse('@a = 1')
+      expect(node.right_value).to eq parse('1')
     end
   end
 
-  describe "#to_value" do
+  describe '#to_value' do
     it 'gets for int' do
-      node = parse("1")
+      node = parse('1')
       expect(node.to_value).to eq 1
     end
 
     it 'gets for string' do
       node = parse("'str'")
-      expect(node.to_value).to eq "str"
+      expect(node.to_value).to eq 'str'
     end
 
     it 'gets for symbol' do
-      node = parse(":str")
+      node = parse(':str')
       expect(node.to_value).to eq :str
     end
 
     it 'get for boolean' do
-      node = parse("true")
+      node = parse('true')
       expect(node.to_value).to be_truthy
-      node = parse("false")
+      node = parse('false')
       expect(node.to_value).to be_falsey
     end
 
     it 'get for range' do
-      node = parse("(1..10)")
+      node = parse('(1..10)')
       expect(node.to_value).to eq (1..10)
     end
 
@@ -382,13 +384,13 @@ describe Parser::AST::Node do
     it 'matches arguments any' do
       source = 'config.middleware.insert_after ActiveRecord::QueryCache, Lifo::Cache, page_cache: false'
       node = parse(source)
-      expect(node).to be_match(type: 'send', arguments: {any: 'Lifo::Cache'})
+      expect(node).to be_match(type: 'send', arguments: { any: 'Lifo::Cache' })
     end
 
     it 'matches not' do
       source = 'class Synvert; end'
       node = parse(source)
-      expect(node).not_to be_match(type: 'class', name: {not: 'Synvert'})
+      expect(node).not_to be_match(type: 'class', name: { not: 'Synvert' })
     end
   end
 
@@ -413,24 +415,25 @@ describe Parser::AST::Node do
     it 'rewrites for ArgumentsNode' do
       source = 'test { |a, b| }'
       node = parse(source)
-      expect(node.rewritten_source('{{arguments}}')).to eq %(a, b)
+      expect(node.rewritten_source('{{arguments}}')).to eq 'a, b'
     end
 
-    it 'rewrites array with multi line given as argument for method'do
-      source = <<-EOS.strip
-long_name_method([
-  1,
-  2,
-  3
-])
+    it 'rewrites array with multi line given as argument for method' do
+      source = <<~EOS.strip
+        long_name_method([
+          1,
+          2,
+          3
+        ])
       EOS
+
       node = parse(source)
-      expect(node.rewritten_source('{{arguments}}')).to eq <<-EOS.strip
-[
-  1,
-  2,
-  3
-]
+      expect(node.rewritten_source('{{arguments}}')).to eq <<~EOS.strip
+        [
+          1,
+          2,
+          3
+        ]
       EOS
     end
   end