rbs 2.1.0 → 2.2.0

data/lib/rbs/definition_builder/method_builder.rb

@@ -10,7 +10,11 @@ module RBS
           end
 
           def accessibility
-            accessibilities[0]
+            if original.is_a?(AST::Members::Alias)
+              raise "alias member doesn't have accessibility"
+            else
+              accessibilities[0] or raise
+            end
           end
 
           def self.empty(name:, type:)
@@ -102,22 +106,32 @@ module RBS
                 each_member_with_accessibility(d.decl.members) do |member, accessibility|
                   case member
                   when AST::Members::MethodDefinition
-                    if member.instance?
-                      build_method(methods,
-                                   type,
-                                   member: member.update(types: member.types.map {|type| type.sub(subst) }),
-                                   accessibility: accessibility)
+                    case member.kind
+                    when :instance
+                      build_method(
+                        methods,
+                        type,
+                        member: member.update(types: member.types.map {|type| type.sub(subst) }),
+                        accessibility: member.visibility || accessibility
+                      )
+                    when :singleton_instance
+                      build_method(
+                        methods,
+                        type,
+                        member: member.update(types: member.types.map {|type| type.sub(subst) }),
+                        accessibility: :private
+                      )
                     end
                   when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
                     if member.kind == :instance
                       build_attribute(methods,
                                       type,
                                       member: member.update(type: member.type.sub(subst)),
-                                      accessibility: accessibility)
+                                      accessibility: member.visibility || accessibility)
                     end
                   when AST::Members::Alias
                     if member.kind == :instance
-                      build_alias(methods, type, member: member, accessibility: accessibility)
+                      build_alias(methods, type, member: member)
                     end
                   end
                 end
@@ -134,19 +148,19 @@ module RBS
 
             Methods.new(type: type).tap do |methods|
               entry.decls.each do |d|
-                each_member_with_accessibility(d.decl.members) do |member, accessibility|
+                d.decl.members.each do |member|
                   case member
                   when AST::Members::MethodDefinition
                     if member.singleton?
-                      build_method(methods, type, member: member, accessibility: accessibility)
+                      build_method(methods, type, member: member, accessibility: member.visibility || :public)
                     end
                   when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
                     if member.kind == :singleton
-                      build_attribute(methods, type, member: member, accessibility: accessibility)
+                      build_attribute(methods, type, member: member, accessibility: member.visibility || :public)
                     end
                   when AST::Members::Alias
                     if member.kind == :singleton
-                      build_alias(methods, type, member: member, accessibility: accessibility)
+                      build_alias(methods, type, member: member)
                     end
                   end
                 end
@@ -168,18 +182,16 @@ module RBS
                 when AST::Members::MethodDefinition
                   build_method(methods, type, member: member, accessibility: :public)
                 when AST::Members::Alias
-                  build_alias(methods, type, member: member, accessibility: :public)
+                  build_alias(methods, type, member: member)
                 end
               end
             end.validate!
           end
       end
 
-      def build_alias(methods, type, member:, accessibility:)
+      def build_alias(methods, type, member:)
         defn = methods.methods[member.new_name] ||= Methods::Definition.empty(type: type, name: member.new_name)
-
         defn.originals << member
-        defn.accessibilities << accessibility
       end
 
       def build_attribute(methods, type, member:, accessibility:)

data/lib/rbs/definition_builder.rb

@@ -587,7 +587,7 @@ module RBS
             defs: original_method.defs.map do |defn|
               defn.update(defined_in: definition.type_name, implemented_in: definition.type_name)
             end,
-            accessibility: method_def.accessibility,
+            accessibility: original_method.accessibility,
             alias_of: original_method
           )
         else

data/lib/rbs/environment.rb

@@ -357,7 +357,8 @@ module RBS
           comment: member.comment,
           overload: member.overload?,
           annotations: member.annotations,
-          location: member.location
+          location: member.location,
+          visibility: member.visibility
         )
       when AST::Members::AttrAccessor
         AST::Members::AttrAccessor.new(
@@ -367,7 +368,8 @@ module RBS
           annotations: member.annotations,
           comment: member.comment,
           location: member.location,
-          ivar_name: member.ivar_name
+          ivar_name: member.ivar_name,
+          visibility: member.visibility
         )
       when AST::Members::AttrReader
         AST::Members::AttrReader.new(
@@ -377,7 +379,8 @@ module RBS
           annotations: member.annotations,
           comment: member.comment,
           location: member.location,
-          ivar_name: member.ivar_name
+          ivar_name: member.ivar_name,
+          visibility: member.visibility
         )
       when AST::Members::AttrWriter
         AST::Members::AttrWriter.new(
@@ -387,7 +390,8 @@ module RBS
           annotations: member.annotations,
           comment: member.comment,
           location: member.location,
-          ivar_name: member.ivar_name
+          ivar_name: member.ivar_name,
+          visibility: member.visibility
         )
       when AST::Members::InstanceVariable
         AST::Members::InstanceVariable.new(

data/lib/rbs/namespace.rb

@@ -59,7 +59,7 @@ module RBS
     alias eql? ==
 
     def hash
-      self.class.hash ^ path.hash ^ absolute?.hash
+      path.hash ^ absolute?.hash
     end
 
     def split

data/lib/rbs/type_name.rb

@@ -27,7 +27,7 @@ module RBS
     alias eql? ==
 
     def hash
-      self.class.hash ^ namespace.hash ^ name.hash
+      namespace.hash ^ name.hash
     end
 
     def to_s

data/lib/rbs/types.rb

@@ -213,7 +213,7 @@ module RBS
       alias eql? ==
 
       def hash
-        self.class.hash ^ name.hash ^ args.hash
+        name.hash ^ args.hash
       end
 
       def free_variables(set = Set.new)

data/lib/rbs/validator.rb

@@ -73,6 +73,8 @@ module RBS
         if set = result.incompatible?(entry.decl.type_params)
           set.each do |param_name|
             param = entry.decl.type_params.find {|param| param.name == param_name } or raise
+            next if param.unchecked?
+
             raise InvalidVarianceAnnotationError.new(
               type_name: type_name,
               param: param,

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/rbs/writer.rb

@@ -6,6 +6,16 @@ module RBS
     def initialize(out:)
       @out = out
       @indentation = []
+      @preserve = false
+    end
+
+    def preserve?
+      @preserve
+    end
+
+    def preserve!(preserve: true)
+      @preserve = preserve
+      self
     end
 
     def indent(size = 2)
@@ -119,7 +129,9 @@ module RBS
       when AST::Declarations::Alias
         write_comment decl.comment
         write_annotation decl.annotations
-        puts "type #{name_and_params(decl.name, decl.type_params)} = #{decl.type}"
+        write_loc_source(decl) {
+          puts "type #{name_and_params(decl.name, decl.type_params)} = #{decl.type}"
+        }
 
       when AST::Declarations::Interface
         write_comment decl.comment
@@ -163,6 +175,16 @@ module RBS
       end
     end
 
+    def put_lines(lines, leading_spaces:)
+      lines.each_line.with_index do |line, index|
+        line.chomp!
+        line.rstrip!
+        line.sub!(/\A( {,#{leading_spaces}})/, '') if index > 0
+
+        puts line
+      end
+    end
+
     def write_member(member)
       case member
       when AST::Members::Include
@@ -211,7 +233,7 @@ module RBS
       when AST::Members::MethodDefinition
         write_comment member.comment
         write_annotation member.annotations
-        write_def member
+        write_loc_source(member) { write_def member }
       else
         write_decl member
       end
@@ -230,7 +252,25 @@ module RBS
       end
     end
 
+    def write_loc_source(located)
+      if preserve? && loc = located.location
+        put_lines(loc.source, leading_spaces: loc.start_column)
+      else
+        yield
+      end
+    end
+
     def write_def(member)
+      visibility =
+        case member.visibility
+        when :public
+          "public "
+        when :private
+          "private "
+        else
+          ""
+        end
+
       name = case member.kind
              when :instance
                "#{method_name(member.name)}"
@@ -242,7 +282,7 @@ module RBS
 
       string = ""
 
-      prefix = "def #{name}:"
+      prefix = "#{visibility}def #{name}:"
       padding = " " * (prefix.size-1)
 
       string << prefix
@@ -270,6 +310,16 @@ module RBS
     end
 
     def attribute(kind, attr)
+      visibility =
+        case attr.visibility
+        when :public
+          "public "
+        when :private
+          "private "
+        else
+          ""
+        end
+
       var = case attr.ivar_name
             when nil
               ""
@@ -286,7 +336,7 @@ module RBS
                    ""
                  end
 
-      "attr_#{kind} #{receiver}#{attr.name}#{var}: #{attr.type}"
+      "#{visibility}attr_#{kind} #{receiver}#{attr.name}#{var}: #{attr.type}"
     end
 
     def preserve_empty_line(prev, decl)

data/lib/rbs.rb

@@ -7,9 +7,7 @@ require "pp"
 require "ripper"
 require "logger"
 require "tsort"
-require "strscan"
 
-require "rbs/char_scanner"
 require "rbs/errors"
 require "rbs/buffer"
 require "rbs/namespace"

data/schema/typeParam.json

@@ -15,13 +15,13 @@
     "upper_bound": {
       "oneOf": [
         {
-          "$ref": "types.json#definitions/classInstance"
+          "$ref": "types.json#/definitions/classInstance"
         },
         {
-          "$ref": "types.json#definitions/classSingleton"
+          "$ref": "types.json#/definitions/classSingleton"
         },
         {
-          "$ref": "types.json#definitions/interface"
+          "$ref": "types.json#/definitions/interface"
         },
         {
           "type": "null"

data/sig/annotate/rdoc_annotater.rbs

@@ -8,7 +8,7 @@ module RBS
 
       def initialize: (source: RDocSource) -> void
 
-      def annotate_file: (Pathname) -> void
+      def annotate_file: (Pathname, preserve: bool) -> void
 
       def annotate_decls: (Array[AST::Declarations::t], ?outer: Array[Namespace]) -> void
 

data/sig/buffer.rbs

@@ -11,12 +11,16 @@ module RBS
     # The content of the buffer.
     attr_reader content: String
 
-    attr_reader lines: Array[String]
+    @lines: Array[String]
 
-    attr_reader ranges: Array[Range[Integer]]
+    @ranges: Array[Range[Integer]]
 
     def initialize: (name: untyped name, content: String content) -> void
 
+    def lines: () -> Array[String]
+
+    def ranges: () -> Array[Range[Integer]]
+
     # Translate position to location.
     def pos_to_loc: (Integer pos) -> loc
 

data/sig/members.rbs

@@ -12,6 +12,8 @@ module RBS
       class Base
       end
 
+      type visibility = :public | :private
+
       class MethodDefinition < Base
         type kind = :instance | :singleton | :singleton_instance
 
@@ -19,13 +21,14 @@ module RBS
         # ^^^                    keyword
         #     ^^^                name
         #
-        # def self.bar: () -> void | ...
-        # ^^^                              keyword
-        #     ^^^^^                        kind
-        #          ^^^                     name
-        #                            ^^^   overload
+        # private def self.bar: () -> void | ...
+        # ^^^^^^^                                  visibility
+        #         ^^^                              keyword
+        #             ^^^^^                        kind
+        #                  ^^^                     name
+        #                                    ^^^   overload
         #
-        type loc = Location[:keyword | :name, :kind | :overload]
+        type loc = Location[:keyword | :name, :kind | :overload | :visibility]
 
         attr_reader name: Symbol
         attr_reader kind: kind
@@ -34,8 +37,9 @@ module RBS
         attr_reader location: loc?
         attr_reader comment: Comment?
         attr_reader overload: bool
+        attr_reader visibility: visibility?
 
-        def initialize: (name: Symbol, kind: kind, types: Array[MethodType], annotations: Array[Annotation], location: loc?, comment: Comment?, overload: boolish) -> void
+        def initialize: (name: Symbol, kind: kind, types: Array[MethodType], annotations: Array[Annotation], location: loc?, comment: Comment?, overload: boolish, ?visibility: visibility?) -> void
 
         include _HashEqual
         include _ToJson
@@ -46,7 +50,7 @@ module RBS
 
         def overload?: () -> bool
 
-        def update: (?name: Symbol, ?kind: kind, ?types: Array[MethodType], ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?, ?overload: boolish) -> MethodDefinition
+        def update: (?name: Symbol, ?kind: kind, ?types: Array[MethodType], ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?, ?overload: boolish, ?visibility: visibility?) -> MethodDefinition
       end
 
       module Var
@@ -133,15 +137,16 @@ module RBS
         #             ^^^^             name
         #                 ^            colon
         #
-        # attr_accessor self.name (@foo) : String
-        # ^^^^^^^^^^^^^                             keyword
-        #               ^^^^^                       kind
-        #                    ^^^^                   name
-        #                         ^^^^^^            ivar
-        #                          ^^^^             ivar_name
-        #                                ^          colon
+        # public attr_accessor self.name (@foo) : String
+        # ^^^^^^                                           visibility
+        #        ^^^^^^^^^^^^^                             keyword
+        #                      ^^^^^                       kind
+        #                           ^^^^                   name
+        #                                ^^^^^^            ivar
+        #                                 ^^^^             ivar_name
+        #                                       ^          colon
         #
-        type loc = Location[:keyword | :name | :colon, :kind | :ivar | :ivar_name]
+        type loc = Location[:keyword | :name | :colon, :kind | :ivar | :ivar_name | :visibility]
 
         attr_reader name: Symbol
         attr_reader type: Types::t
@@ -150,12 +155,13 @@ module RBS
         attr_reader annotations: Array[Annotation]
         attr_reader location: loc?
         attr_reader comment: Comment?
+        attr_reader visibility: visibility?
 
-        def initialize: (name: Symbol, type: Types::t, ivar_name: Symbol | false | nil, kind: kind, annotations: Array[Annotation], location: loc?, comment: Comment?) -> void
+        def initialize: (name: Symbol, type: Types::t, ivar_name: Symbol | false | nil, kind: kind, annotations: Array[Annotation], location: loc?, comment: Comment?, ?visibility: visibility?) -> void
 
         include _HashEqual
 
-        def update: (?name: Symbol, ?type: Types::t, ?ivar_name: Symbol | false | nil, ?kind: kind, ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?) -> instance
+        def update: (?name: Symbol, ?type: Types::t, ?ivar_name: Symbol | false | nil, ?kind: kind, ?annotations: Array[Annotation], ?location: loc?, ?comment: Comment?, ?visibility: visibility) -> instance
       end
 
       class AttrReader < Base

data/sig/method_builder.rbs

@@ -6,7 +6,8 @@ module RBS
 
         class Definition
           type original = AST::Members::MethodDefinition | AST::Members::Alias | AST::Members::AttrAccessor | AST::Members::AttrWriter | AST::Members::AttrReader
-          type accessibility = :public | :private
+
+          type accessibility = RBS::Definition::accessibility
 
           attr_reader name: Symbol
           attr_reader type: instance_type
@@ -59,11 +60,11 @@ module RBS
 
       def build_interface: (TypeName) -> Methods
 
-      def build_alias: (Methods, Methods::instance_type, member: AST::Members::Alias, accessibility: Methods::Definition::accessibility) -> void
+      def build_alias: (Methods, Methods::instance_type, member: AST::Members::Alias) -> void
 
-      def build_attribute: (Methods, Methods::instance_type, member: AST::Members::AttrAccessor | AST::Members::AttrReader | AST::Members::AttrWriter, accessibility: Methods::Definition::accessibility) -> void
+      def build_attribute: (Methods, Methods::instance_type, member: AST::Members::AttrAccessor | AST::Members::AttrReader | AST::Members::AttrWriter, accessibility: Definition::accessibility) -> void
 
-      def build_method: (Methods, Methods::instance_type, member: AST::Members::MethodDefinition, accessibility: Methods::Definition::accessibility) -> void
+      def build_method: (Methods, Methods::instance_type, member: AST::Members::MethodDefinition, accessibility: Definition::accessibility) -> void
 
       def each_member_with_accessibility: (Array[AST::Members::t | AST::Declarations::t], ?accessibility: Definition::accessibility) { (AST::Members::t | AST::Declarations::t, Definition::accessibility) -> void } -> void
 

data/sig/writer.rbs

@@ -1,4 +1,6 @@
 module RBS
+  # Writer prints RBS AST to String.
+  #
   class Writer
     interface _IO
       def puts: (*untyped) -> void
@@ -6,23 +8,96 @@ module RBS
       def flush: () -> void
     end
 
+    # Channel to output the result.
+    #
     attr_reader out: _IO
+
+    # Array of indentations.
+    #
     attr_reader indentation: Array[String]
 
     def initialize: (out: _IO) -> void
 
+    # Output the array of declarations.
+    # It automatically inserts empty lines between the declarations.
+    #
+    def write: (Array[AST::Declarations::t]) -> void
+
+    def preserve?: () -> bool
+
+    def preserve!: (?preserve: bool) -> self
+
+    private
+
+    @preserve: bool
+
+    # Increases the indentation and yields the block.
+    #
     def indent: (?Integer size) { () -> void } -> void
 
+    # Returns the current indentation of lines.
+    #
     def prefix: () -> String
 
+    # Prints a string.
+    # Automatically appends the `#prefix` and newline at the end.
+    #
     def puts: (?String) -> void
 
+    # Prints a (possibly) multi-line string.
+    #
+    # Drops `leading_spaces` of spaces at the beginning of each line.
+    #
+    # ```ruby
+    # put_lines(<<TEXT, leading_spaces: 0)
+    # Hello
+    #   world!
+    # TEXT
+    #
+    # # Outputs
+    # # Hello
+    # #   world!
+    #
+    # put_lines(<<TEXT, leading_spaces: 2)
+    # Hello
+    #   world!
+    # TEXT
+    #
+    # # Outputs
+    # # Hello
+    # # world!
+    # ```
+    #
+    # This is for `Location#source`.
+    # The `#source` returns the text spans from the beginning to end of the element.
+    # It will look like the following.
+    #
+    # ```rbs
+    # module Foo
+    #   type t = Integer     # the definition of `t` starts from line=2, column=2
+    #          | String
+    #          | :false      # the definition of `t` ends from line=4, column=17
+    # end
+    # ```
+    #
+    # The expected output will be something like:
+    #
+    # ```rbs
+    # type t = Integer       # Extracted from `Foo` definition and keeps the line breaks
+    #        | String
+    #        | :false
+    # ```
+    #
+    # And it can be done with a `#put_lines(source, leading_spaces: 2)` call.
+    #
+    def put_lines: (String, leading_spaces: Integer) -> void
+
+    def write_loc_source: (_Located) { () -> void } -> void
+
     def write_annotation: (Array[AST::Annotation]) -> void
 
     def write_comment: (AST::Comment?) -> void
 
-    def write: (Array[AST::Declarations::t]) -> void
-
     def write_decl: (AST::Declarations::t) -> void
 
     def write_member: (AST::Declarations::Module::member) -> void
@@ -31,6 +106,8 @@ module RBS
 
     def name_and_args: (TypeName, Array[Types::t]) -> String?
 
+    def write_alias: (AST::Declarations::Alias) -> void
+
     def method_name: (Symbol) -> String
 
     def write_def: (AST::Members::MethodDefinition) -> void

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

@@ -1,2 +1,3 @@
 dependencies:
   - name: uri
+  - name: timeout

data/stdlib/net-http/0/net-http.rbs

@@ -33,6 +33,27 @@ module Net
   class HTTPHeaderSyntaxError < StandardError
   end
 
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # OpenTimeout, a subclass of Timeout::Error, is raised if a connection cannot be
+  # created within the open_timeout.
+  #
+  class OpenTimeout < Timeout::Error
+  end
+
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # ReadTimeout, a subclass of Timeout::Error, is raised if a chunk of the
+  # response cannot be read within the read_timeout.
+  #
+  class ReadTimeout < Timeout::Error
+  end
+
+  # <!-- rdoc-file=lib/net/protocol.rb -->
+  # WriteTimeout, a subclass of Timeout::Error, is raised if a chunk of the
+  # response cannot be written within the write_timeout.  Not raised on Windows.
+  #
+  class WriteTimeout < Timeout::Error
+  end
+
   # <!-- rdoc-file=lib/net/http.rb -->
   # ## An HTTP client API for Ruby.
   #

data/stdlib/uri/0/generic.rbs

@@ -880,7 +880,7 @@ module URI
     #     uri.merge!("/main.rbx?page=1")
     #     uri.to_s  # => "http://my.example.com/main.rbx?page=1"
     #
-    def merge!: (string oth) -> String
+    def merge!: (URI::Generic | string oth) -> String
 
     # <!--
     #   rdoc-file=lib/uri/generic.rb
@@ -904,7 +904,7 @@ module URI
     #     uri.merge("/main.rbx?page=1")
     #     # => "http://my.example.com/main.rbx?page=1"
     #
-    def merge: (string oth) -> URI::Generic
+    def merge: (URI::Generic | string oth) -> URI::Generic
 
     # :stopdoc:
     def route_from_path: (String src, String dst) -> String