synvert 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a942de5f8a6e4eec684585bf3bb37c1cadceeba0a0c580a3d94908e8ac73b584
-  data.tar.gz: 4414547d4d2bae57d34a3616bae182d450c14e0cf5dffc4a4c3e0d63f4b30dce
+  metadata.gz: 202949a760e4597b388d3f01804eac78e1caa59f1bcf54af018923e8e70e57ac
+  data.tar.gz: 2a9122faffaabade6bfd688ece159012e14da7699f3ab40e458b417a8e5568a6
 SHA512:
-  metadata.gz: 7555cf4ad97597997620a17ff843e53fffe7dec9e8dc8c7e48e0707a32105204a8fc651849d55c9784461a264aa6bb7eac180efc7bea6fa960b9eb8280d80a8f
-  data.tar.gz: dfd3b9c58df5508c651c99074f4399e90dc4aef1e188720c0d46bcfc4afdaa757847e6353e635cd7d5f19bb3a8095f8f92ab2602225644e36b4fe08d421c577e
+  metadata.gz: 1a0c7ce37d608c40fe040d1ae59323e97bf34531e982f0123ef1be5381d4e480c5523dd1947f71eeaf781e1ff47351243d67e69503265917b7f0f3d08387b13e
+  data.tar.gz: 3b2f3add6f28774ae73f1ad2ad517cef9920654311ba9451268459a743c7de9621bf2dcaa6ba0e2d36a648e9be9e487e8a1ec969d3d132b4b6010281fe243b4f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 1.5.0 (2023-10-28)
+
+* Update `synvert-core` to 1.29.3
+* Remove `bin/synvert`
+* Add `guard` for test
+* Abstract `Synvert::Command`
+
+## 1.4.5 (2023-07-03)
+
+* Update `synvert-core` to 1.28.3
+
 ## 1.4.6 (2023-07-03)
 
 * Read helpers before execute/test/run a snippet

data/Gemfile

@@ -5,4 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in synvert.gemspec
 gemspec
 
-gem 'coveralls', require: false
+gem 'guard'
+gem 'guard-rspec'
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    synvert (1.4.6)
-      synvert-core (>= 1.28.0)
+    synvert (1.5.0)
+      synvert-core (>= 1.29.3)
 
 GEM
   remote: https://rubygems.org/
@@ -13,36 +13,53 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    coderay (1.1.3)
     concurrent-ruby (1.2.2)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
-    crack (0.4.5)
-      rexml
     diff-lcs (1.4.4)
-    docile (1.4.0)
-    hashdiff (1.0.1)
+    ffi (1.16.3)
+    formatador (1.1.0)
+    guard (2.18.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.9)
+    method_source (1.0.0)
     minitest (5.18.0)
-    node_mutation (1.18.3)
-    node_query (1.13.2)
+    nenv (0.3.0)
+    node_mutation (1.21.4)
+    node_query (1.13.12)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
-    parser_node_ext (1.1.1)
+    parser_node_ext (1.2.1)
       parser
     prettier_print (1.2.1)
-    public_suffix (4.0.6)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.6)
-    rexml (3.2.5)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -56,48 +73,34 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sync (0.5.0)
+    shellany (0.0.1)
     syntax_tree (6.1.1)
       prettier_print (>= 1.2.0)
-    syntax_tree_ext (0.3.1)
+    syntax_tree_ext (0.6.4)
       syntax_tree
-    synvert-core (1.28.0)
+    synvert-core (1.29.3)
       activesupport (< 7.0.0)
-      node_mutation (>= 1.18.2)
-      node_query (>= 1.13.2)
+      node_mutation (>= 1.21.4)
+      node_query (>= 1.13.12)
       parallel
       parser
-      parser_node_ext (>= 1.1.1)
+      parser_node_ext (>= 1.2.1)
       syntax_tree
