blacklight-spotlight 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a848d17a782a172979d2f5f1474be224e5aa50
-  data.tar.gz: aaf3bb7c7c594a324f31bacc68a854576bcadfa3
+  metadata.gz: b0aefec4ae05cfb0ff575bc3f774e69f8e949757
+  data.tar.gz: 2bf34ba4683b051d523cb98e461e96fa2cad2149
 SHA512:
-  metadata.gz: fa6893ca19f7e9607d5398f2920af9954b9edee98a4e0cd59e120057ed1aed8c0b901bbe2933efdd9aef2140a6c04708b442472b8a55133055db960be35e9190
-  data.tar.gz: 41d04adaad2035a0ee4693b41ed794fe5b8d4d627f1b638cc6d07967385919424c4789e0ef4e1ff13a14b3a57cb950bd333f02120fe522a5fd1cd102b9e5b468
+  metadata.gz: e6e7e9d9b16f7267bb1862edc08be110799329d727cdf4d6e208e70af90442c665733aaa3d750dd26c26215a456dc04c9a22e53d711e2c9358cc385194fef93f
+  data.tar.gz: 44143ac2594a25f1b191c8117bd986b90d593bb7d95c36d6fe0b04f20d8e89665551ac3ce8373115c2cf1e957fb8b5ff015e34de1bbd6f6de51dcc29592c4381

data/app/assets/stylesheets/spotlight/_header.scss

@@ -36,7 +36,6 @@
   background-color: $masthead-bg;
   border-bottom: 1px solid $navbar-default-border;
   margin-bottom: $padding-large-vertical * 2.5;
-  overflow: hidden;
   padding: 0;
   position: relative;
   // allow dropdowns in the top nav to stack above the masthead
@@ -126,7 +125,7 @@
     -webkit-filter: blur($masthead-image-blur);
     filter: blur($masthead-image-blur);
 
-    height: $masthead-height;
+    height: 100%;
 
     // Shift image slightly to hide blurred edge of image
     margin-left: -$masthead-image-blur;
@@ -145,7 +144,7 @@
        rgba(0, 0, 0, 0.5)
      );
 
-    height: $masthead-height;
+    height: 100%;
   }
 }
 

data/app/controllers/spotlight/search_configurations_controller.rb

@@ -21,7 +21,7 @@ module Spotlight
       add_breadcrumb t(:'spotlight.configuration.sidebar.header'), exhibit_dashboard_path(@exhibit)
       add_breadcrumb t(:'spotlight.configuration.sidebar.search_configuration'), edit_exhibit_search_configuration_path(@exhibit)
 
-      @field_metadata = Spotlight::FieldMetadata.new(repository, @blacklight_configuration.blacklight_config)
+      @field_metadata = Spotlight::FieldMetadata.new(current_exhibit, repository, @blacklight_configuration.blacklight_config)
     end
 
     def update

data/app/helpers/spotlight/application_helper.rb

@@ -107,8 +107,8 @@ module Spotlight
         class: 'btn btn-default btn-xs metadata-select',
         data: {
           behavior: 'metadata-select',
-          'deselect-text': t(:".deselect_all"),
-          'select-text': t(:".select_all")
+          'deselect-text' => t(:".deselect_all"),
+          'select-text' => t(:".select_all")
         }
       )
     end

data/app/helpers/spotlight/pages_helper.rb

@@ -37,11 +37,11 @@ module Spotlight
     def nestable_data_attributes_hash(type)
       case type
       when 'feature_pages'
-        { "data-max-depth": '2',
-          "data-expand-btn-HTML": '',
-          "data-collapse-btn-HTML": '' }
+        { 'data-max-depth' => '2',
+          'data-expand-btn-HTML' => '',
+          'data-collapse-btn-HTML' => '' }
       when 'about_pages'
-        { "data-max-depth": '1' }
+        { 'data-max-depth' => '1' }
       else
         {}
       end

