rbs 2.8.4 → 3.8.1

data/stdlib/net-protocol/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: timeout

data/stdlib/net-protocol/0/net-protocol.rbs

@@ -0,0 +1,56 @@
+module Net
+  class Protocol
+    VERSION: String
+  end
+
+  class ProtocolError < StandardError
+  end
+
+  class ProtoSyntaxError < ProtocolError
+  end
+
+  class ProtoFatalError < ProtocolError
+  end
+
+  class ProtoUnknownError < ProtocolError
+  end
+
+  class ProtoServerError < ProtocolError
+  end
+
+  class ProtoAuthError < ProtocolError
+  end
+
+  class ProtoCommandError < ProtocolError
+  end
+
+  class ProtoRetriableError < ProtocolError
+  end
+
+  class HTTPBadResponse < StandardError
+  end
+
+  class HTTPHeaderSyntaxError < StandardError
+  end
+
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # OpenTimeout, a subclass of Timeout::Error, is raised if a connection cannot be
+  # created within the open_timeout.
+  #
+  class OpenTimeout < Timeout::Error
+  end
+
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # ReadTimeout, a subclass of Timeout::Error, is raised if a chunk of the
+  # response cannot be read within the read_timeout.
+  #
+  class ReadTimeout < Timeout::Error
+  end
+
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # WriteTimeout, a subclass of Timeout::Error, is raised if a chunk of the
+  # response cannot be written within the write_timeout.  Not raised on Windows.
+  #
+  class WriteTimeout < Timeout::Error
+  end
+end

data/stdlib/net-smtp/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: net-protocol

data/stdlib/net-smtp/0/net-smtp.rbs

@@ -0,0 +1,55 @@
+module Net
+  # Module mixed in to all SMTP error classes
+  module SMTPError
+    attr_reader response: Response
+
+    def initialize: (Response response, ?message: String) -> void
+
+    def message: () -> String?
+  end
+
+  # Represents an SMTP authentication error.
+  class SMTPAuthenticationError < ProtoAuthError
+    include SMTPError
+  end
+
+  # Represents SMTP error code 4xx, a temporary error.
+  class SMTPServerBusy < ProtoServerError
+    include SMTPError
+  end
+
+  # Represents an SMTP command syntax error (error code 500)
+  class SMTPSyntaxError < ProtoSyntaxError
+    include SMTPError
+  end
+
+  # Represents a fatal SMTP error (error code 5xx, except for 500)
+  class SMTPFatalError < ProtoFatalError
+    include SMTPError
+  end
+
+  # Unexpected reply code returned from server.
+  class SMTPUnknownError < ProtoUnknownError
+    include SMTPError
+  end
+
+  # Command is not supported on server.
+  class SMTPUnsupportedCommand < ProtocolError
+    include SMTPError
+  end
+
+  class SMTP < Protocol
+    def self.start: (String address, ?Integer port, ?tls_verify: bool, ?tls_hostname: String?, ?helo: String, ?user: String?, ?password: String?, ?auth_type: Symbol) -> instance
+                  | [T] (String address, ?Integer port, ?tls_verify: bool, ?tls_hostname: String?, ?helo: String, ?user: String?, ?password: String?, ?auth_type: Symbol) { (instance) -> T } -> T
+                  | (String address, ?Integer port, ?String helo, ?String? user, ?String? password, ?Symbol auth_type) -> instance
+                  | [T] (String address, ?Integer port, ?String helo, ?String? user, ?String? password, ?Symbol auth_type) { (instance) -> T } -> T
+
+    def initialize: (String address, ?Integer port) -> void
+    def send_message: (_Each[String] mail_src, String from_addr, *String to_addrs) -> void
+  end
+
+  class Response
+  end
+
+  class SMTPSession = SMTP
+end

data/stdlib/nkf/0/nkf.rbs

@@ -66,14 +66,16 @@
 #
 # {de/en}crypt ROT13/47
 #
-# ### -[h](123) --hiragana --katakana --katakana-hiragana
+# ### -h[123] --hiragana --katakana --katakana-hiragana
 #
 # -h1 --hiragana
 # :   Katakana to Hiragana conversion.
 #
+#
 # -h2 --katakana
 # :   Hiragana to Katakana conversion.
 #
+#
 # -h3 --katakana-hiragana
 # :   Katakana to Hiragana and Hiragana to Katakana conversion.
 #
@@ -95,19 +97,22 @@
 #
 # New line preserving line folding.
 #
-# ### -[Z](0-3)
+# ### -Z[0-3]
 #
 # Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.
 #
 # -Z -Z0
 # :   Convert X0208 alphabet to ASCII.
 #
+#
 # -Z1
 # :   Converts X0208 kankaku to single ASCII space.
 #
+#
 # -Z2
 # :   Converts X0208 kankaku to double ASCII spaces.
 #
+#
 # -Z3
 # :   Replacing Fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as
 #     in HTML.
@@ -120,7 +125,7 @@
 # convert X0201 kana to X0208. In JIS output, ESC-(-I is used. In EUC output,
 # SSO is used.
 #
-# ### -[B](0-2)
+# ### -B[0-2]
 #
 # Assume broken JIS-Kanji input, which lost ESC. Useful when your site is using
 # old B-News Nihongo patch.
@@ -128,6 +133,7 @@
 # -B1
 # :   allows any char after ESC-( or ESC-$.
 #
+#
 # -B2
 # :   forces ASCII after NL.
 #
@@ -141,7 +147,7 @@
 #
 # Delete r in line feed, Add r in line feed.
 #
-# ### -[m](BQN0)
+# ### -m[BQN0]
 #
 # MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT) To see ISO8859-1 (Latin-1) -l is
 # necessary.
@@ -154,6 +160,7 @@
 # -mQ
 # :   Decode MIME quoted stream. '_' in quoted stream is converted to space.
 #
+#
 # -mN
 # :   Non-strict decoding.
 #
@@ -172,6 +179,7 @@
 # -MB
 # :   MIME encode Base64 stream.
 #
+#
 # -MQ
 # :   Perform quoted encoding.
 #
@@ -181,16 +189,18 @@
 # Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP. **-s**, **-e**
 # and **-x** are not compatible with this option.
 #
-# ### -[L](uwm)
+# ### -L[uwm]
 #
 # new line mode Without this option, nkf doesn't convert line breaks.
 #
 # -Lu
 # :   unix (LF)
 #
+#
 # -Lw
 # :   windows (CRLF)
 #
+#
 # -Lm
 # :   mac (CR)
 #
@@ -215,63 +225,83 @@
 # ISO-2022-JP
 # :   a.k.a. RFC1468, 7bit JIS, JUNET
 #
+#
 # EUC-JP (eucJP-nkf)
 # :   a.k.a. AT&T JIS, Japanese EUC, UJIS
 #
+#
 # eucJP-ascii
 # :   a.k.a. x-eucjp-open-19970715-ascii
 #
+#
 # eucJP-ms
 # :   a.k.a. x-eucjp-open-19970715-ms
 #
+#
 # CP51932
 # :   Microsoft Version of EUC-JP.
 #
+#
 # Shift_JIS
 # :   SJIS, MS-Kanji
 #
+#
 # Windows-31J
 # :   a.k.a. CP932
 #
+#
 # UTF-8
 # :   same as UTF-8N
 #
+#
 # UTF-8N
 # :   UTF-8 without BOM
 #
+#
 # UTF-8-BOM
 # :   UTF-8 with BOM
 #
+#
 # UTF-16
 # :   same as UTF-16BE
 #
+#
 # UTF-16BE
 # :   UTF-16 Big Endian without BOM
 #
+#
 # UTF-16BE-BOM
 # :   UTF-16 Big Endian with BOM
 #
+#
 # UTF-16LE
 # :   UTF-16 Little Endian without BOM
 #
+#
 # UTF-16LE-BOM
 # :   UTF-16 Little Endian with BOM
 #
+#
 # UTF-32
 # :   same as UTF-32BE
 #
+#
 # UTF-32BE
 # :   UTF-32 Big Endian without BOM
 #
+#
 # UTF-32BE-BOM
 # :   UTF-32 Big Endian with BOM
 #
+#
 # UTF-32LE
 # :   UTF-32 Little Endian without BOM
 #
+#
 # UTF-32LE-BOM
 # :   UTF-32 Little Endian with BOM
 #
+#
 # UTF8-MAC
 # :   NKDed UTF-8, a.k.a. UTF8-NFD (input only)
 #

data/stdlib/objspace/0/objspace.rbs

@@ -4,9 +4,9 @@
 #
 # You need to `require 'objspace'` to use this extension module.
 #
-# Generally, you *SHOULD NOT* use this library if you do not know about the MRI
-# implementation.  Mainly, this library is for (memory) profiler developers and
-# MRI developers who need to know about MRI memory usage.
+# Generally, you **SHOULD** **NOT** use this library if you do not know about
+# the MRI implementation.  Mainly, this library is for (memory) profiler
+# developers and MRI developers who need to know about MRI memory usage.
 #
 %a{annotate:rdoc:source:from=ext/objspace}
 module ObjectSpace
@@ -233,12 +233,19 @@ module ObjectSpace
 
   # <!--
   #   rdoc-file=ext/objspace/lib/objspace.rb
-  #   - ObjectSpace.dump(obj[, output: :string]) # => "{ ... }"
-  #   - ObjectSpace.dump(obj, output: :file)     # => #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
-  #   - ObjectSpace.dump(obj, output: :stdout)   # => nil
+  #   - dump(obj, output: :string)
   # -->
   # Dump the contents of a ruby object as JSON.
   #
+  # *output* can be one of: `:stdout`, `:file`, `:string`, or IO object.
+  #
+  # *   `:file` means dumping to a tempfile and returning corresponding File
+  #     object;
+  # *   `:stdout` means printing the dump and returning `nil`;
+  # *   `:string` means returning a string with the dump;
+  # *   if an instance of IO object is provided, the output goes there, and the
+  #     object is returned.
+  #
   # This method is only expected to work with C Ruby. This is an experimental
   # method and is subject to change. In particular, the function signature and
   # output format are not guaranteed to be compatible in future versions of ruby.
@@ -247,27 +254,42 @@ module ObjectSpace
 
   # <!--
   #   rdoc-file=ext/objspace/lib/objspace.rb
-  #   - ObjectSpace.dump_all([output: :file]) # => #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
-  #   - ObjectSpace.dump_all(output: :stdout) # => nil
-  #   - ObjectSpace.dump_all(output: :string) # => "{...}\n{...}\n..."
-  #   - ObjectSpace.dump_all(output:
-  #   - File.open('heap.json','w'))         # => #<File:heap.json>
-  #   - ObjectSpace.dump_all(output: :string,
-  #   - since: 42)                          # => "{...}\n{...}\n..."
+  #   - dump_all(output: :file, full: false, since: nil, shapes: true)
   # -->
   # Dump the contents of the ruby heap as JSON.
   #
+  # *output* argument is the same as for #dump.
+  #
+  # *full* must be a boolean. If true, all heap slots are dumped including the
+  # empty ones (`T_NONE`).
+  #
   # *since* must be a non-negative integer or `nil`.
   #
   # If *since* is a positive integer, only objects of that generation and newer
   # generations are dumped. The current generation can be accessed using
-  # GC::count.
-  #
-  # Objects that were allocated without object allocation tracing enabled are
-  # ignored. See ::trace_object_allocations for more information and examples.
+  # GC::count. Objects that were allocated without object allocation tracing
+  # enabled are ignored. See ::trace_object_allocations for more information and
+  # examples.
   #
   # If *since* is omitted or is `nil`, all objects are dumped.
   #
+  # *shapes* must be a boolean or a non-negative integer.
+  #
+  # If *shapes* is a positive integer, only shapes newer than the provided shape
+  # id are dumped. The current shape_id can be accessed using
+  # `RubyVM.stat(:next_shape_id)`.
+  #
+  # If *shapes* is `false`, no shapes are dumped.
+  #
+  # To only dump objects allocated past a certain point you can combine *since*
+  # and *shapes*:
+  #     ObjectSpace.trace_object_allocations
+  #     GC.start
+  #     gc_generation = GC.count
+  #     shape_generation = RubyVM.stat(:next_shape_id)
+  #     call_method_to_instrument
+  #     ObjectSpace.dump_all(since: gc_generation, shapes: shape_generation)
+  #
   # This method is only expected to work with C Ruby. This is an experimental
   # method and is subject to change. In particular, the function signature and
   # output format are not guaranteed to be compatible in future versions of ruby.
@@ -372,7 +394,7 @@ module ObjectSpace
   #
   # With this method, you can find memory leaks.
   #
-  # This method is only expected to work except with C Ruby.
+  # This method is only expected to work with C Ruby.
   #
   # Example:
   #     ObjectSpace.reachable_objects_from(['a', 'b', 'c'])

data/stdlib/observable/0/observable.rbs

