rbs 3.0.0.dev.2 → 3.0.0

data/lib/rbs/errors.rb

@@ -20,7 +20,25 @@ module RBS
   class LoadingError < BaseError; end
   class DefinitionError < BaseError; end
 
+  module DetailedMessageable
+    def detailed_message(highlight: false, **)
+      indent = " " * location.start_column
+      marker = "^" * (location.end_column - location.start_column)
+
+      io = StringIO.new
+      io.puts super
+      io.puts
+      io.print "\e[1m" if highlight
+      io.puts "  #{location.buffer.lines[location.end_line - 1]}"
+      io.puts "  #{indent}#{marker}"
+      io.print "\e[m" if highlight
+      io.string
+    end
+  end
+
   class ParsingError < BaseError
+    include DetailedMessageable
+
     attr_reader :location
     attr_reader :error_message
     attr_reader :token_type

data/lib/rbs/locator.rb

@@ -2,21 +2,24 @@
 
 module RBS
   class Locator
-    attr_reader :decls
+    attr_reader :decls, :dirs, :buffer
 
-    def initialize(decls:)
+    def initialize(buffer:, dirs:, decls:)
+      @buffer = buffer
+      @dirs = dirs
       @decls = decls
     end
 
-    def buffer
-      decls[0].location&.buffer or raise
-    end
-
     def find(line:, column:)
       pos = buffer.loc_to_pos([line, column])
 
+      dirs.each do |dir|
+        array = [] #: Array[component]
+        find_in_directive(pos, dir, array) and return array
+      end
+
       decls.each do |decl|
-        array = []
+        array = [] #: Array[component]
         find_in_decl(pos, decl: decl, array: array) and return array
       end
 
@@ -36,6 +39,22 @@ module RBS
       end
     end
 
+    def find_in_directive(pos, dir, array)
+      if test_loc(pos, location: dir.location)
+        array.unshift(dir)
+
+        dir.clauses.each do |clause|
+          if test_loc(pos, location: clause.location)
+            array.unshift(clause)
+            find_in_loc(pos, location: clause.location, array: array)
+            return true
+          end
+        end
+      end
+
+      false
+    end
+
     def find_in_decl(pos, decl:, array:)
       if test_loc(pos, location: decl.location)
         array.unshift(decl)

data/lib/rbs/sorter.rb

@@ -34,7 +34,7 @@ module RBS
         -3
       when Declarations::Constant
         -2
-      when Declarations::Class, Declarations::Module
+      when Declarations::Class, Declarations::Module, Declarations::Interface
         -1
       when Members::Include
         0.0
@@ -102,7 +102,7 @@ module RBS
         member.name.to_s
       when Declarations::TypeAlias
         member.name.to_s
-      when Declarations::Class, Declarations::Module
+      when Declarations::Class, Declarations::Module, Declarations::Interface
         member.name.to_s
       else
         raise

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.0.0.dev.2"
+  VERSION = "3.0.0"
 end

data/sig/collection/sources.rbs

@@ -1,8 +1,8 @@
 module RBS
   module Collection
     module Sources
-      def self.from_config_entry: (Git::source_entry) -> Git
-                                | (source_entry) -> t
+      def self.from_config_entry: (Git::source_entry, base_directory: Pathname) -> Git
+                                | (source_entry, base_directory: Pathname) -> t
 
       interface _Source
         def has?: (String name, String? version) -> boolish
@@ -13,11 +13,12 @@ module RBS
         def dependencies_of: (String name, String version) -> Array[manifest_dependency]?
       end
 
-      type t = Git | Stdlib | Rubygems
+      type t = Git | Stdlib | Rubygems | Local
 
       type source_entry = Git::source_entry
                         | Stdlib::source_entry
                         | Rubygems::source_entry
+                        | Local::source_entry
 
       type manifest_entry = {
         "dependencies" => Array[manifest_dependency]?,
@@ -126,6 +127,34 @@ module RBS
         def gems_versions: () -> Hash[String, Set[String]]
       end
 
+      class Local
+        include Base
+
+        type source_entry = {
+          'type' => 'local',
+          'path' => String,
+        }
+
+        attr_reader path: Pathname
+        attr_reader full_path: Pathname
+
+        def initialize: (path: String, base_directory: Pathname) -> void
+
+        def has?: (String name, String? version) -> boolish
+
+        def versions: (String name) -> Array[String]
+
+        def install: (dest: Pathname, name: String, version: String, stdout: CLI::_IO) -> void
+
+        def to_lockfile: () -> source_entry
+
+        def manifest_of: (String name, String version) -> manifest_entry?
+
+        private
+
+        def _install: (Pathname src, Pathname dest) -> void
+      end
+
       # signatures that are bundled in rbs gem under the stdlib/ directory
       class Stdlib
 

data/sig/environment.rbs

@@ -111,7 +111,9 @@ module RBS
     # Global declarations
     attr_reader global_decls: Hash[Symbol, GlobalEntry]
 
-    attr_reader buffer_directives: Hash[Buffer, Array[AST::Directives::t]]
+    # A hash from Buffer to it's contents
+    #
+    attr_reader signatures: Hash[Buffer, [Array[AST::Directives::t], Array[AST::Declarations::t]]]
 
     def initialize: () -> void
 
@@ -141,16 +143,11 @@ module RBS
 
     def inspect: () -> String
 
-    @buffers: Array[Buffer]
-
     def buffers: () -> Array[Buffer]
 
-    def buffers_decls: () -> Hash[Buffer, Array[AST::Declarations::t]]
-
-    # Construct new environment without declarations tested `true` by block.
-    # Construction of new environment is done with `<<` so that nested declarations will work well.
+    # Remove declarations and directives that are loaded from `buffers`
     #
-    def reject: () { (AST::Declarations::t) -> boolish } -> Environment
+    def unload: (Set[Buffer] buffers) -> Environment
 
     # Returns true if an interface with the type name is defined
     #

data/sig/locator.rbs

@@ -10,14 +10,22 @@ module RBS
                    | AST::TypeParam
                    | AST::Declarations::Class::Super
                    | AST::Declarations::Module::Self
+                   | AST::Directives::t
+                   | AST::Directives::Use::clause
+
+    # The buffer the location points to
+    #
+    attr_reader buffer: Buffer
 
     # Array of _top-level_ declarations.
     #
     attr_reader decls: Array[AST::Declarations::t]
 
-    def initialize: (decls: Array[AST::Declarations::t]) -> void
+    # Array of directives.
+    #
+    attr_reader dirs: Array[AST::Directives::t]
 
-    def buffer: () -> Buffer
+    def initialize: (buffer: Buffer, decls: Array[AST::Declarations::t], dirs: Array[AST::Directives::t]) -> void
 
     # Returns list of components.
     # Inner component comes first.
@@ -29,6 +37,10 @@ module RBS
     #
     def find2: (line: Integer, column: Integer) -> [Symbol?, Array[component]]?
 
+    private
+
+    def find_in_directive: (Integer pos, AST::Directives::t, Array[component]) -> bool
+
     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

data/stdlib/bigdecimal/0/big_decimal.rbs

@@ -145,12 +145,8 @@ class BigDecimal < Numeric
 
   # <!--
   #   rdoc-file=ext/bigdecimal/bigdecimal.c
-  #   - BigDecimal.double_fig -> integer
+  #   - double_fig()
   # -->
-  # Returns the number of digits a Float object is allowed to have; the result is
-  # system-dependent:
-  #
-  #     BigDecimal.double_fig # => 16
   #
   def self.double_fig: () -> Integer
 
@@ -1007,7 +1003,9 @@ class BigDecimal < Numeric
   # -->
   # Returns the sign of the value.
   #
-  # Returns a positive value if > 0, a negative value if < 0, and a zero if == 0.
+  # Returns a positive value if > 0, a negative value if < 0. It behaves the same
+  # with zeros - it returns a positive value for a positive zero (BigDecimal('0'))
+  # and a negative value for a negative zero (BigDecimal('-0')).
   #
   # The specific value returned indicates the type and sign of the BigDecimal, as
   # follows:
@@ -1348,12 +1346,15 @@ module Kernel
   #   - BigDecimal(value, exception: true) -> bigdecimal
   #   - BigDecimal(value, ndigits, exception: true) -> bigdecimal
   # -->
-  # Returns the \BigDecimal converted from +value+
-  #     with a precision of +ndigits+ decimal digits.
+  # Returns the BigDecimal converted from `value` with a precision of `ndigits`
+  # decimal digits.
+  #
+  # When `ndigits` is less than the number of significant digits in the value, the
+  # result is rounded to that number of digits, according to the current rounding
+  # mode; see BigDecimal.mode.
   #
-  #     When +ndigits+ is less than the number of significant digits
-  #     in the value, the result is rounded to that number of digits,
-  #     according to the current rounding mode; see BigDecimal.mode.
+  # When `ndigits` is 0, the number of digits to correctly represent a float
+  # number is determined automatically.
   #
   # Returns `value` converted to a BigDecimal, depending on the type of `value`:
   #
@@ -1486,13 +1487,15 @@ class Float
   #   - float.to_d(precision)  -> bigdecimal
   # -->
   # Returns the value of `float` as a BigDecimal. The `precision` parameter is
-  # used to determine the number of significant digits for the result (the default
-  # is Float::DIG).
+  # used to determine the number of significant digits for the result. When
+  # `precision` is set to `0`, the number of digits to represent the float being
+  # converted is determined automatically. The default `precision` is `0`.
   #
   #     require 'bigdecimal'
   #     require 'bigdecimal/util'
   #
   #     0.5.to_d         # => 0.5e0
+  #     1.234.to_d       # => 0.1234e1
   #     1.234.to_d(2)    # => 0.12e1
   #
   # See also BigDecimal::new.

data/stdlib/cgi/0/core.rbs

@@ -882,6 +882,14 @@ class CGI
     #
     def escapeHTML: (string str) -> String
 
+    # <!--
+    #   rdoc-file=ext/cgi/escape/escape.c
+    #   - CGI.escapeURIComponent(string) -> string
+    # -->
+    # Returns URL-escaped string following RFC 3986.
+    #
+    def escapeURIComponent: (string) -> String
+
     # <!--
     #   rdoc-file=ext/cgi/escape/escape.c
     #   - CGI.unescape(string, encoding=@@accept_charset) -> string
@@ -897,6 +905,14 @@ class CGI
     # Returns HTML-unescaped string.
     #
     def unescapeHTML: (string str) -> String
+
+    # <!--
+    #   rdoc-file=ext/cgi/escape/escape.c
+    #   - CGI.unescapeURIComponent(string, encoding=@@accept_charset) -> string
+    # -->
+    # Returns URL-unescaped string following RFC 3986.
+    #
+    def unescapeURIComponent: (string) -> String
   end
 
   # <!-- rdoc-file=lib/cgi/core.rb -->

data/stdlib/coverage/0/coverage.rbs

@@ -3,7 +3,7 @@
 # experimental, so these APIs may be changed in future.
 #
 # Caveat: Currently, only process-global coverage measurement is supported. You
-# cannot measure per-thread covearge.
+# cannot measure per-thread coverage.
 #
 # # Usage
 #
@@ -153,7 +153,7 @@ module Coverage
   #   - line_stub(file)
   # -->
   #
-  def self.line_stub: () -> Array[Integer?]
+  def self.line_stub: (String) -> Array[Integer?]
 
   # <!--
   #   rdoc-file=ext/coverage/coverage.c
@@ -190,15 +190,41 @@ module Coverage
 
   # <!--
   #   rdoc-file=ext/coverage/coverage.c
-  #   - Coverage.start                                              => nil
-  #   - Coverage.start(:all)                                        => nil
-  #   - Coverage.start(lines: bool, branches: bool, methods: bool)  => nil
-  #   - Coverage.start(oneshot_lines: true)                         => nil
+  #   - Coverage.setup                                                          => nil
+  #   - Coverage.setup(:all)                                                    => nil
+  #   - Coverage.setup(lines: bool, branches: bool, methods: bool, eval: bool)  => nil
+  #   - Coverage.setup(oneshot_lines: true)                                     => nil
+  # -->
+  # Set up the coverage measurement.
+  #
+  # Note that this method does not start the measurement itself. Use
+  # Coverage.resume to start the measurement.
+  #
+  # You may want to use Coverage.start to setup and then start the measurement.
+  #
+  def self.setup: (?lines: bool, ?branches: bool, ?methods: bool, ?eval: bool) -> nil
+                | (oneshot_lines: bool, ?branches: bool, ?methods: bool, ?eval: bool) -> nil
+                | (:all) -> nil
+
+  # <!--
+  #   rdoc-file=ext/coverage/coverage.c
+  #   - Coverage.start                                                          => nil
+  #   - Coverage.start(:all)                                                    => nil
+  #   - Coverage.start(lines: bool, branches: bool, methods: bool, eval: bool)  => nil
+  #   - Coverage.start(oneshot_lines: true)                                     => nil
   # -->
   # Enables the coverage measurement. See the documentation of Coverage class in
   # detail. This is equivalent to Coverage.setup and Coverage.resume.
   #
-  def self.start: (?lines: boolish, ?branches: boolish, ?methods: boolish, ?oneshot_lines: boolish) -> nil
+  alias self.start self.setup
+
+  # <!--
+  #   rdoc-file=ext/coverage/coverage.c
+  #   - Coverage.state  => :idle, :suspended, :running
+  # -->
+  # Returns the state of the coverage measurement.
+  #
+  def self.state: () -> (:idle | :suspended | :running)
 
   # <!--
   #   rdoc-file=ext/coverage/coverage.c
@@ -207,12 +233,28 @@ module Coverage
   # Start/resume the coverage measurement.
   #
   # Caveat: Currently, only process-global coverage measurement is supported. You
-  # cannot measure per-thread covearge. If your process has multiple thread, using
+  # cannot measure per-thread coverage. If your process has multiple thread, using
   # Coverage.resume/suspend to capture code coverage executed from only a limited
   # code block, may yield misleading results.
   #
   def self.resume: () -> nil
 
+  # <!--
+  #   rdoc-file=ext/coverage/coverage.c
+  #   - Coverage.supported?(mode) -> true or false
+  # -->
+  # Returns true if coverage measurement is supported for the given mode.
+  #
+  # The mode should be one of the following symbols: `:lines`, `:branches`,
+  # `:methods`, `:eval`.
+  #
+  # Example:
+  #
+  #     Coverage.supported?(:lines)  #=> true
+  #     Coverage.supported?(:all)    #=> false
+  #
+  def self.supported?: (Symbol) -> bool
+
   # <!--
   #   rdoc-file=ext/coverage/coverage.c
   #   - Coverage.suspend  => nil

data/stdlib/csv/0/csv.rbs

@@ -2488,7 +2488,7 @@ class CSV::Row < Object
   # `index_or_header` and `specifiers`.
   #
   # The nested objects may be instances of various classes. See [Dig
-  # Methods](https://docs.ruby-lang.org/en/master/dig_methods_rdoc.html).
+  # Methods](rdoc-ref:dig_methods.rdoc).
   #
   # Examples:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"