rbs-trace 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa35a17dce6177b82270290080a095b19ee61015245ce8d64621990b7634635
-  data.tar.gz: c6ec9bb2c2387b4c421e03bab6d3aec654eff71e1d814c680027952ccd4d6805
+  metadata.gz: 66c8c25570faea268f27c79d9a91cd4b0768e326e6c013fac3ea5bffb2c94bb5
+  data.tar.gz: 1fdefe3317b2a9c59600e1182fbfcd4b267020bc63c9bf9537f128b00d3543d7
 SHA512:
-  metadata.gz: cfabe32a33ba27850b286c2a6ab5bbf33d382dea09cfb6e6bc828d9c3aac949b644ad9cd8afbbc2bbc3f3c873c6200ccb9743f7ee04143ec3eb38ff2eb35f382
-  data.tar.gz: 4dbdea59fdf5711777c5a3b9ed5e07e8420c901fe6a156d9e710e31227c437220001974e848c678adef096aef279a277b2679c11329ae7f32c43841b65649edb
+  metadata.gz: ead299e9457dcd8c8b00b363110a57448cc935a6d634009d584966d9c913588708e48618b56a88ff69550f6fe7c2c911a5db33a51711b480f221ee36fe18b72c
+  data.tar.gz: 668d6007a51b4836fbd6c8ff0eadb9e59a30f60d1a53cf0498572778e6d27612e77bfb4426ffb44760433e2d3b9c9065cb01d36ede3f5a77c5115d168fa3fbd0

data/.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/base:1-bookworm",
+  "features": {
+    "ghcr.io/devcontainers/features/ruby:1": {
+      "version": "3.4.4"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "GitHub.copilot",
+        "Shopify.ruby-lsp",
+        "soutaro.steep-vscode"
+      ]
+    }
+  }
+}

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.7.0] - 2025-09-01
+
+- feat: Add support for generics other than Array, Range, and Hash
+
+## [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 `::`

data/README.md

@@ -114,12 +114,45 @@ 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
 trace.save_files(out_dir: "sig/trace/")
 ```
 
+### Specify generics size
+
+By default, generics are applied to the generated results only in the following classes.
+
+- Array
+- Hash
+- Range
+
+If any other classes require generics, configure them as follows.
+
+```ruby
+trace.add_generics_size!("CSV::Table" => 1, "ActiveSupport::HashWithIndifferentAccess" => 2)
+```
+
 ### Parallel testing
 
 If you are using a parallel testing gem such as [parallel_tests](https://github.com/grosser/parallel_tests) or [flatware](https://github.com/briandunn/flatware), first save the type definitions in RBS files.

data/lib/rbs/trace/builder.rb

@@ -9,12 +9,12 @@ module RBS
       UNBOUND_NAME_METHOD = Class.instance_method(:name)
       private_constant :UNBOUND_CLASS_METHOD, :UNBOUND_NAME_METHOD
 
-      GENERICS_SIZE = {
-        Array => 1,
-        Range => 1,
-        Hash => 2
-      }.freeze
-      private_constant :GENERICS_SIZE
+      DEFAULT_GENERICS_SIZE = {
+        "Array" => 1,
+        "Range" => 1,
+        "Hash" => 2
+      }.freeze #: Hash[String, Integer]
+      private_constant :DEFAULT_GENERICS_SIZE
 
       # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
       def method_call(bind:, parameters:, void:)
@@ -37,6 +37,11 @@ module RBS
         AST::Members::MethodDefinition::Overload.new(method_type:, annotations: [])
       end
 
+      # @rbs () -> Hash[String, Integer]
+      def generics_size
+        @generics_size ||= DEFAULT_GENERICS_SIZE.dup
+      end
+
       private
 
       def stack_traces
@@ -115,7 +120,7 @@ module RBS
         elsif klass == Object || class_name.nil?
           type_untyped
         else
-          size = GENERICS_SIZE[klass].to_i
+          size = generics_size[klass.name].to_i
           args = Array.new(size) { type_untyped }
           Types::ClassInstance.new(name: TypeName.parse(class_name), args:, location: nil)
         end

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()
@@ -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

data/lib/rbs/trace/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   class Trace
-    VERSION = "0.5.1"
+    VERSION = "0.7.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
 
@@ -62,6 +62,11 @@ module RBS
       files.each_value { |file| file.save_rbs(out_dir) }
     end
 
+    # @rbs (Hash[String, Integer]) -> Hash[String, Integer]
+    def add_generics_size!(additional_generics_size)
+      builder.generics_size.merge!(additional_generics_size)
+    end
+
     private
 
     # @rbs () -> Array[String]

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/builder.rbs

@@ -9,7 +9,7 @@ module RBS
 
       UNBOUND_NAME_METHOD: untyped
 
-      GENERICS_SIZE: untyped
+      DEFAULT_GENERICS_SIZE: Hash[String, Integer]
 
       # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
       def method_call: (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
@@ -17,6 +17,9 @@ module RBS
       # @rbs (__todo__) -> AST::Members::MethodDefinition::Overload
       def method_return: (__todo__) -> AST::Members::MethodDefinition::Overload
 
+      # @rbs () -> Hash[String, Integer]
+      def generics_size: () -> Hash[String, Integer]
+
       private
 
       def stack_traces: () -> untyped

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

data/sig/generated/rbs/trace.rbs

@@ -23,12 +23,15 @@ 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
 
+    # @rbs (Hash[String, Integer]) -> Hash[String, Integer]
+    def add_generics_size!: (Hash[String, Integer]) -> Hash[String, Integer]
+
     private
 
     # @rbs () -> Array[String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Takumi Shotoku
@@ -47,6 +47,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -88,8 +89,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/rbs-trace
-  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.5.1
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.5.1/CHANGELOG.md
+  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.7.0
+  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.7.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Automatically Insert inline RBS type declarations using runtime information.
 test_files: []