IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-29 20:24:05 -06:00
Code Issues Packages Projects Releases Wiki Activity
589add7bb5
discourse/documentation/index.html

126 lines
3.2 KiB
HTML
Raw Normal View History

DEV: Chat service object initial implementation (#19814) This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux. --- This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project. Working with services generally involves 3 parts: - The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy) ```ruby class UpdateAge include Chat::Service::Base model :user, :fetch_user policy :can_see_user contract step :update_age class Contract attribute :age, :integer end def fetch_user(user_id:, **) User.find_by(id: user_id) end def can_see_user(guardian:, **) guardian.can_see_user(user) end def update_age(age:, **) user.update!(age: age) end end ``` - The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller ```ruby def update with_service(UpdateAge) do on_success { render_serialized(result.user, BasicUserSerializer, root: "user") } end end ``` - Rspec matchers and steps inspector, improving the dev experience while creating specs for a service ```ruby RSpec.describe(UpdateAge) do subject(:result) do described_class.call(guardian: guardian, user_id: user.id, age: age) end fab!(:user) { Fabricate(:user) } fab!(:current_user) { Fabricate(:admin) } let(:guardian) { Guardian.new(current_user) } let(:age) { 1 } it { expect(user.reload.age).to eq(age) } end ``` Note in case of unexpected failure in your spec, the output will give all the relevant information: ``` 1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user' Failure/Error: it { is_expected.to fail_to_find_a_model(:user) } Expected model 'foo' (key: 'result.model.user') was not found in the result object. [1/4] [model] 'user' ❌ [2/4] [policy] 'can_see_user' [3/4] [contract] 'default' [4/4] [step] 'update_age' /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError) from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run' from <internal:kernel>:90:in `tap' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>' ```
2023-02-13 06:09:57 -06:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<link rel="shortcut icon" href="assets/favicon.ico">
<link rel="icon" href="assets/favicon.png">
<link rel="apple-touch-icon" href="assets/favicon.png">
<meta content="en" name="language">
<meta content="width=device-width, initial-scale=1" name="viewport">
<meta name="robots" content="noindex,nofollow,noarchive">
<title>Discourse documentation | Discourse - Civilized Discussion</title>
<style>
body { background: white; }
* , *:before, *:after {
box-sizing: border-box;
margin: 0;
padding: 0;
font-family: "Rubik", Helvetica, Arial, sans-serif;
}
h1 {
color: #111;
font-weight: 700;
}
h1 a, h1 a:visited {
background-image: url(assets/highlight.png);
background-size: contain;
background-position: bottom;
background-repeat: no-repeat;
color: black;
text-decoration: none;
}
a, a:visited {
color: rgb(14, 118, 178);
text-decoration: none;
}
.site-header-navigation__container {
display: flex;
justify-content: space-between;
align-items: center;
margin: 0 auto;
padding: 0 2em;
}
.content-header {
text-align: center;
margin-bottom: 5em;
}
.content {
background-image: url(assets/blobs.svg);
background-position: top center;
background-repeat: no-repeat;
background-size: 100% auto;
overflow: hidden;
text-align: center;
position: relative;
width: 100%;
min-height: 600px;
display: flex;
justify-content: center;
}
.content__wrapper {
padding: 0 2em;
}
.projects-list {
padding: 2em;
border-radius: 15px;
position: relative;
background-image: url(assets/blob-wide-yellow3.svg);
background-position: top center;
background-repeat: no-repeat;
background-size: 100% auto;
min-height: 400px;
width: 400px;
}
.projects-list__item {
list-style: none;
}
</style>
</head>
<body>
<header role="banner" class="site-header-navigation">
<div class="site-header-navigation__container">
<div class="site-header-navigation__logo">
<a href="https://discourse.github.io/discourse">
<svg width="385" height="104" viewBox="0 0 300 40">
<use xlink:href="assets/logo.svg#logo-large"></use>
</svg>
</a>
</div>
</div>
</header>
<header class="content-header">
<div class="content__wrapper">
<h1><a href="https://www.discourse.org">Discourse</a> projects documentation</h1>
</div>
</header>
<main class="content">
<div class="content__wrapper">
<ul class="projects-list">
<li class="projects-list__item">
<h4>Chat</h4>
<p>
<a href="chat/backend/index.html">Backend</a>
<span> - </span>
<a href="chat/frontend/index.html">Frontend</a>
</p>
</li>
</ul>
</div>
</main>
</body>
</html>
Reference in New Issue Copy Permalink