synvert-core 0.21.2 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cb208eddfa8a9d304c434950ab7054f0836f52860bb6edaeebe0c421cf7647c
-  data.tar.gz: 3609ebb014a30b489761bdd27ce2a0236695636b4a51196eb7f7c122d59ff692
+  metadata.gz: 1aab544b0a434d8d34f445906448203f8ebf670f2e3fc14ac791163c1c059bbb
+  data.tar.gz: c913b856a8281cbd07ac6ca59fea393a633b3d920b0849b9a9f16dd897989b0f
 SHA512:
-  metadata.gz: b503e1bfe14c3e489465f71eb3edba0e5cc6ebaab0a860b14c6766208468951832eb61dd070353313b2bba3f0d3001ade5c9683e7de799a8a380db06ae7997eb
-  data.tar.gz: 80923462e716f67f4f278627be2ab765534c302cd2d572f78ee0e03a6cb7c8569bdc8182ee0550f05e41d3184184dca378e9a262da1eb8cf386e5c5f5e5c76f3
+  metadata.gz: cc0c4ea16085329d3385227885af3fc10fc925be5abe0bf408afa89ee95d5aba048225be488b8624dd0cdb7c6c0b4ed994f9d8c66aa8891c252eaf5784e3f06c
+  data.tar.gz: d3a6ac011d673c981cc59e34ad0bbcba5c5042a5bc20ea15a46d6c77b775d8f682d212951ec8503432473044e2f58c80342810fe9d4521cf405bf719e845bdd3

data/CHANGELOG.md

@@ -1,12 +1,25 @@
 # CHANGELOG
 
-## 0.21.2 (2021-02-26)
+## 0.25.1 (2021-03-24)
 
-* Fix `find_matching_nodes` if `current_node` is a `:begin` node
+* attr_reader ruby_version and gem_spec
 
-## 0.21.1 (2021-02-26)
+## 0.25.0 (2021-03-23)
 
-* Fix `find_matching_nodes` if `current_node` is a `Parser::AST::Node`
+* 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
+
+## 0.22.0 (2021-03-13)
+
+* Track `affected_files` for rewriter
+* Fix `find_matching_nodes` for `current_node`
 
 ## 0.21.0 (2021-02-25)
 

data/lib/synvert/core.rb

@@ -7,6 +7,7 @@ require 'parser/current'
 require 'ast'
 require 'active_support/core_ext/object'
 require 'erubis'
+require 'set'
 require 'synvert/core/node_ext'
 
 module Synvert

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
 
@@ -335,24 +335,22 @@ module Parser::AST
     # @param rules [Hash] rules to match.
     # @return true if matches.
     def match?(rules)
-      flat_hash(rules)
-        .keys
-        .all? do |multi_keys|
-          case multi_keys.last
-          when :any
-            actual_values = actual_value(self, multi_keys[0...-1])
-            expected = expected_value(rules, multi_keys)
-            actual_values.any? { |actual| match_value?(actual, expected) }
-          when :not
-            actual = actual_value(self, multi_keys[0...-1])
-            expected = expected_value(rules, multi_keys)
-            !match_value?(actual, expected)
-          else
-            actual = actual_value(self, multi_keys)
-            expected = expected_value(rules, multi_keys)
-            match_value?(actual, expected)
-          end
+      flat_hash(rules).keys.all? do |multi_keys|
+        case multi_keys.last
+        when :any
+          actual_values = actual_value(self, multi_keys[0...-1])
+          expected = expected_value(rules, multi_keys)
+          actual_values.any? { |actual| match_value?(actual, expected) }
+        when :not
+          actual = actual_value(self, multi_keys[0...-1])
+          expected = expected_value(rules, multi_keys)
+          !match_value?(actual, expected)
+        else
+          actual = actual_value(self, multi_keys)
+          expected = expected_value(rules, multi_keys)
+          match_value?(actual, expected)
         end
+      end
     end
 
     # Get rewritten source code.

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
@@ -145,7 +145,13 @@ module Synvert::Core
     #   @return [Array] helper methods.
     # @!attribute [r] warnings
     #   @return [Array<Synvert::Core::Rewriter::Warning>] warning messages.
-    attr_reader :group, :name, :sub_snippets, :helpers, :warnings
+    # @!attribute [r] affected_files
+    #   @return [Set] affected fileds
+    # @!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.
@@ -161,6 +167,7 @@ module Synvert::Core
       @helpers = []
       @sub_snippets = []
       @warnings = []
+      @affected_files = Set.new
       self.class.register(@group, @name, self)
     end
 
@@ -188,6 +195,13 @@ module Synvert::Core
       @warnings << warning
     end
 
+    # Add an affected file.
+    #
+    # @param file_path [String]
+    def add_affected_file(file_path)
+      @affected_files.add(file_path)
+    end
+
     #######
     # DSL #
     #######
@@ -215,10 +229,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_with_action.rb

@@ -23,11 +23,9 @@ module Synvert::Core
     def rewritten_code
       if rewritten_source.split("\n").length > 1
         new_code = []
-        rewritten_source
-          .split("\n")
-          .each_with_index { |line, index|
-            new_code << (index == 0 || !@options[:autoindent] ? line : indent(@node) + line)
-          }
+        rewritten_source.split("\n").each_with_index { |line, index|
+          new_code << (index == 0 || !@options[:autoindent] ? line : indent(@node) + line)
+        }
         new_code.join("\n")
       else
         rewritten_source

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

@@ -87,43 +87,41 @@ module Synvert::Core
     # and rewrite source code back to original file.
     def process
       file_pattern = File.join(Configuration.path, @file_pattern)
-      Dir
-        .glob(file_pattern)
-        .each do |file_path|
-          next if Configuration.skip_files.include? file_path
-
-          begin
-            conflict_actions = []
-            source = +self.class.file_source(file_path)
-            ast = self.class.file_ast(file_path)
-
-            @current_file = file_path
-
-            process_with_node ast do
-              begin
-                instance_eval(&@block)
-              rescue NoMethodError
-                puts @current_node.debug_info
-                raise
-              end
+      Dir.glob(file_pattern).each do |file_path|
+        next if Configuration.skip_files.include? file_path
+
+        begin
+          conflict_actions = []
+          source = +self.class.file_source(file_path)
+          ast = self.class.file_ast(file_path)
+
+          @current_file = file_path
+
+          process_with_node ast do
+            begin
+              instance_eval(&@block)
+            rescue NoMethodError
+              puts @current_node.debug_info
+              raise
             end
+          end
 
-            if @actions.length > 0
-              @actions.sort_by! { |action| action.send(@options[:sort_by]) }
-              conflict_actions = get_conflict_actions
-              @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
-              @actions = []
-
-              self.class.write_file(file_path, source)
+          if @actions.length > 0
+            @actions.sort_by! { |action| action.send(@options[:sort_by]) }
+            conflict_actions = get_conflict_actions
+            @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
-          rescue Parser::SyntaxError
-            puts "[Warn] file #{file_path} was not parsed correctly."
-            # do nothing, iterate next file
-          end while !conflict_actions.empty?
-        end
+            @actions = []
+
+            update_file(file_path, source)
+          end
+        rescue Parser::SyntaxError
+          puts "[Warn] file #{file_path} was not parsed correctly."
+          # do nothing, iterate next file
+        end while !conflict_actions.empty?
+      end
     end
 
     # Gets current node, it allows to get current node in block code.
@@ -312,5 +310,14 @@ module Synvert::Core
         source
       end
     end
+
+    # It updates a file with new source code.
+    #
+    # @param file_path [String] the file path
+    # @param source [String] the new source code
+    def update_file(file_path, source)
+      self.class.write_file(file_path, source)
+      @rewriter.add_affected_file(file_path)
+    end
   end
 end

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/rewriter/scope/goto_scope.rb

@@ -19,7 +19,7 @@ module Synvert::Core
       current_node = @instance.current_node
       return unless current_node
 
-      child_node = current_node.send @child_node_name
+      child_node = @child_node_name.is_a?(Parser::AST::Node) ? @child_node_name : current_node.send(@child_node_name)
       @instance.process_with_other_node child_node do
         @instance.instance_eval(&@block)
       end

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

@@ -46,8 +46,8 @@ module Synvert::Core
           current_node.children.each do |child_node|
             matching_nodes << child_node if child_node.match? @rules
           end
-        else
-          matching_nodes << current_node if current_node.match? @rules
+        elsif current_node.match? @rules
+          matching_nodes << current_node
         end
       else
         current_node.each do |child_node|

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '0.21.2'
+    VERSION = '0.25.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
 

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

@@ -243,6 +243,7 @@ end
         expect(File).to receive(:read).with('spec/models/post_spec.rb').and_return(output)
         instance.process
         instance.process
+        expect(rewriter.affected_files).to be_include('spec/models/post_spec.rb')
       end
     end
 

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.21.2
+  version: 0.25.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport