ruby-next 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60cb4fb34088c955545d17b1e3bbda33fb8cf499219c05a599425612dff7a659
-  data.tar.gz: 2526f31e135878c5a65b603d8605b6d8c422b746982422a1bded330600cf533a
+  metadata.gz: 582bed282b94d002360230275370e6ba44507ee75294ea0e5a892a0d991e4bb2
+  data.tar.gz: 1e5a75bd9783c3e1f27b2285dbbbc9cc71e892bd4a4c2eab064beea568f32424
 SHA512:
-  metadata.gz: 56ac9e4e59b9e7c701e2697421a2ef13cfcd8bb719e9ff6e3cc056fedb1f04871bf3e5affe14c2fd2656bf802e53f1e6e01fed14aa1f9f6af6a683023cd3099e
-  data.tar.gz: 616b66826563cec6b615ba9ccf4e92da338798074c60d4314d841ed35945cf785b9abce781c5b2d44cf7ac57576ec1b1d9c37a94c8bea0fd7cc64999d402be5c
+  metadata.gz: 71d9afb628d2cff983b6a419c9bec6c8b1635af9aa70b40a8fd59e6e9daa95e78cc204fb84e02af2c6789e4f22622d093e04414b5618129c956fc3082b529090
+  data.tar.gz: e76d9077c8a7cda3351a4bb96b3836236b7d0ec7d0efabbdc3f192c51bd538445254fe9c7a8085d7c00b72647280a3d7ed5e8f5174f5d6074c900ba1482ea422

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 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.
 
@@ -576,11 +576,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 +584,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:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-next
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-23 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.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: ruby-next-parser
   requirement: !ruby/object:Gem::Requirement