ruby-next-core 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad6cea22baa599e5a6edeb4fdda1fb7c9bd0b0d5617fb01cf4450374c7d9443
-  data.tar.gz: fa39e7d51cdf70c32dc2067000023e42dbe3b23bd1d8bf520e06a3a028d63b8d
+  metadata.gz: ac9ab37024b70ac4ba553ceca25b7b63a0029ccf356787295b5d6509eb2b5461
+  data.tar.gz: a27ef393520aae1513047c234f999993ff0bc1dd6614e7aca8c5acf02561a7af
 SHA512:
-  metadata.gz: e7df787bfa90d036bbd45c7bd2dbc85f3513d922b3606dfde12ade0196f7ccb6789aba263d407fc012c7b4625d38b4aa6d7df05a5ac4e784b3b9cfc5db356b0f
-  data.tar.gz: a4c364d32b19003c219670096dd6420d415663445d68deb7e92c8d9763cc705884e7ab7e43fed81c6c084450f6a32e14bd8b50f24629256cb064c84a8bb87583
+  metadata.gz: 00b81f2df63fce2fb38da1470315a1d1fa2ae1e4ebc69b150712a9f02f2e5a07c7bb8f2776ae109ec4b3fd259567f674cf6df209f0d06fb4fa6e542467f44c7f
+  data.tar.gz: 7f201ea784a2707d0aec127086d5b76c1475fa7c60e984988ddb7c37262d6168cc86139112b71ea466502eba330e1fd6cf98fe6c674266dfb7e4b5c62d75d7b4

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:
 

data/bin/parse

@@ -17,3 +17,4 @@ contents =
 
 ast = RubyNext::Language.parse(contents)
 puts ast
+puts "\n // Parsed with #{RubyNext::Language.parser_class}"

data/bin/transform

@@ -12,8 +12,8 @@ begin
 rescue LoadError
 end
 
-ENV["RUBY_NEXT_EDGE"] = "1"
-ENV["RUBY_NEXT_PROPOSED"] = "1"
+ENV["RUBY_NEXT_EDGE"] ||= "1"
+ENV["RUBY_NEXT_PROPOSED"] ||= "1"
 
 require "ruby-next/language"
 require "ruby-next/language/rewriters/runtime"
@@ -44,3 +44,4 @@ OptionParser.new do |opts|
 end.parse!
 
 puts RubyNext::Language.transform(contents, **transform_opts)
+puts "\n // Parsed with #{RubyNext::Language.parser_class}"

data/lib/.rbnext/2.1/ruby-next/commands/nextify.rb

@@ -196,7 +196,7 @@ module RubyNext
 
         rewriters = specified_rewriters || Language.rewriters.select { |rw| rw.unsupported_version?(version) }
 
-        context = Language::TransformContext.new
+        context = Language::TransformContext.new(path: path)
 
         new_contents = Language.transform contents, context: context, rewriters: rewriters
 

data/lib/.rbnext/2.1/ruby-next/core.rb

@@ -68,7 +68,7 @@ module RubyNext
       def build_location(trace_locations)
         # The caller_locations behaviour depends on implementaion,
         # e.g. in JRuby https://github.com/jruby/jruby/issues/6055
-        while trace_locations.first.label != "patch"
+        while trace_locations.first.base_label != "patch"
           trace_locations.shift
         end
 

data/lib/.rbnext/2.1/ruby-next/language.rb

@@ -29,9 +29,10 @@ module RubyNext
     RewriterNotFoundError = Class.new(StandardError)
 
     class TransformContext
-      attr_reader :versions, :use_ruby_next
+      attr_reader :versions, :use_ruby_next, :path
 
-      def initialize
+      def initialize(path: nil)
+        @path = path
         # Minimum supported RubyNext version
         @min_version = MIN_SUPPORTED_VERSION
         @dirty = false
@@ -104,7 +105,7 @@ module RubyNext
         @runtime
       end
 
-      def transform(source, rewriters: self.rewriters, using: RubyNext::Core.refine?, context: TransformContext.new)
+      def transform(source, rewriters: self.rewriters, using: RubyNext::Core.refine?, path: nil, context: TransformContext.new(path: path))
         text_rewriters, ast_rewriters = rewriters.partition(&:text?)
 
         retried = 0

