geoblacklight 4.0.0 → 4.1.1

data/app/helpers/carto_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module CartoHelper
   ##
   # Creates a Carto OneClick link, using the configuration link
@@ -10,14 +11,14 @@ module CartoHelper
       provider: carto_provider,
       logo: Settings.APPLICATION_LOGO_URL
     )
-    carto_oneclick_host + '?' + params
+    carto_oneclick_host + "?" + params
   end
 
   ##
   # Removes blank space from provider to accomodate Carto OneClick
   #
   def carto_provider
-    application_name.delete(' ')
+    application_name.delete(" ")
   end
 
   private

data/app/helpers/geoblacklight/geoblacklight_helper_behavior.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ##
 # Adds helper behavior logic for GeoBlacklight, to used alongside
 # BlacklightHelperBehavior
@@ -11,7 +12,7 @@ module Geoblacklight
     # @param [Symbol, String] presenting_method
     # @return [String]
     def geoblacklight_present(presenting_method, document = @document)
-      document_presenter(document).try(presenting_method.to_sym) || ''
+      document_presenter(document).try(presenting_method.to_sym) || ""
     end
   end
 end

data/app/helpers/geoblacklight_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GeoblacklightHelper
   def document_available?
     @document.public? || (@document.same_institution? && user_signed_in?)
@@ -9,17 +10,17 @@ module GeoblacklightHelper
   end
 
   def iiif_jpg_url
-    @document.references.iiif.endpoint.sub! 'info.json', 'full/full/0/default.jpg'
+    @document.references.iiif.endpoint.sub! "info.json", "full/full/0/default.jpg"
   end
 
   def download_link_file(label, id, url)
     link_to(
       label,
       url,
-      'contentUrl' => url,
-      data: {
-        download: 'trigger',
-        download_type: 'direct',
+      "contentUrl" => url,
+      :data => {
+        download: "trigger",
+        download_type: "direct",
         download_id: id
       }
     )
@@ -30,9 +31,9 @@ module GeoblacklightHelper
       text,
       download_hgl_path(id: document),
       data: {
-        blacklight_modal: 'trigger',
-        download: 'trigger',
-        download_type: 'harvard-hgl',
+        blacklight_modal: "trigger",
+        download: "trigger",
+        download_type: "harvard-hgl",
         download_id: document.id
       }
     )
