rbs 3.1.3 → 3.2.0.pre.1

data/core/module.rbs

@@ -235,7 +235,7 @@ class Module < Object
   #
   #     Exiting with code 99
   #
-  def alias_method: (::Symbol | ::String new_name, ::Symbol | ::String old_name) -> ::Symbol
+  def alias_method: (id new_name, id old_name) -> ::Symbol
 
   # <!--
   #   rdoc-file=object.c
@@ -284,7 +284,7 @@ class Module < Object
   #     end
   #     Mod.instance_methods.sort   #=> [:one, :one=, :two, :two=]
   #
-  def attr_accessor: (*Object::name arg0) -> Array[Symbol]
+  def attr_accessor: (*id arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -298,7 +298,7 @@ class Module < Object
   # in turn. String arguments are converted to symbols. Returns an array of
   # defined method names as symbols.
   #
-  def attr_reader: (*Object::name arg0) -> Array[Symbol]
+  def attr_reader: (*id arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -309,7 +309,7 @@ class Module < Object
   # *symbol*`.id2name`. String arguments are converted to symbols. Returns an
   # array of defined method names as symbols.
   #
-  def attr_writer: (*Object::name arg0) -> Array[Symbol]
+  def attr_writer: (*id arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=load.c
@@ -328,7 +328,7 @@ class Module < Object
   # replaced with *filename*.  If *const* is defined but not as autoload, does
   # nothing.
   #
-  def autoload: (Symbol _module, String filename) -> NilClass
+  def autoload: (id _module, String filename) -> NilClass
 
   # <!--
   #   rdoc-file=load.c
@@ -354,7 +354,7 @@ class Module < Object
   #     B.autoload?(:CONST)          #=> "const.rb", found in A (ancestor)
   #     B.autoload?(:CONST, false)   #=> nil, not found in B itself
   #
-  def autoload?: (Symbol name, ?boolish inherit) -> String?
+  def autoload?: (id name, ?boolish inherit) -> String?
 
   # <!-- rdoc-file=vm_eval.c -->
   # Evaluates the string or block in the context of *mod*, except that when a
@@ -412,7 +412,7 @@ class Module < Object
   #     Fred.class_variable_defined?(:@@foo)    #=> true
   #     Fred.class_variable_defined?(:@@bar)    #=> false
   #
-  def class_variable_defined?: (Symbol | String arg0) -> bool
+  def class_variable_defined?: (id arg0) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -428,7 +428,7 @@ class Module < Object
   #     end
   #     Fred.class_variable_get(:@@foo)     #=> 99
   #
-  def class_variable_get: (Symbol | String arg0) -> untyped
+  def class_variable_get: (id arg0) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -447,7 +447,7 @@ class Module < Object
   #     Fred.class_variable_set(:@@foo, 101)     #=> 101
   #     Fred.new.foo                             #=> 101
   #
-  def class_variable_set: (Symbol | String arg0, untyped arg1) -> untyped
+  def class_variable_set: (id arg0, untyped arg1) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -527,7 +527,7 @@ class Module < Object
   #
   #     Hash.const_defined? 'foobar'   #=> NameError: wrong constant name foobar
   #
-  def const_defined?: (Symbol | String name, ?boolish inherit) -> bool
+  def const_defined?: (id name, ?boolish inherit) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -566,7 +566,7 @@ class Module < Object
   #
   #     Object.const_get 'foobar' #=> NameError: wrong constant name foobar
   #
-  def const_get: (Symbol | String name, ?boolish inherit) -> untyped
+  def const_get: (id name, ?boolish inherit) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -618,7 +618,7 @@ class Module < Object
   #
   #     Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar
   #
-  def const_set: (Symbol | String arg0, untyped arg1) -> untyped
+  def const_set: (id arg0, untyped arg1) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -668,7 +668,7 @@ class Module < Object
   #     p Object.const_source_location('A::C1')   # => ["test.rb", 2]  -- nesting is supported
   #     p Object.const_source_location('String')  # => []  -- constant is defined in C code
   #
-  def const_source_location: (Symbol | String name, ?boolish inherit) -> ([ String, Integer ] | [ ] | nil)
+  def const_source_location: (id name, ?boolish inherit) -> ([ String, Integer ] | [ ] | nil)
 
   # <!--
   #   rdoc-file=object.c
@@ -726,8 +726,8 @@ class Module < Object
   #     I'm Dino!
   #     #<B:0x401b39e8>
   #
-  def define_method: (Symbol | String arg0, ?Proc | Method | UnboundMethod arg1) -> Symbol
-                   | (Symbol | String arg0) { () -> untyped } -> Symbol
+  def define_method: (id symbol, Proc | Method | UnboundMethod method) -> Symbol
+                   | (id symbol) { () -> untyped } -> Symbol
 
   # <!--
   #   rdoc-file=object.c
@@ -746,7 +746,7 @@ class Module < Object
   #     HTTP::NOT_FOUND
   #     # warning: constant HTTP::NOT_FOUND is deprecated
   #
-  def deprecate_constant: (*Symbol) -> self
+  def deprecate_constant: (*id) -> self
 
   def eql?: (untyped other) -> bool
 
@@ -936,7 +936,7 @@ class Module < Object
   #
   #     Hello there, Dave!
   #
-  def instance_method: (Symbol arg0) -> UnboundMethod
+  def instance_method: (id arg0) -> UnboundMethod
 
   # <!--
   #   rdoc-file=object.c
@@ -1029,7 +1029,7 @@ class Module < Object
   #     C.method_defined? "method4"             #=> false
   #     C.method_defined? "private_method2"     #=> false
   #
-  def method_defined?: (Symbol | String name, ?boolish inherit) -> bool
+  def method_defined?: (id name, ?boolish inherit) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -1147,7 +1147,7 @@ class Module < Object
   #     Mod.one     #=> "This is one"
   #     c.call_one  #=> "This is the new one"
   #
-  def module_function: (*Symbol | String arg0) -> self
+  def module_function: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1246,7 +1246,7 @@ class Module < Object
   #       end
   #     end
   #
-  def private_class_method: (*Symbol | String arg0) -> self
+  def private_class_method: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1254,7 +1254,7 @@ class Module < Object
   # -->
   # Makes a list of existing constants private.
   #
-  def private_constant: (*Symbol arg0) -> self
+  def private_constant: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1301,7 +1301,7 @@ class Module < Object
   #     C.private_method_defined? "method2", false   #=> false
   #     C.method_defined? "method2"                  #=> false
   #
-  def private_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
+  def private_method_defined?: (id name, ?boolish inherit) -> bool
 
   # <!--
   #   rdoc-file=vm_method.c
@@ -1365,7 +1365,7 @@ class Module < Object
   #     C.protected_method_defined? "method2", false  #=> false
   #     C.method_defined? "method2"                   #=> true
   #
-  def protected_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
+  def protected_method_defined?: (id name, ?boolish inherit) -> bool
 
   # <!--
   #   rdoc-file=vm_method.c
@@ -1398,7 +1398,7 @@ class Module < Object
   # String arguments are converted to symbols. An Array of Symbols and/or Strings
   # is also accepted.
   #
-  def public_class_method: (*Symbol | String arg0) -> self
+  def public_class_method: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1406,7 +1406,7 @@ class Module < Object
   # -->
   # Makes a list of existing constants public.
   #
-  def public_constant: (*Symbol arg0) -> self
+  def public_constant: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=proc.c
@@ -1414,7 +1414,7 @@ class Module < Object
   # -->
   # Similar to *instance_method*, searches public method only.
   #
-  def public_instance_method: (Symbol arg0) -> UnboundMethod
+  def public_instance_method: (id arg0) -> UnboundMethod
 
   # <!--
   #   rdoc-file=object.c
@@ -1453,7 +1453,7 @@ class Module < Object
   #     C.public_method_defined? "method2"         #=> false
   #     C.method_defined? "method2"                #=> true
   #
-  def public_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
+  def public_method_defined?: (id name, ?boolish inherit) -> bool
 
   # <!--
   #   rdoc-file=eval.c
@@ -1505,7 +1505,7 @@ class Module < Object
   #     99
   #     nil
   #
-  def remove_class_variable: (Symbol arg0) -> untyped
+  def remove_class_variable: (id arg0) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -1515,7 +1515,7 @@ class Module < Object
   # previous value.  If that constant referred to a module, this will not change
   # that module's name and can lead to confusion.
   #
-  def remove_const: (Symbol arg0) -> untyped
+  def remove_const: (id arg0) -> untyped
 
   # <!--
   #   rdoc-file=vm_method.c
@@ -1525,7 +1525,7 @@ class Module < Object
   # Removes the method identified by *symbol* from the current class. For an
   # example, see Module#undef_method. String arguments are converted to symbols.
   #
-  def remove_method: (*Symbol | String arg0) -> self
+  def remove_method: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1591,7 +1591,7 @@ class Module < Object
   #     In parent
   #     prog.rb:23: undefined method `hello' for #<Child:0x401b3bb4> (NoMethodError)
   #
-  def undef_method: (*Symbol | String arg0) -> self
+  def undef_method: (*id arg0) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -1629,5 +1629,7 @@ class Module < Object
   # `attr_reader(name)` but deprecated. Returns an array of defined method names
   # as symbols.
   #
-  def attr: (*Object::name arg0) -> Array[Symbol]
+  def attr: (*id arg0) -> Array[Symbol]
+
+  type id = Symbol | string
 end

data/core/object.rbs

@@ -205,7 +205,7 @@ class Object < BasicObject
   #     chris.define_singleton_method(:greet) {|greeting| "#{greeting}, I'm Chris!" }
   #     chris.greet("Hi") #=> "Hi, I'm Chris!"
   #
-  def define_singleton_method: (name, Method | UnboundMethod) -> Symbol
+  def define_singleton_method: (name, Method | UnboundMethod | Proc method) -> Symbol
                              | (name) { (*untyped) -> untyped } -> Symbol
 
   # <!--
@@ -320,7 +320,7 @@ class Object < BasicObject
   #     enum.first(4) # => [1, 1, 1, 2]
   #     enum.size # => 42
   #
-  def enum_for: (Symbol method, *untyped args) ?{ (*untyped args) -> Integer } -> Enumerator[untyped, untyped]
+  def enum_for: (Symbol method, *untyped, **untyped) ?{ (*untyped, **untyped) -> Integer } -> Enumerator[untyped, untyped]
               | () ?{ () -> Integer } -> Enumerator[untyped, self]
 
   # <!--

data/core/string_io.rbs

@@ -495,6 +495,15 @@ class StringIO
   #
   def tell: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/stringio/stringio.c
+  #   - strio.truncate(integer)    -> 0
+  # -->
+  # Truncates the buffer string to at most *integer* bytes. The stream must be
+  # opened for writing.
+  #
+  def truncate: (Integer) -> 0
+
   # <!-- rdoc-file=ext/stringio/stringio.c -->
   # Returns `false`.  Just for compatibility to IO.
   #

data/core/thread.rbs

@@ -971,6 +971,30 @@ class Thread < Object
   #
   def self.handle_interrupt: (untyped hash) -> untyped
 
+  # <!--
+  #   rdoc-file=thread.c
+  #   - thr.raise
+  #   - thr.raise(string)
+  #   - thr.raise(exception [, string [, array]])
+  # -->
+  # Raises an exception from the given thread. The caller does not have to be
+  # `thr`. See Kernel#raise for more information.
+  #
+  #     Thread.abort_on_exception = true
+  #     a = Thread.new { sleep(200) }
+  #     a.raise("Gotcha")
+  #
+  # This will produce:
+  #
+  #     prog.rb:3: Gotcha (RuntimeError)
+  #      from prog.rb:2:in `initialize'
+  #      from prog.rb:2:in `new'
+  #      from prog.rb:2
+  #
+  def self?.raise: () -> bot
+                 | (String message, ?cause: Exception?) -> bot
+                 | (_Exception exception, ?untyped message, ?::Array[String] backtrace, ?cause: Exception?) -> bot
+
   # <!--
   #   rdoc-file=thread.c
   #   - Thread.kill(thread)   -> thread
@@ -1414,7 +1438,7 @@ class Thread::ConditionVariable < Object
   #
   # Returns the slept result on `mutex`.
   #
-  def wait: (Thread::Mutex mutex, ?Integer timeout) -> self
+  def wait: (Thread::Mutex mutex, ?Integer | Float? timeout) -> self
 end
 
 # <!-- rdoc-file=thread_sync.c -->

data/core/time.rbs

@@ -1093,7 +1093,7 @@ class Time < Object
   #
   # Related: Time#ceil, Time#floor.
   #
-  def round: (?Integer arg0) -> Time
+  def round: (?int ndigits) -> Time
 
   # <!--
   #   rdoc-file=time.c
@@ -1503,7 +1503,7 @@ class Time < Object
   #
   # Related: Time#ceil, Time#round.
   #
-  def floor: (?Integer ndigits) -> Time
+  def floor: (?int ndigits) -> Time
 
   # <!--
   #   rdoc-file=time.c
@@ -1530,7 +1530,7 @@ class Time < Object
   #
   # Related: Time#floor, Time#round.
   #
-  def ceil: (?Integer ndigits) -> Time
+  def ceil: (?int ndigits) -> Time
 end
 
 Time::RFC2822_DAY_NAME: Array[String]

data/docs/CONTRIBUTING.md

@@ -69,7 +69,7 @@ We define the standard members order so that ordering doesn't bother reading dif
 5. `public` & public instance methods
 6. `private` & private instance methods
 
-```
+```rbs
 class HelloWorld[X]
   def self.new: [A] () { (void) -> A } -> HelloWorld[A]         # new or initialize comes first
   def initialize: () -> void

data/docs/rbs_by_example.md

@@ -6,20 +6,20 @@ The purpose of this doc is to teach you how to write RBS signatures by using the
 
 ## Examples
 
+In each example, the first snippet is for *Ruby* and the second one is for *RBS*.
+
 ### Zero argument methods
 
 **Example:** `String#empty?`
 
 ```ruby
-# .rb
 "".empty?
 # => true
 "hello".empty?
 # => false
 ```
 
-```ruby
-# .rbs
+```rbs
 class String
   def empty?: () -> bool
 end
@@ -32,14 +32,13 @@ end
 **Example:** `String#include?`
 
 ```ruby
-# .rb
 "homeowner".include?("house")
 # => false
 "homeowner".include?("meow")
 # => true
 ```
 
-```ruby
+```rbs
 class String
   def include?: (String) -> bool
 end
@@ -53,7 +52,6 @@ boolean value
 **Example:** `String#end_with?`
 
 ```ruby
-# .rb
 "hello?".end_with?("!")
 # => false
 "hello?".end_with?("?")
@@ -64,8 +62,7 @@ boolean value
 # => false
 ```
 
-```ruby
-# .rbs
+```rbs
 class String
   def end_with?: (*String) -> bool
 end
@@ -79,7 +76,6 @@ returns a boolean value.
 **Example:** `String#ljust`
 
 ```ruby
-# .rb
 "hello".ljust(4)
 #=> "hello"
 "hello".ljust(20)
@@ -88,8 +84,7 @@ returns a boolean value.
 #=> "hello123412341234123"
 ```
 
-```ruby
-# .rbs
+```rbs
 class String
   def ljust: (Integer, ?String) -> String
 end
@@ -102,7 +97,6 @@ end
 **Example:** `Array#*`
 
 ```ruby
-# .rb
 [1, 2, 3] * ","
 # => "1,2,3"
 [1, 2, 3] * 2
@@ -112,8 +106,7 @@ end
 *Note:* Some of the signatures after this point include type variables (e.g. `Elem`, `T`).
 For now, it's safe to ignore them, but they're included for completeness.
 
-```ruby
-# .rbs
+```rbs
 class Array[Elem]
   def *: (String) -> String
        | (Integer) -> Array[Elem]
@@ -128,7 +121,6 @@ end
 **Example:** `String#<<`
 
 ```ruby
-# .rb
 a = "hello "
 a << "world"
 #=> "hello world"
@@ -136,8 +128,7 @@ a << 33
 #=> "hello world!"
 ```
 
-```ruby
-# .rbs
+```rbs
 class String
   def <<: (String | Integer) -> String
 end
@@ -148,7 +139,6 @@ end
 ### Nilable types
 
 ```ruby
-# .rb
 [1, 2, 3].first
 # => 1
 [].first
@@ -159,8 +149,7 @@ end
 # => []
 ```
 
-```ruby
-# .rbs
+```rbs
 class Enumerable[Elem]
   def first: () -> Elem?
            | (Integer) -> Array[Elem]
@@ -183,7 +172,6 @@ The `?` syntax is a convenient shorthand for a union with nil. An equivalent uni
 **Example**: `String#lines`
 
 ```ruby
-# .rb
 "hello\nworld\n".lines
 # => ["hello\n", "world\n"]
 "hello  world".lines(' ')
@@ -192,8 +180,7 @@ The `?` syntax is a convenient shorthand for a union with nil. An equivalent uni
 # => ["hello", "world"]
 ```
 
-```ruby
-# .rbs
+```rbs
 class String
   def lines: (?String, ?chomp: bool) -> Array[String]
 end
@@ -209,12 +196,11 @@ Keyword arguments are declared similar to in ruby, with the keyword immediately
 **Example**: `Time.now`
 
 ```ruby
-# .rb
 Time.now
 # => 2009-06-24 12:39:54 +0900
 ```
 
-```ruby
+```rbs
 class Time
   def self.now: () -> Time
 end
@@ -228,7 +214,6 @@ end
 **Example**: `Array#filter`
 
 ```ruby
-# .rb
 [1,2,3,4,5].filter {|num| num.even? }
 # => [2, 4]
 %w[ a b c d e f ].filter {|v| v =~ /[aeiou]/ }
@@ -236,8 +221,7 @@ end
 [1,2,3,4,5].filter
 ```
 
-```ruby
-# .rbs
+```rbs
 class Array[Elem]
   def filter: () { (Elem) -> boolish } -> ::Array[Elem]
             | () -> ::Enumerator[Elem, ::Array[Elem]]
@@ -260,8 +244,7 @@ h.keys
 # => ["a", "b", "c", "d"]
 ```
 
-```ruby
-# .rbs
+```rbs
 class Hash[K, V]
   def keys: () -> Array[K]
 end
@@ -273,7 +256,6 @@ Generic types in RBS are parameterized at declaration time. These type variables
 
 
 ```ruby
-# .rb
 a = [ "a", "b", "c", "d" ]
 a.collect {|x| x + "!"}
 # => ["a!", "b!", "c!", "d!"]
@@ -281,8 +263,7 @@ a.collect.with_index {|x, i| x * i}
 # => ["", "b", "cc", "ddd"]
 ```
 
-```ruby
-# .rbs
+```rbs
 class Array[Elem]
   def collect: [U] () { (Elem) -> U } -> Array[U]
              | () -> Enumerator[Elem, Array[untyped]]
@@ -302,7 +283,7 @@ In this example, the method receives its signature from the inferred return type
 # => [[2, 4, 6], [1, 3, 5]]
 ```
 
-```ruby
+```rbs
 class Enumerable[Elem]
   def partition: () { (Elem) -> boolish } -> [Array[Elem], Array[Elem]]
                | () -> ::Enumerator[Elem, [Array[Elem], Array[Elem] ]]
@@ -318,7 +299,7 @@ Tuples can be of any size, and they can have mixed types.
 # => {1=>1, 2=>4, 3=>9, 4=>16, 5=>25}
 ```
 
-```ruby
+```rbs
 class Enumerable[Elem]
   def to_h: () -> ::Hash[untyped, untyped]
           | [T, U] () { (Elem) -> [T, U] } -> ::Hash[T, U]

data/docs/repo.md

@@ -13,7 +13,7 @@ Assume there is a rubygem called `bug-free-doodle` and our application depends o
 
 One workaround is to add type definitions of the library in the application signatures.
 
-```
+```rbs
 # sig/polyfill/bug-free-doodle.rbs
 
 module Bug

data/docs/sigs.md

@@ -18,7 +18,7 @@ See [syntax guide](syntax.md).
 When you finish writing signature, you may want to test the signature.
 rbs provides a feature to test your signature.
 
-```
+```console
 $ RBS_TEST_TARGET='Foo::*' bundle exec ruby -r rbs/test/setup test/foo_test.rb
 ```
 
@@ -74,7 +74,7 @@ The `rbs` test framework tries to the best error message for overloaded methods
 
 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
+```rbs
 # First definition
 class C
   def foo: () -> untyped
@@ -99,14 +99,14 @@ The design of the signature testing aims to be non-intrusive. The setup is done
 You need to require `rbs/test/setup` for signature testing.
 You can do it using `-r` option through command line argument or the `RUBYOPT` environment variable.
 
-```
+```console
 $ ruby -r rbs/test/setup run_tests.rb
 $ RUBYOPT='-rrbs/test/setup' rake test
 ```
 
 When you are using Bundler, you may need to require `bundler/setup` explicitly.
 
-```
+```console
 $ RUBYOPT='-rbundler/setup -rrbs/test/setup' bundle exec rake test
 ```
 
@@ -130,7 +130,7 @@ You need to specify `RBS_TEST_TARGET` to run the test, and you can customize the
 You may need to specify `-r` or `-I` to load signatures.
 The default is `-I sig`.
 
-```
+```shell
 RBS_TEST_OPT='-r pathname -I sig'
 ```
 
@@ -144,7 +144,7 @@ You can see the backtrace how the type error is caused and debug your program or
 
 So, a typical command line to start the test would look like the following:
 
-```
+```console
 $ RBS_TEST_LOGLEVEL=error \
   RBS_TEST_TARGET='Kaigi::*' \
   RBS_TEST_SKIP='Kaigi::MonkeyPatch' \
@@ -160,7 +160,7 @@ $ RBS_TEST_LOGLEVEL=error \
 
 You can skip installing the instrumentation per-method basis using `rbs:test:skip` annotation.
 
-```
+```rbs
 class String
   %a{rbs:test:skip} def =~: (Regexp) -> Integer?
 end

data/docs/stdlib.md

@@ -10,7 +10,7 @@ We support writing tests for core/stdlib signatures.
 
 First, execute `generate:stdlib_test` rake task with a class name that you want to test.
 
-```bash
+```console
 $ bundle exec rake 'generate:stdlib_test[String]'
 Created: test/stdlib/String_test.rb
 ```
@@ -47,7 +47,6 @@ end
 class StringTest < Test::Unit::TestCase
   include TypeAssertions
 
-  # library "pathname", "set", "securerandom"     # Declare library signatures to load
   testing "::String"
 
   def test_gsub
@@ -83,7 +82,7 @@ If the execution of the program escape from the class definition, the instrument
 
 You can run the test with:
 
-```
+```console
 $ bundle exec rake stdlib_test                # Run all tests
 $ bundle exec ruby test/stdlib/String_test.rb # Run specific tests
 ```