synvert-core 0.63.1 → 0.64.0

data/lib/synvert/core/rewriter.rb

@@ -5,18 +5,8 @@ require 'fileutils'
 module Synvert::Core
   # Rewriter is the top level namespace in a snippet.
   #
-  # One Rewriter can contain one or many [Synvert::Core::Rewriter::Instance],
+  # One Rewriter checks if the depndency version matches, and it can contain one or many {Synvert::Core::Rewriter::Instance},
   # 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', '>= 2.0.0'
-  #
-  #     within_files 'spec/**/*.rb' do
-  #       with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
-  #         replace_with "create({{arguments}})"
-  #       end
-  #     end
-  #   end
   class Rewriter
     autoload :Action, 'synvert/core/rewriter/action'
     autoload :AppendAction, 'synvert/core/rewriter/action/append_action'
@@ -53,7 +43,7 @@ module Synvert::Core
     class << self
       # Execute the temporary rewriter without group and name.
       #
-      # @param block [Block] a block defines the behaviors of the rewriter.
+      # @yield defines the behaviors of the rewriter.
       def execute(&block)
         rewriter = Rewriter.new('', '', &block)
         rewriter.process
@@ -91,7 +81,7 @@ module Synvert::Core
       #
       # @param group [String] the rewriter group.
       # @param name [String] the rewriter name.
-      # @param sandbox [Boolean] if run in sandbox mode, default is false.
+      # @param sandbox [Boolean] if run in sandbox mode.
       # @return [Synvert::Core::Rewriter] the registered rewriter.
       # @raise [Synvert::Core::RewriterNotFound] if the registered rewriter is not found.
       def call(group, name, sandbox = false)
@@ -141,13 +131,12 @@ module Synvert::Core
     #   @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.
+    # Initialize a Rewriter.
+    # When a rewriter is initialized, it is already registered.
     #
     # @param group [String] group of the rewriter.
     # @param name [String] name of the rewriter.
-    # @param block [Block] a block defines the behaviors of the rewriter, block code won't be called when initialization.
-    # @return [Synvert::Core::Rewriter]
+    # @yield defines the behaviors of the rewriter, block code won't be called when initialization.
     def initialize(group, name, &block)
       @group = group
       @name = name
@@ -198,9 +187,12 @@ module Synvert::Core
     # DSL #
     #######
 
-    # Parse description dsl, it sets description of the rewrite.
+    # Parse +description+ dsl, it sets description of the rewrite.
     # Or get description.
-    #
+    # @example
+    #   Synvert::Rewriter.new 'rspec', 'use_new_syntax' do
+    #     description 'It converts rspec code to new syntax, it calls all rspec sub snippets.'
+    #   end
     # @param description [String] rewriter description.
     # @return rewriter description.
     def description(description = nil)
@@ -211,24 +203,34 @@ module Synvert::Core
       end
     end
 
-    # Parse if_ruby dsl, it checks if ruby version if greater than or equal to the specified ruby version.
-    #
-    # @param version, [String] specified ruby version.
+    # Parse +if_ruby+ dsl, it checks if ruby version is greater than or equal to the specified ruby version.
+    # @example
+    #   Synvert::Rewriter.new 'ruby', 'new_safe_navigation_operator' do
+    #     if_ruby '2.3.0'
+    #   end
+    # @param version [String] specified ruby version.
     def if_ruby(version)
       @ruby_version = Rewriter::RubyVersion.new(version)
     end
 
-    # Parse if_gem dsl, it compares version of the specified gem.
-    #
+    # Parse +if_gem+ dsl, it compares version of the specified gem.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'upgrade_5_2_to_6_0' do
+    #     if_gem 'rails', '>= 6.0'
+    #   end
     # @param name [String] gem name.
     # @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.
-    # It creates a [Synvert::Core::Rewriter::Instance] to rewrite code.
-    #
+    # Parse +within_files+ dsl, it finds specified files.
+    # It creates a {Synvert::Core::Rewriter::Instance} to rewrite code.
+    # @example
+    #   Synvert::Rewriter.new 'rspec', 'be_close_to_be_within' do
+    #     within_files '**/*.rb' do
+    #     end
+    #   end
     # @param file_patterns [String|Array<String>] string pattern or list of string pattern to find files, e.g. ['spec/**/*_spec.rb']
     # @param block [Block] the block to rewrite code in the matching files.
     def within_files(file_patterns, &block)
