"型"のあるRailsアプリケーション開発 / Typed Rails application development

Rubyセミナー 東京
https://www.ruby.or.jp/ja/news/20240702

Transcript

1. "ܕ"ͷ͋ΔRailsΞϓϦέʔγϣϯ։ൃ Rubyηϛφʔ ౦ژ 2024/09/20 1
2. ࣗݾ঺հ • ໊લ: ਖ਼ಙ ޼(aka: ਆ଎) • GitHub: @sinsoku (ը૾ӈ্) • X: @sinsoku_listy (ը૾ӈԼ) • Railsྺ: 10೥͘Β͍ 2
3. Omotesando.rb ΦϑϥΠϯ։࠵Ͱɺຖ݄ୈҰ໦༵೔ɻ 3
4. Asakusa-bashi.rbs ΦϯϥΠϯ։࠵Ͱɺෆఆظʢ݄ʹ1ճ͘Β͍ʣ 4
5. ΞδΣϯμ • ! RBSʹ͍ͭͯ • ⭐ "ܕ" ͷϝϦοτ • # RBSಋೖͷखॱ • $ rbs-traceͷ঺հ 5
6. ! RBSʹ͍ͭͯ 6
7. RBS • Ruby 3.0Ͱຊମʹಉࠝ͞Εͨ • RubyͷܕఆٛΛॻ͘จ๏·ͨ͸gem • ಈతͳܕఆٛʢϝλϓϩʣ͸Ͱ͖ͳ͍ • RBSࣗମ͸ ܕݕࠪͷػೳΛ࣋ͨͳ͍ 7
8. RBS Ruby RBS 8
9. ⭐ "ܕ" ͷϝϦοτ 9
10. "ܕ" ͷϝϦοτ • υΩϡϝϯτ • ίʔυδϟϯϓ • ೖྗิ׬ • ܕݕࠪ 10
11. υΩϡϝϯτʢVSCodeʣ 11
12. υΩϡϝϯτʢRubyMineʣ 12
13. ίʔυδϟϯϓʢVSCodeʣ 13
14. ೖྗิ׬ʢVSCodeʣ 14
15. ܕݕࠪʢSteepʣ 15
16. ⚠ ܕݕࠪͷਫ਼౓͸RBSʹґଘ͢Δ Ruby͸࣮ߦՄೳͰ΋RBSͱҰக͍ͯ͠ͳ͚Ε͹ΤϥʔʹͳΓ· ͢ɻ 16
17. ! RBSಋೖͷखॱ 17
18. RBSΛಋೖ͢Δखॱʢجຊʣ ͜Ε͚ͩ 1. Gemfile ʹ steep Λ௥Ճ͢Δ 2. sig/".rbs Λ࣮૷͢Δ 18
19. RBSΛಋೖ͢Δखॱʢجຊʣ ͜Ε͚ͩ 1. Gemfile ʹ steep Λ௥Ճ͢Δ 2. sig/".rbs Λ࣮૷͢Δ • ! શͯͷΫϥεɺϞδϡʔϧɺϝιουͷܕఆ͕ٛඞཁ • " ෆे෼ͩͱܕݕࠪͷਫ਼౓͸ѱ͍ 19
20. طଘͷRailsΞϓϦͰ શͯͷܕఆٛΛ༻ҙ͢Δͷ͸೉͍͠ 20
21. RBSΛஈ֊తʹಋೖ͢Δखॱʢਪ঑ʣ • ⛔ ॳظ͸ܕݕࠪΛແޮԽ • υΩϡϝϯτɺίʔυδϟϯϓɺೖྗิ׬Λ໨తʹ͢Δ • ♻ Ͱ͖Δ͚ͩRBSΛੜ੒͢Δ • # ਖ਼͍͠ܕఆٛΛ૿΍͢ • $ Ұ෦ͷϑΝΠϧͷΈܕݕࠪΛ༗ޮԽ 21
22. ۩ମతͳಋೖखॱ 1. Gemͷ௥Ճͱઃఆ • steep, rbs_rails, rbs-inline 2. RBSͷΠϯετʔϧͱੜ੒ 3. RBSͷݕূ 4. ΤσΟλͷઃఆ 22
23. sinsoku/redmine1 1 https://github.com/sinsoku/redmine/tree/setup-rbs 23
24. 1. Steepʢsoutaro/steepʣ Gemfileʹ steep Λ௥Ճͯ͠ bundle install Λ࣮ߦ͢Δɻ # Gemfile group :development do gem "steep", require: false end ͦͯ͠ steep init Λ࣮ߦ͢Δɻ $ bundle exec steep init Writing Steepfile..# 24
25. 1. Steepʢsoutaro/steepʣ Steepfile Λฤू͠ɺܕݕࠪΤϥʔΛແࢹ͠·͢ɻ # Steepfile D = Steep:#Diagnostic target :app do signature "sig" check "app", "lib" configure_code_diagnostics(D:#Ruby.silent) end 25
26. 2. RBS Railsʢpocke/rbs_railsʣ • ActiveRecord͕ఆٛ͢ΔϝιουͷRBSΛੜ੒Ͱ͖Δ • σʔλϕʔεͷΧϥϜ໊ͷϝιου • ؔ࿈ʢbelongs_to, has_one, has_manyʣͷϝιου • ActiveRecord::Enum2ͷϝιου • ύεϔϧύʔʢxxx_pathʣͷRBSΛੜ੒Ͱ͖Δ 2 Enumͷ৽͍͠จ๏ʹ͸ະରԠͳͷͰ஫ҙɻࢀߟ: https://github.com/pocke/rbs_rails/pull/268 26
27. 2. RBS Railsʢpocke/rbs_railsʣ Gemfileʹ௥Ճͯ͠ bundle install Λ࣮ߦ͢Δɻ # Gemfile group :development do gem "rbs_rails", require: false end ͦͯ͠ bin/rails g rbs_rails:install Λ࣮ߦ͢Δɻ $ bin/rails g rbs_rails:install create lib/tasks/rbs.rake 27
28. 3. RBS::Inlineʢsoutaro/rbs-inlineʣ • ίϝϯτͰRBSΛهड़Ͱ͖ Δ • ίϝϯτ͕ແ͍৔߹ͷҾ਺ ͱ໭Γ஋͸ untyped ʹͳΔ class Person attr_reader :name #" String attr_reader :addresses #" Array[String] # @rbs name: String # @rbs addresses: Array[String] # @rbs return: void def initialize(name:, addresses:) @name = name @addresses = addresses end def to_s #" String # ུ end # @rbs &block: (String) -$ void def each_address(&block) #:& void addresses.each(&block) end end 28
29. rbs-inline Ͱੜ੒ͨ͠RBS # Generated from app/models/wiki.rb with RBS:"Inline class Wiki < ApplicationRecord include Redmine:"SafeAttributes def visible?: (?untyped user) -$ untyped # Returns the wiki page that acts as the sidebar content # or nil if no such page exists def sidebar: () -$ untyped # find the page with the given title # if page doesn't exist, return a new page def find_or_new_page: (untyped title) -$ untyped 29
30. 3. RBS::Inlineʢsoutaro/rbs-inlineʣ Gemfileʹ௥Ճͯ͠ bundle install Λ࣮ߦ͢Δɻ # Gemfile group :development do gem "rbs-inline", require: false end 30
31. ! rbs-inlineͷه๏͸RuboCopͱিಥ 31
32. RuboCopͷϧʔϧΛௐ੔3 # rbs-inlinde ͰϝιουͷޙΖʹ `##` Λ࢖͏ͨΊ Style/CommentedKeyword: Enabled: false # rbs-inline Ͱ `##` Λ࢖͏ͨΊ Layout/LeadingCommentSpace: Enabled: false # rbs-inline Ͱ͸ attr_* Λ1ͭͣͭॻ͘ඞཁ͕͋ΔͨΊ Style/AccessorGrouping: Enabled: false 3 Style/CommentedKeyword ͷରԠPR͸طʹ͋Δ https://github.com/rubocop/rubocop/pull/13222 32
33. 4. RBSͷΠϯετʔϧͱੜ੒ 1. gemͷRBS • ruby/gem_rbs_collection͔Βऔಘ͢Δ 2. RailsΞϓϦͷRBS • rbs_rails ͱ rbs-inline Ͱੜ੒͢Δ 33
34. gemͷRBSΛऔಘ͢Δ $ bundle exec rbs collection init created: rbs_collection.yaml $ bundle exec rbs collection install औಘͨ͠RBSΛGitͰ؅ཧ͢Δඞཁ͸͋Γ·ͤΜɻ # .gitignore /.gem_rbs_collection/ 34
35. RBSΛੜ੒͢Δ ίϚϯυΛ࣮ߦͯ͠ sig/rbs_rails ͱ sig/generated ʹ RBSΛੜ੒͠·͢ɻ $ bin/rails rbs_rails:all $ bundle exec rbs-inline -#output -#opt-out app lib 35
36. ! rbs-inline ͷղੳࣦഊ 8 lib/plugins/gravatar/spec/gravatar_spec.rb ͰΤϥ ʔ͕ൃੜ͠·ͨ͠ɻ # rbs_inline: disabled # refs: https:/"github.com/soutaro/rbs-inline/issues/105 require 'rubygems' require 'erb' # to get "h" require 'active_support' # to get "returning" require File.dirname(__FILE__) + '/.'/lib/gravatar' include GravatarHelper, GravatarHelper:)PublicMethods, ERB:)Util 8 https://github.com/soutaro/rbs-inline/issues/105 36
37. ! RakeλεΫ namespace :rbs do task setup: %i[collection rbs_rails:all inline] task update: %i[rbs_rails:all inline] task reset: %i[clean setup] task :collection do sh "rbs", "collection", "install", "-"frozen" end task :inline do sh "rbs-inline", "-"output", "-"opt-out", "app", "lib" end task :clean do sh "rm", "-rf", ".gem_rbs_collection/", "sig/rbs_rails/", "sig/generated/" end end 37
38. ! .gitattributes ੜ੒ͨ͠RBSͷଐੑʹ linguist-generated ʹઃఆ͢Δɻ # .gitattributes sig/generated/**/*.rbs linguist-generated sig/rbs_rails/**/*.rbs linguist-generated GitHubͷPRͰมߋͨ͠ϑΝΠϧΛදࣔ͢Δͱ͖ɺطఆͰ diff ͕ද ࣔ͞Εͳ͘ͳΓ·͢ɻ 38
39. ! .gitattributes 39
40. RBSͷݕূ औಘɾੜ੒ͨ͠RBSΛݕূ͠·͢ɻ $ bundle exec steep validate 1ճͰ੒ޭ͢Δ͜ͱ͸كͰɺ͓ͦΒ͘ʮRBSͷఆ͕ٛ଍Γͳ͍ʯͳ ͲͷΤϥʔ͕ى͖·͢ɻ ! 40
41. Cannot find typeʢඪ४ϥΠϒϥϦʣ rbs_collection.yaml ʹ௥Ճɺ·ͨ͸ແࢹ͠·͢ɻ gems: # - name: csv # - name: yaml # `steep:validate` Ͱ `RBS:"UnsatisfiableTypeApplication` ͕ى͖ΔͷͰແࢹ͢Δ - name: ffi ignore: true 41
42. Cannot find typeʢͦͷଞgemʣ4 sig/generated/redmine/wiki_formatting/markdown/formatter.rbs:6:6: [error] Cannot find type `Redcarpet:$Render:$HTML` │ Diagnostic ID: RBS:$UnknownTypeName │ └ class HTML < Redcarpet:$Render:$HTML ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ sig/generated/redmine/wiki_formatting/markdown/formatter.rbs:6:6: [error] Cannot find type `Redcarpet:$Render:$HTML` │ Diagnostic ID: RBS:$UnknownTypeName │ └ class HTML < Redcarpet:$Render:$HTML ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4 ruby/gem_rbs_collection ʹܕఆ͕ٛͳ͍gem 42
43. Cannot find typeʢͦͷଞgemʣ ඞཁͳΫϥε΍ϞδϡʔϧΛ sig/handwritten/".rbs ʹ࣮૷ ͠·͢ɻ # sig/handwritten/redcarpet.rbs module Redcarpet module Render class HTML end end end 43
44. Non-overloading method definition ਌Ϋϥεͱಉ໊͡લͷϝιουΛఆ͍ٛͯ͠Δ৔߹ʹൃੜ͠· ͢ɻ class Project < ApplicationRecord # @rbs (*__todo__) -$ Project | ..& def self.find(*args) # ..& end end 44
45. Type XXX is generic but used as a non generic type5 ఆ਺ʹArrayͱHashΛ࢖͍ͬͯͯɺ͔ͭ freeze Λ࢖͍ͬͯͳ͍ ৔߹ʹൃੜ͠·͢ɻ - DEFAULT_RULES = [:textile, :markdown] + DEFAULT_RULES = [:textile, :markdown] #" Array[__todo__] 5 https://github.com/soutaro/rbs-inline/pull/104 45
46. ! RBSͷݕূ ͜͜·Ͱͷमਖ਼Ͱݕূ͕௨ΔΑ͏ʹͳΓ·͢ɻ $ bundle exec steep validate $ echo $? 0 46
47. 4. ΤσΟλͷઃఆ • VSCode • soutaro.steep-vscode ͷVSCode֦ு͕ඞཁ • RubyMine • ඪ४ͰRBSʹରԠ 47
48. ! RBSͷಋೖ͕׬ྃ1 1 https://github.com/sinsoku/redmine/tree/setup-rbs 48
49. "ܕ" ͷϝϦοτ • ✅ υΩϡϝϯτ • ✅ ίʔυδϟϯϓ • ✅ ೖྗิ׬ • ⛔ ܕݕࠪʢແޮԽʣ 49
50. ਖ਼͍͠ܕఆٛΛ૿΍͢ 1. ίϝϯτͰܕΛॻ͘6 2. bin/rails rbs:update Λ࣮ߦ͢Δ • sig/**/*.rbs ͕ߋ৽͢Δ 3. steep validate Λ࣮ߦ͢Δ 6 https://github.com/soutaro/rbs-inline/wiki/Syntax-guide 50
53. ஈ֊తʹܕݕࠪΛ༗ޮԽ # Steepfile D = Steep:#Diagnostic strict_paths = ["app/models"] target :app do signature "sig" check "app", "lib" ignore(*strict_paths) configure_code_diagnostics(D:#Ruby.silent) end target :strict do signature "sig" check(*strict_paths) end 53
54. ஈ֊తʹܕݕࠪΛ༗ޮԽ # Steepfile D = Steep:#Diagnostic strict_paths = ["app/models"] target :app do signature "sig" check "app", "lib" ignore(*strict_paths) configure_code_diagnostics(D:#Ruby.silent) end target :strict do signature "sig" check(*strict_paths) end 54
55. "ܕ" ͷϝϦοτ • ✅ υΩϡϝϯτ • ✅ ίʔυδϟϯϓ • ✅ ೖྗิ׬ • " ܕݕࠪʢҰ෦ʣ 55
56. ℹ ·ͱΊ • ஈ֊తͳಋೖͰ͋Ε͹ݱ࣮త • ؆୯ʹಋೖͰ͖Δͱ͸ݴ͑ͳ͍΋ͷͷ • ͥͻRBSΛ৮ͬͯΈͯཉ͍͠ • ίϛϡχςΟ΁ͷϑΟʔυόοΫ΋ཉ͍͠ 56
57. ! rbs-traceͷ঺հ 57
58. ! RBS::Traceʢsinsoku/rbs-traceʣ7 ςετͷ࣮ߦ࣌ʹܕ৘ใΛऩू͠ɺࣗಈతʹrbs-inlineͷίϝϯτ Λૠೖ͢ΔͨΊͷgemͰ͢ɻ • TracePointͰϝιουͷҾ਺ɾฦΓ஋ͷܕΛऩू • PrismͰ໭Γ஋ͷ୅ೖΛ൑ఆ • ໭Γ஋Λ࢖༻͍ͯ͠ͳ͍৔߹͸ void ʹͳΔͨΊ 7 https://github.com/sinsoku/rbs-trace 58
59. ! RBS::Traceͷಋೖखॱ Gemfileʹ௥Ճͯ͠ bundle install Λ࣮ߦ͢Δɻ # Gemfile group :test do gem "rbs-trace" end 59
60. ! RBS::Traceͷಋೖखॱ spec/support/rbs_trace.rb Λ࡞੒͢Δɻ return unless ENV["RBS_TRACE"] RSpec.configure do |config| tracing = RBS:#Trace:#MethodTracing.new config.before(:suite) { tracing.enable } config.after(:suite) do tracing.disable tracing.insert_rbs end end 60
61. ! RBS::Traceͷಋೖखॱ ؀ڥม਺ RBS_TRACE Λࢦఆͯ͠RSpecΛ࣮ߦ͢Δͱɺࣗಈతʹ ܕ৘ใΛίϝϯτͰૠೖ͠·͢ɻ $ RBS_TRACE=1 bundle exec rspec 61
62. ͥͻࢼͯ͠Έ͍ͯͩ͘͞ 62
63. RBSʹؔͯ͠ࠔͬͨͱ͖ • ! ruby-jp Slackͷ #types νϟϯωϧ • https://ruby-jp.github.io/ • ✏ Asakusa-bashi.rbs • https://asakusa-bashi-rbs.connpass.com/ 63