blacklight 6.11.0 → 6.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 741267e0943b9248b05baca938f10fe8c3454717
-  data.tar.gz: 333367da063309c42774d31396aadaa17480bc43
+  metadata.gz: 8a72b5c9469391daec118e8cfef69fd9960cf687
+  data.tar.gz: 1a9a6c9147a770fa9ffaa107d789618b39b2c2fd
 SHA512:
-  metadata.gz: 9e86f64f778efb7e43db4b0acd10999bb8c151ba30f59272522354469ad79ba28b04979864d381b2532c478b28fac33e712961bd5ca85aef41a04c0849e1dbe6
-  data.tar.gz: b6c6bc62fa20aeb936610a14de238f99f39f66cc3597255f7ab8c440897526bd95d6aad5eecb56f43ce50716f3af4eac7700147203cd367c13ab78be7f83d3a7
+  metadata.gz: 286d8992abd602981c3603da27a5fe7aa9d7f5796b1b32c4ee63f1afdd66ca3ea50d7a5b15ebf2ea03102b3460a19e5f4ebf0a5a12f2b36772f6971a08cc7f3c
+  data.tar.gz: 9d8b1df273e758854c4e79407cd4817a8561e6b1879100855a1db2400d43fc54219e9ef4c41ba5c69074897915328dd54876f252ba702bc5b6734516c7e32f9e

data/VERSION

@@ -1 +1 @@
-6.11.0
+6.11.1

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

@@ -1,14 +1,14 @@
 //= require blacklight/core
 
-/* 
+/*
   The ajax_modal plugin can display some interactions inside a Bootstrap
-  modal window, including some multi-page interactions. 
+  modal window, including some multi-page interactions.
 
   It supports unobtrusive Javascript, where a link or form that would have caused
   a new page load is changed to display it's results inside a modal dialog,
   by this plugin.  The plugin assumes there is a Bootstrap modal div
   on the page with id #ajax-modal to use as the modal -- the standard Blacklight
-  layout provides this. 
+  layout provides this.
 
   To make a link or form have their results display inside a modal, add
   `data-ajax-modal="trigger"` to the link or form. (Note, form itself not submit input)
@@ -23,18 +23,18 @@
   the layout when a JS AJAX request is detected, OR the response
   can include a `<div data-ajax-modal="container">` -- only the contents
   of the container will be placed inside the modal, the rest of the
-  page will be ignored. 
+  page will be ignored.
 
   If you'd like to have a link or button that closes the modal,
   you can just add a `data-dismiss="modal"` to the link,
   standard Bootstrap convention. But you can also have
   an href on this link for non-JS contexts, we'll make sure
-  inside the modal it closes the modal and the link is NOT followed. 
+  inside the modal it closes the modal and the link is NOT followed.
 
   Link or forms inside the modal will ordinarily cause page loads
   when they are triggered. However, if you'd like their results
   to stay within the modal, just add `data-ajax-modal="preserve"`
-  to the link or form. 
+  to the link or form.
 
   Here's an example of what might be returned, demonstrating most of the devices available:
 
@@ -43,7 +43,7 @@
         <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
         <h3 class="modal-title">Request Placed</h3>
       </div>
-  
+
       <div class="modal-body">
         <p>Some message</p>
         <%= link_to "This result will still be within modal", some_link, :data => {:ajax_modal => "preserve"} %>
@@ -59,22 +59,22 @@
   One additional feature. If the content returned from the AJAX modal load
   has an element with `data-ajax-modal=close`, that will trigger the modal
   to be closed. And if this element includes a node with class "flash_messages",
-  the flash-messages node will be added to the main page inside #main-flahses. 
+  the flash-messages node will be added to the main page inside #main-flahses.
 
   == Events
 
   We'll send out an event 'loaded.blacklight.ajax-modal' with the #ajax-modal
   dialog as the target, right after content is loaded into the modal but before
-  it is shown (if not already a shown modal).  In an event handler, you can 
+  it is shown (if not already a shown modal).  In an event handler, you can
   inspect loaded content by looking inside $(this).  If you call event.preventDefault(),
   we won't 'show' the dialog (although it may already have been shown, you may want to
-  $(this).modal("hide") if you want to ensure hidden/closed. 
+  $(this).modal("hide") if you want to ensure hidden/closed.
 
-  The data-ajax-modal=close behavior is implemented with this event, see for example. 
+  The data-ajax-modal=close behavior is implemented with this event, see for example.
 */
 
