synvert-core 0.63.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5739f84132a6ece2551028571b7e6cb458812524f51ea11de6175eb621592d21
-  data.tar.gz: a55b00a9431cacbe740405294b351cd8c5a1face1f2c20ba3a61897316dc7bd4
+  metadata.gz: f889cb977b7bf6e847bdeeac011ee0d23210ae8db7a0652e8c00d5d98c72a701
+  data.tar.gz: 46d220401cc8c9c0422428c2915862148b4ad8dc236f637ed52dbc45207de742
 SHA512:
-  metadata.gz: ba153f740ea4d281dde99359dcf864beb49bdac33db3833878eebb9ba020966bb8957426936e65f7fc00ce84b76f7bb79fe2c01a5984ea155c5a4f6845c6e5b7
-  data.tar.gz: 6ff6c82355e35e6f86a42f01bcbd57b4e25d6c0ccef0079b89d4980bca26a983bf187526f9f5af150ee7a970d906b3cb22dd69b1af9f84263d3d8231d4673df7
+  metadata.gz: 926df3dd8aa3689938e90c530fb432e0703cff2f89f35f46950b3630eb98b8da6de0e0d5eb75c5c24262f3712400d4570ac05abd5ebbbe6c6954d6c997048432
+  data.tar.gz: 321fb626763ca31e6156c462bb6846ce73d00639a620b0b7048b024fbe50d14f63f6d3209e3a534b0475c29c29e74dcf0a7c204f14ad0927244bd5cbb157b3d6

data/.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -15,3 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+lib/synvert/core/node_query/lexer.rex.rb
+lib/synvert/core/node_query/parser.racc.rb
+lib/synvert/core/node_query/parser.output

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # CHANGELOG
 
-## 0.63.1 (2022-02-26)
+## 1.0.0 (2022-04-25)
+
+* Introduce new node query language
+* Drop ruby 2.5 support
+
+## 0.64.0 (2022-04-02)
 
 * Read absolute path of Gemfile.lock
+* Remove unused `Node#to_s`
+* Yardoc comments
+* Drop `within_direct_node(rules)`, use `within_node(rules, { direct: true })` instead
 
 ## 0.63.0 (2022-02-26)
 

data/Guardfile

@@ -2,6 +2,15 @@
 
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('lib/synvert/core/node_query/lexer.rex.rb') { 'spec/synvert/core/node_query/lexer_spec.rb'  }
+  watch('lib/synvert/core/node_query/compiler.rb') { 'spec/synvert/core/node_query/parser_spec.rb'  }
+  watch(%r{^lib/synvert/core/node_query/compiler/.*\.rb$}) { 'spec/synvert/core/node_query/parser_spec.rb' }
+  watch('lib/synvert/core/node_query/parser.racc.rb') { 'spec/synvert/core/node_query/parser_spec.rb' }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+guard :rake, task: 'generate' do
+  watch('lib/synvert/core/node_query/lexer.rex')
+  watch('lib/synvert/core/node_query/parser.y')
 end

data/README.md

@@ -2,39 +2,79 @@
 
 <img src="https://synvert.xinminlabs.com/img/logo_96.png" alt="logo" width="32" height="32" />
 
