rbs 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d175f17e9f1226e0cb0d37c2167b3b52b0e736661d1406937922194c68adfd54
-  data.tar.gz: 204d38937da751f3ea15dfd64370e379689e54f264b63be54e6c4843c4827579
+  metadata.gz: a2e86d5e87d89f97eed8e2674aa5f5035413179ba104a5cb265ab748268c51fe
+  data.tar.gz: 9d58fa00413d5a334496ee688bbc72520e1911558f39ad2d01b180b790e5d894
 SHA512:
-  metadata.gz: 242ffa432db2a94a59636be87e261411c0bf465ac170b6f5b52955cb671d2c70e6eaed7dc74b489868117fcaa360df33c16ed6e2e472edd96663491c1211d793
-  data.tar.gz: 6ccb639e3a73a7e4794f906e9e125dd173d0406198a11511592e3c3492126c31a5ff1798010087fb19d4eb053ba46140e42f869b913ae3b7aaee20303ef3f92c
+  metadata.gz: 328850c1f912cd7cc45e1c210140c098206f668c0400a817cde00e36dec1591ec235b5b6a1255b0e66d585745d4f6f7effeb09f28ae2a7536091852f9ba8bc89
+  data.tar.gz: 96bc5adc81b98d723a98d20dcbeef13424fb0a4267272ff1ad6daaab5ef310f24c038f4e23793253beade1e55a00a6eece457697a3a4ec62413f08b7c42ace99

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## master
 
