Trailblazer - A New Architecture For Rails

Speaker: Nick Sutterer

The Rails Way has accomplished its mission and jump-started thousand and ten-thousands of projects from an initial idea to a running web application, sometimes within weeks. Lots of those projects are still running, however, they have turned into code hells you better not touch or you might break something. This is a result of the lack of abstraction layers in this great framework.

Trailblazer offers you 7 additional places to put your code in a Rails app, comes with a more intuitive file structure and allows you to develop components for a rock-solid system architecture. It's layered design is completely optional and non-intrusive - you pick where you need more abstractions.

Let's explore Trailblazer's concept orientation, new abstractions as view models, form objects, operations and domain layers, representers and more and discuss this new architectural style over a cup of coffee.

Transcript

1. Trailblazer A new architecture for Rails @apotonick
6. Germany World Taiwan
7. Trailblazer A new architecture for Rails @apotonick
9. Model View Controller
10. Model View Controller
11. Model View Controller
13. enterprise bild raumschiff, 3 abstraktionsschichten sind nicht genug für “enterprise” applikationen (verdammt, das ist nunmal, was wir machen!)
17. “Rails is so 2005” @myabc - probably quoting someone else
18. 2005 Rails Innovation
19. 2014 Rails Innovation
20. 2014 Rails Innovation
21. 2005 ActiveRecord Innovation 2014
22. 2014 Rails Innovation
23. LookupContext ActiveJob ActiveModel
24. LookupContext ActiveJob ActiveModel Turbolinks nested_attributes validation context strong_parameters
25. Trailblazer
26. Model Cells Controller Form/ Contract Operation Twin UI API Domain Domain DB
27. app ├── concepts │ ├── comment │ │ ├── cell.rb │ │ ├── views │ │ │ ├── show.haml │ │ │ ├── list.haml │ │ ├── assets │ │ │ ├── comment.css.sass │ │ ├── form.rb │ │ ├── operation.rb │ │ ├── operation │ │ │ ├── create.rb │ │ ├── twin.rb
28. class Comment < ActiveRecord::Base belongs_to :author end
29. Model Operation Domain Domain DB
31. Hi-Level Domains
32. View shop Search cofee shop Add comment Edit your profle Follow shop
33. View shop Search cofee shop Add comment Edit your profle Follow shop
34. API Hi-Level Domain “entry points”
36. “Implementation”
37. Edit yo Edit yo Add cofee shop View shop Add comment Follow shop
38. Web Web API {} Test ! Add comment
39. “Implementation”
40. Controller Model Factory “Service Object”
41. Web Web API {} Test ! Add comment
42. Web Web API {} Test ! Add comment
43. “Operation”
44. module Comment class Create < Trailblazer::Operation def process(params) # ... end end end “Operation”
45. Using Operation.
46. class CommentsController < ApplicationCo def create Comment::Create[params] end # .. end Controller
47. Console 2.1.3 :001 > Comment::Create[{..}]
48. Test Factory let(:comment) { Comment::Create[{..}] }
49. HTTP API Comment::Create::JSON['{..}']
50. Comment::Create[{..}] != Comment.create({..})
51. Web Web API {} Test ! Comment::Create[params]
52. Edit yo Edit yo Shop::Create Shop::Show Comment::Create Shop::Follow
53. op = Comment::Create[{..}]
54. op = Comment::Create.run({..}) do # valid end
55. respond_with Comment::Create.run({..})
56. op = Comment::Create.run({..}) do # valid end
57. Comment::Create
58. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
59. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
60. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
61. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
62. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
63. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
64. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
65. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
66. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
67. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
68. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
69. process Contract validate do save! send_notification! end
70. Model Controller UI API Domain Domain DB
71. Model Form/ Contract Operation UI API Domain Domain DB
72. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
73. 75% CRUD methods do exactly that.
74. Do what you want.
75. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
76. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) @users = Follower.find_for(model) validate do save! send_notification! end end end
77. Render contract.
78. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end end end
79. class CommentsController < ApplicationController def new @form = Comment::Create[params].contract end # .. end Controller *
80. Async.
81. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end
82. module Comment class Create < Trailblazer::Operation class Contract < Reform::Form property :body validates :body, presence: true end include Worker def process(params) # model = Comment.find(params[:id]) validate do save! send_notification! end end
83. Comment::Create[params] bg
84. v
85. Shop::Create Shop::Show Comment::Create Shop::Follow
86. Reform
88. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
89. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
90. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
91. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
92. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
93. # app/models/comment.rb class Comment < ActiveRecord::Base attr_accessible :author_attributes, :body accepts_nested_attributes_for :author validates :author, :body, :presence => true, :unless => :notification? before_validation :no_create_when_closed, :on => :create, :if => :forum? end
94. params.require(:comment).permit(:body) strong_parameters
95. Model Controller
96. Form object
97. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
98. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
99. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
100. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
101. Strong what?
102. form.validate( body: "Cool!", eviiiiiiiiiiil: 0x13370x1337 )
103. form.validate( body: "Cool!", eviiiiiiiiiiil: 0x13370x1337 ) class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
104. Test.
105. # spec/comment/form_spec.rb let(:comment) { Comment.new } let(:form) { Comment::Form.new(comment) } it do form.validate( body: "Cool!", author: {email: "ryan@bigg.com.au"} ).must_equal true form.save comment.email.must_equal "ryan@bigg.com.au" end
106. # spec/comment/form_spec.rb let(:comment) { Comment.new } let(:form) { Comment::Form.new(comment) } it do form.validate( body: "Cool!", author: {email: "ryan@bigg.com.au"} ).must_equal true form.save comment.email.must_equal "ryan@bigg.com.au" end *
107. # spec/comment/form_spec.rb let(:comment) { Comment.new } let(:form) { Comment::Form.new(comment) } it do form.validate( body: "Cool!", author: {email: "ryan@bigg.com.au"} ).must_equal true form.save comment.email.must_equal "ryan@bigg.com.au" end
108. # spec/comment/form_spec.rb # invalid it do form.validate( body: "Cool!", ).must_equal false form.errors.must_equal {author: ["can't be blank"]} end *
109. # spec/comment/form_spec.rb # invalid it do form.validate( body: "Cool!", ).must_equal false form.errors.must_equal {author: ["can't be blank"]} end
110. #new #errors #validate #save
111. Rendering.
112. # app/controllers/comments_controller.rb def new @form = Comment::Form.new(Comment.new) end # app/views/comments/new.html.haml = simple_form_for(@form) do |f| = f.input :body
113. # app/controllers/comments_controller.rb def new @form = Comment::Form.new(Comment.new) end # app/views/comments/new.html.haml = simple_form_for(@form) do |f| = f.input :body
114. # app/controllers/comments_controller.rb def new @form = Comment::Form.new(Comment.new) end def new @form = Comment::Create.contract end
115. # app/controllers/comments_controller.rb def new @form = Comment::Form.new(Comment.new) end def new @form = Comment::Create.contract end
116. Model UI Controller Form
117. Model UI Controller Form
118. Model UI Controller Form Form
119. Model UI Controller Model Form
120. Model Model Form
121. Comment::Form.new( comment: Comment.new, topic: Topic.find(1) ) Model Model Form
122. Comment::Form.new( comment: Comment.new, topic: Topic.find(1) ) Model Model Form
123. Model Model Form class Comment::TopicForm < Reform::Form property :body, on: :comment property :title, on: :topic validates :title, :body, presence: true end
124. Model Model Form class Comment::TopicForm < Reform::Form property :body, on: :comment property :title, on: :topic validates :title, :body, presence: true end
125. Forms do JSON*.
126. form.validate( body: "Cool!", author: {email: "ryan@bigg.com.au"} )
127. form.validate( "{\"body\":\"Cool!\",\"author\": {\"email\":\"ryan@bigg.com.au\"}}" )
128. Really?
129. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
130. # app/concepts/comment/form.rb class Comment::Form < Reform::Form property :body property :author do property :email validates :email, presence: true end validates :author, :body, presence: true end
131. form.validate( "{\"body\":\"Cool!\",\"author\": {\"email\":\"ryan@bigg.com.au\"}}" ) Representable form.validate( body: "Cool!", author: {email: "ryan@bigg.com.au"} )
132. validate Form Model Form Model Form Model Form Model #new deserialize/ populate #save
133. Cells
137. # app/views/comments/index.html.haml = render_comment(comment)
139. # app/views/comments/index.html.haml = render_comment(comment)
140. # app/helpers/comments_helper.rb def render_comment(comment) render partial: “shared/comment” end
141. # app/helpers/comments_helper.rb def render_comment(comment) render partial: “shared/comment”, locals: {comment: comment} end
142. # app/helpers/comments_helper.rb def render_comment(comment) is_owner = (comment.author == current_user) render partial: “shared/comment”, locals: {comment: comment} end
143. # app/helpers/comments_helper.rb def render_comment(comment) is_owner = (comment.author == current_user) render partial: “shared/comment”, locals: {comment: comment, is_owner: is_owner} end
144. # app/helpers/comments_helper.rb def render_comment(comment, env=:shared) is_owner = (comment.author == current_user) render partial: “shared/comment”, locals: {comment: comment, is_owner: is_owner} end
145. # app/helpers/comments_helper.rb def render_comment(comment, env=:shared) is_owner = (comment.author == current_user) render partial: "#{env}/comment", locals: {comment: comment, is_owner: is_owner} end
146. # app/helpers/comments_helper.rb def render_comment(comment, env=:shared) is_owner = (comment.author == current_user) render partial: "#{env}/comment", locals: {comment: comment, is_owner: is_owner} end
147. render partial: "#{env}/comment", locals: {comment: comment, is_owner: is_owner}
148. # app/views/shared/_comment.html.haml .comment .text = comment.body .author = image_tag comment.image.url
149. # app/views/shared/_comment.html.haml .comment .text = comment.body .author - type = comment.staff? ? :thumb : :staff = image_tag comment.image.url
150. # app/views/shared/_comment.html.haml .comment .text = comment.body .author - type = comment.staff? ? :thumb : :staff = image_tag comment.image.url
152. # app/views/comments/index.html.haml = cell("comment/cell", comment)
153. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end
154. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end
155. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end
156. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end # app/concepts/comment/views/show.haml %h1 Hello, Taiwan!
157. = cell("comment/cell", comment)
158. MVC!
161. # app/views/comments/index.html.haml = cell("comment/cell", comment)
162. # app/views/comments/index.html.haml = cell("comment/cell", comment) # spec/comment/cell_spec.rb it do cell("comment/cell", comment).to_s. includes "Taiwan" end
163. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end # app/concepts/comment/views/show.haml %h1 Hello, Taiwan!
164. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end # app/concepts/comment/views/show.haml .comment .text = body .author = avatar
165. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end # app/concepts/comment/views/show.haml .comment .text = body .author = avatar
166. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end end # app/concepts/co .comment .text = body .author = avatar
167. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private def body end end # app/concepts/co .comment .text = body .author = avatar
168. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private def body model.body end end # app/concepts/co .comment .text = body .author = avatar
169. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private def body model.body end def avatar image_tag model.image.url end end # app/concepts/co .comment .text = body .author = avatar
170. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private def body model.body end def avatar image_tag model.image.url end end # app/concepts/co .comment .text = body .author = avatar
171. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private property :body def avatar image_tag model.image.url end end # app/concepts/co .comment .text = body .author = avatar
172. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel def show render end private property :body property :image def avatar image_tag model.image.url end end # app/concepts/co .comment .text = body .author = avatar
173. # app/concepts/comment/cell.rb class Comment::Cell < Cell::ViewModel property :body property :image def show render end private def avatar image_tag image.url end end # app/concepts/co .comment .text = body .author = avatar
174. # app/helpers/comments_hel def render_comment(comment is_owner = (comment.auth render partial: “shared/ locals: {comment is_owne end
175. # app/concepts/comment/cel class Comment::Cell < Cell property :body property :image def show render end private def avatar image_tag image.url end end
176. Features: No AV (probably in Rails 5.0) Layouts Caching View inheritance 3x faster (even though we create “thousands of objects”) collection rendering polymorphic cells Wrong Font TM
177. Add shop Cell::ViewModel Reform::Form Disposable::Twin Roar::Representer Model Cells Controller Form/ Contract Operation Twin UI API Domain Domain DB
178. apotonick/trailblazer @apotonick apotonick/gemgem