blacklight-spotlight 3.4.0 → 3.4.1

data/spec/jobs/spotlight/rename_sidecar_field_job_spec.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::RenameSidecarFieldJob do
-  include ActiveJob::TestHelper
-
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-  let(:sidecar) { SolrDocument.new(id: 'test').sidecar(exhibit).tap(&:save!) }
-
-  it 'updates the sidecar data and reindex affected documents' do
-    expect_any_instance_of(::SolrDocument).to receive(:reindex)
-
-    sidecar.data['old_field'] = 'some value'
-    sidecar.save!
-
-    perform_enqueued_jobs do
-      described_class.perform_later(exhibit, 'old_field', 'new_field')
-    end
-
-    sidecar.reload
-    expect(sidecar.data['new_field']).to eq 'some value'
-  end
-
-  it 'does not touch unaffected documents' do
-    expect_any_instance_of(::SolrDocument).not_to receive(:reindex)
-
-    sidecar.data['other_field'] = 'some value'
-    sidecar.save!
-
-    perform_enqueued_jobs do
-      described_class.perform_later(exhibit, 'old_field', 'new_field')
-    end
-  end
-end

data/spec/lib/migration/iiif_spec.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'migration/iiif'
-
-RSpec.describe Migration::IIIF do
-  let(:instance) { described_class.new('http://test.host') }
-
-  describe '#migrate_featured_images' do
-    let!(:old_exhibit_thumbnail) { FactoryBot.create(:featured_image, type: nil, iiif_tilesource: nil) }
-    let!(:exhibit) { FactoryBot.create(:exhibit, thumbnail_id: old_exhibit_thumbnail.id) }
-    let(:updated_thumb) { Spotlight::FeaturedImage.find(old_exhibit_thumbnail.id) }
-
-    context "when it's an exhibit thumbnail" do
-      it 'migrates to an ExhibitThumbnail class and stores the image in the correct directory' do
-        instance.run
-        expect(updated_thumb.class).to eq Spotlight::ExhibitThumbnail
-        expect(Spotlight::Exhibit.find(exhibit.id).thumbnail).to eq updated_thumb
-      end
-
-      it 'stores the image in the correct directory for the ExhibitThumbnail class' do
-        instance.run
-        expect(updated_thumb.image.file.file).to match(%r{/spotlight/exhibit_thumbnail/image/#{old_exhibit_thumbnail.id}})
-      end
-    end
-
-    context "when it's any FeaturedImage" do
-      it 'updates the iiif_tilesource attribute based on the given host and image resource' do
-        instance.run
-        expect(updated_thumb.iiif_tilesource).to match %r{http://test.host/images/#{updated_thumb.id}-.*/info.json}
-      end
-
-      it 'returns a nil region if one was not set' do
-        instance.run
-        expect(updated_thumb.iiif_region).to be_nil
-      end
-
-      it 'updates the iiif_region attribute based on the legacy crop coordinates' do
-        old_exhibit_thumbnail.image_crop_x = '1'
-        old_exhibit_thumbnail.image_crop_y = '1'
-        old_exhibit_thumbnail.image_crop_w = '400'
-        old_exhibit_thumbnail.image_crop_h = '400'
-        old_exhibit_thumbnail.save
-
-        instance.run
-        expect(updated_thumb.iiif_region).to eq '1,1,400,400'
-      end
-    end
-  end
-
-  describe '#migrate_upload_images' do
-    let(:file) { double }
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-    let!(:upload) { Spotlight::Resources::Upload.create(exhibit: exhibit) }
-
-    before do
-      allow(File).to receive(:exist?).and_return(true)
-      allow(File).to receive(:new).and_return(file)
-      expect_any_instance_of(Spotlight::Resources::Upload).to receive('read_attribute_before_type_cast').with('url').and_return('file1.jpg')
-      # allow other calls (from rails 4)
-      allow_any_instance_of(Spotlight::Resources::Upload).to receive('read_attribute_before_type_cast').with(anything).and_call_original
-    end
-
-    it 'migrates and saves' do
-      expect_any_instance_of(Spotlight::Resources::Upload).to receive(:save_and_index)
-      expect do
-        instance.send :migrate_upload_images
-      end.to change(Spotlight::FeaturedImage, :count).by(1)
-      expect(Spotlight::FeaturedImage.all.pluck(:id)).to include Spotlight::Resources::Upload.last.id
-    end
-  end
-
-  describe '#migrate_contact_avatars' do
-    let(:file) { double }
-    let!(:contact1) { Spotlight::Contact.create }
-
-    before do
-      allow(File).to receive(:exist?).and_return(true)
-      allow(File).to receive(:new).and_return(file)
-      expect_any_instance_of(Spotlight::Contact).to receive('read_attribute_before_type_cast').with('avatar').and_return('file1.jpg')
-      # allow other calls (from rails 4)
-      allow_any_instance_of(Spotlight::Contact).to receive('read_attribute_before_type_cast').with(anything).and_call_original
-    end
-
-    it 'migrates' do
-      expect do
-        instance.send :migrate_contact_avatars
-      end.to change(Spotlight::FeaturedImage, :count).by(1)
-      expect(Spotlight::Contact.all.pluck(:avatar_id)).to eq Spotlight::FeaturedImage.all.pluck(:id)
-    end
-  end
-end

data/spec/lib/migration/page_language_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'migration/page_language'
-
-RSpec.describe Migration::PageLanguage do
-  describe '#migrate_pages' do
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-    let(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
-    let(:slug) { FriendlyId::Slug.find(page.id) }
-
-    before do
-      # Remove the locale scope (anticipating pre translation state of scope)
-      slug.scope = slug.scope.sub(',locale:en', '')
-      slug.save
-      slug.reload
-    end
-
-    it 'sets the scope to the default locale' do
-      expect(slug.scope).not_to include(',locale:en')
-      subject.run
-      slug.reload
-      expect(slug.scope).to eq "exhibit_id:#{page.exhibit.id},locale:en"
-    end
-  end
-end

data/spec/lib/spotlight/controller_spec.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Controller do
-  class MockController < ActionController::Base
-    include Spotlight::Controller
-  end
-
-  subject { MockController.new }
-
-  let(:params) { { action: 'show' } }
-
-  before do
-    allow(subject).to receive_messages(params: ActionController::Parameters.new(params))
-  end
-
-  describe '#current_exhibit' do
-    it 'is nil by default' do
-      expect(subject.current_exhibit).to be_nil
-    end
-  end
-
-  describe '#exhibit_masthead?' do
-    let(:masthead) { double('masthead', display?: true) }
-
-    before do
-      allow(subject).to receive_messages(current_exhibit: nil, current_masthead: nil)
-    end
-
-    it 'is false if there is no exhibit' do
-      expect(subject).not_to be_exhibit_masthead
-    end
-
-    it 'is false if there is no custom exhibit masthead' do
-      allow(subject).to receive_messages(current_exhibit: double(masthead: nil), current_masthead: nil)
-      expect(subject).not_to be_exhibit_masthead
-    end
-
-    it 'is true if there is an exhibit masthead, but it is not set to display' do
-      allow(subject).to receive_messages(current_exhibit: double(masthead: double(display?: false)))
-      expect(subject).not_to be_exhibit_masthead
-    end
-
-    it 'is true if there is an exhibit masthead' do
-      allow(subject).to receive_messages(current_exhibit: double(masthead: double(display?: true)))
-      expect(subject).to be_exhibit_masthead
-    end
-  end
-
-  describe '#current_masthead' do
-    let(:search_masthead) { double('search-masthead', display?: true) }
-    let(:no_display_search_masthead) { double('no-display-search-masthead', display?: false) }
-    let(:exhibit_masthead) { double('exhibit-masthead', display?: true) }
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-    let(:search) { FactoryBot.create(:search) }
-
-    it 'is nil by default' do
-      expect(subject.current_masthead).to be_nil
-    end
-
-    it 'returns the exhibit masthead if available' do
-      allow(exhibit).to receive_messages(masthead: exhibit_masthead)
-      subject.instance_variable_set(:@exhibit, exhibit)
-      expect(subject.current_masthead).to eq exhibit_masthead
-    end
-
-    it 'allows the masthead to be set' do
-      subject.current_masthead = search_masthead
-      expect(subject.current_masthead).to eq search_masthead
-    end
-
-    context 'with a resource masthead' do
-      before do
-        allow(subject).to receive(:resource_masthead?).and_return(true)
-      end
-
-      it 'checks if the current resource has a masthead' do
-        pending
-        expect(subject.current_masthead).to eq search_masthead
-      end
-    end
-  end
-
-  describe '#resource_masthead?' do
-    it 'is false by default' do
-      expect(subject.resource_masthead?).to eq false
-    end
-  end
-
-  describe '#exhibit_search_facet_path' do
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-    let(:params) { { action: 'index', q: 'xyz' } }
-
-    before do
-      allow(subject).to receive(:current_exhibit).and_return(exhibit)
-    end
-
-    it 'adds the current exhibit context to the route' do
-      expect(subject.spotlight).to receive(:facet_exhibit_catalog_url).with(exhibit, id: 'some_field', q: 'xyz')
-      subject.exhibit_search_facet_path(id: 'some_field')
-    end
-  end
-end

data/spec/lib/spotlight/upload_field_config_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Spotlight::UploadFieldConfig do
-  describe '#label' do
-    it 'accepts a proc and calls it' do
-      label = -> { 'returned string' }
-      expect(described_class.new(field_name: 'something', label: label).label).to eq 'returned string'
-    end
-
-    it 'returns any non-proc value' do
-      expect(described_class.new(field_name: 'something', label: 'String').label).to eq 'String'
-    end
-
-    it 'falls back to the field name when no label is given' do
-      expect(described_class.new(field_name: 'something').label).to eq 'something'
-    end
-  end
-
-  describe '#solr_field' do
-    it 'is an alias of the #solr_field method so it can be polymorphic with other Blacklight configurations' do
-      expect(described_class.new(field_name: 'something').solr_field).to eq 'something'
-    end
-  end
-
-  describe '#solr_fields' do
-    it 'is backwards compatible with the old way of configuring fields' do
-      expect(described_class.new(field_name: 'something').solr_fields).to eq ['something']
-    end
-  end
-
-  describe '#data_to_solr' do
-    it 'returns a hash of the various solr fields mapped to the provided value' do
-      expect(described_class.new(field_name: 'something', solr_fields: %w[a b]).data_to_solr('value')).to eq 'a' => 'value', 'b' => 'value'
-    end
-
-    it 'supports configuring a lambda to pre-process data for a field' do
-      expect(described_class.new(field_name: 'something', solr_fields: [int_field: ->(value) { value.to_i }]).data_to_solr('123value')).to eq int_field: 123
-    end
-  end
-end

data/spec/mailers/spotlight/indexing_complete_mailer_spec.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::IndexingCompleteMailer do
-  subject { described_class.documents_indexed [1, 2, 3], exhibit, user, indexed_count: 3 }
-
-  let(:user) { double(email: 'test@example.com') }
-  let(:exhibit) { double(title: 'Exhibit title') }
-
-  it 'renders the receiver email' do
-    expect(subject.to).to eql([user.email])
-  end
-
-  it 'includes a title' do
-    expect(subject.body.encoded).to match 'Your CSV file has just finished being processed'
-  end
-
-  it 'describes how many documents were indexed' do
-    expect(subject.body.encoded).to match '3 documents'
-  end
-
-  context 'single item' do
-    subject { described_class.documents_indexed [1], exhibit, user }
-
-    it 'handles pluralization when only a single item was indexed' do
-      expect(subject.body.encoded).to match '1 document has'
-    end
-  end
-
-  it 'includes the exhibit title' do
-    expect(subject.body.encoded).to match exhibit.title
-  end
-
-  context 'with errors' do
-    subject { described_class.documents_indexed [], exhibit, user, indexed_count: 0, errors: { 1 => ['missing title'], 20 => ['whatever'] } }
-
-    it 'includes some errors' do
-      expect(subject.body.encoded).to match 'Errors'
-      expect(subject.body.encoded).to match 'Row 1: missing title'
-      expect(subject.body.encoded).to match 'Row 20: whatever'
-    end
-  end
-end

data/spec/models/sir_trevor_rails/block_spec.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe SirTrevorRails::Block do
-  describe '.block_class' do
-    subject { described_class }
-
-    describe 'for known type' do
-      let(:klass) { subject.block_class('browse') }
-
-      it 'returns class' do
-        expect(klass).to eq SirTrevorRails::Blocks::BrowseBlock
-      end
-
-      it 'returned class is the one defined in file' do
-        expect(klass.method_defined?(:searches)).to be true
-      end
-    end
-
-    describe 'for unknown type' do
-      let(:klass) { subject.block_class('unknown') }
-
-      it 'defines and returns class' do
-        expect(klass).to eq SirTrevorRails::Blocks::UnknownBlock
-      end
-
-      it 'defines class that inherits from Block' do
-        expect(klass.superclass).to eq described_class
-      end
-    end
-  end
-
-  describe '.from_hash' do
-    let(:source_hash) { { type: 'test', data: {} } }
-    let(:block) { described_class.from_hash(source_hash, nil) }
-
-    it 'initializes new block based on type field' do
-      expect(block).to be_a_kind_of SirTrevorRails::Blocks::TestBlock
-    end
-
-    it 'creates accessors for all fields defined in data field' do
-      source_hash[:data].merge!(width: '100')
-
-      expect(block.width).to eq '100'
-    end
-  end
-
-  describe 'JSON representation' do
-    let(:empty_source_hash) { { type: 'test', data: {} } }
-    let(:empty_block) { described_class.from_hash(empty_source_hash, nil) }
-    let(:data_source_hash) { { type: 'test', data: { one: 2, three: 4 } } }
-    let(:data_block) { described_class.from_hash(data_source_hash, nil) }
-
-    it 'returns source hash when #as_json is called' do
-      expect(empty_block.as_json).to eq empty_source_hash
-    end
-
-    it 'serializes block data' do
-      expect(data_block.as_json).to eq data_source_hash
-    end
-  end
-
-  describe 'partial view lookup' do
-    let(:source_hash) { { type: 'test', data: {} } }
-    let(:block) { described_class.from_hash(source_hash, nil) }
-
-    it 'uses block type to find view paritals' do
-      expect(block.to_partial_path).to eq 'sir_trevor/blocks/test_block'
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/browse_block_spec.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::BrowseBlock do
-  subject { described_class.new({ type: '', data: block_data }, page) }
-
-  let(:page) { FactoryBot.create(:feature_page) }
-  let(:block_data) { {} }
-
-  describe '#items' do
-    it 'is the array of items with display set to true' do
-      block_data[:item] = {
-        '0': { id: 'abc123', display: 'true' },
-        '1': { id: 'xyz321', display: 'false' }
-      }
-      expect(subject.items.length).to eq 1
-      expect(subject.items).to eq([{ id: 'abc123', display: 'true' }])
-    end
-
-    it 'is an empty array when there is no browse category' do
-      expect(subject.items).to eq([])
-    end
-  end
-
-  describe '#as_json' do
-    context 'when no items are present' do
-      it 'returns an empty items value' do
-        block_data[:item] = nil
-        expect(subject.as_json[:data]).to include item: {}
-      end
-    end
-
-    context 'when the id of a browse category does not exist' do
-      it 'is not included the returned items hash' do
-        search = FactoryBot.create(:search, exhibit: page.exhibit)
-        block_data[:item] = { item_0: { 'id' => 'abc123' }, item_1: { 'id' => search.slug } }
-
-        expect(subject.as_json[:data][:item]).not_to have_key :item_0
-        expect(subject.as_json[:data][:item]).to have_key :item_1
-      end
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/browse_group_categories_block_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::BrowseGroupCategoriesBlock do
-  subject { described_class.new({ type: '', data: block_data }, page) }
-
-  let!(:exhibit) { FactoryBot.create(:exhibit) }
-  let!(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
-  let!(:group1) { FactoryBot.create(:group, exhibit: exhibit, title: 'abc123', published: true) }
-  let!(:group2) { FactoryBot.create(:group, exhibit: exhibit, title: 'xyz321', published: true) }
-
-  let(:block_data) { {} }
-
-  describe '#groups' do
-    it 'is the array of items with display set to true' do
-      block_data[:item] = {
-        '0': { id: 'abc123', display: 'true', weight: '2' },
-        '1': { id: 'xyz321', display: 'true', weight: '1' }
-      }
-      expect(subject.groups.length).to eq 2
-      expect(subject.groups.first.title).to eq 'xyz321'
-    end
-  end
-
-  describe '#groups?' do
-    it 'is the array of items with display set to true' do
-      block_data[:item] = {}
-      expect(subject.be_groups).to be_falsy
-    end
-  end
-
-  describe '#display_item_counts?' do
-    it do
-      expect(subject).not_to be_display_item_counts
-    end
-
-    it do
-      block_data['display-item-counts'] = 'true'
-      expect(subject).to be_display_item_counts
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/featured_pages_block_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::FeaturedPagesBlock do
-  subject { described_class.new({ type: '', data: block_data }, page) }
-
-  let(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-  let(:block_data) { {} }
-
-  describe '#items' do
-    it 'is the array of items with display set to true' do
-      block_data[:item] = {
-        '0': { id: 'abc123', display: 'true' },
-        '1': { id: 'xyz321', display: 'false' }
-      }
-      expect(subject.items.length).to eq 1
-      expect(subject.items).to eq([{ id: 'abc123', display: 'true' }])
-    end
-
-    it 'is an empty array when there is no browse category' do
-      expect(subject.items).to eq([])
-    end
-  end
-
-  describe '#pages' do
-    let!(:page_a) { FactoryBot.create(:feature_page, slug: 'a', exhibit: exhibit) }
-    let!(:translated_page_a) { page_a.clone_for_locale('a').tap { |x| x.update(published: true) && x.save } }
-    let!(:page_b) { FactoryBot.create(:feature_page, slug: 'b', exhibit: exhibit) }
-
-    before do
-      block_data[:item] = {
-        '0': { id: 'a', display: 'true' },
-        '1': { id: 'b', display: 'true' }
-      }
-    end
-
-    it 'retrieves the pages from the default locale' do
-      expect(subject.pages.length).to eq 2
-    end
-  end
-
-  describe '#as_json' do
-    context 'when no items are present' do
-      it 'returns an empty items value' do
-        block_data[:item] = nil
-        expect(subject.as_json[:data]).to include item: {}
-      end
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/search_results_block_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::SearchResultsBlock do
-  subject { described_class.new({ type: '', data: block_data }, page) }
-
-  let(:page) { FactoryBot.create(:feature_page) }
-  let(:block_data) { {} }
-
-  describe '#items' do
-    it 'is the array of items with display set to true' do
-      block_data[:item] = {
-        '0': { id: 'abc123', display: 'true' },
-        '1': { id: 'xyz321', display: 'false' }
-      }
-      expect(subject.items.length).to eq 1
-      expect(subject.items).to eq([{ id: 'abc123', display: 'true' }])
-    end
-
-    it 'is an empty array when there is no browse category' do
-      expect(subject.items).to eq([])
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/solr_documents_block_spec.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::SolrDocumentsBlock do
-  subject { described_class.new({ type: '', data: block_data }, page) }
-
-  let(:page) { FactoryBot.create(:feature_page) }
-  let(:block_data) { {} }
-
-  describe '#text' do
-    it "is the block's text data" do
-      block_data[:text] = 'abc'
-
-      expect(subject.text).to eq 'abc'
-    end
-
-    it "squelches sir-trevor's placeholder values" do
-      block_data[:text] = '<p><br></p>'
-      expect(subject.text).to be_blank
-    end
-  end
-
-  describe '#primary_caption?' do
-    it 'is false if the primary caption field is not configured' do
-      block_data['show-primary-caption'] = 'true'
-      expect(subject.primary_caption?).to eq false
-    end
-
-    it 'is false if the field is configured not to show' do
-      block_data['primary-caption-field'] = 'some_field'
-      block_data['show-primary-caption'] = 'false'
-      expect(subject.primary_caption?).to eq false
-    end
-
-    it 'is true if the field is configured to show' do
-      block_data['primary-caption-field'] = 'some_field'
-      block_data['show-primary-caption'] = 'true'
-      expect(subject.primary_caption?).to eq true
-    end
-  end
-
-  describe '#secondary_caption?' do
-    it 'is false if the secondary caption field is not configured' do
-      block_data['show-secondary-caption'] = 'true'
-      expect(subject.secondary_caption?).to eq false
-    end
-
-    it 'is false if the field is configured not to show' do
-      block_data['secondary-caption-field'] = 'some_field'
-      block_data['show-secondary-caption'] = 'false'
-      expect(subject.secondary_caption?).to eq false
-    end
-
-    it 'is true if the field is configured to show' do
-      block_data['secondary-caption-field'] = 'some_field'
-      block_data['show-secondary-caption'] = 'true'
-      expect(subject.secondary_caption?).to eq true
-    end
-  end
-end

data/spec/models/sir_trevor_rails/blocks/textable_spec.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-describe SirTrevorRails::Blocks::Textable do
-  class TextableTestClass
-    include SirTrevorRails::Blocks::Textable
-    attr_accessor :text
-  end
-  let(:subject) { TextableTestClass.new }
-  let(:st_blank_text) { '<p><br></p>' }
-
-  describe '#text?' do
-    it 'returns false when there is no text' do
-      expect(subject).not_to be_text
-    end
-
-    it 'returns true false when the text is the default sir-trevor text' do
-      allow(subject).to receive_messages(text: st_blank_text)
-      expect(subject).to be_text
-    end
-  end
-
-  describe '#text_align' do
-    it 'proxies the sir-trevor text-align attribute' do
-      allow(subject).to receive_messages('text-align' => 'text-align-value')
-      expect(subject.text_align).to eq 'text-align-value'
-    end
-  end
-
-  describe '#content_align' do
-    it 'is the reverse of text-align' do
-      allow(subject).to receive_messages(text: 'TextContent')
-      allow(subject).to receive_messages(text_align: 'left')
-      expect(subject.content_align).to eq 'right'
-      allow(subject).to receive_messages(text_align: 'right')
-      expect(subject.content_align).to eq 'left'
-    end
-
-    it 'does not have any alignment if there is no text' do
-      expect(subject.content_align).to be_nil
-    end
-  end
-end