rbs-trace 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b5ec23a4828eaf4ac618e5589d1d68578e85d11033efb676350ad19cbd660d
-  data.tar.gz: e313d83a44217fec2c8db6e33f84c03fff39ae7c300c9168f64fdaf62c61c416
+  metadata.gz: e587e127bc2689a2d6e3c9f25dad32a5b75b49164b8666d0c0ff891d9c6e35f4
+  data.tar.gz: 47cb65ce7cef30a14cc68984e7a76614ca593a1581a439b34341386937c65591
 SHA512:
-  metadata.gz: eef77ab67d92f461c1faa8266227678985cf79afef932abf02beb90f63e766de36cf688a7f23ba5457b63de67de46caf974a285325bbd03c9b74ef9d08504bd3
-  data.tar.gz: dc73fef50a753cad90f0f00d83613f7199bc297ea4f159fd65d042d8ea3fe36c8ee9f76cf6af441c0eeae3fa25beada143527158858521c05becb84847aa635a
+  metadata.gz: 3ccd45b222189e14609f8ef30f207341dbf6a4ed863a4c94b5cf051d28504f84cd8d101a68905de787ac5661f9bc7b9432162b81abbda85868e40e14cc741ebd
+  data.tar.gz: 158f74515cad425793edcc6f7d68c2ee8140afb36d9922ee80b6d1c21c020db748c9842c9b3bc6c15d330c2a12834681c6082b3e373c9ae669ccc379337ed626

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.2] - 2024-12-29
+
+- fix: Do not insert comments if comment `#:` exists
+
+## [0.3.1] - 2024-10-19
+
+- fix: Fix the number of types specified in generics
+- fix: Fix the type of the method that raises the exception
+
 ## [0.3.0] - 2024-10-10
 
 - feat: Support eval

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/rbs-trace.svg)](https://badge.fury.io/rb/rbs-trace)
+[![Test](https://github.com/sinsoku/rbs-trace/actions/workflows/test.yml/badge.svg)](https://github.com/sinsoku/rbs-trace/actions/workflows/test.yml)
+
 # RBS::Trace
 
 RBS::Trace collects argument types and return value types using TracePoint, and inserts inline RBS type declarations into files.

data/Rakefile

@@ -19,9 +19,4 @@ task :steep do
   sh "steep check"
 end
 
-default = if RUBY_VERSION.start_with?("3.3")
-            %i[spec rubocop rbs_inline steep]
-          else
-            %i[spec rubocop]
-          end
-task(default:)
+task(default: %i[spec rubocop rbs_inline steep])

data/lib/rbs/trace/declaration.rb

@@ -44,9 +44,9 @@ module RBS
       # TODO: support block argument
       # @rbs () -> String
       def parameters_rbs
-        converted = {}
+        converted = {} #: Hash[Symbol, Array[String?]]
         @parameters.each do |kind, name, klass|
-          converted[kind] ||= []
+          converted[kind] ||= [] #: Array[String?]
           converted[kind] << convert(kind, name, klass)
         end
 
@@ -80,8 +80,10 @@ module RBS
             nil
           elsif [TrueClass, FalseClass].include?(k) # steep:ignore ArgumentTypeMismatch
             "bool"
-          elsif [Array, Hash].include?(k) # steep:ignore ArgumentTypeMismatch
+          elsif [Array, Range].include?(k) # steep:ignore ArgumentTypeMismatch
             "#{k}[untyped]"
+          elsif k == Hash
+            "#{k}[untyped, untyped]"
           elsif k == Object
             "untyped"
           else

data/lib/rbs/trace/file.rb

@@ -37,9 +37,13 @@ module RBS
 
       # @rbs (Array[String], Definition) -> boolish
       def skip_insert?(lines, definition)
-        prev = definition.lineno - 2
+        current = definition.lineno - 1
+        prev = current - 1
 
-        definition.decls.empty? || lines[prev]&.include?("# @rbs")
+        definition.decls.empty? ||
+          lines[prev]&.include?("# @rbs") ||
+          lines[prev]&.include?("#:") ||
+          lines[current]&.include?("#:")
       end
 
       # @rbs () -> Enumerator[Definition, void]

data/lib/rbs/trace/method_tracing.rb

@@ -32,7 +32,7 @@ module RBS
 
       # @rbs () -> TracePoint
       def trace
-        @trace ||= TracePoint.new(:call, :return, :raise) { |tp| record(tp) }
+        @trace ||= TracePoint.new(:call, :return) { |tp| record(tp) }
       end
 
       # @rbs () -> Logger
@@ -57,12 +57,14 @@ module RBS
       # @rbs (File, TracePoint) -> Definition
       def find_or_new_definition(file, tp)
         name = tp.method_id
-        is_singleton = tp.defined_class.singleton_class?
+        is_singleton = tp.defined_class.singleton_class? # steep:ignore NoMethod
         klass = is_singleton ? tp.self : tp.defined_class
         mark = is_singleton ? "." : "#"
         signature = "#{klass}#{mark}#{name}"
 
+        # steep:ignore:start
         file.definitions[signature] ||= Definition.new(klass:, name:, lineno: tp.lineno)
+        # steep:ignore:end
       end
 
       # @rbs (TracePoint) -> void
@@ -75,7 +77,7 @@ module RBS
         case tp.event
         when :call
           call_event(tp)
-        when :return, :raise
+        when :return
           return_event(tp, definition)
         end
       rescue StandardError => e
@@ -84,7 +86,7 @@ module RBS
 
       # @rbs (TracePoint) -> void
       def call_event(tp) # rubocop:disable Metrics
-        parameters = tp.parameters.filter_map do |kind, name|
+        parameters = tp.parameters.filter_map do |kind, name| # steep:ignore NoMethod
           # steep:ignore:start
           value = tp.binding.local_variable_get(name) if name && !%i[* ** &].include?(name)
           # steep:ignore:end
@@ -101,7 +103,9 @@ module RBS
                   end
           [kind, name, klass]
         end
+        # steep:ignore:start
         stack_traces << Declaration.new(parameters, void: !assign_return_value?(tp.path, tp.method_id))
+        # steep:ignore:end
       end
 
       # @rbs (TracePoint, Definition) -> void
@@ -110,7 +114,7 @@ module RBS
         # TODO: check usecase where decl is nil
         return unless decl
 
-        decl.return_type = tp.event == :return ? [obj_to_class(tp.return_value)] : [NilClass]
+        decl.return_type = [obj_to_class(tp.return_value)]
         definition.decls << decl
       end
 
@@ -121,7 +125,7 @@ module RBS
 
       # @rbs (String) -> bool
       def ignore_path?(path)
-        bundle_path = Bundler.bundle_path.to_s # steep:ignore UnknownConstant
+        bundle_path = Bundler.bundle_path.to_s # steep:ignore NoMethod
         ruby_lib_path = RbConfig::CONFIG["rubylibdir"]
 
         path.start_with?("<internal") ||
@@ -169,7 +173,7 @@ module RBS
       def parsed_nodes(path)
         return unless ::File.exist?(path)
 
-        @parsed_nodes ||= {}
+        @parsed_nodes ||= {} #: Hash[String, Prism::ParseResult]
         @parsed_nodes[path] ||= Prism.parse_file(path)
         @parsed_nodes[path].value
       end

data/lib/rbs/trace/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   module Trace
-    VERSION = "0.3.0"
+    VERSION = "0.3.2"
   end
 end

data/rbs_collection.lock.yaml

@@ -6,13 +6,17 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f18921b7bd1280daab3ab218b7e3939748515eb1
+    revision: ccbd2bbc6be5c195df1d90aa68d64916a9e7d0ab
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
   version: '0'
   source:
     type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
 - name: logger
   version: '0'
   source:
@@ -21,8 +25,16 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
 - name: prism
-  version: 0.30.0
+  version: 1.2.0
   source:
     type: rubygems
 - name: rake
@@ -30,7 +42,23 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f18921b7bd1280daab3ab218b7e3939748515eb1
+    revision: ccbd2bbc6be5c195df1d90aa68d64916a9e7d0ab
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
+- name: rbs
+  version: 3.8.1
+  source:
+    type: rubygems
+- name: rbs-inline
+  version: 0.10.0
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
 gemfile_lock_path: Gemfile.lock

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Takumi Shotoku
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -41,8 +40,6 @@ files:
 - README.md
 - Rakefile
 - Steepfile
-- gemfiles/3.1.gemfile
-- gemfiles/3.1.gemfile.lock
 - lib/rbs-trace.rb
 - lib/rbs/trace.rb
 - lib/rbs/trace/declaration.rb
@@ -64,10 +61,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/rbs-trace
-  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.3.0
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.3.0/CHANGELOG.md
+  source_code_uri: https://github.com/sinsoku/rbs-trace/tree/v0.3.2
+  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.3.2/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Automatically Insert inline RBS type declarations using runtime information.
 test_files: []

data/gemfiles/3.1.gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in rbs-trace.gemspec
-gemspec(path: "..")
-
-gem "rake"
-gem "rspec"
-gem "rubocop", require: false
-gem "rubocop-rake", require: false
-gem "rubocop-rspec", require: false

data/gemfiles/3.1.gemfile.lock

@@ -1,68 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    rbs-trace (0.3.0)
-      prism (>= 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.1)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.26.3)
-    parser (3.3.5.0)
-      ast (~> 2.4.1)
-      racc
-    prism (1.0.0)
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.66.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
-      parser (>= 3.3.1.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (3.0.5)
-      rubocop (~> 1.61)
-    ruby-progressbar (1.13.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  arm64-darwin-23
-  ruby
-
-DEPENDENCIES
-  rake
-  rbs-trace!
-  rspec
-  rubocop
-  rubocop-rake
-  rubocop-rspec
-
-BUNDLED WITH
-   2.5.17