-      syntax_tree_ext (>= 0.3.1)
-    term-ansicolor (1.7.1)
-      tins (~> 1.0)
-    thor (1.1.0)
-    tins (1.29.1)
-      sync
+      syntax_tree_ext (>= 0.6.4)
+    thor (1.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.6.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  coveralls
+  guard
+  guard-rspec
   rake
   rspec
   synvert!
-  webmock
 
 BUNDLED WITH
    2.4.7

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/lib/synvert/cli.rb

@@ -28,30 +28,35 @@ module Synvert
 
       case @options[:command]
       when 'list'
-        read_rewriters
-        list_available_rewriters
+        Command.read_rewriters
+        Command.list_available_rewriters(@options[:foramt])
       when 'open'
-        open_rewriter
+        Command.open_rewriter(@options[:snippet_name])
       when 'query'
-        read_rewriters
-        query_available_rewriters
+        Command.read_rewriters
+        Command.query_available_rewriters
       when 'show'
-        show_rewriter
+        Command.show_rewriter(@options[:snippet_name])
       when 'sync'
-        sync_snippets
+        Command.sync_snippets
       when 'generate'
-        generate_snippet
+        Comamnd.generate_snippet(@options[:snippet_name])
       when 'execute'
-        read_helpers
-        execute_snippet(@options[:execute_command])
+        Command.read_helpers
+        rewriter = eval_snippet_name_by_input(STDIN.read)
+        if @options[:execute_command] == 'test'
+          Comamnd.test_snippet(rewriter)
+        else
+          Comamnd.run_snippet(rewriter, @options[:format])
+        end
       when 'test'
-        read_helpers
+        Command.read_helpers
         rewriter = Synvert::Core::Utils.eval_snippet(@options[:snippet_name])
-        test_snippet(rewriter)
+        Command.test_snippet(rewriter)
       when 'run'
-        read_helpers
+        Command.read_helpers
         rewriter = Synvert::Core::Utils.eval_snippet(@options[:snippet_name])
-        run_snippet(rewriter)
+        Command.run_snippet(rewriter, @options[:format])
       else
         # nothing to do
       end
@@ -153,214 +158,9 @@ module Synvert
       end
     end
 
-    # read all rewriters.
-    def read_rewriters
-      Dir.glob(File.join(default_snippets_home, 'lib/**/*.rb')).each { |file| require file }
-    end
-
-    # read all helpers.
-    def read_helpers
-      Dir.glob(File.join(default_snippets_home, 'lib/helpers/**/*.rb')).each { |file| require file }
-    end
-
-    # List and print all available rewriters.
-    def list_available_rewriters
-      if Core::Rewriter.availables.empty?
-        puts "There is no snippet under #{default_snippets_home}, please run `synvert-ruby --sync` to fetch snippets."
-        return
-      end
-
-      if plain_output?
-        Core::Rewriter.availables.each do |group, rewriters|
-          puts group
-          rewriters.each do |name, _rewriter|
-            puts '    ' + name
-          end
-        end
-        puts
-      elsif json_output?
-        output = []
-        Core::Rewriter.availables.each do |group, rewriters|
-          rewriters.each do |name, rewriter|
-            rewriter.process_with_sandbox
-            sub_snippets =
-              rewriter.sub_snippets.map { |sub_snippet|
-                { group: sub_snippet.group, name: sub_snippet.name }
-              }
-            item = { group: group, name: name, description: rewriter.description, sub_snippets: sub_snippets }
-            item[:ruby_version] = rewriter.ruby_version.version if rewriter.ruby_version
-            item[:gem_spec] = { name: rewriter.gem_spec.name, version: rewriter.gem_spec.version } if rewriter.gem_spec
-            output << item
-          end
-        end
-
-        puts output.to_json
-      end
-    end
-
-    # Open one rewriter.
-    def open_rewriter
-      editor = [ENV['SYNVERT_EDITOR'], ENV['EDITOR']].find { |e| !e.nil? && !e.empty? }
-      return puts 'To open a synvert snippet, set $EDITOR or $SYNVERT_EDITOR' unless editor
-
-      path = File.expand_path(File.join(default_snippets_home, "lib/#{@options[:snippet_name]}.rb"))
-      if File.exist?(path)
-        system editor, path
-      else
-        puts "Can't run #{editor} #{path}"
-      end
-    end
-
-    # Query and print available rewriters.
-    def query_available_rewriters
-      Core::Rewriter.availables.each do |group, rewriters|
-        if group.include? @options[:query]
-          puts group
-          rewriters.each do |name, _rewriter|
-            puts '    ' + name
-          end
-        elsif rewriters.keys.any? { |name| name.include? @options[:query] }
-          puts group
-          rewriters.each do |name, _rewriter|
-            puts '    ' + name if name.include?(@options[:query])
-          end
-        end
-      end
-      puts
-    end
-
-    # Show and print one rewriter.
-    def show_rewriter
-      path = File.expand_path(File.join(default_snippets_home, "lib/#{@options[:snippet_name]}.rb"))
-      if File.exist?(path)
-        puts File.read(path)
-      else
-        puts "snippet #{@options[:snippet_name]} not found"
-      end
-    end
-
-    # sync snippets
-    def sync_snippets
-      Snippet.new(default_snippets_home).sync
-      puts 'synvert snippets are synced'
-    end
-
     # eval snippet name by user input
     def eval_snippet_name_by_input(input)
       eval(input)
     end
-
-    # run a snippet
-    def run_snippet(rewriter)
-      if plain_output?
-        puts "===== #{rewriter.group}/#{rewriter.name} started ====="
-        rewriter.process
-        rewriter.warnings.each do |warning|
-          puts '[Warn] ' + warning.message
-        end
-        puts "===== #{rewriter.group}/#{rewriter.name} done ====="
-      elsif json_output?
-        rewriter.process
-        output = {
-          affected_files: rewriter.affected_files.union(rewriter.sub_snippets.sum(Set.new, &:affected_files)).to_a,
-          warnings: rewriter.warnings.union(rewriter.sub_snippets.sum([], &:warnings))
-        }
-        puts output.to_json
-      end
-    rescue StandardError => e
-      if ENV['DEBUG']
-        puts e.backtrace.join("\n")
-      end
-      if plain_output?
-        puts "Error: #{e.message}"
-      else
-        puts({ error: e.message }.to_json)
-      end
-      raise
-    end
-
-    # test a snippet
-    def test_snippet(rewriter)
-      results = rewriter.test
-      puts results.to_json
-    rescue StandardError => e
-      if ENV['DEBUG']
-        puts e.backtrace.join("\n")
-      end
-      puts({ error: e.message }.to_json)
-      raise
-    end
-
-    # execute snippet
-    def execute_snippet(execute_command)
-      rewriter = eval_snippet_name_by_input(STDIN.read)
-      if execute_command == 'test'
-        test_snippet(rewriter)
-      else
-        run_snippet(rewriter)
-      end
-    end
-
-    # generate a new snippet
-    def generate_snippet
-      group, name = @options[:snippet_name].split('/')
-      FileUtils.mkdir_p("lib/#{group}")
-      FileUtils.mkdir_p("spec/#{group}")
-      lib_content = <<~EOF
-        # frozen_string_literal: true
-
-        Synvert::Rewriter.new '#{group}', '#{name}' do
-          description <<~EOS
-            It converts Foo to Bar
-
-            ```ruby
-            Foo
-            ```
-
-            =>
-
-            ```ruby
-            Bar
-            ```
-          EOS
-
-          within_files '**/*.rb' do
-            with_node type: 'const', to_source: 'Foo' do
-              replace_with 'Bar'
-            end
-          end
-        end
-      EOF
-      spec_content = <<~EOF
-        # frozen_string_literal: true
-
-        require 'spec_helper'
-
-        RSpec.describe 'Convert Foo to Bar' do
-          let(:rewriter_name) { '#{group}/#{name}' }
-          let(:fake_file_path) { 'foobar.rb' }
-          let(:test_content) { 'Foo' }
-          let(:test_rewritten_content) { 'Bar' }
-
-          include_examples 'convertable'
-        end
-      EOF
-      File.write("lib/#{group}/#{name}.rb", lib_content)
-      File.write("spec/#{group}/#{name}_spec.rb", spec_content)
-    end
-
-    def default_snippets_home
-      # ENV['HOME'] may use \ as file separator,
-      # but File.join always uses / as file separator.
-      ENV['SYNVERT_SNIPPETS_HOME'] || File.join(ENV['HOME'].gsub("\\", "/"), '.synvert-ruby')
-    end
-
-    def plain_output?
-      @options[:format] == 'plain'
-    end
-
-    def json_output?
-      @options[:format] == 'json'
-    end
   end
 end

data/lib/synvert/command.rb

@@ -0,0 +1,203 @@
+# frozen_stirng_literal: true
+
+module Synvert
+  class Command
+    class << self
+      # sync snippets
+      def sync_snippets
+        if File.exist?(default_snippets_home)
+          Dir.chdir(default_snippets_home) do
+            Kernel.system('git checkout . && git pull --rebase')
+          end
+        else
+          Kernel.system("git clone https://github.com/xinminlabs/synvert-snippets-ruby.git #{default_snippets_home}")
+        end
+        puts 'synvert snippets are synced'
+      end
+
+      # read all rewriters.
+      def read_rewriters
+        Dir.glob(File.join(default_snippets_home, 'lib/**/*.rb')).each { |file| require file }
+      end
+
+      # read all helpers.
+      def read_helpers
+        Dir.glob(File.join(default_snippets_home, 'lib/helpers/**/*.rb')).each { |file| require file }
+      end
+
+      # Open one rewriter.
+      def open_rewriter(snippet_name)
+        editor = [ENV['SYNVERT_EDITOR'], ENV['EDITOR']].find { |e| !e.nil? && !e.empty? }
+        return puts 'To open a synvert snippet, set $EDITOR or $SYNVERT_EDITOR' unless editor
+
+        path = File.expand_path(File.join(default_snippets_home, "lib/#{snippet_name}.rb"))
+        if File.exist?(path)
+          system editor, path
+        else
+          puts "Can't run #{editor} #{path}"
+        end
+      end
+
+      # List and print all available rewriters.
+      def list_available_rewriters(format)
+        if Core::Rewriter.availables.empty?
+          puts "There is no snippet under #{default_snippets_home}, please run `synvert-ruby --sync` to fetch snippets."
+          return
+        end
+
+        if format == 'json'
+          puts available_rewriters.to_json
+        else
+          Core::Rewriter.availables.each do |group, rewriters|
+            puts group
+            rewriters.each do |name, _rewriter|
+              puts '    ' + name
+            end
+          end
+          puts
+        end
+      end
+
+      def available_rewriters
+        output = []
+        Core::Rewriter.availables.each do |group, rewriters|
+          rewriters.each do |name, rewriter|
+            rewriter.process_with_sandbox
+            sub_snippets =
+              rewriter.sub_snippets.map { |sub_snippet|
+                { group: sub_snippet.group, name: sub_snippet.name }
+              }
+            item = { group: group, name: name, description: rewriter.description, sub_snippets: sub_snippets }
+            item[:ruby_version] = rewriter.ruby_version.version if rewriter.ruby_version
+            item[:gem_spec] = { name: rewriter.gem_spec.name, version: rewriter.gem_spec.version } if rewriter.gem_spec
+            output << item
+          end
+        end
+        output
+      end
+
+      # Query and print available rewriters.
+      def query_available_rewriters
+        Core::Rewriter.availables.each do |group, rewriters|
+          if group.include? @options[:query]
+            puts group
+            rewriters.each do |name, _rewriter|
+              puts '    ' + name
+            end
+          elsif rewriters.keys.any? { |name| name.include? @options[:query] }
+            puts group
+            rewriters.each do |name, _rewriter|
+              puts '    ' + name if name.include?(@options[:query])
+            end
+          end
+        end
+        puts
+      end
+
+      # Show and print one rewriter.
+      def show_rewriter(snippet_name)
+        path = File.expand_path(File.join(default_snippets_home, "lib/#{snippet_name}.rb"))
+        if File.exist?(path)
+          puts File.read(path)
+        else
+          puts "snippet #{snippet_name} not found"
+        end
+      end
+
+      # generate a new snippet
+      def generate_snippet(snippet_name)
+        group, name = snippet_name.split('/')
+        FileUtils.mkdir_p("lib/#{group}")
+        FileUtils.mkdir_p("spec/#{group}")
+        lib_content = <<~EOF
+          # frozen_string_literal: true
+
+          Synvert::Rewriter.new '#{group}', '#{name}' do
+            description <<~EOS
+              It converts Foo to Bar
+
+              ```ruby
+              Foo
+              ```
+
+              =>
+
+              ```ruby
+              Bar
+              ```
+            EOS
+
+            within_files '**/*.rb' do
+              with_node type: 'const', to_source: 'Foo' do
+                replace_with 'Bar'
+              end
+            end
+          end
+        EOF
+        spec_content = <<~EOF
+          # frozen_string_literal: true
+
+          require 'spec_helper'
+
+          RSpec.describe 'Convert Foo to Bar' do
+            let(:rewriter_name) { '#{group}/#{name}' }
+            let(:fake_file_path) { 'foobar.rb' }
+            let(:test_content) { 'Foo' }
+            let(:test_rewritten_content) { 'Bar' }
+
+            include_examples 'convertable'
+          end
+        EOF
+        File.write("lib/#{group}/#{name}.rb", lib_content)
+        File.write("spec/#{group}/#{name}_spec.rb", spec_content)
+      end
+
+      # run a snippet
+      def run_snippet(rewriter, format)
+        if format == 'json'
+          rewriter.process
+          output = {
+            affected_files: rewriter.affected_files.union(rewriter.sub_snippets.sum(Set.new, &:affected_files)).to_a,
+            warnings: rewriter.warnings.union(rewriter.sub_snippets.sum([], &:warnings))
+          }
+          puts output.to_json
+        else
+          puts "===== #{rewriter.group}/#{rewriter.name} started ====="
+          rewriter.process
+          rewriter.warnings.each do |warning|
+            puts '[Warn] ' + warning.message
+          end
+          puts "===== #{rewriter.group}/#{rewriter.name} done ====="
+        end
+      rescue StandardError => e
+        if ENV['DEBUG']
+          puts e.backtrace.join("\n")
+        end
+        if plain_output?
+          puts "Error: #{e.message}"
+        else
+          puts({ error: e.message }.to_json)
+        end
+        raise
+      end
+
+      # test a snippet
+      def test_snippet(rewriter)
+        results = rewriter.test
+        puts results.to_json
+      rescue StandardError => e
+        if ENV['DEBUG']
+          puts e.backtrace.join("\n")
+        end
+        puts({ error: e.message }.to_json)
+        raise
+      end
+
+      def default_snippets_home
+        # ENV['HOME'] may use \ as file separator,
+        # but File.join always uses / as file separator.
+        ENV['SYNVERT_SNIPPETS_HOME'] || File.join(ENV['HOME'].gsub("\\", "/"), '.synvert-ruby')
+      end
+    end
+  end
+end

data/lib/synvert/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Synvert
-  VERSION = '1.4.6'
+  VERSION = '1.5.0'
 end

data/lib/synvert.rb

@@ -6,6 +6,5 @@ require 'synvert/core'
 
 module Synvert
   autoload :CLI, 'synvert/cli'
-  autoload :Utils, 'synvert/utils'
-  autoload :Snippet, 'synvert/snippet'
+  autoload :Command, 'synvert/command'
 end

data/spec/spec_helper.rb

@@ -3,10 +3,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert'
-require 'webmock/rspec'
-
-require 'coveralls'
-Coveralls.wear!
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/synvert/command_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Synvert
+  RSpec.describe Command do
+    let(:snippets_path) { File.join(File.dirname(__FILE__), '.synvert-ruby') }
+    before { allow(described_class).to receive(:default_snippets_home).and_return(snippets_path) }
+    before { FileUtils.rm_rf(snippets_path) if Dir.exist?(snippets_path) }
+    after { FileUtils.rm_rf(snippets_path) if Dir.exist?(snippets_path) }
+
+    describe '.sync_snippets' do
+      it 'git clones snippets' do
+        expect(Kernel).to receive(:system).with(
+          "git clone https://github.com/xinminlabs/synvert-snippets-ruby.git #{snippets_path}"
+        )
+        described_class.sync_snippets
+      end
+
+      it 'git pull snippets' do
+        FileUtils.mkdir snippets_path
+        expect(Kernel).to receive(:system).with('git checkout . && git pull --rebase')
+        described_class.sync_snippets
+        FileUtils.cd File.dirname(__FILE__)
+      end
+    end
+
+    describe '.read_rewriters' do
+      before do
+        FileUtils.mkdir_p(File.join(snippets_path, 'lib'))
+        File.write(File.join(snippets_path, 'lib', 'foo_rewriter.rb'), <<~EOS)
+          Synvert::Rewriter.new 'ruby', 'foo_rewriter' do
+          end
+        EOS
+        File.write(File.join(snippets_path, 'lib', 'bar_rewriter.rb'), <<~EOS)
+          Synvert::Rewriter.new 'ruby', 'bar_rewriter' do
+          end
+        EOS
+      end
+
+      it 'requires all .rb files in the lib directory of the snippets home' do
+        described_class.read_rewriters
+        expect(Synvert::Rewriter.fetch('ruby', 'foo_rewriter')).to be_a(Synvert::Rewriter)
+        expect(Synvert::Rewriter.fetch('ruby', 'bar_rewriter')).to be_a(Synvert::Rewriter)
+      end
+    end
+
+    describe '.read_helpers' do
+      before do
+        FileUtils.mkdir_p(File.join(snippets_path, 'lib', 'helpers'))
+        File.write(File.join(snippets_path, 'lib', 'helpers', 'foo_helper.rb'), <<~EOS)
+          Synvert::Helper.new 'foo_helper' do
+          end
+        EOS
+        File.write(File.join(snippets_path, 'lib', 'helpers', 'bar_helper.rb'), <<~EOS)
+          Synvert::Helper.new 'bar_helper' do
+          end
+        EOS
+      end
+
+      it 'requires all .rb files in the lib/helpers directory of the snippets home' do
+        described_class.read_helpers
+        expect(Synvert::Helper.fetch('foo_helper')).to be_a(Synvert::Helper)
+        expect(Synvert::Helper.fetch('bar_helper')).to be_a(Synvert::Helper)
+      end
+    end
+
+    describe '.available_rewriters' do
+      it 'requires all .rb files in the lib directory of the snippets home' do
+        Synvert::Rewriter.new 'ruby', 'foo_rewriter' do
+        end
+        Synvert::Rewriter.new 'ruby', 'bar_rewriter' do
+        end
+        expect(described_class.available_rewriters).to match_array [
+          { description: nil, group: "ruby", name: "foo_rewriter", sub_snippets: [] },
+          { description: nil, group: "ruby", name: "bar_rewriter", sub_snippets: [] }
+        ]
+      end
+    end
+
+    describe '.generate_snippet' do
+      it 'generates both snippet code and test code' do
+        described_class.generate_snippet('ruby/foobar')
+        expect(File.read('lib/ruby/foobar.rb')).to eq <<~EOF
+          # frozen_string_literal: true
+
+          Synvert::Rewriter.new 'ruby', 'foobar' do
+            description <<~EOS
+              It converts Foo to Bar
+
+              ```ruby
+              Foo
+              ```
+
+              =>
+
+              ```ruby
+              Bar
+              ```
+            EOS
+
+            within_files '**/*.rb' do
+              with_node type: 'const', to_source: 'Foo' do
+                replace_with 'Bar'
+              end
+            end
+          end
+        EOF
+        expect(File.read('spec/ruby/foobar_spec.rb')).to eq <<~EOF
+          # frozen_string_literal: true
+
+          require 'spec_helper'
+
+          RSpec.describe 'Convert Foo to Bar' do
+            let(:rewriter_name) { 'ruby/foobar' }
+            let(:fake_file_path) { 'foobar.rb' }
+            let(:test_content) { 'Foo' }
+            let(:test_rewritten_content) { 'Bar' }
+
+            include_examples 'convertable'
+          end
+        EOF
+        FileUtils.rm_rf('lib/ruby')
+        FileUtils.rm_rf('spec/ruby')
+      end
+    end
+  end
+end

data/synvert-ruby.gemspec

@@ -20,10 +20,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.post_install_message = 'Please run `synvert-ruby --sync` first to sync snippets remotely.'
 
-  spec.add_runtime_dependency 'synvert-core', '>= 1.28.0'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'webmock'
+  spec.add_runtime_dependency 'synvert-core', '>= 1.29.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synvert-core
@@ -16,75 +16,18 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: 1.29.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.28.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.29.3
 description: synvert is used to convert ruby code to better syntax.
 email:
 - flyerhzm@gmail.com
 executables:
-- synvert
 - synvert-ruby
 extensions: []
 extra_rdoc_files: []
@@ -95,19 +38,17 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/synvert
 - bin/synvert-ruby
 - lib/synvert.rb
 - lib/synvert/cli.rb
-- lib/synvert/snippet.rb
-- lib/synvert/utils.rb
+- lib/synvert/command.rb
 - lib/synvert/version.rb
 - spec/spec_helper.rb
-- spec/synvert/snippet_spec.rb
-- spec/synvert/utils_spec.rb
+- spec/synvert/command_spec.rb
 - synvert-ruby.gemspec
 homepage: https://github.com/xinminlabs/synvert-ruby
 licenses:
@@ -128,11 +69,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: synvert = syntax + convert.
 test_files:
 - spec/spec_helper.rb
-- spec/synvert/snippet_spec.rb
-- spec/synvert/utils_spec.rb
+- spec/synvert/command_spec.rb

data/bin/synvert

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
-require 'synvert'
-
-puts "synvert is deprecated, use synvert-ruby instead."
-puts
-result = Synvert::CLI.run
-exit(result ? 0 : 1)

data/lib/synvert/snippet.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Synvert
-  # Manage synvert snippets.
-  class Snippet
-    def initialize(snippets_path)
-      @snippets_path = snippets_path
-    end
-
-    # synchronize snippets from github.
-    def sync
-      if File.exist?(@snippets_path)
-        Dir.chdir(@snippets_path) do
-          Kernel.system('git checkout . && git pull --rebase')
-        end
-      else
-        Kernel.system("git clone https://github.com/xinminlabs/synvert-snippets-ruby.git #{@snippets_path}")
-      end
-    end
-  end
-end

data/lib/synvert/utils.rb

@@ -1,18 +0,0 @@
-module Synvert
-  module Utils
-    class << self
-      def format_url(url)
-        convert_to_github_raw_url(url)
-      end
-
-      private
-
-      def convert_to_github_raw_url(url)
-        if url.include?('//github.com/')
-          url = url.sub('//github.com/', '//raw.githubusercontent.com/').sub('/blob/', '/')
-        end
-        url
-      end
-    end
-  end
-end

data/spec/synvert/snippet_spec.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Synvert
-  describe Snippet do
-    let(:snippets_path) { File.join(File.dirname(__FILE__), '.synvert-ruby') }
-    let(:snippet) { Snippet.new(snippets_path) }
-    after { FileUtils.rmdir(snippets_path) if File.exist?(snippets_path) }
-
-    describe 'sync' do
-      it 'git clones snippets' do
-        expect(Kernel).to receive(:system).with(
-          "git clone https://github.com/xinminlabs/synvert-snippets-ruby.git #{snippets_path}"
-        )
-        snippet.sync
-      end
-
-      it 'git pull snippets' do
-        FileUtils.mkdir snippets_path
-        expect(Kernel).to receive(:system).with('git checkout . && git pull --rebase')
-        snippet.sync
-        FileUtils.cd File.dirname(__FILE__)
-      end
-    end
-  end
-end

data/spec/synvert/utils_spec.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Synvert
-  RSpec.describe Utils do
-    describe '.format_url' do
-      it 'converts github url to github raw url' do
-        url = 'https://github.com/xinminlabs/synvert-snippets-ruby/blob/main/lib/ruby/map_and_flatten_to_flat_map.rb'
-        raw_url = 'https://raw.githubusercontent.com/xinminlabs/synvert-snippets-ruby/main/lib/ruby/map_and_flatten_to_flat_map.rb'
-        expect(described_class.format_url(url)).to eq raw_url
-      end
-    end
-  end
-end