orthoses 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2941ebbe45d7ab2dc9ad009628db52419a6a3b18a1fd1ad870164ab017bbb5e1
-  data.tar.gz: 5a33b4b63f62b820f4642d56661cebd393c3381363a8f727655f123568b2784b
+  metadata.gz: 1bbebf8271fbe9859e0e322e0e2d12fbf7a03dc30663309771edeba678674679
+  data.tar.gz: bfdfabbb3110a7c159a7763463077768d76b9cfd14ae77537a87d0abbd8fda74
 SHA512:
-  metadata.gz: bd9a27c8a8f6752fc73c2c65b8dbb0edcb9885425667a8a067a6d56cc2bb32473db565ea41089ad0f8b26c598275afa83e2fb3bbde6f668fc095c942bb75af01
-  data.tar.gz: 4b6c157a129e1e3dfab42737ba1a4ba0f9c1c5ffe25defb693de3bce39f63fdcc746b155d030e273162e550ada315281553d921475bd4a333bf362a46e5a58bd
+  metadata.gz: e1093d5bbc23bf0577d915afd70fa34907316bcdd2062e34cdc7506f455636e47e02bb046048e4682c16feeba2bc045985fbae2636bd2e220fc90a66f30e957b
+  data.tar.gz: 84fe1da94bfe208b46ddc1b3607ba7962e1133150fe454ffc8d4e40ca0dd6bc99c4b7e24f41a18f0217913eedd6e5b08e45329d07455e1e5fb913d102c13b67e

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in orthoses.gemspec
 gemspec
 
+gem "rbs"
 gem "rake", "~> 13.0"
 gem "rgot", "~> 1.1"
 gem "steep"
-gem "activesupport"

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    orthoses (0.8.0)
+    orthoses (0.11.0)
       rbs (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -15,45 +15,45 @@ GEM
     ast (2.4.2)
     concurrent-ruby (1.1.10)
     ffi (1.15.5)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.16.0.3)
+    language_server-protocol (3.17.0.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.15.0)
+    minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.5.0)
+    rbs (2.6.0)
     rgot (1.1.0)
-    steep (1.0.0)
+    steep (1.1.1)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
-      parser (>= 3.0)
+      parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
       rbs (>= 2.3.2)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
   orthoses!
   rake (~> 13.0)
+  rbs
   rgot (~> 1.1)
   steep
 

data/README.md

@@ -41,6 +41,34 @@ Orthoses::Builder.new do
 end.call
 ```
 
+## Utils
+
+`Orthoses::Utils` is a collection of useful methods.
+
+### Orthoses::Utils.each_const_recursive
+
+Yield const by recursive.
+
+### Orthoses::Utils.rbs_defined_const?
+
+Checks if the const name is already defined.
+
+### Orthoses::Utils.rbs_defined_class?
+
+Checks if the class name is already defined.
+
+### Orthoses::Utils.rbs_environment
+
+Fetch cached `RBS::Environment`.
+
+### Orthoses::Utils.object_to_rbs
+
+Convert Ruby object to RBS string.
+
+### Orthoses::Utils.module_name
+
+Get true module name by `Module.instance_method(:name).bind(mod).call`.
+
 ## Middlewares
 
 ### Orthoses::Constant
@@ -48,10 +76,14 @@ end.call
 Add constant signature to class/module.
 Signatures are predicted from constant values.
 
+### Orthoses::Attribute
+
+Add `attr`, `attr_accessor`, `attr_reader` and `attr_writer` to output RBS.
+All type set `untyped`.
+
 ### Orthoses::Mixin
 
 Add module include/extend/prepend definition.
-It use `Module#{includeed,extended,prepended}` for capture.
 
 ### Orthoses::ObjectSpaceAll
 
@@ -115,11 +147,19 @@ Run `rbs prototype rb` command process to `paths` option files.
 `content_filter` option could filter with content decl.
 `mixin_filter` option could filter with mixin(include, extend, prepend) decl.
 
+### Orthoses::RBSPrototypeRuntime
+
+Run `rbs prototype runtime` command process with `patterns` option string.
+
 ### Orthoses::AvoidRecursiveAncestorError
 
 Mixin a module into an Object class raises `RBS::RecursiveAncestorError` when validation.
 Please add this middleware then.
 
+### Orthoses::Autoload
+
+Force load const defined by `autoload`.
+
 ## 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/attribute.rb

@@ -40,8 +40,6 @@ module Orthoses
         end
       end
 
-      store["Module"].body.delete("prepend Orthoses::Attribute::Hook")
-
       attr.captures.each do |capture|
         m = capture.method.receiver.to_s.match(/#<Class:([\w:]+)>/)
         if m && m[1]

data/lib/orthoses/autoload.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class Autoload
+    module Hook
+      def autoload(name, path)
+        super
+      end
+    end
+
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def call
+      ::Module.prepend(Hook)
+
+      autoload = CallTracer.new
+
+      store = autoload.trace(Hook.instance_method(:autoload)) do
+        @loader.call
+      end
+
+      autoload.captures.each do |capture|
+        base_mod = capture.method.receiver
+        name = capture.argument[:name]
+        begin
+          base_mod.const_get(name)
+        rescue NameError, LoadError, ArgumentError => e
+          Orthoses.logger.warn("[Orthoses::Autoload] raise `#{e.message} (#{e.class})` when try to unautoload `#{base_mod}::#{name}`")
+        end
+      end
+
+      store
+    end
+  end
+end

data/lib/orthoses/call_tracer/capturable.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class CallTracer
+    module Capturable
+      def build_capture(tp)
+        Capture.new(
+          method: build_method(tp),
+          argument: build_argument(tp),
+        )
+      end
+
+      private
+
+      def build_method(tp)
+        METHOD_METHOD.bind(tp.self).call(tp.method_id)
+      end
+
+      def build_argument(tp)
+        tp.parameters.each_with_object({}) do |op_name, hash|
+          name = op_name[1]
+          case name
+          when :*, :**, :&, nil
+            # skip
+          else
+            hash[name] = tp.binding.local_variable_get(name).then do |var|
+              case var
+              when Module, Thread::Backtrace::Location
+                var
+              else
+                var.dup
+              end
+            rescue => err
+              warn("#dup fail (#{err.class}) #{err.message}")
+              var
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/call_tracer/lazy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class CallTracer
+    class Lazy
+      include Capturable
+
+      attr_reader :captures
+
+      def initialize
+        @captures = []
+        @lazy_trace_point = LazyTracePoint.new(:call) do |tp|
+          @captures << build_capture(tp)
+        end
+      end
+
+      def trace(name, &block)
+        @lazy_trace_point.enable(target: name, &block)
+      end
+    end
+  end
+end

data/lib/orthoses/call_tracer.rb

@@ -16,46 +16,22 @@ module Orthoses
     class Capture < Struct.new(:method, :argument, keyword_init: true)
     end
 
+    autoload :Lazy, 'orthoses/call_tracer/lazy'
+    require_relative 'call_tracer/capturable'
+
+    include Capturable
+
     attr_accessor :captures
 
     def initialize
       @captures = []
+      @target_tp = TracePoint.new(:call) do |tp|
+        @captures << build_capture(tp)
+      end
     end
 
     def trace(target, &block)
-      t = TracePoint.new(:call) do |tp|
-        called_method = tp.self.method(tp.method_id)
-        argument = tp.parameters.each_with_object({}) do |op_name, hash|
-          name = op_name[1]
-          case name
-          when :*, :**, :&, nil
-            # skip
-          else
-            hash[name] = tp.binding.local_variable_get(name).then do |var|
-              case var
-              when Module
-                var # avoid missing name
-              else
-                var.dup
-              end
-            rescue => err
-              case var
-              when Thread::Backtrace::Location
-                # known
-              else
-                warn("#dup fail (#{err.class}) #{err.message}")
-              end
-              var
-            end
-          end
-        end
-
-        @captures << Capture.new(
-          method: called_method,
-          argument: argument,
-        )
-      end
-      t.enable(target: target, &block)
+      @target_tp.enable(target: target, &block)
     end
   end
 end

data/lib/orthoses/content/duplication_checker.rb

@@ -2,18 +2,20 @@ module Orthoses
   class Content
     # Check and drop duplication method, const etc...
     class DuplicationChecker
-      def initialize(decl)
+      def initialize(decl, env: nil)
         @decl = decl
+        @env = env || Utils.rbs_environment(collection: true)
       end
 
       def update_decl
+        return unless @decl.respond_to?(:members)
         uniq_map = {}
         @decl.members.each do |member|
           key = member_key(member)
           drop_member = uniq_map[key]
           uniq_map[key] = member
           if drop_member
-            Orthoses.logger.warn("#{@decl.name}::#{drop_member} was droped since duplication")
+            Orthoses.logger.info("#{@decl.name} \"#{member.location.source}\" was droped since duplication")
           end
         end
         drop_known_method_definition(uniq_map)
@@ -23,20 +25,24 @@ module Orthoses
       private
 
       def drop_known_method_definition(uniq_map)
-        env = Utils.rbs_environment(collection: true)
-        if m_entry = env.class_decls[@decl.name.absolute!]
+        decl_name = @decl.name.absolute!
+        if m_entry = @env.class_decls[decl_name]
           m_entry.decls.each do |d|
             d.decl.members.grep_v(RBS::AST::Members::LocationOnly).each do |member|
               uniq_map.delete(member_key(member))
             end
           end
         end
-      end
 
-      def member_to_s(member)
-        out = StringIO.new
-        RBS::Writer.new(out: out).write_member(member)
-        out.string.chomp
+        constants_in_uniq_map = uniq_map.select do |key, value|
+          value.kind_of?(RBS::AST::Declarations::Constant)
+        end
+        constants_in_uniq_map.each do |key, value|
+          type_name = decl_name + value.name
+          if @env.constant_decls[type_name]
+            uniq_map.delete(key)
+          end
+        end
       end
 
       def member_key(member)

data/lib/orthoses/content/header_builder.rb

@@ -43,13 +43,9 @@ module Orthoses
       end
 
       def build_super_class(primary)
-        return nil if primary.decl.super_class.then { |s| s.nil? || s.name.relative!.to_s.then { |n| n == "Object" || n == "Random::Base" } }
-
-        context = primary.outer.length.times.map do |i|
-          primary.outer[0, i + 1].map(&:name).inject(:+).to_namespace.absolute!
-        end
-        context.push(RBS::Namespace.root)
+        return nil if primary.decl.super_class.then { |s| s.nil? || s.name.relative!.to_s.then { |n| n == "Object" || n == "Random::Base" || n.start_with?("RBS::Unnamed") } }
 
+        context = build_context(entry: primary)
         super_class_name = @resolver.resolve(primary.decl.super_class.name, context: context) || primary.decl.super_class.name
         if primary.decl.super_class.args.empty?
           if super_class_entry = @env.class_decls[super_class_name]
@@ -65,7 +61,16 @@ module Orthoses
 
       def build_interface(entry:, name_hint: nil)
         full_name = name_hint || entry.decl.name.relative!
-        "interface #{name_and_params(full_name, entry.decl.type_params)}"
+        context = build_context(entry: entry)
+        resolved_name = @resolver.resolve(full_name, context: context) || full_name
+        "interface #{name_and_params(resolved_name.relative!, entry.decl.type_params)}"
+      end
+
+      def build_context(entry:)
+        context = entry.outer.length.times.map do |i|
+          entry.outer[0, i + 1].map(&:name).inject(:+).to_namespace.absolute!
+        end
+        context.push(RBS::Namespace.root)
       end
 
       def name_and_params(name, params)

data/lib/orthoses/content.rb

@@ -35,6 +35,14 @@ module Orthoses
       @body.concat(other)
     end
 
+    def empty?
+      @body.empty?
+    end
+
+    def delete(val)
+      @body.delete(val)
+    end
+
     def to_rbs
       auto_header
       uniqed_body_string
@@ -45,14 +53,36 @@ module Orthoses
       uniqed_body_decl
     end
 
-    private
+    def uniq!
+      out = ArrayIO.new
+      writer = RBS::Writer.new(out: out)
+      to_decl.members.each do |member|
+        writer.write_member(member)
+      end
+      @body.replace(out.to_a)
+    end
 
     def original_rbs
-      <<~RBS
-        #{@header}
-          #{@body.join("\n")}
-        end
-      RBS
+      a = [@header]
+      a << "  #{@body.join("\n  ")}" if @body.length > 0
+      a << "end"
+      a.join("\n")
+    end
+
+    private
+
+    class ArrayIO
+      def initialize
+        @outs = []
+      end
+
+      def puts(line)
+        @outs << line
+      end
+
+      def to_a
+        @outs
+      end
     end
 
     def uniqed_body_string
@@ -81,11 +111,6 @@ module Orthoses
     end
 
     def auto_header
-      if name.split('::').last.start_with?('_')
-        self.header = "interface #{name}"
-        return
-      end
-
       env = Utils.rbs_environment(collection: true)
       if entry = env.class_decls[TypeName(name).absolute!]
         @header = Content::HeaderBuilder.new(env: env).build(entry: entry)
@@ -94,6 +119,11 @@ module Orthoses
 
       return unless @header.nil?
 
+      if name.split('::').last.start_with?('_')
+        self.header = "interface #{name}"
+        return
+      end
+
       val = Object.const_get(name)
 
       case val

data/lib/orthoses/create_file_by_name.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require 'orthoses/outputable'
+
 module Orthoses
   class CreateFileByName
-    def initialize(loader, base_dir:, header: nil)
+    prepend Outputable
+
+    def initialize(loader, base_dir:, header: nil, if: nil)
       @loader = loader
       @base_dir = base_dir
       @header = header
+      @if = binding.local_variable_get(:if)
     end
 
     using(Module.new {
@@ -28,12 +33,15 @@ module Orthoses
       store = @loader.call
 
       store.each do |name, content|
-        rbs = begin
-          content.to_rbs
+        begin
+          content.uniq!
         rescue NameError, LoadError => err
           Orthoses.logger.error(err.inspect)
           next
         end
+
+        next unless @if.nil? || @if.call(name, content)
+
         file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")
         file_path.dirname.mkpath
         file_path.open('w+') do |out|
@@ -41,7 +49,7 @@ module Orthoses
             out.puts @header
             out.puts
           end
-          out.puts rbs
+          out.puts content.original_rbs
         end
         Orthoses.logger.info("Generate file to #{file_path.to_s}")
       end

data/lib/orthoses/lazy_trace_point.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # TracePoint wrapper that allows setting hooks
+  # even if the target is undefined
+  #   LazyTracePoint.new(:call) do |tp|
+  #     ...
+  #   end.enable(target: 'Class#class_attribute') do
+  #     require 'active_support/core_ext/class/attribute'
+  #     ...
+  #   end
+  class LazyTracePoint < TracePoint
+    # for TracePoint target
+    ::Module.prepend(Module.new{
+      def method_added(id)
+        super
+      end
+    })
+    ::BasicObject.prepend(Module.new{
+      def singleton_method_added(id)
+        super
+      end
+    })
+
+    METHOD_METHOD = ::Kernel.instance_method(:method)
+    INSTANCE_METHOD_METHOD = ::Module.instance_method(:instance_method)
+    UNBOUND_NAME_METHOD = ::Module.instance_method(:name)
+    METHOD_ADDED_METHOD = ::Module.instance_method(:method_added)
+    SINGLETON_METHOD_ADDED_METHOD = ::BasicObject.instance_method(:singleton_method_added)
+
+    def initialize(*events, &block)
+      @mod_name = nil
+      @instance_method_id = nil
+      @singleton_method_id = nil
+      super
+    end
+
+    def enable(target: nil, target_line: nil, target_thread: nil, &block)
+      return super unless target.kind_of?(String)
+
+      case
+      when target.include?('#')
+        @mod_name, instance_method_id = target.split('#', 2)
+        @instance_method_id = instance_method_id.to_sym
+        @singleton_method_id = nil
+
+        trace_instance_method(&block)
+      when target.include?('.')
+        @mod_name, singleton_method_id = target.split('.', 2)
+        @singleton_method_id = singleton_method_id.to_sym
+        @instance_method_id = nil
+
+        trace_singleton_method(&block)
+      else
+        raise ArgumentError, "argument shuold be 'Foo#foo' or 'Foo.foo' format"
+      end
+    end
+
+    private
+
+    def trace_instance_method(&block)
+      # try to load
+      target = Object.const_get(@mod_name).instance_method(@instance_method_id)
+      enable(target: target, &block)
+    rescue NameError
+      TracePoint.new(:call) do |tp|
+        id = tp.binding.local_variable_get(:id)
+        next unless id == @instance_method_id
+
+        mod_name = UNBOUND_NAME_METHOD.bind(tp.self).call
+
+        next unless mod_name
+        next unless mod_name == @mod_name
+
+        enable(target: INSTANCE_METHOD_METHOD.bind(tp.self).call(id))
+        tp.disable
+      end.enable(target: METHOD_ADDED_METHOD, &block)
+    ensure
+      disable
+    end
+
+    def trace_singleton_method(&block)
+      # try to load
+      target = Object.const_get(@mod_name).method(@singleton_method_id)
+      enable(target: target, &block)
+    rescue NameError
+      TracePoint.new(:call) do |tp|
+        id = tp.binding.local_variable_get(:id)
+        next unless id == @singleton_method_id
+
+        mod_name = UNBOUND_NAME_METHOD.bind(tp.self).call
+
+        next unless mod_name
+        next unless mod_name == @mod_name
+
+        enable(target: METHOD_METHOD.bind(tp.self).call(id))
+        tp.disable
+      end.enable(target: SINGLETON_METHOD_ADDED_METHOD, &block)
+    ensure
+      disable
+    end
+  end
+end

data/lib/orthoses/load_rbs.rb

@@ -11,7 +11,9 @@ module Orthoses
 
     def call
       @loader.call.tap do |store|
-        env = Content::Environment.load_from_paths(@paths)
+        paths = @paths
+        paths = paths.call if paths.instance_of?(Proc)
+        env = Content::Environment.load_from_paths(paths.to_a)
         env.write_to(store: store)
       end
     end

data/lib/orthoses/mixin.rb

@@ -34,8 +34,6 @@ module Orthoses
         end
       end
 
-      store["Module"].body.delete("prepend Orthoses::Mixin::Hook")
-
       collect_definitions(store, include, :include)
       collect_definitions(store, extend, :extend)
       collect_definitions(store, prepend, :prepend)
@@ -58,6 +56,8 @@ module Orthoses
           mod_name = Utils.module_name(mod)
           next unless mod_name
 
+          next if mod_name.start_with?("Orthoses")
+
           known_type_params = Utils.known_type_params(mod)
           next unless known_type_params.nil? || known_type_params.empty?