@@ -240,11 +242,18 @@ module Synvert::Core
       Rewriter::Instance.new(self, Array(file_patterns), &block).process
     end
 
-    # Parse within_file dsl, it finds a specifiled file.
+    # Parse +within_file+ dsl, it finds a specifiled file.
     alias within_file within_files
 
-    # Parses add_file dsl, it adds a new file.
-    #
+    # Parses +add_file+ dsl, it adds a new file.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'add_application_record' do
+    #     add_file 'app/models/application_record.rb', <<~EOS
+    #       class ApplicationRecord < ActiveRecord::Base
+    #         self.abstract_class = true
+    #       end
+    #     EOS
+    #   end
     # @param filename [String] file name of newly created file.
     # @param content [String] file body of newly created file.
     def add_file(filename, content)
@@ -257,13 +266,14 @@ module Synvert::Core
       end
 
       FileUtils.mkdir_p File.dirname(filepath)
-      File.open filepath, 'w' do |file|
-        file.write content
-      end
+      File.write(filepath, content)
     end
 
-    # Parses remove_file dsl, it removes a file.
-    #
+    # Parses +remove_file+ dsl, it removes a file.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'upgrade_4_0_to_4_1' do
+    #     remove_file 'config/initializers/secret_token.rb'
+    #   end
     # @param filename [String] file name.
     def remove_file(filename)
       return if @sandbox
@@ -272,26 +282,59 @@ module Synvert::Core
       File.delete(file_path) if File.exist?(file_path)
     end
 
-    # Parse add_snippet dsl, it calls anther rewriter.
-    #
+    # Parse +add_snippet+ dsl, it calls anther rewriter.
+    # @example
+    #   Synvert::Rewriter.new 'minitest', 'better_syntax' do
+    #     add_snippet 'minitest', 'assert_empty'
+    #     add_snippet 'minitest', 'assert_equal_arguments_order'
+    #     add_snippet 'minitest', 'assert_includes'
+    #     add_snippet 'minitest', 'assert_instance_of'
+    #     add_snippet 'minitest', 'assert_kind_of'
+    #     add_snippet 'minitest', 'assert_match'
+    #     add_snippet 'minitest', 'assert_nil'
+    #     add_snippet 'minitest', 'assert_operator'
+    #     add_snippet 'minitest', 'assert_path_exists'
+    #     add_snippet 'minitest', 'assert_predicate'
+    #     add_snippet 'minitest', 'assert_respond_to'
+    #     add_snippet 'minitest', 'assert_silent'
+    #     add_snippet 'minitest', 'assert_truthy'
+    #   end
     # @param group [String] group of another rewriter.
     # @param name [String] name of another rewriter.
     def add_snippet(group, name)
       @sub_snippets << self.class.call(group.to_s, name.to_s, @sandbox)
     end
 
-    # Parse helper_method dsl, it defines helper method for [Synvert::Core::Rewriter::Instance].
-    #
+    # Parse +helper_method+ dsl, it defines helper method for {Synvert::Core::Rewriter::Instance}.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'convert_active_record_dirty_5_0_to_5_1' do
+    #     helper_method :find_callbacks_and_convert do |callback_names, callback_changes|
+    #       # do anything, method find_callbacks_and_convert can be reused later.
+    #     end
+    #     within_files Synvert::RAILS_MODEL_FILES + Synvert::RAILS_OBSERVER_FILES do
+    #       find_callbacks_and_convert(before_callback_names, before_callback_changes)
+    #       find_callbacks_and_convert(after_callback_names, after_callback_changes)
+    #     end
+    #   end
     # @param name [String] helper method name.
-    # @param block [Block] helper method block.
+    # @yield helper method block.
     def helper_method(name, &block)
       @helpers << { name: name, block: block }
     end
 
-    # Parse todo dsl, it sets todo of the rewriter.
+    # Parse +todo+ dsl, it sets todo of the rewriter.
     # Or get todo.
