geoblacklight 2.4.0 → 3.0.0

data/app/controllers/download_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class DownloadController < ApplicationController
   # include Blacklight::SearchHelper
   include Blacklight::Catalog
@@ -5,8 +6,7 @@ class DownloadController < ApplicationController
   rescue_from Geoblacklight::Exceptions::ExternalDownloadFailed do |exception|
     Geoblacklight.logger.error exception.message + ' ' + exception.url
     flash[:danger] = view_context
-                     .content_tag(:span,
-                                  flash_error_message(exception),
+                     .tag.span(flash_error_message(exception),
                                   data: {
                                     download: 'error',
                                     download_id: params[:id],
@@ -62,16 +62,16 @@ class DownloadController < ApplicationController
   # exception
   # @return [String] error message to display in flash
   def flash_error_message(exception)
-    if exception.url.present?
-      message = t('geoblacklight.download.error_with_url',
-                  link: view_context
-                        .link_to(exception.url,
-                                 exception.url,
-                                 target: 'blank'))
-                .html_safe
-    else
-      message = t('geoblacklight.download.error')
-    end
+    message = if exception.url.present?
+                t('geoblacklight.download.error_with_url',
+                            link: view_context
+                                  .link_to(exception.url,
+                                           exception.url,
+                                           target: 'blank'))
+                  .html_safe
+              else
+                t('geoblacklight.download.error')
+              end
     message
   end
 

data/app/controllers/relation_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class RelationController < ApplicationController
   include Blacklight::Configurable
   # include Blacklight::SearchHelper

data/app/controllers/wms_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class WmsController < ApplicationController
   def handle
     response = Geoblacklight::WmsLayer.new(wms_params).feature_info

data/app/helpers/arcgis_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ArcgisHelper
   ##
   # Generates an ArcGIS.com viewer url with params that can open content

data/app/helpers/blacklight_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BlacklightHelper
   include Blacklight::BlacklightHelperBehavior
   include Geoblacklight::GeoblacklightHelperBehavior

data/app/helpers/carto_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module CartoHelper
   ##
   # Creates a Carto OneClick link, using the configuration link

data/app/helpers/geoblacklight_helper.rb

@@ -1,6 +1,5 @@
+# frozen_string_literal: true
 module GeoblacklightHelper
-  extend Deprecation
-
   def document_available?
     @document.public? || (@document.same_institution? && user_signed_in?)
   end
@@ -13,6 +12,20 @@ module GeoblacklightHelper
     @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,
+      class: ['btn', 'btn-default', 'download', 'download-original'],
+      data: {
+        download: 'trigger',
+        download_type: 'direct',
+        download_id: id
+      }
+    )
+  end
+
   def download_link_direct(text, document)
     link_to(
       text,
@@ -26,6 +39,7 @@ module GeoblacklightHelper
       }
     )
   end
+  deprecation_deprecate download_link_direct: 'Use download_link_file instead'
 
   def download_link_hgl(text, document)
     link_to(
@@ -95,43 +109,6 @@ module GeoblacklightHelper
     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
   # passed in using the facet parameter
@@ -195,8 +172,8 @@ 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}")
-      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
+      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
@@ -218,7 +195,7 @@ module GeoblacklightHelper
   # get_field_values method
   # @param [Hash] args from get_field_values
   def render_value_as_truncate_abstract(args)
-    content_tag :div, class: 'truncate-abstract' do
+    tag.div class: 'truncate-abstract' do
       Array(args[:value]).flatten.join(' ')
     end
   end
@@ -230,33 +207,6 @@ 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
-  # @return [String]
-  # @deprecated Use {#carto_link} instead.
-  def cartodb_link(file_link)
-    carto_link(file_link)
-  end
-  deprecation_deprecate carto_link: 'use GeoblacklightHelper#carto_link instead'
-
   ##
   # Renders the partials for a Geoblacklight::Reference in the web services
   # modal
@@ -285,7 +235,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, aria_hidden: true))
+       .add_previous_sibling(geoblacklight_icon(item.value, aria_hidden: true, classes: 'svg_tooltip'))
     doc.to_html.html_safe
   end
 
@@ -317,16 +267,19 @@ module GeoblacklightHelper
   # Renders a reference url for a document
   # @param [Hash] document, field_name
   def render_references_url(args)
+    return unless args[:document]&.references&.url
     link_to(
       args[:document].references.url.endpoint,
       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)
+    icon_options = {}
+    icon_options = { classes: 'svg_tooltip' } if Settings.USE_GEOM_FOR_RELATIONS_ICON
+    geoblacklight_icon(icon_name, icon_options)
   end
 end

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
@@ -34,15 +35,15 @@ 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?
@@ -50,11 +51,11 @@ module Geoblacklight
     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
@@ -108,7 +109,7 @@ module Geoblacklight
     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

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

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/_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

@@ -40,4 +40,7 @@
       <%= 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,30 +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 %>
-  <h3 class="index_title col pl-2">
+<%= 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 %>
+  </h3>
+  <span class='status-icons'>
+    <%= render partial: 'header_icons', locals: { document: document } %>
+
     <button
-      class="caret-toggle btn pl-0 py-0 stretched-link"
+      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 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>
-  </h3>
+  </span>
+<% end %>
 
-  <div class='col-md-12 more-info-area'>
-    <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
-      <small>
-        <%= geoblacklight_present(:index_fields_display, document) %>
-      </small>
-    </div>
+<div class='more-info-area'>
+  <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
+    <small>
+      <%= geoblacklight_present(:index_fields_display, document) %>
+    </small>
   </div>
-<% end %>
+</div>