rbs 3.6.1 → 3.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd93b9bdce0e6148409689ba4aa2db4d34109e46b799706b6f44944134f1b817
-  data.tar.gz: 3780dcddba54316cf7cb97224f7dc7a187195904a3f21cc430a017c03d663387
+  metadata.gz: 71d2f47af53cec9b87afca94ed1f79caf43e91caed557a454d6cd1532252dac1
+  data.tar.gz: a5e0d3a9e65aad57295754716a9d9f2d99d0a841ed930fa6b2b5a991151fdab9
 SHA512:
-  metadata.gz: 786d469a57422f169e2980a4b0f80eb4ec857081f51b2c56ac87e070abd118b4245f537457de06058ef32ea394742e9bcb3cd106c7d3408b51a0aab8a622a260
-  data.tar.gz: 7b70ac096f7d53171b5aebcafc6605426e80ee598cddabb70c520b689cc07fadbaa22bda3d2bd9f6a748587cc6ce11246c3a79f50125ea102cf561ed66bfc353
+  metadata.gz: 29487fc82d44333d8c63e910c26a9d3454e5d0e8e6c5d7951e25bf87e2ab2d4c8d444e53b81098da3b0b7080f3d3d80cde92132494a0422ee4d18bd04c915249
+  data.tar.gz: ba2e2a81be7d83bb31f6e1e58824ca9eea51c29bff4fbf54eddb93245b258118265f31c2f2753e68e3d9639dd242083311252037c15c3dc17f88d1f09a92518b

data/.github/workflows/ruby.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2', '3.3', head]
+        ruby: ['3.1', '3.2', '3.3', head]
         rubyopt: [""]
         job:
           - test
@@ -29,11 +29,13 @@ jobs:
             job: stdlib_test
             rubyopt: "--enable-frozen-string-literal"
           - ruby: "3.3"
-            job: lexer compile confirm_lexer
+            job: lexer templates compile confirm_lexer confirm_templates
           - ruby: "3.3"
             job: rubocop validate test_doc build test_generate_stdlib raap
           - ruby: "3.3"
             job: typecheck_test
+    env:
+      RANDOMIZE_STDLIB_TEST_ORDER: "true"
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1

data/.github/workflows/windows.yml

@@ -20,7 +20,9 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: rake-compiler
-        run: gem install rake-compiler
+      - name: bundle install
+        run: |
+          bundle config set without profilers libs
+          bundle install
       - name: compile
-        run: rake compile
+        run: bundle exec rake compile

data/.gitignore

@@ -19,4 +19,5 @@ lib/**/*.bundle
 lib/**/*.so
 lib/**/*.dll
 doc/
+
 **/*.gem

data/.rubocop.yml

@@ -28,11 +28,17 @@ RBS/Lint:
   Exclude:
     - 'sig/**/*'
     - 'test/**/*'
+RBS/Lint/TopLevelInterface:
+  Enabled: false
+RBS/Lint/TopLevelTypeAlias:
+  Enabled: false
 RBS/Style:
   Enabled: false
   Exclude:
     - 'sig/**/*'
     - 'test/**/*'
+RBS/Style/EmptyArgument:
+  Enabled: true
 RBS/Style/InitializeReturnType:
   Enabled: true
 

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # CHANGELOG
 
+## 3.7.0.pre.1 (2024-12-05)
+
+### Signature updates
+
+* `CGI.accept_charset` ([#2045](https://github.com/ruby/rbs/pull/2045))
+* `IO#readline`, `IO#readlines` ([#2059](https://github.com/ruby/rbs/pull/2059))
+* `Kernel#proc` ([#2036](https://github.com/ruby/rbs/pull/2036))
+* `Kernel#system` ([#2075](https://github.com/ruby/rbs/pull/2075))
+* `Object#to_yaml` ([#2107](https://github.com/ruby/rbs/pull/2107))
+* `OpenSSL::Digest` ([#2108](https://github.com/ruby/rbs/pull/2108))
+* `OpenSSL.base64digest` ([#2078](https://github.com/ruby/rbs/pull/2078))
+* `Process.detach` ([#2083](https://github.com/ruby/rbs/pull/2083))
+
+### Library changes
+
+* Reduce object allocation for record type ([#2118](https://github.com/ruby/rbs/pull/2118))
+* Milestone to graduate stringio from core. ([#2114](https://github.com/ruby/rbs/pull/2114))
+* Mark all internal `parse_` methods as `static` ([#2103](https://github.com/ruby/rbs/pull/2103))
+* Add templating mechanism to automatically generate `.c`/`.h` files ([#2098](https://github.com/ruby/rbs/pull/2098))
+* Remove unused `rbs_unescape_string` declaration ([#2058](https://github.com/ruby/rbs/pull/2058))
+* Fix UntypedFunction does not provide #map_type_name ([#2054](https://github.com/ruby/rbs/pull/2054))
+* Better `instance_eval`/`instance_exec` detection ([#2052](https://github.com/ruby/rbs/pull/2052))
+* Overload annotations ([#2049](https://github.com/ruby/rbs/pull/2049))
+
+#### rbs prototype
+
+* prototype rb: Fix crashed by self::CONST ([#2079](https://github.com/ruby/rbs/pull/2079))
+
+#### rbs collection
+
+* mutex_m support ([#2115](https://github.com/ruby/rbs/pull/2115))
+
+### Miscellaneous
+
+* Use `File.open` with block ([#2119](https://github.com/ruby/rbs/pull/2119))
+* Compile without activesupport ([#2105](https://github.com/ruby/rbs/pull/2105))
+* docs: Add singleton attribute members to syntax.md ([#2090](https://github.com/ruby/rbs/pull/2090))
+* Bundle update rubocop-on-rbs ([#2094](https://github.com/ruby/rbs/pull/2094))
+* `bundle exec` on windows ([#2101](https://github.com/ruby/rbs/pull/2101))
+* Fix typos ([#2097](https://github.com/ruby/rbs/pull/2097))
+* Bundle update json 2.8.2 ([#2095](https://github.com/ruby/rbs/pull/2095))
+* Skip `rbs` gem validation ([#2084](https://github.com/ruby/rbs/pull/2084))
+* Skip PTY_test with Windows platform ([#2055](https://github.com/ruby/rbs/pull/2055))
+* Randomize stdlib test order to uncover hidden assumptions ([#2043](https://github.com/ruby/rbs/pull/2043))
+* Suppress `inline` is not at beginning of declaration for melt_array ([#2050](https://github.com/ruby/rbs/pull/2050))
+* Skip `mkpath` test with 3.4 ([#2053](https://github.com/ruby/rbs/pull/2053))
+
 ## 3.6.1 (2024-10-03)
 
 ### Library changes

data/Rakefile

@@ -30,10 +30,22 @@ task :confirm_lexer => :lexer do
   sh "git diff --exit-code ext/rbs_extension/lexer.c"
 end
 
+task :confirm_templates => :templates do
+  puts "Testing if generated code under include and src is updated with respect to templates"
+  sh "git diff --exit-code -- include src"
+end
+
 rule ".c" => ".re" do |t|
   puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake lexer` ⚠️⚠️⚠️"
 end
 
+rule %r{^src/(.*)\.c} => 'templates/%X.c.erb' do |t|
+  puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake templates` ⚠️⚠️⚠️"
+end
+rule %r{^include/(.*)\.c} => 'templates/%X.c.erb' do |t|
+  puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake templates` ⚠️⚠️⚠️"
+end
+
 task :annotate do
   sh "bin/generate_docs.sh"
 end
@@ -43,7 +55,18 @@ task :confirm_annotation do
   sh "git diff --exit-code core stdlib"
 end
 
+task :templates do
+  sh "#{ruby} templates/template.rb include/rbs/constants.h"
+  sh "#{ruby} templates/template.rb include/rbs/ruby_objs.h"
+  sh "#{ruby} templates/template.rb src/constants.c"
+  sh "#{ruby} templates/template.rb src/ruby_objs.c"
+end
+
 task :compile => "ext/rbs_extension/lexer.c"
+task :compile => "include/rbs/constants.h"
+task :compile => "include/rbs/ruby_objs.h"
+task :compile => "src/constants.c"
+task :compile => "src/ruby_objs.c"
 
 task :test_doc do
   files = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -63,7 +86,12 @@ task :validate => :compile do
   # Skip RBS validation because Ruby CI runs without rubygems
   case skip_rbs_validation = ENV["SKIP_RBS_VALIDATION"]
   when nil
-    libs << "rbs"
+    begin
+      Gem::Specification.find_by_name("rbs")
+      libs << "rbs"
+    rescue Gem::MissingSpecError
+      STDERR.puts "🚨🚨🚨🚨 Skipping `rbs` gem because it's not found"
+    end
   when "true"
     # Skip
   else
@@ -86,6 +114,11 @@ task :stdlib_test => :compile do
   test_files = FileList["test/stdlib/**/*_test.rb"].reject do |path|
     path =~ %r{Ractor} || path =~ %r{Encoding}
   end
+
+  if ENV["RANDOMIZE_STDLIB_TEST_ORDER"] == "true"
+    test_files.shuffle!
+  end
+
   sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test_files.join(' ')}"
   # TODO: Ractor tests need to be run in a separate process
   sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Ractor_test.rb"

data/config.yml

@@ -0,0 +1,311 @@
+nodes:
+  - name: RBS::AST::Annotation
+    fields:
+      - name: string
+      - name: location
+  - name: RBS::AST::Comment
+    fields:
+      - name: string
+      - name: location
+  - name: RBS::AST::Declarations::Class
+    fields:
+      - name: name
+      - name: type_params
+      - name: super_class
+      - name: members
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Class::Super
+    fields:
+      - name: name
+      - name: args
+      - name: location
+  - name: RBS::AST::Declarations::ClassAlias
+    fields:
+      - name: new_name
+      - name: old_name
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Constant
+    fields:
+      - name: name
+      - name: type
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Global
+    fields:
+      - name: name
+      - name: type
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Interface
+    fields:
+      - name: name
+      - name: type_params
+      - name: members
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Module
+    fields:
+      - name: name
+      - name: type_params
+      - name: self_types
+      - name: members
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::Module::Self
+    fields:
+      - name: name
+      - name: args
+      - name: location
+  - name: RBS::AST::Declarations::ModuleAlias
+    fields:
+      - name: new_name
+      - name: old_name
+      - name: location
+      - name: comment
+  - name: RBS::AST::Declarations::TypeAlias
+    fields:
+      - name: name
+      - name: type_params
+      - name: type
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Directives::Use
+    fields:
+      - name: clauses
+      - name: location
+  - name: RBS::AST::Directives::Use::SingleClause
+    fields:
+      - name: type_name
+      - name: new_name
+      - name: location
+  - name: RBS::AST::Directives::Use::WildcardClause
+    fields:
+      - name: namespace
+      - name: location
+  - name: RBS::AST::Members::Alias
+    fields:
+      - name: new_name
+      - name: old_name
+      - name: kind
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::AttrAccessor
+    fields:
+      - name: name
+      - name: type
+      - name: ivar_name
+      - name: kind
+      - name: annotations
+      - name: location
+      - name: comment
+      - name: visibility
+  - name: RBS::AST::Members::AttrReader
+    fields:
+      - name: name
+      - name: type
+      - name: ivar_name
+      - name: kind
+      - name: annotations
+      - name: location
+      - name: comment
+      - name: visibility
+  - name: RBS::AST::Members::AttrWriter
+    fields:
+      - name: name
+      - name: type
+      - name: ivar_name
+      - name: kind
+      - name: annotations
+      - name: location
+      - name: comment
+      - name: visibility
+  - name: RBS::AST::Members::ClassInstanceVariable
+    fields:
+      - name: name
+      - name: type
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::ClassVariable
+    fields:
+      - name: name
+      - name: type
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::Extend
+    fields:
+      - name: name
+      - name: args
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::Include
+    fields:
+      - name: name
+      - name: args
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::InstanceVariable
+    fields:
+      - name: name
+      - name: type
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::MethodDefinition
+    fields:
+      - name: name
+      - name: kind
+      - name: overloads
+      - name: annotations
+      - name: location
+      - name: comment
+      - name: overloading
+      - name: visibility
+  - name: RBS::AST::Members::MethodDefinition::Overload
+    fields:
+      - name: annotations
+      - name: method_type
+  - name: RBS::AST::Members::Prepend
+    fields:
+      - name: name
+      - name: args
+      - name: annotations
+      - name: location
+      - name: comment
+  - name: RBS::AST::Members::Private
+    fields:
+      - name: location
+  - name: RBS::AST::Members::Public
+    fields:
+      - name: location
+  - name: RBS::AST::TypeParam
+    fields:
+      - name: name
+      - name: variance
+      - name: upper_bound
+      - name: default_type
+      - name: location
+  - name: RBS::MethodType
+    fields:
+      - name: type_params
+      - name: type
+      - name: block
+      - name: location
+  - name: RBS::Namespace
+    fields:
+      - name: path
+      - name: absolute
+  - name: RBS::TypeName
+    fields:
+      - name: namespace
+      - name: name
+  - name: RBS::Types::Alias
+    fields:
+      - name: name
+      - name: args
+      - name: location
+  - name: RBS::Types::Bases::Any
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Bool
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Bottom
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Class
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Instance
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Nil
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Self
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Top
+    fields:
+      - name: location
+  - name: RBS::Types::Bases::Void
+    fields:
+      - name: location
+  - name: RBS::Types::Block
+    fields:
+      - name: type
+      - name: required
+      - name: self_type
+  - name: RBS::Types::ClassInstance
+    fields:
+      - name: name
+      - name: args
+      - name: location
+  - name: RBS::Types::ClassSingleton
+    fields:
+      - name: name
+      - name: location
+  - name: RBS::Types::Function
+    fields:
+      - name: required_positionals
+      - name: optional_positionals
+      - name: rest_positionals
+      - name: trailing_positionals
+      - name: required_keywords
+      - name: optional_keywords
+      - name: rest_keywords
+      - name: return_type
+  - name: RBS::Types::Function::Param
+    fields:
+      - name: type
+      - name: name
+      - name: location
+  - name: RBS::Types::Interface
+    fields:
+      - name: name
+      - name: args
+      - name: location
+  - name: RBS::Types::Intersection
+    fields:
+      - name: types
+      - name: location
+  - name: RBS::Types::Literal
+    fields:
+      - name: literal
+      - name: location
+  - name: RBS::Types::Optional
+    fields:
+      - name: type
+      - name: location
+  - name: RBS::Types::Proc
+    fields:
+      - name: type
+      - name: block
+      - name: location
+      - name: self_type
+  - name: RBS::Types::Record
+    fields:
+      - name: all_fields
+      - name: location
+  - name: RBS::Types::Tuple
+    fields:
+      - name: types
+      - name: location
+  - name: RBS::Types::Union
+    fields:
+      - name: types
+      - name: location
+  - name: RBS::Types::UntypedFunction
+    fields:
+      - name: return_type
+  - name: RBS::Types::Variable
+    fields:
+      - name: name
+      - name: location

data/core/dir.rbs

@@ -784,7 +784,7 @@ class Dir
   # caveats.
   #
   def chdir: () -> Integer
-           | [T] { () -> T } -> T
+           | [T] () { () -> T } -> T
 
   # <!--
   #   rdoc-file=dir.c

data/core/io.rbs

@@ -1638,7 +1638,7 @@ class IO < Object
   # Optional keyword argument `chomp` specifies whether line separators are to be
   # omitted.
   #
-  def readline: (?String sep, ?Integer limit) -> String
+  def readline: (?String sep, ?Integer limit, ?chomp: boolish) -> String
 
   # <!--
   #   rdoc-file=io.c
@@ -1701,7 +1701,7 @@ class IO < Object
   #     # => ["First line", "Second line", "", "Fourth line", "Fifth line"]
   #     f.close
   #
-  def readlines: (?String sep, ?Integer limit) -> ::Array[String]
+  def readlines: (?String sep, ?Integer limit, ?chomp: boolish) -> ::Array[String]
 
   # <!--
   #   rdoc-file=io.c

data/core/kernel.rbs

@@ -1209,7 +1209,7 @@ module Kernel : BasicObject
   # -->
   # Equivalent to Proc.new.
   #
-  def self?.proc: () { () -> untyped } -> Proc
+  def self?.proc: () { (?) -> untyped } -> Proc
 
   # <!--
   #   rdoc-file=proc.c
@@ -2056,8 +2056,8 @@ module Kernel : BasicObject
   #
   # Raises an exception if the new process could not execute.
   #
-  def self?.system: (String command, *String args, ?unsetenv_others: boolish, ?pgroup: true | Integer, ?umask: Integer, ?in: redirect_fd, ?out: redirect_fd, ?err: redirect_fd, ?close_others: boolish, ?chdir: String) -> (NilClass | FalseClass | TrueClass)
-                  | (Hash[string, string?] env, String command, *String args, ?unsetenv_others: boolish, ?pgroup: true | Integer, ?umask: Integer, ?in: redirect_fd, ?out: redirect_fd, ?err: redirect_fd, ?close_others: boolish, ?chdir: String) -> (NilClass | FalseClass | TrueClass)
+  def self?.system: (String command, *String args, ?unsetenv_others: boolish, ?pgroup: true | Integer, ?umask: Integer, ?in: redirect_fd, ?out: redirect_fd, ?err: redirect_fd, ?close_others: boolish, ?chdir: String, ?exception: bool) -> (NilClass | FalseClass | TrueClass)
+                  | (Hash[string, string?] env, String command, *String args, ?unsetenv_others: boolish, ?pgroup: true | Integer, ?umask: Integer, ?in: redirect_fd, ?out: redirect_fd, ?err: redirect_fd, ?close_others: boolish, ?chdir: String, ?exception: bool) -> (NilClass | FalseClass | TrueClass)
 
   # <!--
   #   rdoc-file=object.c

data/core/process.rbs

@@ -615,7 +615,7 @@ module Process
   #
   #     thread.join.pid                       # => 313262
   #
-  def self.detach: (Integer pid) -> Thread
+  def self.detach: (Integer pid) -> Process::Waiter
 
   # <!--
   #   rdoc-file=process.c

data/core/set.rbs

@@ -629,5 +629,5 @@ module Enumerable[unchecked out Elem]
   # Needs to `require "set"` to use this method.
   #
   def to_set: () -> Set[Elem]
-            | [T] { (Elem) -> T } -> Set[T]
+            | [T] () { (Elem) -> T } -> Set[T]
 end

data/docs/syntax.md

@@ -416,10 +416,12 @@ _method-types_ ::= _method-type-parameters_ _method-type_
 _method-type-parameters_ ::=                                                    # Empty
                            | `[` _type-variable_ `,` ... `]`
 
-_attribute-member_ ::= _visibility_ _attribute-type_ _method-name_ `:` _type_                     # Attribute
-                     | _visibility_ _attribute-type_ _method-name_ `(` _ivar-name_ `) :` _type_   # Attribute with variable name specification
-                     | _visibility_ _attribute-type_ _method-name_ `() :` _type_                  # Attribute without variable
-
+_attribute-member_ ::= _visibility_ _attribute-type_ _method-name_ `:` _type_                             # Attribute
+                     | _visibility_ _attribute-type_ _method-name_ `(` _ivar-name_ `) :` _type_           # Attribute with variable name specification
+                     | _visibility_ _attribute-type_ _method-name_ `() :` _type_                          # Attribute without variable
+                     | _visibility_ _attribute-type_ `self.` _method-name_ `:` _type_                     # Singleton attribute
+                     | _visibility_ _attribute-type_ `self.` _method-name_ `(` _ivar-name_ `) :` _type_   # Singleton attribute with variable name specification
+                     | _visibility_ _attribute-type_ `self.` _method-name_ `() :` _type_                  # Singleton attribute without variable
 _visibility_ ::= `public` | `private`
 
 _attribute-type_ ::= `attr_reader` | `attr_writer` | `attr_accessor`

data/ext/rbs_extension/extconf.rb

@@ -1,4 +1,14 @@
 require 'mkmf'
+
 $INCFLAGS << " -I$(top_srcdir)" if $extmk
+$INCFLAGS << " -I$(srcdir)/../../include"
+
+$VPATH << "$(srcdir)/../../src"
+$VPATH << "$(srcdir)/ext/rbs_extension"
+
+root_dir = File.expand_path('../../../', __FILE__)
+$srcs = Dir.glob("#{root_dir}/src/*.c") +
+        Dir.glob("#{root_dir}/ext/rbs_extension/*.c")
+
 append_cflags ['-std=gnu99']
 create_makefile 'rbs_extension'