synvert-core 1.35.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 241e9b40114c50b1dec1b86784fde026ed03ac64f2e38e314f00ed1f35a010c5
-  data.tar.gz: 521fee14550bd2eebb9e26d9aa1928bd4ae51cc43a88692c5337dad7ab32cc11
+  metadata.gz: 8e5f40c698306314082157a4b976ff37e9adf84bb81e1915b7ffd319cbac227a
+  data.tar.gz: 326fd1445561b81a70c9ed88ccd710c9103985f31e3349dccbc12688734b6630
 SHA512:
-  metadata.gz: 206b4e331e89760a0f47376401a48986b0ce2ec7e72d29cc566a93ae9b2341d7298a9738da3b9434c38a66d81b32bd6e109c9f52a0804d2575dcc0a8f46b2254
-  data.tar.gz: e42ec5540b5b3dab9688ef43d9872132ea8e78c33073aa8567e10dcfb3152e7c50b8d1d639b16d3a0bacd9bc088966fb32c915dfccb045c412b79552e37a3eec
+  metadata.gz: a296c2ea8fa640b117d409361dd7148bffaf63bf5ac7e7d90f636a83b40f6d32b2294a3bfd185b86bdc6a242179eed0ebf8325e78e9c6b90965932f97ed8358a
+  data.tar.gz: 5bfd5bf3f26f8a13dd595bb4428fa6c6a76a04e4d148cb1b45b286d2a437ca93ba608075edcafa8355f88fec7d7483e19ea0a312157c22bb007d320a0a50fb15

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "synvert"
+  ]
+}

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 2.0.0 (2024-04-28)
+
+* Add instance variable `Instance#current_parser`
+* Add callback and visit ast nodes
+
 ## 1.35.4 (2024-04-25)
 
 * Eval snippet on gist.github.com
@@ -166,7 +171,7 @@
 
 ## 1.26.3 (2023-05-13)
 
-* Fix haml and slim engine to support attribute and ruby evalidation in the same line
+* Fix haml and slim engine to support attribute and ruby evaluation in the same line
 * Fix ruby block in multi lins in haml and slim
 
 ## 1.26.2 (2023-05-10)
@@ -400,12 +405,12 @@
 ## 1.2.1 (2022-05-01)
 
 * Selector always after a node type in NQL
-* Define `pairs` method for `hash` ndoe
+* Define `pairs` method for `hash` node
 
 ## 1.2.0 (2022-04-29)
 
 * Remove comma in NQL array value
-* Parse pseduo class without selector in NQL
+* Parse pseudo class without selector in NQL
 * Parse multiple goto scope in NQL
 * Parse `nil?` in NQL
 
@@ -542,7 +547,7 @@
 
 ## 0.44.0 (2021-07-19)
 
-* Return rewrtier after executing snippet
+* Return rewriter after executing snippet
 * `left_value` and `right_value` support `or_asgn` node
 * `child_node_range` supports send `parentheses`
 
@@ -656,7 +661,7 @@
 
 ## 0.17.0 (2021-01-29)
 
-* Ignore `gem_spec` check if `Gemfile.lock` does not eixst
+* Ignore `gem_spec` check if `Gemfile.lock` does not exist
 
 ## 0.16.0 (2021-01-17)
 
@@ -714,10 +719,10 @@
 ## 0.7.0 (2014-09-29)
 
 * Add debug info for MethodNotSupported error.
-* Add left_value and right_vaue ext to ast node
+* Add left_value and right_value ext to ast node
 * Add arguments for def and defs nodes
 * Add name for arg and blockarg nodes
-* Remove trailing whitespaces in rewritten code
+* Remove trailing whitespace in rewritten code
 * Rewriter.available always returns a hash
 * Support ArgumentsNode in rewritten_source
 

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.35.4)
+    synvert-core (2.0.0)
       activesupport (< 7.0.0)
       node_mutation (>= 1.24.4)
       node_query (>= 1.15.2)
+      node_visitor (>= 1.0.1)
       parallel
       parser
       parser_node_ext (>= 1.3.2)
