2019-04-29 20:27:42 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
RSpec.describe WordWatcher do
|
2022-08-02 04:06:03 -04:00
|
|
|
let(:raw) { <<~RAW.strip }
|
|
|
|
Do you like liquorice?
|
|
|
|
|
|
|
|
|
|
|
|
I really like them. One could even say that I am *addicted* to liquorice. And if
|
|
|
|
you can mix it up with some anise, then I'm in heaven ;)
|
|
|
|
RAW
|
2017-06-28 16:56:44 -04:00
|
|
|
|
2020-05-23 00:56:13 -04:00
|
|
|
after { Discourse.redis.flushdb }
|
2017-06-28 16:56:44 -04:00
|
|
|
|
2022-08-02 04:06:03 -04:00
|
|
|
describe ".words_for_action" do
|
|
|
|
it "returns words with metadata including case sensitivity flag" do
|
|
|
|
Fabricate(:watched_word, action: WatchedWord.actions[:censor])
|
|
|
|
word1 = Fabricate(:watched_word, action: WatchedWord.actions[:block]).word
|
|
|
|
word2 =
|
|
|
|
Fabricate(:watched_word, action: WatchedWord.actions[:block], case_sensitive: true).word
|
|
|
|
|
|
|
|
expect(described_class.words_for_action(:block)).to include(
|
|
|
|
word1 => {
|
|
|
|
case_sensitive: false,
|
|
|
|
},
|
|
|
|
word2 => {
|
|
|
|
case_sensitive: true,
|
|
|
|
},
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "returns word with metadata including replacement if word has replacement" do
|
|
|
|
word =
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
action: WatchedWord.actions[:link],
|
|
|
|
replacement: "http://test.localhost/",
|
|
|
|
).word
|
|
|
|
|
|
|
|
expect(described_class.words_for_action(:link)).to include(
|
|
|
|
word => {
|
|
|
|
case_sensitive: false,
|
|
|
|
replacement: "http://test.localhost/",
|
|
|
|
},
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "returns an empty hash when no words are present" do
|
|
|
|
expect(described_class.words_for_action(:tag)).to eq({})
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe ".word_matcher_regexp_list" do
|
2019-07-22 07:59:56 -04:00
|
|
|
let!(:word1) { Fabricate(:watched_word, action: WatchedWord.actions[:block]).word }
|
|
|
|
let!(:word2) { Fabricate(:watched_word, action: WatchedWord.actions[:block]).word }
|
2022-08-02 04:06:03 -04:00
|
|
|
let!(:word3) do
|
|
|
|
Fabricate(:watched_word, action: WatchedWord.actions[:block], case_sensitive: true).word
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2022-08-02 04:06:03 -04:00
|
|
|
let!(:word4) do
|
|
|
|
Fabricate(:watched_word, action: WatchedWord.actions[:block], case_sensitive: true).word
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2019-07-22 07:59:56 -04:00
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "when watched_words_regular_expressions = true" do
|
|
|
|
it "returns the proper regexp" do
|
2019-07-22 07:59:56 -04:00
|
|
|
SiteSetting.watched_words_regular_expressions = true
|
2022-08-02 04:06:03 -04:00
|
|
|
regexps = described_class.word_matcher_regexp_list(:block)
|
|
|
|
|
|
|
|
expect(regexps).to be_an(Array)
|
|
|
|
expect(regexps.map(&:inspect)).to contain_exactly(
|
|
|
|
"/(#{word1})|(#{word2})/i",
|
|
|
|
"/(#{word3})|(#{word4})/",
|
|
|
|
)
|
2019-07-22 07:59:56 -04:00
|
|
|
end
|
2022-07-27 12:14:14 -04:00
|
|
|
end
|
2019-07-22 07:59:56 -04:00
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "when watched_words_regular_expressions = false" do
|
|
|
|
it "returns the proper regexp" do
|
2019-07-22 07:59:56 -04:00
|
|
|
SiteSetting.watched_words_regular_expressions = false
|
2022-08-02 04:06:03 -04:00
|
|
|
regexps = described_class.word_matcher_regexp_list(:block)
|
|
|
|
|
|
|
|
expect(regexps).to be_an(Array)
|
|
|
|
expect(regexps.map(&:inspect)).to contain_exactly(
|
|
|
|
"/(?:\\W|^)(#{word1}|#{word2})(?=\\W|$)/i",
|
|
|
|
"/(?:\\W|^)(#{word3}|#{word4})(?=\\W|$)/",
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "is empty for an action without watched words" do
|
|
|
|
regexps = described_class.word_matcher_regexp_list(:censor)
|
|
|
|
|
|
|
|
expect(regexps).to be_an(Array)
|
|
|
|
expect(regexps).to be_empty
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when regular expression is invalid" do
|
|
|
|
before do
|
|
|
|
SiteSetting.watched_words_regular_expressions = true
|
|
|
|
Fabricate(:watched_word, word: "Test[\S*", action: WatchedWord.actions[:block])
|
|
|
|
end
|
|
|
|
|
|
|
|
it "does not raise an exception by default" do
|
|
|
|
expect { described_class.word_matcher_regexp_list(:block) }.not_to raise_error
|
|
|
|
end
|
|
|
|
|
|
|
|
it "raises an exception with raise_errors set to true" do
|
|
|
|
expect {
|
|
|
|
described_class.word_matcher_regexp_list(:block, raise_errors: true)
|
|
|
|
}.to raise_error(RegexpError)
|
2019-07-22 07:59:56 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
describe "#word_matches_for_action?" do
|
2017-06-28 16:56:44 -04:00
|
|
|
it "is falsey when there are no watched words" do
|
2022-07-26 11:15:42 -04:00
|
|
|
expect(described_class.new(raw).word_matches_for_action?(:require_approval)).to be_falsey
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
context "with watched words" do
|
2019-05-06 23:12:20 -04:00
|
|
|
fab!(:anise) do
|
|
|
|
Fabricate(:watched_word, word: "anise", action: WatchedWord.actions[:require_approval])
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2017-06-28 16:56:44 -04:00
|
|
|
|
|
|
|
it "is falsey without a match" do
|
2022-07-26 11:15:42 -04:00
|
|
|
expect(
|
|
|
|
described_class.new("No liquorice for me, thanks...").word_matches_for_action?(
|
|
|
|
:require_approval,
|
2023-01-09 06:18:21 -05:00
|
|
|
),
|
2022-07-26 11:15:42 -04:00
|
|
|
).to be_falsey
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
it "is returns matched words if there's a match" do
|
2022-07-26 11:15:42 -04:00
|
|
|
matches = described_class.new(raw).word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches).to be_truthy
|
|
|
|
expect(matches[1]).to eq(anise.word)
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
it "finds at start of string" do
|
2022-07-26 11:15:42 -04:00
|
|
|
matches =
|
|
|
|
described_class.new("#{anise.word} is garbage").word_matches_for_action?(
|
|
|
|
:require_approval,
|
|
|
|
)
|
|
|
|
expect(matches[1]).to eq(anise.word)
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
it "finds at end of string" do
|
2022-07-26 11:15:42 -04:00
|
|
|
matches =
|
|
|
|
described_class.new("who likes #{anise.word}").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[1]).to eq(anise.word)
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
it "finds non-letters in place of letters" do
|
|
|
|
Fabricate(:watched_word, word: "co(onut", action: WatchedWord.actions[:require_approval])
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("This co(onut is delicious.").word_matches_for_action?(
|
|
|
|
:require_approval,
|
|
|
|
)
|
|
|
|
expect(matches[1]).to eq("co(onut")
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
it "handles * for wildcards" do
|
|
|
|
Fabricate(:watched_word, word: "a**le*", action: WatchedWord.actions[:require_approval])
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("I acknowledge you.").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[1]).to eq("acknowledge")
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
2017-09-27 15:48:57 -04:00
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
it "handles word boundary" do
|
|
|
|
Fabricate(:watched_word, word: "love", action: WatchedWord.actions[:require_approval])
|
|
|
|
expect(
|
|
|
|
described_class.new("I Love, bananas.").word_matches_for_action?(:require_approval)[1],
|
|
|
|
).to eq("Love")
|
|
|
|
expect(
|
|
|
|
described_class.new("I LOVE; apples.").word_matches_for_action?(:require_approval)[1],
|
|
|
|
).to eq("LOVE")
|
|
|
|
expect(
|
|
|
|
described_class.new("love: is a thing.").word_matches_for_action?(:require_approval)[1],
|
|
|
|
).to eq("love")
|
|
|
|
expect(
|
|
|
|
described_class.new("I love. oranges").word_matches_for_action?(:require_approval)[1],
|
|
|
|
).to eq("love")
|
|
|
|
expect(
|
|
|
|
described_class.new("I :love. pineapples").word_matches_for_action?(:require_approval)[1],
|
|
|
|
).to eq("love")
|
|
|
|
expect(
|
|
|
|
described_class.new("peace ,love and understanding.").word_matches_for_action?(
|
|
|
|
:require_approval,
|
|
|
|
)[
|
2023-01-09 06:18:21 -05:00
|
|
|
1
|
|
|
|
],
|
2022-07-27 12:14:14 -04:00
|
|
|
).to eq("love")
|
2019-02-17 23:24:27 -05:00
|
|
|
end
|
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "when there are multiple matches" do
|
|
|
|
context "with non regexp words" do
|
2019-07-22 07:59:56 -04:00
|
|
|
it "lists all matching words" do
|
|
|
|
%w[bananas hate hates].each do |word|
|
|
|
|
Fabricate(:watched_word, word: word, action: WatchedWord.actions[:block])
|
|
|
|
end
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("I hate bananas").word_matches_for_action?(
|
|
|
|
:block,
|
|
|
|
all_matches: true,
|
|
|
|
)
|
2019-07-22 07:59:56 -04:00
|
|
|
expect(matches).to contain_exactly("hate", "bananas")
|
2023-01-09 06:18:21 -05:00
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
matches =
|
|
|
|
described_class.new("She hates bananas too").word_matches_for_action?(
|
|
|
|
:block,
|
|
|
|
all_matches: true,
|
|
|
|
)
|
2019-07-22 07:59:56 -04:00
|
|
|
expect(matches).to contain_exactly("hates", "bananas")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "with regexp words" do
|
2019-07-22 07:59:56 -04:00
|
|
|
before { SiteSetting.watched_words_regular_expressions = true }
|
|
|
|
|
|
|
|
it "lists all matching patterns" do
|
|
|
|
Fabricate(:watched_word, word: "(pine)?apples", action: WatchedWord.actions[:block])
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: "((move|store)(d)?)|((watch|listen)(ed|ing)?)",
|
|
|
|
action: WatchedWord.actions[:block],
|
|
|
|
)
|
2023-01-09 06:18:21 -05:00
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
matches =
|
|
|
|
described_class.new("pine pineapples apples").word_matches_for_action?(
|
|
|
|
:block,
|
|
|
|
all_matches: true,
|
|
|
|
)
|
2019-07-22 07:59:56 -04:00
|
|
|
expect(matches).to contain_exactly("pineapples", "apples")
|
2023-01-09 06:18:21 -05:00
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
matches =
|
|
|
|
described_class.new(
|
|
|
|
"go watched watch ed ing move d moveed moved moving",
|
|
|
|
).word_matches_for_action?(:block, all_matches: true)
|
2019-07-22 07:59:56 -04:00
|
|
|
expect(matches).to contain_exactly(*%w[watched watch move moved])
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "when word is an emoji" do
|
2019-02-15 10:25:48 -05:00
|
|
|
it "handles emoji" do
|
|
|
|
Fabricate(:watched_word, word: ":joy:", action: WatchedWord.actions[:require_approval])
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Lots of emojis here :joy:").word_matches_for_action?(
|
|
|
|
:require_approval,
|
|
|
|
)
|
|
|
|
expect(matches[1]).to eq(":joy:")
|
2019-02-15 10:25:48 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
it "handles unicode emoji" do
|
|
|
|
Fabricate(:watched_word, word: "🎃", action: WatchedWord.actions[:require_approval])
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Halloween party! 🎃").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[1]).to eq("🎃")
|
2019-02-15 10:25:48 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
it "handles emoji skin tone" do
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: ":woman:t5:",
|
|
|
|
action: WatchedWord.actions[:require_approval],
|
|
|
|
)
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("To Infinity and beyond! 🚀 :woman:t5:").word_matches_for_action?(
|
|
|
|
:require_approval,
|
|
|
|
)
|
|
|
|
expect(matches[1]).to eq(":woman:t5:")
|
2019-02-15 10:25:48 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-07-27 12:14:14 -04:00
|
|
|
context "when word is a regular expression" do
|
2017-11-17 14:10:38 -05:00
|
|
|
before { SiteSetting.watched_words_regular_expressions = true }
|
|
|
|
|
|
|
|
it "supports regular expressions on word boundaries" do
|
|
|
|
Fabricate(:watched_word, word: /\btest\b/, action: WatchedWord.actions[:block])
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches = described_class.new("this is not a test.").word_matches_for_action?(:block)
|
|
|
|
expect(matches[0]).to eq("test")
|
2017-11-17 14:10:38 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
it "supports regular expressions as a site setting" do
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: /tro[uo]+t/,
|
|
|
|
action: WatchedWord.actions[:require_approval],
|
|
|
|
)
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Evil Trout is cool").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[0]).to eq("Trout")
|
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Evil Troot is cool").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[0]).to eq("Troot")
|
|
|
|
|
|
|
|
matches = described_class.new("trooooooooot").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[0]).to eq("trooooooooot")
|
2017-11-17 14:10:38 -05:00
|
|
|
end
|
2018-01-09 16:51:45 -05:00
|
|
|
|
|
|
|
it "support uppercase" do
|
|
|
|
Fabricate(:watched_word, word: /a\S+ce/, action: WatchedWord.actions[:require_approval])
|
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
matches = described_class.new("Amazing place").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches).to be_nil
|
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Amazing applesauce").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[0]).to eq("applesauce")
|
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new("Amazing AppleSauce").word_matches_for_action?(:require_approval)
|
|
|
|
expect(matches[0]).to eq("AppleSauce")
|
2018-01-09 16:51:45 -05:00
|
|
|
end
|
2017-09-27 15:48:57 -04:00
|
|
|
end
|
2017-11-17 14:10:38 -05:00
|
|
|
|
2022-08-02 04:06:03 -04:00
|
|
|
context "when case sensitive words are present" do
|
|
|
|
before do
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: "Discourse",
|
|
|
|
action: WatchedWord.actions[:block],
|
|
|
|
case_sensitive: true,
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when watched_words_regular_expressions = true" do
|
|
|
|
it "respects case sensitivity flag in matching words" do
|
|
|
|
SiteSetting.watched_words_regular_expressions = true
|
|
|
|
Fabricate(:watched_word, word: "p(rivate|ublic)", action: WatchedWord.actions[:block])
|
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new(
|
|
|
|
"PUBLIC: Discourse is great for public discourse",
|
|
|
|
).word_matches_for_action?(:block, all_matches: true)
|
|
|
|
expect(matches).to contain_exactly("PUBLIC", "Discourse", "public")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when watched_words_regular_expressions = false" do
|
|
|
|
it "repects case sensitivity flag in matching" do
|
|
|
|
SiteSetting.watched_words_regular_expressions = false
|
|
|
|
Fabricate(:watched_word, word: "private", action: WatchedWord.actions[:block])
|
|
|
|
|
|
|
|
matches =
|
|
|
|
described_class.new(
|
|
|
|
"PRIVATE: Discourse is also great private discourse",
|
|
|
|
).word_matches_for_action?(:block, all_matches: true)
|
|
|
|
|
|
|
|
expect(matches).to contain_exactly("PRIVATE", "Discourse", "private")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-07-26 11:15:42 -04:00
|
|
|
describe ".apply_to_text" do
|
|
|
|
fab!(:censored_word) do
|
|
|
|
Fabricate(:watched_word, word: "censored", action: WatchedWord.actions[:censor])
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2022-07-26 11:15:42 -04:00
|
|
|
fab!(:replaced_word) do
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: "to replace",
|
|
|
|
replacement: "replaced",
|
|
|
|
action: WatchedWord.actions[:replace],
|
|
|
|
)
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2022-07-26 11:15:42 -04:00
|
|
|
fab!(:link_word) do
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: "https://notdiscourse.org",
|
|
|
|
replacement: "https://discourse.org",
|
|
|
|
action: WatchedWord.actions[:link],
|
|
|
|
)
|
2023-01-09 06:18:21 -05:00
|
|
|
end
|
2022-07-26 11:15:42 -04:00
|
|
|
|
|
|
|
it "replaces all types of words" do
|
|
|
|
text = "hello censored world to replace https://notdiscourse.org"
|
|
|
|
expected =
|
|
|
|
"hello #{described_class::REPLACEMENT_LETTER * 8} world replaced https://discourse.org"
|
|
|
|
expect(described_class.apply_to_text(text)).to eq(expected)
|
|
|
|
end
|
2022-08-02 04:06:03 -04:00
|
|
|
|
|
|
|
context "when watched_words_regular_expressions = true" do
|
|
|
|
it "replaces captured non-word prefix" do
|
|
|
|
SiteSetting.watched_words_regular_expressions = true
|
|
|
|
Fabricate(
|
|
|
|
:watched_word,
|
|
|
|
word: "\\Wplaceholder",
|
|
|
|
replacement: "replacement",
|
|
|
|
action: WatchedWord.actions[:replace],
|
|
|
|
)
|
|
|
|
|
|
|
|
text = "is \tplaceholder in https://notdiscourse.org"
|
|
|
|
expected = "is replacement in https://discourse.org"
|
|
|
|
expect(described_class.apply_to_text(text)).to eq(expected)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when watched_words_regular_expressions = false" do
|
|
|
|
it "maintains non-word character prefix" do
|
|
|
|
SiteSetting.watched_words_regular_expressions = false
|
|
|
|
|
|
|
|
text = "to replace and\thttps://notdiscourse.org"
|
|
|
|
expected = "replaced and\thttps://discourse.org"
|
|
|
|
expect(described_class.apply_to_text(text)).to eq(expected)
|
|
|
|
end
|
|
|
|
end
|
2022-07-26 11:15:42 -04:00
|
|
|
end
|
2017-06-28 16:56:44 -04:00
|
|
|
end
|