geoblacklight 2.1.1 → 2.4.0

data/app/assets/stylesheets/geoblacklight/modules/item.scss

@@ -19,4 +19,20 @@
       }
     }
   }
+
+  .help-text {
+    cursor: pointer;
+  }
+
+  .truncate-abstract.collapse:not(.show),
+  .truncate-abstract.collapsing {
+    display: block;
+    display: -webkit-box;
+    height: auto;
+    min-height: #{8 * $line-height-base}rem;
+    max-height: #{8 * $line-height-base}rem;
+    overflow-y: hidden;
+    -webkit-box-orient: vertical;
+    -webkit-line-clamp: 8;
+  }
 }

data/app/assets/stylesheets/geoblacklight/modules/results.scss

@@ -3,44 +3,75 @@
 }
 
 .more-info-area {
-  float: left;
-  order:3;
   max-height: 100px;
   overflow:hidden;
 }
 
-.text-span{
-  width:80%;
-  float:left;
-}
-
-.hide-overflow {
-  white-space: nowrap;
-  overflow: hidden;
-  text-overflow: ellipsis;
-  display:block
-}
-
-.status-icons {
-  order: 2;
-  margin-left: 0.5rem;
-}
-
 .index_title {
-  order: 1;
-  @extend .text-span;
-  @extend .hide-overflow;
   @extend h5;
+  display: flex;
+  justify-content: space-between;
   font-size:1rem;
   width:80%;
+
+  .title-wrapper {
+    @extend .d-flex;
+    @extend .justify-content-start;
+    flex: 1;
+    min-width: 0;
+  }
+
+  .document-counter {
+    @extend .pr-1;
+  }
+
+  a {
+    white-space: nowrap;
+    overflow-x: hidden;
+    min-width: 0;
+    text-overflow: ellipsis;
+    position: relative;
+    z-index: 2; // get the link above the toggle
+  }
+
+  .caret-toggle {
+    @extend .fa, .fa-caret-right;
+    flex-grow: 0;
+    width: 10px;
+
+    &[aria-expanded="true"] {
+      @extend .fa, .fa-caret-down;
+    }
+  }
+
+  .document-counter {
+    flex-grow: 0;
+  }
+
+  .status-icons {
+    margin-left: 0.5rem;
+    white-space: nowrap;
+  }
 }
 
