synvert-core 1.29.4 → 1.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9784d9012764a97bb61fea6c37d32b82832e9591b8065403a01b2f1e18e610
-  data.tar.gz: a7fcd9da422493f5e1b8d39fefe12050ef020b1b1580d99bfcbd3e6eb18e69ca
+  metadata.gz: a5923465a97b00d151c7877fb725f5f74c63975c9683d926a4bf14e2feae8fc8
+  data.tar.gz: 94ed7f17447b0d501243b6074f9b4c2e57b09c5954b013727dc052933ac5e8fc
 SHA512:
-  metadata.gz: 9718d0a8a344fb024dc6c778e6aa45a7aafbdb21eb627324cb21e083ac0705813344abc23af72cff45465d2651ed2497438365d1685f60ff0b130b6dfedcede5
-  data.tar.gz: 2bd452b4b303a2ee985c14f124074c09169dd19d2cc73041cf864298dd29543186645febee87b23017b4dbfc83a7fcafe08aae104c9d3886133b83b8b2769e91
+  metadata.gz: c0614ad3287376170341654f290599a0f3541dd26562124935c208d77be666a1073a439090731a42efe62806f4aac91238c0a5eaf79ce971515719ee34384863
+  data.tar.gz: 1335bdfaaa06f1d8f8cca811d3e0fd4a9d40ca1f1ac0597a42b110555be59976e299cf9147c785c8c8d4ad418251a7fa0c7f2de7967ef71d77c46cbf86548076

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 1.30.1 (2023-12-01)
+
+* It is `parser` option instead of `adapter`
+
+## 1.30.0 (2023-11-27)
+
+* Update `node_mutation` to 1.22.0
+* Update `node_query` to 1.14.1
+* Add `adapter` as `Rewriter::ReplaceErbStmtWithExprAction` parameter
+* Initialize `NodeQuery` and `NodeMutation` with `adapter`
+* Remove `ensure_current_adapter` as adapter is an instance variable of Rewriter
+
 ## 1.29.4 (2023-11-24)
 
 * Update `node_mutation` to 1.21.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.29.4)
+    synvert-core (1.30.1)
       activesupport (< 7.0.0)
       node_mutation (>= 1.21.6)
       node_query (>= 1.13.12)
@@ -50,8 +50,8 @@ GEM
     method_source (1.0.0)
     minitest (5.20.0)
     nenv (0.3.0)
-    node_mutation (1.21.6)
-    node_query (1.13.12)
+    node_mutation (1.22.0)
+    node_query (1.14.1)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)

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

@@ -8,8 +8,10 @@ module Synvert::Core
     # Initialize a ReplaceErbStmtWithExprAction.
     #
     # @param node [Synvert::Core::Rewriter::Node]
-    def initialize(node, erb_source)
-      super(node, nil)
+    # @param erb_source [String]
+    # @param adapter [NodeMutation::Adapter]
+    def initialize(node, erb_source, adapter:)
+      super(node, nil, adapter: adapter)
       @erb_source = erb_source
       @type = :insert
     end
@@ -25,7 +27,7 @@ module Synvert::Core
 
     # Calculate the begin the end positions.
     def calculate_position
-      @start = NodeMutation.adapter.get_start(@node)
+      @start = @adapter.get_start(@node)
       loop do
         @start -= 1
         break if @erb_source[@start] == '%'

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)
+      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.parser)
       @block = block
     end
 

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

@@ -35,9 +35,7 @@ module Synvert::Core
     #   @return file path
     # @!attribute [rw] current_node
     #   @return current ast node
-    # @!attribute [r] mutation_adapter
-    #   @return NodeMutation Adapter
-    attr_reader :file_path, :current_node, :mutation_adapter
+    attr_reader :file_path, :current_node
     attr_accessor :current_node
 
     # Process the instance.
@@ -51,9 +49,8 @@ module Synvert::Core
       loop do
         source = read_source(absolute_file_path)
         encoded_source = Engine.encode(File.extname(file_path), source)
-        @current_mutation = NodeMutation.new(source)
+        @current_mutation = NodeMutation.new(source, adapter: @rewriter.parser)
         @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
-        @mutation_adapter = NodeMutation.adapter
         begin
           node = parse_code(@file_path, encoded_source)
 
