geoblacklight 6.0.0.pre.alpha.7 → 6.0.0.pre.beta.2

data/app/components/geoblacklight/facets/bbox_field_component.html.erb

@@ -12,6 +12,7 @@
     </button>
   </h3>
   <div id="<%= html_id %>" role="region" aria-labelledby="<%= header_html_id %>" class="panel-collapse facet-content collapse show">
-    <%= render Geoblacklight::LocationLeafletMapComponent.new(geosearch: { dynamic: true }) %>
+    <%# No map_geometry: this map is pointed at the results, or at the area they are filtered to %>
+    <%= render Geoblacklight::OverviewMapComponent.new(geosearch: true, map_geometry: nil) %>
   </div>
 </div>

data/app/components/geoblacklight/georeferenced_header_badge_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # Badge that indicates the data is georeferenced
+  class GeoreferencedHeaderBadgeComponent < HeaderBadgeComponent
+    # Don't render for empty or false values
+    def render?
+      @document.georeferenced?
+    end
+
+    # Without this, the badge would show "true" for the label
+    def label
+      t("geoblacklight.badges.georeferenced")
+    end
+  end
+end

data/app/components/geoblacklight/header_badge_component.html.erb

@@ -1,2 +1,4 @@
-<span class="badge text-bg-secondary text-uppercase fw-semibold d-inline-flex align-items-center gap-1 me-1">
-  <%= label %><%= icon(field) %></span>
+<span class="badge icon-badge">
+  <%= tag.span label, class: 'label' %>
+  <%= icon %>
+</span>

data/app/components/geoblacklight/header_badge_component.rb

@@ -14,7 +14,7 @@ module Geoblacklight
       @document[field]
     end
 
-    def icon(field)
+    def icon
       helpers.geoblacklight_icon(label)
     end
   end

data/app/components/geoblacklight/header_badges_component.html.erb

@@ -0,0 +1,5 @@
+<div class="badges">
+  <% @fields.each do |field| %>
+    <%= render_badge(field) %>
+  <% end %>
+</div>

data/app/components/geoblacklight/header_badges_component.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class HeaderBadgesComponent < ViewComponent::Base
+    attr_reader :document
+
+    DEFAULT_FIELDS = [
+      Geoblacklight.configuration.fields.access_rights,
+      Geoblacklight.configuration.fields.resource_class,
+      Geoblacklight.configuration.fields.georeferenced
+    ].freeze
+
+    def initialize(document:, fields: DEFAULT_FIELDS)
+      @document = document
+      @fields = fields
+      super()
+    end
+
+    def render_badge(field)
+      render badge_class(field).new(document: @document, field:)
+    end
+
+    def badge_class(field)
+      case field
+      when Geoblacklight.configuration.fields.resource_class
+        Geoblacklight::ResourceHeaderBadgeComponent
+      when Geoblacklight.configuration.fields.georeferenced
+        Geoblacklight::GeoreferencedHeaderBadgeComponent
+      else
+        Geoblacklight::HeaderBadgeComponent
+      end
+    end
+  end
+end

data/app/components/geoblacklight/iiif_drag_drop_component.html.erb

@@ -1,3 +1,3 @@
 <%= link_to @href_link, data: {manifest: @manifest}, class: 'float-end' do %>
-  <%= helpers.geoblacklight_icon('iiif-drag-drop', classes: 'svg_tooltip iiif-icon') %>
+  <%= helpers.geoblacklight_icon('iiif-drag-drop', classes: 'iiif-icon') %>
 <% end %>

data/app/components/geoblacklight/item_map_viewer_component.html.erb

@@ -1,59 +1 @@
 <%= display_tag %>
-<% content_for :head do %>
-  <!-- Include Mirador 3 for IIIF content -->
-  <script src="https://unpkg.com/mirador@^3/dist/mirador.min.js"></script>
-  <!-- Include OpenSeadragon for IIIF Image content -->
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/openseadragon/2.4.2/openseadragon.min.js"></script>
-<% end %>
-<% if iiif_manifest? %>
-  <!-- Initialize Mirador viewer -->
-  <script>
-    window.miradorTarget = document.getElementById("mirador");
-    if (window.miradorTarget) {
-      Mirador.viewer({
-        id: "mirador",
-        windows: [
-          {
-            id: "main",
-            loadedManifest: window.miradorTarget.dataset.manifestUrl,
-          },
-        ],
-        window: {
-          allowClose: false,
-          allowFullscreen: true,
-          allowMaximize: false,
-          authNewWindowCenter: "screen",
-          hideWindowTitle: true,
-          sidebarPanel: "attribution",
-          views: [
-            { key: "single", behaviors: [null, "individuals"] },
-            { key: "book", behaviors: [null, "paged"] },
-            { key: "scroll", behaviors: ["continuous"] },
-            { key: "gallery" },
-          ],
-        },
-        workspace: {
-          showZoomControls: true,
-          type: "single",
-        },
-        workspaceControlPanel: {
-          enabled: false,
-        },
-      });
-  }
-  </script>
-<% elsif iiif_image? %>
-  <!-- Initialize OpenSeadragon viewer -->
-  <script>
-    window.osdTarget = document.getElementById("openseadragon");
-    if (window.osdTarget) {
-      OpenSeadragon({
-        id: "openseadragon",
-        tileSources: [window.osdTarget.dataset.imageUrl],
-        prefixUrl: "https://cdnjs.cloudflare.com/ajax/libs/openseadragon/2.4.2/images/",
-        preserveViewport: true,
-        visibilityRatio: 1,
-      });
-    }
-  </script>
-<% end %>

data/app/components/geoblacklight/item_map_viewer_component.rb

@@ -7,16 +7,10 @@ module Geoblacklight
       @document = document
     end
 
-    # If the conditions for this being IIIF content are met, dislay the IIIF viewer
-    # If it is oembed content, display the oembed viewer
-    # Otherwise display the base viewer which will take into account if it is open layers
-    # or generic content.
+    # Use the appropriate viewer based on the protocol of the document
     def display_tag
-      return iiif_manifest_tag if iiif_manifest?
-      return iiif_image_tag if iiif_image?
-      return oembed_tag if protocol == "Oembed"
-
-      base_tag
+      return oembed_tag if @document.viewer_protocol == "oembed"
+      ogm_viewer_tag
     end
 
     def render?
@@ -25,45 +19,6 @@ module Geoblacklight
 
     private
 
-    def protocol
-      @document.viewer_protocol&.camelize
-    end
-
-    def openlayers?
-      %w[Cog Pmtiles].include?(protocol)
-    end
-
-    def iiif_image?
-      protocol == "Iiif"
-    end
-
-    def iiif_manifest?
-      protocol == "IiifManifest"
-    end
-
-    # Use mirador as the IIIF manifest viewer due to bug in Clover; see:
-    # https://github.com/samvera-labs/clover-iiif/issues/294
-    def iiif_manifest_tag
-      tag.div(nil,
-        id: "mirador",
-        class: "viewer mirador-viewer",
-        data: {
-          manifest_url: @document.viewer_endpoint
-        })
-    end
-
-    # Use openseadragon for IIIF image content due to bug in Clover; see:
-    # https://github.com/samvera-labs/clover-iiif/issues/294
-    def iiif_image_tag
-      tag.div(nil,
-        id: "openseadragon",
-        class: "viewer openseadragon-viewer",
-        data: {
-          image_url: @document.viewer_endpoint
-        })
-    end
-
-    # Generate the viewer HTML for oEmbed content
     def oembed_tag
       tag.div(nil,
         id: "oembed-viewer",
@@ -74,30 +29,24 @@ module Geoblacklight
         })
     end
 
