synvert-core 0.23.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03fc53b8833a45acfc449689b313108daf0e98c93dfd8e197fc9b3940e68816b
-  data.tar.gz: e9563c1fe7e358c748be50638a37ecfb7d155c8c4f4ed6dbcde1cac29ed74b99
+  metadata.gz: e3f85c5eb0a82ffb3447ad72ac9f901883a074b1f16c244176008a333b3e90cc
+  data.tar.gz: c13b895edc3ef7f9d126795933e2bf01267b0b912e2904a4481baff175eebca4
 SHA512:
-  metadata.gz: d053963cb0dfb4e92e515d965a7651d35d60d2d929e2dce1f46c8a32fc4a6101414cd8b47f185c0b43a10470a340614c2d6048184fb869c5e9e6b60a2f16ff27
-  data.tar.gz: 24307e135f10127b48403cfae69c89c4d71d112a513a83570ae7fd16c625882437e2efadefbd4b683fae6d9ce990ae0c1b104e7da3dbfe5f52a893e6f025df63
+  metadata.gz: 16ceb23eaf30909e4950cefbaae20b650f90320a496fee4a095a054dc7996fe91bfbcb79fc6252caa38f09b5998c687d4171bee050fc605cf2c8ee8ddac93c61
+  data.tar.gz: fc0202a47909b7bcffdd0e235c198419afcf2653f89bcd9abce626b412ab3c4a92a0bfbc71be8971873d15aeac85e4e2d0f80575ee44f75374d7c755af281c12

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## 0.26.1 (2021-03-31)
+
+* Support `:class` in `child_node_range`
+
+## 0.26.0 (2021-03-30)
+
+* attr_reader ruby_version and gem_spec
+* Add `replace` action
+
+## 0.25.0 (2021-03-23)
+
+* Use `Gem::Dependency#match?` to check gem version
+
+## 0.24.0 (2021-03-17)
+
+* Rename helper method `has_key?` to `key?`
+
 ## 0.23.0 (2021-03-14)
 
 * Accept a node as goto_node argument

data/lib/synvert/core/node_ext.rb

@@ -187,11 +187,11 @@ module Parser::AST
     # @param [Object] key value.
     # @return [Boolean] true if specified key exists.
     # @raise [Synvert::Core::MethodNotSupported] if calls on other node.
-    def has_key?(key)
+    def key?(key)
       if :hash == type
         children.any? { |pair_node| pair_node.key.to_value == key }
       else
-        raise Synvert::Core::MethodNotSupported, "has_key? is not handled for #{debug_info}"
+        raise Synvert::Core::MethodNotSupported, "key? is not handled for #{debug_info}"
       end
     end
 
@@ -205,7 +205,7 @@ module Parser::AST
         value_node = children.find { |pair_node| pair_node.key.to_value == key }
         value_node ? value_node.value : nil
       else
-        raise Synvert::Core::MethodNotSupported, "has_key? is not handled for #{debug_info}"
+        raise Synvert::Core::MethodNotSupported, "hash_value is not handled for #{debug_info}"
       end
     end
 
@@ -317,6 +317,33 @@ module Parser::AST
       loc.expression.line
     end
 
+    # Get the source range of child node.
+    #
+    # @param [String] name of child node.
+    # @return [Parser::Source::Range] source range of child node.
+    def child_node_range(child_name)
+      case type
+      when :class
+        case child_name
+        when :name
+          loc.name
+        when :parent_class
+          parent_class&.loc&.expression
+        end
+      when :send
+        case child_name
+        when :receiver
+          receiver&.loc&.expression
+        when :message
+          loc.selector
+        when :arguments
+          Parser::Source::Range.new('(string)', arguments.first.loc.expression.begin_pos, arguments.last.loc.expression.end_pos) unless arguments.empty?
+        end
+      else
+        raise Synvert::Core::MethodNotSupported, "child_node_range is not handled for #{evaluated.inspect}, child_name: #{child_name}"
+      end
+    end
+
     # Recursively iterate all child nodes of current node.
     #
     # @yield [child] Gives a child node.

data/lib/synvert/core/rewriter.rb

@@ -7,7 +7,7 @@ module Synvert::Core
   # which define the behavior what files and what codes to detect and rewrite to what code.
   #
   #   Synvert::Rewriter.new 'factory_girl_short_syntax', 'use FactoryGirl short syntax' do
-  #     if_gem 'factory_girl', {gte: '2.0.0'}
+  #     if_gem 'factory_girl', '>= 2.0.0'
   #
   #     within_files 'spec/**/*.rb' do
   #       with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
@@ -21,6 +21,7 @@ module Synvert::Core
     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'
+    autoload :ReplaceAction, 'synvert/core/rewriter/action/replace_action'
     autoload :ReplaceErbStmtWithExprAction, 'synvert/core/rewriter/action/replace_erb_stmt_with_expr_action'
     autoload :RemoveAction, 'synvert/core/rewriter/action/remove_action'
 
@@ -147,7 +148,11 @@ module Synvert::Core
     #   @return [Array<Synvert::Core::Rewriter::Warning>] warning messages.
     # @!attribute [r] affected_files
     #   @return [Set] affected fileds
-    attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files
+    # @!attribute [r] ruby_version
+    #   @return [Rewriter::RubyVersion] the ruby version
+    # @!attribute [r] gem_spec
+    #   @return [Rewriter::GemSpec] the gem spec
+    attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec
 
     # Initialize a rewriter.
     # When a rewriter is initialized, it is also registered.
@@ -225,10 +230,9 @@ module Synvert::Core
     # Parse if_gem dsl, it compares version of the specified gem.
     #
     # @param name [String] gem name.
-    # @param comparator [Hash] equal, less than or greater than specified version, e.g. {gte: '2.0.0'},
-    #   key can be eq, lt, gt, lte, gte or ne.
-    def if_gem(name, comparator)
-      @gem_spec = Rewriter::GemSpec.new(name, comparator)
+    # @param version [String] equal, less than or greater than specified version, e.g. '>= 2.0.0',
+    def if_gem(name, version)
+      @gem_spec = Rewriter::GemSpec.new(name, version)
     end
 
     # Parse within_files dsl, it finds specified files.

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # ReplaceAction to replace child node with code.
+  class Rewriter::ReplaceAction < Rewriter::Action
+    def initialize(instance, selector, with:)
+      @instance = instance
+      @selector = selector
+      @code = with
+      @node = @instance.current_node
+    end
+
+    # Begin position of code to replace.
+    #
+    # @return [Integer] begin position.
+    def begin_pos
+      @node.child_node_range(@selector).begin_pos
+    end
+
+    # End position of code to replace.
+    #
+    # @return [Integer] end position.
+    def end_pos
+      @node.child_node_range(@selector).end_pos
+    end
+
+    # The rewritten source code.
+    #
+    # @return [String] rewritten code.
+    def rewritten_code
+      rewritten_source
+    end
+  end
+end

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

@@ -3,22 +3,15 @@
 module Synvert::Core
   # GemSpec checks and compares gem version.
   class Rewriter::GemSpec
-    OPERATORS = { eq: '==', lt: '<', gt: '>', lte: '<=', gte: '>=', ne: '!=' }.freeze
+    attr_reader :name, :version
 
     # Initialize a gem_spec.
     #
     # @param name [String] gem name
-    # @param comparator [Hash] comparator to gem version, e.g. {eq: '2.0.0'},
-    #   comparator key can be eq, lt, gt, lte, gte or ne.
-    def initialize(name, comparator)
+    # @param version [String] gem version, e.g. '~> 2.0.0',
+    def initialize(name, version)
       @name = name
