rbs 0.12.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f566c8a8b046574b66d406b1d049d982867b31e551e3faf85a3afde6ed85916
-  data.tar.gz: 0aa60fd17edfe999f4c9d8460d0aaed46a24424cdde490ac767ee6b54d192d26
+  metadata.gz: 5348f41dbf169228104d4ba79ad88098ec3e8e83656b48b0b1c5877fab2e8cb7
+  data.tar.gz: c79ce48144a85642f974b0973e22f8ed97a072d98ce98e2b62aebf639c8d04f7
 SHA512:
-  metadata.gz: 997754b8a0f57c831357f08e37ef93219bf75c60d1ce270232989c7c485a42c42fc5f2fdf88ecf002e2d78b56ccdccdd60ec437dc0e0a6616d15a492cf77af23
-  data.tar.gz: f1fe9f1e6a33b259e4e8eb407bcd6019a24b40eed427992658ff728d5cad9d68b26054058de7840caa589dc796dc44f10003823ff8752d28827b26f27a44ca76
+  metadata.gz: efb99d0e6476b83dbd1994a71526adab4b5b6aab2fc231a1685407739bb9a3e2f1268fb3effcbe701fa033608a0b872fd3f0011d046c599457bf47a3c3fcdb97
+  data.tar.gz: 87d13112f6abce7b7ead4e95302978d17c7c08eaf94485bf27c00c5d91e08f8c10458344661b73d518caff095787323d3694512d76796f2d20da8c2bad2e101f

data/.github/workflows/ruby.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - master-nightly-bionic 
+        - master-nightly-bionic
         - 2.6.5-bionic
         - 2.7.0-bionic
         job:

data/.gitignore

@@ -6,7 +6,6 @@
 /spec/reports/
 /tmp/
 /.ruby-version
-/lib/rbs/parser.rb
 /lib/rbs/parser.output
 /vendor/sigs
 /Gemfile.lock

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 ## master
 