data/lib/.rbnext/2.3/ruby-next/commands/nextify.rb

@@ -196,7 +196,7 @@ module RubyNext
 
         rewriters = specified_rewriters || Language.rewriters.select { |rw| rw.unsupported_version?(version) }
 
-        context = Language::TransformContext.new
+        context = Language::TransformContext.new(path: path)
 
         new_contents = Language.transform contents, context: context, rewriters: rewriters
 

data/lib/.rbnext/2.3/ruby-next/config.rb

@@ -20,11 +20,16 @@ module RubyNext
 
   class << self
     # TruffleRuby claims its RUBY_VERSION to be X.Y while not supporting all the features
-    # Currently (23.0.1), it still doesn't support pattern matching, although claims to be "like 3.1".
+    # Currently (23.x), it still doesn't support pattern matching, although claims to be "like 3.1".
     # So, we fallback to 2.6.5 (since we cannot use 2.7).
+    # TruffleRuby 24.x seems to support pattern matching.
     if defined?(TruffleRuby)
       def current_ruby_version
-        "2.6.5"
+        if RUBY_ENGINE_VERSION >= "24.0.0"
+          "3.1.0"
+        else
+          "2.6.5"
+        end
       end
     else
       def current_ruby_version

data/lib/.rbnext/2.7/ruby-next/core.rb

@@ -68,7 +68,7 @@ module RubyNext
       def build_location(trace_locations)
         # The caller_locations behaviour depends on implementaion,
         # e.g. in JRuby https://github.com/jruby/jruby/issues/6055
-        while trace_locations.first.label != "patch"
+        while trace_locations.first.base_label != "patch"
           trace_locations.shift
         end
 

data/lib/.rbnext/2.7/ruby-next/language/rewriters/text.rb

@@ -109,7 +109,9 @@ module RubyNext
         # Rewrite source code by ignoring string literals and comments
         def rewrite(source)
           Normalizer.new.normalizing(source) do |normalized|
-            safe_rewrite(normalized)
+            safe_rewrite(normalized).tap do |rewritten|
+              context.track!(self) if rewritten != normalized
+            end
           end
         end
 

data/lib/ruby-next/commands/nextify.rb

@@ -198,7 +198,7 @@ module RubyNext
 
         rewriters = specified_rewriters || Language.rewriters.select { |rw| rw.unsupported_version?(version) }
 
-        context = Language::TransformContext.new
+        context = Language::TransformContext.new(path: path)
 
         new_contents = Language.transform contents, context: context, rewriters: rewriters
 

data/lib/ruby-next/config.rb

@@ -20,11 +20,16 @@ module RubyNext
 
   class << self
     # TruffleRuby claims its RUBY_VERSION to be X.Y while not supporting all the features
-    # Currently (23.0.1), it still doesn't support pattern matching, although claims to be "like 3.1".
+    # Currently (23.x), it still doesn't support pattern matching, although claims to be "like 3.1".
     # So, we fallback to 2.6.5 (since we cannot use 2.7).
+    # TruffleRuby 24.x seems to support pattern matching.
     if defined?(TruffleRuby)
       def current_ruby_version
-        "2.6.5"
+        if RUBY_ENGINE_VERSION >= "24.0.0"
+          "3.1.0"
+        else
+          "2.6.5"
+        end
       end
     else
       def current_ruby_version

data/lib/ruby-next/core/refinement/import.rb

@@ -36,7 +36,7 @@ RubyNext::Core.singleton_class.module_eval do
 
           begin
             if defined?(::RubyNext::Language) && ::RubyNext::Language.runtime?
-              new_source = ::RubyNext::Language.transform(buffer.join, rewriters: RubyNext::Language.current_rewriters, using: false)
+              new_source = ::RubyNext::Language.transform(buffer.join, rewriters: RubyNext::Language.current_rewriters, using: false, path: source_file)
               # Transformed successfully => valid method => evaluate transpiled code
               import << [new_source, source_file, lineno]
               buffer.clear

data/lib/ruby-next/core.rb

@@ -68,7 +68,7 @@ module RubyNext
       def build_location(trace_locations)
         # The caller_locations behaviour depends on implementaion,
         # e.g. in JRuby https://github.com/jruby/jruby/issues/6055
-        while trace_locations.first.label != "patch"
+        while trace_locations.first.base_label != "patch"
           trace_locations.shift
         end
 

data/lib/ruby-next/language/parser.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 begin
-  require "parser/prism"
+  require "prism"
+  require "prism/translation/parser"
 rescue LoadError
   require "parser/ruby33"
 end
@@ -71,9 +72,16 @@ module RubyNext
     unless parser_class
       self.parser_class = if defined?(::Parser::RubyNext)
         ::Parser::RubyNext
-      elsif defined?(::Parser::Prism)
-        parser_syntax_errors << ::Prism::ParserCompiler::CompilationError
-        ::Parser::Prism
+      elsif defined?(::Prism::Translation::Parser)
+        Class.new(::Prism::Translation::Parser) do
+          # Use this callback to ignore some parse-level errors, such as parsing numbered parameters
+          # when transpiling for older Ruby versions
+          def valid_error?(error)
+            !error.message.include?("is reserved for numbered parameters")
+          end
+        end.tap do |clazz|
+          Language.const_set(:PrismParser, clazz)
+        end
       else
         ::Parser::Ruby33
       end

data/lib/ruby-next/language/rewriters/3.1/shorthand_hash.rb

@@ -41,7 +41,7 @@ module RubyNext
           when :lvar
             node.children[0]
           else
-            raise ArgumentError, "Unsupport ipair node: #{node}"
+            raise SyntaxError, "#{node} is not allowed as a local variable name"
           end
         end
       end

data/lib/ruby-next/language/rewriters/abstract.rb

@@ -36,10 +36,8 @@ module RubyNext
             false
           end
 
-          private
-
-          def transform(source)
-            Language.transform(source, rewriters: [self], using: false)
+          def transform(source, **opts)
+            Language.transform(source, rewriters: [self], using: false, **opts)
           end
         end
 

data/lib/ruby-next/language/rewriters/edge/it_param.rb

@@ -50,7 +50,11 @@ module RubyNext
         end
 
         def it?(node)
-          node.is_a?(Parser::AST::Node) && node.type == :send && node.children[0].nil? && node.children[1] == :it && node.children[2].nil?
+          node.is_a?(Parser::AST::Node) && (
+            node.type == :send && node.children[0].nil? && node.children[1] == :it && node.children[2].nil?
+          ) || ( # Prism version
+            node.type == :lvar && node.children[0] == :"0it"
+          )
         end
       end
     end

data/lib/ruby-next/language/rewriters/proposed/method_reference.rb

@@ -12,11 +12,7 @@ module RubyNext
         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
     end

data/lib/ruby-next/language/rewriters/text.rb

@@ -109,7 +109,9 @@ module RubyNext
         # Rewrite source code by ignoring string literals and comments
         def rewrite(source)
           Normalizer.new.normalizing(source) do |normalized|
-            safe_rewrite(normalized)
+            safe_rewrite(normalized).tap do |rewritten|
+              context.track!(self) if rewritten != normalized
+            end
           end
         end
 

data/lib/ruby-next/language/runtime.rb

@@ -17,7 +17,7 @@ module RubyNext
       class << self
         def load(path, contents)
           contents ||= File.read(path)
-          new_contents = transform contents
+          new_contents = transform contents, path: path
 
           RubyNext.debug_source new_contents, path
 

data/lib/ruby-next/language.rb

@@ -29,9 +29,10 @@ module RubyNext
     RewriterNotFoundError = Class.new(StandardError)
 
     class TransformContext
-      attr_reader :versions, :use_ruby_next
+      attr_reader :versions, :use_ruby_next, :path
 
-      def initialize
+      def initialize(path: nil)
+        @path = path
         # Minimum supported RubyNext version
         @min_version = MIN_SUPPORTED_VERSION
         @dirty = false
@@ -104,7 +105,7 @@ module RubyNext
         @runtime
       end
 
-      def transform(source, rewriters: self.rewriters, using: RubyNext::Core.refine?, context: TransformContext.new)
+      def transform(source, rewriters: self.rewriters, using: RubyNext::Core.refine?, path: nil, context: TransformContext.new(path: path))
         text_rewriters, ast_rewriters = rewriters.partition(&:text?)
 
         retried = 0

data/lib/ruby-next/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyNext
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-next-core
 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: require-hooks