orthoses 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5b96650f0b18fdb84d67bc6821887ac974e529bf13e05c079ad703645a0583
-  data.tar.gz: 50a0101c732e7a66d166e0ff4a3f6fd439d7c50ab2985ffb49c618e698f5873f
+  metadata.gz: 0e53d784825b1c759916988c4aaca8e6942fd89e0de4c73dff022f40ca265027
+  data.tar.gz: 7e6fdb9ac599274b713a9930d15bb8b81267c3afcc4a7ed3a6c747a13c711201
 SHA512:
-  metadata.gz: 2a9443b508c4dbb2518c656d34441fcedf4d571254834b375a99d97fd3c1443dd8bc4ef165c48334a66e64267efa7e9da7db43f9fcfea7c96d90a023f83e25b9
-  data.tar.gz: aa13ee94cb12d5729204fa8ecd926142bf56c58f30e9a6e13ee1c73914748fda0d752d3aeb7d31292de677c8ad4c19c5dd8636d919b05664b154cd4d62e0188a
+  metadata.gz: 61b9855a1f2744de78e9993d4adb024133aa08eeefa4541f9371bbb9598c500b8e4af2618ff9904039bbb086a2fde61b714c6ae20bc466077b1b46601f9d6735
+  data.tar.gz: 6a2eaea1e8da4d1231dbcf4ebb4b4b92e228a03656a89385a439ff651b5dc204a9fb5071e8fb11a0fec35e95e85e6e1c332cc341ecb72302bd3d2623e3779585

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orthoses (0.3.0)
+    orthoses (0.4.0)
       rbs (~> 2.0)
 
 GEM
@@ -30,9 +30,9 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.4.0)
+    rbs (2.5.0)
     rgot (1.1.0)
-    steep (0.52.2)
+    steep (1.0.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)

data/README.md

@@ -89,18 +89,6 @@ This is very useful for middleware development and debugging.
 If a class is defined using the `DelegateClass` method
 RBS is automatically generated as inherited.
 
-### Orthoses::Writer
-
-Write output RBS to `io` option object.
-`io` should be able to call `#write` method.
-This is useful when you want to combine outputs into a single output.
-
-### Orthoses::RBSPrototypeRB
-
-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.
-
 .rb
 
 ```rb
@@ -115,6 +103,22 @@ class Tempfile < File
 end
 ```
 
+### Orthoses::Writer
+
+Write output RBS to `io` option object.
+`io` should be able to call `#write` method.
+This is useful when you want to combine outputs into a single output.
+
+### Orthoses::RBSPrototypeRB
+
+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::AvoidRecursiveAncestorError
+
+Mixin a module into an Object class raises `RBS::RecursiveAncestorError` when validation.
+Please add this middleware then.
 
 ## Development
 

data/examples/minitest/Rakefile

@@ -0,0 +1,48 @@
+file :src do
+  sh "git clone https://github.com/minitest/minitest.git src"
+end
+
+desc "generate minitest"
+task :minitest => :src do
+  $:.unshift(File.expand_path("src/lib"))
+
+  out = Pathname('out')
+  out.rmtree rescue nil
+  require 'orthoses'
+
+  Orthoses::Builder.new do
+    use Orthoses::CreateFileByName,
+      base_dir: out.to_s
+    use Orthoses::Filter, if: ->(name, content) {
+      name.start_with?("Minitest") || name == "Kernel"
+    }
+    use Orthoses::Constant,
+      strict: false,
+      if: ->(current, const, val, rbs){
+        !Orthoses::Utils.rbs_defined_const?("#{current}::#{const}")
+      }
+    use Orthoses::Mixin
+    use Orthoses::RBSPrototypeRB,
+      paths: Dir.glob('src/lib/minitest{.rb,/*.rb}'),
+      constant_filter: ->(_) { false },
+      mixin_filter: ->(_) { false }
+    run ->(){
+      require_relative 'src/lib/minitest'
+      require_relative 'src/lib/minitest/test'
+      require_relative 'src/lib/minitest/spec'
+      require_relative 'src/lib/minitest/parallel'
+      require_relative 'src/lib/minitest/mock'
+      require_relative 'src/lib/minitest/benchmark'
+
+      require_relative 'src/lib/minitest/pride_plugin'
+    }
+  end.call
+
+  sh "rbs -r mutex_m -I #{out} validate --silent"
+  out.join("manifest.yaml").write <<~YAML
+    dependencies:
+      - name: mutex_m
+  YAML
+end
+
+task default: :minitest

data/examples/simple_middleware.rb

@@ -0,0 +1,11 @@
+module Orthoses
+  class Simple
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def call
+      @loader.call
+    end
+  end
+end

data/examples/simple_middleware.rbs

@@ -0,0 +1,7 @@
+module Orthoses
+  class Simple
+    @loader: Orthoses::_Call
+    include Orthoses::_MiddleWare
+    def initialize: (Orthoses::_Call loader) -> void
+  end
+end

data/lib/orthoses/avoid_recursive_ancestor_error.rb

@@ -0,0 +1,22 @@
+module Orthoses
+  class AvoidRecursiveAncestorError
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def call
+      @loader.call.tap do |store|
+        object_mixins = {}
+        store["Object"].to_decl.members.each do |member|
+          case member
+          when RBS::AST::Members::Mixin
+            object_mixins[member.name.relative!.to_s] = true
+          end
+        end
+        object_mixins.each_key do |object_mixin|
+          store[object_mixin].header = "module #{object_mixin} : BasicObject"
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/content/duplication_checker.rb

@@ -4,24 +4,38 @@ module Orthoses
     class DuplicationChecker
       def initialize(decl)
         @decl = decl
-        @uniq_map = {}
       end
 
-      def <<(member)
-        key = member_key(member)
-        if @uniq_map.key?(key)
-          Orthoses.logger.warn("#{@decl.name}::#{member_to_s(member)} was droped since duplication")
-        else
-          @uniq_map[key] = member
+      def update_decl
+        uniq_map = {}
+        @decl.members.reverse_each do |member|
+          key = member_key(member)
+          if uniq_map.key?(key)
+            Orthoses.logger.warn("#{@decl.name}::#{member_to_s(member)} was droped since duplication")
+          else
+            uniq_map[key] = member
+          end
         end
-      end
-
-      def uniq_members
-        @uniq_map.values
+        drop_known_method_definition(uniq_map)
+        @decl.members.replace(uniq_map.values.reverse)
       end
 
       private
 
+      def drop_known_method_definition(uniq_map)
+        env = Utils.rbs_environment(collection: true)
+        if m_entry = env.class_decls[@decl.name.absolute!]
+          m_entry.decls.each do |d|
+            d.decl.members.each do |member|
+              case member
+              when RBS::AST::Members::MethodDefinition, RBS::AST::Members::Alias
+                uniq_map.delete(member_key(member))
+              end
+            end
+          end
+        end
+      end
+
       def member_to_s(member)
         out = StringIO.new
         RBS::Writer.new(out: out).write_member(member)
@@ -36,7 +50,7 @@ module Orthoses
         when RBS::AST::Members::LocationOnly
           [member.class]
         when RBS::AST::Members::Alias
-          [member.class, member.new_name, member.old_name, member.kind]
+          [RBS::AST::Members::MethodDefinition, member.new_name, member.kind]
         else
           [member.class, member.name]
         end

data/lib/orthoses/content/environment.rb

@@ -2,90 +2,53 @@ module Orthoses
   class Content
     class Environment
       def initialize(constant_filter: nil, mixin_filter: nil)
-        @env = RBS::Environment.new
+        @load_env = RBS::Environment.new
+        @known_env = Utils.rbs_environment(collection: true)
         @constant_filter = constant_filter
         @mixin_filter = mixin_filter
       end
 
       def <<(decl)
-        @env << decl
+        if known_class_entry = @known_env.class_decls[decl.name.absolute!]
+          decl.type_params.replace(known_class_entry.primary.decl.type_params)
+        end
+        @load_env << decl
+      rescue RBS::DuplicatedDeclarationError => err
+        Orthoses.logger.warn(err.inspect)
       end
 
       def write_to(store:)
         each do |add_content|
           content = store[add_content.name]
-          # content.header = add_content.header
+          content.header ||= add_content.header
           content.concat(add_content.body)
         end
       end
 
       def each
-        each_class do |content|
-          yield content
-        end
-        each_interface do |content|
-          yield content
-        end
-      end
-
-      private
+        header_builder = HeaderBuilder.new(env: @load_env)
 
-      def each_class
-        @env.class_decls.each do |type_name, m_entry|
+        @load_env.class_decls.each do |type_name, m_entry|
           name = type_name.relative!.to_s
           content = Content.new(name: name)
-          case decl = m_entry.decls.first.decl
-          when RBS::AST::Declarations::Module
-            self_types = decl.self_types.empty? ? nil : " : #{decl.self_types.join(', ')}"
-            content.header = "module #{name_and_params(name, decl.type_params)}#{self_types}"
-          when RBS::AST::Declarations::Class
-            super_class = decl.super_class.nil? ? nil : " < #{name_and_args(decl.super_class.name, decl.super_class.args)}"
-            content.header = "class #{name_and_params(name, decl.type_params)}#{super_class}"
-          else
-            raise
-          end
+          content.header = header_builder.build(entry: m_entry, name_hint: name)
           decls_to_lines(m_entry.decls.map(&:decl)).each do |line|
             content << line
           end
           yield content
         end
-      end
 
-      def each_interface
-        @env.interface_decls.each do |type_name, s_entry|
+        @load_env.interface_decls.each do |type_name, s_entry|
           name = type_name.relative!.to_s
           content = Content.new(name: name)
-          decl = s_entry.decl
-          content.header = "interface #{name_and_params(name, decl.type_params)}"
-          decls_to_lines([decl]).each do |line|
+          content.header = header_builder.build(entry: s_entry)
+          decls_to_lines([s_entry.decl]).each do |line|
             content << line
           end
           yield content
         end
       end
 
-      def name_and_params(name, params)
-        if params.empty?
-          "#{name}"
-        else
-          ps = params.each.map do |param|
-            param.to_s
-          end
-
-          "#{name}[#{ps.join(", ")}]"
-        end
-      end
-
-      def name_and_args(name, args)
-        if name && args
-          if args.empty?
-            "#{name}"
-          else
-            "#{name}[#{args.join(", ")}]"
-          end
-        end
-      end
-
       def decls_to_lines(decls)
         out = StringIO.new
         writer = RBS::Writer.new(out: out)

data/lib/orthoses/content/header_builder.rb

@@ -0,0 +1,93 @@
+module Orthoses
+  class Content
+    class HeaderBuilder
+      def initialize(env:)
+        @env = env
+        @resolver = RBS::TypeNameResolver.from_env(env)
+      end
+
+      def build(entry:, name_hint: nil)
+        case entry
+        when RBS::Environment::ModuleEntry
+          build_module(entry: entry, name_hint: name_hint)
+        when RBS::Environment::ClassEntry
+          build_class(entry: entry, name_hint: name_hint)
+        when RBS::Environment::SingleEntry
+          build_interface(entry: entry, name_hint: name_hint)
+        else
+          raise
+        end
+      end
+
+      private
+
+      def build_module(entry:, name_hint: nil)
+        primary = entry.primary
+        full_name = name_hint || primary.decl.name.relative!
+
+        self_types =
+          if primary.decl.self_types.empty?
+            nil
+          else
+            " : #{primary.decl.self_types.join(', ')}"
+          end
+
+        "module #{name_and_params(full_name, primary.decl.type_params)}#{self_types}"
+      end
+
+      def build_class(entry:, name_hint: nil)
+        primary = entry.primary
+        full_name = name_hint || primary.decl.name.relative!
+
+        "class #{name_and_params(full_name, primary.decl.type_params)}#{build_super_class(primary)}"
+      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
+
+        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.absolute!]
+            super_primary = super_class_entry.primary
+            " < #{name_and_args(super_class_name, super_primary.decl.type_params.map { :untyped })}"
+          else
+            " < #{name_and_args(super_class_name, [])}"
+          end
+        else
+          " < #{name_and_args(super_class_name, primary.decl.super_class.args)}"
+        end
+      end
+
+      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)}"
+      end
+
+      def name_and_params(name, params)
+        if params.empty?
+          "#{name}"
+        else
+          ps = params.each.map do |param|
+            param.to_s
+          end
+
+          "#{name}[#{ps.join(", ")}]"
+        end
+      end
+
+      def name_and_args(name, args)
+        if name && args
+          if args.empty?
+            "#{name}"
+          else
+            "#{name}[#{args.join(", ")}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/content.rb

@@ -2,6 +2,7 @@
 
 require 'orthoses/content/duplication_checker'
 require 'orthoses/content/environment'
+require 'orthoses/content/header_builder'
 
 module Orthoses
   # Common interface for output.
@@ -20,36 +21,79 @@ module Orthoses
     attr_accessor :header
 
     def initialize(name:)
+      Orthoses.logger.debug("Create Orthoses::Content for #{name}")
       @name = name
       @body = []
       @header = nil
     end
 
     def <<(line)
-      Orthoses.logger.debug("[#{name}] << #{line} on #{__FILE__}:#{__LINE__}")
       @body << line
     end
 
     def concat(other)
-      Orthoses.logger.debug("[#{name}] concat #{other} on #{__FILE__}:#{__LINE__}")
       @body.concat(other)
     end
 
     def to_rbs
-      if @header.nil?
-        auto_header
-      end
-      body_uniq("#{@header}\n#{@body.map { |b| "  #{b}\n" }.join}end\n")
+      auto_header
+      uniqed_body_string
+    end
+
+    def to_decl
+      auto_header
+      uniqed_body_decl
     end
 
     private
 
+    def original_rbs
+      <<~RBS
+        #{@header}
+          #{@body.join("\n")}
+        end
+      RBS
+    end
+
+    def uniqed_body_string
+      out = StringIO.new
+      writer = RBS::Writer.new(out: out)
+      writer.write_decl(uniqed_body_decl)
+      out.string
+    end
+
+    def uniqed_body_decl
+      buffer = RBS::Buffer.new(
+        name: "orthoses/content.rb",
+        content: original_rbs
+      )
+      parsed_decls = RBS::Parser.parse_signature(buffer)
+      unless parsed_decls.length == 1
+        raise "expect decls.length == 1, but got #{parsed_decls.length}"
+      end
+      parsed_decl = parsed_decls.first or raise
+      parsed_decl.tap do |decl|
+        DuplicationChecker.new(decl).update_decl
+      end
+    rescue RBS::ParsingError
+      Orthoses.logger.error "```rbs\n#{original_rbs}```"
+      raise
+    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)
+        return
+      end
+
+      return unless @header.nil?
+
       val = Object.const_get(name)
 
       case val
@@ -93,28 +137,5 @@ module Orthoses
         end
       end
     end
-
-    def body_uniq(rbs)
-      buffer = RBS::Buffer.new(
-        name: "orthoses/content.rb",
-        content: rbs
-      )
-      out = StringIO.new
-      writer = RBS::Writer.new(out: out)
-      decls = RBS::Parser.parse_signature(buffer).map do |parsed_decl|
-        parsed_decl.tap do |decl|
-          duplicate_checker = DuplicationChecker.new(decl)
-          decl.members.each do |member|
-            duplicate_checker << member
-          end
-          decl.members.replace(duplicate_checker.uniq_members)
-        end
-      end
-      writer.write(decls)
-      out.string
-    rescue RBS::ParsingError
-      Orthoses.logger.error "```rbs\n#{rbs}```"
-      raise
-    end
   end
 end

