rbs 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d83588e6a5f96ce5953f7c94eaf6f745eddadd1446e91946f18d4b81efb70bc
-  data.tar.gz: 3d7c3148afbe2a6041de6c909ddf08d7991e17c6fa2cebd4393a920582539263
+  metadata.gz: 3be8bb7e853829dddbff29b1a3337a33fd61e2860f6c83771dfdbe2ad097eb75
+  data.tar.gz: e569b69fe73f92c80e621521be85e8292fdb43a14d4f1fdc8f7537cdd04efbb5
 SHA512:
-  metadata.gz: e8a99b1a837a8cf4c7f1ce6b148c25e66433db2800d356a51ad58cc9b41280b097d3db7a3138679bc34f3c536415473a1b5423fac44f1048359d8556c938c298
-  data.tar.gz: 145caea219b5fb1d209e37f03ae0d4999f788895cf6a6dc4150d9ee4864be46ee7dc1126b95d0ddb0b1f1a4576c46f502c415aef56143900be61b726f81a291f
+  metadata.gz: 53895724feba94cfc7695ee7013f7cfa83618d566f4eec14fab0b5bed00074cda0394668a92d1f9eaa572bc3f0d8099a2f0bf201b05a444b3b2b8201c797ed48
+  data.tar.gz: 924a8b04e9b88464b5443fc1b8269cd20cfbfb25e04cc93737d52bbe1b4a895ac389371e373129ac6238a1152369ce71c3cca9183608fc9cebca4f571effc018

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 ## master
 
+## 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

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")

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.
   #

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
 

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
 

data/docs/sigs.md

@@ -26,7 +26,7 @@ The test installs instrumentations to spy the method calls and check if argument
 If errors are reported by the test, you will fix the signature.
 You will be sure that you ship a correct signature finally.
 
-The instrumentations are implemneted using `Module#prepend`.
+The instrumentations are implemented using `Module#prepend`.
 It defines a module with same name of methods, which asserts the type of arguments/return values and calls `super`.
 
 ## Type errors
@@ -70,6 +70,23 @@ ERROR -- : [Kaigi::Conference#speakers] UnexpectedBlockError: unexpected block i
 The error means there is a type error on overloaded methods.
 The `rbs` test framework tries to the best error message for overloaded methods too, but it reports the `UnresolvedOverloadingError` when it fails.
 
+### DuplicatedMethodDefinitionError
+
+The error is reported when a method is defined multiple times, as RBS does not allow duplicate method definitions. When you need to overload a method, use the `...` syntax:
+
+```ruby
+# First definition
+class C
+  def foo: () -> untyped
+end
+
+# Second definition, use `...` syntax to tell RBS that we're overloading the method
+class C
+  def foo: () -> untyped
+         | ...
+end
+```
+
 ## Setting up the test
 
 The design of the signature testing aims to be non-intrusive. The setup is done in two steps:

data/docs/syntax.md

@@ -11,8 +11,8 @@ _type_ ::= _class-name_ _type-arguments_                (Class instance type)
          | _type_ `|` _type_                            (Union type)
          | _type_ `&` _type_                            (Intersection type)
          | _type_ `?`                                   (Optional type)
-         | `{` _record-name_ `:` _type_ `,` ... `}`     (Record type)
-         | `[]` | `[` _type_ `,` ... `]`                (Tuples)
+         | `{` _record-name_ `:` _type_ `,` etc. `}`     (Record type)
+         | `[]` | `[` _type_ `,` etc. `]`                (Tuples)
          | _type-variable_                              (Type variables)
          | `^(` _parameters_ `) ->` _type_              (Proc type)
          | `self`
@@ -36,7 +36,7 @@ _namespace_ ::=                                         (Empty namespace)
               | _namespace_ /[A-Z]\w*/ `::`             (Namespace)
 
 _type-arguments_ ::=                                    (No application)
-                   | `[` _type_ `,` ... `]`             (Type application)
+                   | `[` _type_ `,` etc. `]`             (Type application)
 
 _literal_ ::= _string-literal_
             | _symbol-literal_
@@ -203,7 +203,6 @@ We can see an example at the definition of `Enumerable#find`:
 ```
 module Enumerable[Elem, Return]
   def find: () { (Elem) -> boolish } -> Elem?
-  ...
 end
 ```
 
@@ -233,11 +232,11 @@ _parameters_ ::= _required-positionals_ _optional-positionals_ _rest-positional_
 
 _parameter_ ::= _type_ _var-name_                                  # Parameter with var name
               | _type_                                             # Parameter without var name
-_required-positionals_ ::= _parameter_ `,` ...
-_optional-positionals_ ::= `?` _parameter_ `,` ...
+_required-positionals_ ::= _parameter_ `,` etc.
+_optional-positionals_ ::= `?` _parameter_ `,` etc.
 _rest-positional_ ::=                                              # Empty
                     | `*` _parameter_
-_trailing-positionals_ ::= _parameter_ `,` ...
+_trailing-positionals_ ::= _parameter_ `,` etc.
 _keywords_ ::=                                                     # Empty
              | `**` _parameter_                                    # Rest keyword
              | _keyword_ `:` _parameter_ `,` _keywords_            # Required keyword
@@ -292,9 +291,10 @@ _method-member_ ::= `def` _method-name_ `:` _method-types_            # Instance
 _method-types_ ::=                                                       # Empty
                  | `super`                                               # `super` overloading
                  | _type-parameters_ _method-type_ `|` _method-types_    # Overloading types
+                 | `...`                                                 # Overloading for duplicate definitions
 
 _type-parameters_ ::=                                                 # Empty
-                    | `[` _type-variable_ `,` ... `]`
+                    | `[` _type-variable_ `,` etc. `]`
 
 _attribute-member_ ::= _attribute-type_ _method-name_ `:` _type_                     # Attribute
                      | _attribute-type_ _method-name_ `(` _ivar-name_ `) :` _type_   # Attribute with variable name specification
@@ -450,7 +450,7 @@ _const-name_ ::= _namespace_ /[A-Z]\w*/
 _global-name_ ::= /$[a-zA-Z]\w+/ | ...
 
 _module-type-parameters_ ::=                                                  # Empty
-                           | `[` _module-type-parameter_ `,` ... `]`
+                           | `[` _module-type-parameter_ `,` etc. `]`
 
 _module-type-parameter_ ::= _check_ _variance_ _type-variable_
 _variance_ ::= `out` | `in`
@@ -475,7 +475,7 @@ For example, an `Array` of `String` can almost be considered to be an `Array` of
 
 ```
 class Array[out T]
-  # ...
+  # etc.
 end
 ```
 
@@ -486,7 +486,7 @@ In those cases, one must use the `unchecked` keyword:
 
 ```
 class Array[unchecked out T]
-  # ...
+  # etc.
 end
 ```
 

data/lib/rbs.rb

@@ -43,6 +43,7 @@ require "rbs/validator"
 require "rbs/factory"
 require "rbs/repository"
 require "rbs/ancestor_graph"
+require "rbs/locator"
 
 begin
   require "rbs/parser"

data/lib/rbs/ast/annotation.rb

@@ -19,8 +19,8 @@ module RBS
         self.class.hash ^ string.hash
       end
 
-      def to_json(*a)
-        { string: string, location: location }.to_json(*a)
+      def to_json(state = _ = nil)
+        { string: string, location: location }.to_json(state)
       end
     end
   end

data/lib/rbs/ast/comment.rb

@@ -19,8 +19,8 @@ module RBS
         self.class.hash ^ string.hash
       end
 
-      def to_json(*a)
-        { string: string, location: location }.to_json(*a)
+      def to_json(state = _ = nil)
+        { string: string, location: location }.to_json(state)
       end
 
       def concat(string:, location:)