@@ -54,11 +55,12 @@ GEM
     nenv (0.3.0)
     node_mutation (1.24.4)
     node_query (1.15.2)
+    node_visitor (1.0.1)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     parser_node_ext (1.3.2)

data/README.md

@@ -6,52 +6,58 @@
 [![Build Status](https://github.com/synvert-hq/synvert-core-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/synvert-hq/synvert-core-ruby/actions/workflows/main.yml)
 [![Gem Version](https://img.shields.io/gem/v/synvert-core.svg)](https://rubygems.org/gems/synvert-core)
 
-Synvert core provides a set of DSLs to rewrite ruby code. e.g.
+Synvert core provides a set of DSLs to rewrite (find and replace) ruby code. e.g.
 
 ```ruby
-Synvert::Rewriter.new 'factory_bot', 'convert_factory_girl_to_factory_bot' do
-  description <<~EOS
-    It converts FactoryGirl to FactoryBot
+Synvert::Rewriter.new 'ruby', 'map_and_flatten_to_flat_map' do
+  configure(parser: Synvert::PARSER_PARSER)
 
-    ```ruby
-    require 'factory_girl'
-    require 'factory_girl_rails'
-    ```
-
-    =>
-
-    ```ruby
-    require 'factory_bot'
-    require 'factory_bot_rails'
-    ```
+  description <<~EOS
+    It converts `map` and `flatten` to `flat_map`
 
     ```ruby
-    FactoryGirl.create(:user)
-    FactoryGirl.build(:user)
+    enum.map do
+      # do something
+    end.flatten
     ```
 
     =>
 
     ```ruby
-    FactoryBot.create(:user)
-    FactoryBot.build(:user)
+    enum.flat_map do
+      # do something
+    end
     ```
   EOS
 
-  within_files Synvert::RAILS_TEST_FILES do
-    find_node '.const[name=FactoryGirl]' do
-      replace_with 'FactoryBot'
+  within_files Synvert::ALL_RUBY_FILES + Synvert::ALL_RAKE_FILES do
+    find_node '.send [receiver=.block [caller=.send[message=map]]] [message=flatten] [arguments.size=0]' do
+      group do
+        delete :message, :dot
+        replace 'receiver.caller.message', with: 'flat_map'
+      end
     end
+  end
+end
+```
 
-    find_node ".send[receiver=nil][message=require][arguments.size=1][arguments.first='factory_girl']" do
-      replace :arguments, with: "'factory_bot'"
-    end
+It also supports to add callbacks to visit ast nodes.
 
-    with_node type: 'send', receiver: nil, message: 'require', arguments: { size: 1, first: "'factory_girl_rails'" } do
-      replace :arguments, with: "'factory_bot_rails'"
+```ruby
+Synvert::Helper.new 'ruby/parse' do |options|
+  configure(parser: Synvert::PRISM_PARSER)
+
+  with_configurations(number_of_workers: 1) do
+    class_names = []
+    within_file Synvert::ALL_RUBY_FILES do
+      add_callback :class_node, at: 'start' do |node|
+        class_names << node.name.to_source
+      end
     end
+    # class_names is an array of class names
   end
 end
+
 ```
 
 Want to see more examples, check out [synvert-snippets-ruby](https://github.com/synvert-hq/synvert-snippets-ruby).
@@ -106,9 +112,13 @@ Actions:
 * [group](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#group-instance_method) - group actions
 * [add_action](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#add_action-instance_method) - add custom action
 
+Callbacks:
+
+* [add_callback](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#add_callback-instance_method) - add callback when visiting ast nodes
+
 Others:
 
-* [wrap_with_quotes](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#wrap_with_quotes-instance_method) - wrap string code with single or doulbe quotes
+* [wrap_with_quotes](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#wrap_with_quotes-instance_method) - wrap string code with single or double quotes
 * [add_leading_spaces](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#add_leading_spaces-instance_method) - add leading spaces before the string code
 
 

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

@@ -10,7 +10,7 @@ module Synvert::Core
     # @yield run when condition matches
     def initialize(instance, nql_or_rules, &block)
       @instance = instance
-      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.parser)
+      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.current_parser)
       @block = block
     end
 

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

@@ -22,6 +22,8 @@ module Synvert::Core
     # @yield block code to find nodes, match conditions and rewrite code.
     def initialize(rewriter, file_path, &block)
       @rewriter = rewriter
+      @current_parser = @rewriter.parser
+      @current_visitor = NodeVisitor.new(adapter: @current_parser)
       @actions = []
       @file_path = file_path
       @block = block
@@ -35,9 +37,11 @@ module Synvert::Core
 
     # @!attribute [r] file_path
     #   @return file path
+    # @!attribute [r] current_parser
+    #   @return current parser
     # @!attribute [rw] current_node
     #   @return current ast node
-    attr_reader :file_path
+    attr_reader :file_path, :current_parser
     attr_accessor :current_node
 
     # Process the instance.
@@ -52,7 +56,7 @@ module Synvert::Core
       5.times do
         source = read_source(absolute_file_path)
         encoded_source = Engine.encode(File.extname(file_path), source)
-        @current_mutation = NodeMutation.new(source, adapter: @rewriter.parser)
+        @current_mutation = NodeMutation.new(source, adapter: @current_parser)
         @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
         begin
           node = parse_code(@file_path, encoded_source)
@@ -61,6 +65,8 @@ module Synvert::Core
             instance_eval(&@block)
           end
 
+          @current_visitor.visit(node, self)
+
           result = @current_mutation.process
           if result.affected?
             @rewriter.add_affected_file(file_path)
@@ -83,7 +89,7 @@ module Synvert::Core
     def test
       absolute_file_path = File.join(Configuration.root_path, file_path)
       source = read_source(absolute_file_path)
-      @current_mutation = NodeMutation.new(source, adapter: @rewriter.parser)
+      @current_mutation = NodeMutation.new(source, adapter: @current_parser)
       encoded_source = Engine.encode(File.extname(file_path), source)
       @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
       begin
@@ -93,6 +99,8 @@ module Synvert::Core
           instance_eval(&@block)
         end
 
+        @current_visitor.visit(node, self)
+
         result = Configuration.test_result == 'new_source' ? @current_mutation.process : @current_mutation.test
         result.file_path = file_path
         result
@@ -111,13 +119,6 @@ module Synvert::Core
       @current_node
     end
 
-    # Get rewriter's parser.
-    #
-    # @return [String] parser
-    def parser
-      @rewriter.parser
-    end
-
     # Get current_mutation's adapter.
     #
     # @return [NodeMutation::Adapter]
@@ -438,6 +439,18 @@ module Synvert::Core
       @rewriter.add_warning Rewriter::Warning.new(self, message)
     end
 
+    # It adds a callback when visiting an ast node.
+    # @example
+    #   add_callback :class, at: 'start' do |node|
+    #     # do something when visiting class node
+    #   end
+    # @param node_type [Symbol] node type
+    # @param at [String] at start or end
+    # @yield block code to run when visiting the node
+    def add_callback(node_type, at: 'start', &block)
+      @current_visitor.add_callback(node_type, at: at, &block)
+    end
+
     # Wrap str string with single or doulbe quotes based on Configuration.single_quote.
     # @param str [String]
     # @return [String] quoted string
@@ -482,7 +495,7 @@ module Synvert::Core
     # @param encoded_source [String] encoded source code
     # @return [Node] ast node for file
     def parse_code(file_path, encoded_source)
-      case @rewriter.parser
+      case @current_parser
       when Synvert::SYNTAX_TREE_PARSER
         parse_code_by_syntax_tree(file_path, encoded_source)
       when Synvert::PRISM_PARSER
@@ -490,7 +503,7 @@ module Synvert::Core
       when Synvert::PARSER_PARSER
         parse_code_by_parser(file_path, encoded_source)
       else
-        raise Errors::ParserNotSupported.new("Parser #{@rewriter.parser} not supported")
+        raise Errors::ParserNotSupported.new("Parser #{@current_parser} not supported")
       end
     end
 

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

@@ -14,7 +14,7 @@ module Synvert::Core
       super(instance, &block)
 
       @options = { including_self: true, stop_at_first_match: false, recursive: true }.merge(options)
-      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.parser)
+      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.current_parser)
     end
 
     # Find out the matching nodes.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.35.4'
+    VERSION = '2.0.0'
   end
 end

data/lib/synvert/core.rb

@@ -5,6 +5,7 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'node_query'
 require 'node_mutation'
+require 'node_visitor'
 
 module Synvert
   module Core

data/spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb

@@ -11,7 +11,7 @@ module Synvert::Core
       end
     EOS
     let(:node) { Parser::CurrentRuby.parse(source) }
-    let(:instance) { double(current_node: node, parser: :parser) }
+    let(:instance) { double(current_node: node, current_parser: :parser) }
 
     describe '#process' do
       it 'call block if match anything' do

data/spec/synvert/core/rewriter/condition/unless_exist_condition_spec.rb

@@ -11,7 +11,7 @@ module Synvert::Core
       end
     EOS
     let(:node) { Parser::CurrentRuby.parse(source) }
-    let(:instance) { double(current_node: node, parser: :parser) }
+    let(:instance) { double(current_node: node, current_parser: :parser) }
 
     describe '#process' do
       it 'call block if match anything' do

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

@@ -264,6 +264,13 @@ module Synvert::Core
       instance.warn 'foobar'
     end
 
+    it 'parsers add_callback' do
+      instance.instance_variable_set(:@current_visitor, double)
+      block = proc {}
+      expect(instance.instance_variable_get(:@current_visitor)).to receive(:add_callback).with(:class_node, at: 'start', &block)
+      instance.add_callback(:class_node, at: 'start', &block)
+    end
+
     it 'adds action' do
       mutation = NodeMutation.new("", adapter: :parser)
       instance.instance_variable_set(:@current_mutation, mutation)
@@ -414,6 +421,27 @@ module Synvert::Core
         expect(File).to receive(:write).with('./app/views/posts/_form.html.slim', output)
         instance.process
       end
+
+      it 'visits with callbacks' do
+        names = []
+        instance =
+          Rewriter::Instance.new rewriter, 'app/models/synvert/user.rb' do
+            add_callback :module do |node|
+              names << node.name.to_source
+            end
+            add_callback :class do |node|
+              names << node.name.to_source
+            end
+          end
+        expect(File).to receive(:read).with('./app/models/synvert/user.rb', encoding: 'UTF-8').and_return(<<~EOF)
+          module Synvert
+            class User
+            end
+          end
+        EOF
+        instance.process
+        expect(names).to eq ['Synvert', 'User']
+      end
     end
 
     describe '#test' do
@@ -567,6 +595,27 @@ module Synvert::Core
           ),
         ]
       end
+
+      it 'visits with callbacks' do
+        names = []
+        instance =
+          Rewriter::Instance.new rewriter, 'app/models/synvert/user.rb' do
+            add_callback :module do |node|
+              names << node.name.to_source
+            end
+            add_callback :class do |node|
+              names << node.name.to_source
+            end
+          end
+        expect(File).to receive(:read).with('./app/models/synvert/user.rb', encoding: 'UTF-8').and_return(<<~EOF)
+          module Synvert
+            class User
+            end
+          end
+        EOF
+        instance.test
+        expect(names).to eq ['Synvert', 'User']
+      end
     end
 
     describe '#process_with_node' do

data/synvert-core-ruby.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activesupport", "< 7.0.0"
   spec.add_runtime_dependency "node_query", ">= 1.15.2"
   spec.add_runtime_dependency "node_mutation", ">= 1.24.4"
+  spec.add_runtime_dependency "node_visitor", ">= 1.0.1"
   spec.add_runtime_dependency "parser"
   spec.add_runtime_dependency "parser_node_ext", ">= 1.3.2"
   spec.add_runtime_dependency "syntax_tree"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.35.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.24.4
+- !ruby/object:Gem::Dependency
+  name: node_visitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +174,7 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".vscode/settings.json"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -234,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.