rbs-trace 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e7d9ae59c5c4d3427c486422dcda9158bb65b1d5054d0ab5713a9714de9f39c
-  data.tar.gz: fc377a935ef972ac2e153d40f336154c03cb1e42b88dc732132f2e71bba83047
+  metadata.gz: b10553866e335d8d7e7210d41cde3b905939b6ee26822994197c4bcfe8d324ce
+  data.tar.gz: ffa7d6f2f2bd57b7695b2e0622df519a0b0e830519aedb71185576038b514f3b
 SHA512:
-  metadata.gz: e3ff05d28fbef44e66500377dd38e74a0a3890da197d00bbf61b461358d404fef1933d43e30655a5dffce3850f1a71b4d535b88db8e209d2d1100ba7c1f502e9
-  data.tar.gz: 446d6c0d49e72fae943708bc146bf80365cd107bac3d9c509950a0184611f19982dc244f0398964ff50d4d462756a3004ce73e5d5d0488a1ae9e41257555a447
+  metadata.gz: 6f91f4b6facc4ce53917e0b574e85eb4d6f3e11646ce32407e39b79226e310f072ec564a993ef4e9ab68868bc83a261c1756b238f658ad66298d005806a4540f
+  data.tar.gz: c63bfaf42df1456961c16f9903df32f05dabab967d4a0305457aa2288e0b2d12d5e0a8be5ad1d62cf47e21b6bddacd8c82cc4eede8c5b4f1615bd715d4281b45

data/.rubocop.yml

@@ -1,6 +1,7 @@
 require:
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-performance
 
 AllCops:
   TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-03-30
+
+- feat: Add paths to control trace targets
+- chore: Remove wrong examples
+
+## [0.4.1] - 2025-02-24
+
+- fix: Ensure class names are referenced
+- fix: Prefer other types over void and untyped
+- fix: Fix process to guess return value as void
+- fix: Do not parse if the caller is not Ruby
+- chore: Auto correct with rubocop-performance
+
 ## [0.4.0] - 2025-02-23
 
 - feat: Implement the function to save as RBS files

data/README.md

@@ -111,9 +111,7 @@ end
 ### Insert RBS declarations for specific files only
 
 ```ruby
-trace.files.each do |path, file|
-  file.rewrite if path.include?("app/models/")
-end
+RBS::Trace.new(paths: Dir.glob("#{Dir.pwd}/app/models/**/*.rb"))
 ```
 
 ### Save RBS declarations as files

data/lib/rbs/trace/builder.rb

@@ -2,9 +2,13 @@
 
 module RBS
   class Trace
-    class Builder
+    class Builder # rubocop:disable Metrics/ClassLength
       include Helpers
 
+      UNBOUND_CLASS_METHOD = Object.instance_method(:class)
+      UNBOUND_NAME_METHOD = Class.instance_method(:name)
+      private_constant :UNBOUND_CLASS_METHOD, :UNBOUND_NAME_METHOD
+
       GENERICS_SIZE = {
         Array => 1,
         Range => 1,
@@ -12,12 +16,14 @@ module RBS
       }.freeze
       private_constant :GENERICS_SIZE
 
-      # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> void
+      # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
       def method_call(bind:, parameters:, void:)
         method_type = parse_parameters(bind, parameters)
         return_type = type_void if void
 
-        stack_traces << [method_type, return_type]
+        [method_type, return_type].tap do |types|
+          stack_traces << types
+        end
       end
 
       # @rbs (__todo__) -> AST::Members::MethodDefinition::Overload
@@ -101,16 +107,17 @@ module RBS
 
       # @rbs (untyped) -> Types::t
       def parse_class(klass) # rubocop:disable Metrics/MethodLength
+        class_name = UNBOUND_NAME_METHOD.bind_call(klass)
         if [TrueClass, FalseClass].include?(klass)
           type_bool
         elsif klass == NilClass
           type_nil
