rbs 2.8.4 → 3.8.1

data/README.md

@@ -7,7 +7,7 @@ It also allows declaring constants and global variables.
 The following is a small example of RBS for a chat app.
 
 <!-- run-start:a.rbs:bundle exec rbs -I a.rbs validate -->
-```rb
+```rbs
 module ChatApp
   VERSION: String
 
@@ -54,8 +54,8 @@ 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.)
+* The standard library signatures targets the latest release of Ruby. (`3.2` as of 2023.)
+* The library code targets non-EOL versions of Ruby. (`>= 3.0` as of 2023.)
 
 ## Installation
 
@@ -69,7 +69,7 @@ gem "rbs"
 
 The gem ships with the `rbs` command line tool to demonstrate what it can do and help develop RBS.
 
-```bash
+```console
 $ rbs version
 $ rbs list
 $ rbs ancestors ::Object
@@ -77,6 +77,53 @@ $ rbs methods ::Object
 $ rbs method Object then
 ```
 
+An end user of `rbs` will probably find `rbs prototype` the most useful. This command generates boilerplate signature declarations for ruby files. For example, say you have written the below ruby script.
+
+```ruby
+# person.rb
+class Person
+  attr_reader :name
+  attr_reader :contacts
+
+  def initialize(name:)
+    @name = name
+    @contacts = []
+  end
+
+  def speak
+    "I'm #{@name} and I love Ruby!"
+  end
+end
+```
+
+Running prototype on the above will automatically generate
+
+```console
+$ rbs prototype rb person.rb
+class Person
+  @name: untyped
+
+  @contacts: untyped
+
+  attr_reader name: untyped
+
+  attr_reader contacts: untyped
+
+  def initialize: (name: untyped) -> void
+
+  def speak: () -> ::String
+end
+```
+
+It prints signatures for all methods, classes, instance variables, and constants.
+This is only a starting point, and you should edit the output to match your signature more accurately.
+
+`rbs prototype` offers three options.
+
+- `rb` generates from just the available Ruby code
+- `rbi` generates from Sorbet RBI
+- `runtime` generates from runtime API
+
 ## Library
 
 There are two important concepts, _environment_ and _definition_.
@@ -127,10 +174,23 @@ puts singleton.methods[:gsub]
 
 ## Guides
 
+- [Architecture](docs/architecture.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)
+- [RBS by Example](docs/rbs_by_example.md)
+- [RBS collection](docs/collection.md)
+- [Using `Data` and `Struct`](docs/data_and_struct.md)
+- [Releasing a gem with RBS](docs/gem.md)
+
+## Community
+
+Here is a list of some places you can talk with active maintainers.
+
+- [Ruby Discord Server (invite link)](https://discord.gg/ad2acQFtkh) -- We have `rbs` channel in Ruby Discord server.
+- [ruby-jp Slack Workspace (in Japanese)](https://ruby-jp.github.io/) -- We have `types` channel in ruby-jp slack workspace.
+- [gem_rbs_collection](https://github.com/ruby/gem_rbs_collection) -- We have a repository of third-party RBS type definitions, for the case your dependency doesn't ship with RBS files.
 
 ## Development
 

data/Rakefile

@@ -19,7 +19,7 @@ Rake::TestTask.new(:test => :compile) do |t|
   end
 end
 
-multitask :default => [:test, :stdlib_test, :rubocop, :validate, :test_doc]
+multitask :default => [:test, :stdlib_test, :typecheck_test, :rubocop, :validate, :test_doc]
 
 task :lexer do
   sh "re2c -W --no-generation-date -o ext/rbs_extension/lexer.c ext/rbs_extension/lexer.re"
@@ -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
@@ -56,12 +79,28 @@ end
 task :validate => :compile do
   require 'yaml'
 
-  sh "#{ruby} #{rbs} validate --silent"
+  sh "#{ruby} #{rbs} validate --exit-error-on-syntax-error"
 
-  FileList["stdlib/*"].each do |path|
-    lib = [File.basename(path).to_s]
+  libs = FileList["stdlib/*"].map {|path| File.basename(path).to_s }
 
-    sh "#{ruby} #{rbs} #{lib.map {|l| "-r #{l}"}.join(" ")} validate --silent"
+  # Skip RBS validation because Ruby CI runs without rubygems
+  case skip_rbs_validation = ENV["SKIP_RBS_VALIDATION"]
+  when nil
+    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
+    STDERR.puts "🚨🚨🚨🚨 SKIP_RBS_VALIDATION is expected to be `true` or unset, given `#{skip_rbs_validation}` 🚨🚨🚨🚨"
+    libs << "rbs"
+  end
+
+  libs.each do |lib|
+    sh "#{ruby} #{rbs} -r #{lib} validate --exit-error-on-syntax-error"
   end
 end
 
