synvert-core 0.28.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b240936c7390b45a27e9352da7acec3784499d38d5ec10aae3b3403036df36b5
-  data.tar.gz: a9c9a91d25352ef1c5fc09bd1cc0d8751d4239513a2fcff0e2618ccec6e93855
+  metadata.gz: f4448b6bf2d17c1128bb6d20732de90a7458019ca33835fa9740e5d6f8102e4a
+  data.tar.gz: 10df72247c2d5a0e7293481096221e755322218e6031ae6b613470938e1d01c4
 SHA512:
-  metadata.gz: 92298a2a06c408cac4aa99870f85138bc754dcb286b636976a01eb88f63613e6f81b80a1d0fc680922a394ab6b7167b9bdd70d6bf2b14a89a7f1a6faaf5292d0
-  data.tar.gz: f5c10e0e949dd459035e92fb172ed20ad7717369923a93e77dfb8077c7ba7c45c31da3ef1756768215ccdeff8b6b36fef063fe0b6db9fa53b3b9457bd895c8ae
+  metadata.gz: 949edd01e98bd306456ed368bbb4fe16b9d9d320cb82aafd8ddb1a0f2367ba7b8e18ba5d43143aa51a91a64bb95c5d895ea5a7c07beea5dd6f8faf078709267d
+  data.tar.gz: 04ba8cfbb5d3c66855f300712417a5ad7476f4ac307d46824d8f02f8b0667c8bfcdf909ae978c8a442fee75d1f46faed15bb50cc81c0a360f8e824333fa321a0

data/CHANGELOG.md

@@ -1,8 +1,26 @@
 # CHANGELOG
 
-## 0.28.1 (2021-04-09)
+## 0.33.0 (2021-05-10)
+
+* Add `body` for `class` node
+
+## 0.32.0 (2021-05-07)
+
+* Remove `ArgumentsNode`
+
+## 0.31.0 (2021-04-27)
+
+* Add `in` and `not_in` rules
+
+## 0.30.0 (2021-04-26)
+
+* `goto_node` accepts multiple child node names
+* Match any_value
+
+## 0.29.0 (2021-04-25)
 
 * Make `child_name_range` support [:block, :pipe]
+* Get key value for hash node
 
 ## 0.28.0 (2021-04-07)
 

data/lib/synvert/core/node_ext.rb

@@ -1,29 +1,6 @@
 # frozen_string_literal: true
 
 module Parser::AST
-  # ArgumentsNode allows to handle all args as one node or handle all args as an array.
-  class ArgumentsNode
-    # Initialize
-    #
-    # @param node [Parser::AST::Node] args node.
-    def initialize(node)
-      @node = node
-    end
-
-    # If args node responds method itself, call method on args node.
-    # If args children (array) responds method,  call method on args children.
-    # Otherwise raise method missing error.
-    def method_missing(meth, *args, &block)
-      if @node.respond_to?(meth)
-        @node.send meth, *args, &block
-      elsif @node.children.respond_to?(meth)
-        @node.children.send meth, *args, &block
-      else
-        super
-      end
-    end
-  end
-
   # Parser::AST::Node monkey patch.
   class Node
     # Get name node of :class, :module, :const, :mlhs, :def and :defs node.
@@ -101,9 +78,9 @@ module Parser::AST
     def arguments
       case type
       when :def, :block
-        ArgumentsNode.new(children[1])
+        children[1]
       when :defs
-        ArgumentsNode.new(children[2])
+        children[2]
       when :send
         children[2..-1]
       when :defined?
@@ -133,7 +110,7 @@ module Parser::AST
       case type
       when :begin
         children
-      when :def, :block
+      when :def, :block, :class
         return [] if children[2].nil?
 
         :begin == children[2].type ? children[2].body : children[2..-1]
@@ -203,7 +180,7 @@ module Parser::AST
     def hash_value(key)
       if :hash == type
         value_node = children.find { |pair_node| pair_node.key.to_value == key }
-        value_node ? value_node.value : nil
+        value_node&.value
       else
         raise Synvert::Core::MethodNotSupported, "hash_value is not handled for #{debug_info}"
       end
@@ -280,6 +257,35 @@ module Parser::AST
       end
     end
 
+    # Respond key value for hash node, e.g.
+    #
+    # Current node is s(:hash, s(:pair, s(:sym, :number), s(:int, 10)))
+    # node.number_value is 10
+    def method_missing(method_name, *args, &block)
+      if :args == type && children.respond_to?(method_name)
+        return children.send(method_name, *args, &block)
+      elsif :hash == type && method_name.to_s.include?('_value')
+        key = method_name.to_s.sub('_value', '')
+        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
+      end
+
+      super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      if :args == type && children.respond_to?(method_name)
+        return true
+      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)
+      end
+
+      super
+    end
+
     def to_s
       if :mlhs == type
         "(#{children.map(&:name).join(', ')})"
@@ -323,35 +329,57 @@ module Parser::AST
     # @return [Parser::Source::Range] source range of child node.
     def child_node_range(child_name)
       case [type, child_name]
-      when [:block, :pipe]
+      when %i[block pipe]
         Parser::Source::Range.new('(string)', arguments.loc.expression.begin_pos, arguments.loc.expression.end_pos)
-      when [:class, :name]
+      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)
+      when %i[class name]
         loc.name
-      when [:def, :name]
+      when %i[def name]
         loc.name
-      when [:defs, :name]
+      when %i[defs name]
         loc.name
-      when [:defs, :dot]
+      when %i[defs dot]
         loc.operator
-      when [:defs, :self]
-        Parser::Source::Range.new('(string)', loc.operator.begin_pos - 4, loc.operator.begin_pos)
-      when [:send, :dot]
+      when %i[defs self]
+        Parser::Source::Range.new('(string)', loc.operator.begin_pos - 'self'.length, loc.operator.begin_pos)
+      when %i[send dot]
         loc.dot
-      when [:send, :message]
-        loc.operator ? Parser::Source::Range.new('(string)', loc.selector.begin_pos, loc.operator.end_pos) : loc.selector
+      when %i[send message]
+        if loc.operator
+          Parser::Source::Range.new('(string)', loc.selector.begin_pos, loc.operator.end_pos)
+        else
+          loc.selector
+        end
       else
         if respond_to?(child_name)
           child_node = send(child_name)
           return nil if child_node.nil?
+
           if child_node.is_a?(Parser::AST::Node)
-            return Parser::Source::Range.new('(string)', child_node.loc.expression.begin_pos, child_node.loc.expression.end_pos)
+            return(
+              Parser::Source::Range.new(
+                '(string)',
+                child_node.loc.expression.begin_pos,
+                child_node.loc.expression.end_pos
+              )
+            )
           end
+
           # arguments
           return nil if child_node.empty?
-          return Parser::Source::Range.new('(string)', child_node.first.loc.expression.begin_pos, child_node.last.loc.expression.end_pos)
+
+          return(
+            Parser::Source::Range.new(
+              '(string)',
+              child_node.first.loc.expression.begin_pos,
+              child_node.last.loc.expression.end_pos
+            )
+          )
         end
 
-        raise Synvert::Core::MethodNotSupported, "child_node_range is not handled for #{evaluated.inspect}, child_name: #{child_name}"
+        raise Synvert::Core::MethodNotSupported,
+              "child_node_range is not handled for #{evaluated.inspect}, child_name: #{child_name}"
       end
     end
 
@@ -383,6 +411,14 @@ module Parser::AST
           actual = actual_value(self, multi_keys[0...-1])
           expected = expected_value(rules, multi_keys)
           !match_value?(actual, expected)
+        when :in
+          actual = actual_value(self, multi_keys[0...-1])
+          expected_values = expected_value(rules, multi_keys)
+          expected_values.any? { |expected| match_value?(actual, expected) }
+        when :not_in
+          actual = actual_value(self, multi_keys[0...-1])
+          expected_values = expected_value(rules, multi_keys)
+          expected_values.all? { |expected| !match_value?(actual, expected) }
         else
           actual = actual_value(self, multi_keys)
           expected = expected_value(rules, multi_keys)
@@ -405,8 +441,12 @@ module Parser::AST
           evaluated = instance_eval old_code
           case evaluated
           when Parser::AST::Node
-            evaluated.loc.expression.source
-          when Array, ArgumentsNode
+            if evaluated.type == :args
+              evaluated.loc.expression.source[1...-1]
+            else
+              evaluated.loc.expression.source
+            end
+          when Array
             if evaluated.size > 0
               file_source = evaluated.first.loc.expression.source_buffer.source
               source = file_source[evaluated.first.loc.expression.begin_pos...evaluated.last.loc.expression.end_pos]
@@ -422,7 +462,7 @@ module Parser::AST
                 source
               end
             end
-          when String, Symbol
+          when String, Symbol, Integer, Float
             evaluated
           when NilClass
             'nil'
@@ -482,6 +522,8 @@ module Parser::AST
         :false == actual.type
       when Parser::AST::Node
         actual == expected
+      when Synvert::Core::Rewriter::AnyValue
+        !actual.nil?
       else
         raise Synvert::Core::MethodNotSupported, "#{expected.class} is not handled for match_value?"
       end

data/lib/synvert/core/rewriter.rb

@@ -44,6 +44,8 @@ module Synvert::Core
     autoload :RubyVersion, 'synvert/core/rewriter/ruby_version'
     autoload :GemSpec, 'synvert/core/rewriter/gem_spec'
 
+    autoload :AnyValue, 'synvert/core/rewriter/any_value'
+
     class << self
       # Execute the temporary rewriter without group and name.
       #

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  class Rewriter::AnyValue
+  end
+end

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

@@ -181,10 +181,10 @@ module Synvert::Core
     # Parse goto_node dsl, it creates a [Synvert::Core::Rewriter::GotoScope] to go to a child node,
     # then continue operating on the child node.
     #
-    # @param child_node_name [String] the name of the child node.
+    # @param *child_node_names [Array] the name of the child nodes.
     # @param block [Block] block code to continue operating on the matching nodes.
-    def goto_node(child_node_name, &block)
-      Rewriter::GotoScope.new(self, child_node_name, &block).process
+    def goto_node(*child_node_names, &block)
+      Rewriter::GotoScope.new(self, *child_node_names, &block).process
     end
 
     # Parse if_exist_node dsl, it creates a [Synvert::Core::Rewriter::IfExistCondition] to check
@@ -285,6 +285,11 @@ module Synvert::Core
       @rewriter.add_warning Rewriter::Warning.new(self, message)
     end
 
+    # Any value but nil.
+    def any_value
+      Rewriter::AnyValue.new
+    end
+
     private
 
     # It changes source code from bottom to top, and it can change source code twice at the same time,

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

@@ -6,11 +6,11 @@ module Synvert::Core
     # Initialize a scope
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
-    # @param child_node_name [String]
+    # @param *child_node_names [Array]
     # @param block [Block]
-    def initialize(instance, child_node_name, &block)
+    def initialize(instance, *child_node_names, &block)
       @instance = instance
-      @child_node_name = child_node_name
+      @child_node_names = child_node_names
       @block = block
     end
 
@@ -19,7 +19,10 @@ module Synvert::Core
       current_node = @instance.current_node
       return unless current_node
 
-      child_node = @child_node_name.is_a?(Parser::AST::Node) ? @child_node_name : current_node.send(@child_node_name)
+      child_node = current_node
+      @child_node_names.each do |child_node_name|
+        child_node = child_node_name.is_a?(Parser::AST::Node) ? child_node_name : child_node.send(child_node_name)
+      end
       @instance.process_with_other_node child_node do
         @instance.instance_eval(&@block)
       end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.28.1'
+    VERSION = '0.33.0'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -104,17 +104,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.map { |argument| argument.to_source }).to eq %w[foo bar]
+      expect(node.arguments.type).to eq :args
     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 %w[foo bar]
+      expect(node.arguments.type).to eq :args
     end
 
     it 'gets for block node' do
       node = parse('RSpec.configure do |config|; end')
-      expect(node.arguments.map { |argument| argument.to_source }).to eq ['config']
+      expect(node.arguments.type).to eq :args
     end
 
     it 'gets for send node' do
@@ -146,6 +146,21 @@ describe Parser::AST::Node do
       expect(node.body).to eq [parse('include EmailSpec::Helpers'), parse('include EmailSpec::Matchers')]
     end
 
+    it 'gets empty for class node' do
+      node = parse('class User; end')
+      expect(node.body).to be_empty
+    end
+
+    it 'gets one line for class node' do
+      node = parse('class User; attr_accessor :email; end')
+      expect(node.body).to eq [parse('attr_accessor :email')]
+    end
+
+    it 'gets one line for class node' do
+      node = parse('class User; attr_accessor :email; attr_accessor :username; end')
+      expect(node.body).to eq [parse('attr_accessor :email'), parse('attr_accessor :username')]
+    end
+
     it 'gets for begin node' do
       node = parse('foo; bar')
       expect(node.body).to eq [parse('foo'), parse('bar')]
@@ -333,6 +348,18 @@ describe Parser::AST::Node do
     end
   end
 
+  describe 'key value by method_missing' do
+    it 'gets for key value' do
+      node = parse('{:foo => :bar}')
+      expect(node.foo_value).to eq :bar
+
+      node = parse("{'foo' => 'bar'}")
+      expect(node.foo_value).to eq 'bar'
+
+      expect(node.bar_value).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')
@@ -392,6 +419,18 @@ describe Parser::AST::Node do
       node = parse(source)
       expect(node).not_to be_match(type: 'class', name: { not: 'Synvert' })
     end
