synvert 0.13.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ccf2486b37c9a73a8f014901e152ff5229bbcac7a35922d6cb5811318c9621
-  data.tar.gz: 0d9a816901fd978e550f976a6678513a516872f8c41ec3c1a1f21751e8b0a781
+  metadata.gz: fc982f230933521fb1b332728e9affea43b0245b7c0dacd501cce3050983ee90
+  data.tar.gz: 9a370e4f362e8c40eb9cdb8eda9121234d81ded3966428c1d803d33a83099433
 SHA512:
-  metadata.gz: eafeb5f93d44b239f1c48dda8be7426491d126adb1b3ba4a7a17f16b93ec9b48b79db1af3be89a60469891b5b25c4afd31326fc1ef11094fc05d24e0e118f4bc
-  data.tar.gz: 37c977345a20633089077628dc58d1db3dc7a382f64550f42aa912450437886555f2b372fd4edf1fa54bb6ecdefe222a8a08d9d56af5f8d7e6032252f7eb82c1
+  metadata.gz: 2f721c8e10e17347a5db3bc8f39a8fe178d16b77617de653f91edfc3887ee0f74d9076d3a7bcec6e6e7fe293d15378e461ab33f00a9cd92de1868e7aa405c2fd
+  data.tar.gz: b3d976e148b2c33c5a104b1ab94fc8e4898729f07680971a1b6f08684a0f8fdf23d90b000d38d77f22c8b337829da4c1fea825a8b5c9ef8f2952e34e4a6d5f4c

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 0.17.0 (2021-04-19)
+
+* Run `git checkout .` before `git pull --rebase`
+
+## 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

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.
@@ -24,6 +22,12 @@ Install it using rubygems
 $ gem install synvert
 ```
 
+then run
+
+```
+$ synvert --sync
+```
+
 ## Usage
 
 ```
@@ -42,11 +46,19 @@ Usage: synvert [project_path]
 e.g.
 
 ```
-$ 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
+
 ```
-$ synvert -r factory_girl/use_short_syntax,rails/upgrade_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
+$ 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

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
@@ -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.
@@ -236,7 +221,32 @@ module Synvert
       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
@@ -291,5 +301,13 @@ module 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/snippet.rb

@@ -19,7 +19,7 @@ module Synvert
     def sync
       if File.exist?(@snippets_path)
         FileUtils.cd @snippets_path
-        Kernel.system('git pull --rebase')
+        Kernel.system('git checkout .; git pull --rebase')
       else
         Kernel.system("git clone https://github.com/xinminlabs/synvert-snippets.git #{@snippets_path}")
       end

data/lib/synvert/version.rb

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

data/spec/synvert/snippet_spec.rb

@@ -27,7 +27,7 @@ module Synvert
 
       it 'git pull snippets' do
         FileUtils.mkdir snippets_path
-        expect(Kernel).to receive(:system).with('git pull --rebase')
+        expect(Kernel).to receive(:system).with('git checkout .; git pull --rebase')
         snippet.sync
         FileUtils.cd File.dirname(__FILE__)
       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.13.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-19 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