Railsの型ファイル自動生成における課題と解決

Kaigi on Rails 2023 at 浅草橋ヒューリックホール&カンファレンス

Transcript

1. ˜.*9* RailsͷܕϑΝΠϧࣗಈੜ੒ʹ͓͚Δ ՝୊ͱղܾ 
   ,BJHJ
   PO
   3BJMT
   
   %BZ
   
2. Kaigi on Rails 2023 day 2
6. ˜.*9* ܀ݪ༐थ @ksss Kurihara Yuki Railsྺ9೥ ΈͯͶϓϩμΫτ։ൃ෦ॴଐ
7. ˜.*9* 7 https://github.com/ruby/rbs/graphs/contributors
9. ˜.*9* 9
10. ˜.*9* 10 Rails×ܕ RBS
11. ˜.*9* 11 ՝୊ RailsΞϓϦ΁ खܰʹܕΛಋೖ ͍ͨ͠
12. ˜.*9* 12 ղܾ orthoses-rails
13. ˜.*9* 13 orthoses-rails $ bundle add orthoses-rails —require false $ bin/rails generate orthoses:rails:install $ bin/rails orthoses:rails $ bundle exec rbs collection init $ bundle exec rbs collection install
14. ˜.*9* 14 orthoses-rails ActionMailer ActiveModel ActiveRecord ActiveStorage ActiveSupport
15. ˜.*9* 15 .rb .rbs
16. ˜.*9* 16 ܗ੒ظ Forming ࠞཚظ Storming ౷Ұظ Norming ػೳظ Performing ͜͜·Ͱ ͜Ε͔Β Rails×ܕͷੈք
17. ˜.*9* 17 ՝୊ RBSΛಋೖͨ͠ͷ ʹ୭΋࢖ͬͯͳ͍
18. ˜.*9* 18 ղܾ ੜ੒ͨ͠3#4Λ DPNNJU͢Δɻ RBSϋϯζΦϯΛ ෳ਺ճ࣮ࢪɻ
20. ˜.*9* 20 ՝୊ ΞϓϦέʔγϣϯ ίʔυͷ ܕ͕͍͍ͭͯͳ͍
21. ˜.*9* 21 ղܾ શ෦खͰ3#4Λॻ͘ ՝୊: ΞϓϦ έʔγϣϯ ίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍
23. ˜.*9* 23 ղܾ ࣗಈੜ੒ ՝୊: ΞϓϦ έʔγϣϯ ίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍
24. ˜.*9* 24 ղܾ rbs prototype rb ՝୊: ΞϓϦ έʔγϣϯ ίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍
25. ˜.*9* 25 ՝୊ ՝୊: Ξϓ Ϧέʔγϣ ϯίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍ ղܾ: rbs prototype rb eval, define_method ActiveSupport::Concern Array, Hash, Enumerable delegate
26. ˜.*9* 26 rbs prototype rb eval ActiveSupport:: Concern Generics delegate
27. ˜.*9* 27 ղܾ rbs prototype runtime ՝୊: Ξϓ Ϧέʔγϣ ϯίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍ ղܾ: rbs prototype rb ՝୊: ͍Ζ ͍ΖඇରԠ
28. ˜.*9* 28 rbs prototype rb rbs prototype runtime eval ActiveSupport:: Concern Generics delegate
29. ˜.*9* 29 ՝୊ ՝୊: Ξϓ Ϧέʔγϣ ϯίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍ ղܾ: rbs prototype rb ՝୊: ͍Ζ ͍ΖඇରԠ ղܾ: rbs prototype runtime autoloadඇରԠ ஗͍
30. ˜.*9* 30 ղܾ ՝୊: Ξϓ Ϧέʔγϣ ϯίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍ ղܾ: rbs prototype rb ՝୊: ͍Ζ ͍ΖඇରԠ ղܾ: rbs prototype runtime Pull Request ՝୊: ͍Ζ ͍Ζ໰୊͕
31. ˜.*9* 31 rbs prototype rb rbs prototype runtime eval ActiveSupport:: Concern Generics delegate autoload Speed
32. ˜.*9* 32 ՝୊ ՝୊: Ξϓ Ϧέʔγϣ ϯίʔυͷ ܕ͕͍ͭͯ ͍ͳ͍ ղܾ: rbs prototype rb ՝୊: ͍Ζ ͍ΖඇରԠ ղܾ: rbs prototype runtime ActiveRecord Plugins ΋ͬͱػೳΛʂ untyped Gemͷܕ
34. ˜.*9* 34 ͜͜Ͱ ൒෼
36. ˜.*9* 36 ղܾ orthoses
37. https://speakerdeck.com/ksss/rbs-generation-framework-using-rack-architecture
38. https://speakerdeck.com/ksss/rbs-generation-framework-using-rack-architecture Orthoses::Builder.new do use Orthoses::CreateFileByName use Orthoses::Mid, option: true use Orthoses::Tap do |store| store["Foo"] << "def foo: () -> void" end use Orthoses::Mixin run -> { require '...' } end
39. ˜.*9* 39 orthoses More Feature Extending Customizing Filtering Split files Deduping
40. ˜.*9* rbs prototype rb rbs prototype runtime orthoses eval ActiveSupport:: Concern Generics delegate autoload Speed Extensibility
41. ˜.*9* 41 ՝୊ “orthoses” ͕ಡΊͳ͍
42. ˜.*9* 42 ղܾ
43. ˜.*9* 43 ՝୊ rakeͷΤϥʔ͕Θ͔ Γʹ͍͘
47. ˜.*9* 47 ղܾ #detailed_message
48. ˜.*9* 48 ՝୊ rakeλεΫͷσ όοά͕೉͍͠
49. $ bundle exec rdbg -c -- bin/rails orthoses:rails
50. ˜.*9* 50 ղܾ RAKE_DEBUG=1
51. $ RAKE_DEBUG=1 bin/rails orthoses:rails
52. ˜.*9* 52 ՝୊ YARDͷࢿ࢈Λ ྲྀ༻͍ͨ͠
53. ˜.*9* 53 ղܾ orthoses-yard
54. ˜.*9* 54 orthoses-yard # @param [String] str # @return [Integer] def str_to_i(str) str.to_i end def str_to_i: (String str) -> Integer .rb .rbs
55. खॻ͖ ͷน
56. खॻ͖ ͷน orthoses-yard
57. ˜.*9* 57 ՝୊ YARDΛؒҧ͑Δ ͱ RBS΋ؒҧ͏
58. ˜.*9* 58 YARD͸ҙ֎ͱ೉͍͠ # @param [String|Symbol] # @param [Hash<Symbol, String>] h # @param [String] s def foo(str) ʁ ʁ ʁ
59. ˜.*9* 59 YARD͸ҙ֎ͱ೉͍͠ # @param [String|Symbol] # @param [Hash<Symbol, String>] h # @param [String] s def foo(str) SyntaxError Hash[Symbol | String] def foo: (untyped str) -> untyped
60. ˜.*9* 60 I have a rubocop
61. ˜.*9* 61 and I have a yard
62. ˜.*9* 62
63. ˜.*9* 63 rubocop-yard ղܾ
64. ˜.*9* 64 rubocop-yard
65. ˜.*9* 65 rubocop-yard
66. ˜.*9* 66 rubocop-yard
67. ˜.*9* 67 rubocop-yard
68. खॻ͖ ͷน orthoses-yard rubocop-yard
69. ˜.*9* 69 ·ͱΊ orthoses use Orthoses::LoadRBS use Orthoses::YARD use Orthoses::RBSPrototypeRuntime use Orthoses::Rails Rails×ܕͷੈք΁ͷఏҊ use Your::Middleware
70. ˜.*9* 70