rbs 1.2.0 → 1.3.2

data/stdlib/socket/0/unix_socket.rbs

@@ -0,0 +1,132 @@
+# UNIXSocket represents a UNIX domain stream client socket.
+class UNIXSocket < BasicSocket
+  # Creates a pair of sockets connected to each other.
+  #
+  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  #
+  # *protocol* should be a protocol defined in the domain. 0 is default protocol
+  # for the domain.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #     s1.send "a", 0
+  #     s1.send "b", 0
+  #     p s2.recv(10) #=> "ab"
+  #
+  def self.pair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+
+  # Creates a pair of sockets connected to each other.
+  #
+  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  #
+  # *protocol* should be a protocol defined in the domain. 0 is default protocol
+  # for the domain.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #     s1.send "a", 0
+  #     s1.send "b", 0
+  #     p s2.recv(10) #=> "ab"
+  #
+  def self.socketpair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+
+  public
+
+  # Returns the local address as an array which contains address_family and
+  # unix_path.
+  #
+  # Example
+  #     serv = UNIXServer.new("/tmp/sock")
+  #     p serv.addr #=> ["AF_UNIX", "/tmp/sock"]
+  #
+  def addr: () -> [String, String]
+
+  # Returns the path of the local address of unixsocket.
+  #
+  #     s = UNIXServer.new("/tmp/sock")
+  #     p s.path #=> "/tmp/sock"
+  #
+  def path: () -> String
+
+  # Returns the remote address as an array which contains address_family and
+  # unix_path.
+  #
+  # Example
+  #     serv = UNIXServer.new("/tmp/sock")
+  #     c = UNIXSocket.new("/tmp/sock")
+  #     p c.peeraddr #=> ["AF_UNIX", "/tmp/sock"]
+  #
+  def peeraddr: () -> [String, String]
+
+  # Example
+  #
+  #     UNIXServer.open("/tmp/sock") {|serv|
+  #       UNIXSocket.open("/tmp/sock") {|c|
+  #         s = serv.accept
+  #
+  #         c.send_io STDOUT
+  #         stdout = s.recv_io
+  #
+  #         p STDOUT.fileno #=> 1
+  #         p stdout.fileno #=> 7
+  #
+  #         stdout.puts "hello" # outputs "hello\n" to standard output.
+  #       }
+  #     }
+  #
+  # *klass* will determine the class of *io* returned (using the IO.for_fd
+  # singleton method or similar). If *klass* is `nil`, an integer file descriptor
+  # is returned.
+  #
+  # *mode* is the same as the argument passed to IO.for_fd
+  #
+  def recv_io: (?singleton(BasicSocket), ?String mode) -> BasicSocket
+
+  # Receives a message via *unixsocket*.
+  #
+  # *maxlen* is the maximum number of bytes to receive.
+  #
+  # *flags* should be a bitwise OR of Socket::MSG_* constants.
+  #
+  # *outbuf* will contain only the received data after the method call even if it
+  # is not empty at the beginning.
+  #
+  #     s1 = Socket.new(:UNIX, :DGRAM, 0)
+  #     s1_ai = Addrinfo.unix("/tmp/sock1")
+  #     s1.bind(s1_ai)
+  #
+  #     s2 = Socket.new(:UNIX, :DGRAM, 0)
+  #     s2_ai = Addrinfo.unix("/tmp/sock2")
+  #     s2.bind(s2_ai)
+  #     s3 = UNIXSocket.for_fd(s2.fileno)
+  #
+  #     s1.send "a", 0, s2_ai
+  #     p s3.recvfrom(10) #=> ["a", ["AF_UNIX", "/tmp/sock1"]]
+  #
+  def recvfrom: (Integer maxlen, ?Integer flags, ?String outbuf) -> [String, [String, String]]
+
+  # Sends *io* as file descriptor passing.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #
+  #     s1.send_io STDOUT
+  #     stdout = s2.recv_io
+  #
+  #     p STDOUT.fileno #=> 1
+  #     p stdout.fileno #=> 6
+  #
+  #     stdout.puts "hello" # outputs "hello\n" to standard output.
+  #
+  # *io* may be any kind of IO object or integer file descriptor.
+  #
+  def send_io: (BasicSocket | Integer) -> void
+
+  private
+
+  # Creates a new UNIX client socket connected to *path*.
+  #
+  #     require 'socket'
+  #
+  #     s = UNIXSocket.new("/tmp/sock")
+  #     s.send "hello", 0
+  #
+  def initialize: (String path) -> untyped
+end

data/stdlib/timeout/0/timeout.rbs

@@ -54,4 +54,9 @@ module Timeout
   def self?.timeout: [T] (Numeric? sec, ?singleton(Exception) klass, ?String message) { (Numeric sec) -> T } -> T
 end
 
+# Raised by Timeout.timeout when the block times out.
+class Timeout::Error < RuntimeError
+  attr_reader thread: Thread?
+end
+
 Timeout::VERSION: String

data/steep/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -9,36 +9,36 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     concurrent-ruby (1.1.8)
-    ffi (1.15.0)
+    ffi (1.15.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.16.0.0)
+    language_server-protocol (3.16.0.1)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.1.1)
-    steep (0.43.1)
+    rbs (1.2.0)
+    steep (0.44.1)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 2.7)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 1.1.0)
+      rbs (>= 1.2.0)
       terminal-table (>= 2, < 4)
-    terminal-table (3.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -48,4 +48,4 @@ DEPENDENCIES
   steep
 
 BUNDLED WITH
-   2.2.3
+   2.2.15

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -29,15 +29,6 @@ files:
 - README.md
 - Rakefile
 - Steepfile
-- bin/annotate-with-rdoc
-- bin/console
-- bin/query-rdoc
-- bin/rbs-prof
-- bin/run_in_md.rb
-- bin/setup
-- bin/sort
-- bin/steep
-- bin/test_runner.rb
 - core/array.rbs
 - core/basic_object.rbs
 - core/binding.rbs
@@ -95,6 +86,7 @@ files:
 - core/unbound_method.rbs
 - core/warning.rbs
 - docs/CONTRIBUTING.md
+- docs/rbs_by_example.md
 - docs/repo.md
 - docs/sigs.md
 - docs/stdlib.md
@@ -222,12 +214,15 @@ files:
 - stdlib/logger/0/severity.rbs
 - stdlib/monitor/0/monitor.rbs
 - stdlib/mutex_m/0/mutex_m.rbs
+- stdlib/net-http/0/net-http.rbs
+- stdlib/optparse/0/optparse.rbs
 - stdlib/pathname/0/pathname.rbs
 - stdlib/prettyprint/0/prettyprint.rbs
 - stdlib/prime/0/integer-extension.rbs
 - stdlib/prime/0/prime.rbs
 - stdlib/pstore/0/pstore.rbs
 - stdlib/pty/0/pty.rbs
+- stdlib/resolv/0/resolv.rbs
 - stdlib/rubygems/0/basic_specification.rbs
 - stdlib/rubygems/0/config_file.rbs
 - stdlib/rubygems/0/dependency_installer.rbs
@@ -246,6 +241,15 @@ files:
 - stdlib/set/0/set.rbs
 - stdlib/shellwords/0/shellwords.rbs
 - stdlib/singleton/0/singleton.rbs
+- stdlib/socket/0/addrinfo.rbs
+- stdlib/socket/0/basic_socket.rbs
+- stdlib/socket/0/ip_socket.rbs
+- stdlib/socket/0/socket.rbs
+- stdlib/socket/0/tcp_server.rbs
+- stdlib/socket/0/tcp_socket.rbs
+- stdlib/socket/0/udp_socket.rbs
+- stdlib/socket/0/unix_server.rbs
+- stdlib/socket/0/unix_socket.rbs
 - stdlib/strscan/0/string_scanner.rbs
 - stdlib/time/0/time.rbs
 - stdlib/timeout/0/timeout.rbs
@@ -290,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Type signature for Ruby.

data/bin/annotate-with-rdoc

@@ -1,153 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rbs"
-require "rdoc"
-
-def store_for_class(name, stores:)
-  stores.find do |store|
-    store.find_class_named(name) || store.find_module_named(name)
-  end
-end
-
-def format_comment(comment)
-  out = RDoc::Markup::Document.new
-  out << comment
-  formatter = RDoc::Markup::ToMarkdown.new
-  out.accept(formatter).lines.map(&:rstrip).join("\n")
-end
-
-def comment_for_constant(decl, stores:)
-  class_name = decl.name.namespace.to_type_name.to_s
-  klass = store_for_class(class_name, stores: stores)&.yield_self {|store|
-    store.find_class_named(class_name) || store.find_module_named(class_name)
-  }
-
-  if klass
-    constant = klass.constants.find do |const|
-      const.name == decl.name.name.to_s
-    end
-
-    if constant&.documented?
-      string = format_comment(constant.comment)
-      RBS::AST::Comment.new(location: nil, string: string)
-    end
-  end
-end
-
-def comment_for_class(decl, stores:)
-  name = decl.name.to_s
-  klass = store_for_class(name, stores: stores)&.yield_self {|store|
-    store.find_class_named(name) || store.find_module_named(name)
-  }
-
-  if klass&.documented?
-    string = format_comment(klass.comment)
-    RBS::AST::Comment.new(location: nil, string: string)
-  end
-end
-
-def comment_for_method(klass, method, stores:)
-  method = store_for_class(klass, stores: stores)&.load_method(klass, method)
-
-  if method&.documented?
-    out = RDoc::Markup::Document.new
-
-    out << method.comment
-
-    if method.arglists
-      out << RDoc::Markup::Heading.new(1, "arglists 💪👽🚨 << Delete this section")
-      arglists = method.arglists.chomp.split("\n").map {|line| line + "\n" }
-      out << RDoc::Markup::Verbatim.new(*arglists)
-    end
-
-    string = out.accept(RDoc::Markup::ToMarkdown.new)
-    RBS::AST::Comment.new(location: nil, string: string)
-  end
-
-rescue RDoc::Store::MissingFileError
-  puts "  👺 No document found for #{klass}#{method}"
-  nil
-end
-
-if ARGV.empty?
-  puts 'annotate-with-rdoc [RBS files...]'
-  exit
-end
-
-def print_members(stores, klass_name, members)
-  members.each do |member|
-    case member
-    when RBS::AST::Members::MethodDefinition
-      puts "    Processing #{member.name}..."
-
-      method_name = case
-                    when member.instance?
-                      "##{member.name}"
-                    when member.singleton?
-                      "::#{member.name}"
-                    end
-
-      comment = comment_for_method(klass_name, method_name, stores: stores)
-
-      unless comment
-        if member.instance? && member.name == :initialize
-          comment = comment_for_method(klass_name, '::new', stores: stores)
-        end
-      end
-
-      member.instance_variable_set(:@comment, comment)
-    when RBS::AST::Members::AttrReader, RBS::AST::Members::AttrAccessor, RBS::AST::Members::AttrWriter
-      puts "    👻 Attributes not supported (#{klass_name})"
-    when RBS::AST::Members::Alias
-      puts "    Processing #{member.new_name}(alias)..."
-      prefix = case
-               when member.instance?
-                 "#"
-               when member.singleton?
-                 "."
-               end
-      name = "#{prefix}#{member.new_name}"
-
-      comment = comment_for_method(klass_name, name, stores: stores)
-      member.instance_variable_set(:@comment, comment)
-    end
-  end
-end
-
-stores = []
-RDoc::RI::Paths.each true, true, false, false do |path, type|
-  puts "Loading store from #{path}..."
-  store = RDoc::RI::Store.new(path, type)
-  store.load_all
-  stores << store
-end
-
-ARGV.map {|f| Pathname(f) }.each do |path|
-  puts "Opening #{path}..."
-
-  buffer = RBS::Buffer.new(name: path, content: path.read)
-  sigs = RBS::Parser.parse_signature(buffer)
-
-  sigs.each do |decl|
-    case decl
-    when RBS::AST::Declarations::Constant
-      puts "  Importing documentation for #{decl.name}..."
-      comment = comment_for_constant(decl, stores: stores)
-      decl.instance_variable_set(:@comment, comment)
-    when RBS::AST::Declarations::Class, RBS::AST::Declarations::Module
-      puts "  Importing documentation for #{decl.name}..."
-      comment = comment_for_class(decl, stores: stores)
-      decl.instance_variable_set(:@comment, comment)
-
-      print_members stores, decl.name.to_s, decl.members
-    end
-  end
-
-  puts "Writing #{path}..."
-  path.open('w') do |out|
-    writer = RBS::Writer.new(out: out)
-    writer.write sigs
-  end
-end
-

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rbs"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)