blacklight-spotlight 2.13.0 → 3.0.0.alpha.1

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

@@ -1,5 +1,11 @@
 #report-problem-form {
   display: none;
   background-color: #e7e7e7;
-  border-bottom: 1px dotted $gray-light;
+  border-bottom: 1px dotted $gray-600;
+}
+
+@include media-breakpoint-up(sm) {
+  #new_contact_form .col-form-label {
+    text-align: right;
+  }
 }

data/app/assets/stylesheets/spotlight/_sir-trevor_overrides.scss

@@ -24,8 +24,8 @@
 }
 
 .st-block__inner {
-  border: 1px solid $gray-lighter;
-  box-shadow: 3px 3px 15px $gray-lighter;
+  border: 1px solid $gray-700;
+  box-shadow: 3px 3px 15px $gray-700;
   margin: 1em 20px;
   padding: 1.875em 1.875em 2.8em;
 }
@@ -45,7 +45,7 @@
 
 .form-group .st-text-block {
   @extend .form-control;
-  height: auto;
+  height: auto !important;
   min-height: 6em;
 }
 
@@ -66,20 +66,20 @@
 }
 
 .spotlight-block-controls {
-  border: 1px solid $gray-lighter;
+  border: 1px solid $gray-700;
   border-radius: 4px;
-  box-shadow: 3px 3px 15px $gray-lighter;
+  box-shadow: 3px 3px 15px $gray-700;
   margin: 1em 20px;
   padding: 1.875em 1.875em 2.8em 70px;
 }
 
 .st-block-controls__button {
   @extend .btn;
-  @extend .btn-default;
+  @extend .btn-secondary;
 
-  background-color: $btn-default-bg;
-  border: 1px solid $gray-lighter;
-  color: $btn-default-color;
+  background-color: theme-colors("secondary");
+  border: 1px solid $gray-700;
+  color: theme-colors("light");
 
   .st-icon {
     margin-left: auto;

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

@@ -1,9 +1,10 @@
 .carousel-block {
-  
-  .carousel-inner > .item > a > img {
-    // center the image
+
+  .carousel-inner > .carousel-item > a > img {
+    // center and fill the image
     margin-left: auto;
     margin-right: auto;
+    max-width: 100%;
   }
 
   .carousel-caption {
@@ -15,13 +16,13 @@
     // fill left + right
     left: 0;
     right: 0;
-    
+
     // and add a nice background gradient to the captions
-    @include gradient-vertical($start-color: rgba(0,0,0,.0001), $end-color: rgba(0,0,0,.5));
+    @include gradient-y($start-color: rgba(0,0,0,.0001), $end-color: rgba(0,0,0,.5));
   }
 
   // Scale up controls for tablets and up
-  @media screen and (min-width: $screen-sm-min) {
+  @media screen and (min-width: breakpoint-min("sm")) {
     // Show and left align the captions
     .carousel-caption {
       left: 0;
@@ -31,19 +32,19 @@
   }
 
   &.carousel-height-small {
-    .carousel-inner > .item > a > img {
+    .carousel-inner > .carousel-item > a > img {
       height: 350px;
     }
   }
 
   &.carousel-height-medium {
-    .carousel-inner > .item > a > img {
+    .carousel-inner > .carousel-item > a > img {
       height: 500px;
     }
   }
 
   &.carousel-height-large {
-    .carousel-inner > .item > a > img {
+    .carousel-inner > .carousel-item > a > img {
       height: 800px;
     }
   }
@@ -54,6 +55,7 @@
     bottom: initial;
     left: initial;
     margin-left: 0;
+    margin-right: 0;
     text-align: left;
 
     &.col-sm-6 {
@@ -61,7 +63,7 @@
     }
 
     li {
-      display: relative; 
+      display: relative;
       width: 100%;
       height: auto;
       text-indent: 0;
@@ -81,4 +83,4 @@
       a { color: #fff; }
     }
   }
-}
+}

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

@@ -2,7 +2,6 @@
 @import "spotlight/mixins";
 @import "bootstrap/variables";
 
-@import "spotlight/navbar";
 @import "spotlight/sir-trevor_overrides";
 @import "spotlight/attachments";
 @import "spotlight/pages";

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

@@ -1,6 +1,6 @@
 .translation-edit-form {
-  .glyphicon-ok {
-    color: $translation-available-color;
+  .translation-complete {
+    svg { fill: $translation-available-color }
   }
 
   .browse-category-title {
@@ -17,21 +17,21 @@
 }
 
 .translation-subheading {
-  border-bottom: 1px solid $navbar-default-border;
+  border-bottom: 1px solid $border-color;
   margin-bottom: 20px;
 }
 
 .form-group.translation-form {
-  .control-label {
-    padding-top: $panel-body-padding + $padding-base-vertical;
+  .col-form-label {
+    padding-top: $card-spacer-y + $padding-base-vertical;
   }
 
-  .glyphicon-ok {
-    padding-top: $panel-body-padding + $padding-base-vertical;
+  .translation-complete {
+    padding-top: $card-spacer-y + $padding-base-vertical;
   }
 }
 
-.tanslation-description-toggle {
+.translation-description-toggle {
   margin: 0;
   padding: 0;
 
@@ -48,7 +48,7 @@
   background-color: $translation-panel-bg;
   padding-bottom: 0;
 
-  .help-block {
+  .form-text {
     color: $translation-help-color;
     padding-left: 12px;
   }
@@ -63,10 +63,10 @@
 }
 
 .browse-translations-header {
-  border-bottom: 1px solid $navbar-default-border;
-  color: $gray-light;
+  border-bottom: 1px solid $border-color;
+  color: $gray-600;
   display: block;
-  font-size: $font-size-h4;
+  font-size: $h4-font-size;
   font-weight: bold;
   margin-bottom: $padding-large-vertical * 2;
   margin-top: $padding-large-vertical;

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

@@ -1,26 +1,26 @@
-$footer-top-margin: 3 * $padding-small-vertical !default;
-$footer-height: 118px !default;
+$footer-top-margin: 3rem !default;
+$footer-height: 7.5rem !default;
 $white: #ffffff !default;
 $black: #000000 !default;
 
-$masthead-bg: $well-bg !default;
-$masthead-height: 180px !default;
+$masthead-bg: $card-bg !default;
+$masthead-height: 11.25rem !default;
 $masthead-image-blur: 1px !default;
 
 $exhibit-card-height: 350px !default;
-$exhibit-card-bg: $well-bg !default;
-$exhibit-card-border: $well-border !default;
-$exhibit-card-gutter: $padding-large-horizontal !default;
+$exhibit-card-bg: $card-bg !default;
+$exhibit-card-border: $card-border-color !default;
+$exhibit-card-gutter: 30px !default;
 $exhibit-card-image-size: 269px !default;
 $exhibit-card-shadow: inset 2px 2px 5px -2px $exhibit-card-border !default;
 
-$navbar-transparent-color: $gray !default;
+$navbar-transparent-color: $gray-400 !default;
 $navbar-transparent-bg: rgba(0, 0, 0, 0.2) !default;
-$navbar-transparent-border: $gray !default;
-$navbar-transparent-link-color: $gray-lighter !default;
-$navbar-transparent-link-hover-color: $gray-lighter !default;
+$navbar-transparent-border: $gray-500 !default;
+$navbar-transparent-link-color: $gray-600 !default;
+$navbar-transparent-link-hover-color: $gray-600 !default;
 $navbar-transparent-link-hover-bg: rgba(255, 255, 255, 0.15) !default;
-$navbar-transparent-link-active-color: $gray-lighter !default;
+$navbar-transparent-link-active-color: $gray-600 !default;
 $navbar-transparent-link-active-bg: rgba(255, 255, 255, 0.3) !default;
 $navbar-transparent-link-disabled-color: #ccc !default;
 $navbar-transparent-link-disabled-bg: transparent !default;
@@ -33,9 +33,8 @@ $navbar-transparent-brand-hover-color: darken($navbar-transparent-brand-color, 1
 $navbar-transparent-brand-hover-bg: transparent !default;
 
 // Navbar toggle
-$navbar-transparent-toggle-hover-bg: $navbar-default-toggle-hover-bg !default;
-$navbar-transparent-toggle-icon-bar-bg: $navbar-default-toggle-icon-bar-bg !default;
-$navbar-transparent-toggle-border-color: $navbar-default-toggle-border-color !default;
+$navbar-transparent-toggle-icon-bar-bg: $navbar-light-toggler-icon-bg !default;
+$navbar-transparent-toggle-border-color: $navbar-light-toggler-border-color !default;
 
 // Translations
 $translation-available-color: #80bf77;

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

@@ -1,7 +1,7 @@
-$font-size-base: 14px;
-$font-size-h1:            floor(($font-size-base * 2.15)) !default; // ~30px
-$font-size-h2:            floor(($font-size-base * 1.7)) !default; // ~24px
-$font-size-h3:            ceil(($font-size-base * 1.53)) !default; // ~201px
-$font-size-h4:            ceil(($font-size-base * 1.21)) !default; // ~17px
-$font-size-h5:            $font-size-base !default;
-$font-size-h6:            ceil(($font-size-base * 0.85)) !default; // ~12px
+// $font-size-base: 14px;
+// $h1-font-size:            floor(($font-size-base * 2.15)) !default; // ~30px
+// $h2-font-size:            floor(($font-size-base * 1.7)) !default; // ~24px
+// $h3-font-size:            ceil(($font-size-base * 1.53)) !default; // ~201px
+// $h4-font-size:            ceil(($font-size-base * 1.21)) !default; // ~17px
+// $h5-font-size:            $font-size-base !default;
+// $h6-font-size:            ceil(($font-size-base * 0.85)) !default; // ~12px

data/app/assets/stylesheets/spotlight/typeahead.css

@@ -70,7 +70,7 @@
         top: -3px;
         max-width: 160px;
         max-height: 100px;
-        border: 3px solid $panel-info-heading-bg;
+        border: 3px solid theme-colors("info");
       }
     }
   }

data/app/builders/spotlight/bootstrap_breadcrumbs_builder.rb

@@ -23,7 +23,7 @@ module Spotlight
     def render_element(element)
       html_class = 'active' if @context.current_page?(compute_path(element))
 
-      @context.content_tag(:li, class: html_class) do
+      @context.content_tag(:li, class: "breadcrumb-item #{html_class}") do
         @context.link_to_unless_current(element_label(element), compute_path(element), element.options)
       end
     end
@@ -31,7 +31,8 @@ module Spotlight
     private
 
     def element_label(element)
-      @context.truncate(compute_name(element), length: 30, separator: ' ')
+      label = compute_name(element)
+      @context.truncate(label, escape: !label.html_safe?, length: 30, separator: ' ')
     end
   end
 end

data/app/controllers/concerns/spotlight/catalog.rb

@@ -5,8 +5,8 @@ module Spotlight
   # Spotlight catalog mixins
   module Catalog
     extend ActiveSupport::Concern
-    include Blacklight::Catalog
     include Spotlight::Base
+    include Spotlight::SearchHelper
 
     included do
       before_action :add_facet_visibility_field

data/app/controllers/concerns/spotlight/controller.rb

@@ -75,9 +75,9 @@ module Spotlight
       end
     end
 
-    def search_facet_url(*args)
+    def search_facet_path(*args)
       if current_exhibit
-        exhibit_search_facet_url(*args)
+        exhibit_search_facet_path(*args)
       else
         main_app.catalog_facet_url(*args)
       end
@@ -95,7 +95,7 @@ module Spotlight
       end
     end
 
-    def exhibit_search_facet_url(*args)
+    def exhibit_search_facet_path(*args)
       options = args.extract_options!
       options = Blacklight::Parameters.sanitize(params.to_unsafe_h.with_indifferent_access).merge(options).except(:exhibit_id, :only_path)
       spotlight.facet_exhibit_catalog_url(current_exhibit, *args, options)

data/app/controllers/concerns/spotlight/search_helper.rb

@@ -0,0 +1,23 @@
+module Spotlight
+  # ...
+  module SearchHelper
+    def search_service(user_params = respond_to?(:search_state, true) ? search_state.to_h : {})
+      search_service_class.new(config: blacklight_config, user_params: user_params, **search_service_context)
+    end
+
+    def search_service_class
+      if defined?(super)
+        super
+      else
+        Blacklight::SearchService
+      end
+    end
+
+    # @return [Hash] a hash of context information to pass through to the search service
+    def search_service_context
+      return {} unless respond_to?(:current_ability)
+
+      { current_ability: current_ability }
+    end
+  end
+end

data/app/controllers/spotlight/browse_controller.rb

@@ -6,7 +6,7 @@ module Spotlight
   # for the curator's create-update-delete actions)
   class BrowseController < Spotlight::ApplicationController
     load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit'
-    include Spotlight::Base
+    include Spotlight::Catalog
     include Blacklight::Facet
 
     load_and_authorize_resource :search, except: :index, through: :exhibit, parent: false
@@ -14,21 +14,27 @@ module Spotlight
     before_action :attach_search_breadcrumb, only: :show
     record_search_parameters only: :show
 
-    helper_method :should_render_spotlight_search_bar?
+    helper_method :should_render_spotlight_search_bar?, :presenter
 
     before_action :swap_actions_configuration, only: :show
 
+    before_action do
+      blacklight_config.track_search_session = false
+    end
+
     def index
       @searches = @exhibit.searches.published
     end
 
     def show
-      @response, @document_list = search_results(search_query)
+      @response, @document_list = search_service.search_results do |builder|
+        builder.with(search_query)
+      end
 
       respond_to do |format|
         format.html
         format.json do
-          @presenter = Blacklight::JsonPresenter.new(@response, @document_list, facets_from_request, blacklight_config)
+          @presenter = Blacklight::JsonPresenter.new(@response, blacklight_config)
           render template: 'catalog/index'
         end
       end
@@ -116,5 +122,13 @@ module Spotlight
     def default_browse_index_view_type
       Spotlight::Engine.config.default_browse_index_view_type
     end
+
+    def presenter(document)
+      view_context.index_presenter(document)
+    end
+
+    def render_save_this_search?
+      false
+    end
   end
 end

data/app/controllers/spotlight/catalog_controller.rb

@@ -9,6 +9,7 @@ module Spotlight
   class CatalogController < ::CatalogController
     include Spotlight::Concerns::ApplicationController
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit, prepend: true
+    include Blacklight::Catalog
     include Spotlight::Catalog
     include Spotlight::Concerns::CatalogSearchContext
 
@@ -28,6 +29,7 @@ module Spotlight
       blacklight_config.view.select! { |k, _v| k == :admin_table }
       blacklight_config.view.admin_table.partials = [:index_compact]
       blacklight_config.view.admin_table.document_actions = []
+      blacklight_config.track_search_session = false
 
       unless blacklight_config.sort_fields.key? :timestamp
         blacklight_config.add_sort_field :timestamp, sort: "#{blacklight_config.index.timestamp_field} desc"
@@ -54,8 +56,9 @@ module Spotlight
     # setup within their index analyzer. This will ensure that this method returns
     # results when a partial match is passed in the "q" parameter.
     def autocomplete
-      search_params = params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
-      (_, @document_list) = search_results(search_params.merge(public: true, rows: 100))
+      (_, @document_list) = search_service.search_results do |builder|
+        builder.with(builder.blacklight_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field, public: true, rows: 100))
+      end
 
       respond_to do |format|
         format.json do
@@ -67,7 +70,7 @@ module Spotlight
     def admin
       add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
       add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_path(@exhibit)
-      (@response, @document_list) = search_results(params)
+      (@response, @document_list) = search_service.search_results
       @filters = params[:f] || []
 
       respond_to do |format|
@@ -76,7 +79,7 @@ module Spotlight
     end
 
     def update
-      @response, @document = fetch params[:id]
+      @response, @document = search_service.fetch params[:id]
       @document.update(current_exhibit, solr_document_params)
       @document.save
 
@@ -86,11 +89,11 @@ module Spotlight
     end
 
     def edit
-      @response, @document = fetch params[:id]
+      @response, @document = search_service.fetch params[:id]
     end
 
     def make_private
-      @response, @document = fetch params[:id]
+      @response, @document = search_service.fetch params[:id]
       @document.make_private!(current_exhibit)
       @document.save
 
@@ -101,7 +104,7 @@ module Spotlight
     end
 
     def make_public
-      @response, @document = fetch params[:id]
+      @response, @document = search_service.fetch params[:id]
       @document.make_public!(current_exhibit)
       @document.save
 
@@ -112,7 +115,7 @@ module Spotlight
     end
 
     def manifest
-      _, document = fetch params[:id]
+      _, document = search_service.fetch params[:id]
 
       if document.uploaded_resource?
         render json: Spotlight::IiifManifestPresenter.new(document, self).iiif_manifest_json
@@ -123,13 +126,6 @@ module Spotlight
 
     protected
 
-    # TODO: move this out of app/helpers/blacklight/catalog_helper_behavior.rb and into blacklight/catalog.rb
-    # rubocop:disable Naming/PredicateName
-    def has_search_parameters?
-      !params[:q].blank? || !params[:f].blank? || !params[:search_field].blank?
-    end
-    # rubocop:enable Naming/PredicateName
-
     def attach_breadcrumbs
       # The "q: ''" is necessary so that the breadcrumb builder recognizes that a path like this:
       # /exhibits/1?f%5Bgenre_sim%5D%5B%5D=map&q= is not the same as /exhibits/1
@@ -158,7 +154,7 @@ module Spotlight
 
     def setup_next_and_previous_documents_from_browse_category
       index = search_session['counter'].to_i - 1
-      response, documents = get_previous_and_next_documents_for_search index, current_browse_category.query_params.with_indifferent_access
+      response, documents = search_service.previous_and_next_documents_for_search index, current_browse_category.query_params.with_indifferent_access
 
       return unless response
 
@@ -223,7 +219,7 @@ module Spotlight
         add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), search_action_url(current_search_session.query_params)
       end
 
-      add_breadcrumb Array(document[blacklight_config.view_config(:show).title_field]).join(', '), polymorphic_path([current_exhibit, document])
+      add_breadcrumb view_context.show_presenter(document).heading, polymorphic_path([current_exhibit, document])
     end
     # rubocop:enable Metrics/AbcSize