data/app/models/spotlight/field_metadata.rb

@@ -2,8 +2,12 @@ module Spotlight
   ##
   # Expose Solr index metadata about fields
   class FieldMetadata
-    attr_reader :repository, :blacklight_config
-    def initialize(repository, blacklight_config)
+    FACET_LIMIT = 20
+
+    attr_reader :exhibit, :repository, :blacklight_config
+
+    def initialize(exhibit, repository, blacklight_config)
+      @exhibit = exhibit
       @repository = repository
       @blacklight_config = blacklight_config
     end
@@ -11,36 +15,52 @@ module Spotlight
     def field(field_name)
       {
         document_count: document_counts.fetch(field_name, 0),
-        value_count: fields.fetch(field_name, {}).fetch('distinct', 0),
-        terms: fields.fetch(field_name, {}).fetch('topTerms', [])
+        value_count: terms.fetch(field_name, []).length,
+        terms: terms.fetch(field_name, [])
       }
     end
 
+    def search_params
+      search_builder.merge(rows: 0, 'facet.limit' => FACET_LIMIT + 1)
+    end
+
     private
 
-    def luke
-      @luke ||= repository.send_and_receive('admin/luke', fl: '*', 'json.nl' => 'map')
+    def search_builder_class
+      blacklight_config.search_builder_class
+    end
+
+    def search_builder
+      search_builder_class.new(true, self)
     end
 
-    def fields
-      luke['fields']
+    def solr_response
+      @solr_response ||= repository.search(search_params.merge('facet.query' => facet_fields.map { |_key, fields| "#{fields.field}:[* TO *]" },
+                                                               'rows' => 0,
+                                                               'facet' => true))
     end
 
     # This gets the number of *documents* with a field
     def document_counts
       @document_count ||= begin
-        solr_resp = repository.search('facet.query' => facet_fields.map { |_key, fields| "#{fields.field}:[* TO *]" },
-                                      'rows' => 0,
-                                      'facet' => true)
-
-        solr_resp['facet_counts']['facet_queries'].each_with_object({}) do |(k, v), h|
+        solr_response.facet_queries.each_with_object({}) do |(k, v), h|
           h[k.split(/:/).first] = v
         end
       end
     end
 
+    def terms
+      @terms ||= begin
+        solr_response.aggregations.each_with_object({}) do |(facet_name, facet), h|
+          h[facet_name] = facet.items.map(&:label)
+        end
+      end
+    end
+
     def facet_fields
       blacklight_config.facet_fields.reject { |_k, v| v.pivot || v.query }
     end
+
+    alias_method :current_exhibit, :exhibit
   end
 end

data/app/views/spotlight/roles/_edit_fields.html.erb

@@ -2,7 +2,7 @@
           <td>
             <%= f.email_field :user_key, hide_label: true, disabled: f.object.persisted?, data: { behavior: 'check-user-existence' } %>
             <span style='display:none' class='help-block' data-behavior='no-user-note'>
-              <%= t('.invite_html', link: link_to(t('.invite_link'), spotlight.invite_exhibit_roles_path(current_exhibit), data: { method: 'post', 'invite-url': spotlight.invite_exhibit_roles_path(current_exhibit) })) %>
+              <%= t('.invite_html', link: link_to(t('.invite_link'), spotlight.invite_exhibit_roles_path(current_exhibit), data: { method: 'post', 'invite-url' => spotlight.invite_exhibit_roles_path(current_exhibit) })) %>
               <span class='label label-warning pending-label'><%= t('.pending') %></span>
             </span>
           </td>

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

@@ -0,0 +1,12 @@
+<%= content_tag :span, t(:'.document_count', count: metadata[:document_count]) %>
+<% if metadata[:document_count] > 0 %>
+  •
+  <% if metadata[:value_count] > Spotlight::FieldMetadata::FACET_LIMIT %>
+    <%= content_tag :span, t(:'.too_many_values_count', count: Spotlight::FieldMetadata::FACET_LIMIT) %>
+  <% else %>
+    <%= content_tag :span, t(:'.value_count', count: metadata[:value_count]) %>
+  <% end %>
+  <% if metadata[:terms].any? %>
+    <%= tag("span", class: 'btn-with-tooltip glyphicon glyphicon-info-sign', data: {container: 'body', toggle: 'tooltip', placement: 'top', title: metadata[:terms].join(" • ")}) %>
+  <% end %>
+<% end %>

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

@@ -19,13 +19,7 @@
                     </h3>
                   </div>
                   <div class="facet-metadata col-sm-5">
-                    <%= content_tag :span, t(:'.document_count', count: metadata[:document_count]) %>
-                    <% if metadata[:document_count] > 0 %>
-                      • <%= content_tag :span, t(:'.value_count', count: metadata[:value_count]) %>
-                      <% if metadata[:terms].any? %>
-                        <%= tag("span", class: 'btn-with-tooltip glyphicon glyphicon-info-sign', data: {container: 'body', toggle: 'tooltip', placement: 'top', title: metadata[:terms].keys.map(&:to_s).join(" • ")}) %>
-                      <% end %>
-                    <% end %>
+                    <%= render partial: 'facet_metadata', locals: { metadata: metadata } %>
                   </div>
                   <div class="col-sm-2 pull-right">
                     <a class="btn btn-link collapse-toggle collapsed" role="button" data-toggle="collapse" href="#<%= key.parameterize %>_facet_options" aria-expanded="false" aria-controls="<%= key.parameterize %>_facet_options">

data/config/locales/spotlight.en.yml

@@ -183,16 +183,18 @@ en:
           the facets shown in the sidebar to limit a search.  You can select the facets
           that are available for searching below. Click a facet field name to edit its display label.
           Drag and drop facets to specify the order they are displayed in the sidebar.
+        sort_by:
+          label: "Sort by:"
+          count: Frequency
+          index: Value
+      facet_metadata:
         document_count:
           one: "%{count} item"
           other:  "%{count} items"
+        too_many_values_count: "%{count}+ unique values"
         value_count:
           one: "%{count} unique value"
           other: "%{count} unique values"
-        sort_by:
-          label: "Sort by:"
-          count: Frequency
-          index: Value
       sort:
         header: "Sort fields"
         help: >

data/db/migrate/20151215141516_change_roles_to_support_polymorphic_associations.rb

@@ -5,10 +5,10 @@ class ChangeRolesToSupportPolymorphicAssociations < ActiveRecord::Migration
 
     migrate_role_data_to_polymorphic_resource
 
+    remove_index :spotlight_roles, [:exhibit_id, :user_id]
     remove_column :spotlight_roles, :exhibit_id
 
     add_index :spotlight_roles, [:resource_type, :resource_id, :user_id], unique: true, name: 'index_spotlight_roles_on_resource_and_user_id'
-    remove_index :spotlight_roles, [:exhibit_id, :user_id]
   end
 
   def down
@@ -20,12 +20,13 @@ class ChangeRolesToSupportPolymorphicAssociations < ActiveRecord::Migration
     Spotlight::Role.find_each do |e|
       e.update(exhibit_id: e.resource_id) if e.exhibit_id.nil? && e.resource_type == 'Spotlight::Exhibit'
     end
+    
+    remove_index :spotlight_roles, name: 'index_spotlight_roles_on_resource_and_user_id'
 
     remove_column :spotlight_roles, :resource_id
     remove_column :spotlight_roles, :resource_type
 
     add_index :spotlight_roles, [:exhibit_id, :user_id], unique: true
-    remove_index :spotlight_roles, name: 'index_spotlight_roles_on_resource_and_user_id'
   end
 
   private

data/lib/spotlight.rb

@@ -4,8 +4,4 @@ require 'spotlight/engine'
 ##
 # Spotlight
 module Spotlight
-  autoload :Config, 'spotlight/config'
-  autoload :Base, 'spotlight/base'
-  autoload :Controller, 'spotlight/controller'
-  autoload :Catalog, 'spotlight/catalog'
 end

data/lib/spotlight/version.rb

@@ -1,4 +1,4 @@
 #
 module Spotlight
-  VERSION = '0.14.0'
+  VERSION = '0.14.1'
 end

data/spec/helpers/spotlight/pages_helper_spec.rb

@@ -82,12 +82,12 @@ module Spotlight
       end
       describe 'nestable data attributes hash' do
         it 'returns the appropriate hash for feature pages' do
-          expect(helper.nestable_data_attributes_hash('feature_pages')).to eq "data-max-depth": '2',
-                                                                              "data-expand-btn-HTML": '',
-                                                                              "data-collapse-btn-HTML": ''
+          expect(helper.nestable_data_attributes_hash('feature_pages')).to eq('data-max-depth' => '2',
+                                                                              'data-expand-btn-HTML' => '',
+                                                                              'data-collapse-btn-HTML' => '')
         end
         it 'returns the appropriate hash for about pages' do
-          expect(helper.nestable_data_attributes_hash('about_pages')).to eq "data-max-depth": '1'
+          expect(helper.nestable_data_attributes_hash('about_pages')).to eq 'data-max-depth' => '1'
         end
         it 'returns an empty hash if the type is not valid' do
           expect(helper.nestable_data_attributes_hash('something_else')).to eq({})

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

@@ -18,7 +18,7 @@ describe SirTrevorRails::Blocks::Textable do
   end
   describe '#text_align' do
     it 'proxies the sir-trevor text-align attribute' do
-      allow(subject).to receive_messages('text-align': 'text-align-value')
+      allow(subject).to receive_messages('text-align' => 'text-align-value')
       expect(subject.text_align).to eq 'text-align-value'
     end
   end

data/spec/models/spotlight/field_metadata_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Spotlight::FieldMetadata do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
   let(:repository) { double }
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
@@ -10,28 +11,15 @@ describe Spotlight::FieldMetadata do
     end
   end
 
-  let(:luke_response) do
-    {
-      fields: {
-        a: {
-          distinct: 100,
-          topTerms: %w(q w e)
-        },
-        b: {
-          distinct: 50,
-          topTerms: %w(r t y)
-        },
-        c: {
-          distinct: 3,
-          topTerms: [7, 8, 9]
-        }
-      }
-    }.with_indifferent_access
-  end
-
   let(:facet_response) do
     {
       facet_counts: {
+        facet_fields: {
+          a: { 'a' => 1, 'b' => 2, 'c' => 3 },
+          b: { 'b' => 1 },
+          c: { 7 => 1, 8 => 2, 9 => 3 }
+        },
+
         facet_queries: {
           'a:[* TO *]' => 5,
           'b:[* TO *]' => 10,
@@ -41,11 +29,10 @@ describe Spotlight::FieldMetadata do
     }.with_indifferent_access
   end
 
-  subject { described_class.new(repository, blacklight_config) }
+  subject { described_class.new(exhibit, repository, blacklight_config) }
 
   before do
-    allow(repository).to receive(:send_and_receive).with('admin/luke', hash_including(fl: '*')).and_return(luke_response)
-    allow(repository).to receive(:search).with(hash_including('facet' => true)).and_return(facet_response)
+    allow(repository).to receive(:search).with(an_instance_of(SearchBuilder)).and_return(Blacklight::Solr::Response.new(facet_response, {}))
   end
 
   describe '#field' do
@@ -56,14 +43,14 @@ describe Spotlight::FieldMetadata do
     end
 
     it 'has a value count' do
-      expect(subject.field('a')[:value_count]).to eq 100
-      expect(subject.field('b')[:value_count]).to eq 50
+      expect(subject.field('a')[:value_count]).to eq 3
+      expect(subject.field('b')[:value_count]).to eq 1
       expect(subject.field('c')[:value_count]).to eq 3
     end
 
     it 'gets a list of top terms' do
-      expect(subject.field('a')[:terms]).to match_array %w(q w e)
-      expect(subject.field('b')[:terms]).to match_array %w(r t y)
+      expect(subject.field('a')[:terms]).to match_array %w(a b c)
+      expect(subject.field('b')[:terms]).to match_array %w(b)
       expect(subject.field('c')[:terms]).to match_array [7, 8, 9]
     end
 

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Spotlight
+  describe 'spotlight/search_configurations/_facet_metadata', type: :view do
+    before do
+      render partial: 'spotlight/search_configurations/facet_metadata', locals: { metadata: metadata }
+    end
+
+    context 'with a facet without any documents' do
+      let(:metadata) { { document_count: 0 } }
+
+      it 'shows there are no documents' do
+        expect(rendered).to have_content '0 items'
+      end
+    end
+
+    context 'with a facet with a small number of values' do
+      let(:metadata) { { document_count: 1, value_count: 3, terms: %w(a b c) } }
+
+      it 'shows the number of unique values' do
+        expect(rendered).to have_content '1 item'
+        expect(rendered).to have_content '3 unique values'
+        expect(rendered).to have_selector '.btn-with-tooltip'
+      end
+    end
+
+    context 'with a facet with a large number of values' do
+      let(:metadata) { { document_count: 1, value_count: 21, terms: %w() } }
+
+      it 'shows there are many unique values' do
+        expect(rendered).to have_content '20+ unique values'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -793,6 +793,11 @@ files:
 - app/assets/stylesheets/spotlight/application.scss
 - app/assets/stylesheets/spotlight/typeahead.css
 - app/builders/spotlight/bootstrap_breadcrumbs_builder.rb
+- app/controllers/concerns/spotlight/base.rb
+- app/controllers/concerns/spotlight/catalog.rb
+- app/controllers/concerns/spotlight/catalog/access_controls_enforcement.rb
+- app/controllers/concerns/spotlight/config.rb
+- app/controllers/concerns/spotlight/controller.rb
 - app/controllers/spotlight/about_pages_controller.rb
 - app/controllers/spotlight/appearances_controller.rb
 - app/controllers/spotlight/application_controller.rb
@@ -1021,6 +1026,7 @@ files:
 - app/views/spotlight/roles/index.html.erb
 - app/views/spotlight/search_configurations/_default_per_page.html.erb
 - app/views/spotlight/search_configurations/_document_index_view_types.html.erb
+- app/views/spotlight/search_configurations/_facet_metadata.html.erb
 - app/views/spotlight/search_configurations/_facets.html.erb
 - app/views/spotlight/search_configurations/_search_fields.html.erb
 - app/views/spotlight/search_configurations/_sort.html.erb
@@ -1115,11 +1121,6 @@ files:
 - lib/generators/spotlight/templates/spotlight.scss
 - lib/generators/spotlight/templates/spotlight_helper.rb
 - lib/spotlight.rb
-- lib/spotlight/base.rb
-- lib/spotlight/catalog.rb
-- lib/spotlight/catalog/access_controls_enforcement.rb
-- lib/spotlight/config.rb
-- lib/spotlight/controller.rb
 - lib/spotlight/engine.rb
 - lib/spotlight/version.rb
 - lib/tasks/spotlight_tasks.rake
@@ -1311,6 +1312,7 @@ files:
 - spec/views/spotlight/pages/new.html.erb_spec.rb
 - spec/views/spotlight/pages/show.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/_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
@@ -1550,6 +1552,7 @@ test_files:
 - spec/views/spotlight/pages/new.html.erb_spec.rb
 - spec/views/spotlight/pages/show.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/_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