@@ -0,0 +1,217 @@
+# <!-- rdoc-file=lib/observer.rb -->
+# The Observer pattern (also known as publish/subscribe) provides a simple
+# mechanism for one object to inform a set of interested third-party objects
+# when its state changes.
+#
+# ## Mechanism
+#
+# The notifying class mixes in the `Observable` module, which provides the
+# methods for managing the associated observer objects.
+#
+# The observable object must:
+# *   assert that it has `#changed`
+# *   call `#notify_observers`
+#
+# An observer subscribes to updates using Observable#add_observer, which also
+# specifies the method called via #notify_observers. The default method for
+# #notify_observers is #update.
+#
+# ### Example
+#
+# The following example demonstrates this nicely.  A `Ticker`, when run,
+# continually receives the stock `Price` for its `@symbol`.  A `Warner` is a
+# general observer of the price, and two warners are demonstrated, a `WarnLow`
+# and a `WarnHigh`, which print a warning if the price is below or above their
+# set limits, respectively.
+#
+# The `update` callback allows the warners to run without being explicitly
+# called.  The system is set up with the `Ticker` and several observers, and the
+# observers do their duty without the top-level code having to interfere.
+#
+# Note that the contract between publisher and subscriber (observable and
+# observer) is not declared or enforced.  The `Ticker` publishes a time and a
+# price, and the warners receive that.  But if you don't ensure that your
+# contracts are correct, nothing else can warn you.
+#
+#     require "observer"
+#
+#     class Ticker          ### Periodically fetch a stock price.
+#       include Observable
+#
+#       def initialize(symbol)
+#         @symbol = symbol
+#       end
+#
+#       def run
+#         last_price = nil
+#         loop do
+#           price = Price.fetch(@symbol)
+#           print "Current price: #{price}\n"
+#           if price != last_price
+#             changed                 # notify observers
+#             last_price = price
+#             notify_observers(Time.now, price)
+#           end
+#           sleep 1
+#         end
+#       end
+#     end
+#
+#     class Price           ### A mock class to fetch a stock price (60 - 140).
+#       def self.fetch(symbol)
+#         60 + rand(80)
+#       end
+#     end
+#
+#     class Warner          ### An abstract observer of Ticker objects.
+#       def initialize(ticker, limit)
+#         @limit = limit
+#         ticker.add_observer(self)
+#       end
+#     end
+#
+#     class WarnLow < Warner
+#       def update(time, price)       # callback for observer
+#         if price < @limit
+#           print "--- #{time.to_s}: Price below #@limit: #{price}\n"
+#         end
+#       end
+#     end
+#
+#     class WarnHigh < Warner
+#       def update(time, price)       # callback for observer
+#         if price > @limit
+#           print "+++ #{time.to_s}: Price above #@limit: #{price}\n"
+#         end
+#       end
+#     end
+#
+#     ticker = Ticker.new("MSFT")
+#     WarnLow.new(ticker, 80)
+#     WarnHigh.new(ticker, 120)
+#     ticker.run
+#
+# Produces:
+#
+#     Current price: 83
+#     Current price: 75
+#     --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 75
+#     Current price: 90
+#     Current price: 134
+#     +++ Sun Jun 09 00:10:25 CDT 2002: Price above 120: 134
+#     Current price: 134
+#     Current price: 112
+#     Current price: 79
+#     --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 79
+#
+# ### Usage with procs
+#
+# The `#notify_observers` method can also be used with +proc+s by using the
+# `:call` as `func` parameter.
+#
+# The following example illustrates the use of a lambda:
+#
+#     require 'observer'
+#
+#     class Ticker
+#       include Observable
+#
+#       def run
+#         # logic to retrieve the price (here 77.0)
+#         changed
+#         notify_observers(77.0)
+#       end
+#     end
+#
+#     ticker = Ticker.new
+#     warner = ->(price) { puts "New price received: #{price}" }
+#     ticker.add_observer(warner, :call)
+#     ticker.run
+#
+module Observable
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - add_observer(observer, func=:update)
+  # -->
+  # Add `observer` as an observer on this object. So that it will receive
+  # notifications.
+  #
+  # `observer`
+  # :   the object that will be notified of changes.
+  #
+  # `func`
+  # :   Symbol naming the method that will be called when this Observable has
+  #     changes.
+  #
+  #     This method must return true for `observer.respond_to?` and will receive
+  #     `*arg` when #notify_observers is called, where `*arg` is the value passed
+  #     to #notify_observers by this Observable
+  #
+  def add_observer: (untyped observer, ?Symbol func) -> void
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - changed(state=true)
+  # -->
+  # Set the changed state of this object.  Notifications will be sent only if the
+  # changed `state` is `true`.
+  #
+  # `state`
+  # :   Boolean indicating the changed state of this Observable.
+  #
+  def changed: (?bool state) -> void
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - changed?()
+  # -->
+  # Returns true if this object's state has been changed since the last
+  # #notify_observers call.
+  #
+  def changed?: () -> bool
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - count_observers()
+  # -->
+  # Return the number of observers associated with this object.
+  #
+  def count_observers: () -> Integer
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - delete_observer(observer)
+  # -->
+  # Remove `observer` as an observer on this object so that it will no longer
+  # receive notifications.
+  #
+  # `observer`
+  # :   An observer of this Observable
+  #
+  def delete_observer: (untyped observer) -> void
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - delete_observers()
+  # -->
+  # Remove all observers associated with this object.
+  #
+  def delete_observers: () -> void
+
+  # <!--
+  #   rdoc-file=lib/observer.rb
+  #   - notify_observers(*arg)
+  # -->
+  # Notify observers of a change in state **if** this object's changed state is
+  # `true`.
+  #
+  # This will invoke the method named in #add_observer, passing `*arg`. The
+  # changed state is then set to `false`.
+  #
+  # `*arg`
+  # :   Any arguments to pass to the observers.
+  #
+  def notify_observers: (*untyped arg) -> void
+
+  VERSION: String
+end

data/stdlib/open-uri/0/manifest.yaml

@@ -0,0 +1,4 @@
+dependencies:
+  - name: tempfile
+  - name: uri
+  - name: stringio