synvert 0.11.1 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffaa68ee9700864133744f9c3a3ad39424f955d934dc30a59e097865aaff915
-  data.tar.gz: 9f05b924aabfc116b108235b448114fb84cf35bf867e13d217da6210a736d0a2
+  metadata.gz: e99142ef7ed4127f66b23dba5d3ab0ec04d2b8edb315ac48945c15fb6056c294
+  data.tar.gz: dbcbfffa5f570522d6385660663a8438d55ae7216f49cd8964787b31e916aa88
 SHA512:
-  metadata.gz: 4c1fb489d17c2588442a5b5f6c195d39b9001250f4a0228ee734171f94260265d552a5fa4690b2349a1f57a817086dc693b40b29d9556d3764b130b4f3247727
-  data.tar.gz: 2af58834be39f558a11dcc43f752a1949b478711a2f8026e301ddf45e817391bdf161e7b0d91239f2628a268ad48d3904f618c4de4dbfa587509d0e4cb0a4e36
+  metadata.gz: 5346a5cc7fba0bc0aba045206c716d98fc8ac46b5beb109dffa62885e6caa5b09f0e31e9a84b3df324e8dae96f30164782f8211deb66b29a0890ce6b71efbedc
+  data.tar.gz: f2b2b6a0ea082757d333a6c68aabcb03d1ae8ec99a5b95cbe5013bb52af5a4adbcd95dd278103f7f125dea2dc04cdf8ad72ddf70077a85c25af8bdf36f9955b0

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## 0.14.1 (2021-03-13)
+
+* Fix reduce on empty array
+
+## 0.14.0 (2021-03-13)
+
+* Add CLI option `--format`
+* Run one snippet once
+
+## 0.13.0 (2021-03-02)
+
+* Use `ENV['SYNVERT_SNIPPETS_HOME']` to change default snippets home
+* Display snippet source code for showing a snippet
+
+## 0.12.0 (2021-03-01)
+
+* Display `synvert-core` and `parser` version
+* Generate a new snippet
+
 ## 0.11.1 (2021-02-20)
 
 * Use `Synvert::VERSION` instead of `Synvert::Core::VERSION`

data/lib/synvert/cli.rb

@@ -15,7 +15,7 @@ module Synvert
 
     # Initialize a CLI.
     def initialize
-      @options = { command: 'run', custom_snippet_paths: [], snippet_names: [] }
+      @options = { command: 'run', custom_snippet_paths: [], format: 'plain' }
     end
 
     # Run the CLI.
@@ -28,9 +28,6 @@ module Synvert
       when 'list'
         load_rewriters
         list_available_rewriters
-      when 'list-all'
-        load_rewriters
-        list_all_rewriters_in_json
       when 'open'
         open_rewriter
       when 'query'
@@ -41,19 +38,12 @@ module Synvert
         show_rewriter
       when 'sync'
         sync_snippets
+      when 'generate'
+        generate_snippet
       else
         # run
         load_rewriters
-        @options[:snippet_names].each do |snippet_name|
-          puts "===== #{snippet_name} started ====="
-          group, name = snippet_name.split('/')
-          rewriter = Core::Rewriter.call group, name
-          rewriter.warnings.each do |warning|
-            puts '[Warn] ' + warning.message
-          end
-          puts rewriter.todo if rewriter.todo
-          puts "===== #{snippet_name} done ====="
-        end
+        run_snippet
       end
       true
     rescue SystemExit
@@ -80,9 +70,6 @@ module Synvert
                   'load custom snippets, snippet paths can be local file path or remote http url' do |snippet_paths|
             @options[:custom_snippet_paths] = snippet_paths.split(',').map(&:strip)
           end
-          opts.on '--list-all', 'list all available snippets name and description in json format' do
-            @options[:command] = 'list-all'
-          end
           opts.on '-l', '--list', 'list all available snippets' do
             @options[:command] = 'list'
           end
@@ -107,13 +94,18 @@ module Synvert
           opts.on '--sync', 'sync snippets' do
             @options[:command] = 'sync'
           end
-          opts.on '-r',
-                  '--run SNIPPET_NAMES',
-                  'run specified snippets, each SNIPPET_NAME is combined by group and name, e.g. ruby/new_hash_syntax,ruby/new_lambda_syntax' do |snippet_names|
-            @options[:snippet_names] = snippet_names.split(',').map(&:strip)
+          opts.on '-r', '--run SNIPPET_NAME', 'run specified snippet, e.g. ruby/new_hash_syntax' do |snippet_name|
+            @options[:snippet_name] = snippet_name
+          end
+          opts.on '-g', '--generate NEW_SNIPPET_NAME', 'generate a new snippet' do |name|
+            @options[:command] = 'generate'
+            @options[:snippet_name] = name
+          end
+          opts.on '-f', '--format FORMAT', 'output format' do |format|
+            @options[:format] = format
           end
           opts.on '-v', '--version', 'show this version' do
-            puts VERSION
+            puts "#{VERSION} (with synvert-core #{Core::VERSION} and parser #{Parser::VERSION})"
             exit
           end
         end
@@ -131,7 +123,7 @@ module Synvert
 
     # Load all rewriters.
     def load_rewriters
-      Dir.glob(File.join(default_snippets_path, 'lib/**/*.rb')).each { |file| require file }
+      Dir.glob(File.join(default_snippets_home, 'lib/**/*.rb')).each { |file| require file }
 
       @options[:custom_snippet_paths].each do |snippet_path|
         if /^http/.match?(snippet_path)
@@ -142,7 +134,7 @@ module Synvert
         end
       end
     rescue StandardError
-      FileUtils.rm_rf default_snippets_path
+      FileUtils.rm_rf default_snippets_home
       retry
     end
 
@@ -150,7 +142,10 @@ module Synvert
     def list_available_rewriters
       if Core::Rewriter.availables.empty?
         puts 'There is no snippet under ~/.synvert, please run `synvert --sync` to fetch snippets.'
-      else
+        return
+      end
+
+      if plain_output?
         Core::Rewriter.availables.each do |group, rewriters|
           puts group
           rewriters.each do |name, _rewriter|
@@ -158,29 +153,22 @@ module Synvert
           end
         end
         puts
-      end
-    end
-
-    def list_all_rewriters_in_json
-      if Core::Rewriter.availables.empty?
-        puts 'There is no snippet under ~/.synvert, please run `synvert --sync` to fetch snippets.'
-        return
-      end
-
-      output = []
-      Core::Rewriter.availables.each do |group, rewriters|
-        rewriters.each do |name, rewriter|
-          rewriter.process_with_sandbox
-          output << {
-            group: group,
-            name: name,
-            description: rewriter.description,
-            sub_snippets: rewriter.sub_snippets.map(&:name)
-          }
+      elsif json_output?
+        output = []
+        Core::Rewriter.availables.each do |group, rewriters|
+          rewriters.each do |name, rewriter|
+            rewriter.process_with_sandbox
+            output << {
+              group: group,
+              name: name,
+              description: rewriter.description,
+              sub_snippets: rewriter.sub_snippets.map(&:name)
+            }
+          end
         end
-      end
 
-      puts JSON.generate(output)
+        puts JSON.generate(output)
+      end
     end
 
     # Open one rewriter.
@@ -188,7 +176,7 @@ module Synvert
       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_path, "lib/#{@options[:snippet_name]}.rb"))
+      path = File.expand_path(File.join(default_snippets_home, "lib/#{@options[:snippet_name]}.rb"))
       if File.exist? path
         system editor, path
       else
@@ -216,18 +204,9 @@ module Synvert
 
     # Show and print one rewriter.
     def show_rewriter
-      group, name = @options[:snippet_name].split('/')
-      rewriter = Core::Rewriter.fetch(group, name)
-      if rewriter
-        rewriter.process_with_sandbox
-        puts rewriter.description
-        rewriter.sub_snippets.each do |sub_rewriter|
-          puts
-          puts '=' * 80
-          puts "snippet: #{sub_rewriter.name}"
-          puts '=' * 80
-          puts sub_rewriter.description
-        end
+      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
@@ -235,7 +214,7 @@ module Synvert
 
     # sync snippets
     def sync_snippets
-      Snippet.new(default_snippets_path).sync
+      Snippet.new(default_snippets_home).sync
       puts 'synvert snippets are synced'
       core_version = Snippet.fetch_core_version
       if Gem::Version.new(core_version) > Gem::Version.new(Synvert::Core::VERSION)
@@ -243,8 +222,88 @@ module Synvert
       end
     end
 
-    def default_snippets_path
-      File.join(ENV['HOME'], '.synvert')
+    # run snippets
+    def run_snippet
+      snippet_name = @options[:snippet_name]
+      if plain_output?
+        puts "===== #{snippet_name} started ====="
+        group, name = snippet_name.split('/')
+        rewriter = Core::Rewriter.call group, name
+        rewriter.warnings.each do |warning|
+          puts '[Warn] ' + warning.message
+        end
+        puts rewriter.todo if rewriter.todo
+        puts "===== #{snippet_name} done ====="
+      elsif json_output?
+        group, name = snippet_name.split('/')
+        rewriter = Core::Rewriter.call group, name
+        output = {
+          affected_files: rewriter.affected_files.union(rewriter.sub_snippets.map(&:affected_files).reduce([], :+)).to_a,
+          warnings: rewriter.warnings.union(rewriter.sub_snippets.map(&:warnings).reduce([], :+)),
+          todo: rewriter.todo
+        }
+        puts JSON.generate(output)
+      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['SYNVERT_SNIPPETS_HOME'] || File.join(ENV['HOME'], '.synvert')
+    end
+
+    def plain_output?
+      @options[:format] == 'plain'
+    end
+
+    def json_output?
+      @options[:format] == 'json'
     end
   end
 end

data/lib/synvert/version.rb

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

data/spec/synvert/snippet_spec.rb

@@ -8,6 +8,15 @@ module Synvert
     let(:snippet) { Snippet.new(snippets_path) }
     after { FileUtils.rmdir(snippets_path) if File.exist?(snippets_path) }
 
+    describe '.fetch_core_version' do
+      it 'gets remote version' do
+        stub_request(:get, 'https://rubygems.org/api/v1/versions/synvert-core.json').to_return(
+          body: '[{"number":"0.4.2"}]'
+        )
+        expect(Snippet.fetch_core_version).to eq '0.4.2'
+      end
+    end
+
     describe 'sync' do
       it 'git clones snippets' do
         expect(Kernel).to receive(:system).with(
@@ -23,14 +32,5 @@ module Synvert
         FileUtils.cd File.dirname(__FILE__)
       end
     end
-
-    describe 'fetch_core_version' do
-      it 'gets remote version' do
-        stub_request(:get, 'https://rubygems.org/api/v1/versions/synvert-core.json').to_return(
-          body: '[{"number":"0.4.2"}]'
-        )
-        expect(snippet.fetch_core_version).to eq '0.4.2'
-      end
-    end
   end
 end

data/synvert.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.post_install_message = 'Please run `synvert --sync` first to sync snippets remotely.'
 
-  spec.add_runtime_dependency 'synvert-core', '>= 0.20.1'
+  spec.add_runtime_dependency 'synvert-core', '>= 0.22.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.14.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synvert-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement