rbs 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29535fcd236ba4d658d2c975b5084aa58b125203c4aaa1ec4704881b92ed89c7
-  data.tar.gz: 71e165ea5cb1ccbf1b48e9683201f6058dc7c95c7a7619865bf26af2cb6485ad
+  metadata.gz: fe2c03d38ca9869e7c7bdf283f56e61e5ccbad3831b524ba14c6fd31941985e2
+  data.tar.gz: d9cc6563f7eb3173410209daeda05a8216d2ade261a3f05d3f258d0782a08e64
 SHA512:
-  metadata.gz: 236e10d6a7372a1c9b3c07a343a4620048c3f269f750e74f82539fd819f690475deb52090eec0cf38bc338344d240586f44941339bea7759066f68f90c5a3bdb
-  data.tar.gz: 8ef6ef34e9b39c310f70138135589611c31c8840fdea06eaa606b5004fc5d6634882ddd169b030dd4140645ad9d18c7a4a796a8bba88cd917ea1a69b461efdd1
+  metadata.gz: fb4391906260a8414e2c2ef44ded8fda974c495830fb6c2335204052cba67260f1f0d0fd44dd560c3c05b7cdcaffa20ee24d7d16a529c37f900689bb084ce198
+  data.tar.gz: 68cb88ea29edbce815a6887b716f20c640b651628b55b9b3e660e6bc93c218081464888632f9df7bc42da49700c253bc74fb9d01970f7bf13a2425742890431e

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## master
 
+## 0.11.0 (2020-08-31)
+
+* Signature update for `date/datetime` [#367](https://github.com/ruby/rbs/pull/367)
+* Add test double support for runtime type checker [#380](https://github.com/ruby/rbs/pull/380)
+* Add `rbs test` command for runtime type checking [#366](https://github.com/ruby/rbs/pull/366)
+* Fix runtime type checking for record types [#365](https://github.com/ruby/rbs/pull/365)
+* Improve EnvironmentLoader API [#370](https://github.com/ruby/rbs/pull/370)
+* Allow overloading from super methods [#364](https://github.com/ruby/rbs/pull/364)
+
 ## 0.10.0 (2020-08-10)
 
 * Signature update for `Zlib`

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 # Development dependencies
 gem "rake"
 gem "minitest"
+gem "rspec"
 gem "racc"
 gem "rubocop"
 gem "rubocop-rubycw"

data/README.md

@@ -123,7 +123,7 @@ puts singleton.methods[:gsub]
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/docs/syntax.md

@@ -212,7 +212,7 @@ _method-type_ ::= `(` _parameters_ `) ->` _type_
 
 _parameters_ ::= _required-positionals_ _optional-positionals_ _rest-positional_ _trailing-positionals_ _keywords_
 
-_paramater_ ::= _type_ _var-name_                                  # Parameter with var name
+_parameter_ ::= _type_ _var-name_                                  # Parameter with var name
               | _type_                                             # Parameter without var name
 _required-positionals_ ::= _parameter_ `,` ...
 _optional-positionals_ ::= `?` _parameter_ `,` ...
@@ -529,3 +529,16 @@ You can declare a global variable.
 $LOAD_PATH: Array[String]
 ```
 
+### Comments
+
+You can write single line comments. Comments must be on their own line. Comments can lead with whitespace.
+
+```
+# This if interface Foo
+# Usage of Foo is bar
+interface _Foo
+  # New foo is a method
+  # it will return foo.
+  def new: () -> Foo
+end
+```

data/lib/rbs/ast/members.rb

@@ -11,17 +11,15 @@ module RBS
         attr_reader :annotations
         attr_reader :location
         attr_reader :comment
-        attr_reader :attributes
         attr_reader :overload
 
-        def initialize(name:, kind:, types:, annotations:, location:, comment:, attributes:, overload:)
+        def initialize(name:, kind:, types:, annotations:, location:, comment:, overload:)
           @name = name
           @kind = kind
           @types = types
           @annotations = annotations
           @location = location
           @comment = comment
-          @attributes = attributes
           @overload = overload
         end
 
@@ -30,14 +28,13 @@ module RBS
             other.name == name &&
             other.kind == kind &&
             other.types == types &&
-            other.attributes == attributes &&
             other.overload == overload
         end
 
         alias eql? ==
 
         def hash
-          self.class.hash ^ name.hash ^ kind.hash ^ types.hash ^ attributes.hash ^ overload.hash
+          self.class.hash ^ name.hash ^ kind.hash ^ types.hash ^ overload.hash
         end
 
         def instance?
@@ -52,7 +49,7 @@ module RBS
           overload
         end
 
-        def update(name: self.name, kind: self.kind, types: self.types, annotations: self.annotations, location: self.location, comment: self.comment, attributes: self.attributes, overload: self.overload)
+        def update(name: self.name, kind: self.kind, types: self.types, annotations: self.annotations, location: self.location, comment: self.comment, overload: self.overload)
           self.class.new(
             name: name,
             kind: kind,
@@ -60,7 +57,6 @@ module RBS
             annotations: annotations,
             location: location,
             comment: comment,
-            attributes: attributes,
             overload: overload
           )
         end
@@ -73,7 +69,6 @@ module RBS
             annotations: annotations,
             location: location,
             comment: comment,
-            attributes: attributes,
             overload: overload
           }.to_json(*a)
         end

data/lib/rbs/cli.rb

@@ -1,4 +1,5 @@
 require "optparse"
+require "shellwords"
 
 module RBS
   class CLI
@@ -36,7 +37,7 @@ module RBS
       @stderr = stderr
     end
 
-    COMMANDS = [:ast, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse]
+    COMMANDS = [:ast, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse, :test]
 
     def library_parse(opts, options:)
       opts.on("-r LIBRARY", "Load RBS files of the library") do |lib|
@@ -750,5 +751,65 @@ Examples:
         TypeName.new(name: last, namespace: namespace.parent)
       end
     end
+
+    def test_opt options
+      opt_string = options.dirs.map { |dir| "-I #{Shellwords.escape(dir)}"}.concat(options.libs.map { |lib| "-r#{Shellwords.escape(lib)}"}).join(' ')
+      opt_string.empty? ? nil : opt_string
+    end
+
+    def run_test(args, options)
+      unchecked_classes = []
+      targets = []
+      sample_size = nil
+      double_suite = nil
+
+      (opts = OptionParser.new do |opts|
+        opts.banner = <<EOB
+Usage: rbs [rbs options...] test [test options...] COMMAND
+
+Examples:
+
+  $ rbs test rake test
+  $ rbs --log-level=debug test --target SomeModule::* rspec
+  $ rbs test --target SomeModule::* --target AnotherModule::* --target SomeClass rake test
+
+Options:
+EOB
+        opts.on("--target TARGET", "Sets the runtime test target") do |target|
+          targets << target
+        end
+
+        opts.on("--sample-size SAMPLE_SIZE", "Sets the sample size") do |size|
+          sample_size = size
+        end
+
+        opts.on("--unchecked-class UNCHECKED_CLASS", "Sets the class that would not be checked") do |unchecked_class|
+          unchecked_classes << unchecked_class
+        end
+
+        opts.on("--double-suite DOUBLE_SUITE", "Sets the double suite in use (currently supported: rspec | minitest)") do |suite|
+          double_suite = suite
+        end
+
+      end).order!(args)
+
+      if args.length.zero?
+        stdout.puts opts.help
+        exit 1
+      end
+
+      env_hash = {
+        'RUBYOPT' => "#{ENV['RUBYOPT']} -rrbs/test/setup",
+        'RBS_TEST_OPT' => test_opt(options),
+        'RBS_TEST_LOGLEVEL' => RBS.logger_level,
+        'RBS_TEST_SAMPLE_SIZE' => sample_size,
+        'RBS_TEST_DOUBLE_SUITE' => double_suite,
+        'RBS_TEST_UNCHECKED_CLASSES' => (unchecked_classes.join(',') unless unchecked_classes.empty?),
+        'RBS_TEST_TARGET' => (targets.join(',') unless targets.empty?)
+      }
+
+      system(env_hash, *args)
+      $?
+    end
   end
 end

data/lib/rbs/definition.rb

@@ -45,6 +45,15 @@ module RBS
         def update(type: self.type, member: self.member, defined_in: self.defined_in, implemented_in: self.implemented_in)
           TypeDef.new(type: type, member: member, defined_in: defined_in, implemented_in: implemented_in)
         end
+
+        def overload?
+          case member
+          when AST::Members::MethodDefinition
+            member.overload?
+          else
+            false
+          end
+        end
       end
 
       attr_reader :super_method
@@ -79,9 +88,8 @@ module RBS
         @annotations ||= @extra_annotations + defs.flat_map(&:annotations)
       end
 
-      # @deprecated
-      def attributes
-        []
+      def members
+        @members ||= defs.map(&:member).uniq
       end
 
       def public?

data/lib/rbs/definition_builder.rb

@@ -569,7 +569,7 @@ module RBS
             member, visibility = array[0]
             result[method_name] = [visibility, nil, member]
 
-          when array.count {|pair| !pair[0].overload? } == 1
+          else
             visibilities = array.group_by {|pair| pair[1] }
 
             if visibilities.size > 1
@@ -583,14 +583,6 @@ module RBS
 
             overloads, primary = array.map(&:first).partition(&:overload?)
             result[method_name] = [array[0][1], nil, *primary, *overloads]
-
-          else
-            raise InvalidOverloadMethodError.new(
-              type_name: type_name,
-              method_name: method_name,
-              kind: :instance,
-              members: array.map(&:first)
-            )
           end
         end
       end
@@ -973,8 +965,15 @@ module RBS
                   Substitution.build([], [])
                 end
 
+          kind = case ancestor
+                 when Definition::Ancestor::Instance
+                   :instance
+                 when Definition::Ancestor::Singleton
+                   :singleton
+                 end
+
           current_definition.methods.each do |name, method|
-            merge_method definition.methods, name, method, sub
+            merge_method type_name, definition.methods, name, method, sub, kind: kind
           end
 
           current_definition.instance_variables.each do |name, variable|
@@ -998,13 +997,20 @@ module RBS
       )
     end
 
-    def merge_method(methods, name, method, sub)
+    def merge_method(type_name, methods, name, method, sub, kind:)
       super_method = methods[name]
 
+      defs = if method.defs.all? {|d| d.overload? }
+               raise InvalidOverloadMethodError.new(type_name: type_name, method_name: name, kind: kind, members: method.members) unless super_method
+               method.defs + super_method.defs
+             else
+               method.defs
+             end
+
       methods[name] = Definition::Method.new(
         super_method: super_method,
         accessibility: method.accessibility,
-        defs: sub.mapping.empty? ? method.defs : method.defs.map {|defn| defn.update(type: defn.type.sub(sub)) }
+        defs: sub.mapping.empty? ? defs : defs.map {|defn| defn.update(type: defn.type.sub(sub)) }
       )
     end
 

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/parser.y

@@ -458,16 +458,14 @@ rule
           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),
+          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: