blacklight-spotlight 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38fb99b5c2366b2cf6ac5a264e215ed7b0611c43
-  data.tar.gz: 72ba109b5f3c5d257de360f0faf3b8a6eee1b24b
+  metadata.gz: 27f15696fa8fa3ff1b57d0fbdeb5ac72e46e0dd9
+  data.tar.gz: a2187ef8f724bf5e79d56b03068ccbedfd3e24cf
 SHA512:
-  metadata.gz: 029fc6b6a22f5e5b12c71d50a2721a6f638a808988dbfdc2e3fafa614fb670d11eedd62fe45a15da36aa1262b1c8098efa16bb659594a65998065605520da1ad
-  data.tar.gz: dfccd052193692da330ee70c0bc9b728961fd36ab8855884d7a9ff7cdd2a495370a99ebc66a4574904f6092f90edc5c5349c0aa7b87eb6554b75108d606db50b
+  metadata.gz: cbcea53ab6c6ea3b79857aa243332f041cf7aa50a88f0d3aaf9d96b9b99383058bce9c387b7728a6af8087b6c8de0775916bd5ce4e06af9827dc300051458f29
+  data.tar.gz: e82d5776c0494429db93f78508fc150c69e0dae0bd13f32740689e440d662107c9a84d55ad9010d8c1da33fb4dd39d4ef80b82b97dd805c2e17df221210eb0c9

data/Rakefile

@@ -89,7 +89,7 @@ namespace :spotlight do
 
                 _, exit_status = Process.wait2(io.pid)
 
-                raise 'Failed to generate spotlight' if exit_status != 0
+                raise 'Failed to generate spotlight' if exit_status.nonzero?
               end
             end
 

data/app/controllers/spotlight/exhibits_controller.rb

@@ -8,7 +8,7 @@ module Spotlight
     load_and_authorize_resource
 
     def index
-      @published_exhibits = @exhibits.published.page(params[:page])
+      @published_exhibits = @exhibits.published.ordered_by_weight.page(params[:page])
       @published_exhibits = @published_exhibits.tagged_with(params[:tag]) if params[:tag]
 
       if @exhibits.one?

data/app/models/concerns/spotlight/ar_light.rb

@@ -66,6 +66,7 @@ module Spotlight
     def initialize(source_doc = {}, solr_response = nil)
       @association_cache = {}
       super
+      yield self if block_given?
     end
 
     # Returns true if +comparison_object+ is the same exact object, or +comparison_object+

data/app/models/concerns/spotlight/solr_document.rb

@@ -25,6 +25,12 @@ module Spotlight
     ##
     # Class-level methods
     module ClassMethods
+      def build_for_exhibit(id, exhibit)
+        new(unique_key => id) do |doc|
+          doc.sidecar(exhibit).save! # save is a nop if the sidecar isn't modified.
+        end
+      end
+
       def reindex(id)
         find(id).reindex
       rescue Blacklight::Exceptions::InvalidSolrID => e

data/app/models/spotlight/exhibit.rb

@@ -9,6 +9,7 @@ module Spotlight
 
     scope :published, -> { where(published: true) }
     scope :unpublished, -> { where(published: false) }
+    scope :ordered_by_weight, -> { order('weight ASC') }
 
     paginates_per 50
 
@@ -17,8 +18,6 @@ module Spotlight
     validates :title, presence: true
     validates :slug, uniqueness: true
 
-    default_scope { order('weight ASC') }
-
     acts_as_tagger
     acts_as_taggable
     delegate :blacklight_config, to: :blacklight_configuration

data/app/models/spotlight/resource.rb

@@ -2,7 +2,6 @@ module Spotlight
   ##
   # Exhibit resources
   class Resource < ActiveRecord::Base
-    include Spotlight::SolrDocument::AtomicUpdates
     include ActiveSupport::Benchmarkable
 
     class_attribute :document_builder_class
@@ -116,6 +115,10 @@ module Spotlight
       rescue => e
         Rails.logger.warn "Unable to commit to solr: #{e}"
       end
+
+      def write?
+        Spotlight::Engine.config.writable_index
+      end
     end
   end
 end

data/app/models/spotlight/site.rb

@@ -2,7 +2,7 @@ module Spotlight
   ##
   # Global spotlight configuration
   class Site < ActiveRecord::Base
-    has_many :exhibits
+    has_many :exhibits, -> { ordered_by_weight }
     has_many :roles, as: :resource
 
     belongs_to :masthead, dependent: :destroy

data/app/models/spotlight/solr_document_sidecar.rb

@@ -2,14 +2,17 @@ module Spotlight
   ##
   # Exhibit-specific metadata for indexed documents
   class SolrDocumentSidecar < ActiveRecord::Base
-    belongs_to :exhibit
-    belongs_to :document, polymorphic: true
+    belongs_to :exhibit, required: true
+    belongs_to :document, required: true, polymorphic: true
     serialize :data, Hash
 
     delegate :has_key?, :key?, to: :data
 
     def to_solr
-      { document.class.unique_key.to_sym => document.id, visibility_field => public? }.merge(data_to_solr)
+      { document.class.unique_key.to_sym => document.id,
+        visibility_field => public? }
+        .merge(data_to_solr)
+        .merge(exhibit.solr_data)
     end
 
     def private!

data/app/services/spotlight/solr_document_builder.rb

@@ -18,7 +18,7 @@ module Spotlight
       return to_enum(:documents_to_index) { data.size } unless block_given?
 
       data.lazy.reject(&:blank?).each do |doc|
-        yield doc.reverse_merge(existing_solr_doc_hash(doc[unique_key]) || {})
+        yield doc.reverse_merge(exhibit_solr_doc(doc[unique_key]).to_solr)
       end
     end
 
@@ -33,16 +33,25 @@ module Spotlight
     # @return [Enumerator<Hash>] multiple solr document hashes. This can be a
     #   simple array, or an lazy enumerator
     def to_solr
-      (exhibit_specific_solr_data || {}).merge(spotlight_resource_metadata_for_solr || {})
+      spotlight_resource_metadata_for_solr
     end
 
     private
 
+    # Null object for SolrDocument
+    module NilSolrDocument
+      def self.to_solr
+        {}
+      end
+    end
+
     ##
     # Get any exhibit-specific metadata stored in e.g. sidecars, tags, etc
     # This needs the generated solr document
-    def existing_solr_doc_hash(id)
-      document_model.new(unique_key => id).to_solr if document_model && id.present?
+    # @returns [#to_solr] something that responds to `to_solr'
+    def exhibit_solr_doc(id)
+      return NilSolrDocument unless document_model || id.present?
+      document_model.build_for_exhibit(id, exhibit)
     end
 
     def unique_key
@@ -53,10 +62,6 @@ module Spotlight
       end
     end
 
-    def exhibit_specific_solr_data
-      exhibit.solr_data if exhibit
-    end
-
     def spotlight_resource_metadata_for_solr
       {
         Spotlight::Engine.config.resource_global_id_field => (resource.to_global_id.to_s if resource.persisted?),

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '0.19.2'.freeze
+  VERSION = '0.20.0'.freeze
 end

data/spec/controllers/spotlight/sites_controller_spec.rb

@@ -38,7 +38,7 @@ describe Spotlight::SitesController, type: :controller do
 
         expect(response).to redirect_to(exhibits_path)
 
-        expect(Spotlight::Exhibit.all.first).to eq exhibit_b
+        expect(Spotlight::Exhibit.ordered_by_weight.first).to eq exhibit_b
         expect(exhibit_a.reload.weight).to eq 5
       end
     end

data/spec/models/solr_document_spec.rb

@@ -1,5 +1,6 @@
 describe SolrDocument, type: :model do
-  subject { described_class.new(id: 'abcd123') }
+  let(:document) { described_class.new(id: 'abcd123') }
+  subject { document }
   its(:to_key) { should == ['abcd123'] }
   its(:persisted?) { should be_truthy }
   before do
@@ -9,6 +10,16 @@ describe SolrDocument, type: :model do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
   let(:exhibit_alt) { FactoryGirl.create(:exhibit) }
 
+  describe '.build_for_exhibit' do
+    let(:id) { '123abc' }
+    subject { described_class.build_for_exhibit(id, exhibit) }
+
+    it 'has a persisted sidecar' do
+      expect(subject.sidecars.first).to be_persisted
+      expect(subject.sidecars.first.exhibit).to eq exhibit
+    end
+  end
+
   it 'has tags on the exhibit' do
     expect(subject.tags_from(exhibit)).to be_empty
   end

data/spec/services/spotlight/solr_document_builder_spec.rb

@@ -13,10 +13,27 @@ describe Spotlight::SolrDocumentBuilder do
     it 'includes a reference to the resource' do
       expect(subject).to include spotlight_resource_id_ssim: resource.to_global_id.to_s
     end
+  end
+
+  describe '#documents_to_index' do
+    context 'when the document belongs to more than one exhibit' do
+      let(:doc) { SolrDocument.new(id: 'abc123') }
+      let(:resource) { FactoryGirl.create(:resource) }
+      let(:resource_alt) { FactoryGirl.create(:resource) }
+      subject { resource.document_builder }
+
+      before do
+        allow(Spotlight::Engine.config).to receive(:filter_resources_by_exhibit).and_return(true)
+        allow(resource.document_builder).to receive(:to_solr).and_return(id: 'abc123')
+        allow(resource_alt.document_builder).to receive(:to_solr).and_return(id: 'abc123')
+        resource_alt.document_builder.documents_to_index.first
+      end
 
-    it 'includes exhibit-specific data' do
-      allow(exhibit).to receive(:solr_data).and_return(exhibit_data: true)
-      expect(subject).to include exhibit_data: true
+      it 'has filter data for both exhibits' do
+        result = resource.document_builder.documents_to_index.first
+        expect(result).to include "spotlight_exhibit_slug_#{resource.exhibit.slug}_bsi"
+        expect(result).to include "spotlight_exhibit_slug_#{resource_alt.exhibit.slug}_bsi"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -1385,7 +1385,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enable librarians, curators, and others who are responsible for digital collections