rbs 3.3.2 → 3.4.0

data/stdlib/delegate/0/simple_delegator.rbs

@@ -0,0 +1,98 @@
+# <!-- rdoc-file=lib/delegate.rb -->
+# A concrete implementation of Delegator, this class provides the means to
+# delegate all supported method calls to the object passed into the constructor
+# and even to change the object being delegated to at a later time with
+# #__setobj__.
+#
+#     class User
+#       def born_on
+#         Date.new(1989, 9, 10)
+#       end
+#     end
+#
+#     require 'delegate'
+#
+#     class UserDecorator < SimpleDelegator
+#       def birth_year
+#         born_on.year
+#       end
+#     end
+#
+#     decorated_user = UserDecorator.new(User.new)
+#     decorated_user.birth_year  #=> 1989
+#     decorated_user.__getobj__  #=> #<User: ...>
+#
+# A SimpleDelegator instance can take advantage of the fact that SimpleDelegator
+# is a subclass of `Delegator` to call `super` to have methods called on the
+# object being delegated to.
+#
+#     class SuperArray < SimpleDelegator
+#       def [](*args)
+#         super + 1
+#       end
+#     end
+#
+#     SuperArray.new([1])[0]  #=> 2
+#
+# Here's a simple example that takes advantage of the fact that
+# SimpleDelegator's delegation object can be changed at any time.
+#
+#     class Stats
+#       def initialize
+#         @source = SimpleDelegator.new([])
+#       end
+#
+#       def stats(records)
+#         @source.__setobj__(records)
+#
+#         "Elements:  #{@source.size}\n" +
+#         " Non-Nil:  #{@source.compact.size}\n" +
+#         "  Unique:  #{@source.uniq.size}\n"
+#       end
+#     end
+#
+#     s = Stats.new
+#     puts s.stats(%w{James Edward Gray II})
+#     puts
+#     puts s.stats([1, 2, 3, nil, 4, 5, 1, 2])
+#
+# Prints:
+#
+#     Elements:  4
+#      Non-Nil:  4
+#       Unique:  4
+#
+#     Elements:  8
+#      Non-Nil:  7
+#       Unique:  6
+#
+class SimpleDelegator < Delegator
+  public
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __getobj__() { || ... }
+  # -->
+  # Returns the current object method calls are being delegated to.
+  #
+  def __getobj__: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __setobj__(obj)
+  # -->
+  # Changes the delegate object to *obj*.
+  #
+  # It's important to note that this does **not** cause SimpleDelegator's methods
+  # to change.  Because of this, you probably only want to change delegation to
+  # objects of the same type as the original delegate.
+  #
+  # Here's an example of changing the delegation object.
+  #
+  #     names = SimpleDelegator.new(%w{James Edward Gray II})
+  #     puts names[1]    # => Edward
+  #     names.__setobj__(%w{Gavin Sinclair})
+  #     puts names[1]    # => Sinclair
+  #
+  def __setobj__: (untyped obj) -> untyped
+end

data/stdlib/did_you_mean/0/did_you_mean.rbs

@@ -72,7 +72,7 @@
 #
 module DidYouMean
   # <!-- rdoc-file=lib/did_you_mean.rb -->
-  # TODO: Remove on 3.3:
+  # TODO: Remove on the 3.4 development start:
   #
   SPELL_CHECKERS: untyped
 

data/stdlib/erb/0/erb.rbs

@@ -286,11 +286,11 @@ class ERB
   #       def build
   #         b = binding
   #         # create and run templates, filling member data variables
-  #         ERB.new(<<-'END_PRODUCT'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@product").result b
+  #         ERB.new(<<~'END_PRODUCT', trim_mode: "", eoutvar: "@product").result b
   #           <%= PRODUCT[:name] %>
   #           <%= PRODUCT[:desc] %>
   #         END_PRODUCT
-  #         ERB.new(<<-'END_PRICE'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@price").result b
+  #         ERB.new(<<~'END_PRICE', trim_mode: "", eoutvar: "@price").result b
   #           <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
   #           <%= PRODUCT[:desc] %>
   #         END_PRICE

data/stdlib/fileutils/0/fileutils.rbs

@@ -238,8 +238,6 @@ module FileUtils
   #         cd fileutils
   #
   #
-  # FileUtils.chdir is an alias for FileUtils.cd.
-  #
   # Related: FileUtils.pwd.
   #
   def self?.cd: (path dir, ?verbose: boolish) -> void
@@ -652,8 +650,6 @@ module FileUtils
   #
   # Raises an exception if `src` is a directory.
   #
-  # FileUtils.copy is an alias for FileUtils.cp.
-  #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
   def self?.cp: (pathlist src, path dest, ?preserve: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1066,8 +1062,6 @@ module FileUtils
   # Raises an exception if `dest` is the path to an existing file and keyword
   # argument `force` is not `true`.
   #
-  # FileUtils#link is an alias for FileUtils#ln.
-  #
   # Related: FileUtils.link_entry (has different options).
   #
   def self?.ln: (pathlist src, path dest, ?force: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1157,8 +1151,6 @@ module FileUtils
   #         ln -s srcdir3/src0.txt srcdir3/src1.txt destdir3
   #
   #
-  # FileUtils.symlink is an alias for FileUtils.ln_s.
-  #
   # Related: FileUtils.ln_sf.
   #
   def self?.ln_s: (pathlist src, path dest, ?force: boolish, ?relative: boolish, ?target_directory: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1368,9 +1360,6 @@ module FileUtils
   #         mv src0 dest0
   #         mv src1.txt src1 dest1
   #
-  #
-  # FileUtils.move is an alias for FileUtils.mv.
-  #
   def self?.mv: (pathlist src, path dest, ?force: boolish, ?noop: boolish, ?verbose: boolish, ?secure: boolish) -> void
 
   # <!--
@@ -1417,8 +1406,6 @@ module FileUtils
   #
   #     FileUtils.pwd # => "/rdoc/fileutils"
   #
-  # FileUtils.getwd is an alias for FileUtils.pwd.
-  #
   # Related: FileUtils.cd.
   #
   def self?.pwd: () -> String
@@ -1538,8 +1525,6 @@ module FileUtils
   #         rm src0.dat src0.txt
   #
   #
-  # FileUtils.remove is an alias for FileUtils.rm.
-  #
   # Related: [methods for deleting](rdoc-ref:FileUtils@Deleting).
   #
   def self?.rm: (pathlist list, ?force: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1571,8 +1556,6 @@ module FileUtils
   #
   # See FileUtils.rm for keyword arguments.
   #
-  # FileUtils.safe_unlink is an alias for FileUtils.rm_f.
-  #
   # Related: [methods for deleting](rdoc-ref:FileUtils@Deleting).
   #
   def self?.rm_f: (pathlist list, ?noop: boolish, ?verbose: boolish) -> void
@@ -1664,8 +1647,6 @@ module FileUtils
   #
   # See FileUtils.rm_r for keyword arguments.
   #
-  # FileUtils.rmtree is an alias for FileUtils.rm_rf.
-  #
   # Related: [methods for deleting](rdoc-ref:FileUtils@Deleting).
   #
   def self?.rm_rf: (pathlist list, ?noop: boolish, ?verbose: boolish, ?secure: boolish) -> void

data/stdlib/io-console/0/io-console.rbs

@@ -106,8 +106,14 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor()
+  #   - io.cursor -> [row, column]
   # -->
+  # Returns the current cursor position as a two-element array of integers (row,
+  # column)
+  #
+  #     io.cursor # => [3, 5]
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor: () -> [ Integer, Integer ]
 
@@ -205,6 +211,11 @@ class IO
   #
   # You must require 'io/console' to use this method.
   #
+  #     require 'io/console'
+  #     IO::console.getpass("Enter password:")
+  #     Enter password:
+  #     # => "mypassword"
+  #
   def getpass: (?String) -> String
 
   # <!--

data/stdlib/ipaddr/0/ipaddr.rbs

@@ -295,7 +295,8 @@ class IPAddr
   # Returns true if the ipaddr is a private address.  IPv4 addresses in
   # 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16 as defined in RFC 1918 and IPv6
   # Unique Local Addresses in fc00::/7 as defined in RFC 4193 are considered
-  # private.
+  # private. Private IPv4 addresses in the IPv4-mapped IPv6 address range are also
+  # considered private.
   #
   def private?: () -> bool