rbs-trace 0.3.2 → 0.4.0

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

@@ -0,0 +1,21 @@
+# Generated from lib/rbs/trace/overload_compact.rb with RBS::Inline
+
+module RBS
+  class Trace
+    class OverloadCompact
+      # @rbs (Array[AST::Members::MethodDefinition::Overload]) -> void
+      def initialize: (Array[AST::Members::MethodDefinition::Overload]) -> void
+
+      # @rbs () -> Array[AST::Members::MethodDefinition::Overload]
+      def call: () -> Array[AST::Members::MethodDefinition::Overload]
+
+      private
+
+      # @rbs (Array[MethodType]) -> MethodType
+      def merge_method_types: (Array[MethodType]) -> MethodType
+
+      # @rbs (Array[Types::t]) -> Types::t
+      def merge_types: (Array[Types::t]) -> Types::t
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Generated from lib/rbs/trace/return_value_visitor.rb with RBS::Inline
+
+module RBS
+  class Trace
+    class ReturnValueVisitor < Prism::BasicVisitor
+      # @rbs (String) -> ReturnValueVisitor
+      def self.parse_file: (String) -> ReturnValueVisitor
+
+      # @rbs () -> void
+      def initialize: () -> void
+
+      # @rbs (Integer, Symbol) -> bool
+      def void_type?: (Integer, Symbol) -> bool
+
+      # @rbs (Prism::Node) -> void
+      def visit_child_nodes: (Prism::Node) -> void
+
+      # @rbs (Prism::CallNode) -> void
+      def visit_call_node: (Prism::CallNode) -> void
+
+      private
+
+      # @rbs (Prism::CallNode) -> bool
+      def use_return_value?: (Prism::CallNode) -> bool
+    end
+  end
+end

data/sig/generated/rbs/trace/version.rbs

@@ -1,7 +1,7 @@
 # Generated from lib/rbs/trace/version.rb with RBS::Inline
 
 module RBS
-  module Trace
+  class Trace
     VERSION: ::String
   end
 end

data/sig/generated/rbs/trace.rbs

@@ -1,8 +1,70 @@
 # Generated from lib/rbs/trace.rb with RBS::Inline
 
 module RBS
-  module Trace
+  class Trace
     class Error < StandardError
     end
+
+    # steep:ignore:start
+    BUNDLE_PATH: String
+
+    # 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 [T] () { () -> T } -> T
+    def enable: [T] () { () -> T } -> T
+
+    # @rbs () -> void
+    def disable: () -> void
+
+    # @rbs () -> Hash[String, File]
+    def files: () -> Hash[String, File]
+
+    # @rbs () -> void
+    def save_comments: () -> void
+
+    # @rbs (out_dir: String) -> void
+    def save_files: (out_dir: String) -> void
+
+    private
+
+    # @rbs () -> TracePoint
+    def trace: () -> TracePoint
+
+    # @rbs () -> Logger
+    def logger: () -> Logger
+
+    # @rbs () -> Builder
+    def builder: () -> Builder
+
+    # @rbs (String) -> File
+    def find_or_new_file: (String) -> File
+
+    # @rbs (TracePoint) -> void
+    def record: (TracePoint) -> void
+
+    # @rbs (TracePoint, AST::Members::MethodDefinition) -> void
+    def call_event: (TracePoint, AST::Members::MethodDefinition) -> void
+
+    # @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
+
+    # @rbs (String, String) -> Thread::Backtrace::Location?
+    def find_caller_location: (String, String) -> Thread::Backtrace::Location?
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Takumi Shotoku
 bindir: exe
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -23,12 +23,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 description: |
   RBS::Trace collects argument types and return value types using TracePoint, and inserts
   inline RBS type declarations into files.
 email:
 - sinsoku.listy@gmail.com
-executables: []
+executables:
+- rbs-trace
 extensions: []
 extra_rdoc_files: []
 files:
@@ -40,29 +55,41 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- exe/rbs-trace
 - lib/rbs-trace.rb
 - lib/rbs/trace.rb
-- lib/rbs/trace/declaration.rb
-- lib/rbs/trace/definition.rb
+- lib/rbs/trace/builder.rb
+- lib/rbs/trace/cli.rb
+- lib/rbs/trace/cli/inline.rb
+- lib/rbs/trace/cli/merge.rb
 - lib/rbs/trace/file.rb
-- lib/rbs/trace/method_tracing.rb
+- lib/rbs/trace/helpers.rb
+- lib/rbs/trace/inline_comment_visitor.rb
+- lib/rbs/trace/overload_compact.rb
+- lib/rbs/trace/return_value_visitor.rb
 - lib/rbs/trace/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
 - sig/generated/rbs-trace.rbs
 - sig/generated/rbs/trace.rbs
