From 670e6a33f8eeca628707dc020e02ce32502d74a4 Mon Sep 17 00:00:00 2001 From: David Yip Date: Sat, 21 Oct 2017 14:47:17 -0500 Subject: [PATCH] Move KeywordMute into Glitch namespace. There are two motivations for this: 1. It looks like we're going to add other features that require server-side storage (e.g. user notes). 2. Namespacing glitchsoc modifications is a good idea anyway: even if we do not end up doing (1), if upstream introduces a keyword-mute feature that also uses a "KeywordMute" model, we can avoid some merge conflicts this way and work on the more interesting task of choosing which implementation to use. --- .../settings/keyword_mutes_controller.rb | 2 +- app/lib/feed_manager.rb | 2 +- app/models/glitch.rb | 7 +++++ app/models/{ => glitch}/keyword_mute.rb | 6 ++-- ...ove_keyword_mutes_into_glitch_namespace.rb | 7 +++++ db/schema.rb | 22 +++++++------- .../glitch_keyword_mute_fabricator.rb | 2 ++ spec/fabricators/keyword_mute_fabricator.rb | 2 -- spec/models/{ => glitch}/keyword_mute_spec.rb | 30 +++++++++---------- 9 files changed, 47 insertions(+), 33 deletions(-) create mode 100644 app/models/glitch.rb rename app/models/{ => glitch}/keyword_mute.rb (84%) create mode 100644 db/migrate/20171021191900_move_keyword_mutes_into_glitch_namespace.rb create mode 100644 spec/fabricators/glitch_keyword_mute_fabricator.rb delete mode 100644 spec/fabricators/keyword_mute_fabricator.rb rename spec/models/{ => glitch}/keyword_mute_spec.rb (64%) diff --git a/app/controllers/settings/keyword_mutes_controller.rb b/app/controllers/settings/keyword_mutes_controller.rb index d9f99af090..6ae05108d9 100644 --- a/app/controllers/settings/keyword_mutes_controller.rb +++ b/app/controllers/settings/keyword_mutes_controller.rb @@ -55,7 +55,7 @@ class Settings::KeywordMutesController < ApplicationController end def keyword_mutes_for_account - KeywordMute.where(account: @account) + Glitch::KeywordMute.where(account: @account) end def load_keyword_mute diff --git a/app/lib/feed_manager.rb b/app/lib/feed_manager.rb index 516bd81af7..1123f88bbd 100644 --- a/app/lib/feed_manager.rb +++ b/app/lib/feed_manager.rb @@ -138,7 +138,7 @@ class FeedManager end def filter_from_home?(status, receiver_id) - return true if KeywordMute.matcher_for(receiver_id) =~ status.text + return true if Glitch::KeywordMute.matcher_for(receiver_id) =~ status.text return false if receiver_id == status.account_id return true if status.reply? && (status.in_reply_to_id.nil? || status.in_reply_to_account_id.nil?) diff --git a/app/models/glitch.rb b/app/models/glitch.rb new file mode 100644 index 0000000000..0e497babcc --- /dev/null +++ b/app/models/glitch.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module Glitch + def self.table_name_prefix + 'glitch_' + end +end diff --git a/app/models/keyword_mute.rb b/app/models/glitch/keyword_mute.rb similarity index 84% rename from app/models/keyword_mute.rb rename to app/models/glitch/keyword_mute.rb index b0229923d8..3b0b47f52f 100644 --- a/app/models/keyword_mute.rb +++ b/app/models/glitch/keyword_mute.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # == Schema Information # -# Table name: keyword_mutes +# Table name: glitch_keyword_mutes # # id :integer not null, primary key # account_id :integer not null @@ -11,7 +11,7 @@ # updated_at :datetime not null # -class KeywordMute < ApplicationRecord +class Glitch::KeywordMute < ApplicationRecord belongs_to :account, required: true validates_presence_of :keyword @@ -33,7 +33,7 @@ class KeywordMute < ApplicationRecord def initialize(account_id) re = [].tap do |arr| - KeywordMute.where(account_id: account_id).select(:keyword, :id, :whole_word).find_each do |m| + Glitch::KeywordMute.where(account_id: account_id).select(:keyword, :id, :whole_word).find_each do |m| boundary = m.whole_word ? '\b' : '' arr << "#{boundary}#{Regexp.escape(m.keyword.strip)}#{boundary}" end diff --git a/db/migrate/20171021191900_move_keyword_mutes_into_glitch_namespace.rb b/db/migrate/20171021191900_move_keyword_mutes_into_glitch_namespace.rb new file mode 100644 index 0000000000..269bb49d64 --- /dev/null +++ b/db/migrate/20171021191900_move_keyword_mutes_into_glitch_namespace.rb @@ -0,0 +1,7 @@ +class MoveKeywordMutesIntoGlitchNamespace < ActiveRecord::Migration[5.1] + def change + safety_assured do + rename_table :keyword_mutes, :glitch_keyword_mutes + end + end +end diff --git a/db/schema.rb b/db/schema.rb index c0704b13e3..c09876c4d7 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 20171010025614) do +ActiveRecord::Schema.define(version: 20171021191900) do # These are extensions that must be enabled in order to support this database enable_extension "plpgsql" @@ -155,6 +155,15 @@ ActiveRecord::Schema.define(version: 20171010025614) do t.index ["account_id", "target_account_id"], name: "index_follows_on_account_id_and_target_account_id", unique: true end + create_table "glitch_keyword_mutes", force: :cascade do |t| + t.bigint "account_id", null: false + t.string "keyword", null: false + t.boolean "whole_word", default: true, null: false + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["account_id"], name: "index_glitch_keyword_mutes_on_account_id" + end + create_table "imports", force: :cascade do |t| t.integer "type", null: false t.boolean "approved", default: false, null: false @@ -167,15 +176,6 @@ ActiveRecord::Schema.define(version: 20171010025614) do t.bigint "account_id", null: false end - create_table "keyword_mutes", force: :cascade do |t| - t.bigint "account_id", null: false - t.string "keyword", null: false - t.boolean "whole_word", default: true, null: false - t.datetime "created_at", null: false - t.datetime "updated_at", null: false - t.index ["account_id"], name: "index_keyword_mutes_on_account_id" - end - create_table "media_attachments", force: :cascade do |t| t.bigint "status_id" t.string "file_file_name" @@ -481,8 +481,8 @@ ActiveRecord::Schema.define(version: 20171010025614) do add_foreign_key "follow_requests", "accounts", name: "fk_76d644b0e7", on_delete: :cascade add_foreign_key "follows", "accounts", column: "target_account_id", name: "fk_745ca29eac", on_delete: :cascade add_foreign_key "follows", "accounts", name: "fk_32ed1b5560", on_delete: :cascade + add_foreign_key "glitch_keyword_mutes", "accounts", on_delete: :cascade add_foreign_key "imports", "accounts", name: "fk_6db1b6e408", on_delete: :cascade - add_foreign_key "keyword_mutes", "accounts", on_delete: :cascade add_foreign_key "media_attachments", "accounts", name: "fk_96dd81e81b", on_delete: :nullify add_foreign_key "media_attachments", "statuses", on_delete: :nullify add_foreign_key "mentions", "accounts", name: "fk_970d43f9d1", on_delete: :cascade diff --git a/spec/fabricators/glitch_keyword_mute_fabricator.rb b/spec/fabricators/glitch_keyword_mute_fabricator.rb new file mode 100644 index 0000000000..8601ed6d75 --- /dev/null +++ b/spec/fabricators/glitch_keyword_mute_fabricator.rb @@ -0,0 +1,2 @@ +Fabricator(:glitch_keyword_mute) do +end diff --git a/spec/fabricators/keyword_mute_fabricator.rb b/spec/fabricators/keyword_mute_fabricator.rb deleted file mode 100644 index 82cf845c8d..0000000000 --- a/spec/fabricators/keyword_mute_fabricator.rb +++ /dev/null @@ -1,2 +0,0 @@ -Fabricator(:keyword_mute) do -end diff --git a/spec/models/keyword_mute_spec.rb b/spec/models/glitch/keyword_mute_spec.rb similarity index 64% rename from spec/models/keyword_mute_spec.rb rename to spec/models/glitch/keyword_mute_spec.rb index c745051886..108cdafec6 100644 --- a/spec/models/keyword_mute_spec.rb +++ b/spec/models/glitch/keyword_mute_spec.rb @@ -1,15 +1,15 @@ require 'rails_helper' -RSpec.describe KeywordMute, type: :model do +RSpec.describe Glitch::KeywordMute, type: :model do let(:alice) { Fabricate(:account, username: 'alice').tap(&:save!) } let(:bob) { Fabricate(:account, username: 'bob').tap(&:save!) } describe '.matcher_for' do - let(:matcher) { KeywordMute.matcher_for(alice) } + let(:matcher) { Glitch::KeywordMute.matcher_for(alice) } - describe 'with no KeywordMutes for an account' do + describe 'with no Glitch::KeywordMutes for an account' do before do - KeywordMute.delete_all + Glitch::KeywordMute.delete_all end it 'does not match' do @@ -17,63 +17,63 @@ RSpec.describe KeywordMute, type: :model do end end - describe 'with KeywordMutes for an account' do + describe 'with Glitch::KeywordMutes for an account' do it 'does not match keywords set by a different account' do - KeywordMute.create!(account: bob, keyword: 'take') + Glitch::KeywordMute.create!(account: bob, keyword: 'take') expect(matcher =~ 'This is a hot take').to be_falsy end it 'does not match if no keywords match the status text' do - KeywordMute.create!(account: alice, keyword: 'cold') + Glitch::KeywordMute.create!(account: alice, keyword: 'cold') expect(matcher =~ 'This is a hot take').to be_falsy end it 'considers word boundaries when matching' do - KeywordMute.create!(account: alice, keyword: 'bob', whole_word: true) + Glitch::KeywordMute.create!(account: alice, keyword: 'bob', whole_word: true) expect(matcher =~ 'bobcats').to be_falsy end it 'matches substrings if whole_word is false' do - KeywordMute.create!(account: alice, keyword: 'take', whole_word: false) + Glitch::KeywordMute.create!(account: alice, keyword: 'take', whole_word: false) expect(matcher =~ 'This is a shiitake mushroom').to be_truthy end it 'matches keywords at the beginning of the text' do - KeywordMute.create!(account: alice, keyword: 'take') + Glitch::KeywordMute.create!(account: alice, keyword: 'take') expect(matcher =~ 'Take this').to be_truthy end it 'matches keywords at the beginning of the text' do - KeywordMute.create!(account: alice, keyword: 'take') + Glitch::KeywordMute.create!(account: alice, keyword: 'take') expect(matcher =~ 'This is a hot take').to be_truthy end it 'matches if at least one keyword case-insensitively matches the text' do - KeywordMute.create!(account: alice, keyword: 'hot') + Glitch::KeywordMute.create!(account: alice, keyword: 'hot') expect(matcher =~ 'This is a HOT take').to be_truthy end it 'matches keywords surrounded by non-alphanumeric ornamentation' do - KeywordMute.create!(account: alice, keyword: 'hot') + Glitch::KeywordMute.create!(account: alice, keyword: 'hot') expect(matcher =~ 'This is a ~*HOT*~ take').to be_truthy end it 'uses case-folding rules appropriate for more than just English' do - KeywordMute.create!(account: alice, keyword: 'großeltern') + Glitch::KeywordMute.create!(account: alice, keyword: 'großeltern') expect(matcher =~ 'besuch der grosseltern').to be_truthy end it 'matches keywords that are composed of multiple words' do - KeywordMute.create!(account: alice, keyword: 'a shiitake') + Glitch::KeywordMute.create!(account: alice, keyword: 'a shiitake') expect(matcher =~ 'This is a shiitake').to be_truthy expect(matcher =~ 'This is shiitake').to_not be_truthy