-    #
-    # @param todo_list [String] rewriter todo.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'upgrade_3_2_to_4_0' do
+    #     todo <<~EOS
+    #       1. Rails 4.0 no longer supports loading plugins from vendor/plugins. You must replace any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, lib/my_plugin/* and add an appropriate initializer in config/initializers/my_plugin.rb.
+    #       2.  Make the following changes to your Gemfile.
+    #           gem 'sass-rails', '~> 4.0.0'
+    #           gem 'coffee-rails', '~> 4.0.0'
+    #           gem 'uglifier', '>= 1.3.0'
+    #     EOS
+    #   end
+    # @param todo [String] rewriter todo.
     # @return [String] rewriter todo.
     def todo(todo = nil)
       if todo
@@ -302,6 +345,10 @@ module Synvert::Core
     end
 
     # Rerun the snippet until no change.
+    # @example
+    #   Synvert::Rewriter.new 'ruby', 'nested_class_definition' do
+    #     redo_until_no_change
+    #   end
     def redo_until_no_change
       @redo_until_no_change = true
     end

data/lib/synvert/core/version.rb

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

data/lib/synvert/core.rb

@@ -18,7 +18,6 @@ module Synvert
     autoload :Rewriter, 'synvert/core/rewriter'
     autoload :Engine, 'synvert/core/engine'
     autoload :RewriterNotFound, 'synvert/core/exceptions'
-    autoload :GemfileLockNotFound, 'synvert/core/exceptions'
     autoload :MethodNotSupported, 'synvert/core/exceptions'
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -404,13 +404,6 @@ describe Parser::AST::Node do
     end
   end
 
-  describe '#to_s' do
-    it 'gets for mlhs node' do
-      node = parse('var.each { |(param1, param2)| }')
-      expect(node.arguments.first.to_s).to eq '(param1, param2)'
-    end
-  end
-
   describe '#filename' do
     it 'gets file name' do
       source = 'foobar'

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

@@ -10,9 +10,5 @@ module Synvert::Core
       instance = double(current_node: block_node)
       Rewriter::Action.new(instance, source)
     }
-
-    it 'gets line' do
-      expect(subject.line).to eq 2
-    end
   end
 end

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

@@ -46,7 +46,7 @@ module Synvert::Core
       expect(gem_spec).not_to be_match
     end
 
-    it 'raise Synvert::Core::GemfileLockNotFound if Gemfile.lock does not exist' do
+    it 'returns true if Gemfile.lock does not exist' do
       expect(File).to receive(:exist?).with(lock_path).and_return(false)
       gem_spec = Rewriter::GemSpec.new('ast', '1.1.0')
       expect(gem_spec).to be_match

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

@@ -15,7 +15,7 @@ module Synvert::Core
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false, direct: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.within_node(type: 'send', message: 'create', &block)
@@ -25,40 +25,30 @@ module Synvert::Core
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false, direct: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.with_node(type: 'send', message: 'create', &block)
     end
 
-    it 'parses within_node with recursive false' do
+    it 'parses within_node with stop_when_match true' do
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: true }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: true, direct: false }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
       instance.within_node({ type: 'send', message: 'create' }, { stop_when_match: true }, &block)
     end
 
-    it 'parses within_direct_node' do
+    it 'parses within_node with direct true' do
       scope = double
       block = proc {}
       expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { direct: true }, &block)
+        .with(instance, { type: 'send', message: 'create' }, { stop_when_match: false, direct: true }, &block)
         .and_return(scope)
       expect(scope).to receive(:process)
-      instance.within_direct_node(type: 'send', message: 'create', &block)
-    end
-
-    it 'parses with_direct_node' do
-      scope = double
-      block = proc {}
-      expect(Rewriter::WithinScope).to receive(:new)
-        .with(instance, { type: 'send', message: 'create' }, { direct: true }, &block)
-        .and_return(scope)
-      expect(scope).to receive(:process)
-      instance.with_direct_node(type: 'send', message: 'create', &block)
+      instance.within_node({ type: 'send', message: 'create' }, { direct: true }, &block)
     end
 
     it 'parses goto_node' do

data/synvert-core-ruby.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "3.10.0"
+  spec.add_development_dependency "rspec-mocks", "3.10.2" # rspec-mocks 3.10.3 breaks tests
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.63.1
+  version: 0.64.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,16 +112,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.2
 description: convert ruby code to better syntax automatically.
 email:
 - flyerhzm@gmail.com