2018-06-08 17:49:31 +08:00
|
|
|
app/assets/stylesheets/vendor/
|
|
|
|
|
plugins/**/assets/stylesheets/vendor/
|
2020-08-20 18:36:52 +08:00
|
|
|
plugins/**/assets/javascripts/vendor/
|
2022-01-13 16:13:51 +08:00
|
|
|
plugins/**/config/locales/**/*.yml
|
|
|
|
|
plugins/**/config/*.yml
|
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 20:09:57 +08:00
|
|
|
documentation/
|
2018-07-04 16:35:40 +08:00
|
|
|
package.json
|
2019-01-18 02:05:39 +08:00
|
|
|
config/locales/**/*.yml
|
2019-05-21 05:21:43 +08:00
|
|
|
!config/locales/**/*.en*.yml
|
2019-05-06 18:37:19 +08:00
|
|
|
script/import_scripts/**/*.yml
|
2020-08-25 17:40:40 +08:00
|
|
|
|
2021-03-19 01:09:01 +08:00
|
|
|
app/assets/javascripts/browser-update.js
|
2020-08-25 17:40:40 +08:00
|
|
|
app/assets/javascripts/ember-addons/
|
|
|
|
|
app/assets/javascripts/discourse/lib/autosize.js
|
|
|
|
|
lib/javascripts/locale/
|
|
|
|
|
lib/javascripts/messageformat.js
|
|
|
|
|
lib/highlight_js/
|
|
|
|
|
plugins/**/lib/javascripts/locale
|
|
|
|
|
public/
|
2022-08-23 17:25:07 +08:00
|
|
|
!/app/assets/javascripts/discourse/public
|
2020-08-25 17:40:40 +08:00
|
|
|
vendor/
|
2024-01-02 18:44:26 +08:00
|
|
|
!app/assets/javascripts/ember-production-deprecations/vendor/
|
2020-08-25 17:40:40 +08:00
|
|
|
app/assets/javascripts/discourse/tests/fixtures
|
2022-05-04 23:37:01 +08:00
|
|
|
spec/
|
2020-08-25 17:40:40 +08:00
|
|
|
node_modules/
|
|
|
|
|
dist/
|
2022-07-06 16:37:54 +08:00
|
|
|
tmp/
|
|
|
|
|
|
2020-10-13 13:56:03 +08:00
|
|
|
**/*.rb
|
2022-07-06 16:37:54 +08:00
|
|
|
**/*.html
|
|
|
|
|
**/*.json
|
|
|
|
|
**/*.md
|