-- sig/generated/rbs/trace/declaration.rbs
-- sig/generated/rbs/trace/definition.rbs
+- sig/generated/rbs/trace/builder.rbs
+- sig/generated/rbs/trace/cli.rbs
+- sig/generated/rbs/trace/cli/inline.rbs
+- sig/generated/rbs/trace/cli/merge.rbs
 - sig/generated/rbs/trace/file.rbs
-- sig/generated/rbs/trace/method_tracing.rbs
+- sig/generated/rbs/trace/helpers.rbs
+- sig/generated/rbs/trace/inline_comment_visitor.rbs
+- sig/generated/rbs/trace/overload_compact.rbs
+- sig/generated/rbs/trace/return_value_visitor.rbs
 - sig/generated/rbs/trace/version.rbs
+- tmp/.keep
 homepage: https://github.com/sinsoku/rbs-trace
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/rbs-trace
-  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
+  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
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/lib/rbs/trace/declaration.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module RBS
-  module Trace
-    class Declaration
-      METHOD_KINDS = %i[req opt rest keyreq key keyrest].freeze #: Array[Symbol]
-      private_constant :METHOD_KINDS
-
-      attr_reader :parameters #: Array[untyped]
-      attr_reader :void #: bool
-      attr_accessor :return_type #: Array[Object]
-
-      # @rbs (Array[untyped], ?void: bool) -> void
-      def initialize(parameters, void: false)
-        @parameters = parameters
-        @void = void
-      end
-
-      # @rbs () -> String
-      def to_rbs
-        return_rbs = void ? "void" : convert_type(return_type)
-
-        "(#{parameters_rbs}) -> #{return_rbs}"
-      end
-
-      # @rbs (Declaration) -> Declaration
-      def merge(other) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        new_parameters = @parameters.map.with_index do |parameter, index|
-          kind = parameter[0]
-          name = parameter[1]
-          klass = parameter[2]
-          other_klass = other.parameters[index][2]
-
-          merged_klass = (klass + other_klass).uniq
-          [kind, name, merged_klass]
-        end
-        Declaration.new(new_parameters, void: void && other.void).tap do |decl|
-          decl.return_type = (return_type + other.return_type).uniq
-        end
-      end
-
-      private
-
-      # TODO: support block argument
-      # @rbs () -> String
-      def parameters_rbs
-        converted = {} #: Hash[Symbol, Array[String?]]
-        @parameters.each do |kind, name, klass|
-          converted[kind] ||= [] #: Array[String?]
-          converted[kind] << convert(kind, name, klass)
-        end
-
-        METHOD_KINDS.flat_map { |kind| converted[kind] }.compact.join(", ")
-      end
-
-      # @rbs (Symbol, Symbol, Array[Object]) -> String?
-      def convert(kind, name, klass) # rubocop:disable Metrics/MethodLength
-        type = convert_type(klass)
-        case kind
-        when :req
-          type
-        when :opt
-          "?#{type}"
-        when :rest
-          "*#{type}"
-        when :keyreq
-          "#{name}: #{type}"
-        when :key
-          "?#{name}: #{type}"
-        when :keyrest
-          "**#{type}"
-        end
-      end
-
-      # @rbs (Array[Object]) -> String
-      def convert_type(klass) # rubocop:disable Metrics
-        optional = klass.any? { |k| k == NilClass }
-        types = klass.filter_map do |k|
-          if k == NilClass
-            nil
-          elsif [TrueClass, FalseClass].include?(k) # steep:ignore ArgumentTypeMismatch
-            "bool"
-          elsif [Array, Range].include?(k) # steep:ignore ArgumentTypeMismatch
-            "#{k}[untyped]"
-          elsif k == Hash
-            "#{k}[untyped, untyped]"
-          elsif k == Object
-            "untyped"
-          else
-            k.name # steep:ignore NoMethod
-          end
-        end.uniq
-        type = types.join("|")
-
-        if types.size > 1 && optional
-          "(#{type})?"
-        elsif types.empty?
-          "nil"
-        elsif optional
-          "#{type}?"
-        else
-          type
-        end
-      end
-    end
-  end
-end

data/lib/rbs/trace/definition.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module RBS
-  module Trace
-    class Definition
-      attr_reader :klass #: Class
-      attr_reader :name #: Symbol
-      attr_reader :lineno #: Integer
-
-      # @rbs (klass: Object, name: Symbol, lineno: Integer) -> void
-      def initialize(klass:, name:, lineno:)
-        @klass = klass
-        @name = name
-        @lineno = lineno
-      end
-
-      # @rbs () -> Array[Declaration]
-      def decls
-        @decls ||= []
-      end
-
-      # @rbs (?Integer) -> String
-      def rbs_comment(indent = 0)
-        "#{" " * indent}# @rbs #{rbs}\n"
-      end
-
-      # @rbs () -> String
-      def rbs
-        @decls.inject { |result, decl| result.merge(decl) }.to_rbs
-      end
-    end
-  end
-end

data/lib/rbs/trace/method_tracing.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-module RBS
-  module Trace
-    class MethodTracing # rubocop:disable Metrics/ClassLength
-      ASSIGNED_NODE_TYPES = %i[statements_node local_variable_write_node instance_variable_write_node
-                               class_variable_write_node constant_write_node call_node
-                               embedded_statements_node].freeze #: Array[Symbol]
-      private_constant :ASSIGNED_NODE_TYPES
-
-      # @rbs [T] () { () -> T } -> T
-      def enable(&)
-        trace.enable(&)
-      end
-
-      # @rbs () -> void
-      def disable
-        trace.disable
-      end
-
-      # @rbs () -> Hash[String, File]
-      def files
-        @files ||= {}
-      end
-
-      # @rbs () -> void
-      def insert_rbs
-        files.each_value(&:rewrite)
-      end
-
-      private
-
-      # @rbs () -> TracePoint
-      def trace
-        @trace ||= TracePoint.new(:call, :return) { |tp| record(tp) }
-      end
-
-      # @rbs () -> Logger
-      def logger
-        return @logger if defined?(@logger)
-
-        level = ENV["RBS_TRACE_DEBUG"] ? :debug : :info
-        @logger = Logger.new($stdout, level:)
-      end
-
-      # @rbs () -> Array[Declaration]
-      def stack_traces
-        @stack_traces ||= []
-      end
-
-      # @rbs (String) -> File
-      def find_or_new_file(path)
-        files[path] ||= File.new(path)
-        files[path]
-      end
-
-      # @rbs (File, TracePoint) -> Definition
-      def find_or_new_definition(file, tp)
-        name = tp.method_id
-        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
-      def record(tp) # rubocop:disable Metrics/MethodLength
-        return if ignore_path?(tp.path)
-
-        file = find_or_new_file(tp.path)
-        definition = find_or_new_definition(file, tp)
-
-        case tp.event
-        when :call
-          call_event(tp)
-        when :return
-          return_event(tp, definition)
-        end
-      rescue StandardError => e
-        logger.debug(e)
-      end
-
-      # @rbs (TracePoint) -> void
-      def call_event(tp) # rubocop:disable Metrics
-        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
-          klass = case kind
-                  when :rest
-                    value ? value.map { |v| obj_to_class(v) }.uniq : [Object]
-                  when :keyrest
-                    value ? value.map { |_, v| obj_to_class(v) }.uniq : [Object]
-                  when :block
-                    # TODO: support block argument
-                    next
-                  else
-                    [obj_to_class(value)]
-                  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
-      def return_event(tp, definition)
-        decl = stack_traces.pop
-        # TODO: check usecase where decl is nil
-        return unless decl
-
-        decl.return_type = [obj_to_class(tp.return_value)]
-        definition.decls << decl
-      end
-
-      # @rbs (BasicObject) -> Class
-      def obj_to_class(obj)
-        Object.instance_method(:class).bind_call(obj)
-      end
-
-      # @rbs (String) -> bool
-      def ignore_path?(path)
-        bundle_path = Bundler.bundle_path.to_s # steep:ignore NoMethod
-        ruby_lib_path = RbConfig::CONFIG["rubylibdir"]
-
-        path.start_with?("<internal") ||
-          path.start_with?("(eval") ||
-          path.start_with?(bundle_path) ||
-          path.start_with?(ruby_lib_path) ||
-          path.start_with?(__FILE__)
-      end
-
-      # @rbs (String, Symbol) -> bool
-      def assign_return_value?(path, method_id) # rubocop:disable Metrics
-        is_initialize = method_id == :initialize
-        return false if is_initialize
-
-        locations = caller_locations || []
-        i = locations.index { |loc| loc.path == path && loc.label == method_id.to_s }
-        loc = locations[i + 1] if i
-        # If the caller is not found, assume the return value is used.
-        return true unless loc
-
-        node = parsed_nodes(loc.path) # steep:ignore ArgumentTypeMismatch
-        return false unless node
-
-        method_name = is_initialize ? :new : method_id
-        parents = find_parents(node, method_name:, lineno: loc.lineno)
-        return false unless parents
-
-        parent = parents[1]
-        ASSIGNED_NODE_TYPES.include?(parent.type) # steep:ignore NoMethod
-      end
-
-      # @rbs (Prism::Node, method_name: Symbol, lineno: Integer, ?parents: Array[Prism::Node]) -> Array[Prism::Node]?
-      def find_parents(node, method_name:, lineno:, parents: [])
-        result = nil
-        node.compact_child_nodes.each do |child| # steep:ignore NoMethod
-          break if result
-
-          found = child.type == :call_node && child.name == method_name && child.location.start_line == lineno
-          result = found ? [child, *parents] : find_parents(child, method_name:, lineno:, parents: [node, *parents])
-        end
-        result
-      end
-
-      # @rbs (String) -> Prism::ProgramNode?
-      def parsed_nodes(path)
-        return unless ::File.exist?(path)
-
-        @parsed_nodes ||= {} #: Hash[String, Prism::ParseResult]
-        @parsed_nodes[path] ||= Prism.parse_file(path)
-        @parsed_nodes[path].value
-      end
-    end
-  end
-end

data/sig/generated/rbs/trace/declaration.rbs

@@ -1,36 +0,0 @@
-# Generated from lib/rbs/trace/declaration.rb with RBS::Inline
-
-module RBS
-  module Trace
-    class Declaration
-      METHOD_KINDS: Array[Symbol]
-
-      attr_reader parameters: Array[untyped]
-
-      attr_reader void: bool
-
-      attr_accessor return_type: Array[Object]
-
-      # @rbs (Array[untyped], ?void: bool) -> void
-      def initialize: (Array[untyped], ?void: bool) -> void
-
-      # @rbs () -> String
-      def to_rbs: () -> String
-
-      # @rbs (Declaration) -> Declaration
-      def merge: (Declaration) -> Declaration
-
-      private
-
-      # TODO: support block argument
-      # @rbs () -> String
-      def parameters_rbs: () -> String
-
-      # @rbs (Symbol, Symbol, Array[Object]) -> String?
-      def convert: (Symbol, Symbol, Array[Object]) -> String?
-
-      # @rbs (Array[Object]) -> String
-      def convert_type: (Array[Object]) -> String
-    end
-  end
-end

data/sig/generated/rbs/trace/definition.rbs

@@ -1,25 +0,0 @@
-# Generated from lib/rbs/trace/definition.rb with RBS::Inline
-
-module RBS
-  module Trace
-    class Definition
-      attr_reader klass: Class
-
-      attr_reader name: Symbol
-
-      attr_reader lineno: Integer
-
-      # @rbs (klass: Object, name: Symbol, lineno: Integer) -> void
-      def initialize: (klass: Object, name: Symbol, lineno: Integer) -> void
-
-      # @rbs () -> Array[Declaration]
-      def decls: () -> Array[Declaration]
-
-      # @rbs (?Integer) -> String
-      def rbs_comment: (?Integer) -> String
-
-      # @rbs () -> String
-      def rbs: () -> String
-    end
-  end
-end

data/sig/generated/rbs/trace/method_tracing.rbs

@@ -1,63 +0,0 @@
-# Generated from lib/rbs/trace/method_tracing.rb with RBS::Inline
-
-module RBS
-  module Trace
-    class MethodTracing
-      # rubocop:disable Metrics/ClassLength
-      ASSIGNED_NODE_TYPES: Array[Symbol]
-
-      # @rbs [T] () { () -> T } -> T
-      def enable: [T] () { () -> T } -> T
-
-      # @rbs () -> void
-      def disable: () -> void
-
-      # @rbs () -> Hash[String, File]
-      def files: () -> Hash[String, File]
-
-      # @rbs () -> void
-      def insert_rbs: () -> void
-
-      private
-
-      # @rbs () -> TracePoint
-      def trace: () -> TracePoint
-
-      # @rbs () -> Logger
-      def logger: () -> Logger
-
-      # @rbs () -> Array[Declaration]
-      def stack_traces: () -> Array[Declaration]
-
-      # @rbs (String) -> File
-      def find_or_new_file: (String) -> File
-
-      # @rbs (File, TracePoint) -> Definition
-      def find_or_new_definition: (File, TracePoint) -> Definition
-
-      # @rbs (TracePoint) -> void
-      def record: (TracePoint) -> void
-
-      # @rbs (TracePoint) -> void
-      def call_event: (TracePoint) -> void
-
-      # @rbs (TracePoint, Definition) -> void
-      def return_event: (TracePoint, Definition) -> void
-
-      # @rbs (BasicObject) -> Class
-      def obj_to_class: (BasicObject) -> Class
-
-      # @rbs (String) -> bool
-      def ignore_path?: (String) -> bool
-
-      # @rbs (String, Symbol) -> bool
-      def assign_return_value?: (String, Symbol) -> bool
-
-      # @rbs (Prism::Node, method_name: Symbol, lineno: Integer, ?parents: Array[Prism::Node]) -> Array[Prism::Node]?
-      def find_parents: (Prism::Node, method_name: Symbol, lineno: Integer, ?parents: Array[Prism::Node]) -> Array[Prism::Node]?
-
-      # @rbs (String) -> Prism::ProgramNode?
-      def parsed_nodes: (String) -> Prism::ProgramNode?
-    end
-  end
-end