@@ -42,22 +43,22 @@ module GeoblacklightHelper
   # @return [String]
   def download_link_iiif
     link_to(
-      download_text('JPG'),
+      download_text("JPG"),
       iiif_jpg_url,
-      'contentUrl' => iiif_jpg_url,
-      data: {
-        download: 'trigger'
+      "contentUrl" => iiif_jpg_url,
+      :data => {
+        download: "trigger"
       }
     )
   end
 
   def download_link_generated(download_type, document)
     link_to(
-      t('geoblacklight.download.export_link', download_format: export_format_label(download_type)),
-      '',
+      t("geoblacklight.download.export_link", download_format: export_format_label(download_type)),
+      "",
       data: {
         download_path: download_path(document.id, type: download_type),
-        download: 'trigger',
+        download: "trigger",
         download_type: download_type,
         download_id: document.id
       }
@@ -69,31 +70,34 @@ module GeoblacklightHelper
   # @param [SolrDocument] args
   # @return [String]
   def snippit(args)
-    truncate(Array(args[:value]).flatten.join(' '), length: 150)
+    truncate(Array(args[:value]).flatten.join(" "), length: 150)
   end
 
   ##
   # Returns an SVG icon or empty HTML span element
   # @return [SVG or HTML tag]
+  # standard:disable Style/ArgumentsForwarding
+  # TODO: Remove linter disable after lowest supported Ruby version >= 3.2
   def geoblacklight_icon(name, **args)
-    icon_name = name ? name.to_s.parameterize : 'none'
+    icon_name = name ? name.to_s.parameterize : "none"
     begin
       blacklight_icon(icon_name, **args)
     rescue Blacklight::Exceptions::IconNotFound
-      tag.span class: 'icon-missing geoblacklight-none'
+      tag.span class: "icon-missing geoblacklight-none"
     end
   end
+  # standard:enable Style/ArgumentsForwarding
 
   ##
   # Looks up properly formatted names for formats
   #
   def proper_case_format(format)
-    t("geoblacklight.formats.#{format.to_s.parameterize(separator: '_')}")
+    t("geoblacklight.formats.#{format.to_s.parameterize(separator: "_")}")
   end
 
   # Format labels are customized for exports - look up the appropriate key.
   def export_format_label(format)
-    t("geoblacklight.download.export_#{format.to_s.parameterize(separator: '_')}_link")
+    t("geoblacklight.download.export_#{format.to_s.parameterize(separator: "_")}_link")
   end
 
   ##
@@ -109,7 +113,7 @@ module GeoblacklightHelper
   #
   def download_text(format)
     download_format = proper_case_format(format)
-    value = t('geoblacklight.download.download_link', download_format: download_format)
+    value = t("geoblacklight.download.download_link", download_format: download_format)
     value.html_safe
   end
 
@@ -126,16 +130,23 @@ module GeoblacklightHelper
   def render_help_text_entry(feature, key)
     if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
       help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
-      tag.h3 class: 'help-text viewer_protocol h6' do
-        tag.a data: { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
+      tag.h3 class: "help-text viewer_protocol h6" do
+        tag.a data: {toggle: "popover", title: help_text[:title], content: help_text[:content]} do
           help_text[:title]
         end
       end
     else
-      tag.span class: 'help-text translation-missing'
+      tag.span class: "help-text translation-missing"
     end
   end
 
+  ##
+  # Determines if item view should render the sidebar static map
+  # @return [Boolean]
+  def render_sidebar_map?(document)
+    Settings.SIDEBAR_STATIC_MAP&.any? { |vp| document.viewer_protocol == vp }
+  end
+
   ##
   # Deteremines if item view should include attribute table
   # @return [Boolean]
@@ -149,8 +160,8 @@ module GeoblacklightHelper
   # get_field_values method
   # @param [Hash] args from get_field_values
   def render_value_as_truncate_abstract(args)
-    tag.div class: 'truncate-abstract' do
-      Array(args[:value]).flatten.join(' ')
+    tag.div class: "truncate-abstract" do
+      Array(args[:value]).flatten.join(" ")
     end
   end
 
@@ -158,7 +169,7 @@ module GeoblacklightHelper
   # Selects the basemap used for map displays
   # @return [String]
   def geoblacklight_basemap
-    blacklight_config.basemap_provider || 'positron'
+    blacklight_config.basemap_provider || "positron"
   end
 
   ##
@@ -168,10 +179,10 @@ module GeoblacklightHelper
   def render_web_services(reference)
     render(
       partial: "web_services_#{reference.type}",
-      locals: { reference: reference }
+      locals: {reference: reference}
     )
   rescue ActionView::MissingTemplate
-    render partial: 'web_services_default', locals: { reference: reference }
+    render partial: "web_services_default", locals: {reference: reference}
   end
 
   ##
@@ -187,13 +198,13 @@ module GeoblacklightHelper
   # @param [Geoblacklight::Metadata::Base] metadata the metadata object
   # @return [String]
   def render_transformed_metadata(metadata)
-    render partial: 'catalog/metadata/content', locals: { content: metadata.transform.html_safe }
+    render partial: "catalog/metadata/content", locals: {content: metadata.transform.html_safe}
   rescue Geoblacklight::MetadataTransformer::TransformError => transform_err
     Geoblacklight.logger.warn transform_err.message
-    render partial: 'catalog/metadata/markup', locals: { content: metadata.to_xml }
+    render partial: "catalog/metadata/markup", locals: {content: metadata.to_xml}
   rescue => err
     Geoblacklight.logger.warn err.message
-    render partial: 'catalog/metadata/missing'
+    render partial: "catalog/metadata/missing"
   end
 
   ##
@@ -221,17 +232,17 @@ module GeoblacklightHelper
     icon_name = document[Settings.FIELDS.GEOM_TYPE] if Settings.USE_GEOM_FOR_RELATIONS_ICON
     icon_name = icon if icon_name.blank?
     icon_options = {}
-    icon_options = { classes: 'svg_tooltip' } if Settings.USE_GEOM_FOR_RELATIONS_ICON
+    icon_options = {classes: "svg_tooltip"} if Settings.USE_GEOM_FOR_RELATIONS_ICON
     geoblacklight_icon(icon_name, **icon_options)
   end
 
   ## Returns the data-map attribute value used as the JS map selector
   def results_js_map_selector(controller_name)
     case controller_name
-    when 'bookmarks'
-      'bookmarks'
+    when "bookmarks"
+      "bookmarks"
     else
-      'index'
+      "index"
     end
   end
 end

data/app/models/concerns/geoblacklight/bbox_filter_query.rb

@@ -38,7 +38,7 @@ module Geoblacklight
     end
 
     def boost
-      "^#{field_config.within_boost || '10'}"
+      "^#{field_config.within_boost || "10"}"
     end
 
     private

data/app/models/concerns/geoblacklight/solr_document/arcgis.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SolrDocument
     module Arcgis

data/app/models/concerns/geoblacklight/solr_document/carto.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SolrDocument
     ##

data/app/models/concerns/geoblacklight/solr_document/citation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SolrDocument
     module Citation
@@ -11,8 +12,8 @@ module Geoblacklight
           fetch(Settings.FIELDS.TITLE, nil),
           ("[#{format}]" if format),
           fetch(Settings.FIELDS.PUBLISHER, nil),
-          I18n.t('geoblacklight.citation.retrieved_from', document_url: solr_document_url)
-        ].flatten.compact.join('. ')
+          I18n.t("geoblacklight.citation.retrieved_from", document_url: solr_document_url)
+        ].flatten.compact.join(". ")
       end
 
       private

data/app/models/concerns/geoblacklight/solr_document/finder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SolrDocument
     ##

data/app/models/concerns/geoblacklight/solr_document/inspection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SolrDocument
     ##

data/app/models/concerns/geoblacklight/solr_document.rb

@@ -20,11 +20,11 @@ module Geoblacklight
     end
 
     def public?
-      rights_field_data.present? && rights_field_data.casecmp('public').zero?
+      rights_field_data.present? && rights_field_data.casecmp("public").zero?
     end
 
     def restricted?
-      rights_field_data.blank? || rights_field_data.casecmp('restricted').zero?
+      rights_field_data.blank? || rights_field_data.casecmp("restricted").zero?
     end
 
     def downloadable?
@@ -39,6 +39,10 @@ module Geoblacklight
       references.download.to_hash if references.download.present?
     end
 
+    def display_note
+      fetch(Settings.FIELDS.DISPLAY_NOTE, "")
+    end
+
     def hgl_download
       references.hgl.to_hash if references.hgl.present?
     end
@@ -48,7 +52,7 @@ module Geoblacklight
     end
 
     def same_institution?
-      fetch(Settings.FIELDS.PROVIDER, '').casecmp(Settings.INSTITUTION.downcase).zero?
+      fetch(Settings.FIELDS.PROVIDER, "").casecmp(Settings.INSTITUTION.downcase).zero?
     end
 
     def iiif_download
@@ -60,7 +64,7 @@ module Geoblacklight
     end
 
     def external_url
-      references.url.endpoint if references.url
+      references.url&.endpoint
     end
 
     def item_viewer
@@ -68,11 +72,11 @@ module Geoblacklight
     end
 
     def itemtype
-      'http://schema.org/Dataset'
+      "http://schema.org/Dataset"
     end
 
     def geom_field
-      fetch(Settings.FIELDS.GEOMETRY, '')
+      fetch(Settings.FIELDS.GEOMETRY, "")
     end
 
     def geometry
@@ -80,7 +84,7 @@ module Geoblacklight
     end
 
     def wxs_identifier
-      fetch(Settings.FIELDS.WXS_IDENTIFIER, '')
+      fetch(Settings.FIELDS.WXS_IDENTIFIER, "")
     end
 
     def file_format
@@ -100,15 +104,19 @@ module Geoblacklight
     private
 
     def rights_field_data
-      fetch(Settings.FIELDS.ACCESS_RIGHTS, '')
+      fetch(Settings.FIELDS.ACCESS_RIGHTS, "")
     end
 
     def method_missing(method, *args, &block)
       if /.*_url$/.match?(method.to_s)
-        checked_endpoint(method.to_s.gsub('_url', ''))
+        checked_endpoint(method.to_s.gsub("_url", ""))
       else
         super
       end
     end
+
+    def respond_to_missing?(method, *args, &block)
+      /.*_url$/.match?(method.to_s) || super
+    end
   end
 end

data/app/models/concerns/geoblacklight/suppressed_records_search_behavior.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   module SuppressedRecordsSearchBehavior
     extend ActiveSupport::Concern
@@ -14,7 +15,7 @@ module Geoblacklight
     def hide_suppressed_records(solr_params)
       # Show suppressed records when searching relationships
       return if blacklight_params.fetch(:f,
-                                        {}).keys.any? do |field|
+        {}).keys.any? do |field|
                   Settings.RELATIONSHIPS_SHOWN.map do |_key, value|
                     value.field
                   end.include?(field)

data/app/presenters/geoblacklight/document_presenter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Geoblacklight
   ##
   # Adds custom functionality for Geoblacklight document presentation
@@ -14,11 +15,11 @@ module Geoblacklight
       @configuration.index_fields.each do |_field_name, field_config|
         val = field_value(field_config)
         if val.present?
-          val += '.' unless val.end_with?('.')
+          val += "." unless val.end_with?(".")
           fields_values << val
         end
       end
-      safe_join(fields_values, ' ')
+      safe_join(fields_values, " ")
     end
   end
 end

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

@@ -1,11 +1,36 @@
-<div class="modal-header">
-  <h1><%= t('blacklight.tools.citation') %></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>
-<div class="modal-body">
-  <% @documents&.each do |document| %>
-    <%= document.geoblacklight_citation(solr_document_url(document)) %>
-  <% end %>
+<div data-controller="clipboard">
+  <div class="modal-header">
+    <h1><%= t('blacklight.tools.citation') %></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>
+  <div class="modal-body" data-clipboard-target="source">
+    <div class="alert alert-info d-none" role="alert">
+      Citation copied to clipboard
+      <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+        <span aria-hidden="true">&times;</span>
+      </button>
+    </div>
+
+      <%= t('blacklight.tools.citation_info') %>
+    <% @documents&.each do |document| %>
+      <%= document.geoblacklight_citation(solr_document_url(document)) %>
+    <% end %>
+  </div>
+  <div class="modal-footer">
+    <button type="button" class="btn btn-primary" data-action="copyToClipboard"><%= t('blacklight.modal.copy-citation') %></button>
+    <button type="button" class="btn btn-secondary" data-dismiss="modal"><%= t('blacklight.modal.close') %></button>
+  </div>
 </div>
