rbs 2.0.0 → 2.1.0

data/stdlib/rubygems/0/basic_specification.rbs

@@ -1,3 +1,6 @@
+# <!-- rdoc-file=lib/rubygems/basic_specification.rb -->
+# BasicSpecification is an abstract class which implements some common code used
+# by both Specification and StubSpecification.
+#
 class Gem::BasicSpecification
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/config_file.rbs

@@ -1,3 +1,35 @@
+# <!-- rdoc-file=lib/rubygems/config_file.rb -->
+# Gem::ConfigFile RubyGems options and gem command options from gemrc.
+#
+# gemrc is a YAML file that uses strings to match gem command arguments and
+# symbols to match RubyGems options.
+#
+# Gem command arguments use a String key that matches the command name and allow
+# you to specify default arguments:
+#
+#     install: --no-rdoc --no-ri
+#     update: --no-rdoc --no-ri
+#
+# You can use `gem:` to set default arguments for all commands.
+#
+# RubyGems options use symbol keys.  Valid options are:
+#
+# `:backtrace`
+# :   See #backtrace
+# `:sources`
+# :   Sets Gem::sources
+# `:verbose`
+# :   See #verbose
+# `:concurrent_downloads`
+# :   See #concurrent_downloads
+#
+#
+# gemrc files may exist in various locations and are read and merged in the
+# following order:
+#
+# *   system wide (/etc/gemrc)
+# *   per user (~/.gemrc)
+# *   per environment (gemrc files listed in the GEMRC environment variable)
+#
 class Gem::ConfigFile
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/dependency_installer.rbs

@@ -1,5 +1,6 @@
+# <!-- rdoc-file=lib/rubygems/dependency_installer.rb -->
+# Installs a gem along with all its dependencies from local and remote gems.
+#
 class Gem::DependencyInstaller
-  type options = Hash[Symbol, untyped] # TODO: Add options...
-
-  # TODO: Add sinatures...
+  type options = Hash[Symbol, untyped]
 end

data/stdlib/rubygems/0/installer.rbs

@@ -1,3 +1,15 @@
+# <!-- rdoc-file=lib/rubygems/installer.rb -->
+# The installer installs the files contained in the .gem into the Gem.home.
+#
+# Gem::Installer does the work of putting files in all the right places on the
+# filesystem including unpacking the gem into its gem dir, installing the
+# gemspec in the specifications dir, storing the cached gem in the cache dir,
+# and installing either wrappers or symlinks for executables.
+#
+# The installer invokes pre and post install hooks.  Hooks can be added either
+# through a rubygems_plugin.rb file in an installed gem or via a
+# rubygems/defaults/#{RUBY_ENGINE}.rb or rubygems/defaults/operating_system.rb
+# file.  See Gem.pre_install and Gem.post_install for details.
+#
 class Gem::Installer
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/path_support.rbs

@@ -1,3 +1,6 @@
+# <!-- rdoc-file=lib/rubygems/path_support.rb -->
+# Gem::PathSupport facilitates the GEM_HOME and GEM_PATH environment settings to
+# the rest of RubyGems.
+#
 class Gem::PathSupport
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/platform.rbs

@@ -1,3 +1,7 @@
+# <!-- rdoc-file=lib/rubygems/platform.rb -->
+# Available list of platforms for targeting Gem installations.
+#
+# See `gem help platform` for information on platform matching.
+#
 class Gem::Platform
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/request_set.rbs

@@ -1,7 +1,49 @@
+# <!-- rdoc-file=lib/rubygems/request_set.rb -->
+# A RequestSet groups a request to activate a set of dependencies.
+#
+#     nokogiri = Gem::Dependency.new 'nokogiri', '~> 1.6'
+#     pg = Gem::Dependency.new 'pg', '~> 0.14'
+#
+#     set = Gem::RequestSet.new nokogiri, pg
+#
+#     requests = set.resolve
+#
+#     p requests.map { |r| r.full_name }
+#     #=> ["nokogiri-1.6.0", "mini_portile-0.5.1", "pg-0.17.0"]
+#
 class Gem::RequestSet
-  # TODO: Add sinatures...
 end
 
