blacklight 7.0.0.rc1 → 7.0.0.rc2

data/.solr_wrapper.yml

@@ -1,5 +1,12 @@
-# Place any default configuration for solr_wrapper here
+# Place configuration for solr_wrapper here
+#
+# Specify the port to run solr on
 # port: 8983
+#
+# Specify a version of Solr to download
+# version: 7.3.1
+#
+# Create a collection when starting solr
 collection:
   dir: lib/generators/blacklight/templates/solr/conf/
   name: blacklight-core

data/.travis.yml

@@ -9,18 +9,20 @@ notifications:
 
 matrix:
   include:
-    - rvm: 2.5.0
-      env: "RAILS_VERSION=5.1.5"
-    - rvm: 2.4.3
-      env: "RAILS_VERSION=5.2.0.rc2"
-    - rvm: 2.4.3
-      env: "RAILS_VERSION=5.1.5"
-    - rvm: 2.3.4
-      env: "RAILS_VERSION=5.0.6"
-    - rvm: jruby-9.1.16.0
-      env: "RAILS_VERSION=5.1.5 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+    - rvm: 2.5.3
+      env: "RAILS_VERSION=5.1.6"
+    - rvm: 2.4.5
+      env: "RAILS_VERSION=5.2.1"
+    - rvm: 2.5.3
+      env: "RAILS_VERSION=5.2.1 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
+    - rvm: 2.4.5
+      env: "RAILS_VERSION=5.1.6"
+    - rvm: 2.3.8
+      env: "RAILS_VERSION=5.2.1"
+    - rvm: jruby-9.2.0.0
+      env: "RAILS_VERSION=5.1.6 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:
-    - rvm: jruby-9.1.16.0
+    - rvm: jruby-9.2.0.0
   fast_finish: true
 
 before_install:
@@ -35,6 +37,6 @@ notifications:
 
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test'
+  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test'
 
-jdk: oraclejdk8
+jdk: oraclejdk9

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Please see blacklight.gemspec for dependency information.

data/README.md

@@ -34,9 +34,9 @@ rails generate blacklight:install
 
 ## Dependencies
 
-* Ruby 2.1+
+* Ruby 2.2+
 * Bundler
-* Rails 5.0+
+* Rails 5.1+
 
 ## Configuring Apache Solr
 You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [README_SOLR](https://github.com/projectblacklight/blacklight/wiki/README_SOLR)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rails'
 begin

data/VERSION

@@ -1 +1 @@
-7.0.0.rc1
+7.0.0.rc2

data/Vagrantfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 

data/app/assets/javascripts/blacklight/blacklight.js

@@ -19,21 +19,23 @@ Blacklight = function () {
           listeners.push('turbolinks:load');
         } else {
           // Turbolinks < 5
-          listeners.push('page:load', 'ready');
+          listeners.push('page:load', 'DOMContentLoaded');
         }
       } else {
-        listeners.push('ready');
+        listeners.push('DOMContentLoaded');
       }
 
-      return listeners.join(' ');
+      return listeners;
     }
   };
 }();
 
 // turbolinks triggers page:load events on page transition
 // If app isn't using turbolinks, this event will never be triggered, no prob.
-$(document).on(Blacklight.listeners(), function () {
-  Blacklight.activate();
+Blacklight.listeners().forEach(function (listener) {
+  document.addEventListener(listener, function () {
+    Blacklight.activate();
+  });
 });
 
 $('.no-js').removeClass('no-js').addClass('js');
@@ -114,11 +116,11 @@ Blacklight.onLoad(function () {
 
    Pass in options for your class name and labels:
    $("form.something").blCheckboxSubmit({
-        checked_label: "Selected",
-        unchecked_label: "Select",
-        progress_label: "Saving...",
         //cssClass is added to elements added, plus used for id base
         cssClass: "toggle_my_kinda_form",
+        error: function() {
+          #optional callback
+        },
         success: function(after_success_check_state) {
           #optional callback
         }
@@ -142,7 +144,7 @@ Blacklight.onLoad(function () {
       var uniqueId = form.attr('data-doc-id') || Math.random();
       // if form is currently using method delete to change state,
       // then checkbox is currently checked
-      var checked = form.find('input[name=_method][value=delete]').size() != 0;
+      var checked = form.find('input[name=_method][value=delete]').length != 0;
 
       var checkbox = $('<input type="checkbox">').addClass(options.cssClass).attr('id', options.cssClass + '_' + uniqueId);
       var label = $('<label>').addClass(options.cssClass).attr('for', options.cssClass + '_' + uniqueId).attr('title', form.attr('title') || '');
@@ -182,10 +184,9 @@ Blacklight.onLoad(function () {
           type: form.attr('method').toUpperCase(),
           data: form.serialize(),
           error: function () {
-            alert('Error');
-            updateStateFor(checked);
             label.removeAttr('disabled');
             checkbox.removeAttr('disabled');
+            options.error.call();
           },
           success: function (data, status, xhr) {
             //if app isn't running at all, xhr annoyingly
@@ -197,10 +198,9 @@ Blacklight.onLoad(function () {
               checkbox.removeAttr('disabled');
               options.success.call(form, checked, xhr.responseJSON);
             } else {
-              alert('Error');
-              updateStateFor(checked);
               label.removeAttr('disabled');
               checkbox.removeAttr('disabled');
+              options.error.call();
             }
           }
         });
@@ -215,6 +215,9 @@ Blacklight.onLoad(function () {
   $.fn.blCheckboxSubmit.defaults = {
     //cssClass is added to elements added, plus used for id base
     cssClass: 'blCheckboxSubmit',
+    error: function () {
+      alert("Error");
+    },
     success: function () {} //callback
   };
 })(jQuery);
@@ -252,8 +255,6 @@ Blacklight.onLoad(function () {
     Blacklight.doResizeFacetLabelsAndCounts();
   });
 })(jQuery);
-//= require blacklight/core
-
 /*
   The blacklight modal plugin can display some interactions inside a Bootstrap
   modal window, including some multi-page interactions.
@@ -368,7 +369,7 @@ Blacklight.modal.receiveAjax = function (contents) {
   // important we don't execute script tags, we shouldn't.
   // code modelled off of JQuery ajax.load. https://github.com/jquery/jquery/blob/master/src/ajax/load.js?source=c#L62
   var container = $('<div>').append(jQuery.parseHTML(contents)).find(Blacklight.modal.containerSelector).first();
-  if (container.size() !== 0) {
+  if (container.length !== 0) {
     contents = container.html();
   }
 
@@ -444,7 +445,6 @@ Blacklight.modal.checkCloseModal = function (event) {
 Blacklight.onLoad(function () {
   Blacklight.modal.setupModal();
 });
-//= require blacklight/core
 (function ($) {
   Blacklight.doSearchContextBehavior = function () {
     if (typeof Blacklight.do_search_context_behavior == 'function') {

data/app/assets/stylesheets/blacklight/_blacklight_base.scss

@@ -7,19 +7,20 @@
    not to use the Blacklight CSS file at all in your local app. */
 
 @import "mixins";
-@import 'blacklight/blacklight_defaults';
-@import "blacklight/bootstrap_overrides";
-@import "blacklight/layout";
-@import "blacklight/header";
-@import "blacklight/constraints";
-@import "blacklight/controls";
-@import "blacklight/search_results";
-@import "blacklight/pagination";
-@import "blacklight/group";
-@import "blacklight/bookmark";
-@import "blacklight/balanced_list";
-@import "blacklight/facets";
-@import "blacklight/search_history";
-@import "blacklight/modal";
-@import "blacklight/twitter_typeahead";
-@import "blacklight/icons";
+@import 'blacklight_defaults';
+@import "bootstrap_overrides";
+@import "layout";
+@import "header";
+@import "constraints";
+@import "controls";
+@import "search_form";
+@import "search_results";
+@import "pagination";
+@import "group";
+@import "bookmark";
+@import "balanced_list";
+@import "facets";
+@import "search_history";
+@import "modal";
+@import "twitter_typeahead";
+@import "icons";

data/app/assets/stylesheets/blacklight/_facets.scss

@@ -19,12 +19,6 @@
     $infix: breakpoint-infix($breakpoint, $grid-breakpoints);
 
     &#{$infix} {
-      @include media-breakpoint-down($breakpoint) {
-        .top-panel-heading {
-          margin-right: 3em;
-        }
-      }
-
       @include media-breakpoint-up($next) {
 
         // scss-lint:disable ImportantRule
@@ -42,11 +36,6 @@
   }
 }
 
-.top-panel-heading {
-  @extend .navbar-light;
-  @extend .clearfix;
-}
-
 .facets-heading {
   @extend .h4;
   line-height: inherit;
@@ -55,7 +44,7 @@
 .facet-limit {
   margin-bottom: $spacer;
 
-  .card-block {
+  .card-body {
     padding: $spacer;
   }
 }
@@ -147,7 +136,7 @@
   }
 }
 
- 
+
 
 /* style for pivot facet's nested list */
 

data/app/assets/stylesheets/blacklight/_icons.scss

@@ -1,10 +1,16 @@
 .blacklight-icons {
-  display: inline-block;
+  display: inline-flex;
   height: $font-size-base;
-  vertical-align: text-top;
   width: $font-size-base;
 }
 
+.blacklight-icons svg {
+  height: 1rem;
+  width: 1rem;
+  top: .125rem;
+  position: relative;
+}
+
 @each $color, $value in $theme-colors {
   .btn-#{$color} {
     .blacklight-icons g {

data/app/assets/stylesheets/blacklight/_search_form.scss

@@ -0,0 +1,7 @@
+// bootstrap does flex-grow: 1 by default which makes the
+// text input roughly the same size as the select in many cases
+.input-group > .form-control {
+  &.search-q {
+    flex-grow: 3;
+  }
+}

data/app/assets/stylesheets/blacklight/blacklight.scss

@@ -2,4 +2,4 @@
 
 /* This is the default blacklight theme. */
 
-@import 'blacklight/blacklight_base';
+@import 'blacklight_base';

data/app/builders/blacklight/action_builder.rb

@@ -16,6 +16,7 @@ module Blacklight
     # doesn't already exist or the `:define_method` option is not `false`
     def build
       return if skip?
+
       callback = opts.fetch(:callback, nil).inspect
       validator = opts.fetch(:validator, nil).inspect
       klass.class_eval <<EORUBY, __FILE__, __LINE__ + 1

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -70,7 +70,7 @@ module Blacklight::Bookmarks
   # is simpler.
   def create
     @bookmarks = if params[:bookmarks]
-                   params[:bookmarks]
+                   permit_bookmarks[:bookmarks]
                  else
                    [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
                  end
@@ -90,28 +90,30 @@ module Blacklight::Bookmarks
         flash[:error] = I18n.t('blacklight.bookmarks.add.failure', count: @bookmarks.length)
       end
 
-      if respond_to? :redirect_back
-        redirect_back fallback_location: bookmarks_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
+      redirect_back fallback_location: bookmarks_path
     end
   end
 
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be.
   def destroy
-    bookmark = current_or_guest_user.bookmarks.find_by(document_id: params[:id], document_type: blacklight_config.document_model.to_s)
+    @bookmarks =
+      if params[:bookmarks]
+        permit_bookmarks[:bookmarks]
+      else
+        [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
+      end
 
-    if bookmark && bookmark.delete && bookmark.destroyed?
+    success = @bookmarks.all? do |bookmark|
+      bookmark = current_or_guest_user.bookmarks.find_by(bookmark)
+      bookmark && bookmark.delete && bookmark.destroyed?
+    end
+
+    if success
       if request.xhr?
         render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count } })
-      elsif respond_to? :redirect_back
-        redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
       else
-        # Deprecated in Rails 5.0
-        redirect_to :back, notice: I18n.t('blacklight.bookmarks.remove.success')
+        redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
       end
     elsif request.xhr?
       head 500 # ajaxy request needs no redirect and should not have flash set
@@ -141,4 +143,8 @@ module Blacklight::Bookmarks
   def start_new_search_session?
     action_name == "index"
   end
+
+  def permit_bookmarks
+    params.permit(bookmarks: [:document_id, :document_type])
+  end
 end

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

@@ -8,9 +8,11 @@ module Blacklight::Catalog
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
-    helper_method :sms_mappings, :has_search_parameters?, :facet_limit_for
+    if respond_to? :helper_method
+      helper_method :sms_mappings, :has_search_parameters?, :facet_limit_for
+    end
 
-    helper Blacklight::Facet
+    helper Blacklight::Facet if respond_to? :helper
 
     # The index action will more than likely throw this one.
     # Example: when the standard query parser is used, and a user submits a "bad" query.
@@ -31,7 +33,6 @@ module Blacklight::Catalog
       format.atom { render layout: false }
       format.json do
         @presenter = Blacklight::JsonPresenter.new(@response,
-                                                   facets_from_request,
                                                    blacklight_config)
       end
       additional_response_formats(format)
@@ -47,11 +48,19 @@ module Blacklight::Catalog
 
     respond_to do |format|
       format.html { @search_context = setup_next_and_previous_documents }
-      format.json { render json: { response: { document: @document } } }
+      format.json
       additional_export_formats(@document, format)
     end
   end
 
+  # get a single document from the index
+  def raw
+    raise(ActionController::RoutingError, 'Not Found') unless blacklight_config.raw_endpoint.enabled
+
+    _, @document = search_service.fetch(params[:id])
+    render json: @document
+  end
+
   # updates the search counter (allows the show view to paginate)
   def track
     search_session['counter'] = params[:counter]
@@ -63,7 +72,7 @@ module Blacklight::Catalog
       path = uri.query ? "#{uri.path}?#{uri.query}" : uri.path
       redirect_to path, status: 303
     else
-      redirect_to blacklight_config.document_model.new(id: params[:id]), status: 303
+      redirect_to({ action: :show, id: params[:id] }, status: 303)
     end
   end
 
@@ -71,6 +80,7 @@ module Blacklight::Catalog
   def facet
     @facet = blacklight_config.facet_fields[params[:id]]
     raise ActionController::RoutingError, 'Not Found' unless @facet
+
     @response = search_service.facet_field_response(@facet.key)
     @display_facet = @response.aggregations[@facet.field]
     @pagination = facet_paginator(@facet, @display_facet)
@@ -100,6 +110,8 @@ module Blacklight::Catalog
     end
   end
 
+  # @return [Array] first value is a Blacklight::Solr::Response and the second
+  #                 is a list of documents
   def action_documents
     search_service.fetch(Array(params[:id]))
   end
@@ -153,7 +165,7 @@ module Blacklight::Catalog
   end
 
   def search_service
-    search_service_class.new(blacklight_config, search_state.to_h)
+    search_service_class.new(config: blacklight_config, user_params: search_state.to_h)
   end
 
   ##
@@ -258,7 +270,7 @@ module Blacklight::Catalog
       flash[:error] = I18n.t('blacklight.sms.errors.carrier.blank')
     elsif params[:to].gsub(/[^\d]/, '').length != 10
       flash[:error] = I18n.t('blacklight.sms.errors.to.invalid', to: params[:to])
-    elsif !sms_mappings.values.include?(params[:carrier])
+    elsif !sms_mappings.value?(params[:carrier])
       flash[:error] = I18n.t('blacklight.sms.errors.carrier.invalid')
     end