synvert 0.19.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b2cb7297283566f1929523ec1bd27886170ce2c8dc8b4ddf6e07a13d9139ba0
-  data.tar.gz: 64d388db47dd58a7d40e4a97d7ad954c474b795fd52cfcc39c850e9271b1ad01
+  metadata.gz: 13a6cfb15282317c912c0ddd99f6e4dfe5040c2ec28c8f7a1b60d2266b7f1517
+  data.tar.gz: c34227427bed2b0d7f3e29112fbd225ff46517fa20fc58c5c9d7c4e4d53a6e2e
 SHA512:
-  metadata.gz: 8c005363c25b19c5253732c9f262643fab4ea4c928aaf10bcc11aa5672cf55464864cc7518b1f74d81ae7fb1876f075a699beb9d0444b3de05aaee98d5a15725
-  data.tar.gz: c6d1bb9f75b6f8a06dfd37e7bf94df5bb9750911bc00c4b9059616dddeb4629e30619b7f1fe38daf6de7f7a806b4f8cc3effd90f740addf9a2f9babb39a04e63
+  metadata.gz: 9642ee80da8558c06b294ebc4e4ce786405d6f93455a3700ac5f3299abdfecba8ee2d2d6dc9cafa9f98c6984ce965075850d39b30573fc686673a74da4979809
+  data.tar.gz: 83b1a5dd39156e8e70725c58c13e1b9ec0968316944583a1153ac9d57fb64f2a9d696d6e515f59be7c2535b1c10a406577fcefa56b1f792d27fcbac779615286

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 1.0.0 (2022-09-17)
+
+* Test a snippet
+* Require single rewriter instead of loading all rewriters
+* Execute command can be either run or test
+* Add `skip_path` and `only_paths` options
+
+## 0.20.0 (2022-08-20)
+
+* Rename `load_rewriters` to `read_rewriters`
+* Run a snippet from remote url or local file path
+
 ## 0.19.3 (2022-07-18)
 
 * Require json

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    synvert (1.0.0)
+      synvert-core (>= 1.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    erubis (2.7.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    minitest (5.16.3)
+    node_mutation (1.3.3)
+      activesupport (< 7.0.0)
+      erubis
+    node_query (1.6.0)
+      activesupport (< 7.0.0)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    parser_node_ext (0.4.0)
+      parser
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    synvert-core (1.8.0)
+      activesupport (< 7.0.0)
+      erubis
+      node_mutation
+      node_query
+      parser
+      parser_node_ext
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  coveralls
+  rake
+  rspec
+  synvert!
+  webmock
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -1,6 +1,6 @@
 # Synvert
 
-<img src="https://synvert.xinminlabs.com/img/logo_96.png" alt="logo" width="32" height="32" />
+<img src="https://synvert.net/img/logo_96.png" alt="logo" width="32" height="32" />
 
 [![AwesomeCode Status for xinminlabs/synvert-ruby](https://awesomecode.io/projects/47cd9805-171c-4c61-b927-baa46cd4020a/status)](https://awesomecode.io/repos/xinminlabs/synvert-ruby)
 ![Main workflow](https://github.com/xinminlabs/synvert-ruby/actions/workflows/main.yml/badge.svg)
@@ -40,7 +40,6 @@ $ synvert-ruby -r factory_bot/use_short_syntax
 ```
 $ synvert-ruby -h
 Usage: synvert-ruby [project_path]
-    -d, --load SNIPPET_PATHS         load custom snippets, snippet paths can be local file path or remote http url
     -l, --list                       list all available snippets
     -q, --query QUERY                query specified snippets
     -s, --show SNIPPET_NAME          show specified snippet description, SNIPPET_NAME is combined by group and name, e.g. ruby/new_hash_syntax
@@ -48,9 +47,11 @@ Usage: synvert-ruby [project_path]
     -g, --generate NEW_SNIPPET_NAME  generate a new snippet
         --sync                       sync snippets
         --execute                    execute snippet
-    -r, --run SNIPPET_NAME           run specified snippet, e.g. ruby/new_hash_syntax
+    -r, --run SNIPPET_NAME           run a snippet with snippet name, e.g. ruby/new_hash_syntax, or remote url, or local file path
+    -t, --test SNIPPET_NAME          test a snippet with snippet name, e.g. ruby/new_hash_syntax, or remote url, or local file path
         --show-run-process           show processing files when running a snippet
-        --skip FILE_PATTERNS         skip specified files or directories, separated by comma, e.g. app/models/post.rb,vendor/plugins/**/*.rb
+        --only-paths DIRECTORIES     only specified files or directories, separated by comma, e.g. app/models,app/controllers
+        --skip-paths FILE_PATTERNS   skip specified files or directories, separated by comma, e.g. vendor/,lib/**/*.rb
     -f, --format FORMAT              output format
     -v, --version                    show this version
 ```
@@ -99,10 +100,28 @@ Run a snippet, analyze and then rewrite code.
 $ synvert-ruby -r factory_bot/use_short_syntax ~/Sites/xinminlabs/synvert-core-ruby
 ```
 
-Load custom snippet
+Run a snippet from remote url
 
 ```
-$ synvert-ruby --load ~/.custom-snippets/my-own-snippet.rb -r my-own-snippet ~/Sites/xinminlabs/synvert-core-ruby
+$ synvert-ruby -r https://raw.githubusercontent.com/xinminlabs/synvert-snippets-ruby/master/lib/factory_bot/use_short_syntax.rb ~/sites/xinminlabs/synvert-core-ruby
+```
+
+Run a snippet from local path
+
+```
+$ synvert-ruby -r ~/.synvert-ruby/lib/factory_bot/use_short_syntax.rb ~/sites/xinminlabs/synvert-core-ruby
+```
+
+Skip paths
+
+```
+$ synvert-ruby -r factory_bot/use_short_syntax --skip-paths vendor/ ~/sites/xinminlabs/synvert-core-ruby
+```
+
+Only paths
+
+```
+$ synvert-ruby -r factory_bot/use_short_syntax --only-paths app/models/ ~/sites/xinminlabs/synvert-core-ruby
 ```
 
 Show processing files when running a snippet.

data/lib/synvert/cli.rb

@@ -2,6 +2,8 @@
 
 require 'optparse'
 require 'json'
+require 'uri'
+require 'open-uri'
 
 module Synvert
   # Synvert command line interface.
@@ -16,7 +18,7 @@ module Synvert
 
     # Initialize a CLI.
     def initialize
-      @options = { command: 'run', custom_snippet_paths: [], format: 'plain' }
+      @options = { command: 'run', format: 'plain' }
     end
 
     # Run the CLI.
@@ -27,12 +29,12 @@ module Synvert
 
       case @options[:command]
       when 'list'
-        load_rewriters
+        read_rewriters
         list_available_rewriters
       when 'open'
         open_rewriter
       when 'query'
-        load_rewriters
+        read_rewriters
         query_available_rewriters
       when 'show'
         show_rewriter
@@ -41,11 +43,15 @@ module Synvert
       when 'generate'
         generate_snippet
       when 'execute'
-        execute_snippet
+        execute_snippet(@options[:execute_command])
+      when 'test'
+        group, name = get_snippet_name(@options[:snippet_name])
+        test_snippet(group, name)
+      when 'run'
+        group, name = get_snippet_name(@options[:snippet_name])
+        run_snippet(group, name)
       else
-        # run
-        load_rewriters
-        run_snippet
+        # nothing to do
       end
       true
     rescue SystemExit
@@ -67,11 +73,6 @@ module Synvert
       optparse =
         OptionParser.new do |opts|
           opts.banner = 'Usage: synvert-ruby [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
@@ -96,18 +97,28 @@ module Synvert
           opts.on '--sync', 'sync snippets' do
             @options[:command] = 'sync'
           end
-          opts.on '--execute', 'execute snippet' do
+          opts.on '--execute', 'execute snippet' do |execute_command|
             @options[:command] = 'execute'
+            @options[:execute_command] = execute_command
+          end
+          opts.on '-r', '--run SNIPPET_NAME', 'run a snippet with snippet name, e.g. ruby/new_hash_syntax, or remote url, or local file path' do |snippet_name|
+            @options[:command] = 'run'
+            @options[:snippet_name] = snippet_name
           end
-          opts.on '-r', '--run SNIPPET_NAME', 'run specified snippet, e.g. ruby/new_hash_syntax' do |snippet_name|
+          opts.on '-t', '--test SNIPPET_NAME', 'test a snippet with snippet name, e.g. ruby/new_hash_syntax, or remote url, or local file path' do |snippet_name|
+            @options[:command] = 'test'
             @options[:snippet_name] = snippet_name
           end
           opts.on '--show-run-process', 'show processing files when running a snippet' do
             Core::Configuration.show_run_process = true
           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(',')
+          opts.on '--only-paths DIRECTORIES',
+                  'only specified files or directories, separated by comma, e.g. app/models,app/controllers' do |directories|
+            @options[:only_paths] = directories
+          end
+          opts.on '--skip-paths FILE_PATTERNS',
+                  'skip specified files or directories, separated by comma, e.g. vendor/,lib/**/*.rb' do |file_patterns|
+            @options[:skip_paths] = file_patterns
           end
           opts.on '-f', '--format FORMAT', 'output format' do |format|
             @options[:format] = format
@@ -118,32 +129,18 @@ module Synvert
           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
-        Core::Configuration.skip_files = skip_files
+      Core::Configuration.root_path = paths.first || Dir.pwd
+      if @options[:only_paths] && !@options[:only_paths].empty?
+        Core::Configuration.only_paths = @options[:only_paths].split(",").map { |only_path| only_path.strip }
+      end
+      if @options[:skip_paths] && !@options[:skip_paths].empty?
+        Core::Configuration.skip_paths = @options[:skip_paths].split(",").map { |skip_path| skip_path.strip }
       end
     end
 
-    # Load all rewriters.
-    def load_rewriters
+    # read all rewriters.
+    def read_rewriters
       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)
-          uri = URI.parse snippet_path
-          eval(uri.read)
-        else
-          require snippet_path
-        end
-      end
-    rescue StandardError
-      FileUtils.rm_rf default_snippets_home
-      retry
     end
 
     # List and print all available rewriters.
@@ -233,20 +230,40 @@ module Synvert
       end
     end
 
-    # run snippets
-    def run_snippet
-      snippet_name = @options[:snippet_name]
+    # get snippet name
+    # it can get from explicit snippet name,
+    # or from local path or http url.
+    def get_snippet_name(snippet_name)
+      if /^http/.match?(snippet_name)
+        uri = URI.parse(snippet_name)
+        eval(uri.open.read)
+        get_last_snippet_name
+      elsif File.exists?(snippet_name)
+        require(snippet_name)
+        get_last_snippet_name
+      else
+        require(File.join(default_snippets_home, 'lib', "#{snippet_name}.rb"))
+        snippet_name.split('/')
+      end
+    end
+
+    # get snippet name by user inputs
+    def get_snippet_name_by_input(input)
+      rewriter = eval(input)
+      get_last_snippet_name
+    end
+
+    # run a snippet
+    def run_snippet(group, name)
       if plain_output?
-        puts "===== #{snippet_name} started ====="
-        group, name = snippet_name.split('/')
+        puts "===== #{group}/#{name} started ====="
         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 ====="
+        puts "===== #{group}/#{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(Set.new, &:affected_files)).to_a,
@@ -257,25 +274,20 @@ module Synvert
       end
     end
 
+    # test a snippet
+    def test_snippet(group, name)
+      rewriter = Core::Rewriter.fetch(group, name)
+      results = rewriter.test
+      puts JSON.generate(results)
+    end
+
     # execute snippet
-    def execute_snippet
-      input = STDIN.read
-      if plain_output?
-        puts '===== execute started ====='
-        rewriter = eval(input)
-        rewriter.warnings.each do |warning|
-          puts '[Warn] ' + warning.message
-        end
-        puts rewriter.todo if rewriter.todo
-        puts '===== execute done ====='
-      elsif json_output?
-        rewriter = eval(input)
-        output = {
-          affected_files: rewriter.affected_files.union(rewriter.sub_snippets.sum(Set.new, &:affected_files)).to_a,
-          warnings: rewriter.warnings.union(rewriter.sub_snippets.sum([], &:warnings)),
-          todo: rewriter.todo
-        }
-        puts JSON.generate(output)
+    def execute_snippet(execute_command)
+      group, name = get_snippet_name_by_input(STDIN.read)
+      if execute_command == 'test'
+        test_snippet(group, name)
+      else
+        run_snippet(group, name)
       end
     end
 
@@ -338,5 +350,12 @@ module Synvert
     def json_output?
       @options[:format] == 'json'
     end
+
+    # get the last registered snippet name
+    def get_last_snippet_name
+      group = Rewriter.availables.keys.last
+      name = Rewriter.availables[group].keys.last
+      return group, name
+    end
   end
 end

data/lib/synvert/version.rb

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

data/synvert-ruby.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.post_install_message = 'Please run `synvert-ruby --sync` first to sync snippets remotely.'
 
-  spec.add_runtime_dependency 'synvert-core', '>= 1.5.0'
+  spec.add_runtime_dependency 'synvert-core', '>= 1.8.0'
 
   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.19.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synvert-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,7 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile