rbs 3.9.4 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d2bd9e9a3614197bf48bb627818de33e6229d916c9e69da54d869604291264
-  data.tar.gz: bca64533203a4632c489eb799ebdfd2504761ea94a14459f0459a1e3f87fcb24
+  metadata.gz: a0ae1797f25f4639914ed5244dd903aa9bf0cb28d8f7ad46917ea78a5a390c8b
+  data.tar.gz: 78456ce40939bc2911cf4b70a8053449f34a457fadc35eda478d6e7bec7cc527
 SHA512:
-  metadata.gz: 8bed7eff9963856fc06bcb36f4f48f5fafebdf9e8caaa7df7d5f27a28a29b17e83d3145088e37fb86edd5ead6fb6aff3ecc9c857c517de5e753ef7dff4d58eb8
-  data.tar.gz: 325b48fd2ebcada1975741733498770c321fe319da5e4c70517b6f2b4adbbd865b73f4dd8557e05268b10de1ce316a8bed7a191f7811fce3f1e6162b16abbb51
+  metadata.gz: b27b18e6a70bf268ecb3db9de38954a733352d643504d1842f9c2dbc9aa4c3af7abf5b9816838a795082061ed3519384e764c31acbce208338cae636481b495a
+  data.tar.gz: fc7f3b804b4f93e18f71032ff34b19962100c5ca835628cf9d8e44467c96c683c699fb6fe8e0ec895a70c448bf1b21e9f840efd523e295378da9a6a5a42e340f

data/.clang-format

@@ -0,0 +1,75 @@
+---
+Language: Cpp
+
+# Indentation
+UseTab: Never
+IndentWidth: 4
+BreakBeforeBraces: Attach
+IndentCaseLabels: false
+NamespaceIndentation: None
+ContinuationIndentWidth: 4
+IndentPPDirectives: None
+IndentWrappedFunctionNames: false
+AccessModifierOffset: -2
+
+# Alignment
+AlignAfterOpenBracket: BlockIndent
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignConsecutiveMacros: false
+AlignEscapedNewlines: Left
+AlignOperands: false
+AlignTrailingComments: true
+DerivePointerAlignment: false
+PointerAlignment: Right
+
+# Function calls formatting
+BinPackArguments: false
+BinPackParameters: false
+AllowAllArgumentsOnNextLine: false
+ExperimentalAutoDetectBinPacking: false
+PenaltyBreakBeforeFirstCallParameter: 1
+AlwaysBreakAfterDefinitionReturnType: None
+
+# Wrapping and Breaking
+ColumnLimit: 0
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Always
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: No
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: false
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+Cpp11BracedListStyle: false
+ReflowComments: false
+SortIncludes: Never
+InsertNewlineAtEOF: true
+
+# Spaces
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInParentheses: false
+SpacesInSquareBrackets: false

data/.clangd

@@ -0,0 +1,2 @@
+CompileFlags:
+    CompilationDatabase: ext/rbs_extension

data/.dockerignore

@@ -0,0 +1,37 @@
+# Keep the build context small. .git is intentionally NOT ignored: rbs.gemspec
+# builds its file list with `git ls-files`.
+#
+# Safe to ignore here: untracked/generated paths, and tracked paths the gemspec
+# already rejects (so `gem build` does not expect them on disk). Do NOT ignore a
+# tracked path the gemspec ships — `gem build` would fail with "... are not
+# files". .vscode/ and benchmark/ are tracked but rejected by the gemspec.
+.vscode/
+benchmark/
+
+# Editor / tooling / worktree copies (untracked; each is a full repo clone)
+.claude/
+trees/
+.devcontainer/
+.idea/
+.ruby-lsp/
+.yardoc/
+doc/
+datasets/
+tmp/
+
+# Build artifact — rebuilt inside the image by `rake wasm:jruby_setup`
+lib/rbs/wasm/*.wasm
+*.gem
+ext/**/*.o
+ext/**/*.so
+ext/**/*.bundle
+*.log
+
+# Local scratch / experiment files
+flamegraph.html
+gc.html
+foo.rbs
+sorted.json
+string.json
+Gemfile-*
+gemfiles/

data/.github/dependabot.yml

@@ -1,22 +1,24 @@
 version: 2
 updates:
-  - package-ecosystem: bundler
-    directory: "/"
-    schedule:
-      interval: daily
-    open-pull-requests-limit: 3
-    allow:
-      - dependency-type: all
+  # - package-ecosystem: bundler
+  #   directory: "/"
+  #   schedule:
+  #     interval: daily
+  #   open-pull-requests-limit: 3
+  #   allow:
+  #     - dependency-type: all
 
-  - package-ecosystem: bundler
-    directory: "/steep"
-    schedule:
-      interval: daily
-    open-pull-requests-limit: 3
-    allow:
-      - dependency-type: all
+  # - package-ecosystem: bundler
+  #   directory: "/steep"
+  #   schedule:
+  #     interval: daily
+  #   open-pull-requests-limit: 3
+  #   allow:
+  #     - dependency-type: all
 
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
       interval: 'weekly'
+    labels:
+      - 'skip-changelog'

data/.github/workflows/bundle-update.yml

@@ -0,0 +1,63 @@
+name: Scheduled Bundle Update PR
+
+on:
+  schedule:
+    - cron: '0 0 * * 2'
+  workflow_dispatch:
+
+jobs:
+  bundle-update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+
+      - name: Set up git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Switch branch
+        run: |
+          git switch -c bundle-update-$(date +'%Y%m%d')-$(uuidgen | cut -c1-8)
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Run bundle update
+        run: |
+          bundle lock --update
+          bundle lock --update --gemfile=steep/Gemfile
+          git add Gemfile.lock steep/Gemfile.lock
+
+          if git diff --cached --exit-code; then
+            echo "No changes to commit, exiting."
+            exit 0
+          fi
+
+          git commit -m "bundle update"
+          echo "has_update=true" >> $GITHUB_ENV
+
+      - name: Push branch
+        if: env.has_update == 'true'
+        run: git push origin HEAD
+
+      - name: Create Pull Request
+        if: env.has_update == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.DEPENDABOT_MERGE_GH_TOKEN }}
+        run: |
+          gh pr create \
+            --title "bundle update ($(date +'%Y-%m-%d'))" \
+            --body "Automated weekly bundle update" \
+            --head "$(git rev-parse --abbrev-ref HEAD)" \
+            --base "${{ github.event.repository.default_branch }}" \
+            --label "skip-changelog"
+
+          gh pr merge --auto --merge "$(git rev-parse --abbrev-ref HEAD)"

data/.github/workflows/c-check.yml

@@ -0,0 +1,66 @@
+name: C Code Generation and Formatting Check
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+  merge_group: {}
+
+permissions:
+  contents: read
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+          bundler-cache: none
+      - name: Set working directory as safe
+        run: git config --global --add safe.directory $(pwd)
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libdb-dev curl autoconf automake m4 libtool
+      - name: Install clang-format from LLVM
+        run: |
+          # The codename must match the `runs-on` image: `ubuntu-latest` is 24.04 (noble).
+          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key \
+            | sudo gpg --dearmor -o /usr/share/keyrings/llvm-archive-keyring.gpg
+          # Written directly rather than through `apt-add-repository`, which cannot
+          # parse `[signed-by=...]` inside a one-line `deb` shortcut.
+          echo "deb [signed-by=/usr/share/keyrings/llvm-archive-keyring.gpg] http://apt.llvm.org/noble/ llvm-toolchain-noble-20 main" \
+            | sudo tee /etc/apt/sources.list.d/llvm.list
+          sudo apt-get update
+          sudo apt-get install -y clang-format-20
+          sudo ln -sf /usr/bin/clang-format-20 /usr/local/bin/clang-format
+          clang-format --version
+      - name: Count processors
+        run: nproc
+      - name: Install Re2c
+        run: |
+          cd /tmp
+          curl -L https://github.com/skvadrik/re2c/archive/refs/tags/4.5.1.tar.gz > re2c-4.5.1.tar.gz
+          tar xf re2c-4.5.1.tar.gz
+          cd re2c-4.5.1
+          cmake --preset=linux-gcc-release-ootree-skeleton-fast
+          cmake --build --preset=linux-gcc-release-ootree-skeleton-fast --parallel="$(nproc)"
+          sudo ln -sf "$(pwd)"/.build/linux-gcc-release-ootree-skeleton-fast/re2c /usr/local/bin/re2c
+          re2c --version
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - name: install erb
+        run: gem install erb
+      - name: bin/setup
+        run: |
+          bin/setup
+      - name: Check C code generation and formatting
+        run: |
+          clang-format --version
+          bundle exec rake lexer templates compile confirm_lexer confirm_templates
+          bundle exec rake format:c_check

data/.github/workflows/comments.yml

@@ -11,12 +11,12 @@ jobs:
   comments:
     runs-on: "ubuntu-latest"
     # env:
-    #   RUBY_COMMIT: 1b0c46daed9186b82ab4fef1a4ab225afe582ee6
+    #   RUBY_COMMIT: v4.0.0-preview2
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.4.1"
+          ruby-version: "4.0.6"
           bundler: none
       - name: Install dependencies
         run: |
@@ -26,6 +26,8 @@ jobs:
         run: |
           ruby -v
           gem update --system
+      - name: install erb
+        run: gem install erb
       - name: bin/setup
         run: |
           bin/setup

data/.github/workflows/dependabot.yml

@@ -14,10 +14,10 @@ jobs:
     if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
     steps:
       - name: Dependabot metadata
-        uses: dependabot/fetch-metadata@d7267f607e9d3fb96fc2fbe83e0af444713e90b7 # v2.3.0
+        uses: dependabot/fetch-metadata@25dd0e34f4fe68f24cc83900b1fe3fe149efef98 # v3.1.0
         id: metadata
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Abort if blocker files are changed

data/.github/workflows/jruby.yml

@@ -0,0 +1,79 @@
+name: JRuby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - ".github/workflows/jruby.yml"
+      - "include/**"
+      - "src/**"
+      - "wasm/**"
+      - "lib/**"
+      - "sig/**"
+      - "core/**"
+      - "stdlib/**"
+      - "test/**"
+      - "Rakefile"
+      - "rbs.gemspec"
+  # `merge_group` has no `paths` filter, so this runs on every queue entry.
+  merge_group: {}
+
+permissions:
+  contents: read
+
+env:
+  # Keep in sync with .github/workflows/wasm.yml.
+  WASI_SDK_VERSION: "33"
+  WASI_SDK_RELEASE: "33.0"
+
+jobs:
+  test:
+    name: jruby
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
+      # Build the .wasm and fetch the Chicory jars with CRuby + the WASI SDK,
+      # then run RBS itself on JRuby against those artifacts.
+      - name: Set up Ruby (to assemble the WebAssembly runtime)
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler: none
+      - name: Update rubygems & bundler
+        run: gem update --system
+      - name: Install gems
+        run: |
+          bundle config set --local without libs:profilers
+          bundle install --jobs 4 --retry 3
+      - name: Install the WASI SDK
+        run: |
+          url="https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_SDK_VERSION}/wasi-sdk-${WASI_SDK_RELEASE}-x86_64-linux.tar.gz"
+          mkdir -p "$HOME/wasi-sdk"
+          curl -sSL "$url" | tar xz --strip-components=1 -C "$HOME/wasi-sdk"
+          echo "WASI_SDK_PATH=$HOME/wasi-sdk" >> "$GITHUB_ENV"
+      - name: Build rbs_parser.wasm
+        run: bundle exec rake wasm:jruby_setup
+
+      - name: Set up JRuby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: jruby
+          bundler: none
+      - name: Install runtime and test gems
+        # rdoc 8.0.0 added a runtime dependency on rbs, which pulls the released
+        # C-extension rbs gem and fails to build on JRuby. Pin rdoc below 8 until
+        # a -java rbs gem is published.
+        run: |
+          gem install prism rake rake-compiler test-unit rspec minitest json-schema pry --no-document
+          gem install rdoc -v "< 8" --no-document
+      # jar-dependencies resolves through the JVM, so download the Chicory/ASM
+      # jars into ~/.m2 here on JRuby (jar-dependencies is not available in the
+      # CRuby step above).
+      - name: Download the Chicory and ASM jars
+        run: jruby -S rake wasm:install_jars
+      - name: Run the test suite on JRuby
+        run: jruby -S rake test

data/.github/workflows/release-gems.yml

@@ -0,0 +1,164 @@
+name: Release gems
+
+# Builds, publishes, and announces a release. Dispatch it against the `vX.Y.Z` tag
+# of the release: the tag is created first so that everything published afterwards
+# traces back to an immutable ref, and so the reversible step comes before the
+# irreversible one.
+#
+# Dispatching against a branch builds and verifies the gems and stops there, which
+# is how the build is exercised without releasing anything.
+#
+# | Gem                  | Platform      | Parser                           |
+# | -------------------- | ------------- | -------------------------------- |
+# | `rbs-X.Y.Z.gem`      | `ruby` (MRI)  | C extension, compiled on install |
+# | `rbs-X.Y.Z-java.gem` | `java` (JRuby)| `rbs_parser.wasm`, prebuilt here |
+#
+# See docs/release.md. The `java` gem is built on CRuby: the platform comes from
+# `RBS_PLATFORM`, not from the engine running `gem build`. JRuby is only needed to
+# run the result, which the workflow does before it would publish anything.
+#
+# One job on purpose. Tagging, pushing the gems, and opening the GitHub release
+# all belong to a single release, and keeping them in one place keeps their order
+# readable -- the tag is created before anything is published, so the reversible
+# step comes before the irreversible one.
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  # Keep in sync with .github/workflows/wasm.yml and .github/workflows/jruby.yml.
+  WASI_SDK_VERSION: "33"
+  WASI_SDK_RELEASE: "33.0"
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # publish the GitHub release
+      id-token: write # trusted publishing to RubyGems
+    steps:
+      # The gemspec takes its file list from `git ls-files`, so both gems are built
+      # from the committed state.
+      - uses: actions/checkout@v7
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler: none
+      - name: Update rubygems & bundler
+        run: gem update --system
+      - name: Install gems
+        run: |
+          bundle config set --local without libs:profilers
+          bundle install --jobs 4 --retry 3
+
+      - name: Read the version
+        id: version
+        run: echo "version=$(ruby -e 'load "lib/rbs/version.rb"; print RBS::VERSION')" >> "$GITHUB_OUTPUT"
+
+      # Fail before spending a minute on the build, and before anything is pushed:
+      # the tag is what the release is named after, so it has to be the version the
+      # tagged commit actually declares.
+      - name: Check the tag against RBS::VERSION
+        if: github.ref_type == 'tag'
+        run: |
+          if [ "${{ github.ref_name }}" != "v${{ steps.version.outputs.version }}" ]; then
+            echo "::error::tag ${{ github.ref_name }} does not match RBS::VERSION ${{ steps.version.outputs.version }}"
+            exit 1
+          fi
+
+      - name: Build the ruby gem
+        run: |
+          mkdir -p pkg
+          gem build rbs.gemspec -o "pkg/rbs-${{ steps.version.outputs.version }}.gem"
+
+      # `rake wasm:jruby_setup` compiles src/**/*.c to WebAssembly and copies the
+      # result to lib/rbs/wasm/, where the gemspec picks it up. clang runs as a
+      # subprocess, so this works on CRuby.
+      - name: Install the WASI SDK
+        run: |
+          url="https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_SDK_VERSION}/wasi-sdk-${WASI_SDK_RELEASE}-x86_64-linux.tar.gz"
+          mkdir -p "$HOME/wasi-sdk"
+          curl -sSL "$url" | tar xz --strip-components=1 -C "$HOME/wasi-sdk"
+          echo "WASI_SDK_PATH=$HOME/wasi-sdk" >> "$GITHUB_ENV"
+      - name: Build rbs_parser.wasm
+        run: bundle exec rake wasm:jruby_setup
+
+      - name: Build the java gem
+        env:
+          RBS_PLATFORM: java
+        run: gem build rbs.gemspec -o "pkg/rbs-${{ steps.version.outputs.version }}-java.gem"
+
+      # `git ls-files` vouches for everything else, but rbs_parser.wasm is a build
+      # artifact, so the java gem is the one that can come out quietly wrong.
+      - name: Check the built gems
+        run: |
+          ruby -rrubygems/package -e '
+            ruby_gem, java_gem = ARGV.map { Gem::Package.new(_1).spec }
+
+            raise "unexpected platform: #{ruby_gem.platform}" unless ruby_gem.platform.to_s == "ruby"
+            raise "the C extension is not declared" if ruby_gem.extensions.empty?
+
+            raise "unexpected platform: #{java_gem.platform}" unless java_gem.platform.to_s == "java"
+            raise "rbs_parser.wasm is missing" unless java_gem.files.include?("lib/rbs/wasm/rbs_parser.wasm")
+            raise "the java gem must not declare an extension" unless java_gem.extensions.empty?
+
+            [ruby_gem, java_gem].each { puts "#{_1.full_name}: #{_1.files.size} files" }
+          ' "pkg/rbs-${{ steps.version.outputs.version }}.gem" \
+            "pkg/rbs-${{ steps.version.outputs.version }}-java.gem"
+
+      # The checks above cannot tell whether rbs_parser.wasm actually runs. Install
+      # the gem the way a user would -- jar-dependencies fetches Chicory and ASM
+      # from Maven during the install -- and parse something with it, so the
+      # WebAssembly runtime is exercised end to end before anything is published.
+      - name: Set up JRuby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: jruby
+          bundler: none
+      - name: Check the java gem on JRuby
+        run: |
+          gem install "pkg/rbs-${{ steps.version.outputs.version }}-java.gem"
+          ruby -e '
+            require "rbs"
+            _, _, decls = RBS::Parser.parse_signature("class Foo end")
+            names = decls.map { _1.name.to_s }
+            raise "parsed #{names.inspect}, expected [\"Foo\"]" unless names == ["Foo"]
+            puts "#{RUBY_ENGINE} #{RUBY_VERSION}: rbs #{RBS::VERSION} parses through the WebAssembly runtime"
+          '
+
+      - name: Switch back to CRuby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler: none
+
+      # Uploaded before publishing, so a failed push still leaves the gems behind.
+      - uses: actions/upload-artifact@v7
+        with:
+          name: gems
+          path: pkg/*.gem
+          if-no-files-found: error
+
+      # Everything below runs only for a release tag.
+      - name: Configure RubyGems credentials
+        if: github.ref_type == 'tag'
+        # No floating major tag on this action, so the exact release is pinned.
+        uses: rubygems/configure-rubygems-credentials@v2.1.0
+
+      - name: Push the gems
+        if: github.ref_type == 'tag'
+        run: |
+          gem push "pkg/rbs-${{ steps.version.outputs.version }}.gem"
+          gem push "pkg/rbs-${{ steps.version.outputs.version }}-java.gem"
+
+      # Last, so that a failed push never announces a release that has no gems.
+      - name: Publish the GitHub release
+        if: github.ref_type == 'tag'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: bundle exec rake gem:gh_release