-        elsif klass == Object || klass.name.nil?
+        elsif klass == Object || class_name.nil?
           type_untyped
         else
           size = GENERICS_SIZE[klass].to_i
           args = Array.new(size) { type_untyped }
-          Types::ClassInstance.new(name: TypeName.parse(klass.name), args:, location: nil)
+          Types::ClassInstance.new(name: TypeName.parse(class_name), args:, location: nil)
         end
       end
 
@@ -119,6 +126,11 @@ module RBS
         klass = obj_to_class(object)
         parse_class(klass)
       end
+
+      # @rbs (BasicObject) -> Class
+      def obj_to_class(obj)
+        UNBOUND_CLASS_METHOD.bind_call(obj)
+      end
     end
   end
 end

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

@@ -13,12 +13,6 @@ module RBS
             # Insert inline comments to `app/**/*.rb`.
             $ rbs-trace inline --sig-dir=sig --rb-dir=app
 
-            # Generate RBS files with rbs-inline.
-            $ rbs-inline --output --opt-out app
-
-            # Remove method definitions that have been migrated to inline comments.
-            $ rbs subtract --write sig sig/generated/
-
           Options:
         USAGE
 

data/lib/rbs/trace/helpers.rb

@@ -3,9 +3,6 @@
 module RBS
   class Trace
     module Helpers
-      UNBOUND_CLASS_METHOD = Object.instance_method(:class)
-      private_constant :UNBOUND_CLASS_METHOD
-
       # @rbs (name: TypeName) -> AST::Declarations::Module
       def new_module_decl(name:)
         AST::Declarations::Module.new(
@@ -46,11 +43,6 @@ module RBS
         )
       end
 
-      # @rbs (BasicObject) -> Class
-      def obj_to_class(obj)
-        UNBOUND_CLASS_METHOD.bind_call(obj)
-      end
-
       # @rbs () -> Types::Bases::Void
       def type_void
         @type_void = Types::Bases::Void.new(location: nil)

data/lib/rbs/trace/overload_compact.rb

@@ -72,14 +72,22 @@ module RBS
 
       # @rbs (Array[Types::t]) -> Types::t
       def merge_types(types)
+        types = compact_types(types)
         return types.first if types.one?
 
-        optional = types.any? { |type| type.is_a?(Types::Bases::Nil) }
+        optional = types.any?(Types::Bases::Nil)
         types = types.reject { |type| type.is_a?(Types::Bases::Nil) }
         type = types.one? ? types.first : Types::Union.new(types:, location: nil) #: Types::t
 
         optional ? Types::Optional.new(type:, location: nil) : type
       end
+
+      # @rbs (Array[Types::t]) -> Array[Types::t]
+      def compact_types(types)
+        types = types.reject { |t| t.is_a?(Types::Bases::Void) } if types.any? { |t| !t.is_a?(Types::Bases::Void) }
+        types.reject! { |t| t.is_a?(Types::Bases::Any) } if types.any? { |t| !t.is_a?(Types::Bases::Any) }
+        types
+      end
     end
   end
 end

data/lib/rbs/trace/return_value_visitor.rb

@@ -38,7 +38,7 @@ module RBS
       # @rbs (Prism::CallNode) -> void
       def visit_call_node(node)
         key = [node.location.start_line, node.name]
-        @void_types[key] = !use_return_value?(node)
+        @void_types[key] = void?(node)
 
         visit_child_nodes(node)
       end
@@ -50,13 +50,16 @@ module RBS
       private
 
       # @rbs (Prism::CallNode) -> bool
-      def use_return_value?(_node)
-        parent_type = @parents[-1]&.type
-        next_parent_type = @parents[-2]&.type
+      def void?(node)
+        parent_node = @parents[-1]
+        next_parent_node = @parents[-2]
+        return true if parent_node.nil? || next_parent_node.nil?
 
-        parent_type.end_with?("write_node") ||
-          parent_type == :call_node ||
-          (parent_type == :statements_node && next_parent_type == :embedded_statements_node)
+        if next_parent_node.type == :program_node
+          parent_node.type == :statements_node
+        else
+          parent_node.type == :statements_node && parent_node.child_nodes[-1] != node
+        end
       end
     end
   end

