rbs 2.0.0 → 2.1.0

data/stdlib/yaml/0/store.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/yaml/store.rb -->
 # YAML::Store provides the same functionality as PStore, except it uses YAML to
 # dump objects instead of Marshal.
 #
@@ -30,6 +31,11 @@
 #       hello: world
 #
 class YAML::Store < ::PStore
+  # <!--
+  #   rdoc-file=lib/yaml/store.rb
+  #   - initialize( file_name, yaml_opts = {} )
+  #   - initialize( file_name, thread_safe = false, yaml_opts = {} )
+  # -->
   # Creates a new YAML::Store object, which will store data in `file_name`. If the
   # file does not already exist, it will be created.
   #

data/stdlib/zlib/0/zlib.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # This module provides access to the [zlib library](http://zlib.net). Zlib is
 # designed to be a portable, free, general-purpose, legally unencumbered -- that
 # is, not covered by any patents -- lossless data-compression library for use on
@@ -54,6 +55,7 @@
 #     *   Zlib::MemError
 #     *   Zlib::BufError
 #     *   Zlib::VersionError
+#     *   Zlib::InProgressError
 #
 #
 #
@@ -66,12 +68,16 @@
 #     *   Zlib::GzipFile::CRCError
 #     *   Zlib::GzipFile::NoFooter
 #
-#
-#
 module Zlib
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.adler32(string, adler)
+  # -->
   # Calculates Adler-32 checksum for `string`, and returns updated value of
   # `adler`. If `string` is omitted, it returns the Adler-32 initial value. If
-  # `adler` is omitted, it assumes that the initial value is given to `adler`.
+  # `adler` is omitted, it assumes that the initial value is given to `adler`. If
+  # `string` is an IO instance, reads from the IO until the IO returns nil and
+  # returns Adler-32 of all read data.
   #
   # Example usage:
   #
@@ -85,15 +91,25 @@ module Zlib
                   | (String) -> Integer
                   | (String, Integer) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.adler32_combine(adler1, adler2, len2)
+  # -->
   # Combine two Adler-32 check values in to one.  `alder1` is the first Adler-32
   # value, `adler2` is the second Adler-32 value.  `len2` is the length of the
   # string used to generate `adler2`.
   #
   def self.adler32_combine: (Integer, Integer, Integer) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.crc32(string, crc)
+  # -->
   # Calculates CRC checksum for `string`, and returns updated value of `crc`. If
   # `string` is omitted, it returns the CRC initial value. If `crc` is omitted, it
-  # assumes that the initial value is given to `crc`.
+  # assumes that the initial value is given to `crc`. If `string` is an IO
+  # instance, reads from the IO until the IO returns nil and returns CRC checksum
+  # of all read data.
   #
   # FIXME: expression.
   #
@@ -101,16 +117,29 @@ module Zlib
                 | (String) -> Integer
                 | (String, Integer) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.crc32_combine(crc1, crc2, len2)
+  # -->
   # Combine two CRC-32 check values in to one.  `crc1` is the first CRC-32 value,
   # `crc2` is the second CRC-32 value.  `len2` is the length of the string used to
   # generate `crc2`.
   #
   def self.crc32_combine: (Integer, Integer, Integer) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - crc_table()
+  # -->
   # Returns the table for calculating CRC checksum as an array.
   #
   def self.crc_table: () -> Array[Integer]
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.deflate(string[, level])
+  #   - Zlib::Deflate.deflate(string[, level])
+  # -->
   # Compresses the given `string`. Valid values of level are Zlib::NO_COMPRESSION,
   # Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION, or an
   # integer from 0 to 9.
@@ -128,6 +157,11 @@ module Zlib
   #
   def self.deflate: (String) -> String
                   | (String, Integer) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.gunzip(src) -> String
+  # -->
   # Decode the given gzipped `string`.
   #
   # This method is almost equivalent to the following code:
@@ -144,6 +178,10 @@ module Zlib
   #
   def self.gunzip: (String) -> String
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.gzip(src, level: nil, strategy: nil) -> String
+  # -->
   # Gzip the given `string`. Valid values of level are Zlib::NO_COMPRESSION,
   # Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION (default),
   # or an integer from 0 to 9.
@@ -165,6 +203,12 @@ module Zlib
                | (String, level: Integer) -> String
                | (String, strategy: Integer) -> String
                | (String, level: Integer, strategy: Integer) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.inflate(string)
+  #   - Zlib::Inflate.inflate(string)
+  # -->
   # Decompresses `string`. Raises a Zlib::NeedDict exception if a preset
   # dictionary is needed for decompression.
   #
