Add RBS type signatures and Steep configuration (#2)

Author: afuno

.github/workflows/steep.yml

@@ -0,0 +1,40 @@
+name: Steep
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  steep:
+    name: Type Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Cache RBS collection
+        uses: actions/cache@v4
+        with:
+          path: .gem_rbs_collection
+          key: rbs-collection-${{ hashFiles('rbs_collection.lock.yaml') }}
+          restore-keys: |
+            rbs-collection-
+
+      - name: Install RBS collection
+        run: bundle exec rbs collection install
+
+      - name: Run Steep type check
+        run: bundle exec steep check

Gemfile.lock

@@ -30,16 +30,23 @@ GEM
     bigdecimal (4.0.1)
     concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
+    csv (3.3.5)
     diff-lcs (1.6.2)
     drb (2.2.3)
+    ffi (1.17.3-arm64-darwin)
+    fileutils (1.8.0)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     minitest (6.0.1)
       prism (~> 1.5)
+    mutex_m (0.3.0)
     parallel (1.27.0)
     parser (3.3.10.0)
       ast (~> 2.4.1)
@@ -49,6 +56,11 @@ GEM
     rack (3.2.4)
     rainbow (3.1.1)
     rake (13.3.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.10.2)
+      logger
     regexp_parser (2.11.3)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -110,6 +122,26 @@ GEM
       rubocop-rake (>= 0.7)
       rubocop-rspec (>= 3.5)
       rubocop-rspec_rails (>= 2.31)
+    steep (1.10.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      mutex_m (>= 0.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.9)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
+    strscan (3.1.7)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     thor (1.5.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -125,8 +157,10 @@ PLATFORMS
 DEPENDENCIES
   appraisal (>= 2.5)
   rake (>= 13.2)
+  rbs (>= 3.8)
   rspec (>= 3.13)
   servactory-rubocop (>= 0.9)
+  steep (>= 1.9)
   stroma!
 
 BUNDLED WITH

Steepfile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  signature "sig/external"
+
+  check "lib"
+
+  # Enable strict mode for better type safety
+  configure_code_diagnostics(D::Ruby.strict)
+
+  # Disable specific diagnostics that don't work well with common Ruby patterns
+  configure_code_diagnostics do |config|
+    # Mixin modules calling super in methods that will be available after include
+    config[D::Ruby::UnexpectedSuper] = :information
+
+    # instance_eval block type mismatch (block doesn't use self argument)
+    config[D::Ruby::BlockTypeMismatch] = :information
+  end
+
+  # Data.define with block causes Steep type checking issues
+  # See: https://github.com/ruby/rbs/blob/master/docs/data_and_struct.md
+  ignore "lib/stroma/hooks/hook.rb"
+
+  # Complex splat delegation (*args) in fetch method causes type checking issues
+  ignore "lib/stroma/settings/setting.rb"
+end