blacklight 7.10.0 → 7.11.1

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

@@ -1,8 +1,6 @@
-<% doc_presenter = show_presenter(document) %>
-<%# default partial to display solr document fields in catalog show view -%>
-<dl class="row dl-invert document-metadata">
-  <% doc_presenter.fields_to_render.each do |field_name, field, field_presenter| -%>
-    <dt class="blacklight-<%= field_name.parameterize %> col-md-3"><%= render_document_show_field_label document, label: field_presenter.label, field: field_name %></dt>
-    <dd class="blacklight-<%= field_name.parameterize %> col-md-9"><%= field_presenter.render %></dd>
-  <% end -%>
-</dl>
+<%= render(
+  Blacklight::DocumentMetadataComponent.new(
+    fields: show_presenter(document).field_presenters,
+    show: true
+  )
+) %>

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

@@ -1,19 +1,25 @@
-<%= render 'previous_next_doc' if @search_context %>
+<%= render 'previous_next_doc' if @search_context && search_session['document_id'] == @document.id %>
 
 <% @page_title = t('blacklight.search.show.title', :document_title => document_show_html_title, :application_name => application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 
-<div id="document" class="document <%= render_document_class %>" itemscope  itemtype="<%= @document.itemtype %>">
-  <div id="doc_<%= @document.id.to_s.parameterize %>">
-    <%= render_document_partials @document, blacklight_config.view_config(:show).partials %>
-  </div>
-</div>
+<%= render (blacklight_config.show.document_component || Blacklight::DocumentComponent).new(document: @document, component: :div, title_component: :h1, show: true) do |component| %>
+  <% component.with(:footer) do %>
+    <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
+      <!--
+           // COinS, for Zotero among others.
+           // This document_partial_name(@document) business is not quite right,
+           // but has been there for a while.
+      -->
+      <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_partial_name(@document)) %>"></span>
+    <% end %>
+  <%  end %>
 
-<% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
-  <!--
-       // COinS, for Zotero among others.
-       // This document_partial_name(@document) business is not quite right,
-       // but has been there for a while.
-  -->
-  <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_partial_name(@document)) %>"></span>
+  <%# Use :body for complete backwards compatibility (overriding the component body markup),
+        but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
+  <% component.with(blacklight_config.show.document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partials) do %>
+    <div id="doc_<%= @document.id.to_s.parameterize %>">
+      <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
+    </div>
+  <% end %>
 <% end %>

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

@@ -1,12 +1,2 @@
 <%= render 'show_tools' %>
-
-<% unless document.more_like_this.empty? %>
-  <div class="card">
-    <div class="card-header">More Like This</div>
-    <div class="card-body">
-      <%= render collection: document.more_like_this,
-                 partial: 'show_more_like_this',
-                 as: :document %>
-    </div>
-  </div>
-<% end %>
+<%= render(Blacklight::Document::MoreLikeThisComponent.new(document: document)) %>

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

@@ -1,13 +1,6 @@
-<% if show_sort_and_per_page? and active_sort_fields.many? %>
-<div id="sort-dropdown" class="sort-dropdown btn-group">
-  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
-      <%= t('blacklight.search.sort.label_html', :field =>sort_field_label(current_sort_field.key)) %> <span class="caret"></span>
-  </button>
-
-  <div class="dropdown-menu" role="menu">
-    <%- active_sort_fields.each do |sort_key, field_config| %>
-      <%= link_to(sort_field_label(sort_key), url_for(search_state.params_for_search(sort: sort_key)), class: 'dropdown-item', role: 'menuitem') %>
-    <%- end -%>
-  </div>
-</div>
+<% if show_sort_and_per_page? %>
+  <%= render(Blacklight::Response::SortComponent.new(
+    choices: active_sort_fields.map { |key, config| [sort_field_label(config.key), key] },
+    search_state: search_state,
+    selected: current_sort_field&.key)) %>
 <% end %>

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

@@ -1,7 +1,7 @@
-<div class="modal-header">
-  <h1 class="modal-title"><%= t('blacklight.email.form.title') %></h1>
-  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-    <span aria-hidden="true">&times;</span>
-  </button>
-</div>
-<%= render :partial => 'email_form' %>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:title, t('blacklight.email.form.title')) %>
+
+  <% component.with(:body) do %>
+    <%= render 'email_form' %>
+  <% end %>
+<% end %>

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

@@ -1,13 +1,6 @@
-<div data-blacklight-modal="container">
-  <div class="modal-header">
-    <h1><%= t('blacklight.email.form.title') %></h1>
-    <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-      <span aria-hidden="true">&times;</span>
-    </button>
-  </div>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:title, t('blacklight.email.form.title')) %>
 
-  <div class="modal-body">
-    <%= render partial: '/shared/flash_msg' %>
-    <span data-blacklight-modal="close"></span>
-  </div>
-</div>
+  <%= render partial: '/shared/flash_msg' %>
+  <span data-blacklight-modal="close"></span>
+<% end %>

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

@@ -1,24 +1,21 @@
-<div class="facet-pagination top row justify-content-between">
-  <%= render :partial=>'facet_pagination' %>
-</div>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:prefix) do %>
+    <div class="facet-pagination top row justify-content-between">
+      <%= render :partial=>'facet_pagination' %>
+    </div>
+  <% end %>
 
-<div class="modal-header">
-  <h1 class="modal-title"><%= facet_field_label(@facet.key) %></h1>
-  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-    <span aria-hidden="true">&times;</span>
-  </button>
-</div>
+  <% component.with(:title, facet_field_label(@facet.key)) %>
 
-<div class="modal-body">
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 
   <div class="facet-extended-list">
-  <%= render_facet_limit(@display_facet, layout: false) %>
+    <%= render_facet_limit(@display_facet, layout: false) %>
   </div>
-</div>
 
-<div class="modal-footer">
-  <div class="facet-pagination bottom row justify-content-between">
-    <%= render :partial=>'facet_pagination' %>
-  </div>
-</div>
+  <% component.with(:footer) do %>
+    <div class="facet-pagination bottom row justify-content-between">
+      <%= render :partial=>'facet_pagination' %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/catalog/index.atom.builder

@@ -6,7 +6,6 @@ xml.instruct!(:xml, encoding: "UTF-8")
 
 xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
          "xmlns:opensearch" => "http://a9.com/-/spec/opensearch/1.1/") do
-
   xml.title   t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name)
   # an author is required, so we'll just use the app name
   xml.author { xml.name application_name }

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

@@ -1,7 +1,7 @@
-<div class="modal-header">
-	<h1 class="modal-title"><%= t('blacklight.sms.form.title') %></h1>
-	<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-    <span aria-hidden="true">&times;</span>
-  </button>
-</div>
-<%= render :partial => 'sms_form' %>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:title, t('blacklight.sms.form.title')) %>
+
+  <% component.with(:body) do %>
+    <%= render 'sms_form' %>
+  <% end %>
+<% end %>

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

@@ -1,13 +1,6 @@
-<div data-blacklight-modal="container">
-  <div class="modal-header">
-    <h1 class="modal-title"><%= t('blacklight.sms.form.title') %></h1>
-    <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-      <span aria-hidden="true">&times;</span>
-    </button>
-  </div>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:title, t('blacklight.sms.form.title')) %>
 
-  <div class="modal-body">
-    <%= render partial: '/shared/flash_msg' %>
-    <span data-blacklight-modal="close"></span>
-  </div>
-</div>
+  <%= render partial: '/shared/flash_msg' %>
+  <span data-blacklight-modal="close"></span>
+<% end %>

data/blacklight.gemspec

@@ -42,7 +42,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "rubocop", '~> 0.63.0'
-  s.add_development_dependency "rubocop-rspec", '~> 1.8'
+  s.add_development_dependency "rubocop", '~> 0.85'
+  s.add_development_dependency "rubocop-rails", '~> 2.6'
+  s.add_development_dependency "rubocop-rspec", '~> 1.43'
   s.add_development_dependency "i18n-tasks"
 end

data/config/i18n-tasks.yml

@@ -15,3 +15,6 @@ search:
   exclude:
     - app/assets/images
     - app/assets/fonts
+
+ignore_missing:
+  - 'button_label_html'

data/config/locales/blacklight.ar.yml

@@ -217,6 +217,8 @@ ar:
         pivot:
           show: فتح
           hide: "إغلاق"
+        group:
+          toggle: 'المزيد »'
       group:
         more: 'المزيد »'
       filters:

data/config/locales/blacklight.de.yml

@@ -197,6 +197,8 @@ de:
         pivot:
           show: Öffnen
           hide: Schließen
+        group:
+          toggle: 'mehr »'
       group:
         more: 'mehr »'
       filters:

data/config/locales/blacklight.en.yml

@@ -197,6 +197,8 @@ en:
         pivot:
           show: Show
           hide: Hide
+        group:
+          toggle: Toggle facets
       group:
         more: 'more »'
       filters:

data/config/locales/blacklight.es.yml

@@ -169,8 +169,8 @@ es:
       pagination:
         title: 'Resultados de navegación'
       pagination_info:
-        no_items_found: 'No %{entry_name} encontrado'
-        single_item_found: '<strong>1</strong> %{entry_name} encontrado'
+        no_items_found: 'No %{entry_name} encontrada'
+        single_item_found: '<strong>1</strong> %{entry_name} encontrada'
         pages:
           one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> de <strong>%{total_num}</strong>'
           other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> de <strong>%{total_num}</strong>'
@@ -197,6 +197,8 @@ es:
         pivot:
           show: Abierto
           hide: Cerrar
+        group:
+          toggle: 'más »'
       group:
         more: 'más »'
       filters:

data/config/locales/blacklight.fr.yml

@@ -200,6 +200,8 @@ fr:
         pivot:
           show: Ouvrir
           hide: Fermer
+        group:
+          toggle: 'plus »'
       group:
         more: 'plus »'
       filters:

data/config/locales/blacklight.hu.yml

@@ -197,6 +197,8 @@ hu:
         pivot:
           show: Megnyitás
           hide: Bezárás
+        group:
+          toggle: 'több »'
       group:
         more: 'több »'
       filters:

data/config/locales/blacklight.it.yml

@@ -197,6 +197,8 @@ it:
         pivot:
           show: Apri
           hide: Chiudi
+        group:
+          toggle: 'altri »'
       group:
         more: 'altri »'
       filters:

data/config/locales/blacklight.nl.yml

@@ -197,6 +197,8 @@ nl:
         pivot:
           show: Openen
           hide: Sluiten
+        group:
+          toggle: 'meer »'
       group:
         more: 'meer »'
       filters:

data/config/locales/blacklight.pt-BR.yml

@@ -198,6 +198,8 @@ pt-BR:
         pivot:
           show: Abrir
           hide: Fechar
+        group:
+          toggle: 'mais »'
       group:
         more: 'mais »'
       filters:

data/config/locales/blacklight.sq.yml

@@ -197,6 +197,8 @@ sq:
         pivot:
           show: Hape
           hide: "Mbylle"
+        group:
+          toggle: 'më shumë »'
       group:
         more: 'më shumë »'
       filters:

data/config/locales/blacklight.zh.yml

@@ -197,6 +197,8 @@ zh:
         pivot:
           show: 打开
           hide: 关
+        group:
+          toggle: '更多 »'
       group:
         more: '更多 »'
       filters:

data/lib/blacklight.rb

@@ -70,6 +70,16 @@ module Blacklight
     Blacklight::RuntimeRegistry.connection_config = value
   end
 
+  def defaults_version
+    @defaults_version ||= blacklight_yml['load_defaults'] ||
+                          # this config parameter was introduced in Blacklight 7.11, so to be safe,
+                          # we pin any 7.x app to the 7.10 behavior
+                          (Blacklight::VERSION.starts_with?('7') && '7.10.0') ||
+                          Blacklight::VERSION
+
+    @defaults_version == 'latest' ? Blacklight::VERSION : @defaults_version
+  end
+
   def self.blacklight_yml
     require 'erb'
     require 'yaml'

data/lib/blacklight/configuration.rb

@@ -65,6 +65,9 @@ module Blacklight
           index: ViewConfig::Index.new(
             # document presenter class used by helpers and views
             document_presenter_class: nil,
+            # component class used to render a document; defaults to Blacklight::DocumentComponent,
+            #   but can be set explicitly to avoid any legacy behavior
+            document_component: nil,
             # solr field to use to render a document title
             title_field: nil,
             # solr field to use to render format-specific partials
@@ -82,6 +85,7 @@ module Blacklight
           show: ViewConfig::Show.new(
             # document presenter class used by helpers and views
             document_presenter_class: nil,
+            document_component: nil,
             display_type_field: 'format',
             # Default route parameters for 'show' requests.
             # Set this to a hash with additional arguments to merge into the route,
@@ -96,7 +100,8 @@ module Blacklight
                                                    list: {},
                                                    atom: {
                                                      if: false, # by default, atom should not show up as an alternative view
-                                                     partials: [:document]
+                                                     partials: [:document],
+                                                     summary_partials: [:index]
                                                    },
                                                    rss: {
                                                      if: false, # by default, rss should not show up as an alternative view
@@ -306,7 +311,7 @@ module Blacklight
     end
 
     # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
 
     # Add a partial to the tools when rendering a document.
     # @!macro partial_if_unless
@@ -319,7 +324,7 @@ module Blacklight
       add_action(show.document_actions, name, opts)
       klass && ActionBuilder.new(klass, name, opts).build
     end
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     # Add a tool for the search result list itself
     # @!macro partial_if_unless

data/lib/blacklight/configuration/fields.rb

@@ -148,13 +148,11 @@ module Blacklight
         end
 
         @table[:reflected_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/reflected_fields", expires_in: 1.hour) do
-          begin
-            repository = repository_class.new(self)
-            repository.reflect_fields
-          rescue => e
-            Blacklight.logger.warn "Error retrieving field metadata: #{e}"
-            false
-          end
+          repository = repository_class.new(self)
+          repository.reflect_fields
+        rescue => e
+          Blacklight.logger.warn "Error retrieving field metadata: #{e}"
+          false
         end
 
         @table[:reflected_fields] || {}

data/lib/blacklight/engine.rb

@@ -8,7 +8,7 @@ module Blacklight
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer 'blacklight.helpers' do
-      ActionView::Base.send :include, BlacklightHelper
+      ActionView::Base.include BlacklightHelper
     end
 
     # This makes our rake tasks visible.

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -6,6 +6,7 @@ module Blacklight
   # additional instances of NestedOpenStructWithHashAccess
   class NestedOpenStructWithHashAccess < OpenStructWithHashAccess
     attr_reader :nested_class
+
     delegate :default_proc=, to: :to_h
 
     def initialize(klass, hash = {})