synvert 0.10.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ccc2f378bbcddf7fe052b577b594bd832672b7cca486786ee0e07611d07d87
-  data.tar.gz: 5ba5f7e67f79dc322e73034f699d76a3c3020bbe7090991d23e947ca25278353
+  metadata.gz: 43ccf2486b37c9a73a8f014901e152ff5229bbcac7a35922d6cb5811318c9621
+  data.tar.gz: 0d9a816901fd978e550f976a6678513a516872f8c41ec3c1a1f21751e8b0a781
 SHA512:
-  metadata.gz: 6ad3896b92637a657e5b453a492d6620b108a33d98470eecc71850de266bfb9cf544c82780bb90f1556fcd0fe9a01ee362f953a186e1b50bc437dd8263558b83
-  data.tar.gz: d84667fea189b0d4c0f249e2889b87946612baa103a007fb7bbcddecb88af6cb7308b0efbc2ebc63997675b5f698400230e1209b1bcf7d225f5ce00f5ff380fb
+  metadata.gz: eafeb5f93d44b239f1c48dda8be7426491d126adb1b3ba4a7a17f16b93ec9b48b79db1af3be89a60469891b5b25c4afd31326fc1ef11094fc05d24e0e118f4bc
+  data.tar.gz: 37c977345a20633089077628dc58d1db3dc7a382f64550f42aa912450437886555f2b372fd4edf1fa54bb6ecdefe222a8a08d9d56af5f8d7e6032252f7eb82c1

data/CHANGELOG.md

@@ -1,8 +1,24 @@
 # CHANGELOG
 
-## 0.10.1 (2021-02-09)
+## 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`
+
+## 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)
 

data/lib/synvert/cli.rb

@@ -28,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'
@@ -38,6 +41,8 @@ module Synvert
         show_rewriter
       when 'sync'
         sync_snippets
+      when 'generate'
+        generate_snippet
       else
         # run
         load_rewriters
@@ -77,6 +82,9 @@ 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
@@ -106,8 +114,12 @@ module Synvert
                   '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 Core::VERSION
+            puts "#{VERSION} (with synvert-core #{Core::VERSION} and parser #{Parser::VERSION})"
             exit
           end
         end
@@ -125,7 +137,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)
@@ -136,7 +148,7 @@ module Synvert
         end
       end
     rescue StandardError
-      FileUtils.rm_rf default_snippets_path
+      FileUtils.rm_rf default_snippets_home
       retry
     end
 
@@ -155,12 +167,34 @@ 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? }
       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
@@ -188,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_home, "lib/#{@options[:snippet_name]}.rb"))
+      if File.exist?(path)
+        puts File.read(path)
       else
         puts "snippet #{@options[:snippet_name]} not found"
       end
@@ -207,7 +232,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)
@@ -215,8 +240,56 @@ module Synvert
       end
     end
 
-    def default_snippets_path
-      File.join(ENV['HOME'], '.synvert')
+    # 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_home
+      ENV['SYNVERT_SNIPPETS_HOME'] || File.join(ENV['HOME'], '.synvert')
     end
   end
 end

data/lib/synvert/snippet.rb

@@ -6,6 +6,11 @@ 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
@@ -19,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 @@
 # frozen_string_literal: true
 
 module Synvert
-  VERSION = '0.10.1'
+  VERSION = '0.13.0'
 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.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.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-03-02 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