Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

REFACTOR: channel retention reminder text (#20310) 

- Moves logic into one specialised component
- Adds more tests
- Removes duplicate key
- Uses pluralization
- Handles 0 case properly

Co-authored-by: Gerhard Schlager <mail@gerhard-schlager.at>
This commit is contained in:
Joffrey JAFFEUX 2023-02-15 14:50:01 +01:00 committed by GitHub
parent 4d9728d468
commit 075af7ba84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 134 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
plugins/chat/assets/javascripts/discourse/components/chat-channel-settings-view.hbs
View File

@ -60,10 +60,7 @@
{{/unless}}
<div class="chat-retention-info">
{{d-icon "info-circle"}}
{{i18n
"chat.settings.retention_info"
days=this.siteSettings.chat_channel_retention_days
}}
<ChatRetentionReminderText @channel={{this.channel}} />
</div>
</div>

3
plugins/chat/assets/javascripts/discourse/components/chat-retention-reminder-text.hbs Normal file
View File

@ -0,0 +1,3 @@
<span class="chat-retention-reminder-text">
{{this.text}}
</span>

33
plugins/chat/assets/javascripts/discourse/components/chat-retention-reminder-text.js Normal file
View File

@ -0,0 +1,33 @@
import Component from "@glimmer/component";
import I18n from "I18n";
import { inject as service } from "@ember/service";
export default class ChatRetentionReminderText extends Component {
@service siteSettings;
get text() {
if (this.args.channel.isDirectMessageChannel) {
if (this.#countForChannelType > 0) {
return I18n.t("chat.retention_reminders.dm", {
count: this.siteSettings.chat_dm_retention_days,
});
} else {
return I18n.t("chat.retention_reminders.dm_none");
}
} else {
if (this.#countForChannelType > 0) {
return I18n.t("chat.retention_reminders.public", {
count: this.siteSettings.chat_channel_retention_days,
});
} else {
return I18n.t("chat.retention_reminders.public_none");
}
}
}
get #countForChannelType() {
return this.args.channel.isDirectMessageChannel
? this.siteSettings.chat_dm_retention_days
: this.siteSettings.chat_channel_retention_days;
}
}

4
plugins/chat/assets/javascripts/discourse/components/chat-retention-reminder.hbs
View File

@ -1,9 +1,9 @@
{{#if this.show}}
<div class="chat-retention-reminder">
<span class="chat-retention-reminder-text">{{this.text}}</span>
<ChatRetentionReminderText @channel={{this.chatChannel}} />
<DButton
@class="btn-flat dismiss-btn"
@action={{action "dismiss"}}
@action={{this.dismiss}}
@icon="times"
/>
</div>

22
plugins/chat/assets/javascripts/discourse/components/chat-retention-reminder.js
View File

@ -1,6 +1,5 @@
import Component from "@ember/component";
import discourseComputed from "discourse-common/utils/decorators";
import I18n from "I18n";
import { action } from "@ember/object";
import { ajax } from "discourse/lib/ajax";
import { popupAjaxError } from "discourse/lib/ajax-error";
@ -18,30 +17,11 @@ export default Component.extend({
!this.chatChannel.isDraft &&
((this.chatChannel.isDirectMessageChannel &&
this.currentUser.needs_dm_retention_reminder) ||
(!this.chatChannel.isDirectMessageChannel &&
(this.chatChannel.isCategoryChannel &&
this.currentUser.needs_channel_retention_reminder))
);
},
@discourseComputed("chatChannel.chatable_type")
text() {
let days = this.siteSettings.chat_channel_retention_days;
let translationKey = "chat.retention_reminders.public";
if (this.chatChannel.isDirectMessageChannel) {
days = this.siteSettings.chat_dm_retention_days;
translationKey = "chat.retention_reminders.dm";
}
return I18n.t(translationKey, { days });
},
@discourseComputed("chatChannel.chatable_type")
daysCount() {
return this.chatChannel.isDirectMessageChannel
? this.siteSettings.chat_dm_retention_days
: this.siteSettings.chat_channel_retention_days;
},
@action
dismiss() {
return ajax("/chat/dismiss-retention-reminder", {

11
plugins/chat/config/locales/client.en.yml
View File

@ -343,7 +343,6 @@ en:
saved: "Saved"
unfollow: "Leave"
admin_title: "Admin"
retention_info: "Chat history will be saved for %{days} days."
admin:
title: "Chat"
@ -415,8 +414,14 @@ en:
other: "%{commaSeparatedUsernames} and %{count} others are typing"
retention_reminders:
public: "Channel history is retained for %{days} days."
dm: "Personal chat history is retained for %{days} days."
public_none: "Channel history is retained indefinitely."
public:
one: "Channel history is retained for %{count} day."
other: "Channel history is retained for %{count} days."
dm_none: "Personal chat history is retained indefinitely."
dm:
one: "Personal chat history is retained for %{count} day."
other: "Personal chat history is retained for %{count} days."
flags:
off_topic: "This message is not relevant to the current discussion as defined by the channel title, and should probably be moved elsewhere."

25
plugins/chat/test/javascripts/components/chat-channel-settings-view-test.js Normal file
View File

@ -0,0 +1,25 @@
import ChatChannel from "discourse/plugins/chat/discourse/models/chat-channel";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import hbs from "htmlbars-inline-precompile";
import I18n from "I18n";
import { module, test } from "qunit";
import { render } from "@ember/test-helpers";
module(
"Discourse Chat | Component | chat-channel-settings-view",
function (hooks) {
setupRenderingTest(hooks);
test("display retention info", async function (assert) {
this.set("channel", ChatChannel.create({ chatable_type: "Category" }));
await render(hbs`<ChatChannelSettingsView @channel={{this.channel}} />`);
assert.dom(".chat-retention-info").hasText(
I18n.t("chat.retention_reminders.public", {
count: this.siteSettings.chat_channel_retention_days,
})
);
});
}
);

66
plugins/chat/test/javascripts/components/chat-retention-reminder-test.js
View File

@ -1,6 +1,5 @@
import ChatChannel from "discourse/plugins/chat/discourse/models/chat-channel";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import { exists, query } from "discourse/tests/helpers/qunit-helpers";
import hbs from "htmlbars-inline-precompile";
import I18n from "I18n";
import { module, test } from "qunit";
@ -11,70 +10,19 @@ module(
function (hooks) {
setupRenderingTest(hooks);
test("Shows for public channels when user needs it", async function (assert) {
this.set(
"chatChannel",
ChatChannel.create({ chatable_type: "Category" })
);
test("display retention info", async function (assert) {
this.channel = ChatChannel.create({ chatable_type: "Category" });
this.currentUser.set("needs_channel_retention_reminder", true);
this.siteSettings.chat_channel_retention_days = 100;
await render(
hbs`<ChatRetentionReminder @chatChannel={{this.chatChannel}} />`
hbs`<ChatRetentionReminder @chatChannel={{this.channel}} />`
);
assert.strictEqual(
query(".chat-retention-reminder-text").innerText.trim(),
I18n.t("chat.retention_reminders.public", { days: 100 })
assert.dom(".chat-retention-reminder").includesText(
I18n.t("chat.retention_reminders.public", {
count: this.siteSettings.chat_channel_retention_days,
})
);
});
test("Doesn't show for public channels when user has dismissed it", async function (assert) {
this.set(
"chatChannel",
ChatChannel.create({ chatable_type: "Category" })
);
this.currentUser.set("needs_channel_retention_reminder", false);
this.siteSettings.chat_channel_retention_days = 100;
await render(
hbs`<ChatRetentionReminder @chatChannel={{this.chatChannel}} />`
);
assert.false(exists(".chat-retention-reminder"));
});
test("Shows for direct message channels when user needs it", async function (assert) {
this.set(
"chatChannel",
ChatChannel.create({ chatable_type: "DirectMessage" })
);
this.currentUser.set("needs_dm_retention_reminder", true);
this.siteSettings.chat_dm_retention_days = 100;
await render(
hbs`<ChatRetentionReminder @chatChannel={{this.chatChannel}} />`
);
assert.strictEqual(
query(".chat-retention-reminder-text").innerText.trim(),
I18n.t("chat.retention_reminders.dm", { days: 100 })
);
});
test("Doesn't show for dm channels when user has dismissed it", async function (assert) {
this.set(
"chatChannel",
ChatChannel.create({ chatable_type: "DirectMessage" })
);
this.currentUser.set("needs_dm_retention_reminder", false);
this.siteSettings.chat_dm_retention_days = 100;
await render(
hbs`<ChatRetentionReminder @chatChannel={{this.chatChannel}} />`
);
assert.false(exists(".chat-retention-reminder"));
});
}
);

54
plugins/chat/test/javascripts/components/chat-retention-reminder-text-test.js Normal file
View File

@ -0,0 +1,54 @@
import ChatChannel from "discourse/plugins/chat/discourse/models/chat-channel";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import hbs from "htmlbars-inline-precompile";
import I18n from "I18n";
import { module, test } from "qunit";
import { render } from "@ember/test-helpers";
module(
"Discourse Chat | Component | chat-retention-reminder-text",
function (hooks) {
setupRenderingTest(hooks);
test("when setting is set on 0", async function (assert) {
this.channel = ChatChannel.create({ chatable_type: "Category" });
this.siteSettings.chat_channel_retention_days = 0;
await render(
hbs`<ChatRetentionReminderText @channel={{this.channel}} />`
);
assert
.dom(".chat-retention-reminder-text")
.includesText(I18n.t("chat.retention_reminders.public_none"));
});
test("when channel is a public channel", async function (assert) {
const count = 10;
this.channel = ChatChannel.create({ chatable_type: "Category" });
this.siteSettings.chat_channel_retention_days = count;
await render(
hbs`<ChatRetentionReminderText @channel={{this.channel}} />`
);
assert
.dom(".chat-retention-reminder-text")
.includesText(I18n.t("chat.retention_reminders.public", { count }));
});
test("when channel is a DM channel", async function (assert) {
const count = 10;
this.channel = ChatChannel.create({ chatable_type: "DirectMessage" });
this.siteSettings.chat_dm_retention_days = count;
await render(
hbs`<ChatRetentionReminderText @channel={{this.channel}} />`
);
assert
.dom(".chat-retention-reminder-text")
.includesText(I18n.t("chat.retention_reminders.dm", { count }));
});
}
);