+
+<script>
+    $('[data-action="copyToClipboard"]').on('click', function() {
+        let text = $('[data-clipboard-target="source"]').text().trim()
+        navigator.clipboard.writeText(text)
+            .then(() => {
+                $('.alert').removeClass('d-none');
+            })
+    });
+</script>
+

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

@@ -0,0 +1,7 @@
+<% document ||= @document %>
+
+<% if document.display_note.present? %>
+  <% document.display_note.each do |display_note| %>
+    <%= render(Geoblacklight::DisplayNoteComponent.new(display_note: display_note)) %>
+  <% end %>
+<% end %>

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

@@ -1,3 +1,4 @@
+<%= render :partial => 'show_sidebar_static_map' if render_sidebar_map?(@document) %>
 <%= render :partial => 'show_tools' %>
 
 <div class="sidebar-buttons">

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

@@ -0,0 +1,10 @@
+<div class="card">
+  <div class="card-header">
+    <%= I18n.t('geoblacklight.location') %>
+  </div>
+
+  <div class="card-body">
+    <%= content_tag :div, id: 'static-map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: 'Map', url: @document.viewer_endpoint, 'layer-id' => @document.wxs_identifier, 'map-geom' => @document.geometry.geojson, 'catalog-path'=> blacklight_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+    <% end %>
+  </div>
+</div>

data/app/views/relation/index.json.jbuilder

@@ -3,6 +3,6 @@
 json.current_doc @relations.search_id
 json.relations do
   Settings.RELATIONSHIPS_SHOWN.each do |key, _value|
-    json.set! key.downcase.to_s, @relations.send(key) unless @relations.send(key)['numFound'].to_i.zero?
+    json.set! key.downcase.to_s, @relations.send(key) unless @relations.send(key)["numFound"].to_i.zero?
   end
 end

data/config/initializers/new_gbl_settings_defaults_4.1.yml