data/lib/rbs/trace/version.rb

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

data/lib/rbs/trace.rb

@@ -24,17 +24,15 @@ module RBS
     BUNDLE_PATH = Bundler.bundle_path.to_s #: String
     # steep:ignore:end
     RUBY_LIB_PATH = RbConfig::CONFIG["rubylibdir"] #: String
-    PATH_INTERNAL = "<internal" #: String
-    PATH_EVAL = "(eval" #: String
-    PATH_INLINE_TEMPLATE = "inline template" #: String
 
-    private_constant :BUNDLE_PATH, :RUBY_LIB_PATH, :PATH_INTERNAL, :PATH_EVAL, :PATH_INLINE_TEMPLATE
+    private_constant :BUNDLE_PATH, :RUBY_LIB_PATH
 
-    # @rbs (?log_level: Symbol, ?raises: bool) -> void
-    def initialize(log_level: nil, raises: false)
+    # @rbs (?log_level: Symbol, ?raises: bool, ?paths: Array[String]) -> void
+    def initialize(log_level: nil, raises: false, paths: default_paths)
       @log_level = log_level
       @log_level ||= ENV["RBS_TRACE_DEBUG"] ? :debug : :info
       @raises = raises
+      @paths = Set.new(paths)
     end
 
     # @rbs [T] () { () -> T } -> T
@@ -54,7 +52,9 @@ module RBS
 
     # @rbs () -> void
     def save_comments
-      files.each_value(&:rewrite)
+      files.each do |path, file|
+        file.rewrite if @paths.include?(path)
+      end
     end
 
     # @rbs (out_dir: String) -> void
@@ -64,6 +64,11 @@ module RBS
 
     private
 
+    # @rbs () -> Array[String]
+    def default_paths
+      Dir.glob("#{Dir.pwd}/**/*.rb").reject { |path| path.start_with?(BUNDLE_PATH, RUBY_LIB_PATH) }
+    end
+
     # @rbs () -> TracePoint
     def trace
       @trace ||= TracePoint.new(:call, :return) { |tp| record(tp) }
@@ -86,7 +91,7 @@ module RBS
 
     # @rbs (TracePoint) -> void
     def record(tp) # rubocop:disable Metrics/MethodLength
-      return if ignore_path?(tp.path)
+      return unless @paths.include?(tp.path)
 
       file = find_or_new_file(tp.path)
       # steep:ignore:start
@@ -127,18 +132,6 @@ module RBS
       member.overloads << overload
     end
 
-    # @rbs (String) -> bool
-    def ignore_path?(path)
-      path.start_with?(
-        PATH_INTERNAL,
-        PATH_EVAL,
-        PATH_INLINE_TEMPLATE,
-        BUNDLE_PATH,
-        RUBY_LIB_PATH,
-        __FILE__
-      )
-    end
-
     # @rbs (String, Symbol) -> bool
     def void_return_type?(path, method_id)
       return true if method_id == :initialize
@@ -151,6 +144,9 @@ module RBS
       # Returns true if the file does not exist (eval, etc.)
       return true unless ::File.exist?(caller_path)
 
+      # If the file is not Ruby, assume the return value is used. (erb, haml, etc.)
+      return false if ::File.extname(caller_path) != ".rb"
+
       @return_value_visitors ||= {} #: Hash[String, ReturnValueVisitor]
       v = @return_value_visitors.fetch(caller_path) { ReturnValueVisitor.parse_file(caller_path) }
       v.void_type?(loc.lineno, method_id)

data/sig/generated/rbs/trace/builder.rbs

@@ -5,10 +5,14 @@ module RBS
     class Builder
       include Helpers
 
+      UNBOUND_CLASS_METHOD: untyped
+
+      UNBOUND_NAME_METHOD: untyped
+
       GENERICS_SIZE: untyped
 