@@ -81,10 +78,9 @@ 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)
+      @current_mutation = NodeMutation.new(source, adapter: @rewriter.parser)
       encoded_source = Engine.encode(File.extname(file_path), source)
       @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source)
-      @mutation_adapter = NodeMutation.adapter
       begin
         node = parse_code(file_path, encoded_source)
 
@@ -108,6 +104,20 @@ module Synvert::Core
       @current_node
     end
 
+    # Get rewriter's adapter.
+    #
+    # @return [String] adapter
+    def parser
+      @rewriter.parser
+    end
+
+    # Gent current_mutation's adapter.
+    #
+    # @return [NodeMutation::Adapter]
+    def mutation_adapter
+      @current_mutation.adapter
+    end
+
     # Set current_node to node and process.
     #
     # @param node [Parser::AST::Node] node set to current_node
@@ -279,7 +289,7 @@ module Synvert::Core
     # @param to [String] where to insert, if it is nil, will insert to current node.
     # @param and_comma [Boolean] insert extra comma.
     def insert_after(code, to: nil, and_comma: false)
-      column = ' ' * NodeMutation.adapter.get_start_loc(@current_node, to).column
+      column = ' ' * @current_mutation.adapter.get_start_loc(@current_node, to).column
       @current_mutation.insert(@current_node, "\n#{column}#{code}", at: 'end', to: to, and_comma: and_comma)
     end
 
@@ -296,7 +306,7 @@ module Synvert::Core
     # @param to [String] where to insert, if it is nil, will insert to current node.
     # @param and_comma [Boolean] insert extra comma.
     def insert_before(code, to: nil, and_comma: false)
-      column = ' ' * NodeMutation.adapter.get_start_loc(@current_node, to).column
+      column = ' ' * @current_mutation.adapter.get_start_loc(@current_node, to).column
       @current_mutation.insert(@current_node, "#{code}\n#{column}", at: 'beginning', to: to, and_comma: and_comma)
     end
 
@@ -313,7 +323,7 @@ module Synvert::Core
     def replace_erb_stmt_with_expr
       absolute_file_path = File.join(Configuration.root_path, @file_path)
       erb_source = read_source(absolute_file_path)
-      action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node, erb_source)
+      action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node, erb_source, adapter: @current_mutation.adapter)
       add_action(action)
     end
 
@@ -480,7 +490,7 @@ module Synvert::Core
     # @param encoded_source [String] encoded source code
     # @return [Node] ast node for file
     def parse_code(file_path, encoded_source)
-      if @rewriter.syntax_tree_parser?
+      if @rewriter.parser == Synvert::SYNTAX_TREE_PARSER
         parse_code_by_syntax_tree(file_path, encoded_source)
       else
         parse_code_by_parser(file_path, encoded_source)

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)
+      @node_query = NodeQuery.new(nql_or_rules, adapter: instance.parser)
     end
 
     # Find out the matching nodes.

data/lib/synvert/core/rewriter.rb

@@ -129,9 +129,7 @@ module Synvert::Core
     # It will call the block.
     def process
       @affected_files = Set.new
-      ensure_current_adapter do
-        instance_eval(&@block)
-      end
+      instance_eval(&@block)
 
       process if !@affected_files.empty? && @redo_until_no_change # redo
     end
@@ -146,9 +144,7 @@ module Synvert::Core
     def test
       @options[:write_to_file] = false
       @affected_files = Set.new
-      ensure_current_adapter do
-        instance_eval(&@block)
-      end
+      instance_eval(&@block)
 
       if !@affected_files.empty? && @redo_until_no_change # redo
         test
@@ -186,8 +182,8 @@ module Synvert::Core
       @affected_files.add(file_path)
     end
 
-    def syntax_tree_parser?
-      @options[:parser] == Synvert::SYNTAX_TREE_PARSER
+    def parser
+      @options[:parser]
     end
 
     #######
@@ -199,20 +195,12 @@ module Synvert::Core
     #   configure({ parser: Synvert::PARSER_PARSER })
     #   configure({ strategy: 'allow_insert_at_same_position' })
     # @param options [Hash]
