rbs-trace 0.3.1 → 0.4.0

data/lib/rbs/trace/method_tracing.rb

@@ -1,178 +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?
-        klass = is_singleton ? tp.self : tp.defined_class
-        mark = is_singleton ? "." : "#"
-        signature = "#{klass}#{mark}#{name}"
-
-        file.definitions[signature] ||= Definition.new(klass:, name:, lineno: tp.lineno)
-      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: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
-        stack_traces << Declaration.new(parameters, void: !assign_return_value?(tp.path, tp.method_id))
-      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 UnknownConstant
-        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 ||= {}
-        @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