+## 0.15.0 (2020-11-2)
+
+* Signature updates for `Kernel`, `PStore`, `Enumerable`, and `Array` ([#450](https://github.com/ruby/rbs/pull/450), [#443](https://github.com/ruby/rbs/pull/443), [#438](https://github.com/ruby/rbs/pull/438), [#437](https://github.com/ruby/rbs/pull/437), [#433](https://github.com/ruby/rbs/pull/433), [#432](https://github.com/ruby/rbs/pull/432))
+* Add helper interfaces ([#434](https://github.com/ruby/rbs/pull/434), [#428](https://github.com/ruby/rbs/pull/428))
+* Change `bool` type semantics ([#456](https://github.com/ruby/rbs/pull/456))
+* Support alias in `rbs prototype rb` ([#457](https://github.com/ruby/rbs/pull/457))
+* Runtime testing improvements ([#455](https://github.com/ruby/rbs/pull/455), [#447](https://github.com/ruby/rbs/pull/447), [#444](https://github.com/ruby/rbs/pull/444), [#431](https://github.com/ruby/rbs/pull/431))
+* Fix proc type parsing ([#451](https://github.com/ruby/rbs/pull/451))
+* Fix type variable parsing ([#442](https://github.com/ruby/rbs/pull/442))
+
+
+## 0.14.0 (2020-10-17)
+
+* Allow keyword names ending with `?` and `!` ([#417](https://github.com/ruby/rbs/pull/417))
+* Make `Range[T]` covariant ([#418](https://github.com/ruby/rbs/pull/418))
+
+## 0.13.1 (2020-10-09)
+
+* Fix test for CI of ruby/ruby ([#412](https://github.com/ruby/rbs/pull/412))
+
+## 0.13.0 (2020-10-09)
+
+* Signature updates for `URI` classes.
+* Fix tests ([#410](https://github.com/ruby/rbs/pull/410))
+* Add `--silent` option for `rbs validate` ([#411](https://github.com/ruby/rbs/pull/411))
+
+## 0.12.2 (2020-09-17)
+
+* Minor signature update for `pty`
+* Fix `PTY` stdlib test
+
 ## 0.12.1 (2020-09-16)
 
 This version is to improve Ruby 3 testing compatibility. Nothing changed for users.

data/Gemfile

@@ -19,3 +19,6 @@ gem "goodcheck"
 # Test gems
 gem "rbs-amber", path: "test/assets/test-gem"
 
+group :ide, optional: true do
+  gem "ruby-debug-ide"
+end

data/README.md

@@ -74,7 +74,7 @@ $ rbs method Object then
 
 ## Library
 
-There are two important concepts, _environment_ and _definition_. 
+There are two important concepts, _environment_ and _definition_.
 
 An _environment_ is a dictionary that keeps track of all declarations. What is the declaration associated with `String` class? An _environment_ will give you the answer.
 
@@ -104,8 +104,14 @@ builder = RBS::DefinitionBuilder.new(env: environment)
 
 # Definition of instance of String
 instance = builder.build_instance(string)
-# Print the types of `gsub` method
+
+# Print the types of `gsub` method:
 puts instance.methods[:gsub].method_types.join("\n")
+# Ouputs =>
+#  (::Regexp | ::string pattern, ::string replacement) -> ::String
+#  (::Regexp | ::string pattern, ::Hash[::String, ::String] hash) -> ::String
+#  (::Regexp | ::string pattern) { (::String match) -> ::_ToS } -> ::String
+#  (::Regexp | ::string pattern) -> ::Enumerator[::String, self]
 
 # Definition of singleton of String
 singleton = builder.build_singleton(string)

data/Rakefile

@@ -25,11 +25,11 @@ task :test_doc => :parser do
 end
 
 task :validate => :parser do
-  sh "#{ruby} #{rbs} validate"
+  sh "#{ruby} #{rbs} validate --silent"
 
   FileList["stdlib/*"].each do |path|
     next if path =~ %r{stdlib/builtin}
-    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate"
+    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate --silent"
   end
 end
 

data/Steepfile

@@ -1,6 +1,7 @@
 target :lib do
   signature "sig"
   check "lib"
+  ignore "lib/rbs/parser.rb"
 
   vendor stdlib: "stdlib"
   library "set", "pathname", "json", "logger"

data/bin/annotate-with-rdoc

@@ -14,7 +14,7 @@ def format_comment(comment)
   out = RDoc::Markup::Document.new
   out << comment
   formatter = RDoc::Markup::ToMarkdown.new
-  out.accept(formatter)
+  out.accept(formatter).lines.map(&:rstrip).join("\n")
 end
 
 def comment_for_constant(decl, stores:)

data/bin/setup

@@ -6,5 +6,3 @@ set -vx
 bundle install --jobs 4 --retry 3
 
 # Do any other automated setup that you need to do here
-
-bundle exec rake parser

data/docs/CONTRIBUTING.md

@@ -17,6 +17,7 @@
     - Use `rbs prototype runtime --merge CLASS_NAME` command to generate the missing method definitions.
     - Committing the auto generated signatures is recommended.
 5. Annotate with RDoc.
+    - You'll need RDoc installed. Rvm users should use `rvm docs generate` first.
     - Use `bin/annotate-with-rdoc stdlib/path/to/signature.rbs` to annotate the RBS files.
     - Committing the generated annotations is recommended.
 6. Fix method types and comments.

data/docs/syntax.md

@@ -179,7 +179,7 @@ Proc type denotes type of procedures, `Proc` instances.
 
 `instance` denotes the type of instance of the class. `class` is the singleton of the class.
 
-`bool` is an abstract type for truth value.
+`bool` is an alias of `true | false`.
 
 `untyped` is for _a type without type checking_. It is `?` in gradual typing, _dynamic_ in some languages like C#, and _any_ in TypeScript. It is both subtype _and_ supertype of all of the types. (The type was `any` but renamed to `untyped`.)
 
@@ -193,15 +193,34 @@ Proc type denotes type of procedures, `Proc` instances.
 
 We recommend using `nil`.
 
-#### `bool` or `TrueClass | FalseClass`
+#### `bool` or `boolish`
 
-We recommend using `bool` because it is more close to Ruby's semantics. If the type of a parameter of a method is `bool`, we usually pass `true` and `false`, and also `nil` or any other values. `TrueClass | FalseClass` rejects other values than `true` and `false`.
+We have a builtin type alias called `boolish`.
+It is an alias of `top` type, and you can use `boolish` if we want to allow any object of any type.
 
-#### `void`, `bool`, or `top`?
+We can see an example at the definition of `Enumerable#find`:
+
+```
+module Enumerable[Elem, Return]
+  def find: () { (Elem) -> boolish } -> Elem?
+  ...
+end
+```
+
+We want to write something like:
+
+```
+array.find {|x| x && x.some_test? }               # The block will return (bool | nil)
+```
+
+We recommend using `boolish` for method arguments and block return values, if you only use the values for conditions.
+You can write `bool` if you strictly want `true | false`.
+
+#### `void`, `boolish`, or `top`?
 
 They are all equivalent for the type system; they are all _top type_.
 
-`void` tells developers a hint that _the value should not be used_. `bool` implies the value is used as a truth value. `top` is anything else.
+`void` tells developers a hint that _the value should not be used_. `boolish` implies the value is used as a truth value. `top` is anything else.
 
 ## Method Types
 
@@ -433,8 +452,10 @@ _global-name_ ::= /$[a-zA-Z]\w+/ | ...
 _module-type-parameters_ ::=                                                  # Empty
                            | `[` _module-type-parameter_ `,` ... `]`
 
-_module-type-parameter_ ::= _variance_ _type-variable_
+_module-type-parameter_ ::= _check_ _variance_ _type-variable_
 _variance_ ::= `out` | `in`
+_check_ ::= # Empty
+          | `unchecked`
 ```
 
 ### Class declaration
@@ -448,6 +469,29 @@ class Ref[A] < Object
 end
 ```
 
+For classes with type parameters, you may specify if they are "invariant" (default), "covariant" (`out`) or "contravariant" (`in`). See [this definition of covariance and contravariance](https://en.wikipedia.org/wiki/Covariance_and_contravariance_(computer_science)).
+
+For example, an `Array` of `String` can almost be considered to be an `Array` of `Object`, but not the reverse, so we can think of:
+
+```
+class Array[out T]
+  # ...
+end
+```
+
+There's a limitation with this is for mutable objects (like arrays): a mutation could invalidate this.
+If an array of String is passed to a method as an array of Objects, and that method adds an Integer to the array, the promise is broken.
+
+In those cases, one must use the `unchecked` keyword:
+
+```
+class Array[unchecked out T]
+  # ...
+end
+```
+
+This is how `Array` is actually defined in RBS.
+
 ### Module declaration
 
 Module declaration takes optional _self type_ parameter, which defines a constraint about a class when the module is mixed.

data/goodcheck.yml

@@ -6,12 +6,12 @@ rules:
       - "stdlib/**/*.rbs"
     fail:
       - |
-        # arglists 💪👽🚨 << Delete this section   
-        #    File.absolute_path?(file_name)  ->  true or false    
+        # arglists 💪👽🚨 << Delete this section
+        #    File.absolute_path?(file_name)  ->  true or false
         #
 
   - id: rbs.no_arg
-    pattern: 
+    pattern:
       regexp: arg\d+
     message: |
       Stop using parameter names like `arg0` or `arg1`
@@ -23,7 +23,7 @@ rules:
       - Documents (comments) may contain that pattern.
     glob:
       - "stdlib/**/*.rbs"
-    fail: 
+    fail:
       - "def `send`: (String | Symbol arg0, *untyped arg1) -> untyped"
     pass:
       - "def `send`: (String | Symbol, *untyped) -> untyped"
@@ -62,4 +62,21 @@ rules:
           end
         end
 
-
+  - id: no_trailing_whitespace
+    pattern:
+      regexp: '[ \t]+$'
+    message: |
+      Trim trailing whitespaces
+    glob:
+      - '**/*.rb'
+      - '**/*.rbs'
+      - '**/*.md'
+    justification:
+      - Let the maintainers know if it is an autogenerated files.
+    pass:
+      - "Hello world"
+      - "Hello\nworld"
+      - "Hello\n\nworld"
+    fail:
+      - "Hello world  "
+      - "Hello \nworld"

data/lib/rbs/ast/comment.rb

@@ -23,7 +23,7 @@ module RBS
         { string: string, location: location }.to_json(*a)
       end
 
-      def concat(string:, location:)  
+      def concat(string:, location:)
         @string.concat string
 
         if loc = @location

data/lib/rbs/cli.rb

@@ -1,3 +1,4 @@
+require "open3"
 require "optparse"
 require "shellwords"
 
@@ -383,6 +384,11 @@ Examples:
 
   $ rbs validate
 EOU
+
+        opts.on("--silent") do
+          require "stringio"
+          @stdout = StringIO.new
+        end
       end.parse!(args)
 
       loader = EnvironmentLoader.new()
@@ -488,7 +494,7 @@ Show paths to directories where the RBS files are loaded from.
 Examples:
 
   $ rbs paths
-  $ tbs -r set paths
+  $ rbs -r set paths
 EOU
       end.parse!(args)
 
@@ -543,7 +549,7 @@ EOU
 Usage: rbs prototype runtime [options...] [pattern...]
 
 Generate RBS prototype based on runtime introspection.
-It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern]. 
+It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern].
 
 Examples:
 
@@ -808,8 +814,10 @@ EOB
         'RBS_TEST_TARGET' => (targets.join(',') unless targets.empty?)
       }
 
-      system(env_hash, *args)
-      $?
+      out, err, status = Open3.capture3(env_hash, *args)
+      stdout.print(out)
+      stderr.print(err)
+      status
     end
   end
 end

data/lib/rbs/constant.rb

@@ -2,7 +2,7 @@ module RBS
   class Constant
     attr_reader :name
     attr_reader :type
-    attr_reader :declaration
+    attr_reader :entry
 
     def initialize(name:, type:, entry:)
       @name = name

data/lib/rbs/constant_table.rb

@@ -47,6 +47,8 @@ module RBS
 
       head, *tail = split_name(name)
 
+      raise unless head
+
       head_constant = case
                       when name.absolute?
                         name_to_constant(TypeName.new(name: head, namespace: Namespace.root))
@@ -57,11 +59,13 @@ module RBS
                           resolve_constant_reference_inherit(head, scopes: constant_scopes(context.first.to_type_name))
                       end
 
-      if head_constant
-        tail.inject(head_constant) do |constant, name|
-          resolve_constant_reference_inherit name,
-                                             scopes: constant_scopes(constant.name),
-                                             no_object: constant.name != BuiltinNames::Object.name
+      tail.inject(head_constant) do |constant, name|
+        if constant
+          resolve_constant_reference_inherit(
+            name,
+            scopes: constant_scopes(constant.name),
+            no_object: constant.name != BuiltinNames::Object.name
+          )
         end
       end
     end
@@ -150,9 +154,6 @@ module RBS
       when Environment::ModuleEntry
         constant_scopes0 BuiltinNames::Module.name, scopes: scopes
         constant_scopes_module name, scopes: scopes
-
-      else
-        raise "Unexpected declaration: #{name} (#{entry.class})"
       end
 
       scopes

data/lib/rbs/definition_builder.rb

@@ -40,7 +40,7 @@ module RBS
           if s = super_class
             yield s
           end
-          
+
           self_types&.each(&block)
           included_modules&.each(&block)
           prepended_modules&.each(&block)
@@ -303,7 +303,7 @@ module RBS
             mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
             ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
           end
-        end  
+        end
       end
 
       ancestors.unshift(self_ancestor)
@@ -316,7 +316,7 @@ module RBS
             mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
             ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
           end
-        end  
+        end
       end
 
       building_ancestors.pop
@@ -814,8 +814,7 @@ module RBS
 
       methods.each do |name, method|
         method.method_types.each do |method_type|
-          case method_type
-          when MethodType
+          unless name == :initialize
             result = calculator.in_method_type(method_type: method_type, variables: param_names)
 
             validate_params_with type_params, result: result do |param|
@@ -941,8 +940,8 @@ module RBS
                   Definition::Method::TypeDef.new(
                     type: method_type,
                     member: initialize_def.member,
-                    defined_in: nil,
-                    implemented_in: nil
+                    defined_in: initialize_def.defined_in,
+                    implemented_in: initialize_def.implemented_in
                   )
                 end,
                 accessibility: :public,

data/lib/rbs/environment.rb

@@ -13,7 +13,7 @@ module RBS
       def context
         @context ||= begin
                        (outer + [decl]).each.with_object([Namespace.root]) do |decl, array|
-                         first = array.first or raise 
+                         first = array.first or raise
                          array.unshift(first + decl.name.to_namespace)
                        end
                      end
@@ -258,6 +258,8 @@ module RBS
                 outer: outer_,
                 prefix: prefix_
               )
+            else
+              raise
             end
           end,
           location: decl.location,
@@ -288,6 +290,8 @@ module RBS
                 outer: outer_,
                 prefix: prefix_
               )
+            else
+              raise
             end
           end,
           location: decl.location,