rbs 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a74db23528adc1dec1cf74a16e9d673ab7bba904e5f9dfb5d32fd48a9a55e5f
-  data.tar.gz: 126f9160565fb35f91598376ef0d0ef7589a940c99399a983cbc35f6a9a355c5
+  metadata.gz: 3be8bb7e853829dddbff29b1a3337a33fd61e2860f6c83771dfdbe2ad097eb75
+  data.tar.gz: e569b69fe73f92c80e621521be85e8292fdb43a14d4f1fdc8f7537cdd04efbb5
 SHA512:
-  metadata.gz: dda7d98e9e01acef22765c4683e081e93c871eb5280d294940685e736716050bf8b4f6cc9d546c987c5932238df9d0f349d04c1becc6bd48832ca202ff69331b
-  data.tar.gz: 3d40ac86d0b6c044822b6e48af4c9c3414feab9ab6924f205c2e1163818301e0428895e62f8a2a55cb5dfd6e3175d2b556d2390a22de6533de998756949a99b0
+  metadata.gz: 53895724feba94cfc7695ee7013f7cfa83618d566f4eec14fab0b5bed00074cda0394668a92d1f9eaa572bc3f0d8099a2f0bf201b05a444b3b2b8201c797ed48
+  data.tar.gz: 924a8b04e9b88464b5443fc1b8269cd20cfbfb25e04cc93737d52bbe1b4a895ac389371e373129ac6238a1152369ce71c3cca9183608fc9cebca4f571effc018

data/.github/workflows/ruby.yml

@@ -27,10 +27,10 @@ jobs:
       run: |
         apt-get update
         apt-get install -y libdb-dev
-    - name: Install bundler
+    - name: Update rubygems & bundler
       run: |
         ruby -v
-        gem install bundler
+        gem update --system
     - name: bundle config set with
       run: |
         echo "NO_MINITEST=true" >> $GITHUB_ENV

data/CHANGELOG.md

@@ -2,6 +2,101 @@
 
 ## 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
+
+* rubygem ([#630](https://github.com/ruby/rbs/pull/630))
+
+## 1.1.0 (2021-03-08)
+
+### Summary
+
+Errors are now organized by `RBS::BaseError`, `RBS::ParsingError`, `RBS::LoadingError`, and `RBS::DefinitionError`.
+The library users can rescue RBS related errors with `RBS::BaseError`, parsing errors with `RBS::ParsingError`, and other errors with `RBS::LoadingError` and `RBS::DefinitionErrors`.
+
+Updating a part of environments are supported. Library users can remove declarations read from a set of files, adding new declarations, running name resolution related to the new decls, and deleting `DefinitionBuilder` caches related to the changes.
+See `RBS::Environment#reject`, `RBS::Environment#resolve_type_names`, `RBS::AncestorGraph`, and `RBS::DefinitionBuilder#update`.
+
+`RBS::DefinitionBuilder#build_singleton` now returns definitions containing `instance` type, which had returned resolved class instance types. This is a breaking change, but we consider it a bug fix because `RBS::DefinitionBuilder#build_instance` has returned `instance` types and `#build_singleton` has returned `class` type.
+
+### Signature updates
+
+* rubygem ([\#605](https://github.com/ruby/rbs/pull/605), [\#610](https://github.com/ruby/rbs/pull/610))
+* Array ([\#612](https://github.com/ruby/rbs/pull/612), [\#614](https://github.com/ruby/rbs/pull/614))
+* cgi/core ([\#599](https://github.com/ruby/rbs/pull/599))
+* Thread ([\#618](https://github.com/ruby/rbs/pull/618))
+
+### Language updates
+
+* Allow trailing comma for Record and Tuple types ([\#606](https://github.com/ruby/rbs/pull/606))
+
+### Library changes
+
+* Allow partial update of RBS declarations ([\#608](https://github.com/ruby/rbs/pull/608), [\#621](https://github.com/ruby/rbs/pull/621))
+* Let errors have `TypeName` ([\#611](https://github.com/ruby/rbs/pull/611))
+* Add `Parser::LexerError` ([\#615](https://github.com/ruby/rbs/pull/615))
+* Performance improvement ([\#617](https://github.com/ruby/rbs/pull/617), [\#620](https://github.com/ruby/rbs/pull/620))
+* No substitute `instance` types on `#build_singleton` ([\#619](https://github.com/ruby/rbs/pull/619))
+
+### Miscellaneous
+
+* Make racc name customizable by `RACC` environment variable ([\#602](https://github.com/ruby/rbs/pull/602))
+* Suppress warnings ([\#624](https://github.com/ruby/rbs/pull/624))
+* Remove needless `Gem::Version` polyfill ([\#622](https://github.com/ruby/rbs/pull/622))
+
+## 1.0.6 (2021-02-17)
+
+* Signature Updates
+  * `Enumerable` ([\#595](https://github.com/ruby/rbs/pull/595), [\#596](https://github.com/ruby/rbs/pull/596), [\#601](https://github.com/ruby/rbs/pull/601))
+  * `#as_json` ([\#597](https://github.com/ruby/rbs/pull/597))
+
+## 1.0.5 (2021-02-13)
+
+* Signature Updates
+  * Enumerable ([\#596](https://github.com/ruby/rbs/pull/596))
+  * Set ([\#595](https://github.com/ruby/rbs/pull/595))
+  * `#to_json` ([\#592](https://github.com/ruby/rbs/pull/592))
+  * `<=>` ([\#593](https://github.com/ruby/rbs/pull/593))
+  * Timeout ([\#586](https://github.com/ruby/rbs/pull/586))
+  * URI::RFC2396_Parser ([\#587](https://github.com/ruby/rbs/pull/587))
+* Rename generic class parameters on re-open ([\#594](https://github.com/ruby/rbs/pull/594))
+* Make `refute_send_type` check that method call doesn't match with types in RBS ([\#588](https://github.com/ruby/rbs/pull/588))
+
 ## 1.0.4 (2021-01-31)
 
 * Unbundle `rr` to run test in `ruby/ruby` repo ([#585](https://github.com/ruby/rbs/pull/585))

data/Rakefile

@@ -2,7 +2,10 @@ 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")
 bin = File.join(__dir__, "bin")
 
@@ -67,7 +70,7 @@ task :rubocop do
 end
 
 rule ".rb" => ".y" do |t|
-  sh "racc -v -o #{t.name} #{t.source}"
+  sh "#{racc} -v -o #{t.name} #{t.source}"
 end
 
 task :parser => "lib/rbs/parser.rb"
@@ -77,7 +80,7 @@ task :build => :parser
 
 task :confirm_parser do
   puts "Testing if parser.rb is updated with respect to parser.y"
-  sh "racc -v -o lib/rbs/parser.rb lib/rbs/parser.y"
+  sh "#{racc} -v -o lib/rbs/parser.rb lib/rbs/parser.y"
   sh "git diff --exit-code lib/rbs/parser.rb"
 end
 

data/Steepfile

@@ -5,6 +5,8 @@ target :lib do
   ignore "lib/rbs/prototype", "lib/rbs/test", "lib/rbs/test.rb"
 
   library "set", "pathname", "json", "logger", "monitor", "tsort"
+  signature "stdlib/strscan/0/"
+  signature "stdlib/rubygems/0/"
 end
 
 # target :lib do

data/bin/rbs-prof

@@ -4,6 +4,6 @@ require "stackprof"
 
 out = ENV["RBS_STACKPROF_OUT"] || 'tmp/stackprof-cpu-rbs.dump'
 
-StackProf.run(mode: :cpu, out: out) do
+StackProf.run(mode: :cpu, out: out, raw: true) do
   load File.join(__dir__, "../exe/rbs")
 end

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.
   #
@@ -1584,8 +1584,8 @@ class Array[unchecked out Elem] < Object
   #     a.sample(random: Random.new(1))     #=> 6
   #     a.sample(4, random: Random.new(1))  #=> [6, 10, 9, 2]
   #
-  def sample: (?random: Random rng) -> Elem?
-            | (?int n, ?random: Random rng) -> ::Array[Elem]
+  def sample: (?random: _Rand rng) -> Elem?
+            | (?int n, ?random: _Rand rng) -> ::Array[Elem]
 
   # Returns a new array containing all elements of `ary` for which the given
   # `block` returns a true value.
@@ -1649,7 +1649,7 @@ class Array[unchecked out Elem] < Object
   #
   #     a.shuffle(random: Random.new(1))  #=> [1, 3, 2]
   #
-  def shuffle: (?random: Random rng) -> ::Array[Elem]
+  def shuffle: (?random: _Rand rng) -> ::Array[Elem]
 
   # Shuffles elements in `self` in place.
   #
@@ -1661,7 +1661,7 @@ class Array[unchecked out Elem] < Object
   #
   #     a.shuffle!(random: Random.new(1))  #=> [1, 3, 2]
   #
-  def shuffle!: (?random: Random rng) -> self
+  def shuffle!: (?random: _Rand rng) -> self
 
   alias size length
 
@@ -1736,7 +1736,7 @@ class Array[unchecked out Elem] < Object
   # See also Enumerable#sort_by.
   #
   def sort: () -> ::Array[Elem]
-          | () { (Elem a, Elem b) -> ::Integer? } -> ::Array[Elem]
+          | () { (Elem a, Elem b) -> ::Integer } -> ::Array[Elem]
 
   # Sorts `self` in place.
   #
@@ -1757,7 +1757,7 @@ class Array[unchecked out Elem] < Object
   # See also Enumerable#sort_by.
   #
   def sort!: () -> self
-           | () { (Elem a, Elem b) -> ::Integer? } -> self
+           | () { (Elem a, Elem b) -> ::Integer } -> self
 
   # Sorts `self` in place using a set of keys generated by mapping the values in
   # `self` through the given block.
@@ -1997,6 +1997,10 @@ interface _ToAry[T]
   def to_ary: () -> ::Array[T]
 end
 
+interface _Rand
+  def rand: (::Integer max) -> ::Integer
+end
+
 interface Array::_Pattern[T]
   def ===: (T) -> bool
 end

data/core/complex.rbs

@@ -121,7 +121,7 @@ class Complex < Numeric
   #     Complex(2)     <=> 2               #=> 0
   #     Complex(2)     <=> 3               #=> -1
   #
-  def <=>: (Numeric) -> Integer?
+  def <=>: (untyped) -> Integer?
 
   # Returns true if cmp equals object numerically.
   #

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]
@@ -286,8 +286,22 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   def sort_by: () { (Elem arg0) -> (Comparable | ::Array[untyped]) } -> ::Array[Elem]
              | () -> ::Enumerator[Elem, ::Array[Elem]]
 
-  def take: (Integer n) -> ::Array[Elem]?
+  # Returns first n elements from *enum*.
+  #
+  #     a = [1, 2, 3, 4, 5, 0]
+  #     a.take(3)             #=> [1, 2, 3]
+  #     a.take(30)            #=> [1, 2, 3, 4, 5, 0]
+  #
+  def take: (Integer n) -> ::Array[Elem]
 
+  # Passes elements to the block until the block returns `nil` or `false`, then
+  # stops iterating and returns an array of all prior elements.
+  #
+  # If no block is given, an enumerator is returned instead.
+  #
+  #     a = [1, 2, 3, 4, 5, 0]
+  #     a.take_while { |i| i < 3 }   #=> [1, 2]
+  #
   def take_while: () { (Elem) -> boolish } -> ::Array[Elem]
                 | () -> ::Enumerator[Elem, ::Array[Elem]]
 

data/core/enumerator.rbs

@@ -244,6 +244,8 @@ end
 
 class Enumerator::Generator[out Elem] < Object
   include Enumerable[Elem]
+
+  def each: () { (Elem) -> void } -> void
 end
 
 class Enumerator::Lazy[out Elem, out Return] < Enumerator[Elem, Return]
@@ -259,4 +261,6 @@ end
 
 class Enumerator::Chain[out Elem] < Object
   include Enumerable[Elem]
+
+  def each: () { (Elem) -> void } -> void
 end

data/core/file.rbs

@@ -985,7 +985,8 @@ class File::Stat < Object
   include Comparable
 
   def initialize: (String file) -> Object
-  def <=>: (File::Stat other) -> Integer?
+  def <=>: (File::Stat other) -> Integer
+         | (untyped) -> nil
 
   def atime: () -> Time
 

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/integer.rbs

@@ -112,7 +112,8 @@ class Integer < Numeric
   #
   # `nil` is returned if the two values are incomparable.
   #
-  def <=>: (Numeric) -> Integer?
+  def <=>: (Integer | Rational) -> Integer
+         | (untyped) -> Integer?
 
   # Returns `true` if `int` equals `other` numerically. Contrast this with
   # Integer#eql?, which requires `other` to be an Integer.

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

@@ -90,7 +90,7 @@ class Module < Object
   # Returns `nil` if `module` has no relationship with `other_module`, if
   # `other_module` is not a module, or if the two values are incomparable.
   #
-  def <=>: (Module other) -> Integer?
+  def <=>: (untyped other) -> Integer?
 
   # Equality --- At the Object level, #== returns `true` only if `obj` and `other`
   # are the same object.  Typically, this method is overridden in descendant
@@ -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.
   #