blacklight 7.10.0 → 7.11.1

data/.travis.yml

@@ -15,8 +15,6 @@ matrix:
       env: "RAILS_VERSION=5.2.4.2"
     - rvm: 2.5.7
       env: "RAILS_VERSION=5.2.4.2 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.9
-      env: "RAILS_VERSION=5.2.4.2"
     - rvm: jruby-9.2.8.0
       env: "RAILS_VERSION=5.2.4.2 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:

data/Gemfile

@@ -39,13 +39,6 @@ else
     gem 'webpacker', '~> 4.0'
   when /^5.[12]/
     gem 'sass-rails', '~> 5.0'
-  when /^4.2/
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
-    gem 'json', '~> 1.8'
-  when /^4.[01]/
-    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -29,6 +29,7 @@ rails generate blacklight:install
 * [Project Homepage](http://projectblacklight.org)
 * [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)
 * [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
+* [Testing and Developing Blacklight](https://github.com/projectblacklight/blacklight/wiki/Testing-and-Developing-Blacklight)
 * [Issue Tracker](https://github.com/projectblacklight/blacklight/issues)
 * [Support](https://github.com/projectblacklight/blacklight/wiki/Support)
 

data/VERSION

@@ -1 +1 @@
-7.10.0
+7.11.1

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

@@ -297,7 +297,7 @@ Blacklight.onLoad(function () {
 
       <div class="modal-body">
         <p>Some message</p>
-        <%= link_to "This result will still be within modal", some_link, data: { blacklight: "preserve" } %>
+        <%= link_to "This result will still be within modal", some_link, data: { blacklight_modal: "preserve" } %>
       </div>
 
 
@@ -488,7 +488,6 @@ Blacklight.handleSearchContextMethod = function (event) {
   form.querySelector('[type="submit"]').click();
   event.preventDefault();
   event.stopPropagation();
-  event.stopImmediatePropagation();
 };
 
 Blacklight.onLoad(function () {

data/app/components/blacklight/document/bookmark_component.html.erb

@@ -0,0 +1,16 @@
+<%-
+# the data-doc-id attribute is used by our JS that converts to a checkbox/label.
+-%>
+<%= form_tag(@bookmark_path,
+             method:  bookmarked? ? :delete : :put,
+             class: "bookmark-toggle",
+             data: {
+               'doc-id' => @document.id,
+               present: t('blacklight.search.bookmarks.present'),
+               absent: t('blacklight.search.bookmarks.absent'),
+               inprogress: t('blacklight.search.bookmarks.inprogress')
+            }) do %>
+  <%= submit_tag(t(bookmarked? ? 'remove.button' : 'add.button', scope: 'blacklight.bookmarks'),
+                 id: "bookmark_toggle_#{@document.id.to_s.parameterize}",
+                 class: "bookmark-#{bookmarked? ? 'remove' : 'add'} btn btn-outline-secondary") %>
+<% end %>

data/app/components/blacklight/document/bookmark_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    class BookmarkComponent < ::ViewComponent::Base
+      def initialize(document:, checked: nil, bookmark_path: nil)
+        @document = document
+        @checked = checked
+        @bookmark_path = bookmark_path
+      end
+
+      def bookmarked?
+        return @checked unless @checked.nil?
+
+        @view_context.bookmarked? @document
+      end
+    end
+  end
+end

data/app/components/blacklight/document/citation_component.html.erb

@@ -0,0 +1,9 @@
+<div>
+  <h1 class="modal-title"><%= title %></h1>
+
+  <%= @formats.each do |i18n_key, citation_method| %>
+    <h2><%= t(i18n_key) %></h2>
+    <%= @document.send(citation_method).html_safe %>
+    <% unless @formats.keys.last === i18n_key %><br/><br/><% end %>
+  <% end %>
+</div>

data/app/components/blacklight/document/citation_component.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    class CitationComponent < ::ViewComponent::Base
+      DEFAULT_FORMATS = {
+        'blacklight.citation.mla': :export_as_mla_citation_txt,
+        'blacklight.citation.apa': :export_as_apa_citation_txt,
+        'blacklight.citation.chicago': :export_as_chicago_citation_txt
+      }.freeze
+
+      with_collection_parameter :document
+
+      def initialize(document:, formats: DEFAULT_FORMATS)
+        @document = document
+        @formats = formats.select { |_k, v| @document.respond_to?(v) }
+      end
+
+      def title
+        @view_context.document_heading(@document)
+      end
+    end
+  end
+end

data/app/components/blacklight/document/more_like_this_component.html.erb

@@ -0,0 +1,12 @@
+<div class="card">
+  <div class="card-header">More Like This</div>
+  <div class="card-body">
+    <ul>
+      <%= @document.more_like_this.each do |document| %>
+        <li class="more_like_this_document">
+          <span class="mlt_title"><%= link_to_document document %></span>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>

data/app/components/blacklight/document/more_like_this_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    class MoreLikeThisComponent < ::ViewComponent::Base
+      with_collection_parameter :document
+
+      def initialize(document:)
+        @document = document
+      end
+
+      def render?
+        @document.more_like_this.present?
+      end
+
+      def link_to_document(*args)
+        @view_context.link_to_document(*args)
+      end
+    end
+  end
+end

data/app/components/blacklight/document_component.html.erb

@@ -0,0 +1,29 @@
+<%= content_tag @component,
+  id: @id,
+  data: {
+    'document-id': @document.id.to_s.parameterize,
+    'document-counter': @counter,
+  },
+  itemscope: true,
+  itemtype: @document.itemtype,
+  class: classes.flatten.join(' ') do %>
+  <%= header %>
+  <% if body.present? %>
+    <%= body %>
+  <% else %>
+    <div class="document-main-section">
+      <header class="documentHeader row">
+        <%= content_tag @title_component, class: 'index_title document-title-heading' do %>
+          <%= before_title %><%= title %><%= after_title %>
+        <% end %>
+        <%= actions %>
+      </header>
+
+      <%= content %>
+      <%= metadata %>
+    </div>
+
+    <%= thumbnail %>
+  <% end %>
+  <%= footer %>
+<% end %>

data/app/components/blacklight/document_component.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class DocumentComponent < ::ViewComponent::Base
+    # Available content areas; some have defaults provided by
+    # the accessors below.
+    with_content_areas :header, :body, :footer,
+                       :before_title, :title, :after_title,
+                       :actions, :metadata, :thumbnail,
+                       :partials
+    with_collection_parameter :document
+
+    # rubocop:disable Metrics/ParameterLists
+    # @param document [Blacklight::Document]
+    # @param presenter [Blacklight::DocumentPresenter]
+    # @param id [String] HTML id for the root element
+    # @param classes [Array, String] additional HTML classes for the root element
+    # @param component [Symbol, String] HTML tag type to use for the root element
+    # @param title_component [Symbol, String] HTML tag type to use for the title element
+    # @param metadata_component [Blacklight::DocumentMetadataComponent]
+    # @param counter [Number, nil]
+    # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
+    def initialize(document: nil, presenter: nil, id: nil, classes: [], component: :article, title_component: :h4, metadata_component: Blacklight::DocumentMetadataComponent, counter: nil, show: false)
+      if presenter.nil? && document.nil?
+        raise ArgumentError, 'missing keyword: :document or :presenter'
+      end
+
+      @document = document || presenter&.document
+      @presenter = presenter
+
+      @component = component
+      @title_component = title_component
+      @id = id || ('document' if show)
+      @classes = classes
+
+      @metadata_component = metadata_component
+
+      @counter = counter
+
+      @show = show
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # HTML classes to apply to the root element
+    def classes
+      [
+        @classes,
+        @view_context.render_document_class(@document),
+        'document',
+        ("document-position-#{@counter}" if @counter)
+      ].compact.flatten
+    end
+
+    # Content for the document title area; should be an inline element
+    def title
+      @title || begin
+        if show?
+          content_tag('span', presenter.heading, itemprop: "name")
+        else
+          @view_context.link_to_document @document, counter: @counter, itemprop: 'name'
+        end
+      end
+    end
+
+    # Content for the document actions area
+    def actions
+      return if @show
+
+      @actions || begin
+        @view_context.render_index_doc_actions @document, wrapping_class: "index-document-functions col-sm-3 col-lg-2"
+      end
+    end
+
+    # Content for the document thumbnail area
+    def thumbnail
+      return if @show
+
+      @thumbnail || begin
+        return unless presenter.thumbnail.exists?
+
+        content_tag :div, class: "document-thumbnail" do
+          presenter.thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: @counter)
+        end
+      end
+    end
+
+    # Content for the document metadata area
+    def metadata
+      @metadata || @view_context.render(@metadata_component.new(fields: presenter.field_presenters, show: show?))
+    end
+
+    # Content that goes before the document title (e.g. the counter)
+    def before_title
+      @before_title || counter
+    end
+
+    private
+
+    def counter
+      return unless @counter
+
+      content_tag :span, class: 'document-counter' do
+        t('blacklight.search.documents.counter', counter: @counter)
+      end
+    end
+
+    def presenter
+      @presenter ||= begin
+        if show?
+          @view_context.presenter(@document)
+        else
+          @view_context.index_presenter(@document)
+        end
+      end
+    end
+
+    def show?
+      @show
+    end
+  end
+end

data/app/components/blacklight/document_metadata_component.html.erb

@@ -0,0 +1,5 @@
+<dl class="document-metadata dl-invert row">
+  <% @fields.each do |field| -%>
+    <%= @view_context.render(field_component(field).new(field: field, show: @show)) %>
+  <% end -%>
+</dl>

data/app/components/blacklight/document_metadata_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class DocumentMetadataComponent < ::ViewComponent::Base
+    with_collection_parameter :fields
+
+    # @param fields [Enumerable<Blacklight::FieldPresenter>] Document field presenters
+    def initialize(fields:, show: false)
+      @fields = fields
+      @show = show
+    end
+
+    def render?
+      @fields.any?
+    end
+
+    def field_component(field)
+      field.try(:component) || Blacklight::MetadataFieldComponent
+    end
+  end
+end

data/app/components/blacklight/facet_item_component.rb

@@ -73,7 +73,7 @@ module Blacklight
     # @return [String]
     # @private
     def render_facet_value
-      content_tag(:span, class: "facet-label") do
+      tag.span(class: "facet-label") do
         link_to_unless(@suppress_link, @label, @href, class: "facet-select")
       end + render_facet_count
     end
@@ -85,12 +85,12 @@ module Blacklight
     # @param [String] item
     # @private
     def render_selected_facet_value
-      content_tag(:span, class: "facet-label") do
-        content_tag(:span, @label, class: "selected") +
+      tag.span(class: "facet-label") do
+        tag.span(@label, class: "selected") +
           # remove link
           link_to(@href, class: "remove") do
-            content_tag(:span, '✖', class: "remove-icon") +
-              content_tag(:span, '[remove]', class: 'sr-only')
+            tag.span('✖', class: "remove-icon") +
+              tag.span('[remove]', class: 'sr-only')
           end
       end + render_facet_count(classes: ["selected"])
     end
@@ -108,7 +108,7 @@ module Blacklight
       return @view_context.render_facet_count(@hits, options) unless @view_context.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
 
       classes = (options[:classes] || []) << "facet-count"
-      content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(@hits)), class: classes)
+      tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(@hits)), class: classes)
     end
 
     private

data/app/components/blacklight/metadata_field_component.html.erb

@@ -0,0 +1,8 @@
+<%= render(@layout.new(field: @field)) do |component| %>
+  <% component.with(:label) do %>
+    <%= label %>
+  <% end %>
+  <% component.with(:value) do %>
+    <%= @field.render %>
+  <% end %>
+<% end %>

data/app/components/blacklight/metadata_field_component.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class MetadataFieldComponent < ::ViewComponent::Base
+    with_collection_parameter :field
+
+    # @param field [Blacklight::FieldPresenter]
+    # @param layout [Blacklight::MetadataFieldLayoutComponent] alternate layout component to use
+    # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
+    def initialize(field:, layout: nil, show: false)
+      @field = field
+      @layout = layout || Blacklight::MetadataFieldLayoutComponent
+      @show = show
+    end
+
+    # @private
+    def label
+      Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
+        if @show
+          @view_context.render_document_show_field_label @field.document, label: @field.label('show'), field: @field.key
+        else
+          @view_context.render_index_field_label @field.document, label: @field.label, field: @field.key
+        end
+      end
+    end
+
+    def render?
+      @field.render_field?
+    end
+  end
+end

data/app/components/blacklight/metadata_field_layout_component.html.erb

@@ -0,0 +1,2 @@
+<dt class="blacklight-<%= @key %> <%= @label_class %>"><%= label %></dt>
+<dd class="blacklight-<%= @key %> <%= @value_class %>"><%= value %></dd>

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class MetadataFieldLayoutComponent < ::ViewComponent::Base
+    with_collection_parameter :field
+    with_content_areas :label, :value
+
+    # @param field [Blacklight::FieldPresenter]
+    def initialize(field:, label_class: 'col-md-3', value_class: 'col-md-9')
+      @field = field
+      @key = @field.key.parameterize
+      @label_class = label_class
+      @value_class = value_class
+    end
+  end
+end

data/app/components/blacklight/response/facet_group_component.html.erb

@@ -0,0 +1,25 @@
+<% # main container for facets/limits menu -%>
+<%= content_tag :div, id: @id,  class: 'facets sidenav facets-toggleable-md' do %>
+  <div class="facets-header">
+    <%= content_tag :h2, @title, class: 'facets-heading' if @title %>
+
+    <%= content_tag :button,
+      class:'navbar-toggler navbar-toggler-right',
+      type: 'button',
+      data: {
+        toggle: 'collapse',
+        target: "##{@panel_id}",
+      },
+      aria: {
+        controls: @panel_id,
+        expanded: 'false',
+        label: t('blacklight.search.facets.group.toggle'),
+      } do %>
+      <span class="navbar-toggler-icon"></span>
+    <% end %>
+  </div>
+
+  <%= content_tag :div, id: @panel_id, class: 'facets-collapse collapse' do %>
+    <%= @view_context.render_facet_partials @fields, response: @response %>
+  <% end %>
+<% end %>