Not the Rails Way

Ruby on Rails architecture practices

Transcript

1. Игорь Александров jetrockets.pro github.com/jetrockets
2. • Пишу на Rails c 2008 года • Начал с Rails 2.2 • Пришел в Ruby из SmallTalk • Последние 5 лет слышу “Ruby/Rails мертв”
4. Not the Rails Way…
11. Ruby on Rails разработчики валят с проекта George Catlin, 1832 after_save… after_commit on:… accepts_nested_attributes_for… validates_presence_of…
12. Пример…
13. Приложение – цепочка сервисов
14. Запрос => [*] => [*] => Ответ
15. Приложение – цепочка функций
16. class CreateDocument … end
17. class CreateDocument def call … end end
18. class CreateDocument def call(document, params) … end end
19. class CreateDocument def call(document, params) document.attributes = params document.save! end end
20. class CreateDocument def call(document, params) document.attributes = params if document.valid? rename_document(document) end document.save! end end
21. • Единый интерфейс сервисов • Частично избавились от колбеков • Тестирование функциональных объектов – проще • Композиция сервисов Что стало лучше?
22. Проблемы • Валидации остались в моделях: document.save(validate: false) # OR document.from_crm = true document.save • Композиция сервисов получалась не всегда, получалось дублирование • Тестирование не стало проще из-за невозможности управлять зависимостями • Не получалось сделать композицию объектов (Domain)
23. Form Object
25. Reform http://trailblazer.to/gems/reform/
26. class CreateDocument def call(document, params) form = CreateDocumentForm.new(document) if form.validate(params) document = form.sync rename_document(document) end document.save! end end
27. class CreateDocument def call(document, params) form = CreateDocumentForm.new(document) if form.validate(params) rename_document(document) end document.save! end end
28. class CreateDocument def initialize(form_class:, rename_document:) … end def call(document, params) … end end
29. class CreateDocument attr_reader :form_class attr_reader :rename_document def initialize(form_class:, rename_document:) @form_class = form_class @rename_document = rename_document end def call(document, params) … end end
30. class CreateDocument def call(document, params) form = form_class.new(document) if form.validate(params) document = form.sync rename_document(document) document.save! end document end end
31. # Initialize command = CreateDocument.new( form_class: Document::CreateDocumentForm, rename_document: Document::RenameDocument.new ) # Use several times command.call(passport, params[:passport]) command.call(visa, params[:visa])
32. # создание документа от заёмщика command = CreateDocument.new( form_class: Document::CreateDocumentForm, rename_document: Document::RenameDocument.new ) # создания документа из CRM command = CreateDocument.new( form_class: Crm::Document::CreateDocumentForm.new, rename_document: Document::RenameDocument.new )
33. class CreateDocument attr_reader :form attr_reader :rename_document attr_reader :upload_document_to_perfect_audit … end
34. Увеличение зависимостей # Document::CreateDocumentForm form_class # Document::RenameDocument rename_document(document) # Document::PerfectAuditUploader upload_document_to_perfect_audit(document)
35. class CreateDocument attr_reader :form_class attr_reader :rename_document attr_reader :upload_document_to_perfect_audit attr_reader :update_expiration_dates attr_reader :convert_document_to_pdf attr_reader :create_affiliations attr_reader :update_cpl_records attr_reader :update_application_status # hundreds of other stuff here … end
37. dry-rb
38. dry-rb 18 библиотек Каждая библиотека служит своей цели
39. • IoC Container • Позволяет реализовать Dependency inversion principle • Thread safe dry-container
40. dry-container # app/containers/global_container.rb module GlobalContainer extend Dry::Container::Mixin namespace('services') do register('create_document') do Document::CreateDocument.new( self[‘forms.create_document_form_class'] ) end end namespace('forms') do register('create_document_form_class') do Document::DocumentForm end end end
41. dry-container # создание документа от заёмщика command = GlobalContainer[‘services.create_document’] command.form # Document::CreateDocumentForm command.class # Document::CreateDocument # создания документа из CRM command = GlobalContainer[‘crm.services.create_document’] command.form # Crm::Document::CreateDocumentForm command.class # Document::CreateDocument
42. dry-container # создание документа от заёмщика command = GlobalContainer[‘services.create_document’] command.form # Document::CreateDocumentForm command.class # Document::CreateDocument # создания документа из CRM command = GlobalContainer[‘crm.services.create_document’] command.form # Crm::Document::CreateDocumentForm command.class # Document::CreateDocument
43. dry-monads • Монада – контейнер, в котором есть результат с объектом • Either монада (классическая) – это Result монада в dry-rb • [паттерн] позволяет делать chaining • Синтаксический сахар
44. Maybe # corporate_action/charts_mapper.rb class CorporateAction::ChartsMapper include Dry::Monads::Maybe::Mixin def fetch_mapping(corporate_action, fund, entry) Maybe( # some calculation that may return nil ) end end # fund/calculate_share_price.rb mapping = mapper.fetch_mapping(action, fund, entry) mapping.bind do |m| calculate_price_by_valuation_amount(fund, m)) end.or(issue_price_of_account(account)))
45. Result class CreateDocument def call(document, params) form = form_class.new(document) if form.validate(params) document = form.sync rename_document(document) document.save! end document end end
46. Result class CreateDocument def call(document, params) form = form_class.new(document) if form.validate(params) document = form.sync rename_document(document) document.save! else return false end document end end
47. Result class CreateDocument include Dry::Monads::Result::Mixin def call(document, params) form = form_class.new(document) if form.validate(params) … document.save! else return Failure(form) end Success(document) rescue => e Failure(e) end end
48. Try class CreateDocument include Dry::Monads::Result::Mixin include Dry::Monads::Try::Mixin … def call(document, params) form = form_class.new(document) if form.validate(params) Try do document.save! … document end.to_either else Failure(form) end end end
49. dry-matcher • pattern matching • Синтаксический сахар • Есть встроенный Result Matcher • Можно написать свой
50. dry-matcher class CreateDocument include Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher) … def call(document, params) form = form_class.new(document) if form.validate(params) Try do document.save! … document end.to_either else Failure(form) end end end
51. dry-matcher command = GlobalContainer[‘services.create_document’] command.call(document, params[:document]) do |m| m.success do |document| render json: { document: DocumentRepresenter.new.call(document) } end m.failure do |form| render_failure_json( 422, document: form.react_errors_hash ) end end
52. dry-matcher (custom) class CreateDocument include Dry::Matcher.for(:call, with: TripleMatcher) … def call(document, params) form = form_class.new(document) if form.validate(params) … document.save! [:success, document] else [:failure, :validation, form] end rescue => e [:failure, e] end end
53. dry-matcher (custom) command = GlobalContainer[‘services.create_document’] command.call(document, params[:document]) do |m| m.success do |document| … end m.failure :validation do |form| render_failure_json( 422, document: form.react_errors_hash ) end m.failure do |e| render_failure_json(500, document: e.message) end end
54. • Валидации основаны на логике предикатов • Работают с любыми типами входных данных • Можно валидировать формы, HTTP параметры, JSON документы, конфигурацию из YAML • Расширяемость • Широко используются в других библиотеках dry-validation & dry-types
55. dry-initializer • param и option • default values • type constraints • private/protected readers
56. dry-initializer class CreateDocument attr_reader :form_class attr_reader :rename_document def initialize(form_class:, rename_document:) @form_class = form_class @rename_document = rename_document end def call(document, params) … end end
57. dry-initializer class CreateDocument extend Dry::Initializer param :form_class param :rename_document def initialize(form_class:, rename_document:) @form_class = form_class @rename_document = rename_document end def call(document, params) … end end
58. RSpec describe Document::CreateDocument do subject(:command) do GlobalContainer[ ‘services.create_document_command' ] end … end Что мы тестируем?
59. RSpec / Stubs require ‘dry/container/stub' describe "#call" do before(:all) do GlobalContainer.enable_stubs! end … GlobalContainer.stub( ‘support.services.exception_notifier’, ExceptionRaiser ) end
60. Итоги
61. Плюсы • тестирование функциональных объектов • простое расширение логики • композиция – основа моделирования процессов • масштабирование и слабая связанность компонентов приложения
62. Минусы • имитация функций объектами • концептуально множатся сущности (которые не являются сущностями по факту) • IoC с доступом по строкам • можно написать монадический метод и вернуть не монадическое значение
63. Спасибо github.com/igor-alexandrov facebook.com/igor.alexandrov twitter.com/igor_alexandrov