synvert-core 1.27.1 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a57aa5fe7a0dfc34c17b5afb0be7657f08b29e7efa7aceb85350a5d7571260
-  data.tar.gz: 6706bbbce5a521aaa00b625ae1c0052241485f7eb230f5c99af68466b0effc7e
+  metadata.gz: 5d42815151ad1672667f0bc09cc57083b0620722a8416f2d6e30ebb1f6faabe5
+  data.tar.gz: 51ebfcd1b6022a91e1739974d89c6172f7358ebb3ddae69132408a6f07b76564
 SHA512:
-  metadata.gz: 2b87be0f4fc6ce7aa88c96644182cb7c479a89104cee0a43779b1e2345cc1e24709e360970896890000042e2f80d8fd297eec435a499ebd28feb1abd283ff6f5
-  data.tar.gz: bc08baeaa494b5307428ec5e2ce4e88d639f8262200fed27d8b5dae4da646e5c0b470be3ceb7f6e55650b4fdcd0daefcb48ca921fafa43763ce34ed91c24e08c
+  metadata.gz: 2bf88532f763fa4c3e4b3c7f12d914ad383c838c8b99ca2faf897e50390e409f941b7b59a8f0dde7350d3c1d29bacc972c8d36abb5aee814ff2337eb2dfc9409
+  data.tar.gz: d5ebb445329da6a3b93d34174150238753b299e0a67b7600a0286e19971cb81a789f3a1017e78729439b68e6ceea0f8cf402cfd1e0eab2d51b360f8f5d6755d8

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.28.0 (2023-06-01)
+
+* Add `Synvert::Core::Helper`
+* Add `call_helper` dsl in rewriter
+
 ## 1.27.1 (2023-05-30)
 
 * Puts error message when rescue `Parser::SyntaxError`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.27.1)
+    synvert-core (1.28.0)
       activesupport (< 7.0.0)
       node_mutation (>= 1.18.2)
       node_query (>= 1.13.2)

data/README.md

