rbs-trace 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b10553866e335d8d7e7210d41cde3b905939b6ee26822994197c4bcfe8d324ce
-  data.tar.gz: ffa7d6f2f2bd57b7695b2e0622df519a0b0e830519aedb71185576038b514f3b
+  metadata.gz: 8a25eb287a611f0c087e0419da03b0d45b53735e3e1bfa9bbcf9018940f640a1
+  data.tar.gz: 70591151052c0e0695b3584b31551e0251987f8cc9b5c5c635db741d4b44c0d9
 SHA512:
-  metadata.gz: 6f91f4b6facc4ce53917e0b574e85eb4d6f3e11646ce32407e39b79226e310f072ec564a993ef4e9ab68868bc83a261c1756b238f658ad66298d005806a4540f
-  data.tar.gz: c63bfaf42df1456961c16f9903df32f05dabab967d4a0305457aa2288e0b2d12d5e0a8be5ad1d62cf47e21b6bddacd8c82cc4eede8c5b4f1615bd715d4281b45
+  metadata.gz: f3fd0ae96dc471248170fd72d639fc338026e7ecba577db2d3be8096652c9e28e9df4a1cf9c012a976da6951dcb0bbbcb12444d029206f9ac3384b9374538165
+  data.tar.gz: 204295de73d9fee188d8c5568546b09bd295173937b9037f1e957f7a4b2952af502b2a58ce2fc01927e29bdeeb866e8950d3b9549cf3f4960759e94d745f5a2f

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
   - rubocop-performance

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.6.0] - 2025-05-12
+
+- feat: Support inline comments using colon-prefixed RBS syntax
+- chore: Update gem dependencies
+
+## [0.5.1] - 2025-04-20
+
+- fix: Support nested modules defined with `::`
+
 ## [0.5.0] - 2025-03-30
 
 - feat: Add paths to control trace targets

data/README.md

@@ -114,6 +114,25 @@ end
 RBS::Trace.new(paths: Dir.glob("#{Dir.pwd}/app/models/**/*.rb"))
 ```
 
+### Change the format of embedded comments
+
+You can change the comment format.
+
+| `comment_format` | embedded comment |
+|---|---|
+| `:rbs_keyword` (default) | `# @rbs () -> void` |
+| `:rbs_colon` | `#: () -> void` |
+
+```ruby
+trace.save_comments(:rbs_colon)
+```
+
+or
+
+```bash
+$ rbs-trace inline --rb-dir=app --rb-dir=lib --comment-format=rbs_colon
+```
+
 ### Save RBS declarations as files
 
 ```ruby

data/lib/rbs/trace/cli/inline.rb

@@ -5,7 +5,7 @@ module RBS
     class CLI
       class Inline
         BANNER = <<~USAGE
-          Usage: rbs-trace inline --sig-dir=DIR --rb-dir=DIR
+          Usage: rbs-trace inline --sig-dir=DIR --rb-dir=DIR --comment-format=FORMAT
 
           Insert RBS inline comments from RBS files.
 
@@ -14,16 +14,19 @@ module RBS
             $ rbs-trace inline --sig-dir=sig --rb-dir=app
 
           Options:
+            --comment-format FORMAT: Format for comments (`rbs_keyword` or `rbs_colon`, default: `rbs_keyword`)
         USAGE
 
         # @rbs (Array[String]) -> void
         def run(args) # rubocop:disable Metrics
           sig_dir = Pathname.pwd.join("sig").to_s
           rb_dirs = [] #: Array[String]
+          comment_format = :rbs_keyword
 
           opts = OptionParser.new(BANNER)
           opts.on("--sig-dir DIR") { |dir| sig_dir = dir }
           opts.on("--rb-dir DIR") { |dir| rb_dirs << dir }
+          opts.on("--comment-format FORMAT") { |format| comment_format = format.to_sym }
           opts.parse!(args)
 
           if rb_dirs.empty?
@@ -35,7 +38,7 @@ module RBS
             rb_files = rb_dirs.flat_map { |rb_dir| Dir.glob("#{rb_dir}/**/*.rb") }
             rb_files.each do |path|
               file = File.new(path, decls)
-              file.rewrite
+              file.rewrite(comment_format)
             end
           end
         end

data/lib/rbs/trace/file.rb

@@ -27,11 +27,11 @@ module RBS
         end
       end
 
-      # @rbs () -> String
-      def with_rbs
+      # @rbs (?Symbol?) -> String
+      def with_rbs(comment_format = nil)
         result = Prism.parse_file(@path)
         comments = {} #: Hash[Integer, String]
-        result.value.accept(InlineCommentVisitor.new(@decls, comments))
+        result.value.accept(InlineCommentVisitor.new(@decls, comments, comment_format))
 
         lines = result.source.source.lines
         comments.keys.sort.reverse_each do |i|
@@ -42,9 +42,9 @@ module RBS
         lines.join
       end
 
-      # @rbs () -> void
-      def rewrite
-        ::File.write(@path, with_rbs)
+      # @rbs (?Symbol?) -> void
+      def rewrite(comment_format = nil)
+        ::File.write(@path, with_rbs(comment_format))
       end
 
       # @rbs () -> String

data/lib/rbs/trace/inline_comment_visitor.rb

@@ -3,10 +3,11 @@
 module RBS
   class Trace
     class InlineCommentVisitor < Prism::Visitor
-      # @rbs (Hash[TypeName, AST::Declarations::t], Hash[Integer, String]) -> void
-      def initialize(decls, comments)
+      # @rbs (Hash[TypeName, AST::Declarations::t], Hash[Integer, String], Symbol?) -> void
+      def initialize(decls, comments, comment_format)
         @decls = decls
         @comments = comments
+        @comment_prefix = comment_format == :rbs_colon ? "#:" : "# @rbs"
         @context = [] #: Array[Symbol]
 
         super()
@@ -15,17 +16,17 @@ module RBS
       # @rbs override
       # @rbs (Prism::Node) -> void
       def visit_class_node(node)
-        @context.push(node.name)
-        super
-        @context.pop
+        with_context node do
+          super
+        end
       end
 
       # @rbs override
       # @rbs (Prism::Node) -> void
       def visit_module_node(node)
-        @context.push(node.name)
-        super
-        @context.pop
+        with_context node do
+          super
+        end
       end
 
       # @rbs override
@@ -38,7 +39,7 @@ module RBS
           overloads = OverloadCompact.new(member.overloads).call
           comment = overloads.map(&:method_type).join(" | ")
 
-          @comments[lineno] = "#{indent}# @rbs #{comment}\n"
+          @comments[lineno] = "#{indent}#{@comment_prefix} #{comment}\n"
         end
 
         super
@@ -58,6 +59,19 @@ module RBS
           member.is_a?(AST::Members::MethodDefinition) && member.name == name
         end
       end
+
+      # @rbs (Prism::ModuleNode | Prism::ClassNode) { () -> void } -> void
+      def with_context(node)
+        constant_path = node.constant_path
+        raise if constant_path.is_a?(Prism::MissingNode) || constant_path.is_a?(Prism::CallNode)
+
+        names = constant_path.full_name_parts
+        @context.push(*names)
+
+        yield
+
+        @context.pop(names.size)
+      end
     end
   end
 end

data/lib/rbs/trace/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   class Trace
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/rbs/trace.rb

@@ -50,10 +50,10 @@ module RBS
       @files ||= {}
     end
 
-    # @rbs () -> void
-    def save_comments
+    # @rbs (?Symbol) -> void
+    def save_comments(comment_format = nil)
       files.each do |path, file|
-        file.rewrite if @paths.include?(path)
+        file.rewrite(comment_format) if @paths.include?(path)
       end
     end
 

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ccbd2bbc6be5c195df1d90aa68d64916a9e7d0ab
+    revision: 1e026936df951c269b64b7cba278132b0af42828
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
@@ -42,17 +42,25 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ccbd2bbc6be5c195df1d90aa68d64916a9e7d0ab
+    revision: 1e026936df951c269b64b7cba278132b0af42828
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
-  version: 3.8.1
+  version: 3.9.3
   source:
     type: rubygems
 - name: rdoc
   version: '0'
   source:
     type: stdlib
+- name: simplecov
+  version: '0.22'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 1e026936df951c269b64b7cba278132b0af42828
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: tsort
   version: '0'
   source:

data/sig/generated/rbs/trace/file.rbs

@@ -11,11 +11,11 @@ module RBS
       # @rbs (untyped, Class, Symbol) -> AST::Members::MethodDefinition?
       def find_or_new_method_definition: (untyped, Class, Symbol) -> AST::Members::MethodDefinition?
 
-      # @rbs () -> String
-      def with_rbs: () -> String
+      # @rbs (?Symbol?) -> String
+      def with_rbs: (?Symbol?) -> String
 
-      # @rbs () -> void
-      def rewrite: () -> void
+      # @rbs (?Symbol?) -> void
+      def rewrite: (?Symbol?) -> void
 
       # @rbs () -> String
       def to_rbs: () -> String

data/sig/generated/rbs/trace/inline_comment_visitor.rbs

@@ -3,8 +3,8 @@
 module RBS
   class Trace
     class InlineCommentVisitor < Prism::Visitor
-      # @rbs (Hash[TypeName, AST::Declarations::t], Hash[Integer, String]) -> void
-      def initialize: (Hash[TypeName, AST::Declarations::t], Hash[Integer, String]) -> void
+      # @rbs (Hash[TypeName, AST::Declarations::t], Hash[Integer, String], Symbol?) -> void
+      def initialize: (Hash[TypeName, AST::Declarations::t], Hash[Integer, String], Symbol?) -> void
 
       # @rbs override
       # @rbs (Prism::Node) -> void
@@ -22,6 +22,9 @@ module RBS
 
       # @rbs (Symbol) -> AST::Members::MethodDefinition?
       def find_method_definition: (Symbol) -> AST::Members::MethodDefinition?
+
+      # @rbs (Prism::ModuleNode | Prism::ClassNode) { () -> void } -> void
+      def with_context: (Prism::ModuleNode | Prism::ClassNode) { () -> void } -> void
     end
   end
 end

data/sig/generated/rbs/trace.rbs

@@ -23,8 +23,8 @@ module RBS
     # @rbs () -> Hash[String, File]
     def files: () -> Hash[String, File]
 
-    # @rbs () -> void
-    def save_comments: () -> void
+    # @rbs (?Symbol) -> void
+    def save_comments: (?Symbol) -> void
 
     # @rbs (out_dir: String) -> void
     def save_files: (out_dir: String) -> void

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Takumi Shotoku
 bindir: exe
 cert_chain: []
-date: 2025-03-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -88,8 +88,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/rbs-trace
-  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.5.0
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.5.0/CHANGELOG.md
+  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.6.0
+  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.6.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Automatically Insert inline RBS type declarations using runtime information.
 test_files: []