synvert-core 0.63.1 → 0.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5739f84132a6ece2551028571b7e6cb458812524f51ea11de6175eb621592d21
-  data.tar.gz: a55b00a9431cacbe740405294b351cd8c5a1face1f2c20ba3a61897316dc7bd4
+  metadata.gz: ea27da2bceb8ec0f2dd837e5aa80135860a2539c7e49170b2bd46af227d1043e
+  data.tar.gz: a901be4a294000eecfbbbf407416015cd9b38499ebc24c744147aebdeba5388f
 SHA512:
-  metadata.gz: ba153f740ea4d281dde99359dcf864beb49bdac33db3833878eebb9ba020966bb8957426936e65f7fc00ce84b76f7bb79fe2c01a5984ea155c5a4f6845c6e5b7
-  data.tar.gz: 6ff6c82355e35e6f86a42f01bcbd57b4e25d6c0ccef0079b89d4980bca26a983bf187526f9f5af150ee7a970d906b3cb22dd69b1af9f84263d3d8231d4673df7
+  metadata.gz: b9d0451d59718fe04e23d48a90e7e705fb455592d2636055064d9c5d7f6a1db20980ff1a38b147d77b16fdc8b059b95a8a95848c183a4115ddb1730541bf0757
+  data.tar.gz: 63246572cc0d9c3d44d7bb12f6d716e11b15fd1978376588e235a4c2f9b5e7849962ed4a81e38bd1a9f74c2cb877325148c486c9f3045ebf8c0aa80459d9b6aa

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 # CHANGELOG
 
-## 0.63.1 (2022-02-26)
+## 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/README.md

@@ -5,36 +5,76 @@
 ![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/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/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