@@ -0,0 +1,104 @@
+# New GeoBlacklight v4.1 Settings
+
+# Display Notes to display / Non-prefixed default bootstrap class is alert-secondary
+DISPLAY_NOTES_SHOWN:
+  danger:
+    bootstrap_alert_class: alert-danger
+    icon: fire-solid
+    note_prefix: "Danger: "
+  info:
+    bootstrap_alert_class: alert-info
+    icon: circle-info-solid
+    note_prefix: "Info: "
+  tip:
+    bootstrap_alert_class: alert-success
+    icon: lightbulb-solid
+    note_prefix: "Tip: "
+  warning:
+    bootstrap_alert_class: alert-warning
+    icon: triangle-exclamation-solid
+    note_prefix: "Warning: "
+
+# Solr field mappings (Added DISPLAY_NOTE)
+FIELDS:
+  :DISPLAY_NOTE: 'gbl_displayNote_sm'
+
+# Relationships to display
+RELATIONSHIPS_SHOWN:
+  MEMBER_OF_ANCESTORS:
+    field: pcdm_memberOf_sm
+    icon: parent-item
+    inverse: :MEMBER_OF_DESCENDANTS
+    label: geoblacklight.relations.member_of_ancestors
+    query_type: ancestors
+  MEMBER_OF_DESCENDANTS:
+    field: pcdm_memberOf_sm
+    icon: child-item
+    inverse: :MEMBER_OF_ANCESTORS
+    label: geoblacklight.relations.member_of_descendants
+    query_type: descendants
+  PART_OF_ANCESTORS:
+    field: dct_isPartOf_sm
+    icon: parent-item
+    inverse: :PART_OF_DESCENDANTS
+    label: geoblacklight.relations.part_of_ancestors
+    query_type: ancestors
+  PART_OF_DESCENDANTS:
+    field: dct_isPartOf_sm
+    icon: child-item
+    inverse: :PART_OF_ANCESTORS
+    label: geoblacklight.relations.part_of_descendants
+    query_type: descendants
+  RELATION_ANCESTORS:
+    field: dct_relation_sm
+    icon: nil
+    inverse: :RELATION_DESCENDANTS
+    label: geoblacklight.relations.relation_ancestors
+    query_type: ancestors
+  RELATION_DESCENDANTS:
+    field: dct_relation_sm
+    icon: nil
+    inverse: :RELATION_ANCESTORS
+    label: geoblacklight.relations.relation_descendants
+    query_type: descendants
+  REPLACES_ANCESTORS:
+    field: dct_replaces_sm
+    icon: nil
+    inverse: :REPLACES_DESCENDANTS
+    label: geoblacklight.relations.replaces_ancestors
+    query_type: ancestors
+  REPLACES_DESCENDANTS:
+    field: dct_replaces_sm
+    icon: nil
+    inverse: :REPLACES_ANCESTORS
+    label: geoblacklight.relations.replaces_descendants
+    query_type: descendants
+  SOURCE_ANCESTORS:
+    field: dct_source_sm
+    icon: parent-item
+    inverse: :SOURCE_DESCENDANTS
+    label: geoblacklight.relations.source_ancestors
+    query_type: ancestors
+  SOURCE_DESCENDANTS:
+    field: dct_source_sm
+    icon: child-item
+    inverse: :SOURCE_ANCESTORS
+    label: geoblacklight.relations.source_descendants
+    query_type: descendants
+  VERSION_OF_ANCESTORS:
+    field: dct_isVersionOf_sm
+    icon: parent-item
+    inverse: :VERSION_OF_DESCENDANTS
+    label: geoblacklight.relations.version_of_ancestors
+    query_type: ancestors
+  VERSION_OF_DESCENDANTS:
+    field: dct_isVersionOf_sm
+    icon: child-item
+    inverse: :VERSION_OF_ANCESTORS
+    label: geoblacklight.relations.version_of_descendants
+    query_type: descendants
+
+# Enable catalog#show sidebar static map for items with the following viewer protocols
+SIDEBAR_STATIC_MAP:
+  - 'iiif'
+  - 'iiif_manifest'

data/config/initializers/rails_config.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
+
 Config.setup do |config|
-  config.const_name = 'Settings'
+  config.const_name = "Settings"
 end
+
+Settings.prepend_source!(File.expand_path("new_gbl_settings_defaults_4_1.yml", __dir__))
+Settings.reload!