rbs 0.7.0 → 0.11.0

data/lib/rbs/environment.rb

@@ -325,7 +325,6 @@ module RBS
           comment: member.comment,
           overload: member.overload?,
           annotations: member.annotations,
-          attributes: member.attributes,
           location: member.location
         )
       when AST::Members::AttrAccessor

data/lib/rbs/environment_loader.rb

@@ -75,29 +75,16 @@ module RBS
       self.class.gem_sig_path(name, version)
     end
 
-    def each_signature(path = nil, immediate: true, &block)
+    def each_signature(path, immediate: true, &block)
       if block_given?
-        if path
-          case
-          when path.file?
-            if path.extname == ".rbs" || immediate
-              yield path
-            end
-          when path.directory?
-            path.children.each do |child|
-              each_signature child, immediate: false, &block
-            end
+        case
+        when path.file?
+          if path.extname == ".rbs" || immediate
+            yield path
           end
-        else
-          paths.each do |path|
-            case path
-            when Pathname
-              each_signature path, immediate: immediate, &block
-            when LibraryPath
-              each_signature path.path, immediate: immediate, &block
-            when GemPath
-              each_signature path.path, immediate: immediate, &block
-            end
+        when path.directory?
+          path.children.each do |child|
+            each_signature child, immediate: false, &block
           end
         end
       else
@@ -105,32 +92,65 @@ module RBS
       end
     end
 
-    def no_builtin!
-      @no_builtin = true
+    def each_library_path
+      paths.each do |path|
+        case path
+        when Pathname
+          yield path, path
+        when LibraryPath
+          yield path, path.path
+        when GemPath
+          yield path, path.path
+        end
+      end
+    end
+
+    def no_builtin!(skip = true)
+      @no_builtin = skip
+      self
     end
 
     def no_builtin?
       @no_builtin
     end
 
-    def load(env:)
-      signature_files = []
+    def each_decl
+      if block_given?
+        signature_files = []
 
-      unless no_builtin?
-        signature_files.push(*each_signature(stdlib_root + "builtin"))
-      end
+        unless no_builtin?
+          each_signature(stdlib_root + "builtin") do |path|
+            signature_files << [:stdlib, path]
+          end
+        end
 
-      each_signature do |path|
-        signature_files.push path
+        each_library_path do |library_path, pathname|
+          each_signature(pathname) do |path|
+            signature_files << [library_path, path]
+          end
+        end
+
+        signature_files.each do |lib_path, file_path|
+          buffer = Buffer.new(name: file_path.to_s, content: file_path.read)
+          Parser.parse_signature(buffer).each do |decl|
+            yield decl, buffer, file_path, lib_path
+          end
+        end
+      else
+        enum_for :each_decl
       end
+    end
+
+    def load(env:)
+      loadeds = []
 
-      signature_files.each do |file|
-        buffer = Buffer.new(name: file.to_s, content: file.read)
+      each_decl do |decl, buffer, file_path, lib_path|
         env.buffers.push(buffer)
-        Parser.parse_signature(buffer).each do |decl|
-          env << decl
-        end
+        env << decl
+        loadeds << [decl, file_path, lib_path]
       end
+
+      loadeds
     end
   end
 end

data/lib/rbs/location.rb

@@ -77,6 +77,21 @@ module RBS
       locations.inject {|l1, l2| l1 + l2 }
     end
 
+    def concat(*others)
+      others.each { |other| self << other }
+      self
+    end
+
+    def <<(other)
+      if other
+        raise "Invalid concat: buffer=#{buffer.name}, other.buffer=#{other.buffer.name}" unless other.buffer == buffer
+        @end_pos = other.end_pos
+        @source = nil
+        @end_loc = nil
+      end
+      self
+    end
+
     def pred?(loc)
       loc.is_a?(Location) &&
         loc.name == name &&

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,22 +443,29 @@ 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]
+          comment: leading_comment(val[0].first&.location || val[2]&.location || val[3].location),
+          overload: overload || !!val[2]
         )
       }
 
   attributes:
-      { result = [] }
     | attributes kINCOMPATIBLE {
-        result = val[0].push(val[1])
+        RBS.logger.warn "`incompatible` method attribute is deprecated and ignored."
       }
 
   method_kind:
@@ -463,7 +475,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 +560,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 }
@@ -1150,15 +1162,13 @@ def leading_comment(location)
 end
 
 def push_comment(string, location)
-  new_comment = AST::Comment.new(string: string+"\n", location: location)
-
-  if (prev_comment = leading_comment(location)) && prev_comment.location.start_column == location.start_column
-    @comments.delete prev_comment.location.end_line
-    new_comment = AST::Comment.new(string: prev_comment.string + new_comment.string,
-                                   location: prev_comment.location + new_comment.location)
+  if (comment = leading_comment(location)) && comment.location.start_column == location.start_column
+    comment.concat(string: "#{string}\n", location: location)
+    @comments[comment.location.end_line] = comment
+  else
+    new_comment = AST::Comment.new(string: "#{string}\n", location: location)
+    @comments[new_comment.location.end_line] = new_comment
   end
-
-  @comments[new_comment.location.end_line] = new_comment
 end
 
 def new_token(type, value = input.matched)
@@ -1218,7 +1228,6 @@ KEYWORDS = {
   "attr_reader" => :kATTRREADER,
   "attr_writer" => :kATTRWRITER,
   "attr_accessor" => :kATTRACCESSOR,
-  "super" => :kSUPER,
   "public" => :kPUBLIC,
   "private" => :kPRIVATE,
   "alias" => :kALIAS,
@@ -1267,6 +1276,7 @@ PUNCTS = {
   "!" => :kEXCLAMATION,
   "**" => :kSTAR2,
   "*" => :kSTAR,
+  "..." => :kDOT3,
   "." => :kDOT,
   "<" => :kLT,
   "-@" => :tOPERATOR,

data/lib/rbs/prototype/rb.rb

@@ -130,7 +130,6 @@ module RBS
               types: types,
               kind: kind,
               comment: comments[node.first_lineno - 1],
-              attributes: [],
               overload: false
             )
 

data/lib/rbs/prototype/rbi.rb

@@ -173,7 +173,6 @@ module RBS
               types: types,
               kind: :singleton,
               comment: comment,
-              attributes: [],
               overload: false
             )
           end
@@ -194,7 +193,6 @@ module RBS
               types: types,
               kind: :instance,
               comment: comment,
-              attributes: [],
               overload: false
             )
           end

data/lib/rbs/prototype/runtime.rb

@@ -154,7 +154,6 @@ module RBS
                 location: nil,
                 comment: method.comments[0],
                 annotations: method.annotations,
-                attributes: method.attributes,
                 overload: false
               )
               return
@@ -193,7 +192,6 @@ module RBS
                 location: nil,
                 comment: nil,
                 annotations: [],
-                attributes: [],
                 overload: false
               )
             end
@@ -227,7 +225,6 @@ module RBS
                   location: nil,
                   comment: nil,
                   annotations: [],
-                  attributes: [],
                   overload: false
                 )
               end
@@ -262,7 +259,6 @@ module RBS
                   location: nil,
                   comment: nil,
                   annotations: [],
-                  attributes: [],
                   overload: false
                 )
               end

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/hook.rb

@@ -7,6 +7,7 @@ module RBS
       OPERATORS = {
         :== => "eqeq",
         :=== => "eqeqeq",
+        :!= => "noteq",
         :+ => "plus",
         :- => "minus",
         :* => "star",

data/lib/rbs/test/setup.rb

@@ -1,24 +1,34 @@
 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'] || '')
+  double_class = to_double_class(ENV['RBS_TEST_DOUBLE_SUITE'])
+  unchecked_classes = (ENV['RBS_TEST_UNCHECKED_CLASSES'] || '').split(',').map! { |unchecked_class| unchecked_class.strip }.push(*double_class)
+rescue InvalidSampleSizeError => exception
+  RBS.logger.error exception.message
+  exit 1
+end
+
+if filter.empty?
   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)"
+  STDERR.puts "  [OPTIONAL] RBS_TEST_DOUBLE_SUITE: sets the double suite in use (currently supported: minitest | rspec)"
+  STDERR.puts "  [OPTIONAL] RBS_TEST_UNCHECKED_CLASSES: sets the classes that would not be checked"
   exit 1
 end
 
@@ -32,26 +42,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)
 
+module_name = Module.instance_method(:name)
+
 TracePoint.trace :end do |tp|
-  class_name = tp.self.name&.yield_self {|name| factory.type_name(name).absolute! }
+  class_name = module_name.bind(tp.self).call&.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 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)
-        end
+    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 env.class_decls.key?(class_name)
+        logger.info "Setting up hooks for #{class_name}"
+        tester.install!(tp.self, sample_size: sample_size, unchecked_classes: unchecked_classes)
       end
     end
   end
 end
+
+at_exit do
+  if $!.nil? || $!.is_a?(SystemExit) && $!.success?
+    if tester.targets.empty?
+      logger.debug { "No type checker was installed!" }
+    end
+  end
+end

data/lib/rbs/test/setup_helper.rb

@@ -0,0 +1,44 @@
+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
+
+      def to_double_class(double_suite)
+        return nil unless double_suite
+
+        case double_suite.downcase.strip
+        when 'rspec'
+          ['::RSpec::Mocks::Double']
+        when 'minitest'
+          ['::Minitest::Mock'] 
+        else
+          RBS.logger.warn "Unknown test suite - defaults to nil"
+          nil
+        end
+      end
+
+    end
+  end
+end