rbs 3.3.2 → 3.4.0.pre.1

data/stdlib/csv/0/csv.rbs

@@ -1,15 +1,6 @@
 # <!-- rdoc-file=lib/csv.rb -->
 # ## CSV
 #
-# ### In a Hurry?
-#
-# If you are familiar with CSV data and have a particular task in mind, you may
-# want to go directly to the:
-# *   [Recipes for CSV](doc/csv/recipes/recipes_rdoc.html).
-#
-#
-# Otherwise, read on here, about the API: classes, methods, and constants.
-#
 # ### CSV Data
 #
 # CSV (comma-separated values) data is a text representation of a table:
@@ -380,15 +371,6 @@
 # feature will be used as the line-ending translation can cause problems with
 # resetting the document position to where it was before the read ahead.
 #
-# ---
-#
-# Raises an exception if the given value is not String-convertible:
-#     row_sep = BasicObject.new
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.generate(ary, row_sep: row_sep)
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.parse(str, row_sep: row_sep)
-#
 # ###### Option `col_sep`
 #
 # Specifies the String field separator to be used for both parsing and
@@ -445,13 +427,6 @@
 #     # Raises ArgumentError (:col_sep must be 1 or more characters: "")
 #     CSV.parse("foo0\nbar1\nbaz2\n", col_sep: col_sep)
 #
-# Raises an exception if the given value is not String-convertible:
-#     col_sep = BasicObject.new
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.generate(line, col_sep: col_sep)
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.parse(str, col_sep: col_sep)
-#
 # ###### Option `quote_char`
 #
 # Specifies the character (String of length 1) used used to quote fields in both
@@ -832,13 +807,14 @@
 #
 # ###### Option `liberal_parsing`
 #
-# Specifies the boolean value that determines whether CSV will attempt to parse
-# input not conformant with RFC 4180, such as double quotes in unquoted fields.
+# Specifies the boolean or hash value that determines whether CSV will attempt
+# to parse input not conformant with RFC 4180, such as double quotes in unquoted
+# fields.
 #
 # Default value:
 #     CSV::DEFAULT_OPTIONS.fetch(:liberal_parsing) # => false
 #
-# For examples in this section:
+# For the next two examples:
 #     str = 'is,this "three, or four",fields'
 #
 # Without `liberal_parsing`:
@@ -849,6 +825,24 @@
 #     ary = CSV.parse_line(str, liberal_parsing: true)
 #     ary # => ["is", "this \"three", " or four\"", "fields"]
 #
+# Use the `backslash_quote` sub-option to parse values that use a backslash to
+# escape a double-quote character.  This causes the parser to treat `\"` as if
+# it were `""`.
+#
+# For the next two examples:
+#     str = 'Show,"Harry \"Handcuff\" Houdini, the one and only","Tampa Theater"'
+#
+# With `liberal_parsing`, but without the `backslash_quote` sub-option:
+#     # Incorrect interpretation of backslash; incorrectly interprets the quoted comma as a field separator.
+#     ary = CSV.parse_line(str, liberal_parsing: true)
+#     ary # => ["Show", "\"Harry \\\"Handcuff\\\" Houdini", " the one and only\"", "Tampa Theater"]
+#     puts ary[1] # => "Harry \"Handcuff\" Houdini
+#
+# With `liberal_parsing` and its `backslash_quote` sub-option:
+#     ary = CSV.parse_line(str, liberal_parsing: { backslash_quote: true })
+#     ary # => ["Show", "Harry \"Handcuff\" Houdini, the one and only", "Tampa Theater"]
+#     puts ary[1] # => Harry "Handcuff" Houdini, the one and only
+#
 # ###### Option `nil_value`
 #
 # Specifies the object that is to be substituted for each null (no-text) field.
@@ -988,15 +982,6 @@
 # feature will be used as the line-ending translation can cause problems with
 # resetting the document position to where it was before the read ahead.
 #
-# ---
-#
-# Raises an exception if the given value is not String-convertible:
-#     row_sep = BasicObject.new
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.generate(ary, row_sep: row_sep)
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.parse(str, row_sep: row_sep)
-#
 # ###### Option `col_sep`
 #
 # Specifies the String field separator to be used for both parsing and
@@ -1053,13 +1038,6 @@
 #     # Raises ArgumentError (:col_sep must be 1 or more characters: "")
 #     CSV.parse("foo0\nbar1\nbaz2\n", col_sep: col_sep)
 #
-# Raises an exception if the given value is not String-convertible:
-#     col_sep = BasicObject.new
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.generate(line, col_sep: col_sep)
-#     # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-#     CSV.parse(str, col_sep: col_sep)
-#
 # ###### Option `quote_char`
 #
 # Specifies the character (String of length 1) used used to quote fields in both
@@ -1124,7 +1102,7 @@
 #
 # With `write_headers`":
 #     CSV.open(file_path,'w',
-#         :write_headers=> true,
+#         :write_headers => true,
 #         :headers => ['Name','Value']
 #       ) do |csv|
 #         csv << ['foo', '0']
@@ -1192,14 +1170,6 @@
 #
 # See also [Write Converters](#class-CSV-label-Write+Converters)
 #
-# ---
-#
-# Raises an exception if the converter returns a value that is neither `nil` nor
-# String-convertible:
-#     bad_converter = proc {|field| BasicObject.new }
-#     # Raises NoMethodError (undefined method `is_a?' for #<BasicObject:>)
-#     CSV.generate_line(['a', 'b', 'c'], write_converters: bad_converter)#
-#
 # ###### Option `write_nil_value`
 #
 # Specifies the object that is to be substituted for each `nil`-valued field.
@@ -1737,8 +1707,8 @@ class CSV < Object
   #
   # Arguments:
   # *   Argument `path_or_io` must be a file path or an IO stream.
-  # *   Argument `mode`, if given, must be a File mode See [Open
-  #     Mode](https://ruby-doc.org/core/IO.html#method-c-new-label-Open+Mode).
+  # *   Argument `mode`, if given, must be a File mode. See [Access
+  #     Modes](rdoc-ref:File@Access+Modes).
   # *   Arguments `**options` must be keyword options. See [Options for
   #     Parsing](#class-CSV-label-Options+for+Parsing).
   # *   This method optionally accepts an additional `:encoding` option that you

data/stdlib/date/0/date.rbs

@@ -92,8 +92,6 @@ class Date
   #
   # See argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   #
-  # Date.civil is an alias for Date.new.
-  #
   # Related: Date.jd.
   #
   def initialize: (?Integer year, ?Integer month, ?Integer mday, ?Integer start) -> void
@@ -192,8 +190,6 @@ class Date
   #
   # See argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  # Date._rfc822 is an alias for Date._rfc2822.
-  #
   # Related: Date.rfc2822 (returns a Date object).
   #
   def self._rfc2822: (String str) -> Hash[Symbol, Integer | String]
@@ -230,8 +226,6 @@ class Date
   #
   # See argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  # Date._rfc822 is an alias for Date._rfc2822.
-  #
   # Related: Date.rfc2822 (returns a Date object).
   #
   def self._rfc822: (String str) -> Hash[Symbol, Integer | String]
@@ -335,8 +329,6 @@ class Date
   #     Date.gregorian_leap?(2000) # => true
   #     Date.gregorian_leap?(2001) # => false
   #
-  # Date.leap? is an alias for Date.gregorian_leap?.
-  #
   # Related: Date.julian_leap?.
   #
   def self.gregorian_leap?: (Integer year) -> bool
@@ -465,8 +457,6 @@ class Date
   #     Date.gregorian_leap?(2000) # => true
   #     Date.gregorian_leap?(2001) # => false
   #
-  # Date.leap? is an alias for Date.gregorian_leap?.
-  #
   # Related: Date.julian_leap?.
   #
   def self.leap?: (Integer year) -> bool
@@ -533,7 +523,7 @@ class Date
   #
   # Related: Date._parse (returns a hash).
   #
-  def self.parse: (String str, ?boolish complete, ?Integer start) -> Date
+  def self.parse: (?String str, ?boolish complete, ?Integer start) -> Date
 
   # <!--
   #   rdoc-file=ext/date/date_core.c
@@ -553,8 +543,6 @@ class Date
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
   #
-  # Date.rfc822 is an alias for Date.rfc2822.
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def self.rfc2822: (String str, ?Integer start) -> Date
@@ -598,8 +586,6 @@ class Date
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
   #
-  # Date.rfc822 is an alias for Date.rfc2822.
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def self.rfc822: (String str, ?Integer start) -> Date
@@ -656,8 +642,6 @@ class Date
   #
   # See argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   #
-  # Date.valid_date? is an alias for Date.valid_civil?.
-  #
   # Related: Date.jd, Date.new.
   #
   def self.valid_civil?: (Integer year, Integer month, Integer mday, ?Integer start) -> bool
@@ -693,8 +677,6 @@ class Date
   #
   # See argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   #
-  # Date.valid_date? is an alias for Date.valid_civil?.
-  #
   # Related: Date.jd, Date.new.
   #
   def self.valid_date?: (Integer year, Integer month, Integer mday, ?Integer start) -> bool
@@ -962,8 +944,6 @@ class Date
   #
   # See [asctime](https://linux.die.net/man/3/asctime).
   #
-  # Date#ctime is an alias for Date#asctime.
-  #
   def asctime: () -> String
 
   # <!-- rdoc-file=ext/date/date_core.c -->
@@ -975,8 +955,6 @@ class Date
   #
   # See [asctime](https://linux.die.net/man/3/asctime).
   #
-  # Date#ctime is an alias for Date#asctime.
-  #
   def ctime: () -> String
 
   # <!--
@@ -1016,8 +994,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).mday # => 3
   #
-  # Date#day is an alias for Date#mday.
-  #
   def day: () -> Integer
 
   # <!--
@@ -1131,8 +1107,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).iso8601 # => "2001-02-03"
   #
-  # Date#xmlschema is an alias for Date#iso8601.
-  #
   def iso8601: () -> String
 
   # <!--
@@ -1216,8 +1190,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).mday # => 3
   #
-  # Date#day is an alias for Date#mday.
-  #
   def mday: () -> Integer
 
   # <!--
@@ -1240,8 +1212,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).mon # => 2
   #
-  # Date#month is an alias for Date#mon.
-  #
   def mon: () -> Integer
 
   # <!--
@@ -1257,8 +1227,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).mon # => 2
   #
-  # Date#month is an alias for Date#mon.
-  #
   def month: () -> Integer
 
   # <!--
@@ -1286,8 +1254,6 @@ class Date
   #     d.to_s      # => "2001-02-03"
   #     d.next.to_s # => "2001-02-04"
   #
-  # Date#succ is an alias for Date#next.
-  #
   def next: () -> Date
 
   # <!--
@@ -1347,8 +1313,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).rfc2822 # => "Sat, 3 Feb 2001 00:00:00 +0000"
   #
-  # Date#rfc822 is an alias for Date#rfc2822.
-  #
   def rfc2822: () -> String
 
   # <!--
@@ -1377,8 +1341,6 @@ class Date
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
   #
-  # Date.rfc822 is an alias for Date.rfc2822.
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def rfc822: () -> String
@@ -1467,8 +1429,6 @@ class Date
   #     d.to_s      # => "2001-02-03"
   #     d.next.to_s # => "2001-02-04"
   #
-  # Date#succ is an alias for Date#next.
-  #
   def succ: () -> Date
 
   # <!--
@@ -1571,8 +1531,6 @@ class Date
   #
   #     Date.new(2001, 2, 3).iso8601 # => "2001-02-03"
   #
-  # Date#xmlschema is an alias for Date#iso8601.
-  #
   def xmlschema: () -> String
 
   # <!--

