rbs 2.6.0 → 2.7.0.pre.1

data/core/module.rbs

@@ -1401,7 +1401,7 @@ class Module < Object
   #
   # Returns a module, where refined methods are defined.
   #
-  def refine: (Class arg0) { (untyped arg0) -> untyped } -> self
+  def refine: (Module mod) { () -> void } -> Refinement
 
   # <!--
   #   rdoc-file=object.c

data/core/regexp.rbs

@@ -760,7 +760,7 @@ class Regexp
   #     r3 = Regexp.new(r2)              #=> /cat/i
   #     r4 = Regexp.new('dog', Regexp::EXTENDED | Regexp::IGNORECASE) #=> /dog/ix
   #
-  def initialize: (String string, ?Integer | nil | false options, ?String kcode) -> Object
+  def initialize: (String string, ?Integer | nil | false | top options, ?String kcode) -> Object
                 | (Regexp regexp) -> void
 
   # <!--

data/core/string_io.rbs

@@ -450,7 +450,7 @@ class StringIO
   # opened for writing.  If the argument is not a string, it will be converted to
   # a string using `to_s`. Returns the number of bytes written.  See IO#write.
   #
-  def write: (String arg0) -> Integer
+  def write: (*_ToS) -> Integer
 
   # This is a deprecated alias for #each_byte.
   #

data/core/warning.rbs

@@ -38,5 +38,5 @@ module Warning
   #
   # See the documentation of the Warning module for how to customize this.
   #
-  def warn: (String) -> nil
+  def self?.warn: (String message, ?category: :deprecated | :experimental | nil) -> nil
 end

data/ext/rbs_extension/parser.c

@@ -566,13 +566,30 @@ static void initialize_method_params(method_params *params){
 }
 
 /*
-  function ::= {} `(` params `)` `{` `(` params `)` `->` optional `}` `->` <optional>
-             | {} `(` params `)` `->` <optional>
-             | {} `{` `(` params `)` `->` optional `}` `->` <optional>
-             | {} `{` `->` optional `}` `->` <optional>
-             | {} `->` <optional>
+  self_type_binding ::= {} <>
+                      | {} `[` `self` `:` type <`]`>
 */
-static void parse_function(parserstate *state, VALUE *function, VALUE *block) {
+static VALUE parse_self_type_binding(parserstate *state) {
+  if (state->next_token.type == pLBRACKET) {
+    parser_advance(state);
+    parser_advance_assert(state, kSELF);
+    parser_advance_assert(state, pCOLON);
+    VALUE type = parse_type(state);
+    parser_advance_assert(state, pRBRACKET);
+    return type;
+  } else {
+    return Qnil;
+  }
+}
+
+/*
+  function ::= {} `(` params `)` self_type_binding? `{` `(` params `)` self_type_binding? `->` optional `}` `->` <optional>
+             | {} `(` params `)` self_type_binding? `->` <optional>
+             | {} self_type_binding? `{` `(` params `)` self_type_binding? `->` optional `}` `->` <optional>
+             | {} self_type_binding? `{` self_type_binding `->` optional `}` `->` <optional>
+             | {} self_type_binding? `->` <optional>
+*/
+static void parse_function(parserstate *state, VALUE *function, VALUE *block, VALUE *function_self_type) {
   method_params params;
   initialize_method_params(&params);
 
@@ -582,6 +599,11 @@ static void parse_function(parserstate *state, VALUE *function, VALUE *block) {
     parser_advance_assert(state, pRPAREN);
   }
 
+  // Passing NULL to function_self_type means the function itself doesn't accept self type binding. (== method type)
+  if (function_self_type) {
+    *function_self_type = parse_self_type_binding(state);
+  }
+
   VALUE required = Qtrue;
   if (state->next_token.type == pQUESTION && state->next_token2.type == pLBRACE) {
     // Optional block
@@ -600,6 +622,8 @@ static void parse_function(parserstate *state, VALUE *function, VALUE *block) {
       parser_advance_assert(state, pRPAREN);
     }
 
+    VALUE block_self_type = parse_self_type_binding(state);
+
     parser_advance_assert(state, pARROW);
     VALUE block_return_type = parse_optional(state);
 
@@ -614,7 +638,8 @@ static void parse_function(parserstate *state, VALUE *function, VALUE *block) {
         block_params.rest_keywords,
         block_return_type
       ),
-      required
+      required,
+      block_self_type
     );
 
     parser_advance_assert(state, pRBRACE);
@@ -642,11 +667,12 @@ static VALUE parse_proc_type(parserstate *state) {
   position start = state->current_token.range.start;
   VALUE function = Qnil;
   VALUE block = Qnil;
-  parse_function(state, &function, &block);
+  VALUE proc_self = Qnil;
+  parse_function(state, &function, &block, &proc_self);
   position end = state->current_token.range.end;
   VALUE loc = rbs_location_pp(state->buffer, &start, &end);
 
-  return rbs_proc(function, block, loc);
+  return rbs_proc(function, block, loc, proc_self);
 }
 
 /**
@@ -1130,7 +1156,7 @@ VALUE parse_method_type(parserstate *state) {
 
   type_range.start = state->next_token.range.start;
 
-  parse_function(state, &function, &block);
+  parse_function(state, &function, &block, NULL);
 
   rg.end = state->current_token.range.end;
   type_range.end = rg.end;

data/ext/rbs_extension/ruby_objs.c

@@ -144,10 +144,11 @@ VALUE rbs_optional(VALUE type, VALUE location) {
   );
 }
 
-VALUE rbs_block(VALUE type, VALUE required) {
+VALUE rbs_block(VALUE type, VALUE required, VALUE self_type) {
   VALUE args = rb_hash_new();
   rb_hash_aset(args, ID2SYM(rb_intern("type")), type);
   rb_hash_aset(args, ID2SYM(rb_intern("required")), required);
+  rb_hash_aset(args, ID2SYM(rb_intern("self_type")), self_type);
 
   return CLASS_NEW_INSTANCE(
     RBS_Types_Block,
@@ -196,11 +197,12 @@ VALUE rbs_function(
   );
 }
 
-VALUE rbs_proc(VALUE function, VALUE block, VALUE location) {
+VALUE rbs_proc(VALUE function, VALUE block, VALUE location, VALUE self_type) {
   VALUE args = rb_hash_new();
   rb_hash_aset(args, ID2SYM(rb_intern("type")), function);
   rb_hash_aset(args, ID2SYM(rb_intern("block")), block);
   rb_hash_aset(args, ID2SYM(rb_intern("location")), location);
+  rb_hash_aset(args, ID2SYM(rb_intern("self_type")), self_type);
 
   return CLASS_NEW_INSTANCE(
     RBS_Types_Proc,

data/ext/rbs_extension/ruby_objs.h

@@ -22,7 +22,7 @@ VALUE rbs_ast_members_mixin(VALUE klass, VALUE name, VALUE args, VALUE annotatio
 VALUE rbs_ast_members_variable(VALUE klass, VALUE name, VALUE type, VALUE location, VALUE comment);
 VALUE rbs_ast_members_visibility(VALUE klass, VALUE location);
 VALUE rbs_base_type(VALUE klass, VALUE location);
-VALUE rbs_block(VALUE type, VALUE required);
+VALUE rbs_block(VALUE type, VALUE required, VALUE self_type);
 VALUE rbs_class_instance(VALUE typename, VALUE type_args, VALUE location);
 VALUE rbs_class_singleton(VALUE typename, VALUE location);
 VALUE rbs_function_param(VALUE type, VALUE name, VALUE location);
@@ -33,7 +33,7 @@ VALUE rbs_literal(VALUE literal, VALUE location);
 VALUE rbs_method_type(VALUE type_params, VALUE type, VALUE block, VALUE location);
 VALUE rbs_namespace(VALUE path, VALUE absolute);
 VALUE rbs_optional(VALUE type, VALUE location);
-VALUE rbs_proc(VALUE function, VALUE block, VALUE location);
+VALUE rbs_proc(VALUE function, VALUE block, VALUE location, VALUE self_type);
 VALUE rbs_record(VALUE fields, VALUE location);
 VALUE rbs_tuple(VALUE types, VALUE location);
 VALUE rbs_type_name(VALUE namespace, VALUE name);

data/lib/rbs/ancestor_graph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class AncestorGraph
     InstanceNode = _ = Struct.new(:type_name, keyword_init: true)

data/lib/rbs/annotate/annotations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Annotate
     class Annotations

data/lib/rbs/annotate/formatter.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RBS
   module Annotate
     class Formatter
       attr_reader :buffer
 
       def initialize()
-        @buffer = ""
+        @buffer = +""
         @pending_separator = nil
       end
 
@@ -14,7 +16,7 @@ module RBS
             s = self.class.translate(s) or raise
           end
 
-          s.rstrip!
+          s = s.rstrip
 
           unless s.empty?
             if ss = @pending_separator

data/lib/rbs/annotate/rdoc_annotator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Annotate
     class RDocAnnotator

data/lib/rbs/annotate/rdoc_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Annotate
     class RDocSource

data/lib/rbs/annotate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rdoc"
 
 require "rbs/annotate/rdoc_annotator"

data/lib/rbs/ast/annotation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module AST
     class Annotation

data/lib/rbs/ast/comment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module AST
     class Comment

data/lib/rbs/ast/declarations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module AST
     module Declarations

data/lib/rbs/ast/members.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module AST
     module Members

data/lib/rbs/ast/type_param.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module AST
     class TypeParam
@@ -106,7 +108,7 @@ module RBS
       end
 
       def to_s
-        s = ""
+        s = +""
 
         if unchecked?
           s << "unchecked "

data/lib/rbs/buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class Buffer
     attr_reader :name

data/lib/rbs/builtin_names.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module BuiltinNames
     class Name

data/lib/rbs/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open3"
 require "optparse"
 require "shellwords"
@@ -74,6 +76,7 @@ module RBS
 
     attr_reader :stdout
     attr_reader :stderr
+    attr_reader :original_args
 
     def initialize(stdout:, stderr:)
       @stdout = stdout
@@ -100,6 +103,8 @@ module RBS
     end
 
     def run(args)
+      @original_args = args.dup
+
       options = LibraryOptions.new
 
       opts = OptionParser.new
@@ -667,6 +672,8 @@ EOU
       output_dir = nil
       # @type var base_dir: Pathname?
       base_dir = nil
+      # @type var force: bool
+      force = false
 
       opts = OptionParser.new
       opts.banner = <<EOU
@@ -696,6 +703,10 @@ EOU
         base_dir = Pathname(path)
       end
 
+      opts.on("--force", "Overwrite existing RBS files") do
+        force = true
+      end
+
       opts.parse!(args)
 
       unless has_parser?
@@ -722,6 +733,9 @@ EOU
       input_paths = args.map {|arg| Pathname(arg) }
 
       if output_dir
+        # @type var skip_paths: Array[Pathname]
+        skip_paths = []
+
         # batch mode
         input_paths.each do |path|
           stdout.puts "Processing `#{path}`..."
@@ -764,7 +778,17 @@ EOU
             parser = new_parser[]
             parser.parse file_path.read()
 
-            stdout.puts "  Writing RBS to `#{output_path}`..."
+            if output_path.file?
+              if force
+                stdout.puts "    - Writing RBS to existing file `#{output_path}`..."
+              else
+                stdout.puts "    - Skipping existing file `#{output_path}`..."
+                skip_paths << file_path
+                next
+              end
+            else
+              stdout.puts "    - Writing RBS to `#{output_path}`..."
+            end
 
             (output_path.parent).mkpath
             output_path.open("w") do |io|
@@ -773,6 +797,19 @@ EOU
             end
           end
         end
+
+        unless skip_paths.empty?
+          stdout.puts
+          stdout.puts ">>>> Skipped existing #{skip_paths.size} files. Use `--force` option to update the files."
+          command = original_args.take(original_args.size - input_paths.size)
+
+          skip_paths.take(10).each do |path|
+            stdout.puts "  #{defined?(Bundler) ? "bundle exec " : ""}rbs #{Shellwords.join(command)} --force #{Shellwords.escape(path.to_s)}"
+          end
+          if skip_paths.size > 10
+            stdout.puts "  ..."
+          end
+        end
       else
         # file mode
         parser = new_parser[]
@@ -975,7 +1012,7 @@ EOB
       env_hash = {
         'RUBYOPT' => "#{ENV['RUBYOPT']} -rrbs/test/setup",
         'RBS_TEST_OPT' => test_opt(options),
-        'RBS_TEST_LOGLEVEL' => RBS.logger_level,
+        'RBS_TEST_LOGLEVEL' => %w(DEBUG INFO WARN ERROR FATAL)[RBS.logger_level || 5] || "UNKNOWN",
         'RBS_TEST_SAMPLE_SIZE' => sample_size,
         'RBS_TEST_DOUBLE_SUITE' => double_suite,
         'RBS_TEST_UNCHECKED_CLASSES' => (unchecked_classes.join(',') unless unchecked_classes.empty?),

data/lib/rbs/collection/cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Collection
     class Cleaner

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Collection
 
@@ -37,6 +39,7 @@ module RBS
         end
 
         private def assign_gem(name:, version:)
+          # @type var locked: gem_entry?
           locked = lock&.gem(name)
           specified = config.gem(name)
 
@@ -51,6 +54,7 @@ module RBS
 
             installed_version = version
             best_version = find_best_version(version: installed_version, versions: source.versions({ 'name' => name }))
+
             locked = {
               'name' => name,
               'version' => best_version.to_s,
@@ -58,10 +62,11 @@ module RBS
             }
           end
 
+          locked or raise
+
           upsert_gem specified, locked
-          source = Sources.from_config_entry(locked['source'])
-          manifest = source.manifest_of(locked) or return
-          manifest['dependencies']&.each do |dep|
+          source = Sources.from_config_entry(locked['source'] || raise)
+          source.dependencies_of(locked)&.each do |dep|
             @gem_queue.push({ name: dep['name'], version: nil} )
           end
         end

data/lib/rbs/collection/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Collection
 

data/lib/rbs/collection/installer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   module Collection
     class Installer

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RBS
+  module Collection
+    module Sources
+      module Base
+        def dependencies_of(config_entry)
+          manifest = manifest_of(config_entry) or return
+          manifest['dependencies']
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha2'
 require 'open3'
 require 'find'
@@ -6,6 +8,7 @@ module RBS
   module Collection
     module Sources
       class Git
+        include Base
         METADATA_FILENAME = '.rbs_meta.yaml'
 
         class CommandError < StandardError; end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module RBS
@@ -5,6 +7,7 @@ module RBS
     module Sources
       # Signatures that are inclduded in gem package as sig/ directory.
       class Rubygems
+        include Base
         include Singleton
 
         def has?(config_entry)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module RBS
@@ -5,27 +7,30 @@ module RBS
     module Sources
       # signatures that are bundled in rbs gem under the stdlib/ directory
       class Stdlib
+        include Base
         include Singleton
 
+        REPO = Repository.default
+
         def has?(config_entry)
-          gem_dir(config_entry).exist?
+          lookup(config_entry)
         end
 
         def versions(config_entry)
-          gem_dir(config_entry).glob('*/').map { |path| path.basename.to_s }
+          REPO.gems[config_entry['name']].versions.keys.map(&:to_s)
         end
 
         def install(dest:, config_entry:, stdout:)
           # Do nothing because stdlib RBS is available by default
           name = config_entry['name']
           version = config_entry['version'] or raise
-          from = gem_dir(config_entry) / version
+          from = lookup(config_entry)
           stdout.puts "Using #{name}:#{version} (#{from})"
         end
 
         def manifest_of(config_entry)
-          version = config_entry['version'] or raise
-          manifest_path = gem_dir(config_entry).join(version, 'manifest.yaml')
+          config_entry['version'] or raise
+          manifest_path = (lookup(config_entry) or raise).join('manifest.yaml')
           YAML.safe_load(manifest_path.read) if manifest_path.exist?
         end
 
@@ -35,8 +40,8 @@ module RBS
           }
         end
 
-        private def gem_dir(config_entry)
-          Repository::DEFAULT_STDLIB_ROOT.join(config_entry['name'])
+        private def lookup(config_entry)
+          REPO.lookup(config_entry['name'], config_entry['version'])
         end
       end
     end

data/lib/rbs/collection/sources.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require_relative './sources/base'
 require_relative './sources/git'
 require_relative './sources/stdlib'
 require_relative './sources/rubygems'

data/lib/rbs/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'bundler'
 

data/lib/rbs/constant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class Constant
     attr_reader :name

data/lib/rbs/constant_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class ConstantTable
     attr_reader :definition_builder
@@ -56,9 +58,9 @@ module RBS
                         name_to_constant(TypeName.new(name: head, namespace: Namespace.root))
                       else
                         resolve_constant_reference_context(head, context: context) ||
-                          context.first.yield_self do |first_contet|
-                            raise unless first_contet
-                            resolve_constant_reference_inherit(head, scopes: constant_scopes(first_contet.to_type_name))
+                          context.first.yield_self do |first_context|
+                            raise unless first_context
+                            resolve_constant_reference_inherit(head, scopes: constant_scopes(first_context.to_type_name))
                           end
                       end
 

data/lib/rbs/definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class Definition
     class Variable
@@ -118,7 +120,7 @@ module RBS
       end
 
       def comments
-        @comments ||= _ = defs.map(&:comment).compact
+        @comments ||= defs.map(&:comment).compact.uniq
       end
 
       def annotations
@@ -172,6 +174,16 @@ module RBS
           alias_of: alias_of
         )
       end
+
+      def update(super_method: self.super_method, defs: self.defs, accessibility: self.accessibility, alias_of: self.alias_of, annotations: self.annotations)
+        self.class.new(
+          super_method: super_method,
+          defs: defs,
+          accessibility: accessibility,
+          alias_of: alias_of,
+          annotations: annotations
+        )
+      end
     end
 
     module Ancestor

data/lib/rbs/definition_builder/ancestor_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class DefinitionBuilder
     class AncestorBuilder

data/lib/rbs/definition_builder/method_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RBS
   class DefinitionBuilder
     class MethodBuilder