-    # @option adapter [String] Synvert::PARSER_PARSER or Synvert::SYNTAX_TREE_PARSER
+    # @option parser [String] Synvert::PARSER_PARSER or Synvert::SYNTAX_TREE_PARSER
     # @option strategy [String] 'allow_insert_at_same_position'
     def configure(options)
       @options = @options.merge(options)
       if options[:parser] && ![Synvert::PARSER_PARSER, Synvert::SYNTAX_TREE_PARSER].include?(options[:parser])
-        raise Errors::ParserNotSupported.new("Parser #{options[:adapter]} not supported")
-      end
-
-      if syntax_tree_parser?
-        NodeQuery.configure(adapter: NodeQuery::SyntaxTreeAdapter.new)
-        NodeMutation.configure(adapter: NodeMutation::SyntaxTreeAdapter.new)
-      else
-        NodeQuery.configure(adapter: NodeQuery::ParserAdapter.new)
-        NodeMutation.configure(adapter: NodeMutation::ParserAdapter.new)
+        raise Errors::ParserNotSupported.new("Parser #{options[:parser]} not supported")
       end
     end
 
@@ -417,18 +405,6 @@ module Synvert::Core
 
     private
 
-    # Ensure back to current adapter after running a rewriter.
-    def ensure_current_adapter
-      current_query_adapter = NodeQuery.adapter
-      current_mutation_adapter = NodeMutation.adapter
-      begin
-        yield
-      ensure
-        NodeQuery.configure(adapter: current_query_adapter)
-        NodeMutation.configure(adapter: current_mutation_adapter)
-      end
-    end
-
     # Handle one file.
     # @param file_patterns [String] file patterns to find files.
     # @yield [file_path] block to handle file.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.29.4'
+    VERSION = '1.30.1'
   end
 end

data/spec/support/parser_helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'parser/current'
+require 'parser_node_ext'
+
 module ParserHelper
   def parser_parse(code)
     Parser::CurrentRuby.parse code

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

@@ -8,8 +8,8 @@ module Synvert::Core
       subject {
         erb_source = "<% form_for post do |f| %>\n<% end %>"
         source = Engine::Erb.encode(erb_source)
-        node = Parser::CurrentRuby.parse(source).children.first
-        described_class.new(node, erb_source).process
+        node = parser_parse(source).children.first
+        described_class.new(node, erb_source, adapter: NodeMutation::ParserAdapter.new).process
       }
 
       it 'gets start' do
@@ -29,8 +29,8 @@ module Synvert::Core
       subject {
         erb_source = "<%form_for post do |f|%>\n<%end%>"
         source = Engine::Erb.encode(erb_source)
-        node = Parser::CurrentRuby.parse(source).children.first
-        described_class.new(node, erb_source).process
+        node = parser_parse(source).children.first
+        described_class.new(node, erb_source, adapter: NodeMutation::ParserAdapter.new).process
       }
 
       it 'gets start' do

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

@@ -3,17 +3,15 @@
 require 'spec_helper'
 
 module Synvert::Core
-  describe Rewriter::IfExistCondition do
-    let(:source) {
-      '
+  RSpec.describe Rewriter::IfExistCondition do
+    let(:source) { <<~EOS }
       RSpec.configure do |config|
         config.include EmailSpec::Helpers
         config.include EmailSpec::Methods
       end
-      '
-    }
+    EOS
     let(:node) { Parser::CurrentRuby.parse(source) }
-    let(:instance) { double(current_node: node) }
+    let(:instance) { double(current_node: node, parser: :parser) }
 
     describe '#process' do
       it 'call block if match anything' do

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

@@ -4,22 +4,20 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::IfOnlyExistCondition do
-    let(:source) {
-      '
+    let(:source) { <<~EOS }
       RSpec.configure do |config|
         config.include EmailSpec::Helpers
         config.include EmailSpec::Methods
       end
-      '
-    }
+    EOS
     let(:node) { Parser::CurrentRuby.parse(source) }
-    let(:instance) { double(current_node: node) }
+    let(:instance) { double(current_node: node, parser: :parser) }
 
     describe '#process' do
       it 'gets matching nodes' do
         source = ' RSpec.configure do |config| config.include EmailSpec::Helpers end '
         node = Parser::CurrentRuby.parse(source)
-        instance = double(current_node: node)
+        instance = double(current_node: node, parser: :parser)
         run = false
         condition =
           Rewriter::IfOnlyExistCondition.new instance,

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

@@ -4,16 +4,14 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::UnlessExistCondition do
-    let(:source) {
-      '
+    let(:source) { <<~EOS }
       RSpec.configure do |config|
         config.include EmailSpec::Helpers
         config.include EmailSpec::Methods
       end
-      '
-    }
+    EOS
     let(:node) { Parser::CurrentRuby.parse(source) }
-    let(:instance) { double(current_node: node) }
+    let(:instance) { double(current_node: node, parser: :parser) }
 
     describe '#process' do
       it 'call block if match anything' do

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

@@ -148,9 +148,8 @@ module Synvert::Core
     end
 
     it 'parses insert_after' do
-      instance.instance_variable_set(:@current_mutation, double)
+      expect(@current_mutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
       instance.current_node = double
-      expect(NodeMutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
       expect(instance.instance_variable_get(:@current_mutation)).to receive(:insert).with(
         instance.current_node,
         "\n  Foobar",
@@ -162,9 +161,8 @@ module Synvert::Core
     end
 
     it 'parses insert_before' do
-      instance.instance_variable_set(:@current_mutation, double)
+      expect(@current_mutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
       instance.current_node = double
-      expect(NodeMutation).to receive_message_chain(:adapter, :get_start_loc, :column).and_return(2)
       expect(instance.instance_variable_get(:@current_mutation)).to receive(:insert).with(
         instance.current_node,
         "Foobar\n  ",
@@ -176,7 +174,8 @@ module Synvert::Core
     end
 
     it 'parses replace_erb_stmt_with_expr' do
-      instance.instance_variable_set(:@current_mutation, double)
+      adapter = NodeMutation::ParserAdapter.new
+      instance.instance_variable_set(:@current_mutation, double(adapter: adapter))
       instance.current_node = double
       action = double
       erb_source = '<% form_for @post do |f| %><% end %>'
@@ -184,7 +183,8 @@ module Synvert::Core
       expect(instance.instance_variable_get(:@current_mutation)).to receive(:actions).and_return([])
       expect(Rewriter::ReplaceErbStmtWithExprAction).to receive(:new).with(
         instance.current_node,
-        erb_source
+        erb_source,
+        adapter: adapter
       ).and_return(action)
       expect(action).to receive(:process)
       instance.replace_erb_stmt_with_expr
@@ -275,7 +275,7 @@ module Synvert::Core
     end
 
     it 'adds action' do
-      mutation = NodeMutation.new("")
+      mutation = NodeMutation.new("", adapter: :parser)
       instance.instance_variable_set(:@current_mutation, mutation)
       action = double
       expect(action).to receive(:process).and_return(action)

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

@@ -5,7 +5,7 @@ require 'spec_helper'
 module Synvert::Core
   describe Rewriter::WithinScope do
     let(:instance) {
-      rewriter = Rewriter.new('foo', 'bar')
+      rewriter = Rewriter.new('foo', 'bar') { configure(parser: PARSER_PARSER) }
       Rewriter::Instance.new(rewriter, 'file pattern')
     }
     let(:source) { <<~EOS }

data/spec/synvert/core/rewriter_spec.rb

@@ -6,25 +6,20 @@ module Synvert::Core
   RSpec.describe Rewriter do
     describe '#configure' do
       it 'parses parser' do
-        running_query_adapter = nil
         running_mutation_adapter = nil
         rewriter =
           Rewriter.new 'group', 'name' do
             configure parser: 'syntax_tree'
 
             within_files '**/*.rb' do
-              running_query_adapter = NodeQuery.adapter
-              running_mutation_adapter = NodeMutation.adapter
+              running_mutation_adapter = mutation_adapter
             end
           end
         input = "class Foobar\nend"
         FakeFS do
           File.write("code.rb", input)
           rewriter.process
-          expect(running_query_adapter).to be_instance_of(NodeQuery::SyntaxTreeAdapter)
           expect(running_mutation_adapter).to be_instance_of(NodeMutation::SyntaxTreeAdapter)
-          expect(NodeQuery.adapter).to be_instance_of(NodeQuery::ParserAdapter)
-          expect(NodeMutation.adapter).to be_instance_of(NodeMutation::ParserAdapter)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.29.4
+  version: 1.30.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport