rbs-trace 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4040f1116ab68a5b072e7a847480080c778b1ff87c37a0a47d1ee3b923f61ffb
-  data.tar.gz: b262f219610e463cdccfa5d7e3442526963f118d2ea1386ff442919920b9053f
+  metadata.gz: b10553866e335d8d7e7210d41cde3b905939b6ee26822994197c4bcfe8d324ce
+  data.tar.gz: ffa7d6f2f2bd57b7695b2e0622df519a0b0e830519aedb71185576038b514f3b
 SHA512:
-  metadata.gz: e3e1eea5dc319b4eafd62e62ffc1dc10ccc3301ffa603ddd8696f9b0a9a8f16a7604037873595fd91291211264e79622e8f1eba05a22dd02e78133466ae35e7d
-  data.tar.gz: 30f08d4582741295df623ab8ddf1f87c97723eeea0a8217e39a6ae4bcd12dd6a1ee88623256d96e29a83a410687ec8e3fa89a3ce95a72973dc5ad1002846481d
+  metadata.gz: 6f91f4b6facc4ce53917e0b574e85eb4d6f3e11646ce32407e39b79226e310f072ec564a993ef4e9ab68868bc83a261c1756b238f658ad66298d005806a4540f
+  data.tar.gz: c63bfaf42df1456961c16f9903df32f05dabab967d4a0305457aa2288e0b2d12d5e0a8be5ad1d62cf47e21b6bddacd8c82cc4eede8c5b4f1615bd715d4281b45

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [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

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/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/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   class Trace
-    VERSION = "0.4.1"
+    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

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.1
+  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.1
-  changelog_uri: https://github.com/sinsoku/rbs-trace/blob/v0.4.1/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: