rbs 2.0.0.pre1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df2f2f119ca85f630c640b201ebf9ce72322db96223de2fb1d4ba77df68aee59
-  data.tar.gz: 82943e12963a10f2a4dbd30096fe40fb90ee4b23d6239bd515526a39d2af3b97
+  metadata.gz: f4afaa0d6ac4b7b74aae38aa7cd04679dad881ad073ca496aa06f272a7261cfe
+  data.tar.gz: 041f1bf758d156f9a968ae3cb460da45a99f80aacb2868513549687ee4e4ad76
 SHA512:
-  metadata.gz: 9dbd99091da5e5d116a5bb428383c3e63e8b8ee4207ea859e177577b33a1d1dc3d312bb31f03fcda61d90993b4a9ab1ccab69855e7ecb8e986f9696a638c618d
-  data.tar.gz: dc05caaa25da531bbe353eb0294fbe016a90039eef12a040f2c5b07f409683c9fbc6c3406beba8c8d76f25f5b0ed7bbc3501967cc84fcc000a2e49fda85e84a3
+  metadata.gz: 8891199897e1ef1574b8009bc810c0d60a1a8fbe4a9f2d5d6658b703c75d515d6e89022e5246a6196657775d8f0ea2bd44db13718a425face5d16d3e5cff38dd
+  data.tar.gz: faa9199018c944a87de33fc99a4bf203e73f2f24d27960d79cd92fb82aaa6be2218cae07a2bb6887ad1dee2df96e8abc7b43ec818bf11d5a40dfabf3e782f1c2

data/.github/workflows/comments.yml

@@ -0,0 +1,34 @@
+name: RBS Comments
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    container:
+      image: rubylang/ruby:3.1-focal
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        apt-get update
+        apt-get install -y libdb-dev
+    - name: Update rubygems & bundler
+      run: |
+        ruby -v
+        gem update --system
+    - name: bundle config set with
+      run: |
+        echo "NO_MINITEST=true" >> $GITHUB_ENV
+        bundle config set --local without 'minitest'
+      if: "contains(matrix.container_tag, 'master-nightly')"
+    - name: bin/setup
+      run: |
+        bin/setup
+    - name: Run test
+      run: |
+        bundle exec rake annotate confirm_annotation

data/.github/workflows/ruby.yml

@@ -13,6 +13,7 @@ jobs:
       matrix:
         container_tag:
         - master-nightly-focal
+        - 3.1-focal
         - 3.0-focal
         - 2.7-bionic
         - 2.6-bionic
@@ -27,6 +28,10 @@ jobs:
           job: confirm_lexer
         - container_tag: 2.6-bionic
           job: stdlib_test
+        - container_tag: 2.7-bionic
+          job: stdlib_test
+        - container_tag: 3.0-focal
+          job: stdlib_test
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:

data/CHANGELOG.md

@@ -2,11 +2,79 @@
 
 ## master
 
-## 2.0.0 (pre1)
+## 2.2.0 (2022-02-22)
+
+RBS 2.2 ships with a new syntax to specify the visibility of a method per definition bases.
+
+```rbs
+class Foo
+  private def hello: () -> void
+
+  private attr_accessor world: String
+end
+```
+
+It also changes the semantics of `self?` method.
+It defines both _public_ singleton method and _private_ instance method, which is equivalent to `module_function`.
+
+## Signature updates
+
+* `net-http` ([\#892](https://github.com/ruby/rbs/pull/892))
+* `uri` ([\#864](https://github.com/ruby/rbs/pull/864))
+* `Encoding` ([\#897](https://github.com/ruby/rbs/pull/897), [\#898](https://github.com/ruby/rbs/pull/898))
+* `File::Stat` ([\#879](https://github.com/ruby/rbs/pull/879))
+* `Kernel#sleep` ([\#893](https://github.com/ruby/rbs/pull/893))
+
+### Language updates
+
+* Add public/private per member modifier ([\#911](https://github.com/ruby/rbs/pull/911))
+* Let `self?.` be equivalent to `module_function` ([\#910](https://github.com/ruby/rbs/pull/910))
+
+### Library changes
+
+* Add c99 flag for compiling on Ruby 2 ([\#895](https://github.com/ruby/rbs/pull/895))
+* Fix incorrect URI reference in `schema/typeParam.json` ([\#891](https://github.com/ruby/rbs/pull/891))
+* Allow scaffolding below namespace ([\#894](https://github.com/ruby/rbs/pull/894))
+* Let `Writer` preserve format ([\#900](https://github.com/ruby/rbs/pull/900))
+* Reduce memory usage of `RBS::Buffer` ([\#907](https://github.com/ruby/rbs/pull/907))
+* Do not call `#class` from `#hash` to improve performance ([\#906](https://github.com/ruby/rbs/pull/906))
+* Skip type variable validation if `unchcked` ([\#909](https://github.com/ruby/rbs/pull/909))
+
+### Miscellaneous
+
+* Add `Thread::Backtrace` and `Thread::Backtrace::Location` test ([\#896](https://github.com/ruby/rbs/pull/896))
+* Test annotations ([\#902](https://github.com/ruby/rbs/pull/902))
+* Remove goodcheck rule for arglists section ([\#901](https://github.com/ruby/rbs/pull/901))
+* Remove `CharScanner` due to no longer used ([\#905](https://github.com/ruby/rbs/pull/905))
+
+## 2.1.0 (2022-02-02)
+
+RBS 2.1 is a release to deliver the types and documents of the new and updated methods of Ruby 3.1.
+
+### Signature updates
+
+* Documents imported from Ruby 3.1 ([\#881](https://github.com/ruby/rbs/pull/881))
+* Methods/classes updated in Ruby 3.1 ([\#886](https://github.com/ruby/rbs/pull/886))
+* io/wait ([\#865](https://github.com/ruby/rbs/pull/865))
+* json ([\#863](https://github.com/ruby/rbs/pull/863))
+* nkf ([\#873](https://github.com/ruby/rbs/pull/873))
+* openssl ([\#866](https://github.com/ruby/rbs/pull/866))
+* `Dir.exists?`, `FileTest#exists?` ([\#884](https://github.com/ruby/rbs/pull/884))
+* `FileTest` ([\#880](https://github.com/ruby/rbs/pull/880))
+* `Gem::Version#<=>` ([\#869](https://github.com/ruby/rbs/pull/869))
+* `Process.clock_gettime` ([\#858](https://github.com/ruby/rbs/pull/858))
+
+### Library changes
+
+* Introduce `rbs annotate` command ([\#881](https://github.com/ruby/rbs/pull/881))
+* Make prototype rb to be aware of prepend ([\#861](https://github.com/ruby/rbs/pull/861))
+* Fixes incorrect "Invalid Variance" error when method type variable shadows outer type variable ([#889](https://github.com/ruby/rbs/pull/889))
+
+## 2.0.0 (2021-12-24)
 
 ### Bounded Generics
 
-RBS 2.0 ships with _bounded generics_, which improves the expressiveness of the language by adding new syntax to define the constraint on type parameters.
+RBS 2.0 ships with _bounded generics_, which improves the expressiveness of the language by adding a new syntax to define constraints on type parameters.
 
 ```rbs
 class PrettyPrint[T < _Output]
@@ -28,7 +96,31 @@ It means _`T` has to be compatible with `_Output` interface._
 
 See [the PR for details](https://github.com/ruby/rbs/pull/844).
 
-`manifest.yaml` allows declaring the dependencies from your gems to standard libraries explicitly.
+### RBS Collection manager
+
+RBS Collection feature is generally available on RBS 2.0. In short, it is Bundler for RBS. You can manage RBSs of standard libraries and third party gems with `rbs collection` subcommand.
+
+```bash
+$ rbs collection init
+created: rbs_collection.yaml
+
+# The `install` command set up RBS files and creates `rbs_collection.lock.yaml` file
+$ rbs collection install
+Installing actionpack:6.0 (actionpack@ce6664cec73)
+(...snip...)
+Using tsort:0 (/path/to/rbs-2.0.0/stdlib/tsort/0)
+It's done! 21 gems' RBSs now installed.
+
+# Now you can use `rbs`, `typeprof` and `steep` commands with the dependencies out of the box!
+$ rbs validate
+$ typeprof app.rb
+$ steep check
+```
+
+RBS 2.0 also introduces `manifest.yaml` to declare the dependencies from your gems to standard libraries explicitly.
+See [the documentation](https://github.com/ruby/rbs/blob/master/docs/collection.md) for more information.
+
+### Breaking changes
 
 This version contains a bug fix, which potentially breaks the compatibility with older versions.
 The super class names in class definitions are now resolved in _outer_ context.
@@ -36,7 +128,7 @@ It was an incompatibility with Ruby and [this PR](https://github.com/ruby/rbs/pu
 
 ### Signature updates
 
-* uri ([\#846](https://github.com/ruby/rbs/pull/846), [\#852](https://github.com/ruby/rbs/pull/852), [\#851](https://github.com/ruby/rbs/pull/851), [\#850](https://github.com/ruby/rbs/pull/850))
+* uri ([\#846](https://github.com/ruby/rbs/pull/846), [\#852](https://github.com/ruby/rbs/pull/852), [\#851](https://github.com/ruby/rbs/pull/851), [\#850](https://github.com/ruby/rbs/pull/850), [#849](https://github.com/ruby/rbs/pull/849))
 
 ### Language updates
 

data/README.md

@@ -52,6 +52,11 @@ end
 ```
 <!-- run-end -->
 
+## The Target Version
+
+* The standard library signatures targets Ruby 3.1. (The latest release of Ruby.)
+* The library code targets Ruby 3.1, 3.0, and 2.7. (It runs on 2.6 in fact.)
+
 ## Installation
 
 Install the `rbs` gem. `$ gem install rbs` from the command line, or add a line in your `Gemfile`.
@@ -122,7 +127,7 @@ puts singleton.methods[:gsub]
 
 ## Guides
 
-- [Standard library signature contribution guide](docs/CONTRIBUTING.md)
+- [Core and standard library signature contribution guide](docs/CONTRIBUTING.md)
 - [Writing signatures guide](docs/sigs.md)
 - [Stdlib signatures guide](docs/stdlib.md)
 - [Syntax](docs/syntax.md)

data/Rakefile

@@ -34,6 +34,15 @@ rule ".c" => ".re" do |t|
   puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake lexer` ⚠️⚠️⚠️"
 end
 
+task :annotate do
+  sh "rbs annotate core stdlib"
+end
+
+task :confirm_annotation do
+  puts "Testing if RBS docs are updated with respect to RDoc"
+  sh "git diff --exit-code core stdlib"
+end
+
 task :compile => "ext/rbs_extension/lexer.c"
 
 task :test_doc do
@@ -73,6 +82,7 @@ task :validate => :compile do
 
     if lib == ["net-http"]
       lib << "uri"
+      lib << "timeout"
     end
 
     if lib == ["resolv"]
@@ -106,17 +116,40 @@ namespace :generate do
       raise "Class name is necessary. e.g. rake 'generate:stdlib_test[String]'"
     end
 
-    path = Pathname(ENV["RBS_GENERATE_TEST_PATH"] || "test/stdlib/#{klass}_test.rb")
-    raise "#{path} already exists!" if path.exist?
-
     require "erb"
     require "rbs"
 
+    class TestTarget
+      def initialize(klass)
+        @type_name = RBS::Namespace.parse(klass).to_type_name
+      end
+
+      def path
+        Pathname(ENV['RBS_GENERATE_TEST_PATH'] || "test/stdlib/#{file_name}_test.rb")
+      end
+
+      def file_name
+        @type_name.to_s.gsub(/\A::/, '').gsub(/::/, '_')
+      end
+
+      def to_s
+        @type_name.to_s
+      end
+
+      def absolute_type_name
+        @absolute_type_name ||= @type_name.absolute!
+      end
+    end
+
+    target = TestTarget.new(klass)
+    path = target.path
+    raise "#{path} already exists!" if path.exist?
+
     class TestTemplateBuilder
-      attr_reader :klass, :env
+      attr_reader :target, :env
 
-      def initialize(klass)
-        @klass = klass
+      def initialize(target)
+        @target = target
 
         loader = RBS::EnvironmentLoader.new
         Dir['stdlib/*'].each do |lib|
@@ -132,17 +165,17 @@ namespace :generate do
           require_relative "test_helper"
 
           <%- unless class_methods.empty? -%>
-          class <%= klass %>SingletonTest < Test::Unit::TestCase
+          class <%= target %>SingletonTest < Test::Unit::TestCase
             include TypeAssertions
 
             # library "pathname", "set", "securerandom"     # Declare library signatures to load
-            testing "singleton(::<%= klass %>)"
+            testing "singleton(::<%= target %>)"
 
           <%- class_methods.each do |method_name, definition| %>
             def test_<%= test_name_for(method_name) %>
           <%- definition.method_types.each do |method_type| -%>
               assert_send_type  "<%= method_type %>",
-                                <%= klass %>, :<%= method_name %>
+                                <%= target %>, :<%= method_name %>
           <%- end -%>
             end
           <%- end -%>
@@ -150,17 +183,17 @@ namespace :generate do
           <%- end -%>
 
           <%- unless instance_methods.empty? -%>
-          class <%= klass %>Test < Test::Unit::TestCase
+          class <%= target %>Test < Test::Unit::TestCase
             include TypeAssertions
 
             # library "pathname", "set", "securerandom"     # Declare library signatures to load
-            testing "::<%= klass %>"
+            testing "::<%= target %>"
 
           <%- instance_methods.each do |method_name, definition| %>
             def test_<%= test_name_for(method_name) %>
           <%- definition.method_types.each do |method_type| -%>
               assert_send_type  "<%= method_type %>",
-                                <%= klass %>.new, :<%= method_name %>
+                                <%= target %>.new, :<%= method_name %>
           <%- end -%>
             end
           <%- end -%>
@@ -200,24 +233,20 @@ namespace :generate do
         }.fetch(method_name, method_name)
       end
 
-      def type_name
-        @type_name ||= RBS::TypeName.new(name: klass.to_sym, namespace: RBS::Namespace.new(path: [], absolute: true))
-      end
-
       def class_methods
-        @class_methods ||= RBS::DefinitionBuilder.new(env: env).build_singleton(type_name).methods.select {|_, definition|
-          definition.implemented_in == type_name
+        @class_methods ||= RBS::DefinitionBuilder.new(env: env).build_singleton(target.absolute_type_name).methods.select {|_, definition|
+          definition.implemented_in == target.absolute_type_name
         }
       end
 
       def instance_methods
-        @instance_methods ||= RBS::DefinitionBuilder.new(env: env).build_instance(type_name).methods.select {|_, definition|
-          definition.implemented_in == type_name
+        @instance_methods ||= RBS::DefinitionBuilder.new(env: env).build_instance(target.absolute_type_name).methods.select {|_, definition|
+          definition.implemented_in == target.absolute_type_name
         }
       end
     end
 
-    path.write TestTemplateBuilder.new(klass).call
+    path.write TestTemplateBuilder.new(target).call
 
     puts "Created: #{path}"
   end
@@ -226,4 +255,6 @@ 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"
+  sh "RBS_GENERATE_TEST_PATH=/tmp/Thread_Mutex_test.rb rake 'generate:stdlib_test[Thread::Mutex]'"
+  sh "ruby -c /tmp/Thread_Mutex_test.rb"
 end