-.caret-toggle {
-  @extend .fa, .fa-caret-right;
-  cursor: pointer;
-  width: 10px;
+#main-container {
+  .category-block {
+    min-height: 240px;
+
+    .category-icon {
+      font-size: 6em;
+    }
+  }
+
+  [data-map="index"] {
+    height: 400px;
 
-  &.open {
-    @extend .fa, .fa-caret-down;
+    .leaflet-control-container {
+      .search-control {
+        a {
+          color: $white;
+        }
+      }
+    }
   }
 }

data/app/assets/stylesheets/geoblacklight/modules/toolbar.scss

@@ -3,6 +3,10 @@
 
   .list-group {
 
+    .list-group-item.exports {
+      margin-top:0px;
+    }
+
     .list-group-item {
 
       form {

data/app/helpers/geoblacklight_helper.rb

@@ -1,4 +1,6 @@
 module GeoblacklightHelper
+  extend Deprecation
+
   def document_available?
     @document.public? || (@document.same_institution? && user_signed_in?)
   end
@@ -81,13 +83,54 @@ module GeoblacklightHelper
                        layout: 'facet_tag_layout')
   end
 
-  def geoblacklight_icon(name)
-    icon_name = name ? name.parameterize : 'none'
-    content_tag :span,
-                '',
-                class: "geoblacklight-icon geoblacklight-#{icon_name}",
-                title: name
+  ##
+  # Returns an SVG icon or empty HTML span element
+  # @return [SVG or HTML tag]
+  def geoblacklight_icon(name, **args)
+    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'
+    end
+  end
+
+  ##
+  # Render an empty span
+  # @return [HTML tag]
+  def render_empty_span(classname)
+    tag.span class: classname
+  end
+
+  ##
+  # Capture SVG icon aria labels to describe
+  def queue_icon_aria_label(feature_name)
+    @aria_labels ||= Set.new
+    @aria_labels << feature_name
+  end
+  deprecation_deprecate :queue_icon_aria_label
+
+  ##
+  # Render a div of divs describing aria-labelledby values
+  # @return [HTML tag]
+  def render_aria_labels(aria_labels)
+    return unless aria_labels.present?
+    content_tag :div, id: 'aria-labels', class: 'sr-only sr-only-focusable' do
+      aria_labels.each do |label|
+        concat(render_aria_label(label))
+      end
+    end
+  end
+  deprecation_deprecate :render_aria_labels
+
+  # Render a div describing a aria-labelledby value
+  # @return [HTML tag]
+  def render_aria_label(label)
+    content_tag :div, id: "aria-label-#{label}" do
+      I18n.t("geoblacklight.aria-labels.#{label}")
+    end
   end
+  deprecation_deprecate :render_aria_label
 
   ##
   # Renders an unique array of search links based off of terms
@@ -139,6 +182,29 @@ module GeoblacklightHelper
     value.html_safe
   end
 
+  ##
+  # Deteremines if a feature should include help text popover
+  # @return [Boolean]
+  def show_help_text?(feature, key)
+    Settings&.HELP_TEXT&.send(feature)&.include?(key)
+  end
+
+  ##
+  # Render help text popover for a given feature and translation key
+  # @return [HTML tag]
+  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}")
+      content_tag :h3, class: 'help-text viewer_protocol h6' do
+        content_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'
+    end
+  end
+
   ##
   # Deteremines if item view should include attribute table
   # @return [Boolean]
@@ -164,6 +230,23 @@ module GeoblacklightHelper
     blacklight_config.basemap_provider || 'positron'
   end
 
+  def display_carto
+    return link_to(
+      content_tag(:span, '', class: 'geoblacklight geoblacklight-carto') +
+      t('geoblacklight.tools.open_carto'),
+      carto_link(@document.carto_reference),
+      target: '_blank'
+    ) if @document.carto_reference.present? && !Settings.CARTO_HIDE
+  end
+
+  def display_arcgis
+    return link_to(
+      blacklight_icon('esri-globe') + ' ' +
+      t('geoblacklight.tools.open_arcgis'),
+      arcgis_link(@document.arcgis_urls)
+    ) if @document.arcgis_urls.present? && !Settings.ARCGIS_HIDE
+  end
+
   ##
   # Creates a Carto OneClick link link, using the configuration link
   # @param [String] file_link
@@ -202,7 +285,7 @@ module GeoblacklightHelper
   def render_facet_item_with_icon(field_name, item)
     doc = Nokogiri::HTML.fragment(render_facet_item(field_name, item))
     doc.at_css('.facet-label').children.first
-       .add_previous_sibling(geoblacklight_icon(item.value))
+       .add_previous_sibling(geoblacklight_icon(item.value, aria_hidden: true))
     doc.to_html.html_safe
   end
 
@@ -239,4 +322,11 @@ module GeoblacklightHelper
       args[:document].references.url.endpoint
     ) if args[:document]&.references&.url
   end
+
+  ## Returns the icon used based off a Settings strategy
+  def relations_icon(document, icon)
+    icon_name = document[Settings.FIELDS.GEOM_TYPE] if Settings.USE_GEOM_FOR_RELATIONS_ICON
+    icon_name = icon if icon_name.blank?
+    geoblacklight_icon(icon_name)
+  end
 end

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

@@ -7,6 +7,7 @@ module Geoblacklight
     include Geoblacklight::SolrDocument::Carto
     include Geoblacklight::SolrDocument::Inspection
     include Geoblacklight::SolrDocument::Arcgis
+    include Geoblacklight::SolrDocument::Citation
 
     delegate :download_types, to: :references
     delegate :viewer_protocol, to: :item_viewer
@@ -17,11 +18,11 @@ module Geoblacklight
     end
 
     def public?
-      fetch(Settings.FIELDS.RIGHTS).casecmp('public').zero?
+      rights_field_data.present? && rights_field_data.casecmp('public').zero?
     end
 
     def restricted?
-      fetch(Settings.FIELDS.RIGHTS).casecmp('restricted').zero?
+      rights_field_data.blank? || rights_field_data.casecmp('restricted').zero?
     end
 
     def downloadable?
@@ -40,8 +41,12 @@ module Geoblacklight
       references.hgl.to_hash unless references.hgl.blank?
     end
 
+    def oembed
+      references.oembed.endpoint unless references.oembed.blank?
+    end
+
     def same_institution?
-      fetch(Settings.FIELDS.PROVENANCE).casecmp(Settings.INSTITUTION.downcase).zero?
+      fetch(Settings.FIELDS.PROVENANCE, '').casecmp(Settings.INSTITUTION.downcase).zero?
     end
 
     def iiif_download
@@ -98,6 +103,10 @@ module Geoblacklight
 
     private
 
+    def rights_field_data
+      fetch(Settings.FIELDS.RIGHTS, '')
+    end
+
     def method_missing(method, *args, &block)
       if /.*_url$/ =~ method.to_s
         checked_endpoint(method.to_s.gsub('_url', ''))

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

@@ -0,0 +1,28 @@
+module Geoblacklight
+  module SolrDocument
+    module Citation
+      include ActionView::Helpers::OutputSafetyHelper
+
+      def geoblacklight_citation(solr_document_url)
+        [
+          fetch(Settings.FIELDS.CREATOR, nil),
+          ("(#{issued})" if issued),
+          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('. ')
+      end
+
+      private
+
+      def issued
+        fetch(Settings.FIELDS.ISSUED, nil)
+      end
+
+      def format
+        fetch(Settings.FIELDS.FILE_FORMAT, nil)
+      end
+    end
+  end
+end

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

@@ -57,6 +57,11 @@ module Geoblacklight
     def hide_suppressed_records(solr_params)
       # Show child records if searching for a specific source parent
       return unless blacklight_params.fetch(:f, {})[Settings.FIELDS.SOURCE.to_sym].nil?
+
+      # Do not suppress action_documents method calls for individual documents
+      # ex. CatalogController#web_services (exportable views)
+      return if solr_params[:q]&.include?('{!lucene}layer_slug_s:')
+
       solr_params[:fq] ||= []
       solr_params[:fq] << '-suppressed_b: true'
     end

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

@@ -0,0 +1,11 @@
+<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/app/views/catalog/_data_dictionary.html.erb

@@ -1,5 +1,6 @@
 <% if document.data_dictionary_download.present? %>
     <%= link_to document.data_dictionary_download[:data_dictionary] do %>
-        <span class='geoblacklight geoblacklight-data-dictionary'></span><%= t('geoblacklight.references.data_dictionary') %>
+        <%= geoblacklight_icon('book', aria_hidden: true) %>
+        <%= t('geoblacklight.references.data_dictionary') %>
     <% end %>
-<% end %>
+<% end %>

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

@@ -1,6 +1,6 @@
 <%= link_to document_action_path(document_action_config, (local_assigns.has_key?(:url_opts) ? url_opts : {}).merge(({id: document} if document) || {})),
             id: document_action_config.fetch(:id, "#{document_action_config.key}Link"),
             data: {}.merge(({blacklight_modal: "trigger"} if document_action_config.modal != false) || {}) do %>
-    <%= content_tag :span, '', class: "geoblacklight geoblacklight-#{document_action_config.key}" %>
+    <%= geoblacklight_icon(document_action_config.key, aria_hidden: true) %>
     <%= document_action_label(document_action_config.key, document_action_config) %>
 <% end %>

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

@@ -2,5 +2,5 @@
   <div id="documents" class="documents-list col-md-6">
     <%= render documents, :as => :document %>
   </div>
-  <%= content_tag :div, '', id: 'map', class: 'col-md-6', data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+  <%= content_tag :div, '', id: 'map', class: 'col-md-6', aria: { label: t('geoblacklight.map.label') }, data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
 </div>

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

@@ -1,11 +1,3 @@
 <% document ||= @document %>
-<% if document.carto_reference.present? %>
-    <%= link_to(carto_link(document.carto_reference), target: '_blank') do %>
-    <span class='geoblacklight geoblacklight-carto'></span><%= t('geoblacklight.tools.open_carto') %>
-    <% end %>
-<% end %>
-<% if document.arcgis_urls.present? %>
-  <%= link_to(arcgis_link(document.arcgis_urls))  do %>
-    <%= blacklight_icon('esri-globe') %> <%= t('geoblacklight.tools.open_arcgis') %>
-  <% end %>
-<% end %>
+<%= display_carto %>
+<%= display_arcgis %>

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

@@ -5,14 +5,14 @@
       <div class='row'>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-home'></span>
+            <%= geoblacklight_icon('home') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.institution') %>
           <%= render_facet_tags [Settings.FIELDS.PROVENANCE] %>
         </div>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-arrow-circle-down'></span>
+            <%= geoblacklight_icon('arrow-circle-down') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.data_type') %>
           <%= render_facet_tags [Settings.FIELDS.GEOM_TYPE] %>
@@ -21,14 +21,14 @@
       <div class='row'>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-globe'></span>
+            <%= geoblacklight_icon('globe') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.placename') %>
           <%= render_facet_tags [Settings.FIELDS.SPATIAL_COVERAGE] %>
         </div>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-tags'></span>
+            <%= geoblacklight_icon('tags') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.subject') %>
           <%= render_facet_tags [Settings.FIELDS.SUBJECT] %>
@@ -37,7 +37,7 @@
     </div>
     <div class='col-sm'>
       <%= content_tag :h3, t('geoblacklight.home.map_heading') %>
-      <%= content_tag :div, '', id: 'map', data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+      <%= content_tag :div, '', id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
     </div>
   </div>
 </div>