geoblacklight 2.3.0 → 2.4.0

data/app/assets/javascripts/geoblacklight/modules/geosearch.js

@@ -35,7 +35,7 @@
         History.pushState(null, document.title, this.getSearchUrl());
       },
       delay: 800,
-      staticButton: '<a class="btn btn-primary">Redo search here <span class="glyphicon glyphicon-repeat"></span></a>',
+      staticButton: '<a href="#" class="btn btn-primary">Redo search here <span class="glyphicon glyphicon-repeat"></span></a>',
       dynamicButton: '<label><input type="checkbox" checked> Search when I move the map</label>'
     },
 

data/app/assets/javascripts/geoblacklight/modules/home.js

@@ -10,7 +10,7 @@ Blacklight.onLoad(function() {
       searcher: function() {
         window.location.href = this.getSearchUrl();
       },
-      staticButton: '<a class="btn btn-primary">Search here</a>'
+      staticButton: '<a href="#" class="btn btn-primary">Search here</a>'
     }));
   });
 });

data/app/assets/javascripts/geoblacklight/modules/item.js

@@ -9,5 +9,24 @@ Blacklight.onLoad(function() {
     viewer = new window['GeoBlacklight']['Viewer'][viewerName](element);
   });
 
-  new Readmore( '.truncate-abstract', { maxHeight: 60 } );
+  $('.truncate-abstract').each(function(i, element) {
+    var lines = 12 * parseFloat(getComputedStyle(element).fontSize);
+    if (element.getBoundingClientRect().height < lines) return;
+    var id = element.id || 'truncate-' + i;
+
+    element.id = id;
+    $(element).addClass('collapse');
+
+    var control = $('<button class="btn btn-link p-0 border-0" data-toggle="collapse" aria-expanded="false" data-target="#' + id + '" aria-controls="' + id + '">Read more</button>');
+
+    $(element).on('shown.bs.collapse', function() {
+      control.text('Close');
+    });
+    $(element).on('hidden.bs.collapse', function() {
+      control.text('Read more');
+    });
+
+    control.collapse();
+    control.insertAfter(element);
+  });
 });

data/app/assets/stylesheets/geoblacklight/_blacklight_overrides.scss

@@ -40,12 +40,3 @@ $logo-image: image_url('blacklight/logo.svg') !default
   padding-top:0.5rem;
 }
 // End - Addresses GBL issue #639
-
-
-// Begin - Addresses GBL issue #766 - removes flex from display
-.modal-header {
-  display: block;
-  padding: 15px;
-  border-bottom: 1px solid #e9ecef;
-}
-// End - Addresses GBL issue #766

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

@@ -23,4 +23,16 @@
   .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,45 +3,54 @@
 }
 
 .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%;
-}
 
-.caret-toggle {
-  @extend .fa, .fa-caret-right;
-  cursor: pointer;
-  width: 10px;
+  .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;
+  }
 
-  &.open {
-    @extend .fa, .fa-caret-down;
+  .status-icons {
+    margin-left: 0.5rem;
+    white-space: nowrap;
   }
 }
 

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
@@ -84,13 +86,10 @@ module GeoblacklightHelper
   ##
   # Returns an SVG icon or empty HTML span element
   # @return [SVG or HTML tag]
-  def geoblacklight_icon(name)
+  def geoblacklight_icon(name, **args)
     icon_name = name ? name.to_s.parameterize : 'none'
     begin
-      icon = blacklight_icon(icon_name)
-      # Add icon info to queue after icon instantiated successfully
-      queue_icon_aria_label(icon_name)
-      icon
+      blacklight_icon(icon_name, **args)
     rescue Blacklight::Exceptions::IconNotFound
       tag.span class: 'icon-missing geoblacklight-none'
     end
@@ -109,18 +108,20 @@ module GeoblacklightHelper
     @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
+    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]
@@ -129,6 +130,7 @@ module GeoblacklightHelper
       I18n.t("geoblacklight.aria-labels.#{label}")
     end
   end
+  deprecation_deprecate :render_aria_label
 
   ##
   # Renders an unique array of search links based off of terms
@@ -283,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
 
@@ -320,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?
@@ -102,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/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,6 +1,6 @@
 <% if document.data_dictionary_download.present? %>
     <%= link_to document.data_dictionary_download[:data_dictionary] do %>
