synvert-core 1.9.2 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737e801df5a1d686045b99ff8038cd64bd2d39e96813fec4abdedb4473b6f943
-  data.tar.gz: 4adcef7e1eaff7297f35ce5b4df40a3d3edbe447c1354c2a0e7c5e279ec2b60f
+  metadata.gz: 966c0db8262c57bb94be47d44c5638c9c9607728da335b4bde9d39c49f7bc665
+  data.tar.gz: e2be9da04e58da3b236d03006883778f6e202d9bbb5a8fa922dd6339117a6a2a
 SHA512:
-  metadata.gz: 1ad2b3a8e7baa9d158e9a7bdbb0dbc9f46b5924ccd7c18867c41ba40192b2e3b57ae500e25edfdf7d0735161abb953bdb833aacbb0e2403321d692c1ae070dd1
-  data.tar.gz: aafdeaa9f19a732c6386bec43c3fafbd56398d9f543e316875d3fa7038a91b1fdc153c1d2c530259a2b8fb137fcecd1ff9ab936723d5bfbdd0cf71d7fd175d28
+  metadata.gz: 1e1f6a8a25817ebe46c03bdbf6e7982f559c426bf5537c2ae28549215ad77a03c45768af6b3f74ba84e34105c6d1e8c9cbb365cb1f431220b59028678c373dcd
+  data.tar.gz: 44f57f854c537825acb57217b216294f226df391b1eb185fd1558f463084a91ad9fcc296f54eba05c5b66e1d995a40c897d267fff662ff5bf85472d83d993be1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 1.10.1 (2022-10-09)
+
+* Do not reset `@options`
+* `Rewriter.fetch` does not raise error if rewriter not found
+
+## 1.10.0 (2022-10-09)
+
+* Eval snippet by http url, file path or snippet name
+* Remove `execute_command` option
+* Remove `Rewriter.call`
+* Remove `Rewriter.execute`
+
 ## 1.9.2 (2022-10-03)
 
 * Fix `test` in sub_snippets

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.9.2)
+    synvert-core (1.10.1)
       activesupport (< 7.0.0)
       erubis
       node_mutation

data/lib/synvert/core/rewriter.rb

@@ -8,6 +8,8 @@ module Synvert::Core
   # 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.
   class Rewriter
+    DEFAULT_OPTIONS = { run_instance: true, write_to_file: true }.freeze
+
     autoload :ReplaceErbStmtWithExprAction, 'synvert/core/rewriter/action/replace_erb_stmt_with_expr_action'
 
     autoload :Warning, 'synvert/core/rewriter/warning'
@@ -32,15 +34,6 @@ module Synvert::Core
     autoload :AnyValue, 'synvert/core/rewriter/any_value'
 
     class << self
-      # Execute the temporary rewriter without group and name.
-      #
-      # @yield defines the behaviors of the rewriter.
-      def execute(&block)
-        rewriter = Rewriter.new('', '', &block)
-        rewriter.process
-        rewriter
-      end
-
       # Register a rewriter with its group and name.
       #
       # @param group [String] the rewriter group.
@@ -58,35 +51,10 @@ module Synvert::Core
       # @param group [String] rewrtier group.
       # @param name [String] rewrtier name.
       # @return [Synvert::Core::Rewriter] the matching rewriter.
-      # @raise [Synvert::Core::RewriterNotFound] if the registered rewriter is not found.
       def fetch(group, name)
         group = group.to_s
         name = name.to_s
-        rewriter = rewriters.dig(group, name)
-        raise RewriterNotFound, "Rewriter #{group} #{name} not found" unless rewriter
-
-        rewriter
-      end
-
-      # Get a registered rewriter by group and name, then process that rewriter.
-      #
-      # @param group [String] the rewriter group.
-      # @param name [String] the rewriter name.
-      # @param options [Hash]
-      # @option options [Boolean] :run_instance (true) process the instance.
-      # @option options [String] :execute_command ('process') process or test the rewriter
-      # @return [Synvert::Core::Rewriter] the registered rewriter.
-      # @raise [Synvert::Core::RewriterNotFound] if the registered rewriter is not found.
-      def call(group, name, options = { run_instance: true, execute_command: 'process' })
-        rewriter = fetch(group, name)
-        if options[:execute_command] == 'test'
-          rewriter.test
-        elsif options[:run_instance]
-          rewriter.process
-        else
-          rewriter.process_with_sandbox
-        end
-        rewriter
+        rewriters.dig(group, name)
       end
 
       # Get all available rewriters
@@ -125,8 +93,11 @@ module Synvert::Core
     # @!attribute [r] gem_spec
     #   @return [Rewriter::GemSpec] the gem spec
     # @!attribute [r] test_results
-    #   @return [Object] the test results
+    #   @return [Array<Object>] the test results
+    # @!attribute [rw] options
+    #   @return [Hash] the rewriter options
     attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results
+    attr_accessor :options
 
     # Initialize a Rewriter.
     # When a rewriter is initialized, it is already registered.
@@ -143,7 +114,7 @@ module Synvert::Core
       @warnings = []
       @affected_files = Set.new
       @redo_until_no_change = false
-      @options = { run_instance: true, execute_command: 'process', write_to_file: true }
+      @options = DEFAULT_OPTIONS.dup
       @test_results = []
       self.class.register(@group, @name, self)
     end
@@ -161,26 +132,16 @@ module Synvert::Core
     # It will call the block but doesn't change any file.
     def process_with_sandbox
       @options[:run_instance] = false
-      begin
-        process
-      ensure
-        @options[:run_instance] = true
-      end
+      process
     end
 
     def test
       @options[:write_to_file] = false
-      @options[:execute_command] = 'test'
-      begin
-        @affected_files = Set.new
-        instance_eval(&@block)
+      @affected_files = Set.new
+      instance_eval(&@block)
 
-        if !@affected_files.empty? && @redo_until_no_change # redo
-          test
-        end
-      ensure
-        @options[:write_to_file] = true
-        @options[:execute_command] = 'process'
+      if !@affected_files.empty? && @redo_until_no_change # redo
+        test
       end
       @test_results
     end
@@ -260,7 +221,7 @@ module Synvert::Core
         instance.process
       else
         results = instance.test
-        @test_results += results.select { |result| result.affected? }
+        merge_test_results(results)
       end
     end
 
@@ -309,22 +270,34 @@ module Synvert::Core
     #   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'
+    #     add_snippet 'minitest/assert_instance_of'
+    #     add_snippet 'minitest/assert_kind_of'
+    #     add_snippet '/Users/flyerhzm/.synvert-ruby/lib/minitest/assert_match.rb'
+    #     add_snippet '/Users/flyerhzm/.synvert-ruby/lib/minitest/assert_nil.rb'
+    #     add_snippet 'https://github.com/xinminlabs/synvert-snippets-ruby/blob/main/lib/minitest/assert_silent.rb'
+    #     add_snippet 'https://github.com/xinminlabs/synvert-snippets-ruby/blob/main/lib/minitest/assert_truthy.rb'
     #   end
-    # @param group [String] group of another rewriter.
+    # @param group [String] group of another rewriter, if there's no name parameter, the group can be http url, file path or snippet name.
     # @param name [String] name of another rewriter.
-    def add_snippet(group, name)
-      @sub_snippets << self.class.call(group.to_s, name.to_s, @options)
+    def add_snippet(group, name = nil)
+      rewriter =
+        if name
+          Rewriter.fetch(group, name) || Utils.eval_snippet([group, name].join('/'))
+        else
+          Utils.eval_snippet(group)
+        end
+      return unless rewriter && rewriter.is_a?(Rewriter)
+
+      rewriter.options = @options
+      if !rewriter.options[:write_to_file]
+        results = rewriter.test
+        merge_test_results(results)
+      elsif rewriter.options[:run_instance]
+        rewriter.process
+      else
+        rewriter.process_with_sandbox
+      end
+      @sub_snippets << rewriter
     end
 
     # Parse +helper_method+ dsl, it defines helper method for {Synvert::Core::Rewriter::Instance}.
@@ -374,5 +347,11 @@ module Synvert::Core
     def redo_until_no_change
       @redo_until_no_change = true
     end
+
+    private
+
+    def merge_test_results(results)
+      @test_results += results.select { |result| result.affected? }
+    end
   end
 end

data/lib/synvert/core/utils.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Synvert::Core
+  class Utils
+    class << self
+      def eval_snippet(snippet_name)
+        if is_valid_url?(snippet_name)
+          uri = URI.parse(format_url(snippet_name))
+          eval(uri.open.read)
+        elsif is_valid_file?(snippet_name)
+          eval(File.read(snippet_name))
+        else
+          eval(File.read(File.join(default_snippets_home, 'lib', "#{snippet_name}.rb")))
+        end
+      end
+
+      private
+
+      def is_valid_url?(url)
+        /^http/.match?(url)
+      end
+
+      def is_valid_file?(path)
+        File.exist?(path)
+      end
+
+      def default_snippets_home
+        ENV['SYNVERT_SNIPPETS_HOME'] || File.join(ENV['HOME'], '.synvert-ruby')
+      end
+
+      def format_url(url)
+        convert_to_github_raw_url(url)
+      end
+
+      def convert_to_github_raw_url(url)
+        return url unless url.include?('//github.com/')
+
+        url.sub('//github.com/', '//raw.githubusercontent.com/').sub('/blob/', '/')
+      end
+    end
+  end
+end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.9.2'
+    VERSION = '1.10.1'
   end
 end

data/lib/synvert/core.rb

@@ -17,8 +17,7 @@ module Synvert
     autoload :Configuration, 'synvert/core/configuration'
     autoload :Rewriter, 'synvert/core/rewriter'
     autoload :Engine, 'synvert/core/engine'
-    autoload :RewriterNotFound, 'synvert/core/exceptions'
-    autoload :MethodNotSupported, 'synvert/core/exceptions'
+    autoload :Utils, 'synvert/core/utils'
   end
 end
 

data/spec/synvert/core/rewriter_spec.rb

@@ -4,12 +4,6 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter do
-    it '.execute' do
-      run = false
-      Rewriter.execute { run = true }
-      expect(run).to be_truthy
-    end
-
     it 'parses description' do
       rewriter =
         Rewriter.new 'group', 'name' do
@@ -209,7 +203,7 @@ module Synvert::Core
         rewriter1 = Rewriter.new 'group', 'rewriter1'
         rewriter2 =
           Rewriter.new 'group', 'rewriter2' do
-            add_snippet :group, :rewriter1
+            add_snippet 'group', 'rewriter1'
           end
         expect(rewriter1).to receive(:process)
         rewriter2.process
@@ -219,20 +213,30 @@ module Synvert::Core
         rewriter1 = Rewriter.new 'group', 'rewriter1'
         rewriter2 =
           Rewriter.new 'group', 'rewriter2' do
-            add_snippet :group, :rewriter1
+            add_snippet 'group', 'rewriter1'
           end
         expect(rewriter1).to receive(:process)
         rewriter2.process
         expect(rewriter2.sub_snippets).to eq [rewriter1]
       end
 
-      it 'raises RewriterNotFound' do
-        rewriter =
-          Rewriter.new 'group', 'name' do
-            add_snippet :group, :not_exist
-          end
-        expect { rewriter.process }
-          .to raise_error(RewriterNotFound)
+      it 'adds snippet by http url' do
+        expect_any_instance_of(URI).to receive(:open).and_return(StringIO.new("Rewriter.new 'group', 'sub_rewriter' do\nend"))
+        rewriter = Rewriter.new 'group', 'rewriter' do
+          add_snippet 'http://synvert.net/foo/bar.rb'
+        end
+        rewriter.process
+        expect(Rewriter.fetch('group', 'sub_rewriter')).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("Rewriter.new 'group', 'sub_rewriter' do\nend")
+        rewriter = Rewriter.new 'group', 'rewriter' do
+          add_snippet '/home/richard/foo/bar.rb'
+        end
+        rewriter.process
+        expect(Rewriter.fetch('group', 'sub_rewriter')).not_to be_nil
       end
     end
 
@@ -276,23 +280,6 @@ module Synvert::Core
         expect(Rewriter.fetch('group', 'rewriter')).to eq rewriter
       end
 
-      it 'registers and calls rewriter' do
-        rewriter = Rewriter.new 'group', 'rewriter'
-        expect(rewriter).to receive(:process)
-        Rewriter.call 'group', 'rewriter'
-      end
-
-      it 'registers and calls rewriter in sandbox mode' do
-        rewriter = Rewriter.new 'group', 'rewriter'
-        expect(rewriter).to receive(:process_with_sandbox)
-        Rewriter.call 'group', 'rewriter', run_instance: false
-      end
-
-      it 'raises RewriterNotFound if rewriter not found' do
-        expect { Rewriter.call 'group', 'rewriter' }
-          .to raise_error(RewriterNotFound)
-      end
-
       context 'available' do
         it 'lists empty rewriters' do
           expect(Rewriter.availables).to eq({})

data/spec/synvert/core/utils_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Synvert::Core
+  RSpec.describe Utils do
+    describe '.eval_snippet' do
+      it 'evals snippet by http url' do
+        expect_any_instance_of(URI).to receive(:open).and_return(StringIO.new("Rewriter.new 'group', 'name' do\nend"))
+        rewriter = described_class.eval_snippet('http://example.com/rewriter.rb')
+        expect(rewriter.group).to eq 'group'
+        expect(rewriter.name).to eq 'name'
+      end
+
+      it 'adds snippet by file path' do
+        expect(File).to receive(:exist?).and_return(true)
+        expect(File).to receive(:read).and_return("Rewriter.new 'group', 'name' do\nend")
+        rewriter = described_class.eval_snippet('/home/richard/foo/bar.rb')
+        expect(rewriter.group).to eq 'group'
+        expect(rewriter.name).to eq 'name'
+      end
+
+      it 'adds snippet by snippet name' do
+        expect(File).to receive(:exist?).and_return(false)
+        expect(File).to receive(:read).and_return("Rewriter.new 'group', 'name' do\nend")
+        rewriter = described_class.eval_snippet('/home/richard/foo/bar.rb')
+        expect(rewriter.group).to eq 'group'
+        expect(rewriter.name).to eq 'name'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,7 +116,6 @@ files:
 - lib/synvert/core/configuration.rb
 - lib/synvert/core/engine.rb
 - lib/synvert/core/engine/erb.rb
-- lib/synvert/core/exceptions.rb
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
 - lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb
@@ -134,6 +133,7 @@ files:
 - lib/synvert/core/rewriter/scope/query_scope.rb
 - lib/synvert/core/rewriter/scope/within_scope.rb
 - lib/synvert/core/rewriter/warning.rb
+- lib/synvert/core/utils.rb
 - lib/synvert/core/version.rb
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
@@ -154,6 +154,7 @@ files:
 - spec/synvert/core/rewriter/scope_spec.rb
 - spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb
+- spec/synvert/core/utils_spec.rb
 - synvert-core-ruby.gemspec
 homepage: https://github.com/xinminlabs/synvert-core-ruby
 licenses:
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.
@@ -198,3 +199,4 @@ test_files:
 - spec/synvert/core/rewriter/scope_spec.rb
 - spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb
+- spec/synvert/core/utils_spec.rb

data/lib/synvert/core/exceptions.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Synvert::Core
-  # Rewriter not found exception.
-  class RewriterNotFound < RuntimeError
-  end
-
-  # Method not supported exception.
-  class MethodNotSupported < RuntimeError
-  end
-end