rbs-relaxed 3.9.0.1

data/stdlib/rdoc/0/rdoc.rbs

@@ -0,0 +1,391 @@
+# <!-- rdoc-file=lib/rdoc.rb -->
+# RDoc produces documentation for Ruby source files by parsing the source and
+# extracting the definition for classes, modules, methods, includes and
+# requires.  It associates these with optional documentation contained in an
+# immediately preceding comment block then renders the result using an output
+# formatter.
+#
+# For a simple introduction to writing or generating documentation using RDoc
+# see the README.
+#
+# ## Roadmap
+#
+# If you think you found a bug in RDoc see CONTRIBUTING@Bugs
+#
+# If you want to use RDoc to create documentation for your Ruby source files,
+# see RDoc::Markup and refer to `rdoc --help` for command line usage.
+#
+# If you want to set the default markup format see RDoc::Markup@Markup+Formats
+#
+# If you want to store rdoc configuration in your gem (such as the default
+# markup format) see RDoc::Options@Saved+Options
+#
+# If you want to write documentation for Ruby files see RDoc::Parser::Ruby
+#
+# If you want to write documentation for extensions written in C see
+# RDoc::Parser::C
+#
+# If you want to generate documentation using `rake` see RDoc::Task.
+#
+# If you want to drive RDoc programmatically, see RDoc::RDoc.
+#
+# If you want to use the library to format text blocks into HTML or other
+# formats, look at RDoc::Markup.
+#
+# If you want to make an RDoc plugin such as a generator or directive handler
+# see RDoc::RDoc.
+#
+# If you want to write your own output generator see RDoc::Generator.
+#
+# If you want an overview of how RDoc works see CONTRIBUTING
+#
+# ## Credits
+#
+# RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.
+#
+# Dave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.
+#
+# *   The Ruby parser in rdoc/parse.rb is based heavily on the outstanding work
+#     of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby parser
+#     for irb and the rtags package.
+#
+# <!-- rdoc-file=lib/rdoc/rubygems_hook.rb -->
+# This class is referenced by RubyGems to create documents. All implementations
+# are moved to the above RubyGemsHook.
+#
+# This class does nothing when this RDoc is installed as a normal gem or a
+# bundled gem.
+#
+# This class does generate/remove documents for compatibility when this RDoc is
+# installed as a default gem.
+#
+# We can remove this when all maintained RubyGems remove `rubygems/rdoc.rb`.
+#
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/token_stream.rb -->
+  # A TokenStream is a list of tokens, gathered during the parse of some entity
+  # (say a method). Entities populate these streams by being registered with the
+  # lexer. Any class can collect tokens by including TokenStream. From the
+  # outside, you use such an object by calling the start_collecting_tokens method,
+  # followed by calls to add_token and pop_token.
+  #
+  module TokenStream
+    # <!--
+    #   rdoc-file=lib/rdoc/token_stream.rb
+    #   - add_token(token)
+    # -->
+    # Adds one `token` to the collected tokens
+    #
+    def add_token: (Hash[untyped, untyped] token) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/token_stream.rb
+    #   - collect_tokens()
+    # -->
+    # Starts collecting tokens
+    #
+    def collect_tokens: () -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/token_stream.rb
+    #   - start_collecting_tokens()
+    # -->
+    #
+    alias start_collecting_tokens collect_tokens
+  end
+
+  # <!-- rdoc-file=lib/rdoc/class_module.rb -->
+  # ClassModule is the base class for objects representing either a class or a
+  # module.
+  #
+  class ClassModule < Context
+    # <!--
+    #   rdoc-file=lib/rdoc/class_module.rb
+    #   - new(name, superclass = nil)
+    # -->
+    # Creates a new ClassModule with `name` with optional `superclass`
+    #
+    # This is a constructor for subclasses, and must never be called directly.
+    #
+    def initialize: (String name, ?String superclass) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/class_module.rb
+    #   - add_comment(comment, location)
+    # -->
+    # Adds `comment` to this ClassModule's list of comments at `location`.  This
+    # method is preferred over #comment= since it allows ri data to be updated
+    # across multiple runs.
+    #
+    def add_comment: (RDoc::Comment comment, RDoc::Context location) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/normal_class.rb -->
+  # A normal class, neither singleton nor anonymous
+  #
+  class NormalClass < ClassModule
+    def initialize: (String name, ?String superclass) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/single_class.rb -->
+  # A singleton class
+  #
+  class SingleClass < ClassModule
+    def initialize: (String name, ?String superclass) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/normal_module.rb -->
+  # A normal module, like NormalClass
+  #
+  class NormalModule < ClassModule
+  end
+
+  # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+  # Abstract class representing either a method or an attribute.
+  #
+  class MethodAttr < CodeObject
+    include Comparable
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # The method/attribute we're aliasing
+    #
+    attr_reader is_alias_for: MethodAttr?
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # The call_seq or the param_seq with method name, if there is no call_seq.
+    #
+    attr_reader arglists: String
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # Name of this method/attribute.
+    #
+    attr_accessor name: String
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # public, protected, private
+    #
+    attr_accessor visibility: untyped
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # Is this a singleton method/attribute?
+    #
+    attr_accessor singleton: bool
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # Source file token stream
+    #
+    attr_reader text: String
+
+    # <!-- rdoc-file=lib/rdoc/method_attr.rb -->
+    # Different ways to call this method
+    #
+    attr_accessor call_seq: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/method_attr.rb
+    #   - new(text, name)
+    # -->
+    # Creates a new MethodAttr from token stream `text` and method or attribute name
+    # `name`.
+    #
+    # Usually this is called by super from a subclass.
+    #
+    def initialize: (String text, String name) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/method_attr.rb
+    #   - pretty_name()
+    # -->
+    # Method/attribute name with class/instance indicator
+    #
+    def pretty_name: () -> ::String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/method_attr.rb
+    #   - type()
+    # -->
+    # Type of method/attribute (class or instance)
+    #
+    def type: () -> ("class" | "instance")
+
+    # <!--
+    #   rdoc-file=lib/rdoc/method_attr.rb
+    #   - path()
+    # -->
+    # Path to this method for use with HTML generator output.
+    #
+    def path: () -> ::String
+
+    def to_s: () -> ::String
+  end
+
+  # <!-- rdoc-file=lib/rdoc/any_method.rb -->
+  # AnyMethod is the base class for objects representing methods
+  #
+  class AnyMethod < MethodAttr
+    include TokenStream
+
+    # <!--
+    #   rdoc-file=lib/rdoc/any_method.rb
+    #   - call_seq()
+    # -->
+    # Different ways to call this method
+    # ----
+    # <!--
+    #   rdoc-file=lib/rdoc/any_method.rb
+    #   - call_seq=(call_seq)
+    # -->
+    # Sets the different ways you can call this method.  If an empty `call_seq` is
+    # given nil is assumed.
+    #
+    # See also #param_seq
+    #
+    attr_accessor call_seq: ::String
+
+    # <!-- rdoc-file=lib/rdoc/any_method.rb -->
+    # Parameters for this method
+    #
+    attr_accessor params: ::String
+
+    attr_accessor line: Integer
+
+    # <!--
+    #   rdoc-file=lib/rdoc/any_method.rb
+    #   - arglists()
+    # -->
+    # The call_seq or the param_seq with method name, if there is no call_seq.
+    #
+    # Use this for displaying a method's argument lists.
+    #
+    def arglists: () -> String?
+
+    def callseq: () -> String?
+
+    # <!--
+    #   rdoc-file=lib/rdoc/any_method.rb
+    #   - new(text, name)
+    # -->
+    # Creates a new AnyMethod with a token stream `text` and `name`
+    #
+    def initialize: (String? text, String name) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/attr.rb -->
+  # An attribute created by #attr, #attr_reader, #attr_writer or #attr_accessor
+  #
+  class Attr < MethodAttr
+    # <!-- rdoc-file=lib/rdoc/attr.rb -->
+    # Is the attribute readable ('R'), writable ('W') or both ('RW')?
+    #
+    attr_accessor rw: "RW" | "R" | "W"
+
+    # <!--
+    #   rdoc-file=lib/rdoc/attr.rb
+    #   - new(text, name, rw, comment, singleton = false)
+    # -->
+    # Creates a new Attr with body `text`, `name`, read/write status `rw` and
+    # `comment`.  `singleton` marks this as a class attribute.
+    #
+    def initialize: (String? text, String name, String rw, RDoc::Comment? comment, ?bool `singleton`) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/constant.rb -->
+  # A constant
+  #
+  class Constant < CodeObject
+    # <!-- rdoc-file=lib/rdoc/constant.rb -->
+    # Sets the module or class this is constant is an alias for.
+    #
+    attr_writer is_alias_for: String
+
+    # <!-- rdoc-file=lib/rdoc/constant.rb -->
+    # The constant's name
+    #
+    attr_accessor name: String
+
+    # <!-- rdoc-file=lib/rdoc/constant.rb -->
+    # The constant's value
+    #
+    attr_accessor value: String
+
+    # <!-- rdoc-file=lib/rdoc/constant.rb -->
+    # The constant's visibility
+    #
+    attr_accessor visibility: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/constant.rb
+    #   - new(name, value, comment)
+    # -->
+    # Creates a new constant with `name`, `value` and `comment`
+    #
+    def initialize: (String name, String value, RDoc::Comment? comment) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/mixin.rb -->
+  # A Mixin adds features from a module into another context.  RDoc::Include and
+  # RDoc::Extend are both mixins.
+  #
+  class Mixin < CodeObject
+    # <!-- rdoc-file=lib/rdoc/mixin.rb -->
+    # Name of included module
+    #
+    attr_accessor name: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/mixin.rb
+    #   - new(name, comment)
+    # -->
+    # Creates a new Mixin for `name` with `comment`
+    #
+    def initialize: (String name, RDoc::Comment? comment) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/include.rb -->
+  # A Module included in a class with #include
+  #
+  #     RDoc::Include.new 'Enumerable', 'comment ...'
+  #
+  class Include < Mixin
+  end
+
+  # <!-- rdoc-file=lib/rdoc/extend.rb -->
+  # A Module extension to a class with #extend
+  #
+  #     RDoc::Extend.new 'Enumerable', 'comment ...'
+  #
+  class Extend < Mixin
+  end
+
+  # <!-- rdoc-file=lib/rdoc/alias.rb -->
+  # Represent an alias, which is an old_name/new_name pair associated with a
+  # particular context
+  #
+  class Alias < CodeObject
+    # <!-- rdoc-file=lib/rdoc/alias.rb -->
+    # Aliased method's name
+    #
+    attr_accessor name: String
+
+    # <!-- rdoc-file=lib/rdoc/alias.rb -->
+    # Aliasee method's name
+    #
+    attr_accessor old_name: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/alias.rb
+    #   - new(text, old_name, new_name, comment, singleton = false)
+    # -->
+    # Creates a new Alias with a token stream of `text` that aliases `old_name` to
+    # `new_name`, has `comment` and is a `singleton` context.
+    #
+    def initialize: (String? text, String name, String old_name, RDoc::Comment? comment, ?bool `singleton`) -> void
+  end
+
+  # <!-- rdoc-file=lib/rdoc/stats.rb -->
+  # RDoc statistics collector which prints a summary and report of a project's
+  # documentation totals.
+  #
+  class Stats
+  end
+end

data/stdlib/rdoc/0/ri.rbs

@@ -0,0 +1,17 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/ri.rb -->
+  # Namespace for the ri command line tool's implementation.
+  #
+  # See `ri --help` for details.
+  #
+  module RI
+    module Paths
+      type path_type = :system | :site | :home | :gem | :extra
+
+      type gem_filter = :latest | :all
+
+      def self.each: (?bool system, ?bool site, ?bool home, ?gem_filter | false gems, *String extra_dirs) { (String, path_type) -> void } -> void
+    end
+  end
+end

data/stdlib/rdoc/0/store.rbs

@@ -0,0 +1,48 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/store.rb -->
+  # A set of rdoc data for a single project (gem, path, etc.).
+  #
+  # The store manages reading and writing ri data for a project and maintains a
+  # cache of methods, classes and ancestors in the store.
+  #
+  # The store maintains a #cache of its contents for faster lookup.  After adding
+  # items to the store it must be flushed using #save_cache.  The cache contains
+  # the following structures:
+  #
+  #     @cache = {
+  #       :ancestors        => {}, # class name => ancestor names
+  #       :attributes       => {}, # class name => attributes
+  #       :class_methods    => {}, # class name => class methods
+  #       :instance_methods => {}, # class name => instance methods
+  #       :modules          => [], # classes and modules in this store
+  #       :pages            => [], # page names
+  #     }
+  #
+  class Store
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - new(path = nil, type = nil)
+    # -->
+    # Creates a new Store of `type` that will load or save to `path`
+    #
+    def initialize: (?String? path, ?Symbol? type) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - find_class_or_module(name)
+    # -->
+    # Finds the class or module with `name`
+    #
+    def find_class_or_module: (String) -> ClassModule?
+
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - load_all()
+    # -->
+    # Loads all items from this store into memory.  This recreates a documentation
+    # tree for use by a generator
+    #
+    def load_all: () -> void
+  end
+end

data/stdlib/rdoc/0/top_level.rbs

@@ -0,0 +1,97 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/top_level.rb -->
+  # A TopLevel context is a representation of the contents of a single file
+  #
+  class TopLevel < Context
+    MARSHAL_VERSION: 0
+
+    # <!-- rdoc-file=lib/rdoc/top_level.rb -->
+    # Relative name of this file
+    #
+    attr_accessor relative_name: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - new(absolute_name, relative_name = absolute_name)
+    # -->
+    # Creates a new TopLevel for the file at `absolute_name`.  If documentation is
+    # being generated outside the source dir `relative_name` is relative to the
+    # source directory.
+    #
+    def initialize: (String absolute_name, ?String relative_name) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - ==(other)
+    # -->
+    # An RDoc::TopLevel is equal to another with the same relative_name
+    #
+    def ==: (untyped other) -> bool
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - eql?(other)
+    # -->
+    #
+    alias eql? ==
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_alias(an_alias)
+    # -->
+    # Adds `an_alias` to `Object` instead of `self`.
+    #
+    def add_alias: (RDoc::Alias an_alias) -> RDoc::Alias
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_constant(constant)
+    # -->
+    # Adds `constant` to `Object` instead of `self`.
+    #
+    def add_constant: (RDoc::Constant constant) -> RDoc::Constant
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_include(include)
+    # -->
+    # Adds `include` to `Object` instead of `self`.
+    #
+    def add_include: (RDoc::Include `include`) -> RDoc::Include
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_method(method)
+    # -->
+    # Adds `method` to `Object` instead of `self`.
+    #
+    def add_method: (RDoc::AnyMethod method) -> RDoc::AnyMethod
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - find_class_or_module(name)
+    # -->
+    # See RDoc::TopLevel::find_class_or_module
+    #
+    def find_class_or_module: (::String name) -> RDoc::Context
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - find_module_named(name)
+    # -->
+    # Finds a module or class with `name`
+    #
+    def find_module_named: (String name) -> RDoc::Context
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - full_name()
+    # -->
+    # Returns the relative name of this file
+    #
+    def full_name: () -> String
+
+    def to_s: () -> ::String
+  end
+end

data/stdlib/resolv/0/manifest.yaml

@@ -0,0 +1,3 @@
+dependencies:
+  - name: socket
+  - name: timeout