synvert 0.10.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430688d602830d6cbccecf277a580969288b875e992dc1447eb108a7ebd0726c
-  data.tar.gz: 6ea78cce8187cea7470bbc043978b318a4f0bd608bf13124cb9ec5f75917fe37
+  metadata.gz: 6850587d42a82286479a86f22018a83b4e6f3b6d23d65a6518120acde4c4a52c
+  data.tar.gz: e9a223cae6a39601d7bd9f793c109d28db4483664da77a20a88c267a4432568e
 SHA512:
-  metadata.gz: dad3de4c88092bba08138b0b64d70e92fa33ca2d8d4d7acea22d7b5e468e48fb2b08b8531832c985b03f5a4b6c2e0fda5f5aa415aae204c414fc5d14d18646c1
-  data.tar.gz: e500c57544648cb230f43e52658d58c36bde8a13f052c5e66441fc3471c43e867c8693a0b4fde23a9a9c6c69eae28c0d174ef5ddedec499ff6594a676b0beece
+  metadata.gz: eca37ac2eda8ea96d555b32061336b2576f0efbd5471dbfb0ca58594e21a55e17559675d8f2880d5b0f9740564f719311eb06bb34f90491bed713c0b7d6e3267
+  data.tar.gz: 796ce440e914222563a41741b54a89584da3ee2418fe830a37bdfa076beabb794c69312d38e3a319f42c2d483dd72ccb402666dd97e0b0aa539ef47726b0c2b9

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## 0.12.1 (2021-03-01)
+
+* 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`
+
+## 0.11.0 (2021-02-15)
+
+* Add `--list-all` option
+* Add post install message
+* Fix `Synvert::Snippet.fetch_core_version`
+
 ## 0.10.0 (2021-02-07)
 
 * Use new `Core::Confiruation`

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in synvert.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/synvert

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# coding: utf-8
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 require 'synvert'
 
 result = Synvert::CLI.run

data/lib/synvert.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'synvert/version'
 require 'bundler'
 require 'synvert/core'

data/lib/synvert/cli.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'optparse'
 
 module Synvert
@@ -14,7 +15,7 @@ module Synvert
 
     # Initialize a CLI.
     def initialize
-      @options = {command: 'run', custom_snippet_paths: [], snippet_names: []}
+      @options = { command: 'run', custom_snippet_paths: [], snippet_names: [] }
     end
 
     # Run the CLI.
@@ -27,6 +28,9 @@ 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'
@@ -37,7 +41,10 @@ module Synvert
         show_rewriter
       when 'sync'
         sync_snippets
-      else # run
+      when 'generate'
+        generate_snippet
+      else
+        # run
         load_rewriters
         @options[:snippet_names].each do |snippet_name|
           puts "===== #{snippet_name} started ====="
@@ -67,47 +74,63 @@ module Synvert
 
     # Run OptionParser to parse arguments.
     def run_option_parser(args)
-      optparse = OptionParser.new do |opts|
-        opts.banner = 'Usage: synvert [project_path]'
-        opts.on '-d', '--load SNIPPET_PATHS', '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 '-l', '--list', 'list all available snippets' do
-          @options[:command] = 'list'
-        end
-        opts.on '-o', '--open SNIPPET_NAME', 'Open a snippet' do |snippet_name|
-          @options[:command] = 'open'
-          @options[:snippet_name] = snippet_name
-        end
-        opts.on '-q', '--query QUERY', 'query specified snippets' do |query|
-          @options[:command] = 'query'
-          @options[:query] = query
-        end
-        opts.on '--skip FILE_PATTERNS', 'skip specified files or directories, separated by comma, e.g. app/models/post.rb,vendor/plugins/**/*.rb' do |file_patterns|
-          @options[:skip_file_patterns] = file_patterns.split(',')
-        end
-        opts.on '-s', '--show SNIPPET_NAME', 'show specified snippet description, SNIPPET_NAME is combined by group and name, e.g. ruby/new_hash_syntax' do |snippet_name|
-          @options[:command] = 'show'
-          @options[:snippet_name] = snippet_name
-        end
-        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)
-        end
-        opts.on '-v', '--version', 'show this version' do
-          puts Core::VERSION
-          exit
+      optparse =
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: synvert [project_path]'
+          opts.on '-d',
+                  '--load SNIPPET_PATHS',
+                  '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
+          opts.on '-o', '--open SNIPPET_NAME', 'Open a snippet' do |snippet_name|
+            @options[:command] = 'open'
+            @options[:snippet_name] = snippet_name
+          end
+          opts.on '-q', '--query QUERY', 'query specified snippets' do |query|
+            @options[:command] = 'query'
+            @options[:query] = query
+          end
+          opts.on '--skip FILE_PATTERNS',
+                  'skip specified files or directories, separated by comma, e.g. app/models/post.rb,vendor/plugins/**/*.rb' do |file_patterns|
+            @options[:skip_file_patterns] = file_patterns.split(',')
+          end
+          opts.on '-s',
+                  '--show SNIPPET_NAME',
+                  'show specified snippet description, SNIPPET_NAME is combined by group and name, e.g. ruby/new_hash_syntax' do |snippet_name|
+            @options[:command] = 'show'
+            @options[:snippet_name] = snippet_name
+          end
+          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)
+          end
+          opts.on '-g', '--generate NEW_SNIPPET_NAME', 'generate a new snippet' do |name|
+            @options[:command] = 'generate'
+            @options[:snippet_name] = name
+          end
+          opts.on '-v', '--version', 'show this version' do
+            puts "#{VERSION} (with synvert-core #{Core::VERSION} and parser #{Parser::VERSION})"
+            exit
+          end
         end
-      end
       paths = optparse.parse(args)
       Core::Configuration.path = paths.first || Dir.pwd
       if @options[:skip_file_patterns] && !@options[:skip_file_patterns].empty?
-        skip_files = @options[:skip_file_patterns].map do |file_pattern|
-          full_file_pattern = File.join(Core::Configuration.path, file_pattern)
-          Dir.glob(full_file_pattern)
-        end.flatten
+        skip_files =
+          @options[:skip_file_patterns].map do |file_pattern|
+            full_file_pattern = File.join(Core::Configuration.path, file_pattern)
+            Dir.glob(full_file_pattern)
+          end.flatten
         Core::Configuration.skip_files = skip_files
       end
     end
@@ -117,14 +140,14 @@ module Synvert
       Dir.glob(File.join(default_snippets_path, 'lib/**/*.rb')).each { |file| require file }
 
       @options[:custom_snippet_paths].each do |snippet_path|
-        if snippet_path =~ /^http/
+        if /^http/.match?(snippet_path)
           uri = URI.parse snippet_path
           eval(uri.read)
         else
           require snippet_path
         end
       end
-    rescue
+    rescue StandardError
       FileUtils.rm_rf default_snippets_path
       retry
     end
@@ -136,7 +159,7 @@ module Synvert
       else
         Core::Rewriter.availables.each do |group, rewriters|
           puts group
-          rewriters.each do |name, rewriter|
+          rewriters.each do |name, _rewriter|
             puts '    ' + name
           end
         end
@@ -144,6 +167,28 @@ module Synvert
       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)
+          }
+        end
+      end
+
+      puts JSON.generate(output)
+    end
+
     # Open one rewriter.
     def open_rewriter
       editor = [ENV['SYNVERT_EDITOR'], ENV['EDITOR']].find { |e| !e.nil? && !e.empty? }
@@ -162,12 +207,12 @@ module Synvert
       Core::Rewriter.availables.each do |group, rewriters|
         if group.include? @options[:query]
           puts group
-          rewriters.each do |name, rewriter|
+          rewriters.each do |name, _rewriter|
             puts '    ' + name
           end
         elsif rewriters.keys.any? { |name| name.include? @options[:query] }
           puts group
-          rewriters.each do |name, rewriter|
+          rewriters.each do |name, _rewriter|
             puts '    ' + name if name.include?(@options[:query])
           end
         end
@@ -177,18 +222,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_path, "lib/#{@options[:snippet_name]}.rb"))
+      if File.exist?(path)
+        puts File.read(path)
       else
         puts "snippet #{@options[:snippet_name]} not found"
       end
@@ -204,6 +240,54 @@ module Synvert
       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 convert 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_path
       File.join(ENV['HOME'], '.synvert')
     end

data/lib/synvert/snippet.rb

@@ -1,10 +1,16 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'json'
 
 module Synvert
   # Manage synvert snippets.
   class Snippet
+    def self.fetch_core_version
+      content = URI.open('https://rubygems.org/api/v1/versions/synvert-core.json').read
+      JSON.parse(content).first['number']
+    end
+
     def initialize(snippets_path)
       @snippets_path = snippets_path
     end
@@ -18,10 +24,5 @@ module Synvert
         Kernel.system("git clone https://github.com/xinminlabs/synvert-snippets.git #{@snippets_path}")
       end
     end
-
-    def fetch_core_version
-      content = URI.open('https://rubygems.org/api/v1/versions/synvert-core.json').read
-      JSON.parse(content).first['number']
-    end
   end
 end

data/lib/synvert/version.rb

@@ -1,5 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Synvert
-  VERSION = '0.10.0'
+  VERSION = '0.12.1'
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert'

data/spec/synvert/snippet_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Synvert
@@ -6,9 +8,20 @@ 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("git clone https://github.com/xinminlabs/synvert-snippets.git #{snippets_path}")
+        expect(Kernel).to receive(:system).with(
+          "git clone https://github.com/xinminlabs/synvert-snippets.git #{snippets_path}"
+        )
         snippet.sync
       end
 
@@ -19,13 +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

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'synvert/version'
 
@@ -17,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.post_install_message = 'Please run `synvert --sync` first to sync snippets remotely.'
 
-  spec.add_runtime_dependency 'synvert-core', '>= 0.19.0'
+  spec.add_runtime_dependency 'synvert-core', '>= 0.20.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.10.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-03-01 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.19.0
+        version: 0.20.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ homepage: https://github.com/xinminlabs/synvert
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: Please run `synvert --sync` first to sync snippets remotely.
 rdoc_options: []
 require_paths:
 - lib