-        <%= geoblacklight_icon('book') %>
+        <%= geoblacklight_icon('book', aria_hidden: true) %>
         <%= t('geoblacklight.references.data_dictionary') %>
     <% 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 %>
-    <%= geoblacklight_icon(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/_home_text.html.erb

@@ -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>

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

@@ -1,19 +1,27 @@
 <% # header bar for doc items in index view -%>
 <%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
-  <div class='status-icons'>
-    <%= render partial: 'header_icons', locals: { document: document } %>
-  </div>
-  <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
-    <span class='caret-toggle'></span>
-    <% counter = document_counter_with_offset(document_counter) %>
-    <span class="document-counter">
-      <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+  <h3 class="index_title col pl-2">
+    <button
+      class="caret-toggle btn pl-0 py-0 stretched-link"
+      data-toggle="collapse"
+      data-target="#doc-<%= document.id %>-fields-collapse"
+      aria-expanded="false"
+      aria-controls="doc-<%= document.id %>-fields-collapse">
+    </button>
+    <span class="title-wrapper">
+      <% counter = document_counter_with_offset(document_counter) %>
+      <span class="document-counter">
+        <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+      </span>
+      <%= link_to_document document, counter: counter, title: document[blacklight_config.index.title_field] %>
+    </span>
+    <span class='status-icons'>
+      <%= render partial: 'header_icons', locals: { document: document } %>
     </span>
-    <%= link_to_document document, counter: counter, title: document[blacklight_config.index.title_field] %>
   </h3>
 
   <div class='col-md-12 more-info-area'>
-    <div class='collapse' data-collapse-target="<%= document.id %>">
+    <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
       <small>
         <%= geoblacklight_present(:index_fields_display, document) %>
       </small>

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

@@ -6,7 +6,7 @@
       <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
     <% end %>
 
-    <%= content_tag :div, id: 'map', data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+    <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
     <% end %>
   </div>
 </div>

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

@@ -2,7 +2,7 @@
 
 <%= render partial: 'web_services_default', locals: { reference: reference } %>
 
-<div class='form-group form-inline'>
-  <label class='control-label'><%= t('geoblacklight.references.wfs_abv')%> <code><%= t('geoblacklight.references.wfs_label')%></code></label>
-  <input type='text' value='<%= document.wxs_identifier %>' readonly='readonly' class='form-control'>
+<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>
+  <input id="wfs_abv_webservice" type='text' value='<%= document.wxs_identifier %>' readonly='readonly' class="form-control">
 </div>

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

@@ -2,7 +2,7 @@
 
 <%= render partial: 'web_services_default', locals: { reference: reference } %>
 
-<div class='form-group form-inline'>
-  <label class='control-label'><%= t('geoblacklight.references.wms_abv')%> <code><%= t('geoblacklight.references.wms_label')%></code></label>
-  <input type='text' value='<%= document.wxs_identifier %>' readonly='readonly' class='form-control'>
+<div class="form-group form-inline">
+  <label for="wms_abv_webservice" class="mr-2"><%= t('geoblacklight.references.wms_abv')%> <code><%= t('geoblacklight.references.wms_label')%></code></label>
+  <input id="wms_abv_webservice" type='text' value='<%= document.wxs_identifier %>' readonly='readonly' class="form-control">
 </div>

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

@@ -1,6 +1,8 @@
 <div class="modal-header">
-  <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
   <h3 class="modal-title"><%= t('geoblacklight.metadata.view_metadata')%></h3>
+  <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 metadata-body">
   <%= render partial: 'metadata' %>

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

@@ -1,10 +1,12 @@
 <div class="modal-header">
-  <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
   <h1 class="modal-title"><%= t('geoblacklight.references.services')%></h1>
-  <div class="modal-body">
-    <%= render partial: 'web_services' %>
-  </div>
-  <div class="modal-footer">
-    <button type="button" class="btn btn-default hide-without-js" data-dismiss="modal"><%= t('geoblacklight.references.services_close')%></button>
-  </div>
+  <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">
+  <%= render partial: 'web_services' %>
+</div>
+<div class="modal-footer">
+  <button type="button" class="btn btn-default hide-without-js" data-dismiss="modal"><%= t('geoblacklight.references.services_close')%></button>
 </div>