rbs 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72915c0f663f0fafeda4cbabba1de64b1d1d0c09fe8296308cb66b57c20311f1
-  data.tar.gz: feb1ae7af7f99635e9a16ae86d39cdb0220672e52aa5a264cff31705d7f892cc
+  metadata.gz: b7f806cf8264c7ba086b2462e42604febb347b00cc657e642e39070e30825378
+  data.tar.gz: d3bcc382fb797715e27f811c0cd8b1876ef0d37a85599e169d9ce6f2a7bbbed3
 SHA512:
-  metadata.gz: 3f66fa2748f6b1e042498a3bf6a200968d80eca238251e85657f994ebd9a5d4716d162c15168fcebb02890f89c689877ed8d0eecdae0671fcf721220d68d1ded
-  data.tar.gz: a331220a1d7908ac0166b4fbb0e2b0d8c4ca6bb2a79437b9ecd44bd016f88e98dc16b01571e5829620b33d8ba5821b09c6d55c1f18512e5e76863067da509e60
+  metadata.gz: b84abd96145c319fde7b7f4a0a571d7c2c5ec0f959afd1bb3bdaaecb378b74153c235b45ab446e357812e0e29c14d2c4a993af0682c3c9799881720579b03d42
+  data.tar.gz: e2b41d9c74ccb0f19e553c955959cf0922bb72889e7f75dd7a40abe80f9d4773610c97a585969158d3130a289100d04b1cd533921165f3e84f67c6a84b89aa76

data/.github/workflows/ruby.yml

@@ -36,6 +36,8 @@ jobs:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v3
+    - name: Set working directory as safe
+      run: /usr/bin/git config --global --add safe.directory $(pwd)
     - name: Install dependencies
       run: |
         apt-get update

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 2.4.0 (2022-05-08)
+
+This is a minor release with some signature updates, `prototype rb` improvement, and test fixes.
+
+### Signature updates
+
+* did_you_mean ([\#980](https://github.com/ruby/rbs/pull/980))
+* Pattern-matching exceptions ([\#979](https://github.com/ruby/rbs/pull/979/files))
+* `Singleton::SingletonClassMethods` ([\#978](https://github.com/ruby/rbs/pull/978))
+
+#### rbs prototype
+
+* Omit unnecessary param name on keyword arg from `prototype rb` ([\#974](https://github.com/ruby/rbs/pull/974))
+
+### Miscellaneous
+
+* Fix git unsafe repository error on ci test ([\#985](https://github.com/ruby/rbs/pull/985))
+* Prefer `IO::Buffer.new` for mutable buffer tests ([\#989](https://github.com/ruby/rbs/pull/989))
+* Update steep ([\#990](https://github.com/ruby/rbs/pull/990))
+
 ## 2.3.2 (2022-04-06)
 
 ### Library changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (2.3.2)
+    rbs (2.4.0)
 
 PATH
   remote: test/assets/test-gem
@@ -27,12 +27,12 @@ GEM
       rainbow (>= 3.0, < 4.0)
       strong_json (>= 1.1, < 2.2)
     json (2.6.1)
-    json-schema (2.8.1)
-      addressable (>= 2.4)
+    json-schema (3.0.0)
+      addressable (>= 2.8)
     marcel (1.0.2)
     minitest (5.15.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     power_assert (2.0.1)
     prime (0.1.2)
@@ -40,14 +40,14 @@ GEM
       singleton
     psych (4.0.3)
       stringio
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    rake-compiler (1.1.9)
+    rake-compiler (1.2.0)
       rake
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.2.1)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -62,16 +62,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.26.1)
+    rubocop (1.28.2)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)

data/core/errors.rbs

@@ -299,6 +299,36 @@ class NameError[T] < StandardError
   def receiver: () -> T?
 end
 
+class NoMatchingPatternError < StandardError
+end
+
+class NoMatchingPatternKeyError[M, K] < NoMatchingPatternError
+  # <!--
+  #   rdoc-file=error.c
+  #   - NoMatchingPatternKeyError.new(message=nil, matchee: nil, key: nil) -> no_matching_pattern_key_error
+  # -->
+  # Construct a new `NoMatchingPatternKeyError` exception with the given message,
+  # matchee and key.
+  #
+  def initialize: (?string message, matchee: M, key: K) -> void
+
+  # <!--
+  #   rdoc-file=error.c
+  #   - no_matching_pattern_key_error.matchee  -> object
+  # -->
+  # Return the matchee associated with this NoMatchingPatternKeyError exception.
+  #
+  def matchee: () -> M
+
+  # <!--
+  #   rdoc-file=error.c
+  #   - no_matching_pattern_key_error.key  -> object
+  # -->
+  # Return the key caused this NoMatchingPatternKeyError exception.
+  #
+  def key: () -> K
+end
+
 # <!-- rdoc-file=error.c -->
 # Raised when memory allocation fails.
 #

data/lib/rbs/prototype/rb.rb

@@ -427,9 +427,9 @@ module RBS
 
           case value
           when nil, :NODE_SPECIAL_REQUIRED_KEYWORD
-            fun.required_keywords[name] = Types::Function::Param.new(name: name, type: untyped)
+            fun.required_keywords[name] = Types::Function::Param.new(name: nil, type: untyped)
           when RubyVM::AbstractSyntaxTree::Node
-            fun.optional_keywords[name] = Types::Function::Param.new(name: name, type: param_type(value))
+            fun.optional_keywords[name] = Types::Function::Param.new(name: nil, type: param_type(value))
           else
             raise "Unexpected keyword arg value: #{value}"
           end
@@ -444,23 +444,43 @@ module RBS
 
       def function_return_type_from_body(node)
         body = node.children[2]
-        return Types::Bases::Nil.new(location: nil) unless body
-
-        if body.type == :BLOCK
-          return_stmts = any_node?(body) do |n|
-            n.type == :RETURN
-          end&.map do |return_node|
-            returned_value = return_node.children[0]
-            returned_value ? literal_to_type(returned_value) : Types::Bases::Nil.new(location: nil)
-          end || []
-          last_node = body.children.last
-          last_evaluated =  last_node ? literal_to_type(last_node) : Types::Bases::Nil.new(location: nil)
-          types_to_union_type([*return_stmts, last_evaluated])
+        body_type(body)
+      end
+
+      def body_type(node)
+        return Types::Bases::Nil.new(location: nil) unless node
+
+        case node.type
+        when :IF, :UNLESS
+          if_unless_type(node)
+        when :BLOCK
+          block_type(node)
         else
-          literal_to_type(body)
+          literal_to_type(node)
         end
       end
 
+      def if_unless_type(node)
+        raise unless node.type == :IF || node.type == :UNLESS
+
+        _exp_node, true_node, false_node = node.children
+        types_to_union_type([body_type(true_node), body_type(false_node)])
+      end
+
+      def block_type(node)
+        raise unless node.type == :BLOCK
+
+        return_stmts = any_node?(node) do |n|
+          n.type == :RETURN
+        end&.map do |return_node|
+          returned_value = return_node.children[0]
+          returned_value ? literal_to_type(returned_value) : Types::Bases::Nil.new(location: nil)
+        end || []
+        last_node = node.children.last
+        last_evaluated =  last_node ? literal_to_type(last_node) : Types::Bases::Nil.new(location: nil)
+        types_to_union_type([*return_stmts, last_evaluated])
+      end
+
       def literal_to_type(node)
         case node.type
         when :STR

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "2.3.2"
+  VERSION = "2.4.0"
 end

data/sig/polyfill.rbs

@@ -8,12 +8,6 @@ module Gem
   end
 end
 
-module Enumerable[unchecked out Elem]
-  def flat_map: [U] () { (Elem) -> Array[U] } -> Array[U]
-              | [U] () { (Elem) -> U } -> Array[U]
-              | ...
-end
-
 module Bundler
   class LockfileParser
     def initialize: (String) -> void

data/stdlib/did_you_mean/0/did_you_mean.rbs

@@ -0,0 +1,348 @@
+# <!-- rdoc-file=lib/did_you_mean.rb -->
+# The `DidYouMean` gem adds functionality to suggest possible method/class names
+# upon errors such as `NameError` and `NoMethodError`. In Ruby 2.3 or later, it
+# is automatically activated during startup.
+#
+# @example
+#
+#     methosd
+#     # => NameError: undefined local variable or method `methosd' for main:Object
+#     #   Did you mean?  methods
+#     #                  method
+#
+#     OBject
+#     # => NameError: uninitialized constant OBject
+#     #    Did you mean?  Object
+#
+#     @full_name = "Yuki Nishijima"
+#     first_name, last_name = full_name.split(" ")
+#     # => NameError: undefined local variable or method `full_name' for main:Object
+#     #    Did you mean?  @full_name
+#
+#     @@full_name = "Yuki Nishijima"
+#     @@full_anme
+#     # => NameError: uninitialized class variable @@full_anme in Object
+#     #    Did you mean?  @@full_name
+#
+#     full_name = "Yuki Nishijima"
+#     full_name.starts_with?("Y")
+#     # => NoMethodError: undefined method `starts_with?' for "Yuki Nishijima":String
+#     #    Did you mean?  start_with?
+#
+#     hash = {foo: 1, bar: 2, baz: 3}
+#     hash.fetch(:fooo)
+#     # => KeyError: key not found: :fooo
+#     #    Did you mean?  :foo
+#
+# ## Disabling `did_you_mean`
+#
+# Occasionally, you may want to disable the `did_you_mean` gem for e.g.
+# debugging issues in the error object itself. You can disable it entirely by
+# specifying `--disable-did_you_mean` option to the `ruby` command:
+#
+#     $ ruby --disable-did_you_mean -e "1.zeor?"
+#     -e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
+#
+# When you do not have direct access to the `ruby` command (e.g. +rails
+# console+, `irb`), you could applyoptions using the `RUBYOPT` environment
+# variable:
+#
+#     $ RUBYOPT='--disable-did_you_mean' irb
+#     irb:0> 1.zeor?
+#     # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#
+# ## Getting the original error message
+#
+# Sometimes, you do not want to disable the gem entirely, but need to get the
+# original error message without suggestions (e.g. testing). In this case, you
+# could use the `#original_message` method on the error object:
+#
+#     no_method_error = begin
+#                         1.zeor?
+#                       rescue NoMethodError => error
+#                         error
+#                       end
+#
+#     no_method_error.message
+#     # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#     #    Did you mean?  zero?
+#
+#     no_method_error.original_message
+#     # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#
+module DidYouMean
+  # <!-- rdoc-file=lib/did_you_mean.rb -->
+  # TODO: Remove on 3.3:
+  #
+  SPELL_CHECKERS: untyped
+
+  NameErrorCheckers: Object
+
+  VERSION: String
+
+  class ClassNameChecker
+    class ClassName < ::String
+    end
+  end
+
+  module Correctable
+    SKIP_TO_S_FOR_SUPER_LOOKUP: true
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/core_ext/name_error.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[String]
+  end
+
+  # <!-- rdoc-file=lib/did_you_mean/formatter.rb -->
+  # The `DidYouMean::Formatter` is the basic, default formatter for the gem. The
+  # formatter responds to the `message_for` method and it returns a human readable
+  # string.
+  #
+  class Formatter
+    # <!--
+    #   rdoc-file=lib/did_you_mean/formatter.rb
+    #   - message_for(corrections)
+    # -->
+    # Returns a human readable string that contains `corrections`. This formatter is
+    # designed to be less verbose to not take too much screen space while being
+    # helpful enough to the user.
+    #
+    # @example
+    #
+    #     formatter = DidYouMean::Formatter.new
+    #
+    #     # displays suggestions in two lines with the leading empty line
+    #     puts formatter.message_for(["methods", "method"])
+    #
+    #     Did you mean?  methods
+    #                     method
+    #     # => nil
+    #
+    #     # displays an empty line
+    #     puts formatter.message_for([])
+    #
+    #     # => nil
+    #
+    def self.message_for: (Array[String] corrections) -> String
+  end
+
+  module JaroWinkler
+    WEIGHT: Float
+
+    THRESHOLD: Float
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/jaro_winkler.rb
+    #   - distance(str1, str2)
+    # -->
+    #
+    def self?.distance: (String, String) -> Integer
+  end
+
+  module Jaro
+    # <!--
+    #   rdoc-file=lib/did_you_mean/jaro_winkler.rb
+    #   - distance(str1, str2)
+    # -->
+    #
+    def self?.distance: (String, String) -> Integer
+  end
+
+  class KeyErrorChecker
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/key_error_checker.rb
+    #   - new(key_error)
+    # -->
+    #
+    def initialize: (KeyError[_ToS, Hash[_ToS, untyped]]) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/key_error_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[String]
+  end
+
+  module Levenshtein
+    def self?.distance: (String, String) -> Integer?
+  end
+
+  class MethodNameChecker
+    NAMES_TO_EXCLUDE: Hash[untyped, Array[Symbol]]
+
+    # <!-- rdoc-file=lib/did_you_mean/spell_checkers/method_name_checker.rb -->
+    # `MethodNameChecker::RB_RESERVED_WORDS` is the list of reserved words in Ruby
+    # that take an argument. Unlike `VariableNameChecker::RB_RESERVED_WORDS`, these
+    # reserved words require an argument, and a `NoMethodError` is raised due to the
+    # presence of the argument.
+    #
+    # The `MethodNameChecker` will use this list to suggest a reversed word if a
+    # `NoMethodError` is raised and found closest matches.
+    #
+    # Also see `VariableNameChecker::RB_RESERVED_WORDS`.
+    #
+    RB_RESERVED_WORDS: Array[Symbol]
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/method_name_checker.rb
+    #   - new(exception)
+    # -->
+    #
+    def initialize: (NoMethodError[untyped] exception) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/method_name_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[Symbol]
+  end
+
+  class NullChecker
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/null_checker.rb
+    #   - new(*)
+    # -->
+    #
+    def initialize: (*untyped) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/null_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[untyped]
+  end
+
+  class PatternKeyNameChecker
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/pattern_key_name_checker.rb
+    #   - new(no_matching_pattern_key_error)
+    # -->
+    #
+    def initialize: (untyped) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/pattern_key_name_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[String]
+  end
+
+  class RequirePathChecker
+    INITIAL_LOAD_PATH: Array[String]
+    ENV_SPECIFIC_EXT: String
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/require_path_checker.rb
+    #   - requireables()
+    # -->
+    #
+    def self.requireables: -> Array[String]
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/require_path_checker.rb
+    #   - new(exception)
+    # -->
+    #
+    def initialize: (untyped exception) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/require_path_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[String]
+  end
+
+  class SpellChecker
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checker.rb
+    #   - new(dictionary:)
+    # -->
+    #
+    def initialize: (dictionary: Array[String | Symbol]) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checker.rb
+    #   - correct(input)
+    # -->
+    #
+    def correct: (String | Symbol input) -> Array[String]
+  end
+
+  # <!-- rdoc-file=lib/did_you_mean/tree_spell_checker.rb -->
+  # spell checker for a dictionary that has a tree structure, see
+  # doc/tree_spell_checker_api.md
+  #
+  class TreeSpellChecker
+    # <!--
+    #   rdoc-file=lib/did_you_mean/tree_spell_checker.rb
+    #   - new(dictionary:, separator: '/', augment: nil)
+    # -->
+    #
+    def initialize: (dictionary: Array[String], ?separator: String, ?augment: bool?) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/tree_spell_checker.rb
+    #   - correct(input)
+    # -->
+    #
+    def correct: (String input) -> Array[String]
+  end
+
+  class VariableNameChecker
+    NAMES_TO_EXCLUDE: Hash[String, Array[Symbol]]
+
+    # <!-- rdoc-file=lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb -->
+    # `VariableNameChecker::RB_RESERVED_WORDS` is the list of all reserved words in
+    # Ruby. They could be declared like methods are, and a typo would cause Ruby to
+    # raise a `NameError` because of the way they are declared.
+    #
+    # The `:VariableNameChecker` will use this list to suggest a reversed word if a
+    # `NameError` is raised and found closest matches, excluding:
+    #
+    #     * +do+
+    #     * +if+
+    #     * +in+
+    #     * +or+
+    #
+    # Also see `MethodNameChecker::RB_RESERVED_WORDS`.
+    #
+    RB_RESERVED_WORDS: Array[Symbol]
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb
+    #   - new(exception)
+    # -->
+    #
+    def initialize: (NameError[untyped]) -> void
+
+    # <!--
+    #   rdoc-file=lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb
+    #   - corrections()
+    # -->
+    #
+    def corrections: () -> Array[Symbol]
+  end
+end
+
+%a{annotate:rdoc:skip}
+class NameError[T]
+  prepend DidYouMean::Correctable
+end
+
+%a{annotate:rdoc:skip}
+class KeyError[K, R]
+  prepend DidYouMean::Correctable
+end
+
+%a{annotate:rdoc:skip}
+class LoadError
+  prepend DidYouMean::Correctable
+end

data/stdlib/singleton/0/singleton.rbs

@@ -126,6 +126,9 @@ module Singleton
   # Raises a TypeError to prevent duping.
   #
   def dup: () -> bot
+
+  module SingletonClassMethods
+  end
 end
 
 Singleton::VERSION: String

data/steep/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,21 +17,21 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.15.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.3.1)
-    steep (0.52.0)
+    rbs (2.3.2)
+    steep (0.52.2)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.3.0)
+      rbs (>= 2.3.2)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-05-08 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -270,6 +270,7 @@ files:
 - stdlib/date/0/date.rbs
 - stdlib/date/0/date_time.rbs
 - stdlib/dbm/0/dbm.rbs
+- stdlib/did_you_mean/0/did_you_mean.rbs
 - stdlib/digest/0/digest.rbs
 - stdlib/erb/0/erb.rbs
 - stdlib/fiber/0/fiber.rbs