-      # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> void
-      def method_call: (bind: Binding, parameters: Array[__todo__], void: bool) -> void
+      # @rbs (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
+      def method_call: (bind: Binding, parameters: Array[__todo__], void: bool) -> Array[__todo__]
 
       # @rbs (__todo__) -> AST::Members::MethodDefinition::Overload
       def method_return: (__todo__) -> AST::Members::MethodDefinition::Overload
@@ -28,6 +32,9 @@ module RBS
 
       # @rbs (BasicObject) -> Types::t
       def parse_object: (BasicObject) -> Types::t
+
+      # @rbs (BasicObject) -> Class
+      def obj_to_class: (BasicObject) -> Class
     end
   end
 end

data/sig/generated/rbs/trace/helpers.rbs

@@ -3,8 +3,6 @@
 module RBS
   class Trace
     module Helpers
-      UNBOUND_CLASS_METHOD: untyped
-
       # @rbs (name: TypeName) -> AST::Declarations::Module
       def new_module_decl: (name: TypeName) -> AST::Declarations::Module
 
@@ -14,9 +12,6 @@ module RBS
       # @rbs (name: Symbol, kind: (:singleton | :instance)) -> AST::Members::MethodDefinition
       def new_method_definition: (name: Symbol, kind: :singleton | :instance) -> AST::Members::MethodDefinition
 
-      # @rbs (BasicObject) -> Class
-      def obj_to_class: (BasicObject) -> Class
-
       # @rbs () -> Types::Bases::Void
       def type_void: () -> Types::Bases::Void
 

data/sig/generated/rbs/trace/overload_compact.rbs

@@ -16,6 +16,9 @@ module RBS
 
       # @rbs (Array[Types::t]) -> Types::t
       def merge_types: (Array[Types::t]) -> Types::t
+
+      # @rbs (Array[Types::t]) -> Array[Types::t]
+      def compact_types: (Array[Types::t]) -> Array[Types::t]
     end
   end
 end

data/sig/generated/rbs/trace/return_value_visitor.rbs

@@ -21,7 +21,7 @@ module RBS
       private
 
       # @rbs (Prism::CallNode) -> bool
-      def use_return_value?: (Prism::CallNode) -> bool
+      def void?: (Prism::CallNode) -> bool
     end
   end
 end

data/sig/generated/rbs/trace.rbs

@@ -11,14 +11,8 @@ module RBS
     # steep:ignore:end
     RUBY_LIB_PATH: String
 
-    PATH_INTERNAL: String
-
-    PATH_EVAL: String
-
-    PATH_INLINE_TEMPLATE: String
-
-    # @rbs (?log_level: Symbol, ?raises: bool) -> void
-    def initialize: (?log_level: Symbol, ?raises: bool) -> void
+    # @rbs (?log_level: Symbol, ?raises: bool, ?paths: Array[String]) -> void
+    def initialize: (?log_level: Symbol, ?raises: bool, ?paths: Array[String]) -> void
 
     # @rbs [T] () { () -> T } -> T
     def enable: [T] () { () -> T } -> T
@@ -37,6 +31,9 @@ module RBS
 
     private
 
+    # @rbs () -> Array[String]
+    def default_paths: () -> Array[String]
+
     # @rbs () -> TracePoint
     def trace: () -> TracePoint
 
@@ -58,9 +55,6 @@ module RBS
     # @rbs (TracePoint, AST::Members::MethodDefinition) -> void
     def return_event: (TracePoint, AST::Members::MethodDefinition) -> void
 
-    # @rbs (String) -> bool
-    def ignore_path?: (String) -> bool
-
     # @rbs (String, Symbol) -> bool
     def void_return_type?: (String, Symbol) -> bool
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Takumi Shotoku
 bindir: exe
 cert_chain: []
-date: 2025-02-23 00:00:00.000000000 Z
+date: 2025-03-30 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.4.0
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.4.0/CHANGELOG.md
+  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
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: