rbs 1.5.1 → 1.7.0.beta.1

data/sig/collection.rbs

@@ -0,0 +1,4 @@
+module RBS
+  module Collection
+  end
+end

data/sig/comment.rbs

@@ -2,15 +2,17 @@ module RBS
   module AST
     # RBS allows writing documentation of declarations and members.
     #
-    #    # This is a doc for class.
-    #    class Hello
-    #    end
+    # ```
+    # # This is a doc for class.
+    # class Hello
+    # end
+    # ```
     #
     class Comment
       attr_reader string: String
-      attr_reader location: Location?
+      attr_reader location: Location[bot, bot]?
 
-      def initialize: (string: String, location: Location?) -> void
+      def initialize: (string: String, location: Location[bot, bot]?) -> void
 
       def ==: (untyped other) -> bool
 
@@ -19,8 +21,6 @@ module RBS
       def hash: () -> Integer
 
       include _ToJson
-
-      def concat: (string: String, location: Location?) -> self
     end
   end
 end

data/sig/constant_table.rbs

@@ -9,7 +9,7 @@ module RBS
 
     def absolute_type: (Types::t, context: Array[Namespace]) -> Types::t
 
-    def absolute_type_name: (TypeName, context: Array[Namespace], location: Location?) -> TypeName
+    def absolute_type_name: (TypeName, context: Array[Namespace], location: Location[untyped, untyped]?) -> TypeName
 
     def name_to_constant: (TypeName) -> Constant?
 

data/sig/declarations.rbs

@@ -17,7 +17,7 @@ module RBS
           # ^^^^^^^^^          unchecked
           #           ^^^      variance
           #               ^^^^ name
-          type loc = Location::WithChildren[:name, :variance | :unchecked]
+          type loc = Location[:name, :variance | :unchecked]
 
           attr_reader name: Symbol
           attr_reader variance: variance
@@ -86,7 +86,7 @@ module RBS
           # ^^^^^         name
           #      ^^^^^^^^ args
           #
-          type loc = Location::WithChildren[:name, :args]
+          type loc = Location[:name, :args]
 
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
@@ -112,7 +112,7 @@ module RBS
         #              ^            lt
         #                       ^^^ end
         #
-        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :lt]
+        type loc = Location[:keyword | :name | :end, :type_params | :lt]
 
         include NestedDeclarationHelper
         include MixinHelper
@@ -137,7 +137,7 @@ module RBS
           # ^^^^^         name
           #      ^^^^^^^^ args
           #
-          type loc = Location::WithChildren[:name, :args]
+          type loc = Location[:name, :args]
 
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
@@ -166,7 +166,7 @@ module RBS
         #                 ^^^^^^^^^^^     self_types
         #                             ^^^ end
         #
-        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :colon | :self_types]
+        type loc = Location[:keyword | :name | :end, :type_params | :colon | :self_types]
 
         include NestedDeclarationHelper
         include MixinHelper
@@ -199,7 +199,7 @@ module RBS
         #               ^^^^^^     type_params
         #                      ^^^ end
         #
-        type loc = Location::WithChildren[:name | :keyword | :end, :type_params]
+        type loc = Location[:name | :keyword | :end, :type_params]
 
         attr_reader name: TypeName
         attr_reader type_params: ModuleTypeParams
@@ -221,7 +221,7 @@ module RBS
         # ^^^^                keyword
         #      ^^^            name
         #          ^          eq
-        type loc = Location::WithChildren[:keyword | :name | :eq, bot]
+        type loc = Location[:keyword | :name | :eq, bot]
 
         attr_reader name: TypeName
         attr_reader type: Types::t
@@ -240,7 +240,7 @@ module RBS
         # ^^^^^^^         name
         #        ^        colon
         #
-        type loc = Location::WithChildren[:name | :colon, bot]
+        type loc = Location[:name | :colon, bot]
 
         attr_reader name: TypeName
         attr_reader type: Types::t
@@ -258,7 +258,7 @@ module RBS
         # ^^^^^         name
         #      ^        colon
         #
-        type loc = Location::WithChildren[:name | :colon, bot]
+        type loc = Location[:name | :colon, bot]
 
         attr_reader name: Symbol
         attr_reader type: Types::t

data/sig/definition.rbs

@@ -90,7 +90,7 @@ module RBS
 
       def initialize: (type_name: TypeName, params: Array[Symbol], ancestors: Array[Ancestor::t]) -> void
 
-      def apply: (Array[Types::t], location: Location?) -> Array[Ancestor::t]
+      def apply: (Array[Types::t], location: Location[untyped, untyped]?) -> Array[Ancestor::t]
     end
 
     class SingletonAncestors

data/sig/definition_builder.rbs

@@ -14,7 +14,7 @@ module RBS
 
     def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
 
-    def ensure_namespace!: (Namespace, location: Location?) -> void
+    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
 
     def build_interface: (TypeName) -> Definition
 
@@ -37,7 +37,7 @@ module RBS
 
     def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
 
-    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location?
+    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
 
     def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
 

data/sig/environment_loader.rbs

@@ -78,6 +78,9 @@ module RBS
     def add: (path: Pathname) -> void
            | (library: String, version: String?) -> void
 
+    # Add repository path and libraries via rbs_collection.lock.yaml.
+    def add_collection: (Collection::Config collection_config) -> void
+
     # This is helper function to test if RBS for a library is available or not.
     # 
     def has_library?: (library: String, version: String?) -> bool

data/sig/errors.rbs

@@ -19,6 +19,11 @@ module RBS
   # Error class for errors raised during parsing.
   #
   class ParsingError < BaseError
+    attr_reader location: Location[untyped, untyped]
+    attr_reader error_message: String
+    attr_reader token_type: String
+
+    def initialize: (Location[untyped, untyped], String error_message, String token_type) -> void
   end
 
   # Error class for errors raised during loading environments.
@@ -35,45 +40,45 @@ module RBS
     attr_reader type_name: TypeName
     attr_reader args: Array[Types::t]
     attr_reader params: Array[Symbol]
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location?) -> void
+    def initialize: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location?) -> void
+    def self.check!: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location[untyped, untyped]?) -> void
   end
 
   class RecursiveAncestorError < DefinitionError
     attr_reader ancestors: Array[Definition::Ancestor::t]
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (ancestors: Array[Definition::Ancestor::t], location: Location?) -> void
+    def initialize: (ancestors: Array[Definition::Ancestor::t], location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (Definition::Ancestor::t, ancestors: Array[Definition::Ancestor::t], location: Location?) -> void
+    def self.check!: (Definition::Ancestor::t, ancestors: Array[Definition::Ancestor::t], location: Location[untyped, untyped]?) -> void
   end
 
   class NoTypeFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (TypeName, env: Environment, location: Location?) -> TypeName
+    def self.check!: (TypeName, env: Environment, location: Location[untyped, untyped]?) -> TypeName
   end
 
   class NoSuperclassFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (TypeName, env: Environment, location: Location?) -> void
+    def self.check!: (TypeName, env: Environment, location: Location[untyped, untyped]?) -> void
   end
 
   class NoSelfTypeFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
     def self.check!: (AST::Declarations::Module::Self, env: Environment) -> void
   end
@@ -84,7 +89,7 @@ module RBS
 
     def initialize: (type_name: TypeName, member: AST::Members::t) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
     def self.check!: (TypeName, env: Environment, member: AST::Members::t) -> void
   end
@@ -103,9 +108,9 @@ module RBS
 
     def qualified_method_name: () -> String
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
-    def other_locations: () -> Array[Location?]
+    def other_locations: () -> Array[Location[untyped, untyped]?]
   end
 
   class DuplicatedInterfaceMethodDefinitionError < DefinitionError
@@ -127,9 +132,9 @@ module RBS
     attr_reader type_name: TypeName
     attr_reader original_name: Symbol
     attr_reader aliased_name: Symbol
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, original_name: Symbol, aliased_name: Symbol, location: Location?) -> void
+    def initialize: (type_name: TypeName, original_name: Symbol, aliased_name: Symbol, location: Location[untyped, untyped]?) -> void
   end
 
   class SuperclassMismatchError < DefinitionError
@@ -165,9 +170,9 @@ module RBS
   class InvalidVarianceAnnotationError < DefinitionError
     attr_reader type_name: TypeName
     attr_reader param: AST::Declarations::ModuleTypeParams::TypeParam
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, param: AST::Declarations::ModuleTypeParams::TypeParam, location: Location?) -> void
+    def initialize: (type_name: TypeName, param: AST::Declarations::ModuleTypeParams::TypeParam, location: Location[untyped, untyped]?) -> void
   end
 
   class RecursiveAliasDefinitionError < DefinitionError
@@ -179,7 +184,7 @@ module RBS
 
     def initialize: (type: ty, defs: Array[defn]) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
   end
 
   class MixinClassError < DefinitionError
@@ -190,7 +195,7 @@ module RBS
 
     def initialize: (type_name: TypeName, member: member) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
     def self.check!: (type_name: TypeName, env: Environment, member: member) -> void
 
@@ -199,9 +204,9 @@ module RBS
 
   class RecursiveTypeAliasError < LoadingError
     attr_reader alias_names: Array[TypeName]
-    attr_reader location: Location
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (alias_names: Array[TypeName], location: Location) -> void
+    def initialize: (alias_names: Array[TypeName], location: Location[untyped, untyped]?) -> void
 
     def name: () -> String
   end

data/sig/location.rbs

@@ -1,17 +1,24 @@
 module RBS
   # Location is the range on buffer, `start_pos..end_pos`.
   # The index is based on characters.
-  class Location
+  #
+  # A location can have _child_ locations.
+  #
+  # ```
+  #
+  # ```
+  #
+  class Location[RequiredChildKeys, OptionalChildKeys]
     # The buffer this location points on.
-    attr_reader buffer: Buffer
+    attr_reader buffer (): Buffer
 
     # The index of character the range starts from.
-    attr_reader start_pos: Integer
+    attr_reader start_pos (): Integer
 
     # The index of character the range ends at.
-    attr_reader end_pos: Integer
+    attr_reader end_pos (): Integer
 
-    def initialize: (buffer: Buffer, start_pos: Integer, end_pos: Integer) -> void
+    def initialize: (Buffer, Integer start_pos, Integer end_pos) -> void
 
     def inspect: () -> String
 
@@ -19,22 +26,22 @@ module RBS
     def name: () -> untyped
 
     # Line of the `start_pos` (1 origin)
-    def start_line: () -> Integer
+    attr_reader start_line (): Integer
 
     # Column of the `start_pos` (0 origin)
-    def start_column: () -> Integer
+    attr_reader start_column (): Integer
 
     # Line of the `end_pos` (1 origin)
-    def end_line: () -> Integer
+    attr_reader end_line (): Integer
 
     # Column of the `end_pos` (0 origin)
-    def end_column: () -> Integer
+    attr_reader end_column (): Integer
 
-    def start_loc: () -> Buffer::loc
+    attr_reader start_loc (): Buffer::loc
 
-    def end_loc: () -> Buffer::loc
+    attr_reader end_loc (): Buffer::loc
 
-    def range: () -> Range[Integer]
+    attr_reader range (): Range[Integer]
 
     # A substring of buffer associated to the location.
     def source: () -> String
@@ -46,88 +53,44 @@ module RBS
     #     Location.to_string(loc)  # => a.rb:1:0...3:4
     #     Location.to_string(nil)  # => *:*:*..*:*
     #
-    def self.to_string: (Location? location, ?default: ::String default) -> String
+    def self.to_string: (Location[untyped, untyped]? location, ?default: ::String default) -> String
 
     def ==: (untyped other) -> bool
 