-    # The leaflet and openlayers viewers share a lot of the same data attributes
-    # so we can use a base tag for both of them and just vary a few names
-    def base_tag
-      viewer_name = openlayers? ? "openlayers-viewer" : "leaflet-viewer"
-      tag.div(nil,
-        id: viewer_name,
-        class: "viewer #{viewer_name}",
-        data: {
-          "controller" => viewer_name,
-          "#{viewer_name}-available-value" => helpers.document_available?(@document),
-          "#{viewer_name}-basemap-value" => Geoblacklight.configuration.basemap_provider,
-          "#{viewer_name}-dark-basemap-value" => Geoblacklight.configuration.dark_basemap_provider,
-          "#{viewer_name}-protocol-value" => protocol,
-          "#{viewer_name}-url-value" => @document.viewer_endpoint,
-          "#{viewer_name}-map-geom-value" => @document.geometry.geojson,
-          "#{viewer_name}-layer-id-value" => @document.wxs_identifier,
-          "#{viewer_name}-options-value" => leaflet_options.to_h,
-          "#{viewer_name}-page-value" => params[:action]&.upcase,
-          "#{viewer_name}-draw-initial-bounds-value" => true
-        }.compact)
+    def ogm_viewer_tag
+      tag.ogm_viewer(nil,
+        :class => "viewer ogm-viewer",
+        "hide-title" => true,
+        "theme" => helpers.geoblacklight_viewer_theme,
+        "light-basemap" => Geoblacklight.configuration.light_basemap_url,
+        "dark-basemap" => Geoblacklight.configuration.dark_basemap_url,
+        "record-url" => helpers.viewer_solr_document_path(@document),
+        :data => {restricted_origins: restricted_origins})
     end
 
-    def leaflet_options
-      Geoblacklight.configuration.leaflet_options
+    # URLs where the viewer will send credentials (cookies) to, in order to try
+    # to preview restricted data
+    def restricted_origins
+      origins = Geoblacklight.configuration.restricted_origins
+      return if origins.blank? || !@document.restricted? || !helpers.document_available?(@document)
+
+      origins.to_json
     end
   end
 end

data/app/components/geoblacklight/locator_map_component.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # A map of where one record is, beside its metadata. There is nothing to search and nothing it
+  # reports back; the record's own extent is all it draws, from the same endpoint <ogm-viewer>
+  # already reads its metadata from.
+  class LocatorMapComponent < ViewComponent::Base
+    def initialize(document:, id: "locator-map")
+      @document = document
+      @id = id
+      super()
+    end
+
+    def viewer_tag
+      tag.ogm_locator(nil, **attributes)
+    end
+
+    private
+
+    def attributes
+      {
+        :id => @id,
+        :class => "viewer locator-map",
+        "theme" => helpers.geoblacklight_viewer_theme,
+        "light-basemap" => Geoblacklight.configuration.light_basemap_url,
+        "dark-basemap" => Geoblacklight.configuration.dark_basemap_url,
+        "record-url" => helpers.viewer_solr_document_path(@document)
+      }
+    end
+  end
+end

data/app/components/geoblacklight/login_link_component.html.erb

@@ -1,3 +1,3 @@
 <%= link_to t('geoblacklight.tools.login_to_view'),
-            new_user_session_path(referrer: request.original_url),
+            helpers.blacklight_login_path,
             class: ['btn', 'login-btn', 'd-block'] %>

data/app/components/geoblacklight/login_link_component.rb

@@ -10,8 +10,24 @@ module Geoblacklight
       super()
     end
 
+    def before_render
+      store_return_location if render?
+    end
+
     def render?
-      document.restricted? && document.same_institution? && !helpers.user_signed_in?
+      document.restricted? &&
+        document.same_institution? &&
+        helpers.blacklight_login_path.present? &&
+        !helpers.current_user_signed_in?
+    end
+
+    private
+
+    # Bring the user back to this record once they've signed in, for either
+    # Devise or Rails auth.
+    def store_return_location
+      controller.store_location_for(:user, request.original_url) if controller.respond_to?(:store_location_for)
+      controller.send(:store_location_for_rails_authentication)
     end
   end
 end

data/app/components/geoblacklight/metadata_description_markdown_component.rb

@@ -2,19 +2,13 @@
 
 module Geoblacklight
   class MetadataDescriptionMarkdownComponent < Blacklight::MetadataFieldComponent
-    # Transform markdown into HTML
-    # @param [String] value markdown to transform
-    # @return [ActiveSupport::SafeBuffer] rendered HTML
-    def markdown_to_html(value)
-      Commonmarker.to_html(value).html_safe
-    end
-
     def render_field_values
       [tag.div(class: "truncate-abstract", data: {
         read_more_text: t("geoblacklight.truncate.read_more"),
-        close_text: t("geoblacklight.truncate.close")
+        close_text: t("geoblacklight.truncate.close"),
+        max_lines: 12
       }) do
-        safe_join(Array(@field.values).flatten.map { |value| markdown_to_html(value) })
+        safe_join(Array(@field.values).flatten.map { |value| helpers.markdown_to_html(value) })
       end]
     end
   end

data/app/components/geoblacklight/overview_map_component.html.erb

@@ -0,0 +1,2 @@
+<%= viewer_tag %>
+<%= bounds_tag %>

data/app/components/geoblacklight/overview_map_component.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "rgeo"
+require "rgeo-geojson"
+
+module Geoblacklight
+  # Renders a map that can show more than one record at a time, and number them
+  # in the order they were provided. Use for homepage, search, bookmarks, etc.
+  class OverviewMapComponent < ViewComponent::Base
+    def initialize(
+      map_geometry: config.homepage_map_geom,
+      geosearch: false,
+      id: "overview-map"
+    )
+      @map_geometry = map_geometry if map_geometry != "null"
+      @geosearch = geosearch
+      @id = id
+      super()
+    end
+
+    def viewer_tag
+      tag.ogm_overview(nil, **attributes)
+    end
+
+    # Hidden element containing the search bounds for the Stimulus controller
+    # to parse when this component is reconnected via Turbo
+    def bounds_tag
+      tag.span hidden: true, id: "#{@id}-bounds", data: {bounds: search_bounds}
+    end
+
+    def config
+      Geoblacklight.configuration
+    end
+
+    private
+
+    def attributes
+      {
+        :id => @id,
+        :class => "viewer overview-map",
+        "theme" => helpers.geoblacklight_viewer_theme,
+        "light-basemap" => Geoblacklight.configuration.light_basemap_url,
+        "dark-basemap" => Geoblacklight.configuration.dark_basemap_url,
+        "search-bounds" => search_bounds,
+        "view-bounds" => view_bounds,
+        "geosearch" => @geosearch || nil,
+        "search-help-text" => (t("geoblacklight.map.geosearch.search_help") if @geosearch),
+        "data-turbo-permanent" => true,
+        :data => data_attributes
+      }
+    end
+
+    def data_attributes
+      {
+        :controller => "overview-map",
+        :action => "boundsChange->overview-map#search highlightChange->overview-map#highlight",
+        "overview-map-catalog-url-value" => (helpers.search_action_path if @geosearch)
+      }.compact
+    end
+
+    # The bounding box a search is currently filtered to, as W,S,E,N degrees.
+    # When this is active, the camera frames it with some padding around the edges.
+    def search_bounds
+      params[:bbox] if params[:bbox].present?
+    end
+
+    # Where the camera should frame initially. Used for making e.g. the homepage
+    # map point somewhere other than null island on initial load.
+    def view_bounds
+      envelope(@map_geometry) if @map_geometry.present?
+    end
+
+    # Convert geometry provided by homepage_map_geom into a bounding box that
+    # we can pass to MapLibre's camera to frame.
+    def envelope(geometry)
+      shape = RGeo::GeoJSON.decode(geometry)
+      raise "not a geometry" unless shape
+
+      box = RGeo::Cartesian::BoundingBox.create_from_geometry(shape)
+      [box.min_x, box.min_y, box.max_x, box.max_y].join(" ")
+    rescue
+      Geoblacklight.logger.warn "Unreadable homepage_map_geom: #{geometry}"
+      nil
+    end
+  end
+end

data/app/components/geoblacklight/relations/relation_component.html.erb