-      if comparator.is_a?(Hash)
-        @operator = comparator.keys.first
-        @version = Gem::Version.new comparator.values.first
-      else
-        @operator = :eq
-        @version = Gem::Version.new comparator
-      end
+      @version = version
     end
 
     # Check if the specified gem version in Gemfile.lock matches gem_spec comparator.
@@ -33,11 +26,7 @@ module Synvert::Core
 
       ENV['BUNDLE_GEMFILE'] = Configuration.path # make sure bundler reads Gemfile.lock in the correct path
       parser = Bundler::LockfileParser.new(File.read(gemfile_lock_path))
-      if spec = parser.specs.find { |spec| spec.name == @name }
-        Gem::Version.new(spec.version).send(OPERATORS[@operator], @version)
-      else
-        false
-      end
+      parser.specs.any? { |spec| Gem::Dependency.new(@name, @version).match?(spec) }
     end
   end
 end

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

@@ -251,6 +251,15 @@ module Synvert::Core
       @actions << Rewriter::ReplaceWithAction.new(self, code, options)
     end
 
+    # Parse replace with dsl, it creates a [Synvert::Core::Rewriter::ReplaceAction] to
+    # replace child node with code.
+    #
+    # @param selector [Symbol] selector name of child name.
+    # @param with [String] code need to be replaced with.
+    def replace(selector, with:)
+      @actions << Rewriter::ReplaceAction.new(self, selector, with: with)
+    end
+
     # Parse replace_erb_stmt_with_expr dsl, it creates a [Synvert::Core::Rewriter::ReplaceErbStmtWithExprAction] to
     # replace erb stmt code to expr code.
     def replace_erb_stmt_with_expr

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

@@ -3,6 +3,8 @@
 module Synvert::Core
   # GemSpec checks and compares gem version.
   class Rewriter::RubyVersion
+    attr_reader :version
+
     # Initialize a ruby_version.
     #
     # @param version [String] ruby version

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.23.0'
+    VERSION = '0.26.1'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -186,15 +186,15 @@ describe Parser::AST::Node do
     end
   end
 
-  describe '#has_key?' do
+  describe '#key?' do
     it 'gets true if key exists' do
       node = parse('{:foo => :bar}')
-      expect(node.has_key?(:foo)).to be_truthy
+      expect(node.key?(:foo)).to be_truthy
     end
 
     it 'gets false if key does not exist' do
       node = parse('{:foo => :bar}')
-      expect(node.has_key?('foo')).to be_falsey
+      expect(node.key?('foo')).to be_falsey
     end
   end
 
@@ -394,6 +394,62 @@ describe Parser::AST::Node do
     end
   end
 
+  describe '#child_node_range' do
+    context 'send node' do
+      it 'checks receiver' do
+        node = parse('foo.bar(test)')
+        range = node.child_node_range(:receiver)
+        expect(range.to_range).to eq(0...3)
+
+        node = parse('foobar(test)')
+        range = node.child_node_range(:receiver)
+        expect(range).to be_nil
+      end
+
+      it 'checks message' do
+        node = parse('foo.bar(test)')
+        range = node.child_node_range(:message)
+        expect(range.to_range).to eq(4...7)
+
+        node = parse('foobar(test)')
+        range = node.child_node_range(:message)
+        expect(range.to_range).to eq(0...6)
+      end
+
+      it 'checks arguments' do
+        node = parse('foo.bar(test)')
+        range = node.child_node_range(:arguments)
+        expect(range.to_range).to eq(8...12)
+
+        node = parse('foobar(test)')
+        range = node.child_node_range(:arguments)
+        expect(range.to_range).to eq(7...11)
+
+        node = parse('foo.bar')
+        range = node.child_node_range(:arguments)
+        expect(range).to be_nil
+      end
+    end
+
+    context 'class node' do
+      it 'checks name' do
+        node = parse('class Post < ActiveRecord::Base; end')
+        range = node.child_node_range(:name)
+        expect(range.to_range).to eq(6...10)
+      end
+
+      it 'checks parent_class' do
+        node = parse('class Post < ActiveRecord::Base; end')
+        range = node.child_node_range(:parent_class)
+        expect(range.to_range).to eq(13...31)
+
+        node = parse('class Post; end')
+        range = node.child_node_range(:parent_class)
+        expect(range).to be_nil
+      end
+    end
+  end
+
   describe '#rewritten_source' do
     let(:instance) {
       rewriter = Synvert::Rewriter.new('foo', 'bar')

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  describe Rewriter::ReplaceAction do
+    context 'replace with single line' do
+      subject {
+        source = "'slug from title'.gsub(' ', '_')"
+        node = Parser::CurrentRuby.parse(source)
+        instance = double(current_node: node)
+        Rewriter::ReplaceAction.new(instance, :message, with: 'tr')
+      }
+
+      it 'gets begin_pos' do
+        expect(subject.begin_pos).to eq "'slug from title'.".length
+      end
+
+      it 'gets end_pos' do
+        expect(subject.end_pos).to eq "'slug from title'.gsub".length
+      end
+
+      it 'gets rewritten_code' do
+        expect(subject.rewritten_code).to eq 'tr'
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ GEM
     it 'returns true if version in Gemfile.lock is greater than definition' do
       expect(File).to receive(:exist?).with('./Gemfile.lock').and_return(true)
       expect(File).to receive(:read).with('./Gemfile.lock').and_return(gemfile_lock_content)
-      gem_spec = Rewriter::GemSpec.new('ast', { gte: '1.0.0' })
+      gem_spec = Rewriter::GemSpec.new('ast', '~> 1.1')
       expect(gem_spec).to be_match
     end
 
@@ -35,7 +35,7 @@ GEM
     it 'returns false if version in Gemfile.lock is less than definition' do
       expect(File).to receive(:exist?).with('./Gemfile.lock').and_return(true)
       expect(File).to receive(:read).with('./Gemfile.lock').and_return(gemfile_lock_content)
-      gem_spec = Rewriter::GemSpec.new('ast', { gt: '1.2.0' })
+      gem_spec = Rewriter::GemSpec.new('ast', '> 1.2.0')
       expect(gem_spec).not_to be_match
     end
 

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

@@ -117,6 +117,11 @@ module Synvert::Core
       instance.replace_with 'create {{arguments}}'
     end
 
+    it 'parses replace with' do
+      expect(Rewriter::ReplaceAction).to receive(:new).with(instance, :message, with: 'test')
+      instance.replace :message, with: 'test'
+    end
+
     it 'parses remove' do
       expect(Rewriter::RemoveAction).to receive(:new).with(instance)
       instance.remove

data/spec/synvert/core/rewriter_spec.rb

@@ -29,10 +29,10 @@ module Synvert::Core
     end
 
     it 'parses if_gem' do
-      expect(Rewriter::GemSpec).to receive(:new).with('synvert', { gte: '1.0.0' })
+      expect(Rewriter::GemSpec).to receive(:new).with('synvert', '>= 1.0.0')
       rewriter =
         Rewriter.new 'group', 'name' do
-          if_gem 'synvert', { gte: '1.0.0' }
+          if_gem 'synvert', '>= 1.0.0'
         end
       rewriter.process
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,7 @@ files:
 - lib/synvert/core/rewriter/action/insert_action.rb
 - lib/synvert/core/rewriter/action/insert_after_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
 - lib/synvert/core/rewriter/action/replace_with_action.rb
 - lib/synvert/core/rewriter/condition.rb
@@ -173,6 +174,7 @@ files:
 - spec/synvert/core/rewriter/action/insert_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_after_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
 - spec/synvert/core/rewriter/action/replace_with_action_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb
@@ -222,6 +224,7 @@ test_files:
 - spec/synvert/core/rewriter/action/insert_action_spec.rb
 - spec/synvert/core/rewriter/action/insert_after_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
 - spec/synvert/core/rewriter/action/replace_with_action_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb