orthoses 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bde1745c71d6d30b7b45ce7f956a1c02f0d44353932c3743211aa1c05f58d39
-  data.tar.gz: bbe5b95a7665d39faab82b5f53e18cffd22962df1913f1c52698ea51c6045e2c
+  metadata.gz: 0bbf41507135a45b3b2a45ffff90500a68a39f4497bf1fcbd72d94579fd27ae8
+  data.tar.gz: 8a6daa8a64d8bfbda565e24ec53622ca5530f5624e80f0c6fdfed5ca13b10786
 SHA512:
-  metadata.gz: 496d255f99751ac854e5b05ecac69b1e0dc7dbb5fca53bf99d6d622e2dbb154af643de7bf8de8190dca15ff1933fac35c17735da9285532a8a3246d7002836cd
-  data.tar.gz: 56c77cf9074eeb75547c1be3868e9843b0d5337400d2248592879f76fd6cc14f99660d8dbbf593c1d66bac1152e1dafbaa4820ea45a49f5f47945027ce45d53a
+  metadata.gz: c9d4a29dfc22972be165a703c4e86272a6e045ab34a91f76b560eeb329dca0795dab6eef59f419b50b7da4c390fcfa71d74d217baad3aa65b43f0000a2f7a126
+  data.tar.gz: 5579c33080fb673b50445fc8193f2876f8065e9ccc7ad2042020539a688f1242bfbe9dab265a780057040051f555f20b04ff62734ef844d25fea099a835d1c2a

data/README.md

@@ -29,11 +29,13 @@ For example, You can write script in Rakefile.
 require 'orthoses'
 
 namespace :rbs do
-  desc "build RBS to sig/out"
+  desc "build RBS to sig/orthoses"
   task :build do
     Orthoses::Builder.new do
       use Orthoses::CreateFileByName,
-        base_dir: Rails.root.join("sig/out"),
+        depth: 1,
+        to: "sig/orthoses",
+        rmtree: true,
         header: "# !!! GENERATED CODE !!!"
       use Orthoses::Filter do |name, _content|
         path, _lineno = Object.const_source_location(name)
@@ -53,7 +55,7 @@ namespace :rbs do
 end
 ```
 
-Then, you can see the result files under `sig/out`.
+Then, you can see the result files under `sig/orthoses`.
 
 ## Utils
 
@@ -177,6 +179,11 @@ Sort signatures by class/module.
 
 Trace the argument and return value objects when the method is actually called and determine the type.
 
+## 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.
+
 ## 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/builder.rb

@@ -13,7 +13,7 @@ module Orthoses
   class Builder
     def initialize(&block)
       @use = []
-      @run = nil
+      @runner = nil
       instance_eval(&block) if block
     end
 
@@ -37,7 +37,11 @@ module Orthoses
 
     def run(loader)
       use Store
-      @run = proc do
+      reset_runner(loader)
+    end
+
+    def reset_runner(loader)
+      @runner = proc do
         Orthoses.logger.info("[loader].call start")
         loader.call.tap do
           Orthoses.logger.info("[loader].call end")
@@ -46,7 +50,7 @@ module Orthoses
     end
 
     def to_loader
-      @use.reverse.inject(@run) { |current, next_proc| next_proc[current] }
+      @use.reverse.inject(@runner) { |current, next_proc| next_proc[current] }
     end
 
     def call

data/lib/orthoses/content/duplication_checker.rb

@@ -4,48 +4,86 @@ module Orthoses
     class DuplicationChecker
       def initialize(decl, env: nil)
         @decl = decl
-        @env = env || Utils.rbs_environment
+        @known_env = env || Utils.rbs_environment
+        @builder = RBS::DefinitionBuilder.new(env: @known_env)
+        @uniq_map = {}
       end
 
       def update_decl
         return unless @decl.respond_to?(:members)
-        uniq_map = {}
+
+        uniq_members
+        drop_set_method_definition
+        drop_known_method_definition
+        drop_known_const_definition
+
+        @decl.members.replace(@uniq_map.values)
+
+        @uniq_map.clear
+      end
+
+      private
+
+      def uniq_members
         @decl.members.each do |member|
           if member.instance_of?(RBS::AST::Members::MethodDefinition) && member.overloading?
             # avoid to duplicate and keep order
-            uniq_map[Object.new] = member
+            @uniq_map[Object.new] = member
           else
             key = member_key(member)
-            drop_member = uniq_map[key]
-            uniq_map[key] = member
+            drop_member = @uniq_map[key]
+            @uniq_map[key] = member
             if drop_member
               Orthoses.logger.info("#{@decl.name} \"#{member.location.source}\" was droped since duplication")
             end
           end
         end
-        drop_known_method_definition(uniq_map)
-        @decl.members.replace(uniq_map.values)
       end
 
-      private
+      def drop_set_method_definition
+        attr_accessors = @uniq_map.values.grep(RBS::AST::Members::AttrAccessor)
+        attr_accessors.each do |member|
+          @uniq_map.delete([RBS::AST::Members::MethodDefinition, :"#{member.name}=", member.kind])
+        end
+      end
 
-      def drop_known_method_definition(uniq_map)
+      def drop_known_method_definition
         decl_name = @decl.name.absolute!
-        if m_entry = @env.class_decls[decl_name]
+        if m_entry = @known_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))
+            drop_known_method_definition_recur(d)
+          end
+        end
+      end
+
+      def drop_known_method_definition_recur(d)
+        d.decl.members.each do |member|
+          case member
+          when RBS::AST::Members::LocationOnly
+            # ignore
+          when RBS::AST::Members::AttrAccessor
+            @uniq_map.delete([RBS::AST::Members::MethodDefinition, member.name, member.kind])
+            @uniq_map.delete([RBS::AST::Members::MethodDefinition, :"#{member.name}=", member.kind])
+          else
+            if member.kind_of?(RBS::AST::Members::Include) && member.name.interface?
+              # If interface is included, it is shared in the same namespace.
+              drop_known_method_definition_recur(@known_env.interface_decls[member.name])
+            else
+              @uniq_map.delete(member_key(member))
             end
           end
         end
+      end
 
-        constants_in_uniq_map = uniq_map.select do |key, value|
+      def drop_known_const_definition
+        decl_name = @decl.name.absolute!
+        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)
+          if @known_env.constant_decls[type_name]
+            @uniq_map.delete(key)
           end
         end
       end
@@ -60,12 +98,11 @@ module Orthoses
         when RBS::AST::Members::Alias
           [RBS::AST::Members::MethodDefinition, member.new_name, member.kind]
         when RBS::AST::Members::AttrAccessor
-          # FIXME: how to check "#{member.name}=" ?
           [RBS::AST::Members::MethodDefinition, member.name, member.kind]
         when RBS::AST::Members::AttrReader
           [RBS::AST::Members::MethodDefinition, member.name, member.kind]
         when RBS::AST::Members::AttrWriter
-          [RBS::AST::Members::MethodDefinition, "#{member.name}=", member.kind]
+          [RBS::AST::Members::MethodDefinition, :"#{member.name}=", member.kind]
         else
           [member.class, member.name]
         end

data/lib/orthoses/content/environment.rb

@@ -16,9 +16,17 @@ module Orthoses
         end
       end
 
-      def initialize(constant_filter: nil, mixin_filter: nil, attribute_filter: nil)
+      def initialize(
+        method_definition_filter: nil,
+        alias_filter: nil,
+        constant_filter: nil,
+        mixin_filter: nil,
+        attribute_filter: nil
+      )
         @load_env = RBS::Environment.new
         @known_env = Utils.rbs_environment(cache: false)
+        @method_definition_filter = method_definition_filter
+        @alias_filter = alias_filter
         @constant_filter = constant_filter
         @mixin_filter = mixin_filter
         @attribute_filter = attribute_filter
@@ -35,6 +43,7 @@ module Orthoses
         each do |add_content|
           content = store[add_content.name]
           content.header = add_content.header
+          content.comment ||= add_content.comment
           content.concat(add_content.body)
         end
       end
@@ -47,6 +56,7 @@ module Orthoses
         @load_env.class_decls.each do |type_name, m_entry|
           name = type_name.relative!.to_s
           content = Content.new(name: name)
+          content.comment = m_entry.primary.decl.comment&.string&.gsub(/^/, "# ")
           content.header = header_builder.build(entry: m_entry, name_hint: name)
           decls_to_lines(m_entry.decls.map(&:decl)).each do |line|
             content << line
@@ -94,9 +104,12 @@ module Orthoses
             when RBS::AST::Declarations::Constant
               next unless @constant_filter.nil? || @constant_filter.call(member)
             when RBS::AST::Members::MethodDefinition
+              next unless @method_definition_filter.nil? || @method_definition_filter.call(member)
               if last_visibility == :private && member.kind != :singleton_instance
                 member.instance_variable_set(:@visibility, :private)
               end
+            when RBS::AST::Members::Alias
+              next unless @alias_filter.nil? || @alias_filter.call(member)
             when RBS::AST::Members::Mixin
               next unless @mixin_filter.nil? || @mixin_filter.call(member)
             when RBS::AST::Members::Attribute

data/lib/orthoses/content.rb

@@ -74,12 +74,52 @@ module Orthoses
     end
 
     def original_rbs
-      a = []
-      a << @comment if @comment
-      a << @header
-      a << "  #{@body.join("\n  ")}" if @body.length > 0
-      a << "end"
-      a.join("\n")
+      io = StringIO.new
+      io.puts @comment if @comment
+      io.puts @header
+      @body.each do |line|
+        io.puts "  #{line}"
+      end
+      io.puts "end"
+      io.string
+    end
+
+    def auto_header
+      env = Utils.rbs_environment
+      if entry = env.class_decls[TypeName(name).absolute!]
+        @header = Content::HeaderBuilder.new(env: env).build(entry: entry)
+        return
+      end
+
+      return unless @header.nil?
+
+      if interface?
+        self.header = "interface #{name}"
+        return
+      end
+
+      val = Object.const_get(name)
+
+      case val
+      when Class
+        superclass =
+          if val.superclass && val.superclass != Object
+            super_module_name = Utils.module_name(val.superclass)
+
+            if super_module_name && super_module_name != "Random::Base" # https://github.com/ruby/rbs/pull/977
+              " < ::#{super_module_name}#{temporary_type_params(super_module_name)}"
+            else
+              nil
+            end
+          else
+            nil
+          end
+        self.header = "class #{Utils.module_name(val)}#{type_params(name)}#{superclass}"
+      when Module
+        self.header = "module #{Utils.module_name(val)}#{type_params(name)}"
+      else
+        raise "#{val.inspect} is not class/module"
+      end
     end
 
     private
@@ -132,44 +172,6 @@ module Orthoses
       raise
     end
 
-    def auto_header
-      env = Utils.rbs_environment
-      if entry = env.class_decls[TypeName(name).absolute!]
-        @header = Content::HeaderBuilder.new(env: env).build(entry: entry)
-        return
-      end
-
-      return unless @header.nil?
-
-      if interface?
-        self.header = "interface #{name}"
-        return
-      end
-
-      val = Object.const_get(name)
-
-      case val
-      when Class
-        superclass =
-          if val.superclass && val.superclass != Object
-            super_module_name = Utils.module_name(val.superclass)
-
-            if super_module_name && super_module_name != "Random::Base" # https://github.com/ruby/rbs/pull/977
-              " < ::#{super_module_name}#{temporary_type_params(super_module_name)}"
-            else
-              nil
-            end
-          else
-            nil
-          end
-        self.header = "class #{Utils.module_name(val)}#{type_params(name)}#{superclass}"
-      when Module
-        self.header = "module #{Utils.module_name(val)}#{type_params(name)}"
-      else
-        raise "#{val.inspect} is not class/module"
-      end
-    end
-
     def temporary_type_params(name)
       Utils.known_type_params(name)&.then do |params|
         if params.empty?

data/lib/orthoses/create_file_by_name.rb

@@ -6,31 +6,62 @@ module Orthoses
   class CreateFileByName
     prepend Outputable
 
-    def initialize(loader, base_dir:, header: nil, if: nil)
+    def initialize(loader, base_dir: nil, to: nil, header: nil, if: nil, depth: nil, rmtree: false)
+      unless base_dir.nil?
+        warn "[Orthoses::CreateFileByName] base_dir: option is deprecated. Please use to: option instead."
+      end
+
+      to = to || base_dir
+      unless to
+        raise ArgumentError, "should set to: option"
+      end
+
+      relative_path_from_pwd = Pathname(to).expand_path.relative_path_from(Pathname.pwd).to_s
+      unless relative_path_from_pwd == "." || !relative_path_from_pwd.match?(%r{\A[/\.]})
+        raise ArgumentError, "to=\"#{to}\" should be under current dir=\"#{Pathname.pwd}\"."
+      end
+
       @loader = loader
-      @base_dir = base_dir
+      @to = to
       @header = header
+      @depth = depth
+      @rmtree = rmtree
       @if = binding.local_variable_get(:if)
     end
 
     using Utils::Underscore
 
     def call
+      if @rmtree
+        Orthoses.logger.debug("Remove dir #{@to} since `rmtree: true`")
+        Pathname(@to).rmtree rescue nil
+      end
+
       store = @loader.call
 
-      store.each do |name, content|
-        next unless @if.nil? || @if.call(name, content)
+      store.select! do |name, content|
+        @if.nil? || @if.call(name, content)
+      end
+      grouped = store.group_by do |name, _|
+        splitted = name.to_s.split('::')
+        (@depth ? splitted[0, @depth] : splitted).join('::')
+      end
 
-        file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")
+      grouped.each do |group_name, group|
+        file_path = Pathname("#{@to}/#{group_name.split('::').map(&:underscore).join('/')}.rbs")
         file_path.dirname.mkpath
         file_path.open('w+') do |out|
           if @header
             out.puts @header
             out.puts
           end
-          out.puts content.to_rbs
+          group.sort!
+          contents = group.map do |(name, content)|
+            content.to_rbs
+          end.join("\n")
+          out.puts contents
+          Orthoses.logger.info("Generate file to #{file_path.to_s}")
         end
-        Orthoses.logger.info("Generate file to #{file_path.to_s}")
       end
     end
   end

data/lib/orthoses/filter.rb

@@ -16,8 +16,8 @@ module Orthoses
     def call
       @loader.call.tap do |store|
         store.filter! do |name, content|
-          @block.call(name, content).tap do
-            Orthoses.logger.debug("Filter pass [#{name}]")
+          @block.call(name, content).tap do |bool|
+            Orthoses.logger.debug("[Filter] #{bool ? "Pass" : "Reject"} [#{name}]")
           end
         end
       end

data/lib/orthoses/missing_name.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class MissingName
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def call
+      @loader.call.tap do |store|
+        MissingClass.new(store).call
+        MissingModule.new(store).call
+      end
+    end
+
+    private
+
+    class MissingClass
+      def initialize(store)
+        @store = store
+      end
+
+      def call
+        @store.values.each do |content|
+          recur(content)
+        end
+      end
+
+      private
+
+      def recur(content)
+        content.auto_header
+        if content.header && content.header.include?("<")
+          _, superclass = content.header.split(/\s*<\s*/, 2)
+          superclass.sub!(/\[.*/, "")
+          new_name = TypeName(superclass).relative!.to_s
+          recur(@store[new_name])
+        end
+      end
+    end
+
+    class MissingModule
+      def initialize(store)
+        @store = store
+      end
+
+      def call
+        missings = []
+        @store.keys.each do |key_name|
+          missings.concat split_name(key_name)
+        end
+        missings.uniq!
+        missings.each do |missing|
+          @store[missing].header = "module #{missing}"
+        end
+      end
+
+      private
+
+      def split_name(key_name)
+        ret = []
+
+        type_name = TypeName(key_name).relative!
+        if !Utils.rbs_defined_class?(type_name.to_s) && !@store.has_key?(type_name.to_s)
+          ret << type_name.to_s
+        end
+
+        path = type_name.namespace.path
+        path.each_with_index do |sym, index|
+          name = path[0, index + 1].join("::")
+          next if name.empty?
+          if !Utils.rbs_defined_class?(name) && !@store.has_key?(name)
+            ret << name
+          end
+        end
+
+        ret
+      end
+    end
+  end
+end

data/lib/orthoses/mixin.rb

@@ -50,6 +50,7 @@ module Orthoses
 
         base_mod_name = Utils.module_name(base_mod)
         next unless base_mod_name
+        next if base_mod_name.include?("#")
 
         content = store[base_mod_name]
         capture.argument[:modules].each do |mod|
@@ -58,13 +59,17 @@ module Orthoses
 
           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?
+          type_params_sig = ""
+          if type_params = Utils.known_type_params(mod)
+            if !type_params.empty?
+              type_params_sig = "[#{type_params.map{"untyped"}.join(", ")}]"
+            end 
+          end
 
           next unless @if.nil? || @if.call(base_mod, how, mod)
 
-          store[mod_name]
-          content << "#{how} #{mod_name}"
+          store[mod_name].header = "module #{mod_name}"
+          content << "#{how} #{mod_name}#{type_params_sig}"
         end
       end
     end

data/lib/orthoses/rbs_prototype_rb.rb

@@ -1,11 +1,23 @@
 module Orthoses
   # Call `rbs prototype rb` and add to store
   #     use Orthoses::RBSPrototypeRB,
-  #       paths: Dir.glob("lib/**/*.rb")
+  #       paths: Dir.glob("lib/**/*.rb"),
+  #       method_definition_filter: ->(member) { false },
+  #       alias_filter: ->(member) { false }
   class RBSPrototypeRB
-    def initialize(loader, paths:, constant_filter: nil, mixin_filter: nil, attribute_filter: nil)
+    def initialize(
+      loader,
+      paths:,
+      method_definition_filter: nil,
+      alias_filter: nil,
+      constant_filter: nil,
+      mixin_filter: nil,
+      attribute_filter: nil
+    )
       @loader = loader
       @paths = paths
+      @method_definition_filter = method_definition_filter
+      @alias_filter = alias_filter
       @constant_filter = constant_filter
       @mixin_filter = mixin_filter
       @attribute_filter = attribute_filter
@@ -23,6 +35,8 @@ module Orthoses
           end
         end
         env = Orthoses::Content::Environment.new(
+          method_definition_filter: @method_definition_filter,
+          alias_filter: @alias_filter,
           constant_filter: @constant_filter,
           mixin_filter: @mixin_filter,
           attribute_filter: @attribute_filter,

data/lib/orthoses/rbs_prototype_runtime.rb

@@ -3,14 +3,33 @@ module Orthoses
   #     use Orthoses::RBSPrototypeRuntime,
   #       patterns: ['Foo::*']
   class RBSPrototypeRuntime
-    def initialize(loader, patterns:)
+    def initialize(
+      loader,
+      patterns:,
+      method_definition_filter: nil,
+      alias_filter: nil,
+      constant_filter: nil,
+      mixin_filter: nil,
+      attribute_filter: nil
+    )
       @loader = loader
       @patterns = patterns
+      @method_definition_filter = method_definition_filter
+      @alias_filter = alias_filter
+      @constant_filter = constant_filter
+      @mixin_filter = mixin_filter
+      @attribute_filter = attribute_filter
     end
 
     def call
       @loader.call.tap do |store|
-        content_env = Orthoses::Content::Environment.new
+        content_env = Orthoses::Content::Environment.new(
+          method_definition_filter: @method_definition_filter,
+          alias_filter: @alias_filter,
+          constant_filter: @constant_filter,
+          mixin_filter: @mixin_filter,
+          attribute_filter: @attribute_filter,
+        )
 
         patterns = @patterns
         env = RBS::Environment.new

data/lib/orthoses/utils.rb

@@ -177,7 +177,7 @@ module Orthoses
         when String
           TypeName(name).absolute!
         when Module
-          module_to_type_name(name)
+          module_to_type_name(name).absolute!
         else
           raise TypeError
         end

data/lib/orthoses/version.rb

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

data/lib/orthoses.rb

@@ -17,6 +17,7 @@ module Orthoses
   autoload :Mixin, 'orthoses/mixin'
   autoload :LazyTracePoint, 'orthoses/lazy_trace_point'
   autoload :LoadRBS, 'orthoses/load_rbs'
+  autoload :MissingName, 'orthoses/missing_name'
   autoload :ObjectSpaceAll, 'orthoses/object_space_all'
   autoload :Outputable, 'orthoses/outputable'
   autoload :PathHelper, 'orthoses/path_helper'

data/sig/orthoses/_call.rbs

@@ -1,4 +1,4 @@
-# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+# THIS IS GENERATED CODE from `$ rake sig`
 
 interface Orthoses::_Call
   def call: () -> Orthoses::store

data/sig/orthoses/_middle_ware.rbs

@@ -1,4 +1,4 @@
-# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+# THIS IS GENERATED CODE from `$ rake sig`
 
 interface Orthoses::_MiddleWare
   include Orthoses::_Call

data/sig/orthoses/attribute/hook.rbs

@@ -1,4 +1,4 @@
-# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+# THIS IS GENERATED CODE from `$ rake sig`
 
 module Orthoses::Attribute::Hook
   def attr: (*untyped names) -> untyped

data/sig/orthoses/attribute.rbs

@@ -1,4 +1,4 @@
-# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+# THIS IS GENERATED CODE from `$ rake sig`
 
 class Orthoses::Attribute
   def initialize: (Orthoses::_Call loader) -> void

data/sig/orthoses/autoload/hook.rbs

@@ -1,4 +1,4 @@
-# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+# THIS IS GENERATED CODE from `$ rake sig`
 
 module Orthoses::Autoload::Hook
   def autoload: (untyped name, untyped path) -> untyped