@@ -0,0 +1,12 @@
+<li class="list-group-item">
+  <%= link_to document.title, solr_document_path(document) %>
+  <%= render Geoblacklight::HeaderBadgesComponent.new(document: document) %>
+  <% if document.description.present? %>
+    <div class="truncate-abstract description" data-read-more-text="<%= t("geoblacklight.truncate.read_more") %>" data-close-text="<%= t("geoblacklight.truncate.close") %>" data-max-lines=5>
+      <%= description %>
+    </div>
+  <% end %>
+  <% if render_sibling_link? %>
+    <%= link_to t("geoblacklight.relations.browse.#{browse_label_key}", count: sibling_count), sibling_search_path, class: "browse-all" %>
+  <% end %>
+</li>

data/app/components/geoblacklight/relations/relation_component.rb

@@ -0,0 +1,30 @@
+module Geoblacklight
+  module Relations
+    # Display a single record related to this one
+    class RelationComponent < ViewComponent::Base
+      attr_reader :document, :sibling_count, :browse_label_key
+
+      def initialize(document:, field: nil, sibling_count: nil, browse_label_key: nil)
+        @document = document
+        @field = field
+        @sibling_count = sibling_count
+        @browse_label_key = browse_label_key
+        super()
+      end
+
+      def description
+        safe_join(Array(document.description).map { |value| helpers.markdown_to_html(value) })
+      end
+
+      # sibling_count includes the current document itself, so there's only something
+      # worth browsing to when it's more than just that one document.
+      def render_sibling_link?
+        sibling_count.to_i > 1
+      end
+
+      def sibling_search_path
+        helpers.search_catalog_path(f: {@field => [document.id]})
+      end
+    end
+  end
+end

data/app/components/geoblacklight/relations/relations_component.html.erb

@@ -0,0 +1,15 @@
+<div class="card relations">
+  <div class="card-header">
+    <h2 class="mb-0 h6"><%= t(rel_type_info.label, count: result_count) %></h2>
+  </div>
+  <ul class="list-group list-group-flush relation-list">
+    <% related_docs[0..2].each do |document| %>
+      <%= render Geoblacklight::Relations::RelationComponent.new(document: document, field: configuration.field, sibling_count: sibling_count(document), browse_label_key: browse_label_key) %>
+    <% end %>
+  </ul>
+  <% if result_count > 3 && configuration.query_type == "descendants" %>
+    <div class="card-footer">
+      <%= link_to t("geoblacklight.relations.browse.#{browse_label_key}", count: result_count), browse_all_path %>
+    </div>
+  <% end %>
+</div>

data/app/components/geoblacklight/relations/relations_component.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  module Relations
+    # Display links to records related to this one
+    class RelationsComponent < ViewComponent::Base
+      attr_reader :relationship_type, :rel_type_info
+
+      def initialize(relations:, relationship_type:, rel_type_info:)
+        @relations = relations
+        @relationship_type = relationship_type
+        @rel_type_info = rel_type_info
+        super()
+      end
+
+      def render?
+        result_count.positive?
+      end
+
+      def result_count
+        response["numFound"].to_i
+      end
+
+      def related_docs
+        @related_docs ||= Array(response["docs"]).map { |hash| ::SolrDocument.new(hash) }
+      end
+
+      def browse_all_path
+        helpers.search_catalog_path({f: {configuration.field => [@relations.link_id]}})
+      end
+
+      # @param [SolrDocument] document an ancestor of the current document
+      # @return [Integer, nil] how many documents in total - including the current one,
+      #   which is always among them, since that's how this ancestor was found in the
+      #   first place - share this ancestor.
+      def sibling_count(document)
+        return unless configuration.query_type == "ancestors"
+
+        Geoblacklight::Relations::Descendants.new(RSolr.solr_escape(document.id), configuration.field, @relations.repository).results["numFound"].to_i
+      end
+
+      # @return [String] locale key under geoblacklight.relations.browse, e.g. "part_of"
+      #   for both the "part_of_ancestors" and "part_of_descendants" relationship_type
+      def browse_label_key
+        relationship_type.to_s.sub(/_(ancestors|descendants)\z/, "")
+      end
+
+      private
+
+      def configuration
+        Geoblacklight.configuration.relationships_shown.public_send(relationship_type)
+      end
+
+      def response
+        @response ||= @relations.public_send(relationship_type) || {}
+      end
+    end
+  end
+end

