rbs 4.0.0.dev.2 → 4.0.0.dev.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f04dce135a1eb82da13c36f9a8ac01710c75cc2d2943643508b94187f281529
-  data.tar.gz: e4ddb5b4dd310100eb75e07b0a88a1cd92a2787f262db440b33834fbdd595b95
+  metadata.gz: 8e5b2060cc5ad02487c340bb1929f2bb37208e0222d949cc19d7f9dc4ed5898f
+  data.tar.gz: 4e3e4af4a4e4b107794984e04fd73b34812364f8526b05c2f38fcf30ec05213c
 SHA512:
-  metadata.gz: 55dc93bbac5c8472d7241e999bfa879ee6fe2c4e8e518eebae130596fc650a9e512a6140fc52d62be3b11751a3fb6414c7cdd8aeed85423e65077862223435f9
-  data.tar.gz: c160219cfb46afc018c8f5a1e21d10d21ba517f5f13b74d3871add96713fefe3597865d0907fc59f229098f7e13d3de729026136ee1eb15e0055ce90abfc8b9c
+  metadata.gz: eb626cd71636d7f5a7cdd74e3382aa1d19f1f2c13a7c6ff794ed4f2388acc36a87ae54ecc3d722c33ecb7eeade494d2394c8151e1af88c06973a659f4ce509cf
+  data.tar.gz: 2dc1084d7a986fab97e206e4fda8231bad922faa3bf3b9caa201ed67c2ac7a83e0215db3a1ad97f9c41ed7d34f6e62db44204586ccb8dbfd70e067082c65642f

data/.clang-format

@@ -0,0 +1,74 @@
+---
+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
+
+# 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/.github/workflows/c-check.yml

@@ -0,0 +1,51 @@
+name: C Code Generation and Formatting Check
+
+on:
+  push:
+  pull_request: {}
+  merge_group: {}
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          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: |
+          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+          sudo apt-add-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy main"
+          sudo apt-get update
+          sudo apt-get install -y clang-format
+          clang-format --version
+      - name: Install Re2c
+        run: |
+          cd /tmp
+          curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.1.tar.gz > re2c-3.1.tar.gz
+          tar xf re2c-3.1.tar.gz
+          cd re2c-3.1
+          autoreconf -i -W all
+          ./configure
+          make
+          sudo make install
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - 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/dependabot.yml

@@ -14,7 +14,7 @@ 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@08eff52bf64351f401fb50d4972fa95b9f2c2d1b # v2.4.0
         id: metadata
       - name: Checkout repository
         uses: actions/checkout@v4

data/.github/workflows/ruby.yml

@@ -28,8 +28,6 @@ jobs:
           - ruby: "3.4"
             job: stdlib_test
             rubyopt: "--enable-frozen-string-literal"
-          - ruby: "3.4"
-            job: lexer templates compile confirm_lexer confirm_templates
           - ruby: "3.4"
             job: rubocop validate test_doc build test_generate_stdlib raap
           - ruby: "3.4"
@@ -44,23 +42,10 @@ jobs:
           bundler: none
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)
-      - name: Set up permission
-        run: chmod -R o-w /opt/hostedtoolcache/Ruby
       - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y libdb-dev curl autoconf automake m4 libtool python3
-      - name: Install Re2c
-        if: ${{ contains(matrix.job, 'lexer') }}
-        run: |
-          cd /tmp
-          curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.1.tar.gz > re2c-3.1.tar.gz
-          tar xf re2c-3.1.tar.gz
-          cd re2c-3.1
-          autoreconf -i -W all
-          ./configure
-          make
-          sudo make install
       - name: Update rubygems & bundler
         run: |
           ruby -v
@@ -90,8 +75,6 @@ jobs:
           bundler-cache: none
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)
-      - name: Set up permission
-        run: chmod -R o-w /opt/hostedtoolcache/Ruby
       - name: Install dependencies
         run: |
           sudo apt-get update

data/.github/workflows/typecheck.yml

@@ -20,8 +20,6 @@ jobs:
           bundler: none
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)
-      - name: Set up permission
-        run: chmod -R o-w /opt/hostedtoolcache/Ruby
       - name: Install dependencies
         run: |
           sudo apt-get update

data/.gitignore

@@ -21,3 +21,7 @@ lib/**/*.dll
 doc/
 
 **/*.gem
+
+# For clangd's editor integration
+ext/rbs_extension/compile_commands.json
+ext/rbs_extension/.cache

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rubycw
   - rubocop-on-rbs
 

data/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "llvm-vs-code-extensions.vscode-clangd"
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "clangd.onConfigChanged": "restart",
+  "[c]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd"
+  },
+  "[cpp]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd"
+  },
+  "[h]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd"
+  },
+  "[hpp]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd"
+  }
+}

data/README.md

@@ -198,6 +198,43 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### C Code Formatting
+
+This project uses `clang-format` to enforce consistent formatting of C code with a `.clang-format` configuration in the root directory.
+
+#### Setup
+
+First, install clang-format:
+
+```bash
+# macOS
+brew install clang-format
+
+# Ubuntu/Debian
+sudo apt-get install clang-format
+
+# Windows
+choco install llvm
+```
+
+#### Usage
+
+Format all C source files:
+
+```bash
+rake format:c
+```
+
+Check formatting without making changes:
+
+```bash
+rake format:c_check
+```
+
+#### Editor Integration
+
+For VS Code users, install the "clangd" extension which will automatically use the project's `.clang-format` file.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/rbs.

data/Rakefile

@@ -37,6 +37,7 @@ multitask :default => [:test, :stdlib_test, :typecheck_test, :rubocop, :validate
 
 task :lexer do
   sh "re2c -W --no-generation-date -o src/lexer.c src/lexer.re"
+  sh "clang-format -i -style=file src/lexer.c"
 end
 
 task :confirm_lexer => :lexer do
@@ -49,6 +50,84 @@ task :confirm_templates => :templates do
   sh "git diff --exit-code -- include src"
 end
 
+# Task to format C code using clang-format
+namespace :format do
+  dirs = ["src", "ext", "include"]
+
+  # Find all C source and header files
+  files = `find #{dirs.join(" ")} -type f \\( -name "*.c" -o -name "*.h" \\)`.split("\n")
+
+  desc "Format C source files using clang-format"
+  task :c do
+    puts "Formatting C files..."
+
+    # Check if clang-format is installed
+    unless system("which clang-format > /dev/null 2>&1")
+      abort "Error: clang-format not found. Please install clang-format first."
+    end
+
+    if files.empty?
+      puts "No C files found to format"
+      next
+    end
+
+    puts "Found #{files.length} files to format (excluding generated files)"
+
+    exit_status = 0
+    files.each do |file|
+      puts "Formatting #{file}"
+      unless system("clang-format -i -style=file #{file}")
+        puts "❌ Error formatting #{file}"
+        exit_status = 1
+      end
+    end
+
+    exit exit_status unless exit_status == 0
+    puts "✅ All files formatted successfully"
+  end
+
+  desc "Check if C source files are properly formatted"
+  task :c_check do
+    puts "Checking C file formatting..."
+
+    # Check if clang-format is installed
+    unless system("which clang-format > /dev/null 2>&1")
+      abort "Error: clang-format not found. Please install clang-format first."
+    end
+
+    if files.empty?
+      puts "No C files found to check"
+      next
+    end
+
+    puts "Found #{files.length} files to check (excluding generated files)"
+
+    needs_format = false
+    files.each do |file|
+      formatted = `clang-format -style=file #{file}`
+      original = File.read(file)
+
+      if formatted != original
+        puts "❌ #{file} needs formatting"
+        puts "Diff:"
+        # Save formatted version to temp file and run diff
+        temp_file = "#{file}.formatted"
+        File.write(temp_file, formatted)
+        system("diff -u #{file} #{temp_file}")
+        File.unlink(temp_file)
+        needs_format = true
+      end
+    end
+
+    if needs_format
+      warn "Some files need formatting. Run 'rake format:c' to format them."
+      exit 1
+    else
+      puts "✅ All files are properly formatted"
+    end
+  end
+end
+
 rule ".c" => ".re" do |t|
   puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake lexer` ⚠️⚠️⚠️"
 end
@@ -78,6 +157,9 @@ task :templates do
 
   sh "#{ruby} templates/template.rb include/rbs/ast.h"
   sh "#{ruby} templates/template.rb src/ast.c"
+
+  # Format the generated files
+  Rake::Task["format:c"].invoke
 end
 
 task :compile => "ext/rbs_extension/class_constants.h"

data/config.yml

@@ -345,7 +345,7 @@ nodes:
   - name: RBS::Types::Bases::Top
   - name: RBS::Types::Bases::Void
   - name: RBS::Types::Block
-    expose_location: false
+    expose_location: true
     fields:
       - name: type
         c_type: rbs_node

data/core/enumerable.rbs

@@ -192,6 +192,11 @@
 #     find exactly one of each Hash entry.
 #
 module Enumerable[unchecked out Elem] : _Each[Elem]
+  %a{private}
+  interface _Pattern
+    def ===: (untyped) -> bool
+  end
+
   # <!--
   #   rdoc-file=enum.c
   #   - all?                  -> true or false
@@ -234,6 +239,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # Related: #any?, #none? #one?.
   #
   def all?: () -> bool
+          | (_Pattern) -> bool
           | () { (Elem) -> boolish } -> bool
 
   # <!--
@@ -277,6 +283,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # Related: #all?, #none?, #one?.
   #
   def any?: () -> bool
+          | (_Pattern) -> bool
           | () { (Elem) -> boolish } -> bool
 
   # <!--
@@ -1167,6 +1174,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # Related: #one?, #all?, #any?.
   #
   def none?: () -> bool
+           | (_Pattern) -> bool
            | () { (Elem) -> boolish } -> bool
 
   # <!--
@@ -1210,6 +1218,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # Related: #none?, #all?, #any?.
   #
   def one?: () -> bool
+          | (_Pattern) -> bool
           | () { (Elem) -> boolish } -> bool
 
   # <!--

data/core/io.rbs

@@ -2278,7 +2278,7 @@ class IO < Object
   # potential security vulnerabilities if called with untrusted input; see
   # [Command Injection](rdoc-ref:command_injection.rdoc).
   #
-  def self.binread: (String name, ?Integer? length, ?Integer offset) -> String
+  def self.binread: (path name, ?Integer? length, ?Integer offset) -> String
 
   # <!--
   #   rdoc-file=io.c
@@ -2291,7 +2291,7 @@ class IO < Object
   # potential security vulnerabilities if called with untrusted input; see
   # [Command Injection](rdoc-ref:command_injection.rdoc).
   #
-  def self.binwrite: (String name, _ToS string, ?Integer offset, ?mode: String mode) -> Integer
+  def self.binwrite: (path name, _ToS string, ?Integer offset, ?mode: String mode) -> Integer
 
   # <!--
   #   rdoc-file=io.c
@@ -2716,7 +2716,7 @@ class IO < Object
   # *   [Open Options](rdoc-ref:IO@Open+Options).
   # *   [Encoding options](rdoc-ref:encodings.rdoc@Encoding+Options).
   #
-  def self.read: (String name, ?Integer? length, ?Integer offset, ?external_encoding: String | Encoding | nil, ?internal_encoding: String | Encoding | nil, ?encoding: String | Encoding | nil, ?textmode: boolish, ?binmode: boolish, ?autoclose: boolish, ?mode: String) -> String
+  def self.read: (path name, ?Integer? length, ?Integer offset, ?external_encoding: String | Encoding | nil, ?internal_encoding: String | Encoding | nil, ?encoding: String | Encoding | nil, ?textmode: boolish, ?binmode: boolish, ?autoclose: boolish, ?mode: String) -> String
 
   # <!--
   #   rdoc-file=io.c
@@ -2986,7 +2986,7 @@ class IO < Object
   # *   [Open Options](rdoc-ref:IO@Open+Options).
   # *   [Encoding options](rdoc-ref:encodings.rdoc@Encoding+Options).
   #
-  def self.write: (String path, _ToS data, ?Integer offset, ?external_encoding: String | Encoding | nil, ?internal_encoding: String | Encoding | nil, ?encoding: String | Encoding | nil, ?textmode: boolish, ?binmode: boolish, ?autoclose: boolish, ?mode: String) -> Integer
+  def self.write: (path path, _ToS data, ?Integer offset, ?external_encoding: String | Encoding | nil, ?internal_encoding: String | Encoding | nil, ?encoding: String | Encoding | nil, ?textmode: boolish, ?binmode: boolish, ?autoclose: boolish, ?mode: String) -> Integer
 
   # <!--
   #   rdoc-file=io.c

data/core/thread.rbs

@@ -829,13 +829,6 @@ class Thread < Object
   #
   def self.each_caller_location: () { (Backtrace::Location) -> void } -> nil
 
-  # Wraps the block in a single, VM-global
-  # [Mutex\#synchronize](https://ruby-doc.org/core-2.6.3/Mutex.html#method-i-synchronize)
-  # , returning the value of the block. A thread executing inside the
-  # exclusive section will only block other threads which also use the
-  # [::exclusive](Thread.downloaded.ruby_doc#method-c-exclusive) mechanism.
-  def self.exclusive: () { () -> untyped } -> untyped
-
   # <!--
   #   rdoc-file=thread.c
   #   - Thread.exit   -> thread