[perfect-ruby-on-rails] Introduce Steep Typechecking

.github/workflows/perfect-ruby-on-rails.yml → .github/workflows/ruby-on-rails--perfect-ruby-on-rails.yml

@@ -5,7 +5,7 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Perfect Ruby on Rails
+name: Ruby on Rails - Perfect Ruby on Rails
 
 on:
   push:
@@ -22,9 +22,9 @@ on:
       - ruby-on-rails/perfect-ruby-on-rails/Rakefile
       - ruby-on-rails/perfect-ruby-on-rails/.rubocop.yml
       - ruby-on-rails/perfect-ruby-on-rails/.rubocop_todo.yml
-      # - ruby-on-rails/perfect-ruby-on-rails/Steepfile
+      - ruby-on-rails/perfect-ruby-on-rails/Steepfile
       - ruby-on-rails/perfect-ruby-on-rails/**/*.rb
-      # - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
+      - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
       - ruby-on-rails/perfect-ruby-on-rails/**/*.rake
       - ruby-on-rails/perfect-ruby-on-rails/**/*.yml
       - ruby-on-rails/perfect-ruby-on-rails/**/*.js
@@ -44,9 +44,9 @@ on:
       - ruby-on-rails/perfect-ruby-on-rails/Gemfile.lock
       - ruby-on-rails/perfect-ruby-on-rails/.rubocop.yml
       - ruby-on-rails/perfect-ruby-on-rails/.rubocop_todo.yml
-      # - ruby-on-rails/perfect-ruby-on-rails/Steepfile
+      - ruby-on-rails/perfect-ruby-on-rails/Steepfile
       - ruby-on-rails/perfect-ruby-on-rails/**/*.rb
-      # - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
+      - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
       - ruby-on-rails/perfect-ruby-on-rails/**/*.rake
       - ruby-on-rails/perfect-ruby-on-rails/**/*.yml
       - ruby-on-rails/perfect-ruby-on-rails/**/*.js
@@ -66,7 +66,7 @@ jobs:
     outputs:
       ruby-changes: ${{ steps.change-detection.outputs.ruby }}
       rubocop-changes: ${{ steps.change-detection.outputs.rubocop}}
-      # steep-changes: ${{ steps.change-detection.outputs.steep}}
+      steep-changes: ${{ steps.change-detection.outputs.steep}}
     steps:
       - uses: actions/checkout@v6
       - name: Change Detection
@@ -103,18 +103,18 @@ jobs:
               - ruby-on-rails/perfect-ruby-on-rails/.rubocop_todo.yml
               - ruby-on-rails/perfect-ruby-on-rails/**/*.rb
               - ruby-on-rails/perfect-ruby-on-rails/**/*.rake
-            # steep:
-              # - .github/actions/setup-ruby-on-rails/action.yml
-              # - .github/workflows/perfect-ruby-on-rails.yml
-              # - .ruby-version
-              # - .node-version
-              # - ruby-on-rails/perfect-ruby-on-rails/.ruby-version
-              # - ruby-on-rails/perfect-ruby-on-rails/Gemfile
-              # - ruby-on-rails/perfect-ruby-on-rails/Gemfile.lock
-              # - ruby-on-rails/perfect-ruby-on-rails/Steepfile
-              # - ruby-on-rails/perfect-ruby-on-rails/**/*.rb
-              # - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
-              # - ruby-on-rails/perfect-ruby-on-rails/**/*.rake
+            steep:
+              - .github/actions/setup-ruby-on-rails/action.yml
+              - .github/workflows/perfect-ruby-on-rails.yml
+              - .ruby-version
+              - .node-version
+              - ruby-on-rails/perfect-ruby-on-rails/.ruby-version
+              - ruby-on-rails/perfect-ruby-on-rails/Gemfile
+              - ruby-on-rails/perfect-ruby-on-rails/Gemfile.lock
+              - ruby-on-rails/perfect-ruby-on-rails/Steepfile
+              - ruby-on-rails/perfect-ruby-on-rails/**/*.rb
+              - ruby-on-rails/perfect-ruby-on-rails/**/*.rbs
+              - ruby-on-rails/perfect-ruby-on-rails/**/*.rake
   minitest:
     timeout-minutes: 10
     runs-on: ubuntu-latest
@@ -173,19 +173,19 @@ jobs:
       - name: RuboCop
         working-directory: ./ruby-on-rails/perfect-ruby-on-rails
         run: bundle exec rubocop
-  # steep:
-  #   timeout-minutes: 10
-  #   runs-on: ubuntu-latest
-  #   needs: change-detection
-  #   if: needs.change-detection.outputs.steep-changes == 'true'
-  #   steps:
-  #     - uses: actions/checkout@v6
-  #     - uses: ./.github/actions/setup-ruby-on-rails
-  #       with:
-  #         working-directory: ./ruby-on-rails/perfect-ruby-on-rails
-  #         job-name: steep
-  #     - name: Steep
-  #       working-directory: ./ruby-on-rails/perfect-ruby-on-rails
-  #       run: |
-  #         bundle exec rbs-inline --output sig/generated/ .
-  #         bundle exec steep check
+  steep:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    needs: change-detection
+    if: needs.change-detection.outputs.steep-changes == 'true'
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ./.github/actions/setup-ruby-on-rails
+        with:
+          working-directory: ./ruby-on-rails/perfect-ruby-on-rails
+          job-name: steep
+      - name: Steep
+        working-directory: ./ruby-on-rails/perfect-ruby-on-rails
+        run: |
+          bundle exec rbs-inline --output sig/generated/ .
+          bundle exec steep check

.gitignore

@@ -19,6 +19,8 @@ ruby-on-rails/perfect-ruby-on-rails/app/assets/builds/*
 !ruby-on-rails/perfect-ruby-on-rails/app/assets/builds/.keep
 ruby-on-rails/perfect-ruby-on-rails/node_modules/
 ruby-on-rails/perfect-ruby-on-rails/.env
+ruby-on-rails/perfect-ruby-on-rails/sig/
+ruby-on-rails/perfect-ruby-on-rails/vendor/
 
 ## RESTful API
 ruby-on-rails/restful-api/config/master.key

ruby-on-rails/perfect-ruby-on-rails/Gemfile

@@ -31,7 +31,7 @@ gem 'image_processing', '~> 1.14.0'
 gem 'active_storage_validations', '~> 3.0.3'
 
 # Reduces boot times through caching; required in config/boot.rb
-gem 'bootsnap', '~> 1.24.1', require: false
+gem 'bootsnap', '~> 1.24.2', require: false
 
 # environmental variables
 gem 'dotenv-rails', '~> 3.2.0'
@@ -87,7 +87,9 @@ group :development do
   gem 'rubocop-minitest', '~> 0.39.0', require: false
   gem 'rubocop-performance', '~> 1.26.0', require: false
   gem 'rubocop-rails', '~> 2.34.3', require: false
-
+  # Typechecking
+  gem 'rbs-inline', '~> 0.13.0', require: false
+  gem 'steep', '~> 1.10.0', require: false
   # Provides methods for benchmarking Ruby code, giving detailed reports on the time taken for each task
   gem 'benchmark', '~> 0.5.0'
 end

ruby-on-rails/perfect-ruby-on-rails/Gemfile.lock

@@ -88,7 +88,7 @@ GEM
     benchmark (0.5.0)
     bigdecimal (4.1.2)
     bindex (0.8.1)
-    bootsnap (1.24.1)
+    bootsnap (1.24.2)
       msgpack (~> 1.2)
     brakeman (8.0.4)
       racc
@@ -107,6 +107,7 @@ GEM
     crass (1.0.6)
     cssbundling-rails (1.4.3)
       railties (>= 6.0.0)
+    csv (3.3.5)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
@@ -130,6 +131,7 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     ffi (1.17.4-x86_64-linux-gnu)
+    fileutils (1.8.0)
     globalid (1.3.0)
       activesupport (>= 6.1)
     hashie (5.1.0)
@@ -167,6 +169,10 @@ GEM
     kaminari-core (1.2.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    listen (3.10.0)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     loofah (2.25.1)
       crass (~> 1.0.2)
@@ -186,8 +192,9 @@ GEM
       drb (~> 2.0)
       prism (~> 1.5)
     msgpack (1.8.0)
-    multi_xml (0.9.0)
+    multi_xml (0.9.1)
       bigdecimal (>= 3.1, < 5)
+    mutex_m (0.3.0)
     mysql2 (0.5.7)
       bigdecimal
     net-http (0.9.1)
@@ -298,6 +305,15 @@ GEM
       activerecord (>= 7.2)
       activesupport (>= 7.2)
       i18n
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.10.4)
+      logger
+      tsort
+    rbs-inline (0.13.0)
+      prism (>= 0.29)
+      rbs (>= 3.8.0)
     rdoc (7.2.0)
       erb
       psych (>= 4.0.0)
@@ -349,7 +365,27 @@ GEM
     snaky_hash (2.0.3)
       hashie (>= 0.1.0, < 6)
       version_gem (>= 1.1.8, < 3)
+    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)
     stringio (3.2.0)
+    strscan (3.1.8)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     thor (1.5.0)
     timeout (0.6.1)
     tsort (0.2.0)
@@ -383,7 +419,7 @@ PLATFORMS
 DEPENDENCIES
   active_storage_validations (~> 3.0.3)
   benchmark (~> 0.5.0)
-  bootsnap (~> 1.24.1)
+  bootsnap (~> 1.24.2)
   brakeman (~> 8.0.4)
   capybara (~> 3.40.0)
   cssbundling-rails (~> 1.4.1)
@@ -410,12 +446,14 @@ DEPENDENCIES
   rails (~> 8.1.3)
   rails-i18n (~> 8.1.0)
   ransack (~> 4.4.1)
+  rbs-inline (~> 0.13.0)
   rexml (~> 3.4.4)
   rubocop (~> 1.86.1)
   rubocop-minitest (~> 0.39.0)
   rubocop-performance (~> 1.26.0)
   rubocop-rails (~> 2.34.3)
   selenium-webdriver (~> 4.43.0)
+  steep (~> 1.10.0)
   turbo-rails (~> 2.0.16)
   tzinfo-data
   web-console (~> 4.3.0)
@@ -440,7 +478,7 @@ CHECKSUMS
   benchmark (0.5.0) sha256=465df122341aedcb81a2a24b4d3bd19b6c67c1530713fd533f3ff034e419236c
   bigdecimal (4.1.2) sha256=53d217666027eab4280346fba98e7d5b66baaae1b9c3c1c0ffe89d48188a3fbd
   bindex (0.8.1) sha256=7b1ecc9dc539ed8bccfc8cb4d2732046227b09d6f37582ff12e50a5047ceb17e
-  bootsnap (1.24.1) sha256=d7faea1dc24aa5b22dacc049c9236b64ebf60b14dd49c615e15d8402375d39ef
+  bootsnap (1.24.2) sha256=d2900f85a75088d62c9d03dab5e55b20820748c62d427a59fa76899e398c2d1c
   brakeman (8.0.4) sha256=7bf921fa9638544835df9aa7b3e720a9a72c0267f34f92135955edd80d4dcf6f
   builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
   bundler (4.0.11) sha256=5bcec0fb78302e48d02ee46f10ee6e6942be647ba5b44a6d1ddfda9a240ce785
@@ -449,6 +487,7 @@ CHECKSUMS
   connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
   crass (1.0.6) sha256=dc516022a56e7b3b156099abc81b6d2b08ea1ed12676ac7a5657617f012bd45d
   cssbundling-rails (1.4.3) sha256=53aecd5a7d24ac9c8fcd92975acd0e830fead4ee4583d3d3d49bb64651946e41
+  csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
   date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
   debug (1.11.1) sha256=2e0b0ac6119f2207a6f8ac7d4a73ca8eb4e440f64da0a3136c30343146e952b6
   dotenv (3.2.0) sha256=e375b83121ea7ca4ce20f214740076129ab8514cd81378161f11c03853fe619d
@@ -461,6 +500,7 @@ CHECKSUMS
   faraday (2.14.1) sha256=a43cceedc1e39d188f4d2cdd360a8aaa6a11da0c407052e426ba8d3fb42ef61c
   faraday-net_http (3.4.2) sha256=f147758260d3526939bf57ecf911682f94926a3666502e24c69992765875906c
   ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d
+  fileutils (1.8.0) sha256=8c6b1df54e2540bdb2f39258f08af78853aa70bad52b4d394bbc6424593c6e02
   globalid (1.3.0) sha256=05c639ad6eb4594522a0b07983022f04aa7254626ab69445a0e493aa3786ff11
   hashie (5.1.0) sha256=c266471896f323c446ea8207f8ffac985d2718df0a0ba98651a3057096ca3870
   i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
@@ -477,6 +517,7 @@ CHECKSUMS
   kaminari-core (1.2.2) sha256=3bd26fec7370645af40ca73b9426a448d09b8a8ba7afa9ba3c3e0d39cdbb83ff
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  listen (3.10.0) sha256=c6e182db62143aeccc2e1960033bebe7445309c7272061979bb098d03760c9d2
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   loofah (2.25.1) sha256=d436c73dbd0c1147b16c4a41db097942d217303e1f7728704b37e4df9f6d2e04
   mail (2.9.0) sha256=6fa6673ecd71c60c2d996260f9ee3dd387d4673b8169b502134659ece6d34941
@@ -486,7 +527,8 @@ CHECKSUMS
   mini_mime (1.1.5) sha256=8681b7e2e4215f2a159f9400b5816d85e9d8c6c6b491e96a12797e798f8bccef
   minitest (6.0.6) sha256=153ea36d1d987a62942382b61075745042a2b3123b1cd48f4c3675af9cc7d6f1
   msgpack (1.8.0) sha256=e64ce0212000d016809f5048b48eb3a65ffb169db22238fb4b72472fecb2d732
-  multi_xml (0.9.0) sha256=7b6baedb68d1853b1a23b493b78aeee0b80d79bab94e144e63a1b84c9a9df9ca
+  multi_xml (0.9.1) sha256=7ce766b59c17241ed62976caeae1fae9b2431b263398c35396239a68c4a64e57
+  mutex_m (0.3.0) sha256=cfcb04ac16b69c4813777022fdceda24e9f798e48092a2b817eb4c0a782b0751
   mysql2 (0.5.7) sha256=ba09ede515a0ae8a7192040a1b778c0fb0f025fa5877e9be895cd325fa5e9d7b
   net-http (0.9.1) sha256=25ba0b67c63e89df626ed8fac771d0ad24ad151a858af2cc8e6a716ca4336996
   net-imap (0.6.4) sha256=9a5598c67a3022c284d98430ef1d4948e7dbdb62596f61081ea8ca933270a02b
@@ -525,6 +567,10 @@ CHECKSUMS
   rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
   rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
   ransack (4.4.1) sha256=6aeaac36fc19088570e10da1044e6cfd88c740e20f871b84566fd30e32b7a63d
+  rb-fsevent (0.11.2) sha256=43900b972e7301d6570f64b850a5aa67833ee7d87b458ee92805d56b7318aefe
+  rb-inotify (0.11.1) sha256=a0a700441239b0ff18eb65e3866236cd78613d6b9f78fea1f9ac47a85e47be6e
+  rbs (3.10.4) sha256=b17d7c4be4bb31a11a3b529830f0aa206a807ca42f2e7921a3027dfc6b7e5ce8
+  rbs-inline (0.13.0) sha256=aba6e48c2d1b75276e8557376164f4b4ba96dd0204e779a5cee2af442bd30442
   rdoc (7.2.0) sha256=8650f76cd4009c3b54955eb5d7e3a075c60a57276766ebf36f9085e8c9f23192
   regexp_parser (2.12.0) sha256=35a916a1d63190ab5c9009457136ae5f3c0c7512d60291d0d1378ba18ce08ebb
   reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
@@ -540,7 +586,10 @@ CHECKSUMS
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
   selenium-webdriver (4.43.0) sha256=a634377b964b701c6ac0a009ce3a08fa34ec1e1e7fe9a6d57e3088d14529a65c
   snaky_hash (2.0.3) sha256=25a3d299566e8153fb02fa23fd9a9358845950f7a523ddbbe1fa1e0d79a6d456
+  steep (1.10.0) sha256=1b295b55f9aaff1b8d3ee42453ee55bc2a1078fda0268f288edb2dc014f4d7d1
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
+  strscan (3.1.8) sha256=aae2db611a225559f21ffbb71765c9a4e60fd262534a9ea84f4f11c7f32f679e
+  terminal-table (4.0.0) sha256=f504793203f8251b2ea7c7068333053f0beeea26093ec9962e62ea79f94301d2
   thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
   timeout (0.6.1) sha256=78f57368a7e7bbadec56971f78a3f5ecbcfb59b7fcbb0a3ed6ddc08a5094accb
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

ruby-on-rails/perfect-ruby-on-rails/Steepfile

@@ -0,0 +1,13 @@
+D = Steep::Diagnostic
+
+target :app do
+  check 'app'
+  check 'test'
+  signature 'sig'
+
+  library 'minitest'
+  library 'net-smtp'
+  library 'psych'
+
+  configure_code_diagnostics(D::Ruby.default)
+end

ruby-on-rails/perfect-ruby-on-rails/app/channels/application_cable/channel.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 module ApplicationCable
   class Channel < ActionCable::Channel::Base
   end

ruby-on-rails/perfect-ruby-on-rails/app/channels/application_cable/connection.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 module ApplicationCable
   class Connection < ActionCable::Connection::Base
   end

ruby-on-rails/perfect-ruby-on-rails/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class ApplicationController < ActionController::Base
   before_action :authenticate
   helper_method :logged_in?, :current_user

ruby-on-rails/perfect-ruby-on-rails/app/controllers/events_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class EventsController < ApplicationController
   skip_before_action :authenticate, only: [:index, :show]
   before_action :set_event, only: :show

ruby-on-rails/perfect-ruby-on-rails/app/controllers/retirements_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class RetirementsController < ApplicationController
   def new; end
 

ruby-on-rails/perfect-ruby-on-rails/app/controllers/sessions_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class SessionsController < ApplicationController
   skip_before_action :authenticate, only: [:create]
 

ruby-on-rails/perfect-ruby-on-rails/app/controllers/status_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class StatusController < ApplicationController
   skip_before_action :authenticate
 

ruby-on-rails/perfect-ruby-on-rails/app/controllers/tickets_controller.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class TicketsController < ApplicationController
   def new
     raise ApplicationController::RoutingError, 'ログイン状態で TicketsController#new にアクセスされました'

ruby-on-rails/perfect-ruby-on-rails/app/helpers/event_helper.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 module EventHelper
   def show_image_if_attached(event)
     return unless event.has_image_to_show?

ruby-on-rails/perfect-ruby-on-rails/app/jobs/application_job.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class ApplicationJob < ActiveJob::Base
   # Automatically retry jobs that encountered a deadlock
   # retry_on ActiveRecord::Deadlocked

ruby-on-rails/perfect-ruby-on-rails/app/mailers/application_mailer.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 class ApplicationMailer < ActionMailer::Base
   default from: 'from@example.com'
   layout 'mailer'