rbs 1.1.0 → 1.3.0

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/rbs/writer.rb

@@ -267,8 +267,10 @@ module RBS
       end
 
       if member.overload
-        string << padding
-        string << "|"
+        if member.types.size > 0
+          string << padding
+          string << "|"
+        end
         string << " ...\n"
       end
 

data/rbs.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
   end
   spec.files << "lib/rbs/parser.rb"
   spec.bindir        = "exe"

data/sig/ancestor_builder.rbs

@@ -80,6 +80,7 @@ module RBS
       def interface_ancestors: (TypeName, ?building_ancestors: Array[Definition::Ancestor::t]) -> Definition::InstanceAncestors
 
       def mixin_ancestors: (Environment::ClassEntry | Environment::ModuleEntry,
+                            TypeName,
                             included_modules: Array[Definition::Ancestor::Instance]?,
                          included_interfaces:Array[Definition::Ancestor::Instance]?,
                            prepended_modules: Array[Definition::Ancestor::Instance]?,
@@ -87,6 +88,7 @@ module RBS
                          extended_interfaces: Array[Definition::Ancestor::Instance]?) -> void
 
       def mixin_ancestors0: (AST::Declarations::Class | AST::Declarations::Module | AST::Declarations::Interface,
+                             TypeName,
                              align_params: Substitution?,
                          included_modules: Array[Definition::Ancestor::Instance]?,
                       included_interfaces:Array[Definition::Ancestor::Instance]?,

data/sig/annotation.rbs

@@ -20,7 +20,7 @@ module RBS
 
       def hash: () -> Integer
 
-      def to_json: (*untyped) -> String
+      include _ToJson
     end
   end
 end

data/sig/cli.rbs

@@ -8,51 +8,61 @@ module RBS
       attr_reader repos: Array[String]
 
       def initialize: () -> void
-                    
+
       def loader: () -> EnvironmentLoader
+
+      def setup_library_options: (OptionParser) -> OptionParser
+    end
+
+    interface _IO
+      def puts: (*untyped) -> void
+
+      def print: (*untyped) -> void
+
+      def flush: () -> void
     end
 
-    attr_reader stdout: IO
-    attr_reader stderr: IO
+    attr_reader stdout: _IO
+    attr_reader stderr: _IO
 
     def initialize: (stdout: IO, stderr: IO) -> void
-                  
+
     COMMANDS: Array[Symbol]
 
     def library_parse: (OptionParser, options: LibraryOptions) -> void
-                     
+
     def parse_logging_options: (OptionParser) -> void
-                             
+
     def has_parser?: () -> bool
-                   
+
     def run: (Array[String] args) -> void
-           
+
     def run_ast: (Array[String], LibraryOptions) -> void
-               
+
     def run_list: (Array[String], LibraryOptions) -> void
-                
+
     def run_ancestors: (Array[String], LibraryOptions) -> void
-                     
+
     def run_methods: (Array[String], LibraryOptions) -> void
-                   
+
     def run_method: (Array[String], LibraryOptions) -> void
-                  
+
     def run_validate: (Array[String], LibraryOptions) -> void
-                    
+
     def run_constant: (Array[String], LibraryOptions) -> void
-                    
+
     def run_paths: (Array[String], LibraryOptions) -> void
-                 
+
     def run_prototype: (Array[String], LibraryOptions) -> void
-                     
+
     def run_prototype_file: (String format, Array[String]) -> void
-                          
+
     def run_vendor: (Array[String], LibraryOptions) -> void
-                  
+
     def run_parse: (Array[String], LibraryOptions) -> void
-                 
+
     def run_test: (Array[String], LibraryOptions) -> void
-                
+
     def test_opt: (LibraryOptions) -> String?
   end
 end

data/sig/comment.rbs

@@ -18,7 +18,7 @@ module RBS
 
       def hash: () -> Integer
 
-      def to_json: (*untyped) -> String
+      include _ToJson
 
       def concat: (string: String, location: Location?) -> self
     end

data/sig/declarations.rbs

@@ -10,11 +10,21 @@ module RBS
 
       class ModuleTypeParams
         class TypeParam
+          # Key
+          # ^^^ name
+          #
+          # unchecked out Elem
+          # ^^^^^^^^^          unchecked
+          #           ^^^      variance
+          #               ^^^^ name
+          type loc = Location::WithChildren[:name, :variance | :unchecked]
+
           attr_reader name: Symbol
           attr_reader variance: variance
           attr_reader skip_validation: bool
+          attr_reader location: loc?
 
-          def initialize: (name: Symbol, variance: variance, skip_validation: boolish) -> void
+          def initialize: (name: Symbol, variance: variance, skip_validation: boolish, location: loc?) -> void
 
           include _ToJson
         end
@@ -68,19 +78,42 @@ module RBS
       end
 
       class Class < Base
-        type member = Members::t | t
-
         class Super
+          # String
+          # ^^^^^^  name
+          #
+          # Array[String]
+          # ^^^^^         name
+          #      ^^^^^^^^ args
+          #
+          type loc = Location::WithChildren[:name, :args]
+
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
-          attr_reader location: Location?
+          attr_reader location: loc?
 
-          def initialize: (name: TypeName, args: Array[Types::t], location: Location?) -> void
+          def initialize: (name: TypeName, args: Array[Types::t], location: loc?) -> void
 
           include _HashEqual
           include _ToJson
         end
 
+        type member = Members::t | t
+
+        # class Foo end
+        # ^^^^^         keyword
+        #       ^^^     name
+        #           ^^^ end
+        #
+        # class Foo[A] < String end
+        # ^^^^^                     keyword
+        #       ^^^                 name
+        #          ^^^              type_params
+        #              ^            lt
+        #                       ^^^ end
+        #
+        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :lt]
+
         include NestedDeclarationHelper
         include MixinHelper
 
@@ -89,24 +122,28 @@ module RBS
         attr_reader members: Array[member]
         attr_reader super_class: Super?
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], super_class: Super?, annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], super_class: Super?, annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include _HashEqual
         include _ToJson
       end
 
       class Module < Base
-        type member = Members::t | t
-
         class Self
+          # _Each[String]
+          # ^^^^^         name
+          #      ^^^^^^^^ args
+          #
+          type loc = Location::WithChildren[:name, :args]
+
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
-          attr_reader location: Location?
+          attr_reader location: loc?
 
-          def initialize: (name: TypeName, args: Array[Types::t], location: Location?) -> void
+          def initialize: (name: TypeName, args: Array[Types::t], location: loc?) -> void
 
           include _HashEqual
           include _ToJson
@@ -114,18 +151,35 @@ module RBS
           def to_s: () -> String
         end
 
+        type member = Members::t | t
+
+        # module Foo end
+        # ^^^^^^         keyword
+        #        ^^^     name
+        #            ^^^ end
+        #
+        # module Foo[A] : BasicObject end
+        # ^^^^^^                          keyword
+        #        ^^^                      name
+        #           ^^^                   type_params
+        #               ^                 colon
+        #                 ^^^^^^^^^^^     self_types
+        #                             ^^^ end
+        #
+        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :colon | :self_types]
+
         include NestedDeclarationHelper
         include MixinHelper
 
         attr_reader name: TypeName
         attr_reader type_params: ModuleTypeParams
         attr_reader members: Array[member]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader annotations: Array[Annotation]
         attr_reader self_types: Array[Self]
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], location: Location?, annotations: Array[Annotation], self_types: Array[Self], comment: Comment?) -> void
+        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], location: loc?, annotations: Array[Annotation], self_types: Array[Self], comment: Comment?) -> void
 
         include _HashEqual
         include _ToJson
@@ -134,14 +188,27 @@ module RBS
       class Interface
         type member = Members::t
 
+        # interface _Foo end
+        # ^^^^^^^^^          keyword
+        #           ^^^^     name
+        #                ^^^ end
+        #
+        # interface _Bar[A, B] end
+        # ^^^^^^^^^                keyword
+        #           ^^^^           name
+        #               ^^^^^^     type_params
+        #                      ^^^ end
+        #
+        type loc = Location::WithChildren[:name | :keyword | :end, :type_params]
+
         attr_reader name: TypeName
         attr_reader type_params: ModuleTypeParams
         attr_reader members: Array[member]
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (name: TypeName, type_params: ModuleTypeParams, members: Array[member], annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include MixinHelper
 
@@ -150,37 +217,55 @@ module RBS
       end
 
       class Alias < Base
+        # type loc = Location
+        # ^^^^                keyword
+        #      ^^^            name
+        #          ^          eq
+        type loc = Location::WithChildren[:keyword | :name | :eq, bot]
+
         attr_reader name: TypeName
         attr_reader type: Types::t
         attr_reader annotations: Array[Annotation]
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, type: Types::t, annotations: Array[Annotation], location: Location?, comment: Comment?) -> void
+        def initialize: (name: TypeName, type: Types::t, annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
 
         include _HashEqual
         include _ToJson
       end
 
       class Constant < Base
+        # VERSION: String
+        # ^^^^^^^         name
+        #        ^        colon
+        #
+        type loc = Location::WithChildren[:name | :colon, bot]
+
         attr_reader name: TypeName
         attr_reader type: Types::t
-        attr_reader location: Location?
+        attr_reader location: loc?
         attr_reader comment: Comment?
 
-        def initialize: (name: TypeName, type: Types::t, location: Location?, comment: Comment?) -> void
+        def initialize: (name: TypeName, type: Types::t, location: loc?, comment: Comment?) -> void
 
         include _HashEqual
         include _ToJson
       end
 
       class Global < Base
+        # $SIZE: String
+        # ^^^^^         name
+        #      ^        colon
+        #
+        type loc = Location::WithChildren[:name | :colon, bot]
+
         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
         include _ToJson

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/errors.rbs

@@ -181,4 +181,19 @@ module RBS
 
     def location: () -> Location?
   end
+
+  class MixinClassError < DefinitionError
+    type member = AST::Members::Include | AST::Members::Prepend | AST::Members::Extend
+
+    attr_reader type_name: TypeName
+    attr_reader member: member
+
+    def initialize: (type_name: TypeName, member: member) -> void
+
+    def location: () -> Location?
+
+    def self.check!: (type_name: TypeName, env: Environment, member: member) -> void
+
+    def mixin_name: () -> String
+  end
 end

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