orthoses 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23443bbc790318672ea55f35fa859be2850d01abacd34f4274944c3bdc0bffab
-  data.tar.gz: a92d9b0d889bb0fdbebfb643adf7471b62ff4b2f0f5faab7d4899f6f957df610
+  metadata.gz: '0555497d665f5573dfa6a86e454c165195f0e33ae82842fa83c2cff54b7d360d'
+  data.tar.gz: c760feb2cecc92c04f0eecedf9790d7ac9be2dd5a7aed5850d009d51e49594dd
 SHA512:
-  metadata.gz: 2efacfd0945ca2070f50373c2b8cae1f4a0cba220a2cf2a815636fe76ed4d17ddd39124a40a9227e842f0215f05f764aebf49cf8d2b4ba8254412baf82789062
-  data.tar.gz: 7a79c8c1515ac995d4a261776d68c01a684820aa9b00b635a93929e6561f8b5c431909f4ff158451e2f0daeddbf9948e6ef178c5123fc4b5bfdcbc30d294300f
+  metadata.gz: f3febe9350d66db369d8d8b24bd3ef6e3a1885b0207a5bef263a048e4eab732604f48d0fe27900ae1318f29ea87cc1f018a06f9b62a544aae8a402d0312674d1
+  data.tar.gz: e90e69dcd746b3a83984e3234e51666f9cc9102670a71f09676ce97c664c79ff9f68b84ed3da4d7d43a4aa5213b091f05e6455ca6c4709ee54a13dfeab91de23

data/README.md

@@ -175,15 +175,20 @@ Force load const defined by `autoload`.
 
 Sort signatures by class/module.
 
-## Orthoses::Trace
+### Orthoses::Trace
 
 Trace the argument and return value objects when the method is actually called and determine the type.
 
-## Orthoses::MissingName
+### Orthoses::MissingName
 
 Completes undefined class/module names.
 If it is unknown whether it is a class or a module, it is defined as an empty module, and if it is a superclass, it is defined as an empty class.
 
+### Orthoses::ExcludeRBS
+
+You can specify that the specified RBS should not be intentionally generated.
+This is useful when you want to exclude handwritten RBS.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/orthoses/content/duplication_checker.rb

@@ -18,7 +18,9 @@ module Orthoses
         drop_known_method_definition
         drop_known_const_definition
 
-        @decl.members.replace(@uniq_map.values)
+        # HACK
+        new_members = @uniq_map.values
+        @decl.instance_eval { @members = new_members }
 
         @uniq_map.clear
       end

data/lib/orthoses/create_file_by_name.rb

@@ -3,6 +3,11 @@
 require 'orthoses/outputable'
 
 module Orthoses
+  # @param to [String, nil]
+  # @param header [String, nil]
+  # @param if [Proc, nil]
+  # @param depth [Integer, Hash{String => Integer}, nil]
+  # @param rmtree [Boolean]
   class CreateFileByName
     prepend Outputable
 
@@ -43,8 +48,7 @@ module Orthoses
         @if.nil? || @if.call(name, content)
       end
       grouped = store.group_by do |name, _|
-        splitted = name.to_s.split('::')
-        (@depth ? splitted[0, @depth] : splitted).join('::')
+        extract(name)
       end
 
       grouped.each do |group_name, group|
@@ -64,5 +68,24 @@ module Orthoses
         end
       end
     end
+
+    def extract(name)
+      case @depth
+      when nil
+        name.to_s
+      when Integer
+        name.split('::')[0, @depth].join('::')
+      when Hash
+        found_key, found_index = @depth.find do |n, _|
+          name.start_with?(n)
+        end
+        case found_index
+        when nil
+          name.to_s
+        else
+          name.split('::')[0, found_index].join('::')
+        end
+      end
+    end
   end
 end

data/lib/orthoses/exclude_rbs.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # Exclude RBS from output.
+  # @example
+  #   use Orthoses::ExcludeRBS, paths: Dir['sig/hand-written/**/*.rbs']
+  class ExcludeRBS
+    def initialize(loader, paths: nil, rbs: nil)
+      raise ArgumentError, ':paths or :rbs keyword is required' if paths.nil? && rbs.nil?
+
+      @loader = loader
+      @paths = paths
+      @rbs = rbs
+    end
+
+    def call
+      case
+      when @paths
+        @paths.each do |path|
+          add_signature_to_known_env(File.read(path.to_s))
+        end
+      when @rbs
+        add_signature_to_known_env(@rbs)
+      else
+        raise "bug"
+      end
+
+      @loader.call
+    end
+
+    def add_signature_to_known_env(rbs)
+      buffer, directives, decls = ::RBS::Parser.parse_signature(rbs)
+      Utils.rbs_environment.add_signature(buffer: buffer, directives: directives, decls: decls)
+    end
+  end
+end

data/lib/orthoses/trace/attribute.rb

@@ -23,9 +23,10 @@ module Orthoses
 
       include Targetable
 
-      def initialize(loader, patterns:)
+      def initialize(loader, patterns:, sort_union_types: true)
         @loader = loader
         @patterns = patterns
+        @sort_union_types = sort_union_types
 
         @captured_dict = Hash.new { |h, k| h[k] = Hash.new { |hh, kk| hh[kk] = [] } }
       end
@@ -45,6 +46,7 @@ module Orthoses
 
         @captured_dict.each do |mod_name, captures|
           captures.each do |(kind, prefix, name), types|
+            types.sort! if @sort_union_types
             injected = Utils::TypeList.new(types).inject
             store[mod_name] << "#{kind} #{prefix}#{name}: #{injected}"
           end

data/lib/orthoses/trace/method.rb

@@ -7,9 +7,10 @@ module Orthoses
       Info = Struct.new(:key, :op_name_types, :raised, keyword_init: true)
       include Targetable
 
-      def initialize(loader, patterns:)
+      def initialize(loader, patterns:, sort_union_types: true)
         @loader = loader
         @patterns = patterns
+        @sort_union_types = sort_union_types
 
         @stack = []
         @args_return_map = Hash.new { |h, k| h[k] = [] }
@@ -36,9 +37,7 @@ module Orthoses
           case tp.event
           when :call
             if tp.defined_class.singleton_class?
-              # e.g. `Minitest::Spec::DSL#to_s`` may return `nil` with `#to_s`
-              m = tp.defined_class.to_s&.match(/#<Class:([\w:]+)>/) or next
-              mod_name = m[1] or next
+              mod_name = Utils.attached_module_name(tp.defined_class) or next
               kind = :singleton
             else
               mod_name = Utils.module_name(tp.defined_class) or next
@@ -81,6 +80,7 @@ module Orthoses
 
         @args_return_map.map do |(mod_name, kind, visibility, method_id), type_samples|
           type_samples.uniq!
+          type_samples.sort! if @sort_union_types
           method_types = type_samples.map do |(op_name_types, return_type)|
             required_positionals = []
             optional_positionals = []

data/lib/orthoses/utils.rb

@@ -171,6 +171,17 @@ module Orthoses
       end
     end
 
+    def self.attached_module_name(mod)
+      if mod.respond_to?(:attached_object)
+        attached_object = mod.attached_object
+        (attached_object&.is_a?(Module) && attached_object.name) || nil
+      else
+        # e.g. `Minitest::Spec::DSL#to_s` may return `nil` with `#to_s`
+        m = mod.to_s&.match(/#<Class:([\w:]+)>/)
+        m && m[1]
+      end
+    end
+
     def self.known_type_params(name)
       type_name =
         case name

data/lib/orthoses/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orthoses
-  VERSION = "1.13.0"
+  VERSION = "1.15.0"
 end

data/lib/orthoses.rb

@@ -14,6 +14,7 @@ module Orthoses
   autoload :CreateFileByName, 'orthoses/create_file_by_name'
   autoload :DelegateClass, 'orthoses/delegate_class'
   autoload :Descendants, 'orthoses/descendants'
+  autoload :ExcludeRBS, 'orthoses/exclude_rbs'
   autoload :Filter, 'orthoses/filter'
   autoload :Mixin, 'orthoses/mixin'
   autoload :LazyTracePoint, 'orthoses/lazy_trace_point'

data/sig/orthoses/call_tracer.rbs

@@ -17,7 +17,7 @@ module Orthoses::CallTracer::Capturable
 end
 
 module Orthoses::CallTracer::Capturable::ExtractRestParameters
-  def __extract_rest_parameters__: (*untyped rest, **untyped kw_rest) { () -> untyped } -> { :* => untyped, :** => untyped, :& => untyped, :"..." => ::Array[untyped] }
+  def __extract_rest_parameters__: (*untyped rest, **untyped kw_rest) { (*untyped, **untyped) -> untyped } -> untyped
 end
 
 class Orthoses::CallTracer::Capture < ::Struct[untyped]

data/sig/orthoses/constant.rbs

@@ -3,7 +3,7 @@
 class Orthoses::Constant
   @loader: Orthoses::_Call
   @strict: bool
-  @if: ^(Module mod, Symbol const, untyped val, String rbs) -> boolish?
+  @if: (^(Module mod, Symbol const, untyped val, String rbs) -> boolish)?
   @on_error: ^(Orthoses::ConstLoadError) -> void | nil
   def initialize: (Orthoses::_Call loader, ?strict: bool, ?if: ^(Module, Symbol, untyped) -> boolish | nil, ?on_error: ^(Orthoses::ConstLoadError) -> void | nil) -> void
   def call: () -> Orthoses::store

data/sig/orthoses/create_file_by_name.rbs

@@ -1,5 +1,10 @@
 # THIS IS GENERATED CODE from `$ rake sig`
 
+# @param to [String, nil]
+# @param header [String, nil]
+# @param if [Proc, nil]
+# @param depth [Integer, Hash{String => Integer}, nil]
+# @param rmtree [Boolean]
 class Orthoses::CreateFileByName
   @loader: Orthoses::_Call
   @to: untyped
@@ -7,6 +12,7 @@ class Orthoses::CreateFileByName
   @depth: untyped
   @rmtree: untyped
   @if: untyped
-  def initialize: (Orthoses::_Call loader, to: String, ?header: String?, ?depth: Integer?, ?rmtree: boolish) -> void
+  def initialize: (Orthoses::_Call loader, to: String, ?header: String?, ?depth: Integer | Hash[String, Integer] | nil, ?rmtree: boolish) -> void
   def call: () -> Orthoses::store
+  def extract: (untyped name) -> untyped
 end

data/sig/orthoses/exclude_rbs.rbs

@@ -0,0 +1,13 @@
+# THIS IS GENERATED CODE from `$ rake sig`
+
+# Exclude RBS from output.
+# @example
+#   use Orthoses::ExcludeRBS, paths: Dir['sig/hand-written/**/*.rbs']
+class Orthoses::ExcludeRBS
+  @loader: untyped
+  @paths: untyped
+  @rbs: untyped
+  def initialize: (untyped loader, ?paths: untyped?, ?rbs: untyped?) -> void
+  def call: () -> untyped
+  def add_signature_to_known_env: (untyped rbs) -> untyped
+end

data/sig/orthoses/trace.rbs

@@ -10,9 +10,10 @@ end
 class Orthoses::Trace::Attribute
   @loader: untyped
   @patterns: untyped
+  @sort_union_types: untyped
   @captured_dict: untyped
-  def initialize: (untyped loader, patterns: untyped) -> void
-  def call: () -> untyped
+  def initialize: (Orthoses::_Call loader, patterns: Array[String], ?sort_union_types: bool?) -> void
+  def call: () -> Orthoses::store
   private def build_trace_hook: () -> untyped
   include Orthoses::Trace::Targetable
 end
@@ -30,11 +31,12 @@ end
 class Orthoses::Trace::Method
   @loader: untyped
   @patterns: untyped
+  @sort_union_types: untyped
   @stack: untyped
   @args_return_map: untyped
   @alias_map: untyped
-  def initialize: (untyped loader, patterns: untyped) -> void
-  def call: () -> untyped
+  def initialize: (Orthoses::_Call loader, patterns: Array[String], ?sort_union_types: bool?) -> void
+  def call: () -> Orthoses::store
   private def build_trace_point: () -> untyped
   private def build_members: () -> untyped
   private def build_method_definitions: () -> untyped

data/sig/orthoses/utils.rbs

@@ -21,6 +21,8 @@ module Orthoses::Utils
 
   def self.module_to_type_name: (Module) -> RBS::TypeName?
 
+  def self.attached_module_name: (Module) -> String?
+
   def self.known_type_params: (Module | String) -> Array[RBS::AST::TypeParam]?
 
   def self.new_store: () -> Orthoses::store

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -49,6 +49,7 @@ files:
 - lib/orthoses/create_file_by_name.rb
 - lib/orthoses/delegate_class.rb
 - lib/orthoses/descendants.rb
+- lib/orthoses/exclude_rbs.rb
 - lib/orthoses/filter.rb
 - lib/orthoses/lazy_trace_point.rb
 - lib/orthoses/load_rbs.rb
@@ -89,6 +90,7 @@ files:
 - sig/orthoses/create_file_by_name.rbs
 - sig/orthoses/delegate_class.rbs
 - sig/orthoses/descendants.rbs
+- sig/orthoses/exclude_rbs.rbs
 - sig/orthoses/filter.rbs
 - sig/orthoses/lazy_trace_point.rbs
 - sig/orthoses/load_rbs.rbs
@@ -122,14 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Framework for Generate RBS