geoblacklight 2.2.0 → 3.0.1

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Geoblacklight
   # Extends Blacklight::Solr::Document for GeoBlacklight specific functionalit
   module SolrDocument
@@ -7,6 +8,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 +19,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?
@@ -33,27 +35,27 @@ module Geoblacklight
     end
 
     def direct_download
-      references.download.to_hash unless references.download.blank?
+      references.download.to_hash if references.download.present?
     end
 
     def hgl_download
-      references.hgl.to_hash unless references.hgl.blank?
+      references.hgl.to_hash if references.hgl.present?
     end
 
     def oembed
-      references.oembed.endpoint unless references.oembed.blank?
+      references.oembed.endpoint if references.oembed.present?
     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
-      references.iiif.to_hash unless references.iiif.blank?
+      references.iiif.to_hash if references.iiif.present?
     end
 
     def data_dictionary_download
-      references.data_dictionary.to_hash unless references.data_dictionary.blank?
+      references.data_dictionary.to_hash if references.data_dictionary.present?
     end
 
     def external_url
@@ -102,8 +104,12 @@ module Geoblacklight
 
     private
 
+    def rights_field_data
+      fetch(Settings.FIELDS.RIGHTS, '')
+    end
+
     def method_missing(method, *args, &block)
-      if /.*_url$/ =~ method.to_s
+      if /.*_url$/.match?(method.to_s)
         checked_endpoint(method.to_s.gsub('_url', ''))
       else
         super

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Geoblacklight
   module SolrDocument
     module Arcgis
       def arcgis_urls
-        return unless references.esri_webservices.present?
+        return if references.esri_webservices.blank?
         references.esri_webservices.map { |layer| layer.reference[1] if layer }.compact
       end
     end

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

@@ -1,21 +1,9 @@
+# frozen_string_literal: true
 module Geoblacklight
   module SolrDocument
     ##
     # Module for providing external Carto download references for a document
     module Carto
-      extend Deprecation
-      self.deprecation_horizon = 'Geoblacklight 2.0.0'
-      ##
-      # Returns a url to a file that should be used with CartoDB integration
-      # @return [String]
-      # @deprecated Use {#carto_reference} instead
-      def cartodb_reference
-        carto_reference
-      end
-      deprecation_deprecate(
-        cartodb_reference: 'use Geoblacklight::SolrDocument::Carto#carto_reference instead'
-      )
-
       ##
       # Returns a url to a file that should be used with CartoDB integration
       # @return [String]

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+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/solr_document/finder.rb

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Geoblacklight
   module SolrDocument
     ##
@@ -7,7 +8,7 @@ module Geoblacklight
       # Returns boolean about whether document viewer protocol is inspectable
       # @return [Boolean]
       def inspectable?
-        %w(wms feature_layer dynamic_map_layer tiled_map_layer)
+        %w[wms feature_layer dynamic_map_layer tiled_map_layer]
           .include? viewer_protocol
       end
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Geoblacklight
   module SpatialSearchBehavior
     extend ActiveSupport::Concern
@@ -20,9 +21,10 @@ module Geoblacklight
         solr_params[:fq] << "#{Settings.FIELDS.GEOMETRY}:\"Intersects(#{envelope_bounds})\""
 
         if Settings.OVERLAP_RATIO_BOOST
+          solr_params[:bf] ||= []
           solr_params[:overlap] =
             "{!field uf=* defType=lucene f=solr_bboxtype score=overlapRatio}Intersects(#{envelope_bounds})"
-          solr_params[:bf] = "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
+          solr_params[:bf] << "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
         end
       end
       solr_params

data/app/presenters/geoblacklight/document_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Geoblacklight
   ##
   # Adds custom functionality for Geoblacklight document presentation
@@ -12,7 +13,7 @@ module Geoblacklight
       fields_values = []
       @configuration.index_fields.each do |_field_name, field_config|
         val = field_value(field_config)
-        unless val.blank?
+        if val.present?
           val += '.' unless val.end_with?('.')
           fields_values << val
         end

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

@@ -0,0 +1,4 @@
+<% document ||= @document %>
+<%= link_to(arcgis_link(document.arcgis_urls)) do %>
+  <%= blacklight_icon('esri-globe') %> <%= t('geoblacklight.tools.open_arcgis') %>
+<% end %>

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

@@ -0,0 +1,4 @@
+<% document ||= @document %>
+<%= link_to carto_link(document.carto_reference), target: '_blank' do %>
+  <span class='geoblacklight geoblacklight-carto'></span><%= t('geoblacklight.tools.open_carto') %>
+<% 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/_downloads_primary.html.erb

@@ -2,7 +2,14 @@
 <% document ||= @document %>
 
 <% if document.direct_download.present? %>
-  <%= render partial: 'download_link', locals: { download_link: download_link_direct(download_text(document.file_format), document) } %>
+  <% if document.direct_download[:download].is_a? Array %>
+    <% document.direct_download[:download].each do |download| %>
+      <%= render partial: 'download_link', locals: { download_link: download_link_file(download['label'], document.id, download['url']) } %>
+    <% end %>
+  <% end %>
+  <% if document.direct_download[:download].is_a? String %>
+    <%= render partial: 'download_link', locals: { download_link: download_link_direct(download_text(document.file_format), document) } %>
+  <% end %>
 <% end %>
 
 <% if document.hgl_download.present? %>

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

@@ -1,3 +1,3 @@
-<%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE]) %>
-<%= geoblacklight_icon(document[Settings.FIELDS.PROVENANCE]) %>
-<%= geoblacklight_icon(document[Settings.FIELDS.RIGHTS]) %>
+<%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE], classes: 'svg_tooltip') %>
+<%= geoblacklight_icon(document[Settings.FIELDS.PROVENANCE], classes: 'svg_tooltip') %>
+<%= geoblacklight_icon(document[Settings.FIELDS.RIGHTS], classes: 'svg_tooltip') %>

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

@@ -37,7 +37,10 @@
     </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 class="text-right">
+    <%= t('geoblacklight.home.version', version: Geoblacklight::VERSION ) %>
+  </div>
 </div>

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

@@ -1,22 +1,30 @@
 <% # 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>
+<%= content_tag :div, class: 'documentHeader index-split row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+  <h3 class="index_title col">
     <% 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] %>
+    <%= link_to_document document, counter: counter %>
   </h3>
+  <span class='status-icons'>
+    <%= render partial: 'header_icons', locals: { document: document } %>
 
-  <div class='col-md-12 more-info-area'>
-    <div class='collapse' data-collapse-target="<%= document.id %>">
-      <small>
-        <%= geoblacklight_present(:index_fields_display, document) %>
-      </small>
-    </div>
-  </div>
+    <button
+      class="caret-toggle btn"
+      data-toggle="collapse"
+      data-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 %>
+
+<div class='more-info-area'>
+  <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
+    <small>
+      <%= geoblacklight_present(:index_fields_display, document) %>
+    </small>
+  </div>
+</div>

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>

data/app/views/relation/_ancestors.html.erb

@@ -1,10 +1,7 @@
-<li class="list-group-item relations-ancestors">
-  <b><%= t('geoblacklight.relations.ancestor') %></b>
-</li>
 <% @relations.ancestors['docs'].each do |ancestor| %>
-  <li class="list-group-item">
+  <li class="list-group-item border-bottom-0">
     <%= link_to solr_document_path(ancestor['layer_slug_s']) do %>
-      <%= geoblacklight_icon('pagelines-brands') %>
+      <%= relations_icon(ancestor, 'pagelines-brands') %>
       <%= ancestor['dc_title_s'] %>
     <% end %>
   </li>

data/app/views/relation/_descendants.html.erb

@@ -1,16 +1,13 @@
-<li class="list-group-item relations-descendants">
-  <b><%= t('geoblacklight.relations.descendant', count: @relations.descendants['numFound']) %></b>
-</li>
 <% @relations.descendants['docs'][0..2].each do |descendant| %>
-  <li class="list-group-item">
+  <li class="list-group-item border-bottom-0">
     <%= link_to solr_document_path(descendant['layer_slug_s']) do %>
-      <%= geoblacklight_icon('leaf') %>
+      <%= relations_icon(descendant, 'leaf') %>
       <%= descendant['dc_title_s'] %>
     <% end %>
   </li>
 <% end %>
 <% unless (@relations.descendants['numFound'].to_i <= 3) %>
-  <li class="list-group-item">
+  <li class="list-group-item border-bottom-0">
     <%= link_to search_catalog_path({f: {"#{Settings.FIELDS.SOURCE}" => [@relations.link_id]}}) do %>
       <%= t('geoblacklight.relations.browse_all', count: @relations.descendants['numFound']) %>
     <% end %>

data/app/views/relation/index.html.erb

@@ -1,13 +1,25 @@
 <% unless @relations.empty? %>
-  <div class="card relations">
-    <div class="card-header">
-      <%= t('geoblacklight.relations.title') %>
+  <% unless @relations.ancestors['numFound'].to_i.zero? %>
+    <div class="card relations">
+      <div class="card-header">
+        <h2 class="mb-0 h6"><%= t('geoblacklight.relations.ancestor') %></h2>
+      </div>
+
+      <ul class="list-group list-group-flush">
+        <%= render 'ancestors' %>
+      </ul>
     </div>
+  <% end %>
 
-    <ul class="list-group list-group-flush">
-      <%= render 'ancestors' unless @relations.ancestors['numFound'].to_i == 0 %>
-      <%= render 'descendants' unless @relations.descendants['numFound'].to_i == 0 %>
-    </ul>
+  <% unless @relations.descendants['numFound'].to_i.zero? %>
+    <div class="card relations">
+      <div class="card-header">
+        <h2 class="mb-0 h6"><%= t('geoblacklight.relations.descendant') %></h2>
+      </div>
 
-  </div>
+      <ul class="list-group list-group-flush">
+        <%= render 'descendants' %>
+      </ul>
+    </div>
+  <% end %>
 <% end %>