@@ -182,11 +226,16 @@ module Zlib
   #
   def self.inflate: (String) -> String
 
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - zlib_version()
+  # -->
   # Returns the string which represents the version of zlib library.
   #
   def self.zlib_version: () -> String
 end
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Represents text data as guessed by deflate.
 #
 # NOTE: The underlying constant Z_ASCII was deprecated in favor of Z_TEXT in
@@ -194,39 +243,41 @@ end
 #
 # See Zlib::Deflate#data_type.
 #
-#
 Zlib::ASCII: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Slowest compression level, but with the best space savings.
 #
-#
 Zlib::BEST_COMPRESSION: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Fastest compression level, but with the lowest space savings.
 #
-#
 Zlib::BEST_SPEED: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Represents binary data as guessed by deflate.
 #
 # See Zlib::Deflate#data_type.
 #
-#
 Zlib::BINARY: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Default compression level which is a good trade-off between space and time
 #
 Zlib::DEFAULT_COMPRESSION: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Default deflate strategy which is used for normal data.
 #
-#
 Zlib::DEFAULT_STRATEGY: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The default memory level for allocating zlib deflate compression state.
 #
 Zlib::DEF_MEM_LEVEL: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Deflate strategy for data produced by a filter (or predictor). The effect of
 # FILTERED is to force more Huffman codes and less string matching; it is
 # somewhat intermediate between DEFAULT_STRATEGY and HUFFMAN_ONLY. Filtered data
@@ -234,16 +285,18 @@ Zlib::DEF_MEM_LEVEL: Integer
 #
 Zlib::FILTERED: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Processes all pending input and flushes pending output.
 #
-#
 Zlib::FINISH: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Deflate strategy which prevents the use of dynamic Huffman codes, allowing for
 # a simpler decoder for specialized applications.
 #
 Zlib::FIXED: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Flushes all output as with SYNC_FLUSH, and the compression state is reset so
 # that decompression can restart from this point if previous compressed data has
 # been damaged or if random access is desired. Like SYNC_FLUSH, using FULL_FLUSH
@@ -251,115 +304,121 @@ Zlib::FIXED: Integer
 #
 Zlib::FULL_FLUSH: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Deflate strategy which uses Huffman codes only (no string matching).
 #
-#
 Zlib::HUFFMAN_ONLY: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The maximum memory level for allocating zlib deflate compression state.
 #
 Zlib::MAX_MEM_LEVEL: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The maximum size of the zlib history buffer.  Note that zlib allows larger
 # values to enable different inflate modes.  See Zlib::Inflate.new for details.
 #
 Zlib::MAX_WBITS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # No compression, passes through data untouched.  Use this for appending
 # pre-compressed data to a deflate stream.
 #
 Zlib::NO_COMPRESSION: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # NO_FLUSH is the default flush method and allows deflate to decide how much
 # data to accumulate before producing output in order to maximize compression.
 #
 Zlib::NO_FLUSH: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for Amiga hosts
 #
-#
 Zlib::OS_AMIGA: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for Atari hosts
 #
-#
 Zlib::OS_ATARI: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The OS code of current host
 #
-#
 Zlib::OS_CODE: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for CP/M hosts
 #
-#
 Zlib::OS_CPM: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for Mac OS hosts
 #
-#
 Zlib::OS_MACOS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for MSDOS hosts
 #
-#
 Zlib::OS_MSDOS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for OS2 hosts
 #
-#
 Zlib::OS_OS2: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for QDOS hosts
 #
-#
 Zlib::OS_QDOS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for RISC OS hosts
 #
-#
 Zlib::OS_RISCOS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for TOPS-20 hosts
 #
-#
 Zlib::OS_TOPS20: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for UNIX hosts
 #
-#
 Zlib::OS_UNIX: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for unknown hosts
 #
-#
 Zlib::OS_UNKNOWN: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for VM OS hosts
 #
-#
 Zlib::OS_VMCMS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for VMS hosts
 #
-#
 Zlib::OS_VMS: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for Win32 hosts
 #
-#
 Zlib::OS_WIN32: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # OS code for Z-System hosts
 #
-#
 Zlib::OS_ZSYSTEM: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Deflate compression strategy designed to be almost as fast as HUFFMAN_ONLY,
 # but give better compression for PNG image data.
 #
 Zlib::RLE: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The SYNC_FLUSH method flushes all pending output to the output buffer and the
 # output is aligned on a byte boundary. Flushing may degrade compression so it
 # should be used only when necessary, such as at a request or response boundary
@@ -367,26 +426,26 @@ Zlib::RLE: Integer
 #
 Zlib::SYNC_FLUSH: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Represents text data as guessed by deflate.
 #
 # See Zlib::Deflate#data_type.
 #
-#
 Zlib::TEXT: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # Represents an unknown data type as guessed by deflate.
 #
 # See Zlib::Deflate#data_type.
 #
-#
 Zlib::UNKNOWN: Integer
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The Ruby/zlib version string.
 #
-#
 Zlib::VERSION: String
 
+# <!-- rdoc-file=ext/zlib/zlib.c -->
 # The string which represents the version of zlib.h
 #
-#
 Zlib::ZLIB_VERSION: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -59,6 +59,7 @@ files:
 - core/hash.rbs
 - core/integer.rbs
 - core/io.rbs
+- core/io/buffer.rbs
 - core/io/wait.rbs
 - core/kernel.rbs
 - core/marshal.rbs
@@ -77,6 +78,7 @@ files:
 - core/range.rbs
 - core/rational.rbs
 - core/rb_config.rbs
+- core/refinement.rbs
 - core/regexp.rbs
 - core/ruby_vm.rbs
 - core/signal.rbs
@@ -120,6 +122,11 @@ files:
 - goodcheck.yml
 - lib/rbs.rb
 - lib/rbs/ancestor_graph.rb
+- lib/rbs/annotate.rb
+- lib/rbs/annotate/annotations.rb
+- lib/rbs/annotate/formatter.rb
+- lib/rbs/annotate/rdoc_annotator.rb
+- lib/rbs/annotate/rdoc_source.rb
 - lib/rbs/ast/annotation.rb
 - lib/rbs/ast/comment.rb
 - lib/rbs/ast/declarations.rb
@@ -149,7 +156,6 @@ files:
 - lib/rbs/environment_walker.rb
 - lib/rbs/errors.rb
 - lib/rbs/factory.rb
-- lib/rbs/location.rb
 - lib/rbs/location_aux.rb
 - lib/rbs/locator.rb
 - lib/rbs/method_type.rb
@@ -196,6 +202,10 @@ files:
 - schema/types.json
 - sig/ancestor_builder.rbs
 - sig/ancestor_graph.rbs
+- sig/annotate/annotations.rbs
+- sig/annotate/formatter.rbs
+- sig/annotate/rdoc_annotater.rbs
+- sig/annotate/rdoc_source.rbs
 - sig/annotation.rbs
 - sig/buffer.rbs
 - sig/builtin_names.rbs
@@ -203,9 +213,9 @@ files:
 - sig/cli.rbs
 - sig/collection.rbs
 - sig/collection/cleaner.rbs
-- sig/collection/collections.rbs
 - sig/collection/config.rbs
 - sig/collection/installer.rbs
+- sig/collection/sources.rbs
 - sig/comment.rbs
 - sig/constant.rbs
 - sig/constant_table.rbs
@@ -240,6 +250,7 @@ files:
 - sig/version.rbs
 - sig/writer.rbs
 - stdlib/abbrev/0/abbrev.rbs
+- stdlib/abbrev/0/array.rbs
 - stdlib/base64/0/base64.rbs
 - stdlib/benchmark/0/benchmark.rbs
 - stdlib/bigdecimal-math/0/big_math.rbs
@@ -271,6 +282,7 @@ files:
 - stdlib/mutex_m/0/mutex_m.rbs
 - stdlib/net-http/0/manifest.yaml
 - stdlib/net-http/0/net-http.rbs
+- stdlib/nkf/0/nkf.rbs
 - stdlib/objspace/0/objspace.rbs
 - stdlib/openssl/0/manifest.yaml
 - stdlib/openssl/0/openssl.rbs
@@ -361,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Type signature for Ruby.

data/lib/rbs/location.rb

@@ -1,221 +0,0 @@
-# module RBS
-#   class Location
-#     attr_reader :buffer
-#     attr_reader :start_pos
-#     attr_reader :end_pos
-
-#     def initialize(buffer, start_pos, end_pos)
-#       @buffer = buffer
-#       @start_pos = start_pos
-#       @end_pos = end_pos
-#     end
-
-#     # def self.new(buffer_ = nil, start_pos_ = nil, end_pos_ = nil)
-#     #   __skip__ = super(buffer_, start_pos_, end_pos_)
-#     # end
-
-#     # def inspect
-#     #   "#<#{self.class}:#{self.__id__} @buffer=#{buffer.name}, @pos=#{start_pos}...#{end_pos}, source='#{source.lines.first}', start_line=#{start_line}, start_column=#{start_column}>"
-#     # end
-
-#     def name
-#       buffer.name
-#     end
-
-#     def start_line
-#       start_loc[0]
-#     end
-
-#     def start_column
-#       start_loc[1]
-#     end
-
-#     def end_line
-#       end_loc[0]
-#     end
-
-#     def end_column
-#       end_loc[1]
-#     end
-
-#     def start_loc
-#       @start_loc ||= buffer.pos_to_loc(start_pos)
-#     end
-
-#     def end_loc
-#       @end_loc ||= buffer.pos_to_loc(end_pos)
-#     end
-
-#     def range
-#       start_pos...end_pos
-#     end
-
-#     def source
-#       @source ||= buffer.content[start_pos...end_pos] or raise
-#     end
-
-#     def to_s
-#       "#{name || "-"}:#{start_line}:#{start_column}...#{end_line}:#{end_column}"
-#     end
-
-#     def self.to_string(location, default: "*:*:*...*:*")
-#       location&.to_s || default
-#     end
-
-#     def ==(other)
-#       other.is_a?(Location) &&
-#         other.buffer == buffer &&
-#         other.start_pos == start_pos &&
-#         other.end_pos == end_pos
-#     end
-
-#     def +(other)
-#       if other
-#         raise "Invalid concat: buffer=#{buffer.name}, other.buffer=#{other.buffer.name}" unless other.buffer == buffer
-
-#         self.class.new(buffer: buffer,
-#                        start_pos: start_pos,
-#                        end_pos: other.end_pos)
-#       else
-#         self
-#       end
-#     end
-
-#     def concat(*others)
-#       others.each { |other| self << other }
-#       self
-#     end
-
-#     def <<(other)
-#       if other
-#         raise "Invalid concat: buffer=#{buffer.name}, other.buffer=#{other.buffer.name}" unless other.buffer == buffer
-#         @end_pos = other.end_pos
-#         @source = nil
-#         @end_loc = nil
-#       end
-#       self
-#     end
-
-#     def pred?(loc)
-#       loc.is_a?(Location) &&
-#         loc.name == name &&
-#         loc.start_pos == end_pos
-#     end
-
-#     def to_json(state = _ = nil)
-#       {
-#         start: {
-#           line: start_line,
-#           column: start_column
-#         },
-#         end: {
-#           line: end_line,
-#           column: end_column
-#         },
-#         buffer: {
-#           name: name&.to_s
-#         }
-#       }.to_json(state)
-#     end
-
-#     def with_children(required: {}, optional: {})
-#       # @type var required: Hash[Symbol, Range[Integer] | Location]
-#       # @type var optional: Hash[Symbol, Range[Integer] | Location | nil]
-
-#       this = WithChildren.new(buffer: buffer, start_pos: start_pos, end_pos: end_pos)
-
-#       req = required.transform_values do |value|
-#         case value
-#         when Location
-#           value.range
-#         else
-#           value
-#         end
-#       end
-
-#       opt = optional.transform_values do |value|
-#         case value
-#         when Location
-#           value.range
-#         else
-#           value
-#         end
-#       end
-
-#       this.required_children.merge!(req)
-#       this.optional_children.merge!(opt)
-
-#       this
-#     end
-
-#     class WithChildren < Location
-#       attr_reader :required_children, :optional_children
-
-#       def initialize(buffer, start_pos, end_pos)
-#         super(buffer, start_pos, end_pos)
-
-#         @optional_children = {}
-#         @required_children = {}
-#       end
-
-#       def initialize_copy(from)
-#         required_children.merge!(from.required_children)
-#         optional_children.merge!(from.optional_children)
-#         self
-#       end
-
-#       def [](key)
-#         case
-#         when required_children.key?(_ = key)
-#           range = required_children[_ = key]
-#           Location.new(buffer: buffer, start_pos: range.begin, end_pos: range.end)
-#         when optional_children.key?(_ = key)
-#           range = required_children[_ = key] || optional_children[_ = key]
-#           if range
-#             Location.new(buffer: buffer, start_pos: range.begin, end_pos: range.end)
-#           end
-#         else
-#           raise "Unknown key given: `#{key}`"
-#         end
-#       end
-
-#       def merge_required(hash)
-#         this = dup
-
-#         h = hash.transform_values do |value|
-#           case value
-#           when Range
-#             value
-#           when Location
-#             value.range
-#           else
-#             raise
-#           end
-#         end
-
-#         this.required_children.merge!(h)
-
-#         this
-#       end
-
-#       def merge_optional(hash)
-#         this = dup
-
-#         h = hash.transform_values do |value|
-#           case value
-#           when Range
-#             value
-#           when Location
-#             value.range
-#           else
-#             nil
-#           end
-#         end
-
-#         this.optional_children.merge!(h)
-
-#         this
-#       end
-#     end
-#   end
-# end