@@ -71,17 +110,46 @@ FileList["test/stdlib/**/*_test.rb"].each do |test|
   end
 end
 
-task :stdlib_test do
+task :stdlib_test => :compile do
   test_files = FileList["test/stdlib/**/*_test.rb"].reject do |path|
-    path =~ %r{Ractor}
+    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"
+  sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Encoding_test.rb"
+end
+
+task :typecheck_test => :compile do
+  FileList["test/typecheck/*"].each do |test|
+    Dir.chdir(test) do
+      expectations = File.join(test, "steep_expectations.yml")
+      if File.exist?(expectations)
+        sh "steep check --with_expectations"
+      else
+        sh "steep check"
+      end
+    end
+  end
+end
+
+task :raap => :compile do
+  sh %q[ruby test/raap.rb | xargs bundle exec raap -r digest/bubblebabble --library digest --allow-private]
 end
 
 task :rubocop do
-  sh "rubocop --parallel"
+  format = if ENV["CI"]
+    "github"
+  else
+    "progress"
+  end
+
+  sh "rubocop --parallel --format #{format}"
 end
 
 namespace :generate do
@@ -141,36 +209,38 @@ namespace :generate do
 
           <%- unless class_methods.empty? -%>
           class <%= target %>SingletonTest < Test::Unit::TestCase
-            include TypeAssertions
+            include TestHelper
 
-            # library "pathname", "set", "securerandom"     # Declare library signatures to load
+            # library "pathname", "securerandom"     # Declare library signatures to load
             testing "singleton(::<%= target %>)"
 
-          <%- class_methods.each do |method_name, definition| %>
+          <%- 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 %>",
-                                <%= target %>, :<%= method_name %>
+              assert_send_type "<%= method_type %>",
+                               <%= target %>, :<%= method_name %>
           <%- end -%>
             end
+
           <%- end -%>
           end
           <%- end -%>
 
           <%- unless instance_methods.empty? -%>
           class <%= target %>Test < Test::Unit::TestCase
-            include TypeAssertions
+            include TestHelper
 
-            # library "pathname", "set", "securerandom"     # Declare library signatures to load
+            # library "pathname", "securerandom"     # Declare library signatures to load
             testing "::<%= target %>"
 
-          <%- instance_methods.each do |method_name, definition| %>
+          <%- 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 %>",
-                                <%= target %>.new, :<%= method_name %>
+              assert_send_type "<%= method_type %>",
+                               <%= target %>.new, :<%= method_name %>
           <%- end -%>
             end
+
           <%- end -%>
           end
           <%- end -%>
@@ -233,3 +303,113 @@ task :test_generate_stdlib do
   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
+
+Rake::Task[:release].enhance do
+  Rake::Task[:"release:note"].invoke
+end
+
+namespace :release do
+  desc "Explain the post-release steps automatically"
+  task :note do
+    version = Gem::Version.new(RBS::VERSION)
+    major, minor, patch, *_ = RBS::VERSION.split(".")
+    major = major.to_i
+    minor = minor.to_i
+    patch = patch.to_i
+
+    puts "🎉🎉🎉🎉 Congratulations for **#{version}** release! 🎉🎉🎉🎉"
+    puts
+    puts "There are a few things left to complete the release. 💪"
+    puts
+
+    if patch == 0 || version.prerelease?
+      puts "* [ ] Update release note: https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor}"
+    end
+
+    if patch == 0 && !version.prerelease?
+      puts "* [ ] Delete `RBS XYZ is the latest version of...` from release note: https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor}"
+    end
+
+    puts "* [ ] Publish a release at GitHub"
+    puts "* [ ] Make some announcements on Twitter/Mustdon/Slack/???"
+
+    puts
+    puts
+
+    puts "✏️ Making a draft release on GitHub..."
+
+    content = File.read(File.join(__dir__, "CHANGELOG.md"))
+    changelog = content.scan(/^## \d.*?(?=^## \d)/m)[0]
+    changelog = changelog.sub(/^.*\n^.*\n/, "").rstrip
+
+    notes = <<NOTES
+[Release note](https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor})
+
+#{changelog}
+NOTES
+
+    command = [
+      "gh",
+      "release",
+      "create",
+      "--draft",
+      "v#{RBS::VERSION}",
+      "--title=#{RBS::VERSION}",
+      "--notes=#{notes}"
+    ]
+
+    if version.prerelease?
+      command << "--prerelease"
+    end
+
+    require "open3"
+    output, status = Open3.capture2(*command)
+    if status.success?
+      puts "  >> Done! Open #{output.chomp} and publish the release!"
+    end
+  end
+end
+
+
+desc "Generate changelog template from GH pull requests"
+task :changelog do
+  major, minor, patch, _pre = RBS::VERSION.split(".", 4)
+  major = major.to_i
+  minor = minor.to_i
+  patch = patch.to_i
+
+  if patch == 0
+    milestone = "RBS #{major}.#{minor}"
+  else
+    milestone = "RBS #{major}.#{minor}.x"
+  end
+
+  puts "🔍 Finding pull requests that is associated to milestone `#{milestone}`..."
+
+  command = [
+    "gh",
+    "pr",
+    "list",
+    "--limit=10000",
+    "--json",
+    "url,title,number",
+    "--search" ,
+    "milestone:\"#{milestone}\" is:merged sort:updated-desc -label:Released"
+  ]
+
+  require "open3"
+  output, status = Open3.capture2(*command)
+  raise status.inspect unless status.success?
+
+  require "json"
+  json = JSON.parse(output, symbolize_names: true)
+
+  unless json.empty?
+    puts
+    json.each do |line|
+      puts "* #{line[:title]} ([##{line[:number]}](#{line[:url]}))"
+    end
+  else
+    puts "  (🤑 There is no *unreleased* pull request associated to the milestone.)"
+  end
+end

data/Steepfile

@@ -4,22 +4,22 @@ target :lib do
   signature "sig"
   check "lib"
   ignore(
-    "lib/rbs/prototype/runtime.rb",
     "lib/rbs/test",
-    "lib/rbs/test.rb"
+    # "lib/rbs/test.rb"
   )
 
-  library "set", "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest'
-  signature 'stdlib/yaml/0'
+  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'prettyprint', 'yaml', "psych", "securerandom"
   signature "stdlib/strscan/0/"
   signature "stdlib/optparse/0/"
   signature "stdlib/rdoc/0/"
+  signature "stdlib/ripper/0"
+  signature "stdlib/pp/0"
 
-  configure_code_diagnostics do |config|
-    config[D::Ruby::MethodDefinitionMissing] = :hint
-    config[D::Ruby::ElseOnExhaustiveCase] = :hint
-    config[D::Ruby::FallbackAny] = :hint
-  end
+  # configure_code_diagnostics do |config|
+  #   config[D::Ruby::MethodDefinitionMissing] = :hint
+  #   config[D::Ruby::ElseOnExhaustiveCase] = :hint
+  #   config[D::Ruby::FallbackAny] = :hint
+  # end
 end
 
 # target :lib do
@@ -30,7 +30,7 @@ end
 #   check "app/models/**/*.rb"        # Glob
 #   # ignore "lib/templates/*.rb"
 #
-#   # library "pathname", "set"       # Standard libraries
+#   # library "pathname", "uri"       # Standard libraries
 #   # library "strong_json"           # Gems
 # end
 
@@ -39,6 +39,6 @@ end
 #
 #   check "spec"
 #
-#   # library "pathname", "set"       # Standard libraries
+#   # library "pathname", "uri"       # Standard libraries
 #   # library "rspec"
 # end