DEV Community: hiko1129

[Rails][Sorbet] Rubocop Settings

hiko1129 — Sat, 20 Aug 2022 02:24:40 +0000

下記のようにrubocop-sorbetが入っている前提

group :development, :test do
  gem 'rubocop-sorbet', require: false
end

下記のようにTrueSigilを有効化してExcludeでspecやconfigを除外するのが良さげ。
デフォルトでFalseSigilが機能しているので全体としてはtyped: falseが必須でアプリケーション本体に関連する部分のみtyped: true以上必須という挙動になる。

Sorbet/TrueSigil:
  Enabled: true
  Include:
    - "**/*.{rb,rbi,rake,ru,jb,jbuilder}"
  Exclude:
    - spec/**/*
    - config/**/*

上記設定があるとbundle exec srb rbi suggest-typedでアプリケーション関連のtypedがfalse以下になったときに簡単に気づける。

[Ruby][Sorbet] How to check RBI file update omission with CI

hiko1129 — Thu, 18 Aug 2022 14:04:25 +0000

Translate ja to en

tapiocaに関しては--verifyオプションが用意されているのでそれを利用する

bin/tapioca gems --verify
bin/tapioca dsl --verify

sorbet-railsに関してはtapiocaのようなオプションが用意されていないようなので下記の感じで差分があるか確認する

bin/rails db:schema:load # ridgepoleを使っている場合にはridgepole --applyを。
bundle exec rake rails_rbi:all
git diff --exit-code --quiet

実際のところ現状だと各RBIのコンフリクト解消が関わってくるので自分は下記のような感じで対応しています

bundle exec srb rbi sorbet-typed
bin/rails db:schema:load
bin/rails rails_rbi:all
bin/tapioca gem --workers=8
bin/tapioca todo
bundle exec srb rbi suggest-typed # コンフリクト解消をここで行ってから差分がでないことを確認する。こうしないとコンフリクト解消前の状態とコンフリクト解消後の状態の比較になってしまい差分が頻繁に発生する状態になってしまいほぼ常にCIで引っかかる状態になってしまう

git diff --exit-code --quiet
if [ $? -ne 0 ]; then
    echo "Please resolve the difference of RBI files"
    exit 1
fi

参考:

[Ruby][Sorbet] What to do when you can't write types in Ruby files (when meta-programming)

hiko1129 — Wed, 17 Aug 2022 08:37:43 +0000

Translate ja to en

メタプログラミングしている(define_methodとか使っている)ときは.rb上では型を付与できない。

ex: hoge.rb

class Hoge
  define_method :hoge do
    puts 'hogehoge'
  end
end

Hoge.new.hoge

この場合には、RBIファイルに型を書く対応をする（or 型生成するコードを書く）

ex: hoge.rbi

# typed: strict

class Hoge
  sig { void }
  def hoge; end
end

bin/tapioca gemsなどを実行して型が足りないときも同様にsorbet/rbi/shims以下に型を書く（必要な部分のみで問題ない。）

# typed: strict

class ActiveRecord::Base
  sig { void }
  def hoge; end # <- こんな感じで必要な差分のみ追記で問題ない
end

[Rails][Sorbet] How to add kaminari type definitions in sorbet-rails

hiko1129 — Wed, 17 Aug 2022 08:32:23 +0000

Translate ja to en

kaminariに限った話ではないが一部のgemに関してはsorbet-railsのinitializerを追加することで型生成対象に含めることができる。

kaminariのgemを入れているから勝手に生成されるとかではなくあくまで自分で設定する必要がある模様。

# -- config/initializers/sorbet_rails.rb
SorbetRails.configure do |config|
  config.enabled_gem_plugins = [
    :kaminari
  ]
end

参考

https://github.com/chanzuckerberg/sorbet-rails#enabling-built-in-plugins

[Ruby][Sorbet][tapioca] What to do when gem type definition conflicts cannot be resolved

hiko1129 — Wed, 17 Aug 2022 08:22:16 +0000

Translate ja to en

前提

tapiocaを使っている
sorbet-typed(などのコミュニティの型定義)とコンフリクトしている
bundle exec srb rbi suggest-typedで解消されない

対応

下記のようにtapiocaのconfigのexcludeに対象gemを追加。

sorbet/tapioca/config.yml

gem:
  exclude:
    - gemA

試してはいないがおそらくtyped_overridesでfalseにするなどでも解消できるはず（気が向いたら試す）。

gem:
  typed_overrides:
    gemA: "false"

参考

https://github.com/Shopify/tapioca#excluding-a-gem-from-rbi-generation

[Ruby][Sorbet] Using T.unsafe to escape type constraints

hiko1129 — Tue, 16 Aug 2022 01:52:51 +0000

Translate ja to en

typed: trueでもtyped: strictであってもT.unsafeを使うことで特定部分のみ型に基づかない状態で記述できます。

自分がよくやる（やるなよって話であるがTODOつけて一旦通すという意味でよくやる）のは下記のパターンです。

T.unsafe(self).hoge # selfにhogeメソッドは型定義上存在していないが実際には存在するとき

RBIファイルに追記するまで、あるいは何かしらのconfigを書いてメソッドを生やす、あるいは型生成gemのバグ修正待ち、あるいはそもそも事前定義されている型が間違っているときには、上記のようにして一時対応したりしています。

参考

https://sorbet.org/docs/troubleshooting#escape-hatches

[Ruby][Sorbet] What to do when the RBI generated by tapioca does not have the expected type

hiko1129 — Tue, 16 Aug 2022 00:47:44 +0000

Translate ja to en

sorbet/tapioca/require.rbを用意していない状態だと、Gemfileでrequire: falseとしているものやGem側がオプショナルなrequireとしているものなどは読み込まれず、RBIファイルには含まれないようです。
sorbet/tapioca/require.rbに読み込まれていないものを追加することでRBIファイルに型定義(というか雛形)が含まれる模様。

better_htmlのBetterHtml::Parserの型定義が必要にも関わらずRBIファイルに含まれていない場合には、sorbet/tapioca/require.rbに下記のようにbetter_html/parserを追加する必要があります(better_htmlはbetter_html/parserをデフォルトでは読み込まない)。

# typed: strict
# frozen_string_literal: true

require 'better_html/parser'

参考

https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem

[Ruby][Sorbet] How to make a Rakefile typed

hiko1129 — Mon, 15 Aug 2022 14:22:36 +0000

Translate ja to en

https://github.com/ruby/rake/blob/master/lib/rake/dsl_definition.rb#L195 にて

self.extend Rake::DSL

となっているのでそれを表現したT.all(Rake::DSL, Object)をselfとする(厳密には正しくない...)。

# typed: true

T.bind(self, T.all(Rake::DSL, Object)) # ← selfは実行時エラーになるのでせいぜいObjectっぽい

namespace :hoge
  task hoge: :environment do
  end
end

[Ruby][Sorbet] T::Struct == is an identity comparison, not an equivalence comparison

hiko1129 — Sun, 14 Aug 2022 06:22:17 +0000

Translate ja to en

T::Structの==は、hashや通常のStructと異なり同値性ではなく同一性比較になっています。

class Hoge < T::Struct
  const :hoge, Integer
end

a = Hoge.new(hoge: 1)
b = Hoge.new(hoge: 1)

a == b # => false
a == a # => true

issue: https://github.com/sorbet/sorbet/issues/1540
同値性比較用のgem: https://github.com/bellroy/sorbet-struct-comparable

[Ruby][Sorbet] Use sorbet-coerce to make it easy with type conversion

hiko1129 — Sat, 13 Aug 2022 21:29:05 +0000

Translate ja to en

https://github.com/chanzuckerberg/sorbet-coerce
単体でのスター数は少ないですが、sorbet-railsがTypedParamsとして提供しているクラスが内部的にsorbet-coerceに依存しているのでsorbet-rails分足して評価して上げても良いような感じです。

sorbet-coerceは下記のような感じで値を特定の型（クラス）に変換します。

ランタイムレベル変換機能付きのT.castのようなイメージです。

TypeCoerce[T::Boolean].new.from('false') # => false

class Params < T::Struct
  const :id, Integer
  const :role, String, default: 'wizard'
end

TypeCoerce[Params].new.from({id: '1'}) # => <Params id=1, role="wizard">

v0系のバージョン通り絶賛開発中って感じで、T.anyについては制限がある状態です（機能追加のPRは既に出ているので解決は時間の問題の模様）

Sorbetを利用する場合は、下記のようにTypeCoerce（あるいはsorbet-railsのTypedParams）を利用してjsonをT::Structにdeserializeして、T::Structのserializeメソッドを利用してjson形式（hash形式、as_jsonと同様）にserializeする感じになっていくかと。

controller上

class HogeParams < T::Struct
  const :id, Integer
end

class Response < T::Struct
  const :hoge, String
end

typed_params = TypedParams[HogeParams].new.extract!(params) # => <HogeParams id=1>

jbuilder上

T.cast(@res, HogeController::Response)

[Ruby][Sorbet] How to write the type of accessor methods (attr_* series methods)

hiko1129 — Sat, 13 Aug 2022 21:13:37 +0000

Translate ja to en

class Hoge

  sig {returns(String)} # ← このようにattr_系のメソッドの上にsigを書くだけ
  attr_reader :hoge

end

メソッドコールに対して型定義できるのでそのうちRSpecのletも定義できるような方法が追加されるかも？

参考

https://sorbet.org/docs/faq#how-should-i-add-types-to-methods-defined-with-attr_reader

[Ruby][Sorbet] Where should I put the RBI I wrote?

hiko1129 — Tue, 09 Aug 2022 16:06:14 +0000

Translate ja to en

結論

sorbet/rbi/shims 以下に置く。

gemの場合には: sorbet/rbi/shims/gems

(Railsの)appの場合には: sorbet/rbi/shims/app
と言った感じで。

根拠

https://sorbet.org/docs/rbi#hand-written-rbis-for-gems には下記が書かれており、

When rbi-central does not have RBI files for a gem, tapioca init will still have created some autogenerated RBI files for that gem. These autogenerated files are a great way to start off writing hand-written RBIs for a gem! Simply copy the autogenerated file from the sorbet/rbi/gems/ folder to sorbet/rbi/shims/gems, and start modifying it by hand.

https://github.com/Shopify/tapioca#manually-writing-rbi-definitions-shims には下記が書かれている。

A shim is a hand-crafted RBI file that tells Sorbet about constants, ancestors, methods, etc. that it can't understand statically and aren't already generated by Tapioca.