+[![AwesomeCode Status for xinminlabs/synvert-core-ruby](https://awesomecode.io/projects/033f7f02-7b22-41c3-a902-fca37f1ec72a/status)](https://awesomecode.io/repos/xinminlabs/synvert-core-ruby)
 ![Main workflow](https://github.com/xinminlabs/synvert-core-ruby/actions/workflows/main.yml/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/synvert-core.png)](http://badge.fury.io/rb/synvert-core)
 
-synvert-core-ruby provides a dsl to convert ruby source code.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'synvert-core'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install synvert-core
-
-
-## Documentation
-
-[Website][1]
-
-[RDoc][2]
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/synvert-core-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
-[1]: https://synvert.xinminlabs.com
-[2]: https://rubydoc.info/github/xinminlabs/synvert-core-ruby/master/frames
+Synvert core provides a set of DSLs to rewrite ruby code. e.g.
+
+```ruby
+Synvert::Rewriter.new 'ruby', 'map_and_flatten_to_flat_map' do
+  description <<~EOS
+    It converts `map` and `flatten` to `flat_map`
+
+    ```ruby
+    enum.map do
+      # do something
+    end.flatten
+    ```
+
+    =>
+
+    ```ruby
+    enum.flat_map do
+      # do something
+    end
+    ```
+  EOS
+
+  within_files Synvert::ALL_RUBY_FILES do
+    with_node type: 'send', receiver: { type: 'block', caller: { type: 'send', message: 'map' } }, message: 'flatten', arguments: { size: 0 } do
+      delete :message, :dot
+      replace 'receiver.caller.message', with: 'flat_map'
+    end
+  end
+end
+```
+
+Want to see more examples, check out [synvert-snippets-ruby](https://github.com/xinminlabs/synvert-snippets-ruby).
+
+Want to use the CLI, check out [synvert-ruby](https://github.com/xinminlabs/synvert-ruby).
+
+DSLs are as follows
+
+* [description](./Synvert/Core/Rewriter.html#description-instance_method) - set description of the rewriter
+* [if_ruby](./Synvert/Core/Rewriter.html#if_ruby-instance_method) - check if ruby version is greater than or equal to the specified ruby version
+* [if_gem](./Synvert/Core/Rewriter.html#if_gem-instance_method) - compare version of specified gem
+* [within_files](./Synvert/Core/Rewriter.html#within_files-instance_method) - find specified files
+* [within_file](./Synvert/Core/Rewriter.html#within_file-instance_method) - alias to within_files
+* [add_file](./Synvert/Core/Rewriter.html#add_file-instance_method) - add a new file
+* [remove_file](./Synvert/Core/Rewriter.html#remove_file-instance_method) - remove a file
+* [helper_method](./Synvert/Core/Rewriter.html#helper_method-instance_method) - define a helper method
+* [add_snippet](./Synvert/Core/Rewriter.html#add_snippet-instance_method) - call another rewriter
+* [todo](./Synvert/Core/Rewriter.html#todo-instance_method) - set todo
+* [redo_until_no_change](./Synvert/Core/Rewriter.html#redo_until_no_change-instance_method) - run the snippet until no change
+
+Scopes:
+
+* [within_node](./Synvert/Core/Rewriter/Instance.html#within_node-instance_method) - recursively find matching ast nodes
+* [with_node](./Synvert/Core/Rewriter/Instance.html#with_node-instance_method) - alias to within_node
+* [goto_node](./Synvert/Core/Rewriter/Instance.html#goto_node-instance_method) - go to a child node
+
+Conditions:
+
+* [if_exist_node](./Synvert/Core/Rewriter/Instance.html#if_exist_node-instance_method) - check if matching node exist in the child nodes
+* [unless_exist_node](./Synvert/Core/Rewriter/Instance.html#unless_exist_node-instance_method) - check if matching node doesn't exist in the child nodes
+* [if_only_exist_node](./Synvert/Core/Rewriter/Instance.html#if_only_exist_node-instance_method) - check if current node has only one child node and the child node matches rules
+
+Actions:
+
+* [append](./Synvert/Core/Rewriter/Instance.html#append-instance_method) - append the code to the bottom of current node body
+* [prepend](./Synvert/Core/Rewriter/Instance.html#prepend-instance_method) - prepend the code to the bottom of current node body
+* [insert](./Synvert/Core/Rewriter/Instance.html#insert-instance_method) - insert code
+* [insert_after](./Synvert/Core/Rewriter/Instance.html#insert_after-instance_method) - insert the code next to the current node
+* [replace](./Synvert/Core/Rewriter/Instance.html#replace-instance_method) - replace the code of specified child nodes
+* [delete](./Synvert/Core/Rewriter/Instance.html#delete-instance_method) - delete the code specified child nodes
+* [wrap](./Synvert/Core/Rewriter/Instance.html#wrap-instance_method) - wrap the current node with code
+* [replace_with](./Synvert/Core/Rewriter/Instance.html#replace_with-instance_method) - replace the whole code of current node
+* [warn](./Synvert/Core/Rewriter/Instance.html#warn-instance_method) - warn message
+* [replace_erb_stmt_with_expr](./Synvert/Core/Rewriter/Instance.html#replace_erb_stmt_with_expr-instance_method) - replace erb stmt code to expr code

data/Rakefile

@@ -2,7 +2,21 @@
 
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-
 RSpec::Core::RakeTask.new(:spec)
+require 'oedipus_lex'
+Rake.application.rake_require "oedipus_lex"
+
+file "lib/synvert/core/node_query/lexer.rex.rb" => "lib/synvert/core/node_query/lexer.rex"
+file "lib/synvert/core/node_query/parser.racc.rb" => "lib/synvert/core/node_query/parser.y"
+
+task :lexer  => "lib/synvert/core/node_query/lexer.rex.rb"
+task :parser => "lib/synvert/core/node_query/parser.racc.rb"
+task :generate  => [:lexer, :parser]
+
+rule '.racc.rb' => '.y' do |t|
+  cmd = "bundle exec racc -l -v -o #{t.name} #{t.source}"
+  sh cmd
+end
 
 task :default => :spec
+task :spec => :generate

data/lib/synvert/core/array_ext.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Extend Array.
+class Array
+  # Get child node by the name.
+  #
+  # @param child_name [String] name of child node.
+  # @return [Parser::AST::Node] the child node.
+  def child_node_by_name(child_name)
+    direct_child_name, nested_child_name = child_name.split('.', 2)
+    child_direct_child_node = direct_child_name =~ /\A\d+\z/ ? self[direct_child_name.to_i - 1] : self.send(direct_child_name)
+    return child_direct_child_node.child_node_by_name(nested_child_name) if nested_child_name
+    return child_direct_child_node if child_direct_child_node
+
+    raise Synvert::Core::MethodNotSupported,
+          "child_node_by_name is not handled for #{map(&:debug_info).join("\n")}, child_name: #{child_name}"
+  end
+
+  # Get the source range of child node.
+  #
+  # @param child_name [String] name of child node.
+  # @return [Parser::Source::Range] source range of child node.
+  def child_node_range(child_name)
+    direct_child_name, nested_child_name = child_name.split('.', 2)
+    child_direct_child_node = direct_child_name =~ /\A\d+\z/ ? self[direct_child_name.to_i - 1] : self.send(direct_child_name)
+    if nested_child_name
+      return child_direct_child_node.child_node_range(nested_child_name)
+    elsif child_direct_child_node
+      return (
+        Parser::Source::Range.new(
+          '(string)',
+          child_direct_child_node.loc.expression.begin_pos,
+          child_direct_child_node.loc.expression.end_pos
+        )
+      )
+    else
+      raise Synvert::Core::MethodNotSupported,
+            "child_node_range is not handled for #{map(&:debug_info).join("\n")}, child_name: #{child_name}"
+    end
+  end
+end

data/lib/synvert/core/configuration.rb

@@ -4,16 +4,28 @@ module Synvert::Core
   # Synvert global configuration.
   class Configuration
     class << self
+      # @!attribute [w] path
+      # @!attribute [w] skip_files
+      # @!attribute [w] show_run_process
       attr_writer :path, :skip_files, :show_run_process
 
+      # Get the path.
+      #
+      # @return [String] default is '.'
       def path
         @path || '.'
       end
 
+      # Get a list of skip files.
+      #
+      # @return [Array<String>] default is [].
       def skip_files
         @skip_files || []
       end
 
+      # Check if show run process.
+      #
+      # @return [Boolean] default is false
       def show_run_process
         @show_run_process || false
       end

data/lib/synvert/core/engine/erb.rb

@@ -43,11 +43,13 @@ module Synvert::Core
         end
 
         def decode_html_output(source)
-          source.gsub(/@output_buffer.safe_append='(.+?)'.freeze;/m) { reverse_escape_text(Regexp.last_match(1)) }.gsub(
-            /@output_buffer.safe_append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo
-          ) { reverse_escape_text(Regexp.last_match(1)) }.gsub(
-            /@output_buffer.safe_append=(.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo
-          ) { reverse_escape_text(Regexp.last_match(1)) }
+          source.gsub(/@output_buffer.safe_append='(.+?)'.freeze;/m) { reverse_escape_text(Regexp.last_match(1)) }
+                .gsub(
+                  /@output_buffer.safe_append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo
+                ) { reverse_escape_text(Regexp.last_match(1)) }
+                .gsub(
+                  /@output_buffer.safe_append=(.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo
+                ) { reverse_escape_text(Regexp.last_match(1)) }
         end
 
         def remove_erubis_buf(source)
@@ -64,6 +66,7 @@ module Synvert::Core
 
     # borrowed from rails
     class Erubis < ::Erubis::Eruby
+      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
       def add_preamble(src)
         @newline_pending = 0
         src << '@output_buffer = output_buffer || ActionView::OutputBuffer.new;'
@@ -76,7 +79,7 @@ module Synvert::Core
           @newline_pending += 1
         else
           src << "@output_buffer.safe_append='"
-          src << "\n" * @newline_pending if @newline_pending > 0
+          src << ("\n" * @newline_pending) if @newline_pending > 0
           src << escape_text(text)
           src << "'.freeze;"
 
@@ -95,8 +98,6 @@ module Synvert::Core
         end
       end
 
-      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
-
       def add_expr_literal(src, code)
         flush_newline_if_pending(src)
         if BLOCK_EXPR.match?(code)

data/lib/synvert/core/exceptions.rb

@@ -5,10 +5,6 @@ module Synvert::Core
   class RewriterNotFound < RuntimeError
   end
 
-  # Gemfile.lock not found exception.
-  class GemfileLockNotFound < RuntimeError
-  end
-
   # Method not supported exception.
   class MethodNotSupported < RuntimeError
   end