+
+    it 'matches in' do
+      source = 'FactoryBot.create(:user)'
+      node = parse(source)
+      expect(node).to be_match(type: 'send', message: { in: %i[create build] })
+    end
+
+    it 'matches not_in' do
+      source = 'FactoryBot.create(:user)'
+      node = parse(source)
+      expect(node).not_to be_match(type: 'send', message: { not_in: %i[create build] })
+    end
   end
 
   describe '#child_node_range' do
@@ -542,7 +581,7 @@ describe Parser::AST::Node do
       expect(node.rewritten_source('{{name}}')).to eq 'Synvert'
     end
 
-    it 'rewrites for ArgumentsNode' do
+    it 'rewrites for arguments' do
       source = 'test { |a, b| }'
       node = parse(source)
       expect(node.rewritten_source('{{arguments}}')).to eq 'a, b'

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

@@ -5,18 +5,18 @@ require 'spec_helper'
 module Synvert::Core
   describe Rewriter::DeleteAction do
     subject {
-      source = "arr.map {}.flatten"
+      source = 'arr.map {}.flatten'
       node = Parser::CurrentRuby.parse(source)
       instance = double(current_node: node)
       Rewriter::DeleteAction.new(instance, :dot, :message)
     }
 
     it 'gets begin_pos' do
-      expect(subject.begin_pos).to eq "arr.map {}".length
+      expect(subject.begin_pos).to eq 'arr.map {}'.length
     end
 
     it 'gets end_pos' do
-      expect(subject.end_pos).to eq "arr.map {}.flatten".length
+      expect(subject.end_pos).to eq 'arr.map {}.flatten'.length
     end
 
     it 'gets rewritten_code' do

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

@@ -6,7 +6,7 @@ module Synvert::Core
   describe Rewriter::ReplaceAction do
     context 'replace with single line' do
       subject {
-        source = "FactoryBot.create(:user)"
+        source = 'FactoryBot.create(:user)'
         node = Parser::CurrentRuby.parse(source)
         instance = double(current_node: node)
         Rewriter::ReplaceAction.new(instance, :receiver, :dot, :message, with: 'create')
@@ -17,7 +17,7 @@ module Synvert::Core
       end
 
       it 'gets end_pos' do
-        expect(subject.end_pos).to eq "FactoryBot.create".length
+        expect(subject.end_pos).to eq 'FactoryBot.create'.length
       end
 
       it 'gets rewritten_code' do

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

@@ -54,9 +54,9 @@ module Synvert::Core
     it 'parses goto_node' do
       scope = double
       block = proc {}
-      expect(Rewriter::GotoScope).to receive(:new).with(instance, :caller, &block).and_return(scope)
+      expect(Rewriter::GotoScope).to receive(:new).with(instance, :caller, :receiver, &block).and_return(scope)
       expect(scope).to receive(:process)
-      instance.goto_node(:caller, &block)
+      instance.goto_node(:caller, :receiver, &block)
     end
 
     it 'parses if_exist_node' do

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

@@ -8,12 +8,11 @@ module Synvert::Core
       rewriter = Rewriter.new('foo', 'bar')
       Rewriter::Instance.new(rewriter, 'file pattern')
     }
-    let(:source) {
-      '
-Factory.define :user do |user|
-end
-    '
-    }
+    let(:source) { <<~EOS }
+      Factory.define :user do |user|
+      end
+    EOS
+
     let(:node) { Parser::CurrentRuby.parse(source) }
     before do
       Rewriter::Instance.reset
@@ -25,13 +24,13 @@ end
         run = false
         type_in_scope = nil
         scope =
-          Rewriter::GotoScope.new instance, :caller do
+          Rewriter::GotoScope.new instance, :caller, :receiver do
             run = true
             type_in_scope = node.type
           end
         scope.process
         expect(run).to be_truthy
-        expect(type_in_scope).to eq :send
+        expect(type_in_scope).to eq :const
         expect(instance.current_node.type).to eq :block
       end
     end

data/synvert-core.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "erubis"
-  spec.add_runtime_dependency "parser", "~> 3.0.0"
+  spec.add_runtime_dependency "parser"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "guard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.33.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,16 +42,16 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +154,7 @@ files:
 - lib/synvert/core/rewriter/action/replace_action.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
 - lib/synvert/core/rewriter/action/replace_with_action.rb
+- lib/synvert/core/rewriter/any_value.rb
 - lib/synvert/core/rewriter/condition.rb
 - lib/synvert/core/rewriter/condition/if_exist_condition.rb
 - lib/synvert/core/rewriter/condition/if_only_exist_condition.rb
@@ -213,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.