+## 0.8.0 (2020-08-01)
+
+* Signature updates for `Enumerator` and `PTY`
+* Fix prototype rb/rbi error handling [#349](https://github.com/ruby/rbs/pull/349)
+* Runtime test improvements [#344](https://github.com/ruby/rbs/pull/344), [#343](https://github.com/ruby/rbs/pull/343)
+* Add `...` syntax [#342](https://github.com/ruby/rbs/pull/342)
+
 ## 0.7.0 (2020-07-20)
 
 * Add `DefinitionBuilder#one_instance_ancestors` and `DefinitionBuilder#one_singleton_ancestors` [#341](https://github.com/ruby/rbs/pull/341)

data/lib/rbs/cli.rb

@@ -66,6 +66,10 @@ module RBS
       opts
     end
 
+    def has_parser?
+      defined?(RubyVM::AbstractSyntaxTree)
+    end
+
     def run(args)
       options = LibraryOptions.new
 
@@ -599,12 +603,18 @@ EOU
     end
 
     def run_prototype_file(format, args)
+      availability = unless has_parser?
+                       "\n** This command does not work on this interpreter (#{RUBY_ENGINE}) **\n"
+                     end
+
       opts = OptionParser.new
       opts.banner = <<EOU
 Usage: rbs prototype #{format} [options...] [files...]
-
+#{availability}
 Generate RBS prototype from source code.
-It parses specified Ruby code and and generates RBS prototypes. 
+It parses specified Ruby code and and generates RBS prototypes.
+
+It only works on MRI because it parses Ruby code with `RubyVM::AbstractSyntaxTree`.
 
 Examples:
 
@@ -613,6 +623,11 @@ Examples:
 EOU
       opts.parse!(args)
 
+      unless has_parser?
+        stdout.puts "Not supported on this interpreter (#{RUBY_ENGINE})."
+        exit 1
+      end
+
       if args.empty?
         stdout.puts opts
         return nil

data/lib/rbs/parser.y

@@ -4,9 +4,9 @@ class RBS::Parser
         tANNOTATION
         tSTRING tSYMBOL tINTEGER tWRITE_ATTR
         kLPAREN kRPAREN kLBRACKET kRBRACKET kLBRACE kRBRACE
-        kVOID kNIL kTRUE kFALSE kANY kUNTYPED kTOP kBOT kSELF kSELFQ kINSTANCE kCLASS kBOOL kSINGLETON kTYPE kDEF kMODULE kSUPER
+        kVOID kNIL kTRUE kFALSE kANY kUNTYPED kTOP kBOT kSELF kSELFQ kINSTANCE kCLASS kBOOL kSINGLETON kTYPE kDEF kMODULE
         kPRIVATE kPUBLIC kALIAS
-        kCOLON kCOLON2 kCOMMA kBAR kAMP kHAT kARROW kQUESTION kEXCLAMATION kSTAR kSTAR2 kFATARROW kEQ kDOT kLT
+        kCOLON kCOLON2 kCOMMA kBAR kAMP kHAT kARROW kQUESTION kEXCLAMATION kSTAR kSTAR2 kFATARROW kEQ kDOT kDOT3 kLT
         kINTERFACE kEND kINCLUDE kEXTEND kATTRREADER kATTRWRITER kATTRACCESSOR tOPERATOR tQUOTEDMETHOD tQUOTEDIDENT
         kPREPEND kEXTENSION kINCOMPATIBLE
         type_TYPE type_SIGNATURE type_METHODTYPE tEOF
@@ -425,7 +425,12 @@ rule
                                       comment: leading_comment(val[0].first&.location || location))
       }
 
-  overload: { result = nil } | kOVERLOAD
+  overload:
+        { result = nil }
+    | kOVERLOAD {
+        RBS.logger.warn "`overload def` syntax is deprecated. Use `...` syntax instead."
+        result = val[0]
+      }
 
   method_member:
       annotations attributes overload kDEF method_kind def_name method_types {
@@ -438,15 +443,24 @@ rule
             type
           end
         end
+
+        last_type = val[6].last
+        if last_type.is_a?(LocatedValue) && last_type.value == :dot3
+          overload = true
+          val[6].pop
+        else
+          overload = false
+        end
+
         result = Members::MethodDefinition.new(
           name: val[5].value,
           kind: val[4],
-          types: types,
+          types: val[6],
           annotations: val[0],
           location: location,
           comment: leading_comment(val[0].first&.location || val[1].first&.location || val[2]&.location || val[3].location),
           attributes: val[1].map(&:value),
-          overload: !!val[2]
+          overload: overload || !!val[2]
         )
       }
 
@@ -463,7 +477,7 @@ rule
 
   method_types:
       method_type { result = [val[0]] }
-    | kSUPER { result = [LocatedValue.new(value: :super, location: val[0].location)] }
+    | kDOT3 { result = [LocatedValue.new(value: :dot3, location: val[0].location)] }
     | method_type kBAR method_types {
         result = val[2].unshift(val[0])
       }
@@ -548,7 +562,7 @@ rule
       kCLASS | kVOID | kNIL | kTRUE | kFALSE | kANY | kUNTYPED | kTOP | kBOT | kINSTANCE | kBOOL | kSINGLETON
     | kTYPE | kMODULE | kPRIVATE | kPUBLIC | kEND | kINCLUDE | kEXTEND | kPREPEND
     | kATTRREADER | kATTRACCESSOR | kATTRWRITER | kDEF | kEXTENSION | kSELF | kINCOMPATIBLE
-    | kUNCHECKED | kINTERFACE | kSUPER | kALIAS | kOUT | kIN | kOVERLOAD
+    | kUNCHECKED | kINTERFACE | kALIAS | kOUT | kIN | kOVERLOAD
 
   module_type_params:
       { result = nil }
@@ -1218,7 +1232,6 @@ KEYWORDS = {
   "attr_reader" => :kATTRREADER,
   "attr_writer" => :kATTRWRITER,
   "attr_accessor" => :kATTRACCESSOR,
-  "super" => :kSUPER,
   "public" => :kPUBLIC,
   "private" => :kPRIVATE,
   "alias" => :kALIAS,
@@ -1267,6 +1280,7 @@ PUNCTS = {
   "!" => :kEXCLAMATION,
   "**" => :kSTAR2,
   "*" => :kSTAR,
+  "..." => :kDOT3,
   "." => :kDOT,
   "<" => :kLT,
   "-@" => :tOPERATOR,

data/lib/rbs/test.rb

@@ -5,6 +5,7 @@ require "rbs/test/errors"
 require "rbs/test/type_check"
 require "rbs/test/tester"
 require "rbs/test/hook"
+require "rbs/test/setup_helper"
 
 module RBS
   module Test

data/lib/rbs/test/errors.rb

@@ -28,7 +28,11 @@ module RBS
       end
 
       def self.inspect_(obj)
-        Test::INSPECT.bind(obj).call
+        if obj.respond_to?(:inspect)
+          obj.inspect
+        else
+          Test::INSPECT.bind(obj).call     # For the case inspect is not defined (like BasicObject)
+        end
       end
 
       def self.to_string(error)

data/lib/rbs/test/setup.rb

@@ -1,24 +1,29 @@
 require "rbs"
 require "rbs/test"
-
 require "optparse"
 require "shellwords"
 
+include RBS::Test::SetupHelper
+
 logger = Logger.new(STDERR)
 
 begin
   opts = Shellwords.shellsplit(ENV["RBS_TEST_OPT"] || "-I sig")
-  filter = ENV.fetch("RBS_TEST_TARGET").split(",")
-  skips = (ENV["RBS_TEST_SKIP"] || "").split(",")
-  sampling = !ENV.key?("RBS_TEST_NO_SAMPLE")
+  filter = ENV.fetch('RBS_TEST_TARGET').split(',').map! { |e| e.strip }
+  skips = (ENV['RBS_TEST_SKIP'] || '').split(',').map! { |e| e.strip }
   RBS.logger_level = (ENV["RBS_TEST_LOGLEVEL"] || "info")
-rescue
+  sample_size = get_sample_size(ENV['RBS_TEST_SAMPLE_SIZE'] || '')
+rescue InvalidSampleSizeError => exception
+  RBS.logger.error exception.message
+  exit 1
+rescue Exception => e
+  raise e.message
   STDERR.puts "rbs/test/setup handles the following environment variables:"
   STDERR.puts "  [REQUIRED] RBS_TEST_TARGET: test target class name, `Foo::Bar,Foo::Baz` for each class or `Foo::*` for all classes under `Foo`"
   STDERR.puts "  [OPTIONAL] RBS_TEST_SKIP: skip testing classes"
   STDERR.puts "  [OPTIONAL] RBS_TEST_OPT: options for signatures (`-r` for libraries or `-I` for signatures)"
   STDERR.puts "  [OPTIONAL] RBS_TEST_LOGLEVEL: one of debug|info|warn|error|fatal (defaults to info)"
-  STDERR.puts "  [OPTIONAL] RBS_TEST_NO_SAMPLE: if set, the type checker tests all the values of a collection"
+  STDERR.puts "  [OPTIONAL] RBS_TEST_SAMPLE_SIZE: sets the amount of values in a collection to be type-checked (Set to `ALL` to type check all the values)"
   exit 1
 end
 
@@ -32,26 +37,38 @@ env = RBS::Environment.from_loader(loader).resolve_type_names
 
 def match(filter, name)
   if filter.end_with?("*")
-    name.start_with?(filter[0, filter.size - 1]) || name == filter[0, filter.size-3]
+    size = filter.size
+    name.start_with?(filter[0, size - 1]) || name == filter[0, size-3]
   else
     filter == name
   end
 end
 
-factory = RBS::Factory.new()
+def to_absolute_typename(type_name)
+  RBS::Factory.new().type_name(type_name).absolute!
+end
+
 tester = RBS::Test::Tester.new(env: env)
 
 TracePoint.trace :end do |tp|
-  class_name = tp.self.name&.yield_self {|name| factory.type_name(name).absolute! }
+  class_name = tp.self.name&.yield_self {|name| to_absolute_typename name }
 
   if class_name
-    if filter.any? {|f| match(f, class_name.to_s) } && skips.none? {|f| match(f, class_name.to_s) }
+    if filter.any? {|f| match(to_absolute_typename(f).to_s, class_name.to_s) } && skips.none? {|f| match(f, class_name.to_s) }
       if tester.checkers.none? {|hook| hook.klass == tp.self }
         if env.class_decls.key?(class_name)
           logger.info "Setting up hooks for #{class_name}"
-          tester.install!(tp.self, sampling: sampling)
+          tester.install!(tp.self, sample_size: sample_size)
         end
       end
     end
   end
 end
+
+at_exit do
+  if $!.nil? || $!.is_a?(SystemExit) && $!.success?
+    logger.warn "No type checker was installed! " if tester.checkers.empty?
+  end
+end
+
+ 

data/lib/rbs/test/setup_helper.rb

@@ -0,0 +1,29 @@
+module RBS
+  module Test
+    module SetupHelper
+      class InvalidSampleSizeError < StandardError
+        attr_reader :string
+        
+        def initialize(string)
+          @string = string
+          super("Sample size should be a positive integer: `#{string}`")
+        end
+      end
+      
+      DEFAULT_SAMPLE_SIZE = 100
+      
+      def get_sample_size(string)
+        case string
+        when ""
+          DEFAULT_SAMPLE_SIZE
+        when 'ALL'
+          nil
+        else
+          int_size = string.to_i
+          raise InvalidSampleSizeError.new(string) unless int_size.positive?
+          int_size
+        end
+      end
+    end
+  end
+end

data/lib/rbs/test/tester.rb

@@ -17,14 +17,14 @@ module RBS
         @builder ||= DefinitionBuilder.new(env: env)
       end
 
-      def install!(klass, sampling:)
+      def install!(klass, sample_size:)
         RBS.logger.info { "Installing runtime type checker in #{klass}..." }
 
         type_name = factory.type_name(klass.name).absolute!
 
         builder.build_instance(type_name).tap do |definition|
           instance_key = new_key(type_name, "InstanceChecker")
-          Observer.register(instance_key, MethodCallTester.new(klass, builder, definition, kind: :instance, sampling: sampling))
+          Observer.register(instance_key, MethodCallTester.new(klass, builder, definition, kind: :instance, sample_size: sample_size))
 
           definition.methods.each do |name, method|
             if method.implemented_in == type_name
@@ -36,7 +36,7 @@ module RBS
 
         builder.build_singleton(type_name).tap do |definition|
           singleton_key = new_key(type_name, "SingletonChecker")
-          Observer.register(singleton_key, MethodCallTester.new(klass.singleton_class, builder, definition, kind: :singleton, sampling: sampling))
+          Observer.register(singleton_key, MethodCallTester.new(klass.singleton_class, builder, definition, kind: :singleton, sample_size: sample_size))
 
           definition.methods.each do |name, method|
             if method.implemented_in == type_name || name == :new
@@ -66,14 +66,14 @@ module RBS
         attr_reader :definition
         attr_reader :builder
         attr_reader :kind
-        attr_reader :sampling
+        attr_reader :sample_size
 
-        def initialize(self_class, builder, definition, kind:, sampling:)
+        def initialize(self_class, builder, definition, kind:, sample_size:)
           @self_class = self_class
           @definition = definition
           @builder = builder
           @kind = kind
-          @sampling = sampling
+          @sample_size = sample_size
         end
 
         def env
@@ -81,7 +81,7 @@ module RBS
         end
 
         def check
-          @check ||= TypeCheck.new(self_class: self_class, builder: builder, sampling: sampling)
+          @check ||= TypeCheck.new(self_class: self_class, builder: builder, sample_size: sample_size)
         end
 
         def format_method_name(name)

data/lib/rbs/test/type_check.rb

@@ -3,11 +3,14 @@ module RBS
     class TypeCheck
       attr_reader :self_class
       attr_reader :builder
+      attr_reader :sample_size
 
-      def initialize(self_class:, builder:, sampling:)
+      DEFAULT_SAMPLE_SIZE = 100
+
+      def initialize(self_class:, builder:, sample_size:)
         @self_class = self_class
         @builder = builder
-        @sampling = sampling
+        @sample_size = sample_size
       end
 
       def overloaded_call(method, method_name, call, errors:)
@@ -176,12 +179,8 @@ module RBS
         end
       end
 
-      def sampling?
-        !!@sampling
-      end
-
       def sample(array)
-        array.size > 100 && sampling? ? array.sample(100) : array
+        sample_size && (array.size > sample_size) ? array.sample(sample_size) : array
       end
 
       def value(val, type)

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/stdlib/builtin/enumerable.rbs

@@ -46,7 +46,7 @@ module Enumerable[unchecked out Elem, out Return]: _Each[Elem, Return]
             | () { (Elem arg0) -> untyped } -> bool
 
   def collect: [U] () { (Elem arg0) -> U } -> ::Array[U]
-             | () -> ::Enumerator[Elem, Return]
+             | () -> ::Enumerator[Elem, ::Array[untyped]]
 
   def collect_concat: [U] () { (Elem arg0) -> ::Enumerator[U, untyped] } -> ::Array[U]
 
@@ -317,7 +317,7 @@ module Enumerable[unchecked out Elem, out Return]: _Each[Elem, Return]
               | () -> ::Enumerator[Elem, Return]
 
   def map: [U] () { (Elem arg0) -> U } -> ::Array[U]
-         | () -> ::Enumerator[Elem, Return]
+         | () -> ::Enumerator[Elem, ::Array[untyped]]
 
   def member?: (untyped arg0) -> bool
 

data/stdlib/pty/pty.rbs

@@ -0,0 +1,159 @@
+# Creates and manages pseudo terminals (PTYs).  See also
+# http://en.wikipedia.org/wiki/Pseudo_terminal
+#
+# PTY allows you to allocate new terminals using ::open or ::spawn a new
+# terminal with a specific command.
+#
+# ## Example
+#
+# In this example we will change the buffering type in the `factor` command,
+# assuming that factor uses stdio for stdout buffering.
+#
+# If IO.pipe is used instead of PTY.open, this code deadlocks because factor's
+# stdout is fully buffered.
+#
+#     # start by requiring the standard library PTY
+#     require 'pty'
+#
+#     master, slave = PTY.open
+#     read, write = IO.pipe
+#     pid = spawn("factor", :in=>read, :out=>slave)
+#     read.close     # we dont need the read
+#     slave.close    # or the slave
+#
+#     # pipe "42" to the factor command
+#     write.puts "42"
+#     # output the response from factor
+#     p master.gets #=> "42: 2 3 7\n"
+#
+#     # pipe "144" to factor and print out the response
+#     write.puts "144"
+#     p master.gets #=> "144: 2 2 2 2 3 3\n"
+#     write.close # close the pipe
+#
+#     # The result of read operation when pty slave is closed is platform
+#     # dependent.
+#     ret = begin
+#             master.gets     # FreeBSD returns nil.
+#           rescue Errno::EIO # GNU/Linux raises EIO.
+#             nil
+#           end
+#     p ret #=> nil
+#
+# ## License
+#
+#     C) Copyright 1998 by Akinori Ito.
+#
+#     This software may be redistributed freely for this purpose, in full
+#     or in part, provided that this entire copyright notice is included
+#     on any copies of this software and applications and derivations thereof.
+#
+#     This software is provided on an "as is" basis, without warranty of any
+#     kind, either expressed or implied, as to any matter including, but not
+#     limited to warranty of fitness of purpose, or merchantability, or
+#     results obtained from use of this software.
+#
+module PTY
+  # Checks the status of the child process specified by `pid`. Returns `nil` if
+  # the process is still alive.
+  #
+  # If the process is not alive, and `raise` was true, a PTY::ChildExited
+  # exception will be raised. Otherwise it will return a Process::Status instance.
+  #
+  # `pid`
+  # :   The process id of the process to check
+  # `raise`
+  # :   If `true` and the process identified by `pid` is no longer alive a
+  #     PTY::ChildExited is raised.
+  def self.check: (Integer pid) -> (Process::Status | nil)
+                | (Integer pid, FalseClass raise) -> (Process::Status | nil)
+                | (Integer pid, TrueClass raise) -> nil
+
+  # Spawns the specified command on a newly allocated pty. You can also use the
+  # alias ::getpty.
+  #
+  # The command's controlling tty is set to the slave device of the pty and its
+  # standard input/output/error is redirected to the slave device.
+  #
+  # `command` and `command_line` are the full commands to run, given a String. Any
+  # additional `arguments` will be passed to the command.
+  #
+  # ### Return values
+  #
+  # In the non-block form this returns an array of size three, `[r, w, pid]`.
+  #
+  # In the block form these same values will be yielded to the block:
+  #
+  # `r`
+  # :   A readable IO that contains the command's standard output and standard
+  #     error
+  # `w`
+  # :   A writable IO that is the command's standard input
+  # `pid`
+  # :   The process identifier for the command.
+  def self.getpty: (*String command) -> [ IO, IO, Integer ]
+                 | (*String command) { ([ IO ,IO , Integer ]) -> untyped } -> untyped
+
+  # Allocates a pty (pseudo-terminal).
+  #
+  # In the block form, yields two arguments `master_io, slave_file` and the value
+  # of the block is returned from `open`.
+  #
+  # The IO and File are both closed after the block completes if they haven't been
+  # already closed.
+  #
+  #     PTY.open {|master, slave|
+  #       p master      #=> #<IO:masterpty:/dev/pts/1>
+  #       p slave      #=> #<File:/dev/pts/1>
+  #       p slave.path #=> "/dev/pts/1"
+  #     }
+  #
+  # In the non-block form, returns a two element array, `[master_io, slave_file]`.
+  #
+  #     master, slave = PTY.open
+  #     # do something with master for IO, or the slave file
+  #
+  # The arguments in both forms are:
+  #
+  # `master_io`
+  # :   the master of the pty, as an IO.
+  # `slave_file`
+  # :   the slave of the pty, as a File.  The path to the terminal device is
+  #     available via `slave_file.path`
+  #
+  #
+  # IO#raw! is usable to disable newline conversions:
+  #
+  #     require 'io/console'
+  #     PTY.open {|m, s|
+  #       s.raw!
+  #       ...
+  #     }
+  def self.open: () -> [ IO, File ]
+               | () { ([ IO , File ]) -> untyped } -> untyped
+
+  # Spawns the specified command on a newly allocated pty. You can also use the
+  # alias ::getpty.
+  #
+  # The command's controlling tty is set to the slave device of the pty and its
+  # standard input/output/error is redirected to the slave device.
+  #
+  # `command` and `command_line` are the full commands to run, given a String. Any
+  # additional `arguments` will be passed to the command.
+  #
+  # ### Return values
+  #
+  # In the non-block form this returns an array of size three, `[r, w, pid]`.
+  #
+  # In the block form these same values will be yielded to the block:
+  #
+  # `r`
+  # :   A readable IO that contains the command's standard output and standard
+  #     error
+  # `w`
+  # :   A writable IO that is the command's standard input
+  # `pid`
+  # :   The process identifier for the command.
+  def self.spawn: (*String command) -> [ IO, IO, Integer ]
+                | (*String command) {([ IO , IO , Integer ]) -> untyped } -> untyped
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -73,6 +73,7 @@ files:
 - lib/rbs/test/hook.rb
 - lib/rbs/test/observer.rb
 - lib/rbs/test/setup.rb
+- lib/rbs/test/setup_helper.rb
 - lib/rbs/test/spy.rb
 - lib/rbs/test/tester.rb
 - lib/rbs/test/type_check.rb
@@ -169,6 +170,7 @@ files:
 - stdlib/pathname/pathname.rbs
 - stdlib/prime/integer-extension.rbs
 - stdlib/prime/prime.rbs
+- stdlib/pty/pty.rbs
 - stdlib/securerandom/securerandom.rbs
 - stdlib/set/set.rbs
 - stdlib/tmpdir/tmpdir.rbs