data/lib/orthoses/mixin.rb

@@ -37,15 +37,7 @@ module Orthoses
           next unless known_type_params.nil? || known_type_params.empty?
           next unless @if.nil? || @if.call(base_mod, how, mod)
 
-          if base_mod_name == "Object"
-            # avoid RecursiveAncestorError
-            content = store[mod_name]
-            if content.header.nil?
-              content.header = "module #{Utils.module_to_type_name(mod)} : ::BasicObject"
-            end
-          else
-            store[mod_name]
-          end
+          store[mod_name]
 
           "#{how} #{mod_name}"
         end

data/lib/orthoses/rbs_prototype_rb.rb

@@ -15,6 +15,7 @@ module Orthoses
         parser = RBS::Prototype::RB.new
         @paths.each do |path|
           begin
+            Orthoses.logger.debug("parse #{path} by RBS::Prototype::RB")
             parser.parse File.read(path.to_s)
           rescue => err
             Orthoses.logger.error("Parse error #{err.inspect} by RBS::Prototype::RB #{path}")

data/lib/orthoses/version.rb

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

data/lib/orthoses.rb

@@ -3,6 +3,7 @@
 require 'rbs'
 require 'pathname'
 
+require_relative 'orthoses/avoid_recursive_ancestor_error'
 require_relative 'orthoses/builder'
 require_relative 'orthoses/call_tracer'
 require_relative 'orthoses/constant'

data/sig/orthoses/avoid_recursive_ancestor_error.rbs

@@ -0,0 +1,7 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::AvoidRecursiveAncestorError
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader) -> void
+end

data/sig/orthoses/const_load_error.rbs

@@ -1,6 +1,6 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
-class Orthoses::ConstLoadError < ::StandardError
+class Orthoses::ConstLoadError < StandardError
   attr_reader root: Module
   attr_reader const: Symbol
   attr_reader error: untyped

data/sig/orthoses/content.rbs

@@ -8,4 +8,7 @@ class Orthoses::Content
   def <<: (String) -> void
   def concat: (Array[String]) -> void
   def to_rbs: () -> String
+  private
+  def uniqed_body_string: () -> String
+  def uniqed_body_decl: () -> RBS::AST::Declarations::t
 end

data/sig/orthoses/name_space_error.rbs

@@ -1,4 +1,4 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
-class Orthoses::NameSpaceError < ::StandardError
+class Orthoses::NameSpaceError < StandardError
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -36,13 +36,18 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- examples/minitest/Rakefile
+- examples/simple_middleware.rb
+- examples/simple_middleware.rbs
 - lib/orthoses.rb
+- lib/orthoses/avoid_recursive_ancestor_error.rb
 - lib/orthoses/builder.rb
 - lib/orthoses/call_tracer.rb
 - lib/orthoses/constant.rb
 - lib/orthoses/content.rb
 - lib/orthoses/content/duplication_checker.rb
 - lib/orthoses/content/environment.rb
+- lib/orthoses/content/header_builder.rb
 - lib/orthoses/create_file_by_name.rb
 - lib/orthoses/delegate_class.rb
 - lib/orthoses/filter.rb
@@ -61,6 +66,7 @@ files:
 - sig/orthoses.rbs
 - sig/orthoses/_call.rbs
 - sig/orthoses/_middle_ware.rbs
+- sig/orthoses/avoid_recursive_ancestor_error.rbs
 - sig/orthoses/builder.rbs
 - sig/orthoses/builder/call_logable.rbs
 - sig/orthoses/call_tracer.rbs