rbs 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2e86d5e87d89f97eed8e2674aa5f5035413179ba104a5cb265ab748268c51fe
-  data.tar.gz: 9d58fa00413d5a334496ee688bbc72520e1911558f39ad2d01b180b790e5d894
+  metadata.gz: db07b9abb1ed59e789d6a13145e33503f20e37a908826c3c8ba8222f9cf79ec6
+  data.tar.gz: a42440c8542489fd70f24139f24e718b106caa99925a437857867141f730ed9a
 SHA512:
-  metadata.gz: 328850c1f912cd7cc45e1c210140c098206f668c0400a817cde00e36dec1591ec235b5b6a1255b0e66d585745d4f6f7effeb09f28ae2a7536091852f9ba8bc89
-  data.tar.gz: 96bc5adc81b98d723a98d20dcbeef13424fb0a4267272ff1ad6daaab5ef310f24c038f4e23793253beade1e55a00a6eece457697a3a4ec62413f08b7c42ace99
+  metadata.gz: 606289f49ac2d2934808add204997b7828708b05f2b3d60c10f8de6106cbca06527fd628de445511dfa537976fab551e878a45b5ab03ac41374cf242f90b6244
+  data.tar.gz: 5de0b5b93fd872a69fe25d62eaf72fba3fc4d93b57f04f5da311fc66d3b6eeebe53fb654cea4361da32124861ac21c1ad9547bf9e7c0012b6db704e98164a8d9

data/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 ## master
 
+## 0.12.0 (2020-09-15)
+
+* Signature updates for `forwardable`, `struct`, `set`, `URI::Generic`, `URI::File`, and `BigDecimal`.
+* Define `.new` methods from `initialize` included from modules [#390](https://github.com/ruby/rbs/pull/390)
+
+## 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`
+* Make "no type checker installed" message a debug print [#363](https://github.com/ruby/rbs/pull/363)
+* Print `...` for overloading method definitions [#362](https://github.com/ruby/rbs/pull/362)
+* Allow missing method implementation in Ruby code [#359](https://github.com/ruby/rbs/pull/359)
+* Runtime testing improvements [#356](https://github.com/ruby/rbs/pull/356)
+
+## 0.9.1 (2020-08-04)
+
+* Ensure using Module#name [#354](https://github.com/ruby/rbs/pull/354)
+* Fix runtime test setup [#353](https://github.com/ruby/rbs/pull/353)
+
+## 0.9.0 (2020-08-03)
+
+* Fix signature validation [#351](https://github.com/ruby/rbs/pull/351), [#352](https://github.com/ruby/rbs/pull/352)
+* Parsing performance improvement [#350](https://github.com/ruby/rbs/pull/350)
+
 ## 0.8.0 (2020-08-01)
 
 * Signature updates for `Enumerator` and `PTY`

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/Rakefile

@@ -1,5 +1,10 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rbconfig"
+
+ruby = ENV["RUBY"] || RbConfig.ruby
+rbs = File.join(__dir__, "exe/rbs")
+bin = File.join(__dir__, "bin")
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -16,21 +21,21 @@ task :test_doc => :parser do
     `git ls-files -z`.split("\x0").select do |file| Pathname(file).extname == ".md" end
   end
 
-  sh "ruby bin/run_in_md.rb #{files.join(" ")}"
+  sh "#{ruby} #{__dir__}/bin/run_in_md.rb #{files.join(" ")}"
 end
 
 task :validate => :parser do
-  sh "rbs validate"
+  sh "#{ruby} #{rbs} validate"
 
   FileList["stdlib/*"].each do |path|
     next if path =~ %r{stdlib/builtin}
-    sh "rbs -r#{File.basename(path)} validate"
+    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate"
   end
 end
 
 FileList["test/stdlib/**/*_test.rb"].each do |test|
   multitask test => :parser do
-    sh "ruby bin/test_runner.rb #{test}"
+    sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test}"
   end
   multitask stdlib_test: test
 end

data/Steepfile

@@ -0,0 +1,28 @@
+target :lib do
+  signature "sig"
+  check "lib"
+
+  vendor stdlib: "stdlib"
+  library "set", "pathname", "json", "logger"
+end
+
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+# end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

data/bin/steep

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+GEMFILE=$(cd $(dirname $0); pwd)/../steep/Gemfile
+bundle exec --gemfile=${GEMFILE} steep $*

data/bin/test_runner.rb

@@ -1,12 +1,17 @@
 #!/usr/bin/env ruby
 
-RUBY_27 = Gem::Version.new(RUBY_VERSION).yield_self do |ruby_version|
-  Gem::Version.new('2.7.0') <= ruby_version && ruby_version < Gem::Version.new("2.8.0")
+$LOAD_PATH << File.join(__dir__, "../lib")
+
+STDLIB_TEST = Gem::Version.new(RUBY_VERSION).yield_self do |ruby_version|
+  Gem::Version.new('2.7.0') <= ruby_version &&
+    ruby_version <= Gem::Version.new('2.8.0')
 end
 
-unless RUBY_27
-  STDERR.puts "🚨🚨🚨 stdlib test requires Ruby 2.7 but RUBY_VERSION==#{RUBY_VERSION}, exiting... 🚨🚨🚨"
-  exit
+unless STDLIB_TEST
+  unless ENV["FORCE_STDLIB_TEST"]
+    STDERR.puts "🚨🚨🚨 stdlib test requires Ruby 2.7 or later but RUBY_VERSION==#{RUBY_VERSION}, exiting... 🚨🚨🚨"
+    exit
+  end
 end
 
 ARGV.each do |arg|

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

@@ -22,6 +22,18 @@ module RBS
       def to_json(*a)
         { string: string, location: location }.to_json(*a)
       end
+
+      def concat(string:, location:)  
+        @string.concat string
+
+        if loc = @location
+          loc.concat location
+        else
+          @location = location
+        end
+
+        self
+      end
     end
   end
 end

data/lib/rbs/ast/declarations.rb

@@ -7,7 +7,7 @@ module RBS
       class ModuleTypeParams
         attr_reader :params
 
-        TypeParam = Struct.new(:name, :variance, :skip_validation, keyword_init: true) do
+        TypeParam = _ = Struct.new(:name, :variance, :skip_validation, keyword_init: true) do
           def to_json(*a)
             {
               name: name,
@@ -47,7 +47,11 @@ module RBS
         end
 
         def each(&block)
-          params.each(&block)
+          if block
+            params.each(&block)
+          else
+            params.each
+          end
         end
 
         def self.empty
@@ -55,11 +59,13 @@ module RBS
         end
 
         def variance(name)
-          self[name].variance
+          var = self[name] or raise
+          var.variance
         end
 
         def skip_validation?(name)
-          self[name].skip_validation
+          var = self[name] or raise
+          var.skip_validation
         end
 
         def empty?
@@ -85,7 +91,7 @@ module RBS
           if block_given?
             members.each do |member|
               if member.is_a?(Members::Base)
-                yield member
+                yield(_ = member)
               end
             end
           else
@@ -96,8 +102,8 @@ module RBS
         def each_decl
           if block_given?
             members.each do |member|
-              if member.is_a?(Declarations::Base)
-                yield member
+              if member.is_a?(Base)
+                yield(_ = member)
               end
             end
           else
@@ -108,9 +114,9 @@ module RBS
 
       module MixinHelper
         def each_mixin(&block)
-          if block_given?
+          if block
             @mixins ||= begin
-                          members.select do |member|
+                          _ = members.select do |member|
                             case member
                             when Members::Include, Members::Extend, Members::Prepend
                               true

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

@@ -23,7 +23,7 @@ module RBS
 
     def pos_to_loc(pos)
       index = ranges.bsearch_index do |range|
-        pos < range.end
+        pos < range.end ? true : false
       end
 
       if index

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|
@@ -413,6 +414,7 @@ EOU
       env.constant_decls.each do |name, const|
         stdout.puts "Validating constant: `#{name}`..."
         validator.validate_type const.decl.type, context: const.context
+        builder.ensure_namespace!(name.namespace, location: const.decl.location)
       end
 
       env.global_decls.each do |name, global|
@@ -422,7 +424,9 @@ EOU
 
       env.alias_decls.each do |name, decl|
         stdout.puts "Validating alias: `#{name}`..."
-        validator.validate_type decl.decl.type, context: decl.context
+        builder.expand_alias(name).tap do |type|
+          validator.validate_type type, context: [Namespace.root]
+        end
       end
     end
 
@@ -747,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,24 +45,41 @@ 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 mem = member
+          when AST::Members::MethodDefinition
+            mem.overload?
+          else
+            false
+          end
+        end
       end
 
       attr_reader :super_method
       attr_reader :defs
       attr_reader :accessibility
+      attr_reader :extra_annotations
 
-      def initialize(super_method:, defs:, accessibility:)
+      def initialize(super_method:, defs:, accessibility:, annotations: [])
         @super_method = super_method
         @defs = defs
         @accessibility = accessibility
+        @extra_annotations = annotations
       end
 
       def defined_in
-        @defined_in ||= defs.last.defined_in
+        @defined_in ||= begin
+          last_def = defs.last or raise
+          last_def.defined_in
+        end
       end
 
       def implemented_in
-        @implemented_in ||= defs.last.implemented_in
+        @implemented_in ||= begin
+          last_def = defs.last or raise
+          last_def.implemented_in
+        end
       end
 
       def method_types
@@ -70,16 +87,15 @@ module RBS
       end
 
       def comments
-        @comments ||= defs.map(&:comment).compact
+        @comments ||= _ = defs.map(&:comment).compact
       end
 
       def annotations
-        @annotations ||= defs.flat_map(&:annotations)
+        @annotations ||= @extra_annotations + defs.flat_map(&:annotations)
       end
 
-      # @deprecated
-      def attributes
-        []
+      def members
+        @members ||= defs.map(&:member).uniq
       end
 
       def public?
@@ -116,8 +132,8 @@ module RBS
     end
 
     module Ancestor
-      Instance = Struct.new(:name, :args, keyword_init: true)
-      Singleton = Struct.new(:name, keyword_init: true)
+      Instance = _ = Struct.new(:name, :args, keyword_init: true)
+      Singleton = _ = Struct.new(:name, keyword_init: true)
     end
 
     class InstanceAncestors
@@ -209,7 +225,10 @@ module RBS
     end
 
     def interface?
-      entry.is_a?(Environment::SingleEntry) && entry.decl.is_a?(AST::Declarations::Interface)
+      case en = entry
+      when Environment::SingleEntry
+        en.decl.is_a?(AST::Declarations::Interface)
+      end
     end
 
     def class_type?
@@ -229,16 +248,16 @@ module RBS
     end
 
     def type_params_decl
-      case entry
+      case en = entry
       when Environment::ClassEntry, Environment::ModuleEntry
-        entry.type_params
+        en.type_params
       when Environment::SingleEntry
-        entry.decl.type_params
+        en.decl.type_params
       end
     end
 
     def sub(s)
-      definition = self.class.new(type_name: type_name, self_type: self_type.sub(s), ancestors: ancestors, entry: entry)
+      definition = self.class.new(type_name: type_name, self_type: _ = self_type.sub(s), ancestors: ancestors, entry: entry)
 
       definition.methods.merge!(methods.transform_values {|method| method.sub(s) })
       definition.instance_variables.merge!(instance_variables.transform_values {|v| v.sub(s) })
@@ -258,7 +277,7 @@ module RBS
     end
 
     def each_type(&block)
-      if block_given?
+      if block
         methods.each_value do |method|
           if method.defined_in == type_name
             method.method_types.each do |method_type|