rbs-trace 0.3.1 → 0.4.0

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

@@ -0,0 +1,33 @@
+# Generated from lib/rbs/trace/helpers.rb with RBS::Inline
+
+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
+
+      # @rbs (name: TypeName) -> AST::Declarations::Class
+      def new_class_decl: (name: TypeName) -> AST::Declarations::Class
+
+      # @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
+
+      # @rbs () -> Types::Bases::Nil
+      def type_nil: () -> Types::Bases::Nil
+
+      # @rbs () -> Types::Bases::Bool
+      def type_bool: () -> Types::Bases::Bool
+
+      # @rbs () -> Types::Bases::Any
+      def type_untyped: () -> Types::Bases::Any
+    end
+  end
+end

data/sig/generated/rbs/trace/inline_comment_visitor.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/rbs/trace/inline_comment_visitor.rb with RBS::Inline
+
+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 override
+      # @rbs (Prism::Node) -> void
+      def visit_class_node: ...
+
+      # @rbs override
+      # @rbs (Prism::Node) -> void
+      def visit_module_node: ...
+
+      # @rbs override
+      # @rbs (Prism::Node) -> void
+      def visit_def_node: ...
+
+      private
+
+      # @rbs (Symbol) -> AST::Members::MethodDefinition?
+      def find_method_definition: (Symbol) -> AST::Members::MethodDefinition?
+    end
+  end
+end

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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbs-trace
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Takumi Shotoku
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -24,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:
@@ -41,33 +55,42 @@ files:
 - README.md
 - Rakefile
 - Steepfile
-- gemfiles/3.1.gemfile
-- gemfiles/3.1.gemfile.lock
+- 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.1
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.3.1/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'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +105,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.1)
-      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

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 = {}
-        @parameters.each do |kind, name, klass|
-          converted[kind] ||= []
-          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