data/app/components/geoblacklight/resource_header_badge_component.rb

@@ -8,7 +8,7 @@ module Geoblacklight
       dataset_type
     end
 
-    def icon(field)
+    def icon
       return resource_type_icon unless resource_type_icon_missing?
       default_resource_icon
     end

data/app/components/geoblacklight/search_result_component.html.erb

@@ -1,47 +1,28 @@
 <%# This template copies from Blacklight's components/document_component.html.erb
       # for the wrapping `content_tag @component` structure
-      # and adds custom layout within for the document header, status-icons and more-info areas %>
+      # and adds custom layout within for the document header, badges and description area %>
 
 <%= content_tag @component,
   id: @id,
   data: {
     'document-id': @document.id.to_s.parameterize,
-    'document-counter': @counter,
-    'search-results-target': 'result',
-    'action': 'mouseenter->search-results#previewResultOnMap mouseleave->search-results#clearPreview'
+    'map-id': @document.id.to_s,
+    'document-counter': @counter
   },
   itemscope: true,
   itemtype: @document.itemtype,
   class: classes do %>
-
-  <%= content_tag :div, class: 'document-main-section' do %>
-  <%= content_tag :header, class: 'documentHeader index-split', data: { layer_id: @document.id, geom: @document.geometry.geojson } do %>
-    <div class="document-counter">
-      <%= t('blacklight.search.documents.counter', :counter => @counter) if @counter %>
+  <%= header %>
+  <%= thumbnail %>
+  <div class="document-main-section">
+    <%= title %>
+    <div class="metadata">
+      <%= render Geoblacklight::HeaderBadgesComponent.new(document: @document) %>
+      <% if document.description.present? %>
+        <div class="truncate-abstract description" data-read-more-text="<%= t("geoblacklight.truncate.read_more") %>" data-close-text="<%= t("geoblacklight.truncate.close") %>" data-max-lines=4 itemprop="description">
+          <%= description %>
+        </div>
+      <% end %>
     </div>
-
-    <h3 class="index_title">
-      <%= helpers.link_to_document(@document, counter: @counter, itemprop: "name") %>
-    </h3>
-
-    <button
-        class="btn dropdown-toggle collapsed"
-        data-bs-toggle="collapse"
-        data-bs-target="#doc-<%= @document.id %>-fields-collapse"
-        aria-label="<%= t('geoblacklight.metadata.toggle_summary') %>"
-        aria-expanded="false"
-        aria-controls="doc-<%= @document.id %>-fields-collapse">
-    </button>
-  <% end %>
-  <div class="status-icons mx-4 mt-2">
-    <%= render Geoblacklight::HeaderIconsComponent.new(document: @document) %>
   </div>
-  <% end %>
 <% end %>
-<div class="more-info-area border-bottom">
-  <div id="doc-<%= @document.id %>-fields-collapse" class="collapse">
-    <small itemprop="description">
-      <%= index_fields_display %>
-    </small>
-  </div>
-</div>

data/app/components/geoblacklight/search_result_component.rb

@@ -9,20 +9,8 @@ module Geoblacklight
   #    Otherwise view_component will not provide the count value when calling the component.
   #
   class SearchResultComponent < Blacklight::DocumentComponent
-    # Presents configured index fields in search results. Passes values through
-    # configured helper_method. Multivalued fields separated by presenter
-    # field_value_separator (default: comma). Fields separated by period.
-    # @return [String]
-    def index_fields_display
-      fields_values = []
-      @presenter.configuration.index_fields.each_value do |field_config|
-        val = @presenter.field_value(field_config).to_sentence
-        if val.present?
-          val += "." unless val.end_with?(".")
-          fields_values << val
-        end
-      end
-      safe_join(fields_values, " ")
+    def description
+      safe_join(Array(document.description).map { |value| helpers.markdown_to_html(value) })
     end
   end
 end