-    # Returns a new location with starting positionof `self` and ending position of `other`.
-    #
-    #     l1 = Location.new(buffer: buffer, start_pos: 0, end_pox: x)
-    #     l2 = Location.new(buffer: buffer, start_pos: y, end_pos: 20)
-    #     l1 + l2  # => Location.new(buffer: buffer, start_pos: 0, end_pos: 20)
-    #
-    def +: (Location other) -> Location
-
-    # Returns true if `loc` is exact predecessor of `self`.
-    #
-    #     l1 = Location.new(...)    # 0..10
-    #     l2 = Location.new(...)    # 10..13
-    #     l3 = Location.new(...)    # 13..20
-    #
-    #     l1.pred?(l2)       # => true
-    #     l2.pred?(l3)       # => true
-    #     l1.pred?(l3)       # => false
-    #
-    def pred?: (Location loc) -> bool
-
     include _ToJson
 
-    # `<<` locations given as argument.
-    #
-    def concat: (*Location?) -> Location
-
-    # Inplace version of `+`.
-    #
-    def <<: (Location?) -> Location
+    def add_optional_child: (OptionalChildKeys name, Range[Integer]? range) -> void
 
-    # Returns WithChildren instance with given children.
-    #
-    #     location.with_children(
-    #       required: { name: name.location },
-    #       optional: { args: nil }
-    #     )
-    #
-    def with_children: [R, O](?required: Hash[R, Range[Integer] | Location], ?optional: Hash[O, Range[Integer] | Location | nil]) -> WithChildren[R, O]
+    def add_required_child: (RequiredChildKeys name, Range[Integer] range) -> void
 
-    # Location::WithChildren contains _child_ locations.
+    # Returns `Location` instance for given _child_ name.
     #
-    #     # Array[String]
-    #     # ^^^^^          <= name
-    #     #      ^^^^^^^^  <= args
-    #     #
     #     # @type var loc: Location::WithChildren[:name, :args]
-    #     loc = Location::WithChildren.new(buffer: buffer, start_pos: 0, end_pos: 13)
-    #     loc = loc.merge_required({ name: 1...5 })
-    #     loc = loc.merge_optional({ args: 5...13 })
+    #     loc[:name]      # => Location
+    #     loc[:args]      # => may be nil
     #
-    #     loc[:name]      # => Location instance for `Array`
-    #     loc[:args]      # => Location instance for `[String]`
+    # Note that passing unknown symbol raises an error even if the child is _optional_.
+    # You need explicitly set `nil` for absent optional children.
     #
-    class WithChildren[RequiredChildKeys, OptionalChildKeys] < Location
-      attr_reader required_children: Hash[RequiredChildKeys, Range[Integer]]
-
-      attr_reader optional_children: Hash[OptionalChildKeys, Range[Integer]?]
+    def []: (RequiredChildKeys) -> Location[bot, bot]
+          | (OptionalChildKeys) -> Location[bot, bot]?
+          | (Symbol) -> Location[bot, bot]?
 
-      def initialize: ...
+    def each_optional_key: () { (Symbol) -> void } -> void
+                         | () -> Enumerator[Symbol, void]
 
-      def initialize_copy: ...
+    def each_required_key: () { (Symbol) -> void } -> void
+                         | () -> Enumerator[Symbol, void]
 
-      # Returns `Location` instance for given _child_ name.
-      #
-      #     # @type var loc: Location::WithChildren[:name, :args]
-      #     loc[:name]      # => Location
-      #     loc[:args]      # => may be nil
-      #
-      # Note that passing unknown symbol raises an error even if the child is _optional_.
-      # You need explicitly set `nil` for absent optional children.
-      #
-      def []: (RequiredChildKeys) -> Location
-            | (OptionalChildKeys) -> Location?
-            | (Symbol) -> Location?
+    private
 
-      def merge_required: (Hash[RequiredChildKeys, Range[Integer] | Location]) -> self
+    def _start_loc: () -> Buffer::loc?
+    def _end_loc: () -> Buffer::loc?
 
-      def merge_optional: (Hash[OptionalChildKeys, Range[Integer] | Location | nil]) -> self
-    end
+    def _add_required_child: (RequiredChildKeys name, Integer start_pos, Integer end_pos) -> void
+    def _add_optional_child: (OptionalChildKeys name, Integer start_pos, Integer end_pos) -> void
+    def _add_optional_no_child: (OptionalChildKeys name) -> void
+    def _optional_keys: () -> Array[Symbol]
+    def _required_keys: () -> Array[Symbol]
   end
 end