geoblacklight 4.4.1 → 5.0.0.pre.alpha.11

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

@@ -0,0 +1,14 @@
+<div class="index-map-legend pb-2">
+  <div class="index-map-legend-info">
+    <span class="index-map-legend-default" style="background: <%= Settings.LEAFLET.LAYERS.INDEX.DEFAULT.color %>"></span>
+    <p><span class="visually-hidden"><%= Settings.LEAFLET.LAYERS.INDEX.DEFAULT.sr_color_name %> tile indicates </span>Map held by collection</p>
+  </div>
+  <div class="index-map-legend-info">
+    <span class="index-map-legend-unavailable" style="background: <%= Settings.LEAFLET.LAYERS.INDEX.UNAVAILABLE.color %>"></span>
+    <p><span class="visually-hidden"><%= Settings.LEAFLET.LAYERS.INDEX.UNAVAILABLE.sr_color_name %> tile indicates </span>Map not held by collection</p>
+  </div>
+  <div class="index-map-legend-info">
+    <span class="index-map-legend-selected" style="background: <%= Settings.LEAFLET.LAYERS.INDEX.SELECTED.color %>"></span>
+    <p><span class="visually-hidden"><%= Settings.LEAFLET.LAYERS.INDEX.SELECTED.sr_color_name %> tile indicates </span>Selected map tile</p>
+  </div>
+</div>

data/app/components/geoblacklight/index_map_legend_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  ##
+  # A component for rendering legend for the index map
+  #
+  class IndexMapLegendComponent < ViewComponent::Base
+    def initialize(document:)
+      super
+      @document = document
+    end
+
+    def render?
+      @document.item_viewer.index_map
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<%= display_tag %>

data/app/components/geoblacklight/item_map_viewer_component.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class ItemMapViewerComponent < ViewComponent::Base
+    def initialize(document:)
+      super
+      @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.
+    def display_tag
+      return iiif_tag if iiif?
+      return oembed_tag if oembed?
+
+      base_tag
+    end
+
+    def render?
+      @document
+    end
+
+    private
+
+    def protocol
+      @document.viewer_protocol&.camelize
+    end
+
+    def openlayers?
+      %w[Cog Pmtiles].include?(protocol)
+    end
+
+    def iiif?
+      %w[Iiif IiifManifest].include?(protocol)
+    end
+
+    def oembed?
+      protocol == "Oembed"
+    end
+
+    # Generate the viewer HTML for IIIF content
+    def iiif_tag
+      tag.div(nil,
+        id: "clover-viewer",
+        class: "viewer",
+        data: {
+          controller: "clover-viewer",
+          "clover-viewer-protocol-value": protocol,
+          "clover-viewer-url-value": @document.viewer_endpoint
+        })
+    end
+
+    # Generate the viewer HTML for oEmbed content
+    def oembed_tag
+      tag.div(nil,
+        id: "oembed-viewer",
+        class: "viewer",
+        data: {
+          controller: "oembed-viewer",
+          oembed_viewer_url_value: @document.viewer_endpoint
+        })
+    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",
+        data: {
+          "controller" => viewer_name,
+          "#{viewer_name}-available-value" => helpers.document_available?(@document),
+          "#{viewer_name}-basemap-value" => helpers.geoblacklight_basemap,
+          "#{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" => helpers.leaflet_options,
+          "#{viewer_name}-page-value" => params[:action]&.upcase,
+          "#{viewer_name}-draw-initial-bounds-value" => true
+        }.compact)
+    end
+  end
+end

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

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

data/app/components/geoblacklight/location_leaflet_map_component.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class LocationLeafletMapComponent < ViewComponent::Base
+    def initialize(
+      id: "leaflet-viewer",
+      map_geometry: Settings.HOMEPAGE_MAP_GEOM,
+      classes: "",
+      page: nil,
+      geosearch: nil
+    )
+      @id = id
+      @classes = classes
+      @map_geometry = map_geometry if map_geometry != "null"
+      @page = page
+      @geosearch = geosearch
+      super
+    end
+
+    def search_bbox
+      return unless params[:bbox].present?
+
+      bbox = Geoblacklight::BoundingBox.new(*params[:bbox].split(" "))
+      bbox.to_geojson
+    end
+
+    # Add top-level geosearch control to leaflet options if configured
+    def leaflet_options
+      options = helpers.leaflet_options.deep_dup
+      options["CONTROLS"] = {"Geosearch" => @geosearch} if @geosearch
+      options.to_json
+    end
+
+    def viewer_tag
+      tag.div(nil,
+        id: @id,
+        class: @classes,
+        data: {
+          "controller" => "leaflet-viewer",
+          "leaflet-viewer-basemap-value" => helpers.geoblacklight_basemap,
+          "leaflet-viewer-map-geom-value" => search_bbox || @map_geometry,
+          "leaflet-viewer-data-map-value" => @data_map,
+          "leaflet-viewer-page-value" => params[:action]&.upcase,
+          "leaflet-viewer-options-value" => leaflet_options,
+          "leaflet-viewer-catalog-base-url-value" => (helpers.search_catalog_url if @geosearch)
+        }.compact)
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<div class="card authentication">
+    <div class="card-header">
+        <%= link_to t('geoblacklight.tools.login_to_view'), new_user_session_path(referrer: request.original_url), class: ['btn', 'btn-default', 'sidebar-btn'] %>
+    </div>
+</div>

data/app/components/geoblacklight/login_link_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # Display login link
+  class LoginLinkComponent < ViewComponent::Base
+    attr_reader :document
+
+    def initialize(document:)
+      @document = document
+      super
+    end
+
+    def render?
+      document.restricted? && document.same_institution? && !helpers.document_available?
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+<div class="card relations relationship-<%= relationship_type.downcase %>">
+  <div class="card-header">
+    <h2 class="mb-0 h6"><%= t("#{rel_type_info.label}") %></h2>
+  </div>
+
+  <ul class="list-group list-group-flush">
+    <% relationship_type_results['docs'][0..2].map { |hash| SolrDocument.new(hash) }.each do |doc| %>
+      <li class="list-group-item border-bottom-0">
+        <%= link_to solr_document_path(doc) do %>
+          <%= relations_icon(doc, rel_type_info.icon) unless rel_type_info.icon.nil? %>
+          <%= doc.title %>
+        <% end %>
+      </li>
+    <% end %>
+    <% unless (relationship_type_results['numFound'].to_i <= 3) %>
+      <li class="list-group-item border-bottom-0">
+        <%= link_to search_catalog_path({f: {"#{Settings.RELATIONSHIPS_SHOWN.public_send(relationship_type).field}" => [relations.link_id]}}) do %>
+          <%= t('geoblacklight.relations.browse_all', count: relationship_type_results['numFound']) %>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/components/geoblacklight/relations_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # Display expandable file download links in sidebar
+  class RelationsComponent < ViewComponent::Base
+    attr_reader :relations, :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?
+      relationship_type_results["numFound"].to_i.positive?
+    end
+
+    private
+
+    def relationship_type_results
+      @relationship_type_results ||= relations.public_send(relationship_type)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+<%# 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 %>
+
+<%= 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'
+  },
+  itemscope: true,
+  itemtype: @document.itemtype,
+  class: classes.flatten.join(' ') do %>
+
+    <%= content_tag :div, class: 'documentHeader index-split d-flex flex-grow-1', data: { layer_id: @document.id, geom: @document.geometry.geojson } do %>
+      <h3 class="index_title d-flex flex-grow-1">
+        <span class="document-counter">
+          <%= t('blacklight.search.documents.counter', :counter => @counter) if @counter %>
+        </span>
+        <%= helpers.link_to_document(@document, counter: @counter, itemprop: "name") %>
+      </h3>
+
+      <span class='status-icons'>
+        <%= render Geoblacklight::HeaderIconsComponent.new(document: @document) %>
+        <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>
+      </span>
+    <% 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/{presenters/geoblacklight/document_presenter.rb → components/geoblacklight/search_result_component.rb}

