rbs 3.1.3 → 3.2.0

data/lib/rbs/cli.rb

@@ -645,6 +645,7 @@ EOU
         relative_libs = []
         merge = false
         owners_included = []
+        outline = false
 
         OptionParser.new do |opts|
           opts.banner = <<EOU
@@ -657,7 +658,7 @@ Examples:
 
   $ rbs prototype runtime String
   $ rbs prototype runtime --require set Set
-  $ rbs prototype runtime -R lib/rbs RBS::*
+  $ rbs prototype runtime -R lib/rbs RBS RBS::*
 
 Options:
 EOU
@@ -673,6 +674,9 @@ EOU
           opts.on("--method-owner CLASS", "Generate method prototypes if the owner of the method is [CLASS]") do |klass|
             owners_included << klass
           end
+          opts.on("--outline", "Generates only module/class/constant declaration (no method definition)") do
+            outline = true
+          end
         end.parse!(args)
 
         loader = options.loader()
@@ -686,7 +690,10 @@ EOU
           eval("require_relative(lib)", binding, "rbs")
         end
 
-        decls = Prototype::Runtime.new(patterns: args, env: env, merge: merge, owners_included: owners_included).decls
+        runtime = Prototype::Runtime.new(patterns: args, env: env, merge: merge, owners_included: owners_included)
+        runtime.outline = outline
+
+        decls = runtime.decls
 
         writer = Writer.new(out: stdout)
         writer.write decls
@@ -961,7 +968,7 @@ Options:
           Parser.public_send(parse_method, buf, require_eof: true)
         end
       rescue RBS::ParsingError => ex
-        stdout.puts ex.message
+        stdout.print ex.detailed_message(highlight: true)
         syntax_error = true
       end
 
@@ -1241,7 +1248,11 @@ EOB
           w.write(subtracted)
 
           if write_to_file
-            rbs_path.write(io.string)
+            if io.string.empty?
+              rbs_path.delete
+            else
+              rbs_path.write(io.string)
+            end
           else
             stdout.puts(io.string)
           end

data/lib/rbs/collection/config/lockfile_generator.rb

@@ -134,8 +134,12 @@ module RBS
             if locked
               lockfile.gems[name] = locked
 
-              locked[:source].dependencies_of(locked[:name], locked[:version])&.each do |dep|
-                assign_stdlib(name: dep["name"], from_gem: name)
+              begin
+                locked[:source].dependencies_of(locked[:name], locked[:version])&.each do |dep|
+                  assign_stdlib(name: dep["name"], from_gem: name)
+                end
+              rescue
+                RBS.logger.warn "Cannot find `#{locked[:name]}-#{locked[:version]}` gem. Using incorrect Bundler context? (#{definition.lockfile})"
               end
             end
           end

data/lib/rbs/collection/installer.rb

@@ -14,7 +14,10 @@ module RBS
       def install_from_lockfile
         install_to = lockfile.fullpath
         install_to.mkpath
-        lockfile.gems.each_value do |gem|
+        selected = lockfile.gems.select do |name, gem|
+          gem[:source].has?(name, gem[:version])
+        end
+        selected.each_value do |gem|
           gem[:source].install(
             dest: install_to,
             name: gem[:name],
@@ -22,7 +25,7 @@ module RBS
             stdout: stdout
           )
         end
-        stdout.puts "It's done! #{lockfile.gems.size} gems' RBSs now installed."
+        stdout.puts "It's done! #{selected.size} gems' RBSs now installed."
       end
     end
   end

data/lib/rbs/collection/sources/stdlib.rb

@@ -27,7 +27,11 @@ module RBS
         end
 
         def manifest_of(name, version)
-          manifest_path = (lookup(name, version) or raise).join('manifest.yaml')
+          unless path = lookup(name, version)
+            RBS.logger.warn "`#{name}` is specified in rbs_collection.lock.yaml. But it is not found in #{REPO.dirs.join(",")}"
+            return
+          end
+          manifest_path = path.join('manifest.yaml')
           YAML.safe_load(manifest_path.read) if manifest_path.exist?
         end
 

data/lib/rbs/errors.rb

@@ -22,7 +22,14 @@ module RBS
 
   module DetailedMessageable
     def detailed_message(highlight: false, **)
-      msg = super
+      msg = if Exception.method_defined?(:detailed_message)
+        super
+      else
+        # Failback to `#message` in Ruby 3.1 or earlier
+        "#{message} (#{self.class.name})"
+      end
+
+      return msg unless location
 
       # Support only one line
       return msg unless location.start_line == location.end_line

data/lib/rbs/file_finder.rb

@@ -5,7 +5,7 @@ module RBS
     module_function
 
     def self.each_file(path, immediate:, skip_hidden:, &block)
-      return enum_for(__method__, path, immediate: immediate, skip_hidden: skip_hidden) unless block
+      return enum_for((__method__ or raise), path, immediate: immediate, skip_hidden: skip_hidden) unless block
 
       case
       when path.file?

data/lib/rbs/prototype/rb.rb

@@ -5,11 +5,11 @@ module RBS
     class RB
       include Helpers
 
-      Context = _ = Struct.new(:module_function, :singleton, :namespace, keyword_init: true) do
+      Context = _ = Struct.new(:module_function, :singleton, :namespace, :in_def, keyword_init: true) do
         # @implements Context
 
         def self.initial(namespace: Namespace.root)
-          self.new(module_function: false, singleton: false, namespace: namespace)
+          self.new(module_function: false, singleton: false, namespace: namespace, in_def: false)
         end
 
         def method_kind
@@ -29,6 +29,14 @@ module RBS
             :instance
           end
         end
+
+        def enter_namespace(namespace)
+          Context.initial(namespace: self.namespace + namespace)
+        end
+
+        def update(module_function: self.module_function, singleton: self.singleton, in_def: self.in_def)
+          Context.new(module_function: module_function, singleton: singleton, namespace: namespace, in_def: in_def)
+        end
       end
 
       attr_reader :source_decls
@@ -121,11 +129,12 @@ module RBS
 
           decls.push kls
 
-          new_ctx = Context.initial(namespace: context.namespace + kls.name.to_namespace)
+          new_ctx = context.enter_namespace(kls.name.to_namespace)
           each_node class_body do |child|
             process child, decls: kls.members, comments: comments, context: new_ctx
           end
           remove_unnecessary_accessibility_methods! kls.members
+          sort_members! kls.members
 
         when :MODULE
           module_name, *module_body = node.children
@@ -142,11 +151,12 @@ module RBS
 
           decls.push mod
 
-          new_ctx = Context.initial(namespace: context.namespace + mod.name.to_namespace)
+          new_ctx = context.enter_namespace(mod.name.to_namespace)
           each_node module_body do |child|
             process child, decls: mod.members, comments: comments, context: new_ctx
           end
           remove_unnecessary_accessibility_methods! mod.members
+          sort_members! mod.members
 
         when :SCLASS
           this, body = node.children
@@ -195,6 +205,11 @@ module RBS
 
           decls.push member unless decls.include?(member)
 
+          new_ctx = context.update(singleton: kind == :singleton, in_def: true)
+          each_node def_body.children do |child|
+            process child, decls: decls, comments: comments, context: new_ctx
+          end
+
         when :ALIAS
           new_name, old_name = node.children.map { |c| literal_to_symbol(c) }
           member = AST::Members::Alias.new(
@@ -306,7 +321,7 @@ module RBS
             if args.empty?
               context.module_function = true
             else
-              module_func_context = context.dup.tap { |ctx| ctx.module_function = true }
+              module_func_context = context.update(module_function: true)
               args.each do |arg|
                 if arg && (name = literal_to_symbol(arg))
                   if (i, defn = find_def_index_by_name(decls, name))
@@ -377,6 +392,39 @@ module RBS
             comment: comments[node.first_lineno - 1]
           )
 
+        when :IASGN
+          case [context.singleton, context.in_def]
+          when [true, true], [false, false]
+            member = AST::Members::ClassInstanceVariable.new(
+              name: node.children.first,
+              type: Types::Bases::Any.new(location: nil),
+              location: nil,
+              comment: comments[node.first_lineno - 1]
+            )
+          when [false, true]
+            member = AST::Members::InstanceVariable.new(
+              name: node.children.first,
+              type: Types::Bases::Any.new(location: nil),
+              location: nil,
+              comment: comments[node.first_lineno - 1]
+            )
+          when [true, false]
+            # The variable is for the singleton class of the class object.
+            # RBS does not have a way to represent it. So we ignore it.
+          else
+            raise 'unreachable'
+          end
+
+          decls.push member if member && !decls.include?(member)
+
+        when :CVASGN
+          member = AST::Members::ClassVariable.new(
+            name: node.children.first,
+            type: Types::Bases::Any.new(location: nil),
+            location: nil,
+            comment: comments[node.first_lineno - 1]
+          )
+          decls.push member unless decls.include?(member)
         else
           process_children(node, decls: decls, comments: comments, context: context)
         end
@@ -413,7 +461,7 @@ module RBS
           when :SELF
             context.namespace.to_type_name
           when :CONST, :COLON2, :COLON3
-            const_to_name!(node)
+            const_to_name!(node) rescue nil
           end
         end
       end
@@ -743,6 +791,16 @@ module RBS
           ]
         end
       end
+
+      def sort_members!(decls)
+        i = 0
+        orders = {
+          AST::Members::ClassVariable => -3,
+          AST::Members::ClassInstanceVariable => -2,
+          AST::Members::InstanceVariable => -1,
+        }
+        decls.sort_by! { |decl| [orders.fetch(decl.class, 0), i += 1] }
+      end
     end
   end
 end

data/lib/rbs/prototype/rbi.rb

@@ -479,7 +479,7 @@ module RBS
           else
             Types::ClassInstance.new(name: const_to_name(type_node), args: [], location: nil)
           end
-        when type_node.type == :COLON2
+        when type_node.type == :COLON2 || type_node.type == :COLON3
           Types::ClassInstance.new(name: const_to_name(type_node), args: [], location: nil)
         when call_node?(type_node, name: :[], receiver: -> (_) { true })
           # The type_node represents a type application
@@ -553,11 +553,7 @@ module RBS
           TypeName.new(name: node.children[0], namespace: Namespace.empty)
         when :COLON2
           if node.children[0]
-            if node.children[0].type == :COLON3
-              namespace = Namespace.root
-            else
-              namespace = const_to_name(node.children[0]).to_namespace
-            end
+            namespace = const_to_name(node.children[0]).to_namespace
           else
             namespace = Namespace.empty
           end

data/lib/rbs/prototype/runtime.rb

@@ -9,6 +9,7 @@ module RBS
       attr_reader :env
       attr_reader :merge
       attr_reader :owners_included
+      attr_accessor :outline
 
       def initialize(patterns:, env:, merge:, owners_included: [])
         @patterns = patterns
@@ -19,6 +20,7 @@ module RBS
         @owners_included = owners_included.map do |name|
           Object.const_get(name)
         end
+        @outline = false
       end
 
       def target?(const)
@@ -378,7 +380,7 @@ module RBS
           RBS.logger.warn("Skipping anonymous superclass #{mod.superclass} of #{mod}")
           nil
         else
-          super_name = to_type_name(const_name(mod.superclass), full_name: true)
+          super_name = to_type_name(const_name(mod.superclass), full_name: true).absolute!
           super_args = type_args(super_name)
           AST::Declarations::Class::Super.new(name: super_name, args: super_args, location: nil)
         end
@@ -393,7 +395,7 @@ module RBS
         unless decl
           decl = AST::Declarations::Class.new(
             name: to_type_name(only_name(mod)),
-            type_params: [],
+            type_params: type_params(mod),
             super_class: generate_super_class(mod),
             members: [],
             annotations: [],
@@ -426,7 +428,7 @@ module RBS
           )
         end
 
-        generate_methods(mod, type_name, decl.members)
+        generate_methods(mod, type_name, decl.members) unless outline
 
         generate_constants mod, decl.members
       end
@@ -447,7 +449,7 @@ module RBS
         unless decl
           decl = AST::Declarations::Module.new(
             name: to_type_name(only_name(mod)),
-            type_params: [],
+            type_params: type_params(mod),
             self_types: [],
             members: [],
             annotations: [],
@@ -480,7 +482,7 @@ module RBS
           )
         end
 
-        generate_methods(mod, type_name, decl.members)
+        generate_methods(mod, type_name, decl.members) unless outline
 
         generate_constants mod, decl.members
       end
@@ -502,7 +504,7 @@ module RBS
             if outer_module.is_a?(Class)
               outer_decl = AST::Declarations::Class.new(
                 name: to_type_name(outer_module_name),
-                type_params: [],
+                type_params: type_params(outer_module),
                 super_class: generate_super_class(outer_module),
                 members: [],
                 annotations: [],
@@ -512,7 +514,7 @@ module RBS
             else
               outer_decl = AST::Declarations::Module.new(
                 name: to_type_name(outer_module_name),
-                type_params: [],
+                type_params: type_params(outer_module),
                 self_types: [],
                 members: [],
                 annotations: [],
@@ -539,7 +541,17 @@ module RBS
 
       def const_name(const)
         @module_name_method ||= Module.instance_method(:name)
-        @module_name_method.bind(const).call
+        name = @module_name_method.bind(const).call
+        return nil unless name
+
+        begin
+          Object.const_get(name)
+        rescue NameError
+          # Should generate const name if anonymous or internal module (e.g. NameError::message)
+          nil
+        else
+          name
+        end
       end
 
       def type_args(type_name)
@@ -550,6 +562,15 @@ module RBS
         end
       end
 
+      def type_params(mod)
+        type_name = to_type_name(const_name(mod), full_name: true)
+        if class_decl = env.class_decls[type_name.absolute!]
+          class_decl.type_params
+        else
+          []
+        end
+      end
+
       def block_from_ast_of(method)
         return nil if RUBY_VERSION < '3.1'
 

data/lib/rbs/subtractor.rb

@@ -51,6 +51,7 @@ module RBS
       context = _ = [context, decl.name]
       children = call(decl.each_decl.to_a, context: context) +
         decl.each_member.reject { |m| member_exist?(owner, m, context: context) }
+      children = filter_redundunt_access_modifiers(children)
       return nil if children.empty?
 
       update_decl(decl, members: children)
@@ -144,6 +145,22 @@ module RBS
       end
     end
 
+    private def filter_redundunt_access_modifiers(decls)
+      decls = decls.dup
+      decls.pop while access_modifier?(decls.last)
+      decls = decls.map.with_index do |decl, i|
+        if access_modifier?(decl) && access_modifier?(decls[i + 1])
+          nil
+        else
+          decl
+        end
+      end.compact
+    end
+
+    private def access_modifier?(decl)
+      decl.is_a?(AST::Members::Public) || decl.is_a?(AST::Members::Private)
+    end
+
     private def update_decl(decl, members:)
       case decl
       when AST::Declarations::Class

data/lib/rbs/type_name.rb

@@ -9,12 +9,12 @@ module RBS
     def initialize(namespace:, name:)
       @namespace = namespace
       @name = name
-      @kind = case name.to_s[0,1]
-              when /[A-Z]/
+      @kind = case
+              when name.match?(/\A[A-Z]/)
                 :class
-              when /[a-z]/
+              when name.match?(/\A[a-z]/)
                 :alias
-              when "_"
+              when name.start_with?("_")
                 :interface
               else
                 # Defaults to :class

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.1.3"
+  VERSION = "3.2.0"
 end

data/rbs.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.0"
 end

data/schema/decls.json

@@ -60,7 +60,7 @@
       "required": ["declaration", "name", "type", "comment", "location"]
     },
     "global": {
-      "title": "Global declaration: `$DEBUG: bool`, ...",
+      "title": "Global declaration: `$DEBUG: boolish`, ...",
       "type": "object",
       "properties": {
         "declaration": {

data/sig/errors.rbs

@@ -16,9 +16,23 @@ module RBS
   class BaseError < StandardError
   end
 
+  interface _Location
+    %a{pure} def location: () -> Location[untyped, untyped]?
+  end
+
+  interface _DetailedMessage
+    def detailed_message: (**untyped) -> String
+  end
+
+  module DetailedMessageable : _Location, _DetailedMessage
+    def detailed_message: (?highlight: boolish, **untyped) -> String
+  end
+
   # Error class for errors raised during parsing.
   #
   class ParsingError < BaseError
+    include DetailedMessageable
+
     attr_reader location: Location[untyped, untyped]
     attr_reader error_message: String
     attr_reader token_type: String
@@ -67,6 +81,8 @@ module RBS
   end
 
   class NoTypeFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader location: Location[untyped, untyped]?
 
@@ -85,6 +101,8 @@ module RBS
   end
 
   class NoSelfTypeFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader location: Location[untyped, untyped]?
 
@@ -96,6 +114,8 @@ module RBS
   end
 
   class NoMixinFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader member: AST::Members::t
 
@@ -107,6 +127,8 @@ module RBS
   end
 
   class DuplicatedMethodDefinitionError < DefinitionError
+    include DetailedMessageable
+
     type ty = Types::ClassSingleton | Types::ClassInstance | Types::Interface
     type original = DefinitionBuilder::MethodBuilder::Methods::Definition::original
 
@@ -143,6 +165,8 @@ module RBS
   # ```
   #
   class DuplicatedInterfaceMethodDefinitionError < DefinitionError
+    include DetailedMessageable
+
     type ty = Types::ClassSingleton | Types::ClassInstance | Types::Interface
     type mixin_member = AST::Members::Include | AST::Members::Extend
 
@@ -155,11 +179,15 @@ module RBS
     def type_name: () -> TypeName
 
     def qualified_method_name: () -> String
+
+    def location: () -> AST::Members::Mixin::loc?
   end
 
   # The `alias` member declares an alias from unknown method
   #
   class UnknownMethodAliasError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader original_name: Symbol
     attr_reader aliased_name: Symbol
@@ -178,12 +206,16 @@ module RBS
   # The *overloading* method definition cannot find *non-overloading* method definition
   #
   class InvalidOverloadMethodError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader method_name: Symbol
     attr_reader kind: :instance | :singleton
     attr_reader members: Array[AST::Members::MethodDefinition]
 
     def initialize: (type_name: TypeName, method_name: Symbol, kind: :instance | :singleton, members: Array[AST::Members::MethodDefinition]) -> void
+
+    def location: () -> AST::Members::MethodDefinition::loc?
   end
 
   class GenericParameterMismatchError < LoadingError
@@ -201,6 +233,8 @@ module RBS
   end
 
   class InvalidVarianceAnnotationError < DefinitionError
+    include DetailedMessageable
+
     attr_reader type_name: TypeName
     attr_reader param: AST::TypeParam
     attr_reader location: Location[untyped, untyped]?
@@ -209,6 +243,8 @@ module RBS
   end
 
   class RecursiveAliasDefinitionError < DefinitionError
+    include DetailedMessageable
+
     type ty = Types::ClassInstance | Types::ClassSingleton | Types::Interface
     type defn = DefinitionBuilder::MethodBuilder::Methods::Definition
 
@@ -223,6 +259,8 @@ module RBS
   # MixinClassError is raised if a include/prepend/extend has a class (not a module) to mix-in
   #
   class MixinClassError < DefinitionError
+    include DetailedMessageable
+
     type member = AST::Members::Include | AST::Members::Prepend | AST::Members::Extend
 
     attr_reader type_name: TypeName
@@ -240,6 +278,8 @@ module RBS
   # InheritModuleError is raised if a class definition inherits a module (not a class)
   #
   class InheritModuleError < DefinitionError
+    include DetailedMessageable
+
     attr_reader super_decl: AST::Declarations::Class::Super
 
     def initialize: (AST::Declarations::Class::Super) -> void
@@ -254,6 +294,8 @@ module RBS
   end
 
   class RecursiveTypeAliasError < BaseError
+    include DetailedMessageable
+
     attr_reader alias_names: Array[TypeName]
     attr_reader location: Location[untyped, untyped]?
 
@@ -263,6 +305,8 @@ module RBS
   end
 
   class NonregularTypeAliasError < BaseError
+    include DetailedMessageable
+
     # Diagnostic reported from `TypeAliasRegularity`.
     attr_reader diagnostic: TypeAliasRegularity::Diagnostic
 
@@ -273,6 +317,8 @@ module RBS
   end
 
   class CyclicTypeParameterBound < BaseError
+    include DetailedMessageable
+
     attr_reader location: Location[untyped, untyped]?
 
     # Array of parameters which contains cyclic dependencies.
@@ -295,16 +341,24 @@ module RBS
   # ```
   #
   class InconsistentClassModuleAliasError < BaseError
+    include DetailedMessageable
+
     attr_reader alias_entry: Environment::ModuleAliasEntry | Environment::ClassAliasEntry
 
     def initialize: (Environment::ModuleAliasEntry | Environment::ClassAliasEntry) -> void
+
+    def location: () -> AST::Declarations::AliasDecl::loc?
   end
 
   # A module/class alias declaration is cyclic
   #
   class CyclicClassAliasDefinitionError < BaseError
+    include DetailedMessageable
+
     attr_reader alias_entry: Environment::ModuleAliasEntry | Environment::ClassAliasEntry
 
     def initialize: (Environment::ModuleAliasEntry | Environment::ClassAliasEntry) -> void
+
+    def location: () -> AST::Declarations::AliasDecl::loc?
   end
 end

data/sig/parser.rbs

@@ -2,7 +2,7 @@ module RBS
   class Parser
     # Parse a method type and return it
     #
-    # When `range` keyword is specified, it starts parsing from the `begin` to the `endo` the range.
+    # When `range` keyword is specified, it starts parsing from the `begin` to the `end` of the range.
     #
     # ```ruby
     # RBS::Parser.parse_method_type("() -> void")                                # => `() -> void`
@@ -25,7 +25,7 @@ module RBS
 
     # Parse a type and return it
     #
-    # When `range` keyword is specified, it starts parsing from the `begin` to the `endo` the range.
+    # When `range` keyword is specified, it starts parsing from the `begin` to the `end` of the range.
     #
     # ```ruby
     # RBS::Parser.parse_type("String")                          # => `String`