rbs 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a862e1af5773b464ebf201344cf823512ca551df1f827825328863225a26c8
-  data.tar.gz: 2853162048f342a1dad949b518887e82bc4ede46d79d57626fabb49e2edf920d
+  metadata.gz: ab99593166ee140ca3ffc517eddcd872c6798dcb41a991c1e67c0c16a2a86fc9
+  data.tar.gz: a4e5cdd454fb49ddd499ba3382e118f8789b5413d0607ad9e3652551839c0ca3
 SHA512:
-  metadata.gz: 99fbc15297542d7d0bd952806556b128e071a7f31e0f175b573f77c00db3ec4a6ddd473f33aaf170f2a08f99991939cbcc0484d4287413c9e2b55dfbadc7dff0
-  data.tar.gz: 3553c8cc89269a9579ccd52d3c9f61bd44f4f6117856da23726930c5c5b17f5aa5da7f1d69a9748fffc1b2fe62587149856a2c1ddee0fed79fb155be6aee6037
+  metadata.gz: 8d660c0dd7796bad07fac8e2ee85968e91259af0a4c9fed2c8668f0d6e385a517160d5792702181e18923929a3de7ded420c84e2184cb83a852d2133c1f34050
+  data.tar.gz: 4991d9a71cd0bd2bd2832d7764a8d65a73de146fecf76d3ccd67a41599326ca45b091e559acededcd095a44cdef6e32cc01fbb742e04bba945269b4e21a6444c

data/.github/workflows/ruby.yml

@@ -18,7 +18,11 @@ jobs:
         job:
         - test
         - stdlib_test
-        - rubocop validate test_doc build test_generate_stdlib confirm_parser
+        - rubocop validate test_doc build test_generate_stdlib
+        - confirm_parser
+        exclude:
+        - container_tag: master-nightly-focal
+          job: confirm_parser
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/steep/.bundle/
 /.yardoc
 /_yardoc/
 /coverage/
@@ -9,3 +10,4 @@
 /lib/rbs/parser.output
 /vendor/sigs
 /Gemfile.lock
+

data/CHANGELOG.md

@@ -2,6 +2,87 @@
 
 ## master
 
+## 1.3.0 (2021-07-20)
+
+### Summary
+
+RBS 1.3.0 includes bug fixees of the parser and class/module definition validations.
+
+### Signature updates
+
+* dbm ([#718](https://github.com/ruby/rbs/pull/718))
+* net-http ([#686](https://github.com/ruby/rbs/pull/686))
+* optparse ([#693](https://github.com/ruby/rbs/pull/693))
+* resolv ([#697](https://github.com/ruby/rbs/pull/697))
+* socket ([#699](https://github.com/ruby/rbs/pull/699))
+* `IO` ([#698](https://github.com/ruby/rbs/pull/698))
+* `Marshal` ([#684](https://github.com/ruby/rbs/pull/684))
+* `Mutex` ([#683](https://github.com/ruby/rbs/pull/683))
+* `Array#shift` ([#707](https://github.com/ruby/rbs/pull/707))
+* `BasicObject#method_missing` ([#707](https://github.com/ruby/rbs/pull/706), [#710](https://github.com/ruby/rbs/pull/710))
+* `Kernel#caller` ([#705](https://github.com/ruby/rbs/pull/705))
+
+### Library changes
+
+* Interface names starting with lower case characters are now syntax error ([#678](https://github.com/ruby/rbs/pull/678), [#720](https://github.com/ruby/rbs/pull/720))
+* Mixins of classes are rejected ([#681](https://github.com/ruby/rbs/pull/681))
+* Generate prototype of `initialize` method with return type `void` ([#685](https://github.com/ruby/rbs/pull/685))
+* Let `prototype runtime` generate class/module declarations in nested syntax ([#700](https://github.com/ruby/rbs/pull/700))
+* Fix race condition for multi-thread support ([#702](https://github.com/ruby/rbs/pull/702))
+
+### Miscellaneous
+
+* Add new doc `docs/rbs_by_example.md` ([#694](https://github.com/ruby/rbs/pull/694))
+
+## 1.2.1 (2021-05-27)
+
+This release includes the following minor changes:
+
+* Fix test to run the tests in ruby repository. ([#679](https://github.com/ruby/rbs/pull/679))
+* Remove unnecessary files from the gem package. ([#675](https://github.com/ruby/rbs/pull/675))
+* Suppress unused variable warning ([#674](https://github.com/ruby/rbs/pull/674))
+* Update documents ([#672](https://github.com/ruby/rbs/pull/672))
+
+## 1.2.0 (2021-04-21)
+
+### Summary
+
+RBS 1.2 ships with better support for AST/token locations and `Locator` utility class. The AST objects now keep the locations of tokens. The `Locator` class is to translate the text position (line and column) to semantic object at the location. The class allows to find if a text position is on the class name of a class declaration.
+
+### Signature updates
+
+* Hash ([#631](https://github.com/ruby/rbs/pull/631), [#632](https://github.com/ruby/rbs/pull/632), [\#637](https://github.com/ruby/rbs/pull/637), [\#638](https://github.com/ruby/rbs/pull/638), [\#639](https://github.com/ruby/rbs/pull/639), )
+* Module ([\#645](https://github.com/ruby/rbs/pull/645))
+* Enumerable ([\#647](https://github.com/ruby/rbs/pull/647))
+* Array ([\#648](https://github.com/ruby/rbs/pull/648))
+* Proc ([\#649](https://github.com/ruby/rbs/pull/649))
+* Struct ([\#650](https://github.com/ruby/rbs/pull/650), [\#668](https://github.com/ruby/rbs/pull/668))
+* Thread ([\#651](https://github.com/ruby/rbs/pull/651))
+* Random ([\#669](https://github.com/ruby/rbs/pull/669))
+* Shellwords ([\#665](https://github.com/ruby/rbs/pull/665))
+* IO ([\#659](https://github.com/ruby/rbs/pull/659))
+
+### Language updates
+
+* Module self type syntax update ([\#653](https://github.com/ruby/rbs/pull/653))
+
+### Library changes
+
+* Token locations ([\#666](https://github.com/ruby/rbs/pull/666))
+* Add RBS::Locator ([\#667](https://github.com/ruby/rbs/pull/667))
+* Fix runtime type checker ([\#644](https://github.com/ruby/rbs/pull/644))
+
+### Miscellaneous
+
+* Update documentation for overloading ([\#658](https://github.com/ruby/rbs/pull/658))
+* Update target ruby version ([\#633](https://github.com/ruby/rbs/pull/633))
+
+## 1.1.1 (2021-03-12)
+
+### Signature updates
+
+* rubygem ([#630](https://github.com/ruby/rbs/pull/630))
+
 ## 1.1.0 (2021-03-08)
 
 ### Summary

data/README.md

@@ -7,7 +7,7 @@ It also allows declaring constants and global variables.
 The following is a small example of RBS for a chat app.
 
 <!-- run-start:a.rbs:bundle exec rbs -I a.rbs validate -->
-```rbs
+```rb
 module ChatApp
   VERSION: String
 

data/Rakefile

@@ -2,6 +2,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 require "rbconfig"
 
+$LOAD_PATH << File.join(__dir__, "test")
+
 ruby = ENV["RUBY"] || RbConfig.ruby
 racc = ENV.fetch("RACC", "racc")
 rbs = File.join(__dir__, "exe/rbs")
@@ -52,6 +54,15 @@ task :validate => :parser do
       lib << "singleton"
     end
 
+    if lib == ["net-http"]
+      lib << "uri"
+    end
+
+    if lib == ["resolv"]
+      lib << "socket"
+      lib << "timeout"
+    end
+
     sh "#{ruby} #{rbs} #{lib.map {|l| "-r #{l}"}.join(" ")} validate --silent"
   end
 end

data/Steepfile

@@ -7,6 +7,7 @@ target :lib do
   library "set", "pathname", "json", "logger", "monitor", "tsort"
   signature "stdlib/strscan/0/"
   signature "stdlib/rubygems/0/"
+  signature "stdlib/optparse/0/"
 end
 
 # target :lib do

data/core/array.rbs

@@ -682,7 +682,7 @@ class Array[unchecked out Elem] < Object
   #
   # See also Array#+.
   #
-  def concat: (*::Array[Elem] arrays) -> ::Array[Elem]
+  def concat: (*::Array[Elem] arrays) -> self
 
   # Returns the number of elements.
   #
@@ -1637,7 +1637,7 @@ class Array[unchecked out Elem] < Object
   #     args           #=> ["filename"]
   #
   def shift: () -> Elem?
-           | (?int n) -> ::Array[Elem]
+           | (int n) -> ::Array[Elem]
 
   # Returns a new array with elements of `self` shuffled.
   #

data/core/basic_object.rbs

@@ -215,7 +215,7 @@ class BasicObject
   #     r.xxiii   #=> 23
   #     r.mm      #=> 2000
   #
-  def method_missing: (Symbol, *untyped) -> untyped
+  def method_missing: (Symbol, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped
 
   # Invoked as a callback whenever a singleton method is added to the receiver.
   #

data/core/enumerable.rbs

@@ -118,7 +118,7 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   # [].first(10)              #=> []
   # ```
   def first: () -> Elem?
-           | (Integer n) -> ::Array[Elem]?
+           | (_ToInt n) -> ::Array[Elem]
 
   def grep: (untyped arg0) -> ::Array[Elem]
           | [U] (untyped arg0) { (Elem arg0) -> U } -> ::Array[U]

data/core/hash.rbs

@@ -256,7 +256,7 @@ class Hash[unchecked out K, unchecked out V] < Object
   #     h.compact     #=> { a: 1, b: false }
   #     h             #=> { a: 1, b: false, c: nil }
   #
-  def compact: () -> self
+  def compact: () -> ::Hash[K, V]
 
   # Removes all nil values from the hash. Returns nil if no changes were made,
   # otherwise returns the hash.
@@ -450,6 +450,14 @@ class Hash[unchecked out K, unchecked out V] < Object
   #
   def eql?: (untyped) -> bool
 
+  # Returns a hash excluded given keys and the values.
+  #
+  #     h = { a: 100, b: 200, c: 300 }
+  #     h.except(:a)           #=> {:b=>200, :c=>300}
+  #     h.except(:b, :c, :d)   #=> {:a=>100}
+  #
+  def except: (*K) -> ::Hash[K, V]
+
   # Returns a value from the hash for the given key. If the key can't be found,
   # there are several options: With no other arguments, it will raise a KeyError
   # exception; if *default* is given, then that will be returned; if the optional
@@ -498,8 +506,8 @@ class Hash[unchecked out K, unchecked out V] < Object
   #
   # Hash#filter is an alias for Hash#select.
   #
-  def filter: () { (K, V) -> boolish } -> self
-            | () -> ::Enumerator[[ K, V ], self]
+  def filter: () { (K, V) -> boolish } -> ::Hash[K, V]
+            | () -> ::Enumerator[[ K, V ], ::Hash[K, V]]
 
   # Equivalent to Hash#keep_if, but returns `nil` if no changes were made.
   #
@@ -815,7 +823,7 @@ class Hash[unchecked out K, unchecked out V] < Object
   #     h.slice(:a)           #=> {:a=>100}
   #     h.slice(:b, :c, :d)   #=> {:b=>200, :c=>300}
   #
-  def slice: (*K) -> self
+  def slice: (*K) -> ::Hash[K, V]
 
   # ## Element Assignment
   #
@@ -857,7 +865,7 @@ class Hash[unchecked out K, unchecked out V] < Object
 
   # Returns `self`.
   #
-  def to_hash: () -> ::Hash[K, V]
+  def to_hash: () -> self
 
   # Returns a Proc which maps keys to values.
   #

data/core/io.rbs

@@ -181,7 +181,7 @@ class IO < Object
   #     # ...
   #     f.gets # won't cause Errno::EBADF
   #
-  def autoclose=: (bool) -> bool
+  def autoclose=: (boolish) -> untyped
 
   # Returns `true` if the underlying file descriptor of *ios* will be closed
   # automatically at its finalization, otherwise `false`.
@@ -212,7 +212,7 @@ class IO < Object
   # just ignored since Ruby 2.3.
   def close: () -> NilClass
 
-  def close_on_exec=: (boolish) -> bool
+  def close_on_exec=: (boolish) -> untyped
 
   # Returns `true` if *ios* will be closed on exec.
   #
@@ -656,7 +656,7 @@ class IO < Object
   # ```
   def sync: () -> bool
 
-  def sync=: (boolish) -> bool
+  def sync=: (boolish) -> untyped
 
   def sysread: (Integer maxlen, String outbuf) -> String
 
@@ -746,7 +746,7 @@ class IO < Object
 
   def self.readlines: (String name, ?String sep, ?Integer limit, ?external_encoding: String external_encoding, ?internal_encoding: String internal_encoding, ?encoding: String encoding, ?textmode: untyped textmode, ?binmode: untyped binmode, ?autoclose: untyped autoclose, ?mode: String mode) -> ::Array[String]
 
-  def self.select: (::Array[io]? read_array, ?::Array[io]? write_array, ?::Array[io]? error_array, ?Integer? timeout) -> ::Array[::Array[io]]?
+  def self.select: (::Array[io]? read_array, ?::Array[io]? write_array, ?::Array[io]? error_array, ?Numeric? timeout) -> ::Array[::Array[io]]?
 
   def self.sysopen: (String path, ?String mode, ?String perm) -> Integer
 

data/core/kernel.rbs

@@ -13,8 +13,8 @@
 module Kernel : BasicObject
   private
 
-  def self?.caller: (?Integer start_or_range, ?Integer length) -> ::Array[String]?
-            | (?::Range[Integer] start_or_range) -> ::Array[String]?
+  def self?.caller: (Integer start_or_range, ?Integer length) -> ::Array[String]?
+            | (::Range[Integer] start_or_range) -> ::Array[String]?
             | () -> ::Array[String]
 
   def self?.caller_locations: (?Integer start_or_range, ?Integer length) -> ::Array[Thread::Backtrace::Location]?

data/core/marshal.rbs

@@ -136,8 +136,8 @@ module Marshal
   #     ThreadGroup, Continuation
   # *   objects which define singleton methods
   #
-  def self.dump: (Object arg0, ?IO arg1, ?Integer arg2) -> Object
-               | (Object arg0, ?Integer arg1) -> Object
+  def self.dump: (untyped obj, untyped port, ?Integer limit) -> untyped
+               | (untyped obj, ?Integer limit) -> String
 
   # Returns the result of converting the serialized data in source into a Ruby
   # object (possibly with associated subordinate objects). source may be either an
@@ -147,7 +147,8 @@ module Marshal
   # Never pass untrusted data (including user supplied input) to this method.
   # Please see the overview for further details.
   #
-  def self.load: (String arg0, ?Proc arg1) -> Object
+  def self.load: (String | untyped port) -> untyped
+               | [A] (String | untyped port, ^(untyped) -> A) -> A
 
   alias self.restore self.load
 end

data/core/module.rbs

@@ -158,7 +158,7 @@ class Module < Object
   #
   #     Exiting with code 99
   #
-  def alias_method: (Symbol new_name, Symbol old_name) -> self
+  def alias_method: (::Symbol | ::String new_name, ::Symbol | ::String old_name) -> ::Symbol
 
   # Returns a list of modules included/prepended in *mod* (including *mod*
   # itself).

data/core/numeric.rbs

@@ -82,10 +82,20 @@ class Numeric
   #
   def %: (Numeric) -> Numeric
 
+  # Performs addition: the class of the resulting object depends on the class of
+  # `numeric`.
+  #
+  def +: (Numeric) -> Numeric
+
   # Unary Plus---Returns the receiver.
   #
   def +@: () -> Numeric
 
+  # Performs subtraction: the class of the resulting object depends on the class
+  # of `numeric`.
+  #
+  def -: (Numeric) -> Numeric
+
   # Unary Minus---Returns the receiver, negated.
   #
   def -@: () -> Numeric

data/core/proc.rbs

@@ -262,7 +262,7 @@ class Proc < Object
 
   def []: (*untyped arg0) -> untyped
 
-  def curry: (?Integer arity) -> Proc
+  def curry: (?_ToInt arity) -> Proc
 
   # Returns a hash value corresponding to proc body.
   #

data/core/random.rbs

@@ -106,7 +106,9 @@ class Random < Object
 
   # Alias of Random::DEFAULT.rand.
   #
-  def self.rand: (?Integer max) -> Numeric
+  def self.rand: () -> Float
+               | (Integer | ::Range[Integer] max) -> Integer
+               | (Float | ::Range[Float] max) -> Float
 
   # Seeds the system pseudo-random number generator, Random::DEFAULT, with
   # `number`.  The previous seed value is returned.
@@ -126,7 +128,7 @@ class Random < Object
   #     srand 1234               # => 1234
   #     [ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
   #
-  def self.srand: (?Integer number) -> Numeric
+  def self.srand: (?Integer number) -> Integer
 end
 
 # The default Pseudorandom number generator.  Used by class methods of Random.

data/core/range.rbs

@@ -99,7 +99,7 @@ class Range[out Elem] < Object
   # ```ruby
   # (1..10).begin   #=> 1
   # ```
-  def begin: () -> Elem
+  def begin: () -> Elem      # Begin-less ranges have type of Range[Integer?]
 
   def bsearch: [U] () { (Elem) -> boolish } -> U?
 
@@ -114,7 +114,7 @@ class Range[out Elem] < Object
   # (1..10).end    #=> 10
   # (1...10).end   #=> 10
   # ```
-  def `end`: () -> Elem
+  def `end`: () -> Elem      # End-less ranges have type of Range[Integer?]
 
   # Returns `true` if the range excludes its end value.
   #

data/core/struct.rbs

@@ -27,13 +27,14 @@
 # struct member which is either a quoted string ( `"name"` ) or a
 # [Symbol](https://ruby-doc.org/core-2.6.3/Symbol.html) ( `:name` ).
 class Struct[Elem] < Object
-  include Enumerable[Elem]
+  include Enumerable[Elem?]
 
   type attribute_name = Symbol | String
 
   def initialize: (attribute_name, *attribute_name, ?keyword_init: boolish) ?{ () -> void } -> void
 
-  def each: () { (Elem) -> untyped } -> untyped
+  def each: () -> ::Enumerator[Elem?, self]
+          | () { (Elem? item) -> void } -> self
 
   def self.members: () -> ::Array[Symbol]
 end

data/core/thread.rbs

@@ -842,7 +842,7 @@ class Thread < Object
   # However, if class [Thread](Thread.downloaded.ruby_doc) is subclassed,
   # then calling `start` in that subclass will not invoke the subclass’s
   # `initialize` method.
-  def self.start: (*untyped args) -> untyped
+  def self.start: (*untyped args) { (*untyped) -> void } -> instance
 
   # Stops execution of the current thread, putting it into a “sleep” state,
   # and schedules execution of another thread.

data/docs/CONTRIBUTING.md

@@ -28,8 +28,8 @@
 
 ## The Target Version
 
-* The standard library signatures targets Ruby 2.7 for now.
-* The library code targets Ruby 2.6, 2.7, and 3.0.
+* The standard library signatures targets Ruby 3.0 for now.
+* The library code targets Ruby 2.7 and 3.0.
 
 ## Stdlib Worksheet
 
@@ -60,6 +60,8 @@ You may find the *Good for first contributor* column where you can find some cla
   Validate the syntax and some of the semantics.
 * `rake generate:stdlib_test[String]`
   Scaffold the stdlib test.
+* `rake test/stdlib/Array_test.rb`
+  Run specific stdlib test with the path.
 
 ## Standard STDLIB Members Order
 
@@ -85,7 +87,7 @@ class HelloWorld[X]
 
   public                                                        # Public instance methods
 
-  def each: () { (A) -> void } -> void                          # Members are sorted dicionary order
+  def each: () { (A) -> void } -> void                          # Members are sorted dictionary order
 
   def to_s: (?Locale) -> String