# frozen_string_literal: true
RSpec.describe Blacklight::FieldPresenter, :api do
subject(:presenter) { described_class.new(request_context, document, field_config, options) }
let(:request_context) { double('View context', params: { x: '1' }, search_state: search_state, should_render_field?: true, blacklight_config: config) }
let(:document) do
SolrDocument.new(id: 1,
'link_to_facet_true' => 'x',
'link_to_facet_named' => 'x',
'qwer' => 'document qwer value',
'some_field' => [1, 2])
end
let(:options) { {} }
let(:params) { {} }
let(:controller) { double }
let(:search_state) { Blacklight::SearchState.new(params, config, controller) }
let(:field_config) { config.index_fields[field_name] }
let(:field_name) { 'asdf' }
let(:custom_step) do
Class.new(Blacklight::Rendering::AbstractStep) do
def render
'Static step'
end
end
end
let(:config) do
Blacklight::Configuration.new.configure do |config|
config.add_index_field 'qwer'
config.add_index_field 'asdf', helper_method: :render_asdf_index_field
config.add_index_field 'link_to_facet_true', link_to_facet: true
config.add_index_field 'link_to_facet_named', link_to_facet: :some_field
config.add_index_field 'highlight', highlight: true
config.add_index_field 'solr_doc_accessor', accessor: true
config.add_index_field 'explicit_accessor', accessor: :solr_doc_accessor
config.add_index_field 'explicit_array_accessor', accessor: [:solr_doc_accessor, :some_method]
config.add_index_field 'explicit_values_with_context', values: ->(_config, _doc, view_context) { [view_context.params[:x]] }
config.add_index_field 'alias', field: 'qwer'
config.add_index_field 'with_default', default: 'value'
config.add_index_field 'with_steps', steps: [custom_step]
config.add_facet_field :link_to_facet_true
config.add_facet_field :some_field
end
end
describe '#render' do
subject(:result) { presenter.render }
context 'when an explicit html value is provided' do
let(:options) { { value: 'val1' } }
it { is_expected.not_to be_html_safe }
end
context 'when an explicit array value with unsafe characters is provided' do
let(:options) { { value: [' { 'link_to_facet_true' => ['x'] } }).and_return('/foo')
allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
end
let(:field_name) { 'link_to_facet_true' }
it { is_expected.to eq 'bar' }
end
context 'when field has link_to_facet with a field name' do
before do
allow(request_context).to receive(:search_action_path).with({ 'f' => { 'some_field' => ['x'] } }).and_return('/foo')
allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
end
let(:field_name) { 'link_to_facet_named' }
it { is_expected.to eq 'bar' }
end
context 'when no highlight field is available' do
before do
allow(document).to receive(:has_highlight_field?).and_return(false)
end
let(:field_name) { 'highlight' }
it { is_expected.to be_blank }
end
context 'when highlight field is available' do
before do
allow(document).to receive(:has_highlight_field?).and_return(true)
allow(document).to receive(:highlight_field).with('highlight').and_return(['highlight'.html_safe])
end
let(:field_name) { 'highlight' }
it { is_expected.to eq 'highlight' }
end
context 'when no options are provided' do
let(:field_name) { 'qwer' }
it "checks the document field value" do
expect(subject).to eq 'document qwer value'
end
end
context 'when accessor is true' do
before do
allow(document).to receive_messages(solr_doc_accessor: "123")
end
let(:field_name) { 'solr_doc_accessor' }
it { is_expected.to eq '123' }
end
context 'when accessor is set to a value' do
let(:field_name) { 'explicit_accessor' }
it 'calls the accessor with the field_name as the argument' do
expect(document).to receive(:solr_doc_accessor).with('explicit_accessor').and_return("123")
expect(subject).to eq '123'
end
end
context 'when accessor is set to an array' do
let(:field_name) { 'explicit_array_accessor' }
it 'calls the accessors on the return of the preceeding' do
allow(document).to receive_message_chain(:solr_doc_accessor, some_method: "123")
expect(subject).to eq '123'
end
end
context 'when the values lambda is provided and accepts the view contexts' do
let(:field_name) { 'explicit_values_with_context' }
it 'calls the accessors on the return of the preceeding' do
expect(subject).to eq '1'
end
end
context 'when the field is an alias' do
let(:field_name) { 'alias' }
it { is_expected.to eq 'document qwer value' }
end
context 'when the field has a default' do
let(:field_name) { 'with_default' }
it { is_expected.to eq 'value' }
end
context 'with steps' do
let(:field_name) { 'with_steps' }
it { is_expected.to eq 'Static step' }
end
context 'for a field with the helper_method option' do
let(:field_name) { 'field_with_helper' }
let(:field_config) { config.add_facet_field 'field_with_helper', helper_method: 'render_field_with_helper' }
let(:document) do
SolrDocument.new(id: 1, 'field_with_helper' => 'value')
end
let(:options) { { a: 1 } }
it "checks call the helper method with arguments" do
allow(request_context).to receive(:render_field_with_helper) do |*args|
args.first
end
expect(result).to include :document, :field, :value, :config, :a
expect(result[:document]).to eq document
expect(result[:field]).to eq 'field_with_helper'
expect(result[:value]).to eq ['value']
expect(result[:config]).to eq field_config
expect(result[:a]).to eq 1
end
end
end
describe '#label' do
let(:field_config) { Blacklight::Configuration::Field.new(field: 'some_field') }
it 'calculates the field label from the field configuration' do
allow(field_config).to receive(:display_label).with('index', anything).and_return('some label')
expect(presenter.label).to eq 'some label'
end
it 'sends along a count of document values so i18n can do pluralization' do
allow(field_config).to receive(:display_label).with('index', count: 2).and_return('values')
expect(presenter.label).to eq 'values'
end
end
describe '#render_field?' do
subject { presenter.render_field? }
let(:field_config) { double('field config', if: true, unless: false, except_operations: nil) }
it { is_expected.to be true }
context 'when the view context says not to render the field' do
let(:request_context) { double('View context', should_render_field?: false, blacklight_config: config) }
before do
allow(field_config).to receive_messages(if: false)
end
it { is_expected.to be false }
end
end
describe '#any?' do
subject { presenter.any? }
context 'when the document has the field value' do
let(:field_config) { double(field: 'asdf', highlight: false, accessor: nil, default: nil, values: nil, except_operations: nil) }
before do
allow(document).to receive(:fetch).with('asdf', nil).and_return(['value'])
end
it { is_expected.to be true }
end
context 'when the document has a highlight field value' do
let(:field_config) { double(field: 'asdf', highlight: true, except_operations: nil) }
before do
allow(document).to receive(:has_highlight_field?).with('asdf').and_return(true)
allow(document).to receive(:highlight_field).with('asdf').and_return(['value'])
end
it { is_expected.to be true }
end
context 'when the field is a model accessor' do
let(:field_config) { double(field: 'asdf', highlight: false, accessor: true, except_operations: nil) }
before do
allow(document).to receive(:send).with('asdf').and_return(['value'])
end
it { is_expected.to be true }
end
end
end