blacklight-spotlight 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb87cc0336538721053f1ae27eb72f144a749e34
-  data.tar.gz: 7f6f669a329a037b4837b425e0f794d3e00ed237
+  metadata.gz: 14ae1aa0767b7c480a27e35a4a6331075b1f3702
+  data.tar.gz: dfa1d2438093e6b83410ec483848062973583516
 SHA512:
-  metadata.gz: d79777da225046b586c153aa3f0401b25c50ce3c9e3189ad22eea395c28615a03a30e7aa4625303e2bb69416c374ffefee60f78d053ec0c5ebbe685e8e737d7a
-  data.tar.gz: fb37ce544eeb851a99b06327a54493b6b929f5cdddff430c32a35345fb25a8ee7ff26a3ce7da73367060a1dd851ac8397ec4aa74fe6e63c7c7390dbbc22032b4
+  metadata.gz: 7af943f098a05fa6f82edc569cf681d9729801506ac917799ea3a09bda594800ed1b7a22db24b5bcdc0e2a2eebd191091b915b35c0aceae2914b241954fa1396
+  data.tar.gz: f64bf52002e9bf0c3f6ced2c1fac718368a8f6a3bd18916c4a09ffec164212fb4d54e252f06af00dc59fe5da72b930a90956a3ec7395c4e93ed57a7ee8b64cb7

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

@@ -24,9 +24,9 @@ module Spotlight
     ##
     # Class-level methods
     module ClassMethods
-      def build_for_exhibit(id, exhibit)
+      def build_for_exhibit(id, exhibit, attributes = {})
         new(unique_key => id) do |doc|
-          doc.sidecar(exhibit).save! # save is a nop if the sidecar isn't modified.
+          doc.sidecar(exhibit).tap { |x| x.assign_attributes(attributes) }.save! # save is a nop if the sidecar isn't modified.
         end
       end
 

data/app/models/spotlight/blacklight_configuration.rb

@@ -193,7 +193,7 @@ module Spotlight
     def custom_index_fields
       Hash[exhibit.custom_fields.map do |x|
         field = Blacklight::Configuration::IndexField.new x.configuration.merge(
-          key: x.field, field: x.solr_field
+          key: x.field, field: x.solr_field, custom_field: true
         )
         [x.field, field]
       end]
@@ -202,7 +202,7 @@ module Spotlight
     def custom_facet_fields
       Hash[exhibit.custom_fields.vocab.map do |x|
         field = Blacklight::Configuration::FacetField.new x.configuration.merge(
-          key: x.field, field: x.solr_field, show: false
+          key: x.field, field: x.solr_field, show: false, custom_field: true
         )
         [x.field, field]
       end]

data/app/models/spotlight/resource.rb

@@ -13,6 +13,8 @@ module Spotlight
     class_attribute :weight
 
     belongs_to :exhibit
