synvert 0.5.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad8467c3b26e89499b67e13b5c4441a5b9d20a69
-  data.tar.gz: 701ad231cea1d52fc69827ced8610bcb7a07ebce
+SHA256:
+  metadata.gz: 1a6497202b00d143ebee65b85a45fb0fa0e1130d44984955f817799c16376424
+  data.tar.gz: e0befd502bd9414ef93ad6368044983a5f5d9a677a86d2ff63de637ab1740ece
 SHA512:
-  metadata.gz: ec940d0d793d9df5183fd06a670ecd545b229db7cd69cd698120172d4d304cd5a321edb71b9693bcb021596571b8633377751898972c0fc27f65b652a50e728d
-  data.tar.gz: 1a3c11744001240a5545aeb77c7ad4cee4d1e82c3c6913b2d5dcb8dd256816743d36f3ae30139b6e2515d8e7c8f65ad87a4147d4863a6f4a464f3916ca5f81a0
+  metadata.gz: cfa2c293ba1330dcccb3cd2ee43bd1ac47d45a8e0ce011615fcef575842405f27fec6b070061d6567461046a2d7c445ee0440b903baca3ca3c2c47bd00399577
+  data.tar.gz: 79d690b0576dc8083bfc451003ef50d8f3ab968908b774a10f6613a77172751979d93b9746b0e80617998ca0efc84a29ec4b5a61af907b17835c07af440dceaf

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0

data/CHANGELOG.md

@@ -1,8 +1,27 @@
 # CHANGELOG
 
+## 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`
+* Use require instead of eval in order to preserve normal Ruby semantics
+
+## 0.9.0
+
+* Add `-o` or `--open` option` to open a snippet
+
+## 0.5.3
+
+* Show warning message if rewriter not found
+
 ## 0.5.0
 
-* rewrite cli for rewriter group
+* Rewrite cli for rewriter group
 
 ## 0.4.2
 

data/Gemfile

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

data/README.md

@@ -1,17 +1,18 @@
 # Synvert
 
-[![Build Status](https://secure.travis-ci.org/xinminlabs/synvert.png)](http://travis-ci.org/xinminlabs/synvert)
-[![Coverage Status](https://coveralls.io/repos/xinminlabs/synvert/badge.png?branch=master)](https://coveralls.io/r/xinminlabs/synvert)
-[![Gem Version](https://badge.fury.io/rb/synvert.png)](http://badge.fury.io/rb/synvert)
+[![Build Status](https://secure.travis-ci.org/xinminlabs/synvert.svg)](http://travis-ci.org/xinminlabs/synvert)
+[![Coverage Status](https://coveralls.io/repos/xinminlabs/synvert/badge.svg?branch=master)](https://coveralls.io/r/xinminlabs/synvert)
+[![Gem Version](https://badge.fury.io/rb/synvert.svg)](http://badge.fury.io/rb/synvert)
 
 Synvert = syntax + convert, makes it easy to convert ruby code
 automatically.
 
-Synvert is tested against MRI 1.9.3, 2.0.0 and 2.1.1.
+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.
+
 [synvert-snippets][2] lists all snippets to convert ruby code based on
 synvert-core.
 
@@ -45,7 +46,7 @@ $ synvert --sync
 ```
 
 ```
-$ synvert -r factory_girl_short_syntax,upgrade_rails_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
+$ synvert -r factory_girl/use_short_syntax,rails/upgrade_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
 ```
 
 ## Documentation

data/Rakefile

@@ -1,4 +1,6 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

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,5 +1,6 @@
-# coding: utf-8
-require "synvert/version"
+# 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,9 +15,7 @@ module Synvert
 
     # Initialize a CLI.
     def initialize
-      @options = {command: 'run', custom_snippet_paths: [], snippet_names: []}
-      Core::Configuration.instance.set :skip_files, []
-      Core::Configuration.instance.set :default_snippets_path, File.join(ENV['HOME'], '.synvert')
+      @options = { command: 'run', custom_snippet_paths: [], snippet_names: [] }
     end
 
     # Run the CLI.
@@ -24,20 +23,33 @@ module Synvert
     # @return [Boolean] true if command runs successfully.
     def run(args)
       run_option_parser(args)
-      load_rewriters
 
       case @options[:command]
-      when 'list' then list_available_rewriters
-      when 'query' then query_available_rewriters
-      when 'show' then show_rewriter
-      when 'sync' then sync_snippets
+      when 'list'
+        load_rewriters
+        list_available_rewriters
+      when 'list-all'
+        load_rewriters
+        list_all_rewriters_in_json
+      when 'open'
+        open_rewriter
+      when 'query'
+        load_rewriters
+        query_available_rewriters
+      when 'show'
+        load_rewriters
+        show_rewriter
+      when 'sync'
+        sync_snippets
       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
+            puts '[Warn] ' + warning.message
           end
           puts rewriter.todo if rewriter.todo
           puts "===== #{snippet_name} done ====="
@@ -51,67 +63,85 @@ module Synvert
       puts "file #{e.diagnostic.location.source_buffer.name}"
       puts "line #{e.diagnostic.location.line}"
       false
+    rescue Synvert::Core::RewriterNotFound => e
+      puts e.message
+      false
     end
 
-  private
+    private
 
     # 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 '-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 '-v', '--version', 'show this version' do
+            puts Core::VERSION
+            exit
+          end
         end
-      end
       paths = optparse.parse(args)
-      Core::Configuration.instance.set :path, paths.first || Dir.pwd
+      Core::Configuration.path = paths.first || Dir.pwd
       if @options[:skip_file_patterns] && !@options[:skip_file_patterns].empty?
-        skip_files = @options[:skip_file_patterns].map { |file_pattern|
-          full_file_pattern = File.join(Core::Configuration.instance.get(:path), file_pattern)
-          Dir.glob(full_file_pattern)
-        }.flatten
-        Core::Configuration.instance.set :skip_files, skip_files
+        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
 
     # Load all rewriters.
     def load_rewriters
-      default_snippets_path = Core::Configuration.instance.get :default_snippets_path
-      Dir.glob(File.join(default_snippets_path, 'lib/**/*.rb')).each { |file| eval(File.read(file)) }
+      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
-          eval(File.read(snippet_path))
+          require snippet_path
         end
       end
-    rescue
+    rescue StandardError
       FileUtils.rm_rf default_snippets_path
       retry
     end
@@ -119,30 +149,65 @@ module Synvert
     # List and print all available rewriters.
     def list_available_rewriters
       if Core::Rewriter.availables.empty?
-        puts "There is no snippet under ~/.synvert, please run `synvert --sync` to fetch snippets."
+        puts 'There is no snippet under ~/.synvert, please run `synvert --sync` to fetch snippets.'
       else
         Core::Rewriter.availables.each do |group, rewriters|
           puts group
-          rewriters.each do |name, rewriter|
-            puts "    " + name
+          rewriters.each do |name, _rewriter|
+            puts '    ' + name
           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)
+          }
+        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"))
+      if File.exist? path
+        system editor, path
+      else
+        puts "Can't run #{editor} #{path}"
+      end
+    end
+
     # Query and print available rewriters.
     def query_available_rewriters
       Core::Rewriter.availables.each do |group, rewriters|
         if group.include? @options[:query]
           puts group
-          rewriters.each do |name, rewriter|
-            puts "    " + name
+          rewriters.each do |name, _rewriter|
+            puts '    ' + name
           end
         elsif rewriters.keys.any? { |name| name.include? @options[:query] }
           puts group
-          rewriters.each do |name, rewriter|
-            puts "    " + name if name.include?(@options[:query])
+          rewriters.each do |name, _rewriter|
+            puts '    ' + name if name.include?(@options[:query])
           end
         end
       end
@@ -158,9 +223,9 @@ module Synvert
         puts rewriter.description
         rewriter.sub_snippets.each do |sub_rewriter|
           puts
-          puts "=" * 80
+          puts '=' * 80
           puts "snippet: #{sub_rewriter.name}"
-          puts "=" * 80
+          puts '=' * 80
           puts sub_rewriter.description
         end
       else
@@ -170,12 +235,16 @@ module Synvert
 
     # sync snippets
     def sync_snippets
-      Snippet.sync
-      puts "synvert snippets are synced"
+      Snippet.new(default_snippets_path).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}"
       end
     end
+
+    def default_snippets_path
+      File.join(ENV['HOME'], '.synvert')
+    end
   end
 end

data/lib/synvert/snippet.rb

@@ -1,24 +1,28 @@
-# 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
+
     # synchronize snippets from github.
-    def self.sync
-      snippets_path = Core::Configuration.instance.get :default_snippets_path
-      if File.exist?(snippets_path)
-        FileUtils.cd snippets_path
-        system("git pull --rebase")
+    def sync
+      if File.exist?(@snippets_path)
+        FileUtils.cd @snippets_path
+        Kernel.system('git pull --rebase')
       else
-        system("git clone https://github.com/xinminlabs/synvert-snippets.git #{snippets_path}")
+        Kernel.system("git clone https://github.com/xinminlabs/synvert-snippets.git #{@snippets_path}")
       end
     end
-
-    def self.fetch_core_version
-      content = 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.5.0"
+  VERSION = '0.11.0'
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert'
 require 'webmock/rspec'

data/spec/synvert/snippet_spec.rb

@@ -1,29 +1,35 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Synvert
   describe Snippet do
-    describe "sync" do
-      let(:default_snippets_path) { File.join(File.dirname(__FILE__), '.synvert') }
-      before { Core::Configuration.instance.set :default_snippets_path, default_snippets_path }
-      after { FileUtils.rm_rf default_snippets_path }
+    let(:snippets_path) { File.join(File.dirname(__FILE__), '.synvert') }
+    let(:snippet) { Snippet.new(snippets_path) }
+    after { FileUtils.rmdir(snippets_path) if File.exist?(snippets_path) }
 
+    describe 'sync' do
       it 'git clones snippets' do
-        expect(Snippet).to receive(:system).with("git clone https://github.com/xinminlabs/synvert-snippets.git #{default_snippets_path}")
-        Snippet.sync
+        expect(Kernel).to receive(:system).with(
+          "git clone https://github.com/xinminlabs/synvert-snippets.git #{snippets_path}"
+        )
+        snippet.sync
       end
 
       it 'git pull snippets' do
-        FileUtils.mkdir default_snippets_path
-        expect(Snippet).to receive(:system).with("git pull --rebase")
-        Snippet.sync
+        FileUtils.mkdir snippets_path
+        expect(Kernel).to receive(:system).with('git pull --rebase')
+        snippet.sync
+        FileUtils.cd File.dirname(__FILE__)
       end
     end
 
-    describe "fetch_core_version" do
+    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"
+        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

data/synvert.gemspec

@@ -1,27 +1,29 @@
-# 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'
 
 Gem::Specification.new do |spec|
-  spec.name          = "synvert"
+  spec.name          = 'synvert'
   spec.version       = Synvert::VERSION
-  spec.authors       = ["Richard Huang"]
-  spec.email         = ["flyerhzm@gmail.com"]
-  spec.description   = %q{synvert is used to convert ruby code to better syntax.}
-  spec.summary       = %q{synvert = syntax + convert.}
-  spec.homepage      = "https://github.com/xinminlabs/synvert"
-  spec.license       = "MIT"
+  spec.authors       = ['Richard Huang']
+  spec.email         = ['flyerhzm@gmail.com']
+  spec.description   = 'synvert is used to convert ruby code to better syntax.'
+  spec.summary       = 'synvert = syntax + convert.'
+  spec.homepage      = 'https://github.com/xinminlabs/synvert'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   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.require_paths = ['lib']
+  spec.post_install_message = 'Please run `synvert --sync` first to sync snippets remotely.'
 
-  spec.add_runtime_dependency "synvert-core", ">= 0.5.0"
+  spec.add_runtime_dependency 'synvert-core', '>= 0.20.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Richard Huang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synvert-core
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   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
@@ -123,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: synvert = syntax + convert.
 test_files: