synvert 0.4.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 09ddea7b3540df0923b7051d97e4713050222da7
-  data.tar.gz: be6e60c8d3e4eae741f4e5aade6300318a987b29
+SHA256:
+  metadata.gz: 430688d602830d6cbccecf277a580969288b875e992dc1447eb108a7ebd0726c
+  data.tar.gz: 6ea78cce8187cea7470bbc043978b318a4f0bd608bf13124cb9ec5f75917fe37
 SHA512:
-  metadata.gz: ea694f37dcb9db56b488d38bb6b8b347b6e962bc5d3b9431959db7d1f6d764f8e5a5206fc0a49a05e8837369e28420406dd0e088008f3b0d3f8ed5e8566c6003
-  data.tar.gz: e82714766f3fb2111ebff51e0415a9a05a7c6c7b856dcabb564a96c83f70aebbdeac33dadfb2cf669acf6b649a8ea5723cb95b396851075bc438a0b8160dffcb
+  metadata.gz: dad3de4c88092bba08138b0b64d70e92fa33ca2d8d4d7acea22d7b5e468e48fb2b08b8531832c985b03f5a4b6c2e0fda5f5aa415aae204c414fc5d14d18646c1
+  data.tar.gz: e500c57544648cb230f43e52658d58c36bde8a13f052c5e66441fc3471c43e867c8693a0b4fde23a9a9c6c69eae28c0d174ef5ddedec499ff6594a676b0beece

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 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
+
+## 0.4.2
+
+* Tell user to update synvert-core if necessary after syncing snippets.
+
 ## 0.4.0
 
 * Use synvert-core 0.4.0

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,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/synvert.rb

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

data/lib/synvert/cli.rb

@@ -1,6 +1,5 @@
 # coding: utf-8
 require 'optparse'
-require 'open-uri'
 
 module Synvert
   # Synvert command line interface.
@@ -16,8 +15,6 @@ 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')
     end
 
     # Run the CLI.
@@ -25,19 +22,29 @@ 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
-      else
+      when 'list'
+        load_rewriters
+        list_available_rewriters
+      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 ====="
-          rewriter = Core::Rewriter.call snippet_name
+          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,24 +58,27 @@ module Synvert
       puts "file #{e.diagnostic.location.source_buffer.name}"
       puts "line #{e.diagnostic.location.line}"
       false
-    rescue Exception => e
-      print "Error: "
-      p e
+    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.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
@@ -76,14 +86,14 @@ module Synvert
         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' do |snippet_name|
+        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' do |snippet_names|
+        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
@@ -92,48 +102,74 @@ module Synvert
         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)
+        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)
-        }.flatten
-        Core::Configuration.instance.set :skip_files, skip_files
+        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/
           uri = URI.parse snippet_path
           eval(uri.read)
         else
-          eval(File.read(snippet_path))
+          require snippet_path
         end
       end
+    rescue
+      FileUtils.rm_rf default_snippets_path
+      retry
     end
 
     # 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 |rewriter|
-          print rewriter.name.to_s + "  "
+        Core::Rewriter.availables.each do |group, rewriters|
+          puts group
+          rewriters.each do |name, rewriter|
+            puts '    ' + name
+          end
         end
         puts
       end
     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 |rewriter|
-        if rewriter.name.include? @options[:query]
-          print rewriter.name + "  "
+      Core::Rewriter.availables.each do |group, rewriters|
+        if group.include? @options[:query]
+          puts group
+          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])
+          end
         end
       end
       puts
@@ -141,15 +177,16 @@ module Synvert
 
     # Show and print one rewriter.
     def show_rewriter
-      rewriter = Core::Rewriter.fetch(@options[:snippet_name])
+      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 '=' * 80
           puts "snippet: #{sub_rewriter.name}"
-          puts "=" * 80
+          puts '=' * 80
           puts sub_rewriter.description
         end
       else
@@ -159,8 +196,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,17 +1,27 @@
 # coding: utf-8
+require 'open-uri'
+require 'json'
 
 module Synvert
   # Manage synvert snippets.
   class Snippet
+    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
-        `git pull --rebase --quiet`
+    def sync
+      if File.exist?(@snippets_path)
+        FileUtils.cd @snippets_path
+        Kernel.system('git pull --rebase')
       else
-        `git clone https://github.com/xinminlabs/synvert-snippets.git #{snippets_path} --quiet`
+        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
 
 module Synvert
-  VERSION = "0.4.0"
+  VERSION = '0.10.0'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert'
+require 'webmock/rspec'
 
 require 'coveralls'
 Coveralls.wear!

data/spec/synvert/snippet_spec.rb

@@ -2,19 +2,30 @@ require 'spec_helper'
 
 module Synvert
   describe Snippet 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) }
 
-    it 'git clones snippets' do
-      Snippet.sync
-      expect(File.exist?(default_snippets_path)).to be_truthy
+    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}")
+        snippet.sync
+      end
+
+      it 'git pull snippets' do
+        FileUtils.mkdir snippets_path
+        expect(Kernel).to receive(:system).with('git pull --rebase')
+        snippet.sync
+        FileUtils.cd File.dirname(__FILE__)
+      end
     end
 
-    it 'git pull snippets' do
-      Snippet.sync
-      Snippet.sync
-      expect(File.exist?(default_snippets_path)).to be_truthy
+    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

@@ -4,23 +4,24 @@ $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.add_runtime_dependency "synvert-core", "~> 0.2.0"
+  spec.add_runtime_dependency 'synvert-core', '>= 0.19.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: synvert
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Richard Huang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-26 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synvert-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.19.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
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: synvert is used to convert ruby code to better syntax.
 email:
 - flyerhzm@gmail.com
@@ -94,7 +108,7 @@ homepage: https://github.com/xinminlabs/synvert
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,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: