ruby-next 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60cb4fb34088c955545d17b1e3bbda33fb8cf499219c05a599425612dff7a659
-  data.tar.gz: 2526f31e135878c5a65b603d8605b6d8c422b746982422a1bded330600cf533a
+  metadata.gz: e404053f4c0ea48bfed4dca7cd28446c912b3371f2a318dae6da890ff0764be4
+  data.tar.gz: 4f520ce514d2a4d1b9ec5491e3d47fedf821ecb0841038e4f49b96f44ea7ddfd
 SHA512:
-  metadata.gz: 56ac9e4e59b9e7c701e2697421a2ef13cfcd8bb719e9ff6e3cc056fedb1f04871bf3e5affe14c2fd2656bf802e53f1e6e01fed14aa1f9f6af6a683023cd3099e
-  data.tar.gz: 616b66826563cec6b615ba9ccf4e92da338798074c60d4314d841ed35945cf785b9abce781c5b2d44cf7ac57576ec1b1d9c37a94c8bea0fd7cc64999d402be5c
+  metadata.gz: 17e38527a8ba3423c0c7f0605d0bdf76e32fbbed8c95608b1af708bba5ed00f8292d5e863a6a96af05a73e3217b168ce6c2508be033e52e6caeb0f0847962f29
+  data.tar.gz: 71b6e39a4b334728d96c5f62170bd80675475d10280b200da743dde105473ea52571c41a8e52504ac80065ec0e24e69b5a999d53601750736cec5d51ac3e750b

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.0.3 (2024-04-18)
+
+- Fix RuboCop compatibility.
+
+## 1.0.2 (2024-02-23)
+
+- Automatically mark context as dirty if `#safe_rewrite` modifies source code. ([@palkan][])
+
+- Add `context.path` to rewriters to access the current file path (if any). ([@palkan][])
+
 ## 1.0.1 (2024-01-28)
 
 - Fix using Data with inheritance (`class X < Data.define(...)`). ([@palkan][])

data/README.md

@@ -170,7 +170,7 @@ Ruby 3.2 has introduced a new core class—[Data](https://bugs.ruby-lang.org/iss
 
 If you want to opt-out from loading Data backport, you must set the `RUBY_NEXT_DISABLE_DATA` env variable to `true`.
 
-#### Known limitations
+#### Known limitations when using Data
 
 Currently, passing Hash as a last positional argument to `Data.new` is not supported in Ruby <3.0 (due to the difference in keyword arguments handling). We recommend always using keyword arguments when initializing Data objects.
 
@@ -565,6 +565,9 @@ Wonder what would happen if Ruby get a null coalescing operator (`??=`) or some
 
 Ruby Next allows you to write your own syntax rewriters. Full-featured rewriters (used by Ruby Next itself) operate on AST and usually require parser modifications. However, we also support text-based rewriters which can be used to experiment with new syntax much quicker without dealing with grammars, parsers and syntax trees.
 
+> [!TIP]
+> You can experiment with Ruby Next rewriters at our [online playground][playground]!
+
 To implement a text-based rewriter, you need to create a new class inherited from `RubyNext::Language::Rewriters::Text` and implementing either `#rewrite` or `#safe_rewrite` method. For example, the method reference operator (`.:`) could be implemented as follows:
 
 ```ruby
@@ -576,11 +579,7 @@ class MethodReferenceRewriter < RubyNext::Language::Rewriters::Text
   MIN_SUPPORTED_VERSION = Gem::Version.new(RubyNext::NEXT_VERSION)
 
   def safe_rewrite(source)
-    source.gsub(/\.:([\w_]+)/) do |match|
-      context.track! self
-
-      ".method(:#{$1})"
-    end
+    source.gsub(/\.:([\w_]+)/, '.method(:\1)')
   end
 end
 
@@ -588,9 +587,28 @@ end
 RubyNext::Language.rewriters << MethodReferenceRewriter
 ```
 
-The `context` object is responsible for tracking if the rewriter was used for the current file. You must call the `context.track!` method to mark the file as _dirty_ (i.e., it should be transpiled). The input parameter (`source`) is the Ruby source code of the file being transpiled and the output must be the transpiled source code.
+The `#safe_rewrite` method operates on the normalized source code (i.e., without comments and string literals). It's useful when you want to avoid transpiling inside strings or comments. If you want to transpile the original contents, you can use the `#rewrite` method instead. For example, if you want to rewrite comments:
+
+```ruby
+
+class NoteDateRewriter < RubyNext::Language::Rewriters::Text
+  NAME = "note-comment-date"
+  MIN_SUPPORTED_VERSION = Gem::Version.new(RubyNext::NEXT_VERSION)
+
+  def rewrite(source)
+    source.gsub("# NOTE:") do |_match|
+      context.track!(self)
+      "# NOTE (#{Date.today}):"
+    end
+  end
+end
+
+RubyNext::Language.rewriters << NoteDateRewriter
+```
+
+Note that we use the `context` object in the example above. It is responsible for tracking if the rewriter was used for the current file. You must call the `context.track!` method to mark the file as _dirty_ (i.e., it should be transpiled). The input parameter (`source`) is the Ruby source code of the file being transpiled and the output must be the transpiled source code. When using `#safe_rewrite`, marking content as dirty explicitly is not necessary.
 
-The `#safe_rewrite` method operates on the normalized source code (i.e., without comments and string literals). It's useful when you want to avoid transpiling inside strings or comments. If you want to transpile the original contents, you can use the `#rewrite` method instead.
+### Using parser combinators (Paco)
 
 Under the hood, `#safe_rewrite` uses [Paco][] to parse the source and separate string literals from the rest of the code. You can also leverage [Paco][] in your text rewriters, if you want more control on the parsing process. For better experience, we provide a DSL to define a custom parser and the `#parse` method to use it. Here is an example of implementing the `.:` operator using a Paco parser:
 
@@ -689,3 +707,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 [require-hooks]: https://github.com/ruby-next/require-hooks
 [Natalie]: https://natalie-lang.org
 [Paco]: https://github.com/ruby-next/paco
+[playground]: https://ruby-next.github.io

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-next
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: ruby-next-parser
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,7 @@ metadata:
   documentation_uri: https://github.com/ruby-next/ruby-next/blob/master/README.md
   homepage_uri: https://github.com/ruby-next/ruby-next
   source_code_uri: https://github.com/ruby-next/ruby-next
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Make older Rubies quack like edge Ruby
 test_files: []