rbs 2.0.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6c23428bebbddb53710d5f77761d75bdcafa38d988b9fdc62b20563ff3eb60a
-  data.tar.gz: 65c065d547aed025238d0350800830e31e18a3fcd21db73406a7374202517b80
+  metadata.gz: d38dbf926f1fd55787f5d4a70ed5e31ce737e040b698e2aa3d5f68ab14a8b791
+  data.tar.gz: 0d86ba79682c662bc3ab2058a0e4464be43d8a317e58194c0e7dfd1f8aaec735
 SHA512:
-  metadata.gz: c0fbada9d621cb2e1cd2a3793ad208d78a50f826c1c58e03eb5d256f8e6fa024446549f2943c85e37dc0ad1170672b66651dab66d5f8eb3d0a0f9b5757e9315e
-  data.tar.gz: 505fcfdf431ac0c904325494157fab4c5b1855b200ba1d416be0cf3680c173ac302517eb99a93d6657a0344a1fa198a2455498fec493f6b240a96d7b8cddf994
+  metadata.gz: 25801791a12dfe85b729fc0e72eb9ebdb0e801c3c1fe3a1f8d9ec2ded0476e8b2a35a7ac520f034a1d8fe2e954bf4bc6d59caaaf9136286cd5844e8f3d8ae7da
+  data.tar.gz: b5ad3e185184b6ffcb786379abd5909284bab2a680ece911db40fccc7b8d258a52d588114ee99178c00b1d5bcf2030698c7e9db94b7b00b3d2ea88d269dd9de7

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,6 +2,88 @@
 
 ## master
 
+## 2.2.2 (2022-02-22)
+
+### Signature updates
+
+* `cgi` ([\#761](https://github.com/ruby/rbs/pull/761))
+* `json` ([\#761](https://github.com/ruby/rbs/pull/761))
+* `set` ([\#761](https://github.com/ruby/rbs/pull/761))
+
+## 2.2.1 (2022-02-22)
+
+### Library changes
+
+* Let `validate_type_alias` run without an error on unknown type ([\#912](https://github.com/ruby/rbs/pull/912))
+
+## 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

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
@@ -63,6 +72,10 @@ task :validate => :compile do
       lib << "monitor"
     end
 
+    if lib == ["cgi"]
+      lib << "tempfile"
+    end
+
     if lib == ["csv"]
       lib << "forwardable"
     end
@@ -73,6 +86,7 @@ task :validate => :compile do
 
     if lib == ["net-http"]
       lib << "uri"
+      lib << "timeout"
     end
 
     if lib == ["resolv"]
@@ -106,17 +120,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 +169,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 +187,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 +237,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 +259,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