rbs 1.6.2 → 1.7.0.beta.1

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

data/sig/locator.rbs

@@ -37,8 +37,8 @@ module RBS
 
     def find_in_type: (Integer pos, type: Types::t, array: Array[component]) -> bool
 
-    def find_in_loc: (Integer pos, location: Location::WithChildren[untyped, untyped] | Location | nil, array: Array[component]) -> bool
+    def find_in_loc: (Integer pos, location: Location[untyped, untyped]?, array: Array[component]) -> bool
 
-    def test_loc: (Integer pos, location: Location?) -> bool
+    def test_loc: (Integer pos, location: Location[untyped, untyped]?) -> bool
   end
 end

data/sig/members.rbs

@@ -25,7 +25,7 @@ module RBS
         #          ^^^                     name
         #                            ^^^   overload
         #
-        type loc = Location::WithChildren[:keyword | :name, :kind | :overload]
+        type loc = Location[:keyword | :name, :kind | :overload]
 
         attr_reader name: Symbol
         attr_reader kind: kind
@@ -59,7 +59,7 @@ module RBS
         #      ^^^^                    name
         #          ^                   colon
         #
-        type loc = Location::WithChildren[:name | :colon, :kind]
+        type loc = Location[:name | :colon, :kind]
 
         attr_reader name: Symbol
         attr_reader type: Types::t
@@ -97,7 +97,7 @@ module RBS
         #              ^         arg_open
         #                     ^  arg_close
         #
-        type loc = Location::WithChildren[:name | :keyword, :args]
+        type loc = Location[:name | :keyword, :args]
 
         attr_reader name: TypeName
         attr_reader args: Array[Types::t]
@@ -141,7 +141,7 @@ module RBS
         #                          ^^^^             ivar_name
         #                                ^          colon
         #
-        type loc = Location::WithChildren[:keyword | :name | :colon, :kind | :ivar | :ivar_name]
+        type loc = Location[:keyword | :name | :colon, :kind | :ivar | :ivar_name]
 
         attr_reader name: Symbol
         attr_reader type: Types::t
@@ -174,9 +174,9 @@ module RBS
       end
 
       module LocationOnly
-        attr_reader location: Location?
+        attr_reader location: Location[bot, bot]?
 
-        def initialize: (location: Location?) -> void
+        def initialize: (location: Location[bot, bot]?) -> void
 
         include _HashEqual
       end
@@ -206,7 +206,7 @@ module RBS
         #                ^^^^^       old_kind
         #                     ^^^    old_name
         #
-        type loc = Location::WithChildren[:keyword | :new_name | :old_name, :new_kind | :old_kind]
+        type loc = Location[:keyword | :new_name | :old_name, :new_kind | :old_kind]
 
         attr_reader new_name: Symbol
         attr_reader old_name: Symbol

data/sig/method_types.rbs

@@ -3,9 +3,9 @@ module RBS
     attr_reader type_params: Array[Symbol]
     attr_reader type: Types::Function
     attr_reader block: Types::Block?
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_params: Array[Symbol], type: Types::Function, block: Types::Block?, location: Location?) -> void
+    def initialize: (type_params: Array[Symbol], type: Types::Function, block: Types::Block?, location: Location[untyped, untyped]?) -> void
 
     def ==: (untyped other) -> bool
 
@@ -13,7 +13,7 @@ module RBS
 
     def sub: (Substitution) -> MethodType
 
-    def update: (?type_params: Array[Symbol], ?type: Types::Function, ?block: Types::Block?, ?location: Location?) -> MethodType
+    def update: (?type_params: Array[Symbol], ?type: Types::Function, ?block: Types::Block?, ?location: Location[untyped, untyped]?) -> MethodType
 
     def free_variables: (?Set[Symbol] set) -> Set[Symbol]
 

data/sig/parser.rbs

@@ -1,32 +1,22 @@
 module RBS
   class Parser
-    class SyntaxError < ParsingError
-      attr_reader token_str: String
-      attr_reader error_value: untyped
-      attr_reader value_stack: untyped?
+    def self.parse_method_type: (Buffer | String, ?line: Integer, ?column: Integer, ?variables: Array[Symbol]) -> MethodType
 
-      def initialize: (token_str: String, error_value: untyped, ?value_stack: untyped?) -> void
-    end
+    def self.parse_type: (Buffer | String, ?line: Integer, ?column: Integer, ?variables: Array[Symbol]) -> Types::t
 
-    class LexerError < ParsingError
-      attr_reader input: String
-      attr_reader location: Location
+    def self.parse_signature: (Buffer | String, ?line: Integer, ?column: Integer) -> Array[AST::Declarations::t]
 
-      def initialize: (input: String, location: Location) -> void
-    end
+    private
 
-    class SemanticsError < ParsingError
-      attr_reader subject: untyped
-      attr_reader location: Location
-      attr_reader original_message: String
+    def self.buffer: (String | Buffer source) -> Buffer
 
-      def initialize: (String message, subject: untyped, location: Location) -> void
-    end
+    %a{no-defn}
+    def self._parse_type: (Buffer, Integer line, Integer column, Array[Symbol] variables) -> Types::t
 
-    def self.parse_method_type: (String | Buffer, ?variables: Array[Symbol], ?eof_re: Regexp?) -> MethodType
+    %a{no-defn}
+    def self._parse_method_type: (Buffer, Integer line, Integer column, Array[Symbol] variables) -> MethodType
 
-    def self.parse_type: (String | Buffer, ?variables: Array[Symbol], ?eof_re: Regexp?) -> Types::t
-
-    def self.parse_signature: (String | Buffer, ?eof_re: Regexp?) -> Array[AST::Declarations::t]
+    %a{no-defn}
+    def self._parse_signature: (Buffer, Integer line, Integer column) -> Array[AST::Declarations::t]
   end
 end

data/sig/types.rbs

@@ -13,7 +13,7 @@ module RBS
       def sub: (Substitution) -> t
 
       # Maps type names included in the type and returns new instance of type.
-      def map_type_name: () { (TypeName, Location?, t) -> TypeName } -> t
+      def map_type_name: () { (TypeName, Location[untyped, untyped]?, t) -> TypeName } -> t
 
       # Yields all direct sub types included in the type.
       # It doesn't yield the type itself.
@@ -58,16 +58,16 @@ module RBS
     end
 
     module NoTypeName
-      def map_type_name: () { (TypeName, Location?, t) -> TypeName } -> self
+      def map_type_name: () { (TypeName, Location[untyped, untyped]?, t) -> TypeName } -> self
     end
 
     module Bases
       class Base
         include _TypeBase
 
-        attr_reader location: Location?
+        attr_reader location: Location[bot, bot]?
 
-        def initialize: (location: Location?) -> void
+        def initialize: (location: Location[bot, bot]?) -> void
 
         def ==: (untyped other) -> bool
 
@@ -111,6 +111,8 @@ module RBS
     end
 
     class Variable
+      type loc = Location[bot, bot]
+
       attr_reader name: Symbol
 
       @@count: Integer
@@ -119,9 +121,9 @@ module RBS
       include NoTypeName
       include EmptyEachType
 
-      def initialize: (name: Symbol, location: Location?) -> void
+      def initialize: (name: Symbol, location: loc?) -> void
 
-      attr_reader location: Location?
+      attr_reader location: loc?
 
       def ==: (untyped other) -> bool
 
@@ -144,7 +146,7 @@ module RBS
     class ClassSingleton
       # singleton(::Foo)
       #           ^^^^^  => name
-      type loc = Location::WithChildren[:name, bot]
+      type loc = Location[:name, bot]
 
       def initialize: (name: TypeName, location: loc?) -> void
 
@@ -189,7 +191,7 @@ module RBS
       # _Foo[Bar, Baz]
       # ^^^^           => name
       #     ^^^^^^^^^^ => args
-      type loc = Location::WithChildren[:name, :args]
+      type loc = Location[:name, :args]
 
       def initialize: (name: TypeName, args: Array[t], location: loc?) -> void
 
@@ -214,7 +216,8 @@ module RBS
       # Foo[Bar, Baz]
       # ^^^           => name
       #    ^^^^^^^^^^ => args
-      type loc = Location::WithChildren[:name, :args]
+      #
+      type loc = Location[:name, :args]
 
       def initialize: (name: TypeName, args: Array[t], location: loc?) -> void
 
@@ -226,54 +229,64 @@ module RBS
     class Alias
       attr_reader name: TypeName
 
-      def initialize: (name: TypeName, location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (name: TypeName, location: loc?) -> void
 
       include _TypeBase
       include NoFreeVariables
       include NoSubst
       include EmptyEachType
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
 
     class Tuple
       attr_reader types: Array[t]
 
-      def initialize: (types: Array[t], location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (types: Array[t], location: loc?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
 
     class Record
       attr_reader fields: Hash[Symbol, t]
 
-      def initialize: (fields: Hash[Symbol, t], location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (fields: Hash[Symbol, t], location: loc?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
 
     class Optional
       attr_reader type: t
 
-      def initialize: (type: t, location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (type: t, location: loc?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
 
     class Union
       attr_reader types: Array[t]
 
-      def initialize: (types: Array[t], location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (types: Array[t], location: loc?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
 
       def map_type: () { (t) -> t } -> Union
                   | () -> Enumerator[t, Union]
@@ -282,11 +295,13 @@ module RBS
     class Intersection
       attr_reader types: Array[t]
 
-      def initialize: (types: Array[t], location: Location?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (types: Array[t], location: loc?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
 
       def map_type: () { (t) -> t } -> Intersection
                   | () -> Enumerator[t, Intersection]
@@ -294,7 +309,7 @@ module RBS
 
     class Function
       class Param
-        type loc = Location::WithChildren[bot, :name]
+        type loc = Location[bot, :name]
 
         attr_reader type: t
         attr_reader name: Symbol?
@@ -329,7 +344,7 @@ module RBS
       def map_type: { (t) -> t } -> Function
                   | -> Enumerator[t, Function]
 
-      def map_type_name: () { (TypeName, Location?, t) -> TypeName } -> Function
+      def map_type_name: () { (TypeName, Location[untyped, untyped]?, t) -> TypeName } -> Function
 
       def each_type: () { (t) -> void } -> void
                    | -> Enumerator[t, void]
@@ -384,19 +399,22 @@ module RBS
       attr_reader type: Function
       attr_reader block: Block?
 
-      def initialize: (location: Location?, type: Function, block: Block?) -> void
+      type loc = Location[bot, bot]
+
+      def initialize: (location: loc?, type: Function, block: Block?) -> void
 
       include _TypeBase
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
 
     class Literal
       type literal = String | Integer | Symbol | TrueClass | FalseClass
+      type loc = Location[bot, bot]
 
       attr_reader literal: literal
 
-      def initialize: (literal: literal, location: Location?) -> void
+      def initialize: (literal: literal, location: loc?) -> void
 
       include _TypeBase
       include NoFreeVariables
@@ -404,7 +422,7 @@ module RBS
       include EmptyEachType
       include NoTypeName
 
-      attr_reader location: Location?
+      attr_reader location: loc?
     end
   end
 end