require 'spec_helper'
describe BlacklightConfigurationHelper do
let(:blacklight_config) { Blacklight::Configuration.new }
let(:config_value) { double() }
before :each do
allow(helper).to receive_messages(blacklight_config: blacklight_config)
end
describe "#index_fields" do
it "should pass through the configuration" do
allow(blacklight_config).to receive_messages(index_fields: config_value)
expect(helper.index_fields).to eq config_value
end
end
describe "#sort_fields" do
it "should convert the sort fields to select-ready values" do
allow(blacklight_config).to receive_messages(sort_fields: { 'a' => double(key: 'a', label: 'a'), 'b' => double(key: 'b', label: 'b'), c: double(key: 'c', if: false) })
expect(helper.sort_fields).to eq [['a', 'a'], ['b', 'b']]
end
end
describe "#active_sort_fields" do
it "should restrict the configured sort fields to only those that should be displayed" do
allow(blacklight_config).to receive_messages(sort_fields: { a: double(if: false, unless: false), b: double(if:true, unless: true) })
expect(helper.active_sort_fields).to be_empty
end
end
describe "#document_show_fields" do
it "should pass through the configuration" do
allow(blacklight_config).to receive_messages(show_fields: config_value)
expect(helper.document_show_fields).to eq config_value
end
end
describe "#default_document_index_view_type" do
it "should use the first view with default set to true" do
blacklight_config.view.a
blacklight_config.view.b
blacklight_config.view.b.default = true
expect(helper.default_document_index_view_type).to eq :b
end
it "should default to the first configured index view" do
allow(blacklight_config).to receive_messages(view: { a: true, b: true})
expect(helper.default_document_index_view_type).to eq :a
end
end
describe "#document_index_views" do
before do
blacklight_config.view.abc = false
blacklight_config.view.def.if = false
blacklight_config.view.xyz.unless = true
end
it "should filter views using :if/:unless configuration" do
expect(helper.document_index_views).to have_key :list
expect(helper.document_index_views).to_not have_key :abc
expect(helper.document_index_views).to_not have_key :def
expect(helper.document_index_views).to_not have_key :xyz
end
end
describe "#has_alternative_views?" do
subject { helper.has_alternative_views?}
describe "with a single view defined" do
it { should be false }
end
describe "with multiple views defined" do
before do
blacklight_config.view.abc
blacklight_config.view.xyz
end
it { should be true }
end
end
describe "#spell_check_max" do
it "should pass through the configuration" do
allow(blacklight_config).to receive_messages(spell_max: config_value)
expect(helper.spell_check_max).to eq config_value
end
end
describe "#document_show_link_field" do
let(:document) { SolrDocument.new id: 123, a: 1, b: 2, c: 3 }
it "should allow single values" do
blacklight_config.index.title_field = :a
f = helper.document_show_link_field document
expect(f).to eq :a
end
it "should retrieve the first field with data" do
blacklight_config.index.title_field = [:zzz, :b]
f = helper.document_show_link_field document
expect(f).to eq :b
end
it "should fallback on the id" do
blacklight_config.index.title_field = [:zzz, :yyy]
f = helper.document_show_link_field document
expect(f).to eq 123
end
end
describe "#index_field_label" do
let(:document) { double }
it "should look up the label to display for the given document and field" do
allow(helper).to receive(:index_fields).and_return({ "my_field" => double(label: "some label") })
allow(helper).to receive(:field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
helper.index_field_label document, "my_field"
end
end
describe "#document_show_field_label" do
let(:document) { double }
it "should look up the label to display for the given document and field" do
allow(helper).to receive(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
allow(helper).to receive(:field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
helper.document_show_field_label document, "my_field"
end
end
describe "#facet_field_label" do
let(:document) { double }
it "should look up the label to display for the given document and field" do
allow(blacklight_config).to receive(:facet_fields).and_return({ "my_field" => double(label: "some label") })
allow(helper).to receive(:field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
helper.facet_field_label "my_field"
end
end
describe "#view_label" do
it "should look up the label to display for the view" do
allow(blacklight_config).to receive(:view).and_return({ "my_view" => double(label: "some label", title: nil) })
allow(helper).to receive(:field_label).with(:"blacklight.search.view_title.my_view", :"blacklight.search.view.my_view", "some label", nil, "My view")
helper.view_label "my_view"
end
end
describe "#field_label" do
it "should look up the label as an i18n string" do
allow(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
label = helper.field_label :some_key
expect(label).to eq "my label"
end
it "should pass the provided i18n keys to I18n.t" do
allow(helper).to receive(:t).with(:key_a, default: [:key_b, "default text"])
label = helper.field_label :key_a, :key_b, "default text"
end
it "should compact nil keys (fixes rails/rails#19419)" do
allow(helper).to receive(:t).with(:key_a, default: [:key_b])
label = helper.field_label :key_a, nil, :key_b
end
end
describe "#default_per_page" do
it "should be the configured default per page" do
allow(helper).to receive_messages(blacklight_config: double(default_per_page: 42))
expect(helper.default_per_page).to eq 42
end
it "should be the first per-page value if a default isn't set" do
allow(helper).to receive_messages(blacklight_config: double(default_per_page: nil, per_page: [11, 22]))
expect(helper.default_per_page).to eq 11
end
end
describe "#default_sort_field" do
it "should be the configured default field" do
allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(default: nil), b: double(key: 'b', default: true) }))
expect(helper.default_sort_field.key).to eq 'b'
end
it "should be the first per-page value if a default isn't set" do
allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(key: 'a', default: nil), b: double(key: 'b', default: nil) }))
expect(helper.default_sort_field.key).to eq 'a'
end
end
describe "#per_page_options_for_select" do
it "should be the per-page values formatted as options_for_select" do
allow(helper).to receive_messages(blacklight_config: double(per_page: [11, 22, 33]))
expect(helper.per_page_options_for_select).to include ["11 per page", 11]
expect(helper.per_page_options_for_select).to include ["22 per page", 22]
expect(helper.per_page_options_for_select).to include ["33 per page", 33]
end
end
describe "#should_render_field?" do
let(:field_config) { double('field config', if: true, unless: false) }
before do
allow(helper).to receive_messages(document_has_value?: true)
end
it "should be true" do
expect(helper.should_render_field?(field_config)).to be true
end
it "should be false if the :if condition is false" do
allow(field_config).to receive_messages(if: false)
expect(helper.should_render_field?(field_config)).to be false
end
it "should be false if the :unless condition is true" do
allow(field_config).to receive_messages(unless: true)
expect(helper.should_render_field?(field_config)).to be false
end
end
describe "#evaluate_configuration_conditional" do
it "should pass through regular values" do
val = double
expect(helper.evaluate_configuration_conditional(val)).to eq val
end
it "should execute a helper method" do
allow(helper).to receive_messages(:my_helper => true)
expect(helper.evaluate_configuration_conditional(:my_helper)).to be true
end
it "should call a helper to determine if it should render a field" do
a = double
allow(helper).to receive(:my_helper_with_an_arg).with(a).and_return(true)
expect(helper.evaluate_configuration_conditional(:my_helper_with_an_arg, a)).to be true
end
it "should evaluate a Proc to determine if it should render a field" do
one_arg_lambda = lambda { |context, a| true }
two_arg_lambda = lambda { |context, a, b| true }
expect(helper.evaluate_configuration_conditional(one_arg_lambda, 1)).to be true
expect(helper.evaluate_configuration_conditional(two_arg_lambda, 1, 2)).to be true
end
end
describe "#search_field_options_for_select" do
before do
@config = Blacklight::Configuration.new do |config|
config.default_solr_params = { :qt => 'search' }
config.add_search_field 'all_fields', :label => 'All Fields'
config.add_search_field 'title', :qt => 'title_search'
config.add_search_field 'author', :qt => 'author_search'
config.add_search_field 'subject', :qt => 'subject_search'
config.add_search_field 'no_display', :qt => 'something', :include_in_simple_select => false
end
allow(helper).to receive_messages(blacklight_config: @config)
end
it "should return proper options_for_select arguments" do
select_arguments = helper.search_field_options_for_select
select_arguments.each do |(label, key)|
config_hash = @config.search_fields[key]
expect(label).to eq config_hash.label
expect(key).to eq config_hash.key
end
end
it "should not include fields in select if :display_in_simple_search=>false" do
select_arguments = helper.search_field_options_for_select
expect(select_arguments).not_to include(["No Display", "no_display"])
end
end
end