そのオブジェクト、何を保証してくれますか？ - GuideRailのススメ -

"そのオブジェクト、何を保証してくれますか？" LTの資料です。5分に収まってないです。

Kanazawa.rb meetup #156 at ビブリオバウムでの発表です。

Transcript

1. そのオブジェクト、 何を保証してくれますか？ - GuideRail のススメ - @wtnabe Kanazawa.rb meetup #156 at ビブリオバウム 2025-08-16 (Sat)
2. みなさん型書いてますか
3. Ruby はclass ベースオブジェクト指向 基本的に書けるものはオブジェクトでありclass がある class にはclass 固有の振る舞いがある
4. class として違いが書けているなら、 それは異なる型と言える
5. （静的型付けかどうかはのちほど）
6. プリミティブ(?) で確認するのが簡単 irb(main):001> "a" + 1 (irb):1:in `+': no implicit conversion of \ Integer into String (TypeError) "a" + 1 ^ from (irb):1:in `<main>' String の + メソッドは引数に String を要求する Integer を与えても TypeError になる
7. では問題
8. 以下を表現してみよう 1. 要素の定義の異なるHash 2. 公開可能なブログエントリ
9. Q1. 要素の定義の異なるHash
10. A1. Hashie::Dash を使う class MyHash1 < Hashie::Dash property :name end class MyHash2 < Hashie::Dash property :key end MyHash1 == MyHash1 # => true MyHash1 == Myhash2 # => false
11. サブクラス作るだけで異なるっちゃ異なるけど、素のHash に要素の 定義はないので、違いを表現できてはいない 他にも実現方法はあるけどお手軽便利はHashie
12. Q2. 公開可能なブログエントリ
13. こんなモデル class BlogEntry include ActiveModel::API include ActiveModel::Attributes attribute :id, :big_integer attribute :title, :string attribute :body, :string attribute :tags attribute :not_permitted, :boolean end 今回は承認フローについては無視
14. 公開可能な条件 title, body, tags がちゃんと埋まっている not_permitted ではない これをどう表現するか？
15. すぐ思いつくのはメソッドを用意する class BlogEntry def publishable? @title.size > 0 && @body.size > 0 && @tags.size > 0 && !@not_permitted end end
16. でも同じclass なので都度判定が必要 公開ボタンの ON/OFF attribute の nil を避ける （String に対するフィルタが nil に対して動くと例外で死ぬ）
17. 本当はこうなってると嬉しい class 内容 BlogEntry いろんな状態のエントリ BlogEntryPublishable 公開可能な状態のエントリ
18. でも状態は変わるやん？
19. そこでImmutable Value Object ですよ
20. Data ( Ruby 3.2+ )
21. 基本はこんな感じ entry = BlogEntry.new BlogEntryPublishable = Data.define(:id, :title, :body, :tags) # <data BlogEntryPublishable title=..> entry_pulishable = BlogEntryPublishable.new(*entry.attributes) if entry.publishable? def render(entry_publishable) # この中で呼ばれる処理では `&.` とか使わなくてもよい end
22. でもこれDRY じゃないし繊細 entry = BlogEntry.new # attributeの定義が二重化している BlogEntryPublishable = Data.define(:id, :title, :body, :tags) # <data BlogEntryPublishable title=..> entry_publishable = BlogEntryPublishable.new(*entry.attributes) if entry.publishable? # * が繊細 attributes も publishable? もモノによる
23. 合わせておかないと例外が上がってしまう BlogEntryPublishable = Data.define(:id, :title, :body, :tags) BlogEntryPublishable.new(name: "foo") # `initialize': unknown keyword: :name (ArgumentError) ※ 例外の扱いはミスると致命傷なのでやりたくない
24. 便利gem （GuideRail ）作ったよ https://github.com/wtnabe/guide-rail
25. 特徴 dry-schema を利用した宣言的な定義で記述ブレをなくす schema 定義に合わないデータも例外を上げずに処理できる 代表的なデータオブジェクトについては自動的に変換して処理する nil を潰せる 関数型のようにも書ける ( dry-monads を利用 )
26. schema 定義はdry-schema そのまま BlogEntryPublishableSchema = Dry::Schema.Params do required(:id).filled(:integer) required(:title).filled(:string) required(:body).filled(:string) required(:not_permitted).maybe(:false) end schema validation の考え方は2020 年頃からある 流行ってきたのは2023 年のZod 辺りから
27. Creator Class を定義して使う class BlogEntryPublishableCreator extend GuideRail schema BlogEntryPublishableSchema class_name :BlogEntryPublishable end BlogEntryPublishableCreator.from(blog_entry) # => #<data BlogEntryPublishable> # or # => Dry::Schema::Result
28. 定義に合っていない場合は Dry::Schema::Result の形でエラーが返ってくる
29. さまざまなご要望にお応え
30. いろんなデータを受け付けてほしい # @param [untyped] data # @return [Hash] def accept(data) if data.respond_to? :attributes # ActiveModel data.attributes.transform_keys(&:to_sym) elsif data.respond_to? :to_h # Struct, OpenStruct, Hashie, etc... data.to_h elsif data.is_a? Hash data elsif data.respond_to? :to_hash # Hash convertible data.to_hash end end
31. renderable option ( nil を潰したい ) SimpleNullableSchema = Dry::Schema.Params do required(:name).maybe(:string) end class RenderableCreator extend GuideRail schema SimpleNullableSchema class_name :Renderable renderable true end RenderableCreator.from(name: nil) # => #<data Renderable name=""> RenderableCreator.from(name: "John") # => #<data Renderable name="John">
32. yield_block ( Data クラスを拡張したい ) .. class OptionalAndYieldAccepter extend GuideRail class_name :ExtendedData schema OptionalSchema renderable true yield_block do alias_method :name_orig, :name define_method(:name) { "decorated #{name_orig}" } end end OptionalAndYieldAccepter.from({}).name.start_with? "decorated" # => true
33. monadic option ( if 書きたくない ) SimpleNonNullableSchema = Dry::Schema.Params do required(:name).filled(:string) end class SimpleNonNullableMonadicCreator extend GuideRail schema SimpleNonNullableSchema class_name :SimpleNonNullableMonadic monadic true # 常に Dry::Monads::Result を返す end SimpleNonNullableMonadicCreator.from({}).either( ->(e) { e.value! }, # ^^^^^^ ->(e) { e.errors.to_h })
34. 静的解析、静的型付けしたい できあがる class に対して RBS を書こう
35. まとめ Ruby 組み込みオブジェクトは class が挙動を明確にしている 「条件」あるいは「状態」に対して定義（class ）を作ることで独自 オブジェクトもよりクリアになる そのために Immutable Value Object が使える Data 周りの繊細さを取り除き、より安心して使える gem 作ったよ モナドいいかもよ？
36. 参考 GuideRail というimmutable value object をうまく使うためのgem を 作ってみた (2025-07-06) | あーありがち wtnabe/guide-rail: A opinionated factory library to create safe, immutable Data objects from various sources using dry-schema and Data ( Ruby 3.2+ ). 少しでも例外を安全に扱うために - Ruby とJavaScript 編 - (2024-08- 10) | あーありがち