synvert 0.12.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6850587d42a82286479a86f22018a83b4e6f3b6d23d65a6518120acde4c4a52c
-  data.tar.gz: e9a223cae6a39601d7bd9f793c109d28db4483664da77a20a88c267a4432568e
+  metadata.gz: 1d737afecd60f57b9f37667899020a9a228af5ea1aa6e195686e4da8c5e201ea
+  data.tar.gz: 070115ee46ab5de7a6dd3b24bf39ed4a62a5f5b00c7b1a897f7378cc2b379f39
 SHA512:
-  metadata.gz: eca37ac2eda8ea96d555b32061336b2576f0efbd5471dbfb0ca58594e21a55e17559675d8f2880d5b0f9740564f719311eb06bb34f90491bed713c0b7d6e3267
-  data.tar.gz: 796ce440e914222563a41741b54a89584da3ee2418fe830a37bdfa076beabb794c69312d38e3a319f42c2d483dd72ccb402666dd97e0b0aa539ef47726b0c2b9
+  metadata.gz: 7ddc5f29a5f0dc24a13ed097e0814f4a4eed585185420010b6fdbfcdc5822d4b1ba769a094d46e61f494c10866c58b83126f6fda4c768814a9ace2a7b9b3c5c1
+  data.tar.gz: 0dc29b3b96c5aaeaf3479d28e1fe7f33b2a95f76205665bd6c4ec6122d16949e829713f9dd0ff6d92170c4c01e8cbe4d2de52fa5399459c7bb3f0fdd4edad616

data/CHANGELOG.md

@@ -1,7 +1,22 @@
 # CHANGELOG
 
-## 0.12.1 (2021-03-01)
+## 0.16.0 (2021-03-24)
 
+* Add `ruby_version` and `gem_spec` to json output
+
+## 0.15.0 (2021-03-23)
+
+* Fix reduce on empty array
+* Update synvert-core when syncing snippets
+
+## 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)

data/README.md

@@ -7,8 +7,6 @@
 Synvert = syntax + convert, makes it easy to convert ruby code
 automatically.
 
-Synvert is tested against MRI 1.9.3, 2.0.0, 2.1.7 and 2.2.3.
-
 Synvert is composed by synvert-core and synvert-snippets.
 
 [synvert-core][1] provides a dsl to convert ruby code.
@@ -49,6 +47,18 @@ $ synvert --sync
 $ synvert -r factory_girl/use_short_syntax,rails/upgrade_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
 ```
 
+## Docker
+
+We have a docker image to run synvert
+
+```
+$ docker pull xinminlabs/awesomecode-synvert
+
+$ docker run xinminlabs/awesomecode-synvert synvert --list
+
+$ docker run -v <your project path>:/app xinminlabs/awesomecode-synvert synvert --run default/check_syntax /app
+```
+
 ## Documentation
 
 [http://xinminlabs.github.io/synvert/][3]

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'
@@ -46,16 +43,7 @@ module Synvert
       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
@@ -82,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
@@ -109,15 +94,16 @@ 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} (with synvert-core #{Core::VERSION} and parser #{Parser::VERSION})"
             exit
@@ -137,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)
@@ -148,7 +134,7 @@ module Synvert
         end
       end
     rescue StandardError
-      FileUtils.rm_rf default_snippets_path
+      FileUtils.rm_rf default_snippets_home
       retry
     end
 
@@ -156,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|
@@ -164,29 +153,25 @@ 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
+            item = {
+              group: group,
+              name: name,
+              description: rewriter.description,
+              sub_snippets: rewriter.sub_snippets.map(&:name)
+            }
+            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
-      end
 
-      puts JSON.generate(output)
+        puts JSON.generate(output)
+      end
     end
 
     # Open one rewriter.
@@ -194,7 +179,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
@@ -222,7 +207,7 @@ module Synvert
 
     # Show and print one rewriter.
     def show_rewriter
-      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)
         puts File.read(path)
       else
@@ -232,11 +217,36 @@ 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)
-        puts "synvert-core is updated, please install synvert-core #{core_version}"
+        puts "synvert-core is updated, installing synvert-core #{core_version}"
+        system('gem install synvert-core')
+      end
+    end
+
+    # 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.sum([], &:affected_files)).to_a,
+          warnings: rewriter.warnings.union(rewriter.sub_snippets.sum([], &:warnings)),
+          todo: rewriter.todo
+        }
+        puts JSON.generate(output)
       end
     end
 
@@ -250,7 +260,7 @@ module Synvert
 
         Synvert::Rewriter.new '#{group}', '#{name}' do
           description <<~EOS
-            It convert Foo to Bar
+            It converts Foo to Bar
 
             ```ruby
             Foo
@@ -288,8 +298,16 @@ module Synvert
       File.write("spec/#{group}/#{name}_spec.rb", spec_content)
     end
 
-    def default_snippets_path
-      File.join(ENV['HOME'], '.synvert')
+    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.12.1'
+  VERSION = '0.16.0'
 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.25.1'
 
   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.12.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-24 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.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement