rbs 1.7.0 → 2.0.0.pre1

data/sig/validator.rbs

@@ -1,14 +1,50 @@
 module RBS
   class Validator
     attr_reader env: Environment
+
     attr_reader resolver: TypeNameResolver
 
-    def initialize: (env: Environment, resolver: TypeNameResolver) -> void
+    attr_reader definition_builder: DefinitionBuilder
 
-    def absolute_type: (Types::t, context: TypeNameResolver::context) { (Types::t) -> TypeName } -> Types::t
+    attr_reader type_alias_dependency: TypeAliasDependency
+
+    attr_reader type_alias_regularity: TypeAliasRegularity
+
+    def initialize: (env: Environment, resolver: TypeNameResolver) -> void
 
+    # Validates the presence of type names and type application arity match.
+    #
     def validate_type: (Types::t, context: TypeNameResolver::context) -> void
 
+    # Validates type alias definition:
+    #
+    # - There is no circular definition between aliases
+    # - The type alias is _regular_
+    # - The generics type parameter variance annotation is consistent with respect to their usage
+    # - There is no circular dependencies between the generics type parameter bounds
+    #
     def validate_type_alias: (entry: Environment::SingleEntry[TypeName, AST::Declarations::Alias]) -> void
+
+    # Validates the type parameters in generic methods.
+    #
+    def validate_method_definition: (AST::Members::MethodDefinition, type_name: TypeName) -> void
+
+    # Validates the type parameters if there is no circular dependencies between the bounds.
+    #
+    # ```rbs
+    # [X, Y]                      # OK
+    # [X, Y < _Foo[X]]            # OK
+    # [X < _Foo[Y], Y]            # OK
+    # [X < _Foo[Y], Y < _Foo[X]]  # Error
+    # ```
+    #
+    def validate_type_params: (Array[AST::TypeParam] params, type_name: TypeName, ?method_name: Symbol?, location: Location[untyped, untyped]?) -> void
+
+    private
+
+    # Resolves relative type names to absolute type names in given context.
+    # Yields the type when the type name resolution using `#resolver` fails.
+    #
+    def absolute_type: (Types::t, context: TypeNameResolver::context) { (Types::t) -> TypeName } -> Types::t
   end
 end

data/sig/variance_calculator.rbs

@@ -1,7 +1,47 @@
 module RBS
+  # Calculate the use variances of type variables in declaration.
+  #
+  # ```rb
+  # calculator = VarianceCalculator.new(builder: builder)
+  #
+  # # Calculates variances in a method type
+  # result = calculator.in_method_type(method_type: method_type, variables: variables)
+  #
+  # # Calculates variances in a inheritance/mixin/...
+  # result = calculator.in_inherit(name: name, args: args, variables: variables)
+  #
+  # # Calculates variances in a type alias
+  # result = calculator.in_type_alias(name: name, args: args, variables: variables)
+  # ```
+  #
+  # See `RBS::VarianceCaluculator::Result` for information recorded in the `Result` object.
+  #
   class VarianceCalculator
     type variance = :unused | :covariant | :contravariant | :invariant
 
+    # Result contains the set of type variables and it's variance in a occurrence.
+    #
+    # ```rb
+    # # Enumerates recorded type variables
+    # result.each do |name, variance|
+    #   # name is the name of a type variable
+    #   # variance is one of :unused | :covariant | :contravariant | :invariant
+    # end
+    # ```
+    #
+    # You can test with `compatible?` method if the type variable occurrences are compatible with specified (annotated) variance.
+    #
+    # ```rb
+    # # When T is declared as `out T`
+    # result.compatible?(:T, with_annotation: :covariant)
+    #
+    # # When T is declared as `in T`
+    # result.compatible?(:T, with_annotation: :contravariant)
+    #
+    # # When T is declared as `T`
+    # result.compatible?(:T, with_annotation: :invariant)
+    # ```
+    #
     class Result
       attr_reader result: Hash[Symbol, variance]
 
@@ -18,6 +58,8 @@ module RBS
       def include?: (Symbol) -> bool
 
       def compatible?: (Symbol, with_annotation: variance) -> bool
+
+      def incompatible?: (Array[AST::TypeParam]) -> Set[Symbol]?
     end
 
     attr_reader builder: DefinitionBuilder
@@ -30,6 +72,14 @@ module RBS
 
     def in_inherit: (name: TypeName, args: Array[Types::t], variables: Array[Symbol]) -> Result
 
+    def in_type_alias: (name: TypeName) -> Result
+
+    private
+
     def type: (Types::t, result: Result, context: variance) -> void
+
+    def function: (Types::Function, result: Result, context: variance) -> void
+
+    def negate: (variance) -> variance
   end
 end

data/sig/writer.rbs

@@ -27,7 +27,7 @@ module RBS
 
     def write_member: (AST::Declarations::Module::member) -> void
 
-    def name_and_params: (TypeName, AST::Declarations::ModuleTypeParams) -> String?
+    def name_and_params: (TypeName, Array[AST::TypeParam]) -> String?
 
     def name_and_args: (TypeName, Array[Types::t]) -> String?
 

data/stdlib/bigdecimal-math/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: bigdecimal

data/stdlib/csv/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: forwardable

data/stdlib/date/0/date.rbs

@@ -446,7 +446,7 @@ class Date
   #     DateTime.jd(0,12) + DateTime.new(2001,2,3).ajd
   #                               #=> #<DateTime: 2001-02-03T00:00:00+00:00 ...>
   #
-  def +: (Integer | Rational other) -> Date
+  def +: ((Numeric & _ToR) other) -> Date
 
   # Returns the difference between the two dates if the other is a date object.
   # If the other is a numeric value, returns a date object pointing `other` days
@@ -461,7 +461,7 @@ class Date
   #     DateTime.new(2001,2,3) - DateTime.new(2001,2,2,12)
   #                              #=> (1/2)
   #
-  def -: (Integer | Rational other) -> Date
+  def -: ((Numeric & _ToR) other) -> Date
        | (Date other) -> Rational
 
   # Returns a date object pointing `n` months before self. The argument `n` should

data/stdlib/logger/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: monitor

data/stdlib/net-http/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: uri

data/stdlib/openssl/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: socket

data/stdlib/prime/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: singleton

data/stdlib/resolv/0/manifest.yaml

@@ -0,0 +1,3 @@
+dependencies:
+  - name: socket
+  - name: timeout

data/stdlib/set/0/set.rbs

@@ -122,7 +122,7 @@ class Set[A]
   #
   # See also Enumerable#include?
   #
-  def include?: (untyped) -> bool
+  def include?: (A) -> bool
 
   alias member? include?
 
@@ -168,12 +168,12 @@ class Set[A]
   # Deletes the given object from the set and returns self.  Use `subtract` to
   # delete many items at once.
   #
-  def delete: (untyped) -> self
+  def delete: (A) -> self
 
   # Deletes the given object from the set and returns self.  If the object is not
   # in the set, returns nil.
   #
-  def delete?: (untyped) -> self?
+  def delete?: (A) -> self?
 
   # Deletes every element of the set for which block evaluates to true, and
   # returns self. Returns an enumerator if no block is given.

data/stdlib/uri/0/common.rbs

@@ -154,7 +154,7 @@ module URI
   #
   # See URI.encode_www_form_component, URI.decode_www_form.
   #
-  def self.encode_www_form: (Enumerable[[ _ToS, _ToS ]] enum, ?encoding enc) -> String
+  def self.encode_www_form: (Enumerable[[ _ToS, _ToS ]] enum, ?encoding? enc) -> String
 
   # Encodes given `str` to URL-encoded form data.
   #
@@ -168,7 +168,7 @@ module URI
   #
   # See URI.decode_www_form_component, URI.encode_www_form.
   #
-  def self.encode_www_form_component: (String str, ?encoding enc) -> String
+  def self.encode_www_form_component: (_ToS str, ?encoding? enc) -> String
 
   # ## Synopsis
   #
@@ -268,7 +268,7 @@ module URI
   # It's recommended to first ::escape the provided `uri_str` if there are any
   # invalid URI characters.
   #
-  def self.parse: (String uri) -> URI::Generic
+  def self.parse: (_ToStr uri) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
   # ## Synopsis
   #
@@ -302,12 +302,17 @@ module URI
   #       p $&
   #     end
   #
-  def self.regexp: (?Array[String] schemes) -> Regexp
+  def self.regexp: (?Array[String]? schemes) -> Regexp
 
   # Returns a Hash of the defined schemes.
   #
   def self.scheme_list: () -> Hash[String, Class]
 
+  # Construct a URI instance, using the scheme to detect the appropriate class
+  # from +URI.scheme_list+.
+  #
+  def self.for: (String scheme, *untyped arguments, ?default: Class) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
+
   # ## Synopsis
   #
   #     URI::split(uri)
@@ -340,7 +345,7 @@ module URI
   #     URI.split("http://www.ruby-lang.org/")
   #     # => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]
   #
-  def self.split: (String uri) -> [ String?, String?, String?, String?, String?, String?, String?, String?, String? ]
+  def self.split: (_ToStr uri) -> [ String?, String?, String?, String?, nil, String?, String?, String?, String? ]
 end
 
 URI::ABS_PATH: Regexp

data/stdlib/uri/0/ftp.rbs

@@ -0,0 +1,10 @@
+module URI
+  # FTP URI syntax is defined by RFC1738 section 3.2.
+  #
+  # This class will be redesigned because of difference of implementations;
+  # the structure of its path. draft-hoffman-ftp-uri-04 is a draft but it
+  # is a good summary about the de facto spec.
+  # http://tools.ietf.org/html/draft-hoffman-ftp-uri-04
+  class FTP < Generic
+  end
+end

data/stdlib/uri/0/mailto.rbs

@@ -0,0 +1,5 @@
+module URI
+  # RFC6068, the mailto URL scheme.
+  class MailTo < Generic
+  end
+end

data/stdlib/uri/0/ws.rbs

@@ -0,0 +1,10 @@
+module URI
+  # The syntax of WS URIs is defined in RFC6455 section 3.
+  #
+  # Note that the Ruby URI library allows WS URLs containing usernames and
+  # passwords. This is not legal as per the RFC, but used to be
+  # supported in Internet Explorer 5 and 6, before the MS04-004 security
+  # update. See <URL:http://support.microsoft.com/kb/834489>.
+  class WS < Generic
+  end
+end

data/stdlib/uri/0/wss.rbs

@@ -0,0 +1,7 @@
+module URI
+  # The default port for WSS URIs is 443, and the scheme is 'wss:' rather
+  # than 'ws:'. Other than that, WSS URIs are identical to WS URIs;
+  # see URI::WS.
+  class WSS < WS
+  end
+end

data/stdlib/yaml/0/manifest.yaml

@@ -0,0 +1,3 @@
+dependencies:
+  - name: dbm
+  - name: pstore

data/steep/Gemfile.lock

@@ -9,37 +9,37 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     concurrent-ruby (1.1.9)
-    ffi (1.15.3)
-    i18n (1.8.10)
+    ffi (1.15.4)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     language_server-protocol (3.16.0.3)
     listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.5.1)
-    steep (0.46.0)
+    rbs (1.7.1)
+    steep (0.47.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 1.2.0)
+      rbs (~> 1.7.0)
       terminal-table (>= 2, < 4)
-    terminal-table (3.0.1)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0.pre1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -124,6 +124,7 @@ files:
 - lib/rbs/ast/comment.rb
 - lib/rbs/ast/declarations.rb
 - lib/rbs/ast/members.rb
+- lib/rbs/ast/type_param.rb
 - lib/rbs/buffer.rb
 - lib/rbs/builtin_names.rb
 - lib/rbs/char_scanner.rb
@@ -174,6 +175,7 @@ files:
 - lib/rbs/test/tester.rb
 - lib/rbs/test/type_check.rb
 - lib/rbs/type_alias_dependency.rb
+- lib/rbs/type_alias_regularity.rb
 - lib/rbs/type_name.rb
 - lib/rbs/type_name_resolver.rb
 - lib/rbs/types.rb
@@ -182,7 +184,6 @@ files:
 - lib/rbs/vendorer.rb
 - lib/rbs/version.rb
 - lib/rbs/writer.rb
-- lib/ruby/signature.rb
 - rbs.gemspec
 - schema/annotation.json
 - schema/comment.json
@@ -191,6 +192,7 @@ files:
 - schema/location.json
 - schema/members.json
 - schema/methodType.json
+- schema/typeParam.json
 - schema/types.json
 - sig/ancestor_builder.rbs
 - sig/ancestor_graph.rbs
@@ -226,7 +228,9 @@ files:
 - sig/repository.rbs
 - sig/substitution.rbs
 - sig/type_alias_dependency.rbs
+- sig/type_alias_regularity.rbs
 - sig/type_name_resolver.rbs
+- sig/type_param.rbs
 - sig/typename.rbs
 - sig/types.rbs
 - sig/util.rbs
@@ -239,10 +243,12 @@ files:
 - stdlib/base64/0/base64.rbs
 - stdlib/benchmark/0/benchmark.rbs
 - stdlib/bigdecimal-math/0/big_math.rbs
+- stdlib/bigdecimal-math/0/manifest.yaml
 - stdlib/bigdecimal/0/big_decimal.rbs
 - stdlib/cgi/0/core.rbs
 - stdlib/coverage/0/coverage.rbs
 - stdlib/csv/0/csv.rbs
+- stdlib/csv/0/manifest.yaml
 - stdlib/date/0/date.rbs
 - stdlib/date/0/date_time.rbs
 - stdlib/dbm/0/dbm.rbs
@@ -258,20 +264,25 @@ files:
 - stdlib/logger/0/formatter.rbs
 - stdlib/logger/0/log_device.rbs
 - stdlib/logger/0/logger.rbs
+- stdlib/logger/0/manifest.yaml
 - stdlib/logger/0/period.rbs
 - stdlib/logger/0/severity.rbs
 - stdlib/monitor/0/monitor.rbs
 - stdlib/mutex_m/0/mutex_m.rbs
+- stdlib/net-http/0/manifest.yaml
 - stdlib/net-http/0/net-http.rbs
 - stdlib/objspace/0/objspace.rbs
+- stdlib/openssl/0/manifest.yaml
 - stdlib/openssl/0/openssl.rbs
 - stdlib/optparse/0/optparse.rbs
 - stdlib/pathname/0/pathname.rbs
 - stdlib/prettyprint/0/prettyprint.rbs
 - stdlib/prime/0/integer-extension.rbs
+- stdlib/prime/0/manifest.yaml
 - stdlib/prime/0/prime.rbs
 - stdlib/pstore/0/pstore.rbs
 - stdlib/pty/0/pty.rbs
+- stdlib/resolv/0/manifest.yaml
 - stdlib/resolv/0/resolv.rbs
 - stdlib/rubygems/0/basic_specification.rbs
 - stdlib/rubygems/0/config_file.rbs
@@ -310,14 +321,19 @@ files:
 - stdlib/tsort/0/tsort.rbs
 - stdlib/uri/0/common.rbs
 - stdlib/uri/0/file.rbs
+- stdlib/uri/0/ftp.rbs
 - stdlib/uri/0/generic.rbs
 - stdlib/uri/0/http.rbs
 - stdlib/uri/0/https.rbs
 - stdlib/uri/0/ldap.rbs
 - stdlib/uri/0/ldaps.rbs
+- stdlib/uri/0/mailto.rbs
 - stdlib/uri/0/rfc2396_parser.rbs
 - stdlib/uri/0/rfc3986_parser.rbs
+- stdlib/uri/0/ws.rbs
+- stdlib/uri/0/wss.rbs
 - stdlib/yaml/0/dbm.rbs
+- stdlib/yaml/0/manifest.yaml
 - stdlib/yaml/0/store.rbs
 - stdlib/zlib/0/zlib.rbs
 - steep/Gemfile
@@ -341,9 +357,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.22
 signing_key:

data/lib/ruby/signature.rb

@@ -1,7 +0,0 @@
-STDERR.puts "🚨🚨 ruby-signature is renamed to rbs. require 'rbs' instead of 'ruby/signature'. 🚨🚨"
-
-require "rbs"
-
-module Ruby
-  Signature = RBS
-end