rbs 0.10.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29535fcd236ba4d658d2c975b5084aa58b125203c4aaa1ec4704881b92ed89c7
-  data.tar.gz: 71e165ea5cb1ccbf1b48e9683201f6058dc7c95c7a7619865bf26af2cb6485ad
+  metadata.gz: b9e733e8a7ed63c585d2a2253728700a7cdca633fd6a7953fb95cda24f423604
+  data.tar.gz: e690e3412cc614e0ce7d8c379e78f2d39d5a2def56f2e7165322db7c421cffd2
 SHA512:
-  metadata.gz: 236e10d6a7372a1c9b3c07a343a4620048c3f269f750e74f82539fd819f690475deb52090eec0cf38bc338344d240586f44941339bea7759066f68f90c5a3bdb
-  data.tar.gz: 8ef6ef34e9b39c310f70138135589611c31c8840fdea06eaa606b5004fc5d6634882ddd169b030dd4140645ad9d18c7a4a796a8bba88cd917ea1a69b461efdd1
+  metadata.gz: 87bcb3459cb7ef4ac2e56f1047064e0d2b7412d19023ae63b1329e8e40a1dcff3ce3766cfc1086c8447aa2b2e4aea5207e1bf901b25c3f3d49072d90f5a6c694
+  data.tar.gz: 916e9bb2f678fa321862700f386b09b7de88a127e7d4ba92d9b6139f030a865db18a976e51a5820b84caa4c6598aafda876c5e7183a3ed3ff19b8054cfa16842

data/.github/workflows/ruby.yml

@@ -15,20 +15,20 @@ jobs:
         - master-nightly-bionic 
         - 2.6.5-bionic
         - 2.7.0-bionic
+        job:
+        - test
+        - stdlib_test
+        - rubocop validate test_doc build test_generate_stdlib
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v1
-    - name: Run test
+    - name: Install
       run: |
         ruby -v
         gem install bundler
         bin/setup
-        bundle exec rake test
-        bundle exec rake stdlib_test
-        bundle exec rake rubocop
-        bundle exec rake validate
-        bundle exec rake test_doc
-        bundle exec rake build
-        RBS_GENERATE_TEST_PATH=/tmp/Array_test.rb bundle exec rake 'generate:stdlib_test[Array]'
-        ruby -c /tmp/Array_test.rb
+    - name: Run test
+      run: |
+        bundle exec rake ${{ matrix.job }}
+      if: "!(matrix.job == 'stdlib_test' && contains(matrix.container_tag, '2.6.5'))"

data/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 ## master
 
+## 0.13.0 (2020-09-09)
+
+* Signature updates for `URI` classes.
+* Fix tests ([#410](https://github.com/ruby/rbs/pull/410))
+* Add `--silent` option for `rbs validate` ([#411](https://github.com/ruby/rbs/pull/411))
+
+## 0.12.2 (2020-09-17)
+
+* Minor signature update for `pty`
+* Fix `PTY` stdlib test
+
+## 0.12.1 (2020-09-16)
+
+This version is to improve Ruby 3 testing compatibility. Nothing changed for users.
+
+## 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`

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,23 +21,23 @@ 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 --silent"
 
   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 --silent"
   end
 end
 
 FileList["test/stdlib/**/*_test.rb"].each do |test|
-  multitask test => :parser do
-    sh "ruby bin/test_runner.rb #{test}"
+  task test => :parser do
+    sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test}"
   end
-  multitask stdlib_test: test
+  task stdlib_test: test
 end
 
 task :rubocop do
@@ -171,4 +176,9 @@ namespace :generate do
   end
 end
 
+task :test_generate_stdlib do
+  sh "RBS_GENERATE_TEST_PATH=/tmp/Array_test.rb rake 'generate:stdlib_test[Array]'"
+  sh "ruby -c /tmp/Array_test.rb"
+end
+
 CLEAN.include("lib/rbs/parser.rb")

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,14 @@
 #!/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")
+
+IS_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')
 end
 
-unless RUBY_27
-  STDERR.puts "🚨🚨🚨 stdlib test requires Ruby 2.7 but RUBY_VERSION==#{RUBY_VERSION}, exiting... 🚨🚨🚨"
-  exit
+unless IS_RUBY_27
+  STDERR.puts "⚠️⚠️⚠️⚠️ stdlib test assumes Ruby 2.7 but RUBY_VERSION==#{RUBY_VERSION} ⚠️⚠️⚠️⚠️"
 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

@@ -25,7 +25,13 @@ module RBS
 
       def concat(string:, location:)  
         @string.concat string
-        @location.concat location
+
+        if loc = @location
+          loc.concat location
+        else
+          @location = location
+        end
+
         self
       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,6 @@
+require "open3"
 require "optparse"
+require "shellwords"
 
 module RBS
   class CLI
@@ -36,7 +38,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|
@@ -382,6 +384,11 @@ Examples:
 
   $ rbs validate
 EOU
+
+        opts.on("--silent") do
+          require "stringio"
+          @stdout = StringIO.new
+        end
       end.parse!(args)
 
       loader = EnvironmentLoader.new()
@@ -487,7 +494,7 @@ Show paths to directories where the RBS files are loaded from.
 Examples:
 
   $ rbs paths
-  $ tbs -r set paths
+  $ rbs -r set paths
 EOU
       end.parse!(args)
 
@@ -542,7 +549,7 @@ EOU
 Usage: rbs prototype runtime [options...] [pattern...]
 
 Generate RBS prototype based on runtime introspection.
-It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern]. 
+It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern].
 
 Examples:
 
@@ -750,5 +757,67 @@ 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?)
+      }
+
+      out, err, status = Open3.capture3(env_hash, *args)
+      stdout.print(out)
+      stderr.print(err)
+      status
+    end
   end
 end