data/stdlib/date/0/date_time.rbs

@@ -468,8 +468,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6).min # => 5
   #
-  # Date#minute is an alias for Date#min.
-  #
   def min: () -> Integer
 
   # <!-- rdoc-file=ext/date/date_core.c -->
@@ -477,8 +475,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6).min # => 5
   #
-  # Date#minute is an alias for Date#min.
-  #
   def minute: () -> Integer
 
   # <!--
@@ -523,8 +519,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6).sec # => 6
   #
-  # Date#second is an alias for Date#sec.
-  #
   def sec: () -> Integer
 
   # <!--
@@ -536,8 +530,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6.5).sec_fraction # => (1/2)
   #
-  # Date#second_fraction is an alias for Date#sec_fraction.
-  #
   def sec_fraction: () -> Rational
 
   # <!-- rdoc-file=ext/date/date_core.c -->
@@ -545,8 +537,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6).sec # => 6
   #
-  # Date#second is an alias for Date#sec.
-  #
   def second: () -> Integer
 
   # <!-- rdoc-file=ext/date/date_core.c -->
@@ -555,8 +545,6 @@ class DateTime < Date
   #
   #     DateTime.new(2001, 2, 3, 4, 5, 6.5).sec_fraction # => (1/2)
   #
-  # Date#second_fraction is an alias for Date#sec_fraction.
-  #
   def second_fraction: () -> Rational
 
   # <!--
@@ -569,7 +557,7 @@ class DateTime < Date
   #     DateTime.now.strftime # => "2022-07-01T11:03:19-05:00"
   #
   # For other formats, see [Formats for Dates and
-  # Times](doc/strftime_formatting.rdoc).
+  # Times](rdoc-ref:strftime_formatting.rdoc):
   #
   def strftime: (?String format) -> String
 

data/stdlib/delegate/0/delegator.rbs

@@ -0,0 +1,186 @@
+# <!-- rdoc-file=lib/delegate.rb -->
+# This library provides three different ways to delegate method calls to an
+# object.  The easiest to use is SimpleDelegator.  Pass an object to the
+# constructor and all methods supported by the object will be delegated.  This
+# object can be changed later.
+#
+# Going a step further, the top level DelegateClass method allows you to easily
+# setup delegation through class inheritance.  This is considerably more
+# flexible and thus probably the most common use for this library.
+#
+# Finally, if you need full control over the delegation scheme, you can inherit
+# from the abstract class Delegator and customize as needed.  (If you find
+# yourself needing this control, have a look at Forwardable which is also in the
+# standard library.  It may suit your needs better.)
+#
+# SimpleDelegator's implementation serves as a nice example of the use of
+# Delegator:
+#
+#     require 'delegate'
+#
+#     class SimpleDelegator < Delegator
+#       def __getobj__
+#         @delegate_sd_obj # return object we are delegating to, required
+#       end
+#
+#       def __setobj__(obj)
+#         @delegate_sd_obj = obj # change delegation object,
+#                                # a feature we're providing
+#       end
+#     end
+#
+# ## Notes
+#
+# Be advised, RDoc will not detect delegated methods.
+#
+class Delegator < BasicObject
+  def self.const_missing: (Symbol n) -> untyped
+
+  def self.delegating_block: (Symbol mid) -> Proc
+
+  def self.public_api: () -> untyped
+
+  public
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - !()
+  # -->
+  # Delegates ! to the _*getobj*_
+  #
+  def !: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - !=(obj)
+  # -->
+  # Returns true if two objects are not considered of equal value.
+  #
+  def !=: (untyped obj) -> bool
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - ==(obj)
+  # -->
+  # Returns true if two objects are considered of equal value.
+  #
+  def ==: (untyped obj) -> bool
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __getobj__()
+  # -->
+  # This method must be overridden by subclasses and should return the object
+  # method calls are being delegated to.
+  #
+  def __getobj__: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __setobj__(obj)
+  # -->
+  # This method must be overridden by subclasses and change the object delegate to
+  # *obj*.
+  #
+  def __setobj__: (untyped obj) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - eql?(obj)
+  # -->
+  # Returns true if two objects are considered of equal value.
+  #
+  def eql?: (untyped obj) -> bool
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - freeze()
+  # -->
+  # :method: freeze Freeze both the object returned by _*getobj*_ and self.
+  #
+  def freeze: () -> self
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - marshal_dump()
+  # -->
+  # Serialization support for the object returned by _*getobj*_.
+  #
+  def marshal_dump: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - marshal_load(data)
+  # -->
+  # Reinitializes delegation from a serialized object.
+  #
+  def marshal_load: (untyped data) -> void
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - method_missing(m, *args, &block)
+  # -->
+  #
+  def method_missing: (Symbol m, *untyped args, **untyped) { (*untyped, **untyped) -> untyped } -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - methods(all=true)
+  # -->
+  # Returns the methods available to this delegate object as the union of this
+  # object's and _*getobj*_ methods.
+  #
+  def methods: (?boolish all) -> Array[Symbol]
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - protected_methods(all=true)
+  # -->
+  # Returns the methods available to this delegate object as the union of this
+  # object's and _*getobj*_ protected methods.
+  #
+  def protected_methods: (?boolish all) -> Array[Symbol]
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - public_methods(all=true)
+  # -->
+  # Returns the methods available to this delegate object as the union of this
+  # object's and _*getobj*_ public methods.
+  #
+  def public_methods: (?untyped all) -> Array[Symbol]
+
+  private
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - new(obj)
+  # -->
+  # Pass in the *obj* to delegate method calls to.  All methods supported by *obj*
+  # will be delegated to.
+  #
+  def initialize: (untyped obj) -> void
+
+  def initialize_clone: (self obj, ?freeze: bool?) -> self
+
+  def initialize_dup: (self obj) -> self
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - respond_to_missing?(m, include_private)
+  # -->
+  # Checks for a method provided by this the delegate object by forwarding the
+  # call through _*getobj*_.
+  #
+  def respond_to_missing?: (Symbol m, bool include_private) -> bool
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - target_respond_to?(target, m, include_private)
+  # -->
+  # Handle BasicObject instances
+  #
+  def target_respond_to?: (untyped target, Symbol m, bool include_private) -> bool
+
+  VERSION: String
+end

data/stdlib/delegate/0/kernel.rbs

@@ -0,0 +1,47 @@
+%a{annotate:rdoc:skip}
+class Object
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - DelegateClass(superclass, &block)
+  # -->
+  # The primary interface to this library.  Use to setup delegation when defining
+  # your class.
+  #
+  #     class MyClass < DelegateClass(ClassToDelegateTo) # Step 1
+  #       def initialize
+  #         super(obj_of_ClassToDelegateTo)              # Step 2
+  #       end
+  #     end
+  #
+  # or:
+  #
+  #     MyClass = DelegateClass(ClassToDelegateTo) do    # Step 1
+  #       def initialize
+  #         super(obj_of_ClassToDelegateTo)              # Step 2
+  #       end
+  #     end
+  #
+  # Here's a sample of use from Tempfile which is really a File object with a few
+  # special rules about storage location and when the File should be deleted.
+  # That makes for an almost textbook perfect example of how to use delegation.
+  #
+  #     class Tempfile < DelegateClass(File)
+  #       # constant and class member data initialization...
+  #
+  #       def initialize(basename, tmpdir=Dir::tmpdir)
+  #         # build up file path/name in var tmpname...
+  #
+  #         @tmpfile = File.open(tmpname, File::RDWR|File::CREAT|File::EXCL, 0600)
+  #
+  #         # ...
+  #
+  #         super(@tmpfile)
+  #
+  #         # below this point, all methods of File are supported...
+  #       end
+  #
+  #       # ...
+  #     end
+  #
+  def DelegateClass: (Class) -> Class
+end