rbs 1.0.5 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96101c70eb61ad35fb0589861eb35f96a194b9de0e6e0f879237f3c5afea2a60
-  data.tar.gz: 8ca6a02529d655a6c4099b5f9da6ff63ec09159c8fcf2d4a43f60a615aa6b44d
+  metadata.gz: 99ab9c0212ca34de0fa1b8394b02713e5bc63e0904d7f95d0e1c0480635e3e39
+  data.tar.gz: 71be3592a61873855149305edc2b0ef3aabc97259e0ed46c697598fefddb4177
 SHA512:
-  metadata.gz: ffeed46652774774276a0efb9285b53b979fefa0bbf1fd6bdd8aba7fd76172f352313acdfaca64c89dd63332aa346d87785c56b8ff5e8911bf0228a22d8cf5c2
-  data.tar.gz: 4c6bce345c37c5b76b1563a204a7334cbaf99a1e4b34ac2fb88edcf143a1f67d91fef1f3fa16112faa403e644556c92154fa23a7f3c8bcdd45190fc4f042a369
+  metadata.gz: 608db9f87d437542fe683b336198f588c670d0632ce2733570156b253d9fd4514d4b8fefacb38db0d26ed9fac149b2bfc459ff9779334bff8fa08ec103722fde
+  data.tar.gz: 157550825a76be4dd00a8419c001404ef0ad86406340131893a3ac7be473e7cf397da8434b4a841b6dc7f9968eceb93fdbd5f729b23c52c785725be0c1516c77

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,98 @@
 
 ## master
 
+## 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
+
+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

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/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
 
@@ -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/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/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/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

@@ -287,7 +287,20 @@ class Thread < Object
 
   def group: () -> ThreadGroup?
 
-  def initialize: (*untyped args) -> Thread
+  # Creates a new thread executing the given block.
+  #
+  # Any `args` given to ::new will be passed to the block:
+  #
+  #     arr = []
+  #     a, b, c = 1, 2, 3
+  #     Thread.new(a,b,c) { |d,e,f| arr << d << e << f }.join
+  #     arr #=> [1, 2, 3]
+  #
+  # A ThreadError exception is raised if ::new is called without a block.
+  #
+  # If you're going to subclass Thread, be sure to call super in your `initialize`
+  # method, otherwise a ThreadError will be raised.
+  def initialize: (*untyped) { (*untyped) -> void } -> void
 
   # The calling thread will suspend execution and run this `thr` .
   #
@@ -829,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.