@@ -69,6 +69,7 @@ DSLs are as follows
 * [remove_file](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter.html#remove_file-instance_method) - remove a file
 * [helper_method](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter.html#helper_method-instance_method) - define a helper method
 * [add_snippet](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter.html#add_snippet-instance_method) - call another rewriter
+* [call_helper](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter.html#call_helper-instance_method) - call a shared rewriter
 * [redo_until_no_change](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter.html#redo_until_no_change-instance_method) - run the snippet until no change
 
 Scopes:

data/lib/synvert/core/helper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Synvert::Core
+  # Helper is used to define shared snippet.
+  class Helper
+    attr_reader :name, :block
+
+    class << self
+      # Register a helper with its name.
+      #
+      # @param name [String] the unique rewriter name.
+      # @param helper [Synvert::Core::Helper] the helper to register.
+      def register(name, helper)
+        name = name.to_s
+        helpers[name] = helper
+      end
+
+      # Fetch a helper by name.
+      #
+      # @param name [String] rewrtier name.
+      # @return [Synvert::Core::Helper] the matching helper.
+      def fetch(name)
+        name = name.to_s
+        helpers[name]
+      end
+
+      # Get all available helpers
+      #
+      # @return [Hash<String, Synvert::Core::Helper>]
+      def availables
+        helpers
+      end
+
+      # Clear all registered helpers.
+      def clear
+        helpers.clear
+      end
+
+      private
+
+      def helpers
+        @helpers ||= {}
+      end
+    end
+
+    # Initialize a Helper.
+    # When a helper is initialized, it is already registered.
+    #
+    # @param name [String] name of the helper.
+    # @yield defines the behaviors of the helper, block code won't be called when initialization.
+    def initialize(name, &block)
+      @name = name
+      @block = block
+      self.class.register(name, self)
+    end
+  end
+end

data/lib/synvert/core/rewriter.rb

@@ -57,7 +57,7 @@ module Synvert::Core
 
       # Get all available rewriters
       #
-      # @return [Hash<String, Hash<String, Rewriter>>]
+      # @return [Hash<String, Hash<String, Synvert::Core::Rewriter>>]
       def availables
         rewriters
       end
@@ -357,6 +357,22 @@ module Synvert::Core
       @sub_snippets << rewriter
     end
 
+    # It calls a shared rewriter.
+    # @example
+    #   Synvert::Rewriter.new 'rails', 'upgrade_6_0_to_6_1' do
+    #     call_helper 'rails/set_load_defaults', options: { rails_version: '6.1' }
+    #     add_snippet '/Users/flyerhzm/.synvert-ruby/lib/rails/set_load_defaults.rb', options: { rails_version: '6.1' }
+    #     add_snippet 'https://github.com/xinminlabs/synvert-snippets-ruby/blob/main/lib/rails/set_load_defaults.rb', options: { rails_version: '6.1' }
+    #   end
+    # @param name [String] name of helper.
+    # @param options [Hash] options to pass to helper.
+    def call_helper(name, options: {})
+      helper = Synvert::Core::Helper.fetch(name) || Utils.eval_snippet(name)
+      return unless helper && helper.is_a?(Synvert::Core::Helper)
+
+      instance_exec(options, &helper.block)
+    end
+
     # It defines helper method for {Synvert::Core::Rewriter::Instance}.
     # @example
     #   Synvert::Rewriter.new 'rails', 'convert_active_record_dirty_5_0_to_5_1' do

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.27.1'
+    VERSION = '1.28.0'
   end
 end

data/lib/synvert/core.rb

@@ -11,6 +11,7 @@ module Synvert
   module Core
     autoload :Configuration, 'synvert/core/configuration'
     autoload :Rewriter, 'synvert/core/rewriter'
+    autoload :Helper, 'synvert/core/helper'
     autoload :Engine, 'synvert/core/engine'
     autoload :Utils, 'synvert/core/utils'
     autoload :Strategy, 'synvert/core/strategy'
@@ -20,6 +21,7 @@ end
 
 module Synvert
   Rewriter = Core::Rewriter
+  Helper = Core::Helper
   Strategy = Core::Strategy
 
   ALL_RUBY_FILES = %w[**/*.rb]

data/spec/synvert/core/helper_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert::Core
+  RSpec.describe Helper do
+    describe 'class methods' do
+      before :each do
+        described_class.clear
+      end
+
+      it 'registers and fetches' do
+        helper = described_class.new 'helper' do; end
+        expect(described_class.fetch('helper')).to eq helper
+      end
+
+      context 'available' do
+        it 'lists empty helpers' do
+          expect(described_class.availables).to eq({})
+        end
+
+        it 'registers and lists all available helpers' do
+          helper1 = Helper.new 'helper1' do; end
+          helper2 = Helper.new 'helper2' do; end
+          expect(Helper.availables).to eq({ 'helper1' => helper1, 'helper2' => helper2 })
+        end
+      end
+    end
+  end
+end

data/spec/synvert/core/rewriter_spec.rb

@@ -309,6 +309,47 @@ module Synvert::Core
       end
     end
 
+    describe 'parses call_helper' do
+      it 'eval helper by name' do
+        block_receiver = nil
+        block_options = {}
+        helper =
+          Synvert::Helper.new 'helper' do |options|
+            block_receiver = self.class.name
+            block_options = options
+          end
+        rewriter =
+          Rewriter.new 'group', 'rewriter' do
+            call_helper('helper', options: { foo: 'bar' })
+          end
+        rewriter.process
+        expect(block_receiver).to eq 'Synvert::Core::Rewriter'
+        expect(block_options).to eq(foo: 'bar')
+      end
+
+      it 'adds snippet by http url' do
+        expect(Utils).to receive(:remote_snippet_exists?).with(URI.parse('http://synvert.net/foo/bar.rb')).and_return(true)
+        expect_any_instance_of(URI::HTTP).to receive(:open).and_return(StringIO.new("Synvert::Helper.new 'helper' do\nend"))
+        rewriter =
+          Rewriter.new 'group', 'rewriter' do
+            call_helper 'http://synvert.net/foo/bar.rb'
+          end
+        rewriter.process
+        expect(Synvert::Helper.fetch('helper')).not_to be_nil
+      end
+
+      it 'adds snippet by file path' do
+        expect(File).to receive(:exist?).and_return(true)
+        expect(File).to receive(:read).and_return("Synvert::Helper.new 'helper' do\nend")
+        rewriter =
+          Rewriter.new 'group', 'rewriter' do
+            call_helper '/home/richard/foo/bar.rb'
+          end
+        rewriter.process
+        expect(Synvert::Helper.fetch('helper')).not_to be_nil
+      end
+    end
+
     it 'parses helper_method' do
       rewriter =
         Rewriter.new 'group', 'name' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.27.1
+  version: 1.28.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,6 +148,7 @@ files:
 - lib/synvert/core/engine/haml.rb
 - lib/synvert/core/engine/slim.rb
 - lib/synvert/core/errors.rb
+- lib/synvert/core/helper.rb
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
@@ -171,6 +172,7 @@ files:
 - spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/engine/haml_spec.rb
 - spec/synvert/core/engine/slim_spec.rb
+- spec/synvert/core/helper_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb
@@ -217,6 +219,7 @@ test_files:
 - spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/engine/haml_spec.rb
 - spec/synvert/core/engine/slim_spec.rb
+- spec/synvert/core/helper_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action_spec.rb
 - spec/synvert/core/rewriter/condition/if_exist_condition_spec.rb