discourse/spec/lib/discourse_plugin_registry_s...

306 lines
9.3 KiB
Ruby

# frozen_string_literal: true
require "discourse_plugin_registry"
RSpec.describe DiscoursePluginRegistry do
class TestRegistry < DiscoursePluginRegistry
end
let(:registry) { TestRegistry }
let(:registry_instance) { registry.new }
describe ".define_register" do
let(:fresh_registry) { Class.new(TestRegistry) }
let(:plugin_class) do
Class.new(Plugin::Instance) do
attr_accessor :enabled
def enabled?
@enabled
end
end
end
let(:plugin) { plugin_class.new }
it "works for a set" do
fresh_registry.define_register(:test_things, Set)
fresh_registry.test_things << "My Thing"
expect(fresh_registry.test_things).to contain_exactly("My Thing")
fresh_registry.reset!
expect(fresh_registry.test_things.length).to eq(0)
end
it "works for a hash" do
fresh_registry.define_register(:test_things, Hash)
fresh_registry.test_things[:test] = "hello world"
expect(fresh_registry.test_things[:test]).to eq("hello world")
fresh_registry.reset!
expect(fresh_registry.test_things[:test]).to eq(nil)
end
describe ".define_filtered_register" do
it "works" do
fresh_registry.define_filtered_register(:test_things)
expect(fresh_registry.test_things.length).to eq(0)
fresh_registry.register_test_thing("mything", plugin)
plugin.enabled = true
expect(fresh_registry.test_things).to contain_exactly("mything")
plugin.enabled = false
expect(fresh_registry.test_things.length).to eq(0)
end
end
end
describe "#stylesheets" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.stylesheets).to eq(Hash.new)
end
end
describe "#mobile_stylesheets" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.mobile_stylesheets).to eq(Hash.new)
end
end
describe "#javascripts" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.javascripts).to eq(Set.new)
end
end
describe "#auth_providers" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.auth_providers).to eq(Set.new)
end
end
describe "#seed_data" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.seed_data).to be_a(Hash)
expect(registry.seed_data.size).to eq(0)
end
end
describe "#mail_pollers" do
it "defaults to an empty Set" do
registry.reset!
expect(registry.mail_pollers).to eq(Set.new)
end
end
describe ".register_html_builder" do
it "can register and build html" do
DiscoursePluginRegistry.register_html_builder(:my_html) { "<b>my html</b>" }
expect(DiscoursePluginRegistry.build_html(:my_html)).to eq("<b>my html</b>")
DiscoursePluginRegistry.reset!
expect(DiscoursePluginRegistry.build_html(:my_html)).to be_blank
end
it "can register multiple builders" do
DiscoursePluginRegistry.register_html_builder(:my_html) { "one" }
DiscoursePluginRegistry.register_html_builder(:my_html) { "two" }
expect(DiscoursePluginRegistry.build_html(:my_html)).to eq("one\ntwo")
DiscoursePluginRegistry.reset!
end
end
describe ".register_css" do
let(:plugin_directory_name) { "hello" }
before { registry_instance.register_css("hello.css", plugin_directory_name) }
it "is not leaking" do
expect(DiscoursePluginRegistry.new.stylesheets[plugin_directory_name]).to be_nil
end
it "is returned by DiscoursePluginRegistry.stylesheets" do
expect(registry_instance.stylesheets[plugin_directory_name].include?("hello.css")).to eq(true)
end
it "won't add the same file twice" do
expect { registry_instance.register_css("hello.css", plugin_directory_name) }.not_to change(
registry.stylesheets[plugin_directory_name],
:size,
)
end
end
describe ".register_js" do
before { registry_instance.register_js("hello.js") }
it "is returned by DiscoursePluginRegistry.javascripts" do
expect(registry_instance.javascripts.include?("hello.js")).to eq(true)
end
it "won't add the same file twice" do
expect { registry_instance.register_js("hello.js") }.not_to change(
registry.javascripts,
:size,
)
end
end
describe ".register_auth_provider" do
let(:registry) { DiscoursePluginRegistry }
let(:auth_provider) do
provider = Auth::AuthProvider.new
provider.authenticator = Auth::Authenticator.new
provider
end
before { registry.register_auth_provider(auth_provider) }
after { registry.reset! }
it "is returned by DiscoursePluginRegistry.auth_providers" do
expect(registry.auth_providers.include?(auth_provider)).to eq(true)
end
end
describe ".register_service_worker" do
let(:registry) { DiscoursePluginRegistry }
before { registry.register_service_worker("hello.js") }
after { registry.reset! }
it "should register the file once" do
2.times { registry.register_service_worker("hello.js") }
expect(registry.service_workers.size).to eq(1)
expect(registry.service_workers).to include("hello.js")
end
end
describe ".register_archetype" do
it "delegates archetypes to the Archetype component" do
Archetype.expects(:register).with("threaded", { hello: 123 })
registry_instance.register_archetype("threaded", hello: 123)
end
end
describe "#register_asset" do
let(:registry) { DiscoursePluginRegistry }
let(:plugin_directory_name) { "my_plugin" }
after { registry.reset! }
it "does register general css properly" do
registry.register_asset("test.css", nil, plugin_directory_name)
registry.register_asset("test2.css", nil, plugin_directory_name)
expect(registry.mobile_stylesheets[plugin_directory_name]).to be_nil
expect(registry.stylesheets[plugin_directory_name].count).to eq(2)
end
it "registers desktop css properly" do
registry.register_asset("test.css", :desktop, plugin_directory_name)
expect(registry.desktop_stylesheets[plugin_directory_name].count).to eq(1)
expect(registry.stylesheets[plugin_directory_name]).to eq(nil)
expect(registry.mobile_stylesheets[plugin_directory_name]).to eq(nil)
end
it "registers mobile css properly" do
registry.register_asset("test.css", :mobile, plugin_directory_name)
expect(registry.mobile_stylesheets[plugin_directory_name].count).to eq(1)
expect(registry.stylesheets[plugin_directory_name]).to eq(nil)
end
it "registers color definitions properly" do
registry.register_asset("test.css", :color_definitions, plugin_directory_name)
expect(registry.color_definition_stylesheets[plugin_directory_name]).to eq("test.css")
expect(registry.stylesheets[plugin_directory_name]).to eq(nil)
end
it "registers vendored_core_pretty_text properly" do
registry.register_asset("my_lib.js", :vendored_core_pretty_text)
expect(registry.vendored_core_pretty_text.count).to eq(1)
expect(registry.javascripts.count).to eq(0)
end
end
describe "#register_seed_data" do
let(:registry) { DiscoursePluginRegistry }
after { registry.reset! }
it "registers seed data properly" do
registry.register_seed_data("admin_quick_start_title", "Banana Hosting: Quick Start Guide")
registry.register_seed_data(
"admin_quick_start_filename",
File.expand_path("../docs/BANANA-QUICK-START.md", __FILE__),
)
expect(registry.seed_data["admin_quick_start_title"]).to eq(
"Banana Hosting: Quick Start Guide",
)
expect(registry.seed_data["admin_quick_start_filename"]).to eq(
File.expand_path("../docs/BANANA-QUICK-START.md", __FILE__),
)
end
end
context "with filters" do
after { DiscoursePluginRegistry.clear_modifiers! }
class TestFilterPlugInstance < Plugin::Instance
def enabled?
!@disabled
end
def enabled=(value)
@disabled = !value
end
end
let(:plugin_instance) { TestFilterPlugInstance.new }
let(:plugin_instance2) { TestFilterPlugInstance.new }
it "handles modifiers with multiple parameters" do
DiscoursePluginRegistry.register_modifier(plugin_instance, :magic_sum_modifier) do |a, b|
a + b
end
sum = DiscoursePluginRegistry.apply_modifier(:magic_sum_modifier, 1, 2)
expect(sum).to eq(3)
end
it "handles modifier stacking" do
# first in, first called
DiscoursePluginRegistry.register_modifier(plugin_instance, :stacking) { |x| x == 1 ? 2 : 1 }
DiscoursePluginRegistry.register_modifier(plugin_instance2, :stacking) { |x| x + 1 }
expect(DiscoursePluginRegistry.apply_modifier(:stacking, 1)).to eq(3)
end
it "handles disabled plugins" do
plugin_instance.enabled = false
DiscoursePluginRegistry.register_modifier(plugin_instance, :magic_sum_modifier) do |a, b|
a + b
end
sum = DiscoursePluginRegistry.apply_modifier(:magic_sum_modifier, 1, 2)
expect(sum).to eq(1)
end
it "can handle arity mismatch" do
DiscoursePluginRegistry.register_modifier(plugin_instance, :magic_sum_modifier) { 42 }
sum = DiscoursePluginRegistry.apply_modifier(:magic_sum_modifier, 1, 2)
expect(sum).to eq(42)
end
end
end