+# <!-- rdoc-file=lib/rubygems/request_set/gem_dependency_api.rb -->
+# A semi-compatible DSL for the Bundler Gemfile and Isolate gem dependencies
+# files.
+#
+# To work with both the Bundler Gemfile and Isolate formats this implementation
+# takes some liberties to allow compatibility with each, most notably in
+# #source.
+#
+# A basic gem dependencies file will look like the following:
+#
+#     source 'https://rubygems.org'
+#
+#     gem 'rails', '3.2.14a
+#     gem 'devise', '~> 2.1', '>= 2.1.3'
+#     gem 'cancan'
+#     gem 'airbrake'
+#     gem 'pg'
+#
+# RubyGems recommends saving this as gem.deps.rb over Gemfile or Isolate.
+#
+# To install the gems in this Gemfile use `gem install -g` to install it and
+# create a lockfile.  The lockfile will ensure that when you make changes to
+# your gem dependencies file a minimum amount of change is made to the
+# dependencies of your gems.
+#
+# RubyGems can activate all the gems in your dependencies file at startup using
+# the RUBYGEMS_GEMDEPS environment variable or through Gem.use_gemdeps. See
+# Gem.use_gemdeps for details and warnings.
+#
+# See `gem help install` and `gem help gem_dependencies` for further details.
+#
 class Gem::RequestSet::GemDependencyAPI
-  # TODO: Add sinatures...
 end

data/stdlib/rubygems/0/requirement.rbs

@@ -1,4 +1,6 @@
+%a{annotate:rdoc:skip}
 module Gem
+  # <!-- rdoc-file=lib/rubygems/requirement.rb -->
   # A Requirement is a set of one or more version restrictions. It supports a few
   # (`=, !=, >, <, >=, <=, ~>`) different restriction operators.
   #
@@ -8,34 +10,56 @@ module Gem
   class Requirement
     type operator = "=" | "!=" | ">" | "<" | ">=" | "<=" | "~>"
 
+    # <!-- rdoc-file=lib/rubygems/requirement.rb -->
     # Raised when a bad requirement is encountered
     #
     class BadRequirementError < ArgumentError
     end
 
+    # <!-- rdoc-file=lib/rubygems/requirement.rb -->
     # The default requirement matches any version
     #
     DefaultPrereleaseRequirement: [ operator, Gem::Version ]
 
+    # <!-- rdoc-file=lib/rubygems/requirement.rb -->
     # The default requirement matches any non-prerelease version
     #
     DefaultRequirement: [ operator, Gem::Version ]
 
+    # <!-- rdoc-file=lib/rubygems/requirement.rb -->
     # A regular expression that matches a requirement
     #
     PATTERN: Regexp
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - create(*inputs)
+    # -->
     # Factory method to create a Gem::Requirement object.  Input may be a Version, a
     # String, or nil.  Intended to simplify client code.
     #
     # If the input is "weird", the default version requirement is returned.
     #
-    def self.create: (*(String | Gem::Version | Gem::Requirement | nil) inputs) -> instance
+    def self.create: (*String | Gem::Version | Gem::Requirement | nil inputs) -> instance
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - default()
+    # -->
+    #
     def self.default: () -> instance
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - default_prerelease()
+    # -->
+    #
     def self.default_prerelease: () -> instance
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - parse(obj)
+    # -->
     # Parse `obj`, returning an `[op, version]` pair. `obj` can be a String or a
     # Gem::Version.
     #
@@ -48,36 +72,75 @@ module Gem
     #
     def self.parse: (String | Gem::Version obj) -> [ operator, Gem::Version ]
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - new(*requirements)
+    # -->
     # Constructs a requirement from `requirements`. Requirements can be Strings,
     # Gem::Versions, or Arrays of those. `nil` and duplicate requirements are
     # ignored. An empty set of `requirements` is the same as `">= 0"`.
     #
-    def initialize: (*(String | Gem::Version) requirements) -> void
+    def initialize: (*String | Gem::Version requirements) -> void
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - concat(new)
+    # -->
     # Concatenates the `new` requirements onto this requirement.
     #
     def concat: (Array[String | Gem::Version] new) -> void
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - exact?()
+    # -->
     # true if the requirement is for only an exact version
     #
     def exact?: () -> bool
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - none?()
+    # -->
     # true if this gem has no requirements.
     #
     def none?: () -> bool
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - prerelease?()
+    # -->
     # A requirement is a prerelease if any of the versions inside of it are
     # prereleases
     #
     def prerelease?: () -> bool
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - satisfied_by?(version)
+    # -->
     # True if `version` satisfies this Requirement.
     #
     def satisfied_by?: (Gem::Version version) -> bool
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - ===(version)
+    # -->
+    #
     alias === satisfied_by?
+
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - =~(version)
+    # -->
+    #
     alias =~ satisfied_by?
 
+    # <!--
+    #   rdoc-file=lib/rubygems/requirement.rb
+    #   - specific?()
+    # -->
     # True if the requirement will not always match the latest version.
     #
     def specific?: () -> bool