synvert-core 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd7dcc7605d1a18cc68ebfba86d5947960bd1320da0b5f7ae41abc8638fed62
-  data.tar.gz: 3023d5fb8a740da0ce0191bdd08f7435cc931e690714d2195391cf03586efa70
+  metadata.gz: 16de1af456b15373297aebe409711e1725bb329e3da7d4fa8d84023348ceb236
+  data.tar.gz: e034ccf44cfce96335f10a38d5aa36793faa08c84e8d75509fc658824cf64676
 SHA512:
-  metadata.gz: a3c7f43d890a491a7bb3356ec1695a79278a8c19cf61df4f296a1ea6562cbbcfa27764b36cbb22e06f9f27cd53157e2276392bba42856d58212fddb68e92ffac
-  data.tar.gz: 9959f0f8290157b96c83011ef770d59b40b845b236e0f8facf24cb6795cd7a837936a8969e380910df2892604dd25f569c66b9ff0c7aa5649e441b5ddf72b32a
+  metadata.gz: 3f745e87c308b417c5938c2731af00254abe5beba70472bca1ebfdf534127b7df8f6ab33261b8eb5d31d33deaa471927a780a14720f0ee406eea44f5a7e06495
+  data.tar.gz: ac2c35d21a4e6558b14c861966c6326446926bc27cc9e2d278757df31cf68a33142e62d47f9d40e5ec72c1d3fd8efde6574046e00506c9a12d0a800580a00023

data/.github/workflows/main.yml

@@ -1,17 +1,10 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: CI
+name: Test & deploy documentation
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:
@@ -29,3 +22,22 @@ jobs:
         bundler-cache: true
     - name: Run tests
       run: bundle exec rake
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: test
+    name: Update gh-pages to docs
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+      - name: Install required gem dependencies
+        run: gem install yard redcarpet github-markup --no-document
+      - name: Build YARD Ruby Documentation
+        run: yardoc --output-dir docs
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./docs

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 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
+
 ## 1.9.1 (2022-09-23)
 
 * Read / write absolute path

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.9.1)
+    synvert-core (1.10.0)
       activesupport (< 7.0.0)
       erubis
       node_mutation
@@ -49,10 +49,10 @@ GEM
     method_source (1.0.0)
     minitest (5.16.3)
     nenv (0.3.0)
-    node_mutation (1.4.1)
+    node_mutation (1.4.4)
       activesupport (< 7.0.0)
       erubis
-    node_query (1.6.0)
+    node_query (1.7.0)
       activesupport (< 7.0.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -85,7 +85,7 @@ GEM
     thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
   ruby

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.
@@ -68,24 +61,6 @@ module Synvert::Core
         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.
-      # @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 })
-        rewriter = fetch(group, name)
-        if options[:run_instance]
-          rewriter.process
-        else
-          rewriter.process_with_sandbox
-        end
-        rewriter
-      end
-
       # Get all available rewriters
       #
       # @return [Hash<String, Hash<String, Rewriter>>]
@@ -121,7 +96,12 @@ module Synvert::Core
     #   @return [Rewriter::RubyVersion] the ruby version
     # @!attribute [r] gem_spec
     #   @return [Rewriter::GemSpec] the gem spec
-    attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec
+    # @!attribute [r] 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.
@@ -138,7 +118,7 @@ module Synvert::Core
       @warnings = []
       @affected_files = Set.new
       @redo_until_no_change = false
-      @options = { run_instance: true, write_to_file: true }
+      @options = DEFAULT_OPTIONS.dup
       @test_results = []
       self.class.register(@group, @name, self)
     end
@@ -253,7 +233,7 @@ module Synvert::Core
         instance.process
       else
         results = instance.test
-        @test_results += results.select { |result| result.affected? }
+        merge_test_results(results)
       end
     end
 
@@ -302,22 +282,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}.
@@ -367,5 +359,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.1'
+    VERSION = '1.10.0'
   end
 end

data/lib/synvert/core.rb

@@ -19,6 +19,7 @@ module Synvert
     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,13 +213,32 @@ 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 '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
+
       it 'raises RewriterNotFound' do
         rewriter =
           Rewriter.new 'group', 'name' do
@@ -276,23 +289,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.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -133,6 +134,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
@@ -153,6 +155,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:
@@ -173,7 +176,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.
@@ -197,3 +200,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