@@ -2,18 +2,21 @@
 
 module Geoblacklight
   ##
-  # Adds custom functionality for Geoblacklight document presentation
-  class DocumentPresenter < Blacklight::IndexPresenter
-    include ActionView::Helpers::OutputSafetyHelper
-    ##
+  # A component for rendering a single document
+  #
+  # @note when subclassing Blacklight::DocumentComponent, if you override the initializer,
+  #    you must explicitly specify the counter variable `document_counter` even if you don't use it.
+  #    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 = []
-      @configuration.index_fields.each do |_field_name, field_config|
-        val = field_value(field_config)
+      @presenter.configuration.index_fields.each do |_field_name, field_config|
+        val = @presenter.field_value(field_config).to_s
         if val.present?
           val += "." unless val.end_with?(".")
           fields_values << val

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

@@ -0,0 +1,9 @@
+<div class="card">
+  <div class="card-header">
+    <%= @label %>
+  </div>
+
+  <div class="card-body">
+    <%= viewer_tag %>
+  </div>
+</div>

data/app/components/geoblacklight/static_map_component.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class StaticMapComponent < ViewComponent::Base
+    attr_reader :document
+
+    def initialize(document:, **)
+      @document = document
+      super
+    end
+
+    def render?
+      Settings.SIDEBAR_STATIC_MAP&.any? { |vp| @document.viewer_protocol == vp }
+    end
+
+    def before_render
+      @label ||= t("geoblacklight.location")
+    end
+
+    def viewer_tag
+      tag.div(nil,
+        id: "static-map",
+        aria: {
+          label: @label
+        },
+        data: {
+          "controller" => "leaflet-viewer",
+          "leaflet-viewer-basemap-value" => helpers.geoblacklight_basemap,
+          "leaflet-viewer-page-value" => "STATIC_MAP",
+          "leaflet-viewer-map-geom-value" => @document.geometry.geojson,
+          "leaflet-viewer-options-value" => helpers.leaflet_options,
+          "leaflet-viewer-draw-initial-bounds-value" => true
+        })
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<%= display_text %>

data/app/components/geoblacklight/viewer_help_text_component.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  ##
+  # A component for rendering the help text for the viewer container
+  #
+  class ViewerHelpTextComponent < ViewComponent::Base
+    def initialize(feature, key)
+      @feature = feature
+      @key = key
+      super
+    end
+
+    # Retrieve i18n value
+    def help_text_exists?
+      I18n.exists?("geoblacklight.help_text.#{@feature}.#{@key}", locale)
+    end
+
+    def help_text_value
+      I18n.t("geoblacklight.help_text.#{@feature}.#{@key}")
+    end
+
+    def help_text_tag
+      help_text = help_text_value
+      tag.h2 class: "help-text viewer_protocol h6" do
+        tag.a data: {bs_toggle: "popover", bs_title: help_text[:title], bs_content: help_text[:content]} do
+          help_text[:title]
+        end
+      end
+    end
+
+    def help_text_missing_tag
+      tag.span class: "help-text translation-missing"
+    end
+
+    def display_text
+      return help_text_tag if help_text_exists?
+
+      help_text_missing_tag
+    end
+
+    def render?
+      Settings&.HELP_TEXT&.public_send(@feature)&.include?(@key)
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<%= render_web_services %>

data/app/components/geoblacklight/web_services_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class WebServicesComponent < ViewComponent::Base
+    with_collection_parameter :ref
+
+    def initialize(ref:, document:)
+      @ref = ref
+      @document = document
+      @type = ref.type.to_s
+      super
+    end
+
+    def render?
+      Settings.WEBSERVICES_SHOWN.include? @type
+    end
+
+    def render_web_services
+      component_class_name = "Geoblacklight::WebServices#{@type.camelize}Component"
+      component_class = component_class_name.constantize
+      render component_class.new(reference: @ref, document: @document)
+    rescue
+      render Geoblacklight::WebServicesDefaultComponent.new(reference: @ref)
+    end
+  end
+end

data/app/{views/catalog/_web_services_default.html.erb → components/geoblacklight/web_services_default_component.html.erb}

@@ -1,13 +1,11 @@
-<% document ||= @document %>
-
-<div class='form-group web-services-form'>
+<div class='mb-3 web-services-form'>
   <label for='<%= reference.type%>_webservice'>
     <%= "#{formatted_name_reference(reference.type)}" %>
   </label>
   <div class='input-group'>  
-    <input type='text' id='<%= reference.type%>_webservice' value='<%= reference.endpoint %>' readonly='readonly' class='form-control'>
+    <input type='text' id='<%= reference.type%>_webservice' value='<%= reference.endpoint %>' class='form-control'>
     <div class="input-group-append">
-      <button button type="button" class="btn btn-primary" data-action="copyToClipboard" data-clipboard-value='<%= reference.endpoint %>'><%= t('blacklight.modal.copy') %></button>
+      <button button type="button" class="btn btn-primary" data-action="clipboard#copyToClipboard" data-clipboard-value-param='<%= reference.endpoint %>'><%= t('blacklight.modal.copy') %></button>
     </div>
   </div>
 </div>

data/app/components/geoblacklight/web_services_default_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class WebServicesDefaultComponent < ViewComponent::Base
+    attr_reader :reference
+    def initialize(reference:)
+      @reference = reference
+      super
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+<div class="web-services-sidebar">
+  <%= web_services_link %>
+</div>

data/app/components/geoblacklight/web_services_link_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class WebServicesLinkComponent < ViewComponent::Base
+    def initialize(document:)
+      @document = document
+      super
+    end
+
+    def render?
+      (Settings.WEBSERVICES_SHOWN & @document.references.refs.map(&:type).map(&:to_s)).any?
+    end
+
+    def web_services_link
+      link_to "Web services",
+        helpers.web_services_solr_document_path(id: @document.id),
+        class: ["btn", "btn-primary", "sidebar-btn"],
+        id: "web-services-button",
+        data: {blacklight_modal: "trigger"}
+    end
+  end
+end

data/app/{views/catalog/_web_services_wfs.html.erb → components/geoblacklight/web_services_wfs_component.html.erb}

@@ -1,13 +1,10 @@
-<% document ||= @documents.first %>
-
-<%= render partial: 'web_services_default', locals: { reference: reference } %>
-
-<div class="form-group form-inline">
-  <label for="wfs_abv_webservice" class="mr-2"><%= t('geoblacklight.references.wfs_abv')%> <code><%= t('geoblacklight.references.wfs_label')%></code></label>
+<%= render Geoblacklight::WebServicesDefaultComponent.new(reference:) %>
+<div class="mb-3 d-flex align-items-center">
+  <label for="wfs_abv_webservice" class="me-2"><%= t('geoblacklight.references.wfs_abv')%> <code><%= t('geoblacklight.references.wfs_label')%></code></label>
   <div class='input-group'>
     <input id="wfs_abv_webservice" type='text' value='<%= document.wxs_identifier %>' readonly='readonly' class="form-control">
     <div class="input-group-append">
-      <button button type="button" class="btn btn-primary"  data-action="copyToClipboard" data-clipboard-value='<%= document.wxs_identifier %>'><%= t('blacklight.modal.copy') %></button>
+      <button button type="button" class="btn btn-primary"  data-action="clipboard#copyToClipboard" data-clipboard-value-param='<%= document.wxs_identifier %>'><%= t('blacklight.modal.copy') %></button>
     </div>
   </div>
 </div>

data/app/components/geoblacklight/web_services_wfs_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class WebServicesWfsComponent < ViewComponent::Base
+    attr_reader :reference, :document
+    def initialize(reference:, document:)
+      @reference = reference
+      @document = document
+      super
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+<%= render Geoblacklight::WebServicesDefaultComponent.new(reference:) %>
+<div class="mb-3 d-flex align-items-center">
+  <label for="wms_abv_webservice" class="me-2"><%= t('geoblacklight.references.wms_abv')%> <code><%= t('geoblacklight.references.wms_label')%></code></label>
+  <div class='input-group'>
+    <input id="wms_abv_webservice" type='text' value='<%= document.wxs_identifier %>' class="form-control">
+    <div class="input-group-append">
+      <button button type="button" class="btn btn-primary"  data-action="clipboard#copyToClipboard" data-clipboard-value-param='<%= document.wxs_identifier %>'><%= t('blacklight.modal.copy') %></button>
+    </div>
+  </div>
+</div>

data/app/components/geoblacklight/web_services_wms_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class WebServicesWmsComponent < ViewComponent::Base
+    attr_reader :reference, :document
+    def initialize(reference:, document:)
+      @reference = reference
+      @document = document
+      super
+    end
+  end
+end

data/app/controllers/download_controller.rb

@@ -6,7 +6,7 @@ class DownloadController < ApplicationController
 
   rescue_from Geoblacklight::Exceptions::ExternalDownloadFailed do |exception|
     Geoblacklight.logger.error exception.message + " " + exception.url
-    flash[:danger] = view_context
+    flash.now[:danger] = view_context
       .tag.span(t("geoblacklight.download.error"),
         data: {
           download: "error",
@@ -14,47 +14,29 @@ class DownloadController < ApplicationController
           download_type: "generated-#{params[:type]}"
         })
     respond_to do |format|
-      format.json { render json: flash, response: response }
-      format.html { render json: flash, response: response }
+      format.json { render json: [flash, ""], response: response, status: 500 }
+      format.html { render json: [flash, ""], response: response, status: 500 }
     end
   end
 
   def show
-    @response, @document = search_service.fetch params[:id]
+    @document = search_service.fetch params[:id]
     restricted_should_authenticate
     response = check_type
     validate response
     respond_to do |format|
-      format.json { render json: flash, response: response }
-      format.html { render json: flash, response: response }
+      format.json { render json: [flash, download_file_path(response)], response: response }
+      format.html { render json: [flash, download_file_path(response)], response: response }
     end
   end
 
   def file
     # Grab the solr document to check if it should be public or not
-    @response, @document = search_service.fetch(file_name_to_id(params[:id]))
+    @document = search_service.fetch(file_name_to_id(params[:id]))
     restricted_should_authenticate
     send_file download_file_path_and_name, x_sendfile: true
   end
 
-  def hgl
-    @response, @document = search_service.fetch params[:id]
-    if params[:email]
-      response = Geoblacklight::HglDownload.new(@document, params[:email]).get
-      if response.nil?
-        flash[:danger] = t "geoblacklight.download.error"
-      else
-        flash[:success] = t "geoblacklight.download.hgl_success"
-      end
-      respond_to do |format|
-        format.json { render json: flash, response: response }
-        format.html { render json: flash, response: response }
-      end
-    else
-      render layout: false
-    end
-  end
-
   private
 
   def download_file_path_and_name
@@ -71,11 +53,13 @@ class DownloadController < ApplicationController
       Geoblacklight::GeojsonDownload.new(@document).get
     when "geotiff"
       Geoblacklight::GeotiffDownload.new(@document).get
+    when "csv"
+      Geoblacklight::CsvDownload.new(@document).get
     end
   end
 
   def validate(response)
-    flash[:success] = view_context.link_to(t("geoblacklight.download.success", title: response),
+    flash.now[:success] = view_context.link_to(t("geoblacklight.download.success", title: response),
       download_file_path(response),
       data: {download: "trigger",
              download_id: params[:id],