-// We keep all our data in Blacklight.ajaxModal object. 
-// Create lazily if someone else created first. 
+// We keep all our data in Blacklight.ajaxModal object.
+// Create lazily if someone else created first.
 if (Blacklight.ajaxModal === undefined) {
   Blacklight.ajaxModal = {};
 }
@@ -104,67 +104,57 @@ Blacklight.ajaxModal.modalCloseSelector   = "[data-ajax-modal~=close], span.ajax
 
 // Called on fatal failure of ajax load, function returns content
 // to show to user in modal.  Right now called only for extreme
-// network errors. 
+// network errors.
 Blacklight.ajaxModal.onFailure = function(data) {
   var contents =  "<div class='modal-header'>" +
            "<button type='button' class='close' data-dismiss='modal' aria-hidden='true'>×</button>" +
            "Network Error</div>";
   $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
-  $(Blacklight.ajaxModal.modalSelector).modal('show'); 
+  $(Blacklight.ajaxModal.modalSelector).modal('show');
 }
 
-Blacklight.ajaxModal.receiveAjax = function (data) {      
-      if (data.readyState == 0) {
-        // Network error, could not contact server. 
-        Blacklight.ajaxModal.onFailure(data)
-      }
-      else {
-        var contents = data.responseText;
-      
-        // does it have a data- selector for container?
-        // 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.ajaxModal.containerSelector ).first();
-        if (container.size() !== 0) {
-          contents = container.html();
-        }
-
-        $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
-
-        // send custom event with the modal dialog div as the target
-        var e    = $.Event('loaded.blacklight.ajax-modal')
-        $(Blacklight.ajaxModal.modalSelector).trigger(e);
-        // if they did preventDefault, don't show the dialog
-        if (e.isDefaultPrevented()) return;
-
-        $(Blacklight.ajaxModal.modalSelector).modal('show');      
-      }
+Blacklight.ajaxModal.receiveAjax = function (contents) {
+    // does it have a data- selector for container?
+    // 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.ajaxModal.containerSelector ).first();
+    if (container.length !== 0) {
+      contents = container.html();
+    }
+
+    $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
+
+    // send custom event with the modal dialog div as the target
+    var e    = $.Event('loaded.blacklight.blacklight-modal')
+    $(Blacklight.ajaxModal.modalSelector).trigger(e);
+    // if they did preventDefault, don't show the dialog
+    if (e.isDefaultPrevented()) return;
+
+    $(Blacklight.ajaxModal.modalSelector).modal('show');
 };
 
 
 Blacklight.ajaxModal.modalAjaxLinkClick = function(e) {
   e.preventDefault();
 
-  var jqxhr = $.ajax({
-    url: $(this).attr('href'),
-    dataType: 'script'
-  });
-
-  jqxhr.always( Blacklight.ajaxModal.receiveAjax );
+  $.ajax({
+    url: $(this).attr('href')
+  })
+  .fail(Blacklight.ajaxModal.onFailure)
+  .done(Blacklight.ajaxModal.receiveAjax)
 };
 
 Blacklight.ajaxModal.modalAjaxFormSubmit = function(e) {
-  e.preventDefault();
-
-  var jqxhr = $.ajax({
-    url: $(this).attr('action'),
-    data: $(this).serialize(),
-    type: $(this).attr('method'), //POST',
-    dataType: 'script'
- });
+    e.preventDefault();
 
- jqxhr.always(Blacklight.ajaxModal.receiveAjax);
+    $.ajax({
+      url: $(this).attr('action'),
+      data: $(this).serialize(),
+      type: $(this).attr('method') // POST
+    })
+    .fail(Blacklight.ajaxModal.onFailure)
+    .done(Blacklight.ajaxModal.receiveAjax)
 }
 
 
@@ -172,14 +162,14 @@ Blacklight.ajaxModal.modalAjaxFormSubmit = function(e) {
 Blacklight.ajaxModal.setup_modal = function() {
 	// Event indicating blacklight is setting up a modal link,
   // you can catch it and call e.preventDefault() to abort
-  // setup. 
+  // setup.
 	var e = $.Event('setup.blacklight.ajax-modal');
 	$("body").trigger(e);
 	if (e.isDefaultPrevented()) return;
 
   // Register both trigger and preserve selectors in ONE event handler, combining
   // into one selector with a comma, so if something matches BOTH selectors, it
-  // still only gets the event handler called once. 
+  // still only gets the event handler called once.
   $("body").on("click", Blacklight.ajaxModal.triggerLinkSelector  + ", " + Blacklight.ajaxModal.preserveLinkSelector,
     Blacklight.ajaxModal.modalAjaxLinkClick);
   $("body").on("submit", Blacklight.ajaxModal.triggerFormSelector + ", " + Blacklight.ajaxModal.preserveFormSelector,
@@ -190,7 +180,7 @@ Blacklight.ajaxModal.setup_modal = function() {
 
   // we support doing data-dismiss=modal on a <a> with a href for non-ajax
   // use, we need to suppress following the a's href that's there for
-  // non-JS contexts. 
+  // non-JS contexts.
   $("body ").on("click", Blacklight.ajaxModal.modalSelector + " a[data-dismiss~=modal]", function (e) {
     e.preventDefault();
   });
@@ -198,7 +188,7 @@ Blacklight.ajaxModal.setup_modal = function() {
 
 // A function used as an event handler on loaded.blacklight.ajax-modal
 // to catch contained data-ajax-modal=closed directions
-Blacklight.ajaxModal.check_close_ajax_modal = function(event) {  
+Blacklight.ajaxModal.check_close_ajax_modal = function(event) {
   if ($(event.target).find(Blacklight.ajaxModal.modalCloseSelector).length) {
     modal_flashes = $(this).find('.flash_messages');
 
@@ -207,10 +197,10 @@ Blacklight.ajaxModal.check_close_ajax_modal = function(event) {
 
     main_flashes = $('#main-flashes');
     main_flashes.append(modal_flashes);
-    modal_flashes.fadeIn(500);  
+    modal_flashes.fadeIn(500);
   }
 }
 
-Blacklight.onLoad(function() {  
+Blacklight.onLoad(function() {
   Blacklight.ajaxModal.setup_modal();
 });

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

@@ -71,11 +71,12 @@ module Blacklight::Catalog
       @display_facet = @response.aggregations[@facet.field]
       @pagination = facet_paginator(@facet, @display_facet)
       respond_to do |format|
-        # Draw the facet selector for users who have javascript disabled:
-        format.html
+        format.html do
+          # Draw the partial for the "more" facet modal window:
+          return render layout: false if request.xhr?
+          # Otherwise draw the facet selector for users who have javascript disabled.
+        end
         format.json
-        # Draw the partial for the "more" facet modal window:
-        format.js { render :layout => false }
       end
     end
 

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -214,7 +214,11 @@ module Blacklight::CatalogHelperBehavior
     end
 
     if value
-      if url_options == false || url_options[:suppress_link]
+      if url_options == false
+        Deprecation.warn(self, "passing false as the second argument to render_thumbnail_tag is deprecated. Use suppress_link: true instead. This behavior will be removed in Blacklight 7")
+        url_options = { suppress_link: true }
+      end
+      if url_options[:suppress_link]
         value
       else
         link_to_document document, value, url_options

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -54,7 +54,7 @@ module Blacklight
 
     def render_filtered_partials(partials, options={}, &block)
       content = []
-      partials.select { |_, config| blacklight_configuration_context.evaluate_if_unless_configuration config, options }.each do |key, config|
+      filter_partials(partials, options).each do |key, config|
         config.key ||= key
         rendered = render(partial: config.partial || key.to_s, locals: { document_action_config: config }.merge(options))
         if block_given?
@@ -78,5 +78,15 @@ module Blacklight
     def render_show_doc_actions(document=@document, options={}, &block)
       render_filtered_partials(blacklight_config.show.document_actions, { document: document }.merge(options), &block)
     end
+
+    def show_doc_actions?(document = @document, options = {})
+      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).any?
+    end
+
+    private
+
+    def filter_partials(partials, options)
+      partials.select { |_, config| blacklight_configuration_context.evaluate_if_unless_configuration config, options }
+    end
   end
 end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -130,7 +130,14 @@ module Blacklight::ConfigurationHelperBehavior
       should_render_field? config
     end
   end
-  
+
+  # filter #document_index_views to just views that should display in the view type control
+  def document_index_view_controls
+    document_index_views.select do |_k, config|
+      config.display_control.nil? || blacklight_configuration_context.evaluate_configuration_conditional(config.display_control)
+    end
+  end
+
   ##
   # Get the default index view type
   def default_document_index_view_type

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -76,9 +76,9 @@ module Blacklight::UrlHelperBehavior
     return if document.nil?
 
     if respond_to?(controller_tracking_method)
-      send(controller_tracking_method, params.merge(id: document.id))
+      send(controller_tracking_method, params.merge(id: document))
     else
-      blacklight.track_search_context_path(params.merge(id: document.id))
+      blacklight.track_search_context_path(params.merge(id: document))
     end
   end
 

data/app/models/concerns/blacklight/document.rb

@@ -37,7 +37,7 @@ module Blacklight::Document
     extend ActiveModel::Naming
     include Blacklight::Document::Extensions
     include GlobalID::Identification
-  end    
+  end
 
   attr_reader :response, :_source
   alias_method :solr_response, :response
@@ -69,15 +69,14 @@ module Blacklight::Document
   end
 
   def respond_to_missing? m, *args
-    return super if m == :to_hash
-
+    return super if %i(empty? to_hash).include?(m)
     _source_responds_to?(m, *args) || super
   end
 
   # Helper method to check if value/multi-values exist for a given key.
   # The value can be a string, or a RegExp
   # Multiple "values" can be given; only one needs to match.
-  # 
+  #
   # Example:
   # doc.has?(:location_facet)
   # doc.has?(:location_facet, 'Clemons')
@@ -141,12 +140,12 @@ module Blacklight::Document
   module ClassMethods
     attr_writer :unique_key
     def unique_key
-      @unique_key ||= 'id' 
+      @unique_key ||= 'id'
     end
   end
-  
+
   private
-  
+
   def _source_responds_to? *args
     _source && self != _source && _source.respond_to?(*args)
   end

data/app/models/concerns/blacklight/document/semantic_fields.rb

@@ -34,12 +34,14 @@ module Blacklight::Document
     # but extensions should call super and modify hash returned, to avoid
     # unintentionally erasing values provided by other extensions. 
     def to_semantic_values
-      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_name), hash|
-        value = self[field_name]
+      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_names), hash|
+        ##
+        # Handles single string field_name or an array of field_names
+        value = Array.wrap(field_names).map { |field_name| self[field_name] }.flatten.compact
 
         # Make single and multi-values all arrays, so clients
         # don't have to know.
-        hash[key] = Array.wrap(value) unless value.nil?
+        hash[key] = value unless value.empty?
       end
 
       @semantic_value_hash ||= {}

data/app/views/catalog/_show_tools.html.erb

@@ -1,24 +1,26 @@
-<%-
-  # Compare with render_document_functions_partial helper, and
-  # _document_functions partial. BL actually has two groups
-  # of document-related tools. "document functions" by default
-  # contains Bookmark functionality shown on both results and
-  # item view. While "document tools" contains external export type
-  # functions by default only on detail.
-
--%>
-<div class="panel panel-default show-tools">
-  <div class="panel-heading">
-    <%= t('blacklight.tools.title') %>
-  </div>
-
-  <div class="panel-body">
-    <ul class="nav">
-      <%= render_show_doc_actions @document do |config, inner| %>
-        <li class="<%= config.key %>">
-          <%= inner %>
-        </li>
-      <% end %>
-    </ul>
-  </div>
-</div>
+<%-
+  # Compare with render_document_functions_partial helper, and
+  # _document_functions partial. BL actually has two groups
+  # of document-related tools. "document functions" by default
+  # contains Bookmark functionality shown on both results and
+  # item view. While "document tools" contains external export type
+  # functions by default only on detail.
+
+-%>
+<% if show_doc_actions? %>
+  <div class="panel panel-default show-tools">
+    <div class="panel-heading">
+      <%= t('blacklight.tools.title') %>
+    </div>
+
+    <div class="panel-body">
+      <ul class="nav">
+        <%= render_show_doc_actions @document do |config, inner| %>
+          <li class="<%= config.key %>">
+            <%= inner %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+<% end %>

data/app/views/catalog/_view_type_group.html.erb

@@ -2,7 +2,7 @@
 <div class="view-type">
   <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
-    <%  document_index_views.each do |view, config| %>
+    <%  document_index_view_controls.each do |view, config| %>
       <%= link_to url_for(search_state.to_h.merge(view: view)), title: view_label(view), class: "btn btn-default view-type-#{ view.to_s.parameterize } #{"active" if document_index_view_type == view}" do %>
         <%= render_view_type_group_icon view %>
         <span class="caption"><%= view_label(view) %></span>

data/lib/blacklight/utils.rb

@@ -14,7 +14,7 @@ module Blacklight
   ##
   # An OpenStruct that responds to common Hash methods
   class OpenStructWithHashAccess < OpenStruct
-    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, to: :to_h
+    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
 
     ##
     # Expose the internal hash

data/spec/helpers/catalog_helper_spec.rb

@@ -243,7 +243,7 @@ describe CatalogHelper do
     it "does not link to the document if the url options are false" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       allow(helper).to receive_messages(:xyz => "some-thumbnail")
-
+      expect(Deprecation).to receive(:warn)
       result = helper.render_thumbnail_tag document, {}, false
       expect(result).to eq "some-thumbnail"
     end

data/spec/helpers/configuration_helper_spec.rb

@@ -65,6 +65,18 @@ describe BlacklightConfigurationHelper do
     end
   end
 
+  describe '#document_index_view_controls' do
+    before do
+      blacklight_config.view.a
+      blacklight_config.view.b.display_control = false
+    end
+
+    it "filters index views to those set to display controls" do
+      expect(helper.document_index_view_controls).to have_key :a
+      expect(helper.document_index_view_controls).not_to have_key :b
+    end
+  end
+
   describe "#has_alternative_views?" do
     subject { helper.has_alternative_views?}
     describe "with a single view defined" do

data/spec/helpers/url_helper_spec.rb

@@ -245,7 +245,7 @@ describe BlacklightUrlHelper do
     end
 
     it "converts the counter parameter into a data- attribute" do
-      allow(helper).to receive(:track_test_path).with(hash_including(id: '123456', counter: 5)).and_return('tracking url')
+      allow(helper).to receive(:track_test_path).with(hash_including(id: have_attributes(id: '123456'), counter: 5)).and_return('tracking url')
 
       expect(helper.link_to_document(document, :title_display, counter: 5)).to include 'data-context-href="tracking url"'
     end
@@ -287,12 +287,12 @@ describe BlacklightUrlHelper do
   describe "#session_tracking_path" do
     let(:document) { SolrDocument.new(id: 1) }
     it "determines the correct route for the document class" do
-      allow(helper).to receive(:track_test_path).with(id: 1).and_return('x')
+      allow(helper).to receive(:track_test_path).with(id: have_attributes(id: 1)).and_return('x')
       expect(helper.session_tracking_path(document)).to eq 'x'
     end
 
     it "passes through tracking parameters" do
-      allow(helper).to receive(:track_test_path).with(id: 1, x: 1).and_return('x')
+      allow(helper).to receive(:track_test_path).with(id: have_attributes(id: 1), x: 1).and_return('x')
       expect(helper.session_tracking_path(document, x: 1)).to eq 'x'
     end
   end

data/spec/models/blacklight/solr/document_spec.rb

@@ -199,17 +199,23 @@ describe "Blacklight::Solr::Document" do
           include Blacklight::Solr::Document                        
       end
       before do
-        MockDocument.field_semantics.merge!( :title => "title_field", :author => "author_field", :something => "something_field" )
-        
+        MockDocument.field_semantics.merge!(
+          title: ["title_field", "other_title"],
+          author: "author_field",
+          something: "something_field"
+        )
+
         @doc1 = MockDocument.new( 
            "title_field" => "doc1 title",
+           "other_title" => "doc1 title other",
            "something_field" => ["val1", "val2"],
            "not_in_list_field" => "weird stuff" 
          )
       end
 
       it "should return complete dictionary based on config'd fields" do        
-        expect(@doc1.to_semantic_values).to eq :title => ["doc1 title"], :something => ["val1", "val2"]
+        expect(@doc1.to_semantic_values)
+          .to eq title: ["doc1 title", "doc1 title other"], something: ["val1", "val2"]
       end      
       it "should return empty array for a key without a value" do
         expect(@doc1.to_semantic_values[:author]).to be_empty

data/spec/views/catalog/_show_tools.html.erb_spec.rb

@@ -69,5 +69,17 @@ describe "catalog/_show_tools.html.erb" do
       render partial: 'catalog/show_tools'
       expect(rendered).not_to have_selector '.some_action > a[data-ajax-modal="trigger"]', text: "Some action"
     end
+
+    context 'without any document actions defined' do
+      before do
+        document_actions.clear
+      end
+
+      it 'does not display the tools' do
+        render partial: 'catalog/show_tools'
+
+        expect(rendered).to be_blank
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.11.0
+  version: 6.11.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails