rbs 1.1.1 → 1.2.0

data/sig/environment.rbs

@@ -5,7 +5,7 @@ module RBS
     interface _WithContext
       def outer: () -> Array[module_decl]
 
-      def decl: () -> module_decl
+      def decl: () -> untyped
     end
 
     module ContextUtil : _WithContext
@@ -23,7 +23,7 @@ module RBS
       end
 
       attr_reader name: TypeName
-      attr_reader decls: Array[D[module_decl]]
+      attr_reader decls: Array[untyped]
 
       def initialize: (name: TypeName) -> void
 

data/sig/location.rbs

@@ -13,40 +13,121 @@ module RBS
 
     def initialize: (buffer: Buffer, start_pos: Integer, end_pos: Integer) -> void
 
-    def inspect: () -> ::String
+    def inspect: () -> String
 
+    # Returns the name of the buffer.
     def name: () -> untyped
 
+    # Line of the `start_pos` (1 origin)
     def start_line: () -> Integer
 
+    # Column of the `start_pos` (0 origin)
     def start_column: () -> Integer
 
+    # Line of the `end_pos` (1 origin)
     def end_line: () -> Integer
 
+    # Column of the `end_pos` (0 origin)
     def end_column: () -> Integer
 
     def start_loc: () -> Buffer::loc
 
     def end_loc: () -> Buffer::loc
 
+    def range: () -> Range[Integer]
+
+    # A substring of buffer associated to the location.
     def source: () -> String
 
     def to_s: () -> String
 
+    # Returns a string representation suitable for terminal output.
+    #
+    #     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 ==: (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
 
-    def to_json: (*untyped args) -> untyped
+    include _ToJson
 
     # `<<` locations given as argument.
+    #
     def concat: (*Location?) -> Location
 
-    # Append given location destructively.
+    # Inplace version of `+`.
+    #
     def <<: (Location?) -> Location
+
+    # 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]
+
+    # Location::WithChildren contains _child_ locations.
+    #
+    #     # 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 instance for `Array`
+    #     loc[:args]      # => Location instance for `[String]`
+    #
+    class WithChildren[RequiredChildKeys, OptionalChildKeys] < Location
+      attr_reader required_children: Hash[RequiredChildKeys, Range[Integer]]
+
+      attr_reader optional_children: Hash[OptionalChildKeys, Range[Integer]?]
+
+      def initialize: ...
+
+      def initialize_copy: ...
+
+      # 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?
+
+      def merge_required: (Hash[RequiredChildKeys, Range[Integer] | Location]) -> self
+
+      def merge_optional: (Hash[OptionalChildKeys, Range[Integer] | Location | nil]) -> self
+    end
   end
 end

data/sig/locator.rbs

@@ -0,0 +1,44 @@
+module RBS
+  # Locator helps finding RBS elements based on locations in the RBS source text.
+  #
+  class Locator
+    type component = Symbol
+                   | Types::t
+                   | MethodType
+                   | AST::Declarations::t
+                   | AST::Members::t
+                   | AST::Declarations::ModuleTypeParams::TypeParam
+                   | AST::Declarations::Class::Super
+                   | AST::Declarations::Module::Self
+
+    # Array of _top-level_ declarations.
+    #
+    attr_reader decls: Array[AST::Declarations::t]
+
+    def initialize: (decls: Array[AST::Declarations::t]) -> void
+
+    def buffer: () -> Buffer
+
+    # Returns list of components.
+    # Inner component comes first.
+    #
+    def find: (line: Integer, column: Integer) -> Array[component]
+
+    # Returns pair of the inner most symbol and outer components.
+    # It ensures the array starts with a AST/type component.
+    #
+    def find2: (line: Integer, column: Integer) -> [Symbol?, Array[component]]?
+
+    def find_in_decl: (Integer pos, decl: AST::Declarations::t, array: Array[component]) -> bool
+
+    def find_in_member: (Integer pos, member: AST::Members::t, array: Array[component]) -> bool
+
+    def find_in_method_type: (Integer pos, method_type: MethodType, array: Array[component]) -> bool
+
+    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 test_loc: (Integer pos, location: Location?) -> bool
+  end
+end

data/sig/members.rbs

@@ -15,15 +15,27 @@ module RBS
       class MethodDefinition < Base
         type kind = :instance | :singleton | :singleton_instance
 
+        # def foo: () -> void
+        # ^^^                    keyword
+        #     ^^^                name
+        #
+        # def self.bar: () -> void | ...
+        # ^^^                              keyword
+        #     ^^^^^                        kind
+        #          ^^^                     name
+        #                            ^^^   overload
+        #
+        type loc = Location::WithChildren[:keyword | :name, :kind | :overload]
+
         attr_reader name: Symbol
         attr_reader kind: kind
         attr_reader types: Array[MethodType]
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
         attr_reader overload: bool
 
-        def initialize: (name: Symbol, kind: kind, types: Array[MethodType], annotations: Array[Annotation], location: Location?, comment: Comment?, overload: boolish) -> void
+        def initialize: (name: Symbol, kind: kind, types: Array[MethodType], annotations: Array[Annotation], location: loc?, comment: Comment?, overload: boolish) -> void
 
         include _HashEqual
         include _ToJson
@@ -34,16 +46,27 @@ module RBS
 
         def overload?: () -> bool
 
-        def update: (?name: Symbol, ?kind: kind, ?types: Array[MethodType], ?annotations: Array[Annotation], ?location: Location?, ?comment: Comment?, ?overload: boolish) -> MethodDefinition
+        def update: (?name: Symbol, ?kind: kind, ?types: Array[MethodType], ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?, ?overload: boolish) -> MethodDefinition
       end
 
       module Var
+        # @foo: String
+        # ^^^^            name
+        #     ^           colon
+        #
+        # self.@all: Array[String]
+        # ^^^^^                        kind
+        #      ^^^^                    name
+        #          ^                   colon
+        #
+        type loc = Location::WithChildren[:name | :colon, :kind]
+
         attr_reader name: Symbol
         attr_reader type: Types::t
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: Symbol, type: Types::t, location: Location?, comment: Comment?) -> void
+        def initialize: (name: Symbol, type: Types::t, location: loc?, comment: Comment?) -> void
 
         include _HashEqual
       end
@@ -64,13 +87,25 @@ module RBS
       end
 
       module Mixin
+        # include Foo
+        # ^^^^^^^       keyword
+        #         ^^^   name
+        #
+        # include Array[String]
+        # ^^^^^^^                keyword
+        #         ^^^^^          name
+        #              ^         arg_open
+        #                     ^  arg_close
+        #
+        type loc = Location::WithChildren[:name | :keyword, :args]
+
         attr_reader name: TypeName
         attr_reader args: Array[Types::t]
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, args: Array[Types::t], annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (name: TypeName, args: Array[Types::t], annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include _HashEqual
       end
@@ -93,19 +128,34 @@ module RBS
       module Attribute
         type kind = :instance | :singleton
 
+        # attr_reader name: String
+        # ^^^^^^^^^^^                  keyword
+        #             ^^^^             name
+        #                 ^            colon
+        #
+        # attr_accessor self.name (@foo) : String
+        # ^^^^^^^^^^^^^                             keyword
+        #               ^^^^^                       kind
+        #                    ^^^^                   name
+        #                         ^^^^^^            ivar
+        #                          ^^^^             ivar_name
+        #                                ^          colon
+        #
+        type loc = Location::WithChildren[:keyword | :name | :colon, :kind | :ivar | :ivar_name]
+
         attr_reader name: Symbol
         attr_reader type: Types::t
         attr_reader kind: kind
         attr_reader ivar_name: Symbol | false | nil
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: Symbol, type: Types::t, ivar_name: Symbol | false | nil, kind: kind, annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (name: Symbol, type: Types::t, ivar_name: Symbol | false | nil, kind: kind, annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include _HashEqual
 
-        def update: (?name: Symbol, ?type: Types::t, ?ivar_name: Symbol | false | nil, ?kind: kind, ?annotations: Array[Annotation], ?location: Location?, ?comment: Comment?) -> instance
+        def update: (?name: Symbol, ?type: Types::t, ?ivar_name: Symbol | false | nil, ?kind: kind, ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?) -> instance
       end
 
       class AttrReader < Base
@@ -144,14 +194,28 @@ module RBS
       class Alias < Base
         type kind = :instance | :singleton
 
+        # alias foo bar
+        # ^^^^^           keyword
+        #       ^^^       new_name
+        #           ^^^   old_name
+        #
+        # alias self.foo self.bar
+        # ^^^^^                      keyword
+        #       ^^^^^                new_kind
+        #            ^^^             new_name
+        #                ^^^^^       old_kind
+        #                     ^^^    old_name
+        #
+        type loc = Location::WithChildren[:keyword | :new_name | :old_name, :new_kind | :old_kind]
+
         attr_reader new_name: Symbol
         attr_reader old_name: Symbol
         attr_reader kind: kind
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (new_name: Symbol, old_name: Symbol, kind: kind, annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (new_name: Symbol, old_name: Symbol, kind: kind, annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include _HashEqual
         include _ToJson

data/sig/method_builder.rbs

@@ -20,7 +20,7 @@ module RBS
 
           def accessibility: () -> accessibility
 
-          def self.empty: (name: Symbol, type: instance_type) -> instance
+          def self.empty: (name: Symbol, type: instance_type) -> Definition
         end
 
         attr_reader type: instance_type

data/sig/method_types.rbs

@@ -9,7 +9,7 @@ module RBS
 
     def ==: (untyped other) -> bool
 
-    def to_json: (*untyped) -> String
+    include _ToJson
 
     def sub: (Substitution) -> MethodType
 

data/sig/polyfill.rbs

@@ -1,5 +1,4 @@
 module Kernel
-  def to_json: (*untyped) -> String
 end
 
 module Gem
@@ -14,18 +13,24 @@ end
 
 class OptionParser
   def initialize: () ?{ (instance) -> void } -> void
-                
-  def on: (*String) { (String) -> void } -> void
-        
+
+  def on: [T] (*String) { (T) -> void } -> void
+
   attr_accessor version: String
-  
+
   attr_accessor banner: String
 
   def order!: (Array[String]) -> void
-            
+
   def parse!: (Array[String]) -> void
-            
+
   def ver: () -> String
-         
+
   def help: () -> String
 end
+
+module Enumerable[unchecked out Elem]
+  def flat_map: [U] () { (Elem) -> Array[U] } -> Array[U]
+              | [U] () { (Elem) -> U } -> Array[U]
+              | ...
+end

data/sig/rbs.rbs

@@ -1,11 +1,15 @@
 module RBS
   def self.logger: () -> Logger
-                 
+
   def self.logger_level: () -> untyped
-                  
+
   def self.logger_level=: (untyped) -> untyped
-                   
+
   def self.logger_output: () -> IO
-                   
+
   def self.logger_output=: (IO) -> IO
 end
+
+module Ruby
+  Signature: singleton(RBS)
+end

data/sig/typename.rbs

@@ -34,7 +34,7 @@ module RBS
 
     def to_s: () -> ::String
 
-    def to_json: (*untyped a) -> untyped
+    include _ToJson
 
     # Returns a namespace with same components of self.
     def to_namespace: () -> Namespace

data/sig/types.rbs

@@ -3,11 +3,6 @@ module RBS
     # _TypeBase interface represents the operations common to all of the types.
     #
     interface _TypeBase
-      # Location for types in the RBS source code.
-      # `nil` means there is no RBS source code for the type.
-      #
-      def location: () -> Location?
-
       # Returns names of free variables of a type.
       # You can pass a Set instance to add the free variables to the set to avoid Set object allocation.
       #
@@ -32,7 +27,7 @@ module RBS
 
       # Returns a JSON representation.
       #
-      def to_json: (*untyped) -> String
+      include _ToJson
 
       # Returns a String representation.
       # `level` is used internally.
@@ -70,6 +65,8 @@ module RBS
       class Base
         include _TypeBase
 
+        attr_reader location: Location?
+
         def initialize: (location: Location?) -> void
 
         def ==: (untyped other) -> bool
@@ -119,12 +116,13 @@ module RBS
       @@count: Integer
 
       include _TypeBase
-
       include NoTypeName
       include EmptyEachType
 
       def initialize: (name: Symbol, location: Location?) -> void
 
+      attr_reader location: Location?
+
       def ==: (untyped other) -> bool
 
       alias eql? ==
@@ -144,21 +142,26 @@ module RBS
     end
 
     class ClassSingleton
+      # singleton(::Foo)
+      #           ^^^^^  => name
+      type loc = Location::WithChildren[:name, bot]
+
+      def initialize: (name: TypeName, location: loc?) -> void
+
       attr_reader name: TypeName
 
-      include _TypeBase
+      attr_reader location: loc?
 
-      def initialize: (name: TypeName, location: Location?) -> void
+      include _TypeBase
+      include NoFreeVariables
+      include NoSubst
+      include EmptyEachType
 
       def ==: (untyped other) -> bool
 
       alias eql? ==
 
       def hash: () -> Integer
-
-      include NoFreeVariables
-      include NoSubst
-      include EmptyEachType
     end
 
     module Application
@@ -180,11 +183,20 @@ module RBS
     end
 
     class Interface
-      include Application
+      # _Foo
+      # ^^^^ => name
+      #
+      # _Foo[Bar, Baz]
+      # ^^^^           => name
+      #     ^^^^^^^^^^ => args
+      type loc = Location::WithChildren[:name, :args]
 
-      def initialize: (name: TypeName, args: Array[t], location: Location?) -> void
+      def initialize: (name: TypeName, args: Array[t], location: loc?) -> void
 
+      include Application
       include _TypeBase
+
+      attr_reader location: loc?
     end
 
     # ClassInstance represents a type of an instance of a class.
@@ -196,7 +208,17 @@ module RBS
     class ClassInstance
       include Application
 
-      def initialize: (name: TypeName, args: Array[t], location: Location?) -> void
+      # Foo
+      # ^^^ => name
+      #
+      # Foo[Bar, Baz]
+      # ^^^           => name
+      #    ^^^^^^^^^^ => args
+      type loc = Location::WithChildren[:name, :args]
+
+      def initialize: (name: TypeName, args: Array[t], location: loc?) -> void
+
+      attr_reader location: loc?
 
       include _TypeBase
     end
@@ -210,6 +232,8 @@ module RBS
       include NoFreeVariables
       include NoSubst
       include EmptyEachType
+
+      attr_reader location: Location?
     end
 
     class Tuple
@@ -218,6 +242,8 @@ module RBS
       def initialize: (types: Array[t], location: Location?) -> void
 
       include _TypeBase
+
+      attr_reader location: Location?
     end
 
     class Record
@@ -226,6 +252,8 @@ module RBS
       def initialize: (fields: Hash[Symbol, t], location: Location?) -> void
 
       include _TypeBase
+
+      attr_reader location: Location?
     end
 
     class Optional
@@ -234,6 +262,8 @@ module RBS
       def initialize: (type: t, location: Location?) -> void
 
       include _TypeBase
+
+      attr_reader location: Location?
     end
 
     class Union
@@ -243,6 +273,8 @@ module RBS
 
       include _TypeBase
 
+      attr_reader location: Location?
+
       def map_type: () { (t) -> t } -> Union
                   | () -> Enumerator[t, Union]
     end
@@ -254,16 +286,21 @@ module RBS
 
       include _TypeBase
 
+      attr_reader location: Location?
+
       def map_type: () { (t) -> t } -> Intersection
                   | () -> Enumerator[t, Intersection]
     end
 
     class Function
       class Param
+        type loc = Location::WithChildren[bot, :name]
+
         attr_reader type: t
         attr_reader name: Symbol?
+        attr_reader location: loc?
 
-        def initialize: (type: t, name: Symbol?) -> void
+        def initialize: (type: t, name: Symbol?, ?location: loc?) -> void
 
         def map_type: { (t) -> t } -> Param
                     | -> Enumerator[t, Param]
@@ -300,7 +337,7 @@ module RBS
       def each_param: () { (Param) -> void } -> void
                     | -> Enumerator[Param, void]
 
-      def to_json: (*untyped) -> String
+      include _ToJson
 
       def sub: (Substitution) -> Function
 
@@ -336,7 +373,7 @@ module RBS
 
       def ==: (untyped other) -> bool
 
-      def to_json: (*untyped) -> String
+      include _ToJson
 
       def sub: (Substitution) -> Block
 
@@ -350,6 +387,8 @@ module RBS
       def initialize: (location: Location?, type: Function, block: Block?) -> void
 
       include _TypeBase
+
+      attr_reader location: Location?
     end
 
     class Literal
@@ -364,6 +403,8 @@ module RBS
       include NoSubst
       include EmptyEachType
       include NoTypeName
+
+      attr_reader location: Location?
     end
   end
 end