+    has_many :solr_document_sidecars
+
     serialize :data, Hash
     store :metadata, accessors: [
       :enqueued_at,

data/app/models/spotlight/solr_document_sidecar.rb

@@ -3,9 +3,12 @@ module Spotlight
   # Exhibit-specific metadata for indexed documents
   class SolrDocumentSidecar < ActiveRecord::Base
     belongs_to :exhibit, required: true
+    belongs_to :resource
     belongs_to :document, required: true, polymorphic: true
     serialize :data, Hash
 
+    store :data, accessors: [:index_status]
+
     delegate :has_key?, :key?, to: :data
 
     def to_solr

data/app/services/spotlight/solr_document_builder.rb

@@ -51,7 +51,7 @@ module Spotlight
     # @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)
+      document_model.build_for_exhibit(id, exhibit, resource: resource)
     end
 
     def unique_key

data/app/views/spotlight/search_configurations/_facets.html.erb

@@ -4,6 +4,7 @@
     <%= f.fields_for :facet_fields do |idxf| %>
       <% @blacklight_configuration.blacklight_config.facet_fields.each do |key, config| %>
         <% metadata = @field_metadata.field(key) %>
+        <% next unless metadata[:document_count] > 0 || config.custom_field %>
         <li class="dd-item" data-id="<%= key.parameterize %>">
           <div class="dd-handle dd3-handle"><%= t :drag %></div>
           <%= idxf.fields_for key do |facet| %>

data/db/migrate/20160815165432_add_resource_to_solr_document_sidecar.rb

@@ -0,0 +1,8 @@
+class AddResourceToSolrDocumentSidecar < ActiveRecord::Migration
+  def change
+    add_column :spotlight_solr_document_sidecars, :resource_id, :integer
+    add_column :spotlight_solr_document_sidecars, :resource_type, :string
+
+    add_index :spotlight_solr_document_sidecars, [:resource_type, :resource_id], name: 'spotlight_solr_document_sidecars_resource'
+  end
+end

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '0.26.1'.freeze
+  VERSION = '0.27.0'.freeze
 end

data/spec/models/spotlight/blacklight_configuration_spec.rb

@@ -457,6 +457,20 @@ describe Spotlight::BlacklightConfiguration, type: :model do
     end
   end
 
+  describe '#custom_facet_fields' do
+    it 'converts exhibit-specific fields to Blacklight configurations' do
+      allow(subject.exhibit).to receive_message_chain(:custom_fields, vocab: [
+                                                        stub_model(Spotlight::CustomField, field: 'abc', configuration: { a: 1 }, exhibit: subject.exhibit),
+                                                        stub_model(Spotlight::CustomField, field: 'xyz', configuration: { x: 2 }, exhibit: subject.exhibit)
+                                                      ])
+
+      expect(subject.custom_facet_fields).to include 'abc', 'xyz'
+      expect(subject.custom_facet_fields['abc']).to be_a_kind_of Blacklight::Configuration::Field
+      expect(subject.custom_facet_fields['abc'].a).to eq 1
+      expect(subject.custom_facet_fields['abc'].custom_field).to eq true
+    end
+  end
+
   describe '#custom_index_fields' do
     it 'converts exhibit-specific fields to Blacklight configurations' do
       allow(subject.exhibit).to receive_messages(custom_fields: [
@@ -467,6 +481,7 @@ describe Spotlight::BlacklightConfiguration, type: :model do
       expect(subject.custom_index_fields).to include 'abc', 'xyz'
       expect(subject.custom_index_fields['abc']).to be_a_kind_of Blacklight::Configuration::Field
       expect(subject.custom_index_fields['abc'].a).to eq 1
+      expect(subject.custom_index_fields['abc'].custom_field).to eq true
     end
   end
 

data/spec/services/spotlight/solr_document_builder_spec.rb

@@ -34,6 +34,15 @@ describe Spotlight::SolrDocumentBuilder do
         expect(result).to include "spotlight_exhibit_slug_#{resource.exhibit.slug}_bsi"
         expect(result).to include "spotlight_exhibit_slug_#{resource_alt.exhibit.slug}_bsi"
       end
+
+      it 'creates a sidecar resource for the document' do
+        resource.document_builder.documents_to_index.first
+
+        expect(Spotlight::SolrDocumentSidecar.where(document_id: 'abc123', document_type: SolrDocument).size).to eq 2
+        sidecar = resource.solr_document_sidecars.find_by(document_id: 'abc123', document_type: SolrDocument)
+        expect(sidecar.exhibit).to eq resource.exhibit
+        expect(sidecar.resource).to eq resource
+      end
     end
   end
 end

data/spec/views/spotlight/search_configurations/_facets.html.erb_spec.rb

@@ -0,0 +1,40 @@
+describe 'spotlight/search_configurations/_facets', type: :view do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+  let!(:custom_field) { FactoryGirl.create(:custom_field, exhibit: exhibit, label: 'Foobar', field_type: 'vocab') }
+  let(:config) do
+    exhibit.blacklight_configuration
+  end
+  let(:field_metadata) { double('field_metadata') }
+  let(:empty_facet) { { document_count: 0, value_count: 0, terms: [] } }
+  let(:nonempty_facet) { { document_count: 1, value_count: 3, terms: %w(a b c) } }
+  let(:f) do
+    form_helper = nil
+    controller.view_context.bootstrap_form_for(config, url: '/update') do |f|
+      form_helper = f
+    end
+    form_helper
+  end
+
+  before do
+    assign(:blacklight_configuration, config)
+    allow(view).to receive_messages(current_exhibit: exhibit,
+                                    blacklight_config: config.blacklight_config)
+    allow(field_metadata).to receive(:field).with(any_args).and_return(nonempty_facet)
+    allow(field_metadata).to receive(:field).with('genre_ssim').and_return(empty_facet)
+    allow(field_metadata).to receive(:field).with(custom_field.field).and_return(empty_facet)
+    assign(:field_metadata, field_metadata)
+    render partial: 'spotlight/search_configurations/facets', locals: { f: f }
+  end
+
+  it 'shows the config for the non-empty personal name facet' do
+    expect(rendered).to have_content 'Personal Names'
+  end
+
+  it 'shows the config for the empty custom facet' do
+    expect(rendered).to have_content 'Foobar'
+  end
+
+  it 'hides the config for the empty genre facet' do
+    expect(rendered).not_to have_content 'Genre'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -1121,6 +1121,7 @@ files:
 - db/migrate/20151217211019_create_spotlight_exhibit_filters.rb
 - db/migrate/20160329215014_add_readonly_to_custom_fields.rb
 - db/migrate/20160711121314_add_default_view_to_spotlight_searches.rb
+- db/migrate/20160815165432_add_resource_to_solr_document_sidecar.rb
 - lib/blacklight/spotlight.rb
 - lib/generators/spotlight/install_generator.rb
 - lib/generators/spotlight/scaffold_resource_generator.rb
@@ -1340,6 +1341,7 @@ files:
 - spec/views/spotlight/resources/new.html.erb_spec.rb
 - spec/views/spotlight/roles/index.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_facet_metadata.html.erb_spec.rb
+- spec/views/spotlight/search_configurations/_facets.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_search_fields.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_sort.html.erb_spec.rb
 - spec/views/spotlight/searches/_search.html.erb_spec.rb
@@ -1610,6 +1612,7 @@ test_files:
 - spec/views/spotlight/resources/new.html.erb_spec.rb
 - spec/views/spotlight/roles/index.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_facet_metadata.html.erb_spec.rb
+- spec/views/spotlight/search_configurations/_facets.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_search_fields.html.erb_spec.rb
 - spec/views/spotlight/search_configurations/_sort.html.erb_spec.rb
 - spec/views/spotlight/searches/_search.html.erb_spec.rb