geoblacklight 2.2.0 → 3.0.1

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

@@ -7,6 +7,7 @@
 
   #viewer-container {
     [data-map="item"] {
+      border: 1px solid $gray-400;
       height: 27.5rem;
     }
 
@@ -23,4 +24,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,42 @@
 }
 
 .more-info-area {
-  float: left;
-  order:3;
   max-height: 100px;
   overflow:hidden;
+  padding-left: 2ch;
 }
 
-.text-span{
-  width:80%;
-  float:left;
+.documents-list {
+  @extend .mb-4;
 }
 
-.hide-overflow {
-  white-space: nowrap;
-  overflow: hidden;
-  text-overflow: ellipsis;
-  display:block
-}
+.index-split {
+  .index_title {
+    display: flex;
+    font-size: 1rem;
+    padding-right: 0;
+  }
 
-.status-icons {
-  order: 2;
-  margin-left: 0.5rem;
-}
+  .document-counter {
+    @extend .pr-1;
+  }
 
-.index_title {
-  order: 1;
-  @extend .text-span;
-  @extend .hide-overflow;
-  @extend h5;
-  font-size:1rem;
-  width:80%;
-}
+  .caret-toggle {
+    @include caret('right');
+    padding-left: 0;
+    width: 28px;
 
-.caret-toggle {
-  @extend .fa, .fa-caret-right;
-  cursor: pointer;
-  width: 10px;
+    &[aria-expanded="true"] {
+      @include caret('down');
+    }
+  }
 
-  &.open {
-    @extend .fa, .fa-caret-down;
+  .status-icons {
+    cursor: pointer;
+    margin-left: 0.5rem;
+    margin-top: -3px;
+    white-space: nowrap;
+    z-index: 2; // get the icons above the toggle
   }
 }
 

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

@@ -1,59 +1,29 @@
 // Mixins and shared properties for sidebar elements
-
 @mixin sidebar-children {
-  %list-group-item-children {
-    padding: 10px 15px;
-  }
-
-  %list-group-item-anchors {
-    text-align: center;
-    width: 1.4em;
-  }
-
-  margin-top: 16px;
-  margin-bottom: 16px;
+  margin-bottom: 20px;
+  margin-top: 20px;
 
-  .card-header {
-    h2 {
-      display: inline-block;
-      padding-top: 8px;
-      padding-bottom: 8px;
-      margin-bottom: 0px;
-      font-size: 1rem;
-    }
+  .card-header h2 {
+    @extend .h6;
+    margin-bottom: 0px;
   }
 
   .card-subtitle {
-    margin: 1rem 0 .2rem;
-    font-size: .9rem;
+    margin: 1rem 0 0;
+    font-size: 1rem;
     font-weight: normal;
-    color: $gray-600;
   }
 
   .list-group {
-    padding-top: 24px;
-    padding-bottom: 24px;
-    padding-left: 4px;
-    padding-right: 4px;
+     border: 0;
+     margin: 8px 0;
 
     .list-group-item {
-      border-color: $white;
-      padding: 8px 16px;
+      border: 0;
+      padding: 0 0 0 20px;
 
       a {
-        @extend %list-group-item-children;
-
-        .geoblacklight {
-          color: $gray-600;
-        }
-      }
-    }
-
-    &-nested {
-      padding: 0;
-
-      .list-group-item {
-        padding: 8px 0;
+        display: block;
       }
     }
   }

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

@@ -1,70 +1,28 @@
 .show-tools {
   @include sidebar-children;
 
-  .list-group {
-
-    .list-group-item.exports {
-      margin-top:0px;
-    }
-
-    .list-group-item {
-
-      form {
-        @extend %list-group-item-children;
-
-        .checkbox {
-          margin-left: 4px;
-          margin-right: 4px;
-
-          label {
-            margin-bottom: inherit;
-          }
-        }
+  .list-group .list-group-item {
+    // Adjustments to give Bookmark same spacing as other Tools links
+    .checkbox {
+      label {
+        margin-bottom: 0;
       }
 
-      a {
-
-        .geoblacklight {
-
-          &-citation {
-            @extend %list-group-item-anchors;
-          }
-
-          &-data-dictionary {
-            @extend %list-group-item-anchors;
-          }
-
-          &-sms {
-            @extend %list-group-item-anchors;
-          }
-
-          &-email {
-            @extend %list-group-item-anchors;
-          }
-
-          &-web_services {
-            @extend %list-group-item-anchors;
-          }
-
-          &-metadata {
-            @extend %list-group-item-anchors;
-          }
-
-          &-carto {
-            @extend %list-group-item-anchors;
-          }
-
-          // DEPRECATED: Will be removed in GeoBlacklight v2.0
-          &-cartodb {
-            @extend %list-group-item-anchors;
-          }
-        }
+      .toggle-bookmark {
+        margin-right: 4px;
+        padding-bottom: 8px;
+        padding-top: 8px;
       }
     }
 
-    .downloads {
-      margin-left: 4px;
-      margin-right: 4px;
+    // Spacing for Tools links other than Bookmark
+    a {
+      padding: 8px 1rem 8px 0;
     }
   }
+
+  // Spacing between Tools icons and their labels
+  .blacklight-icons {
+    padding-right: 2px;
+  }
 }

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,3 +1,4 @@
+# frozen_string_literal: true
 module GeoblacklightHelper
   def document_available?
     @document.public? || (@document.same_institution? && user_signed_in?)
@@ -11,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,
@@ -24,6 +39,7 @@ module GeoblacklightHelper
       }
     )
   end
+  deprecation_deprecate download_link_direct: 'Use download_link_file instead'
 
   def download_link_hgl(text, document)
     link_to(
@@ -84,54 +100,12 @@ 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'
-    if asset_exists?(icon_name)
-      queue_icon_aria_label(icon_name)
-      blacklight_icon(icon_name)
-    else
-      render_empty_span('icon-missing geoblacklight-none')
-    end
-  end
-
-  ##
-  # Checks if an asset file exists
-  # @return [Boolean]
-  def asset_exists?(path)
-    Rails.application.assets.resolve("blacklight/#{path}").present?
-  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
-
-  ##
-  # Render a div of divs describing aria-labelledby values
-  # @return [HTML tag]
-  def render_aria_labels(aria_labels)
-    return unless aria_labels
-    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
-
-  # 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}")
+    begin
+      blacklight_icon(icon_name, **args)
+    rescue Blacklight::Exceptions::IconNotFound
+      tag.span class: 'icon-missing geoblacklight-none'
     end
   end
 
@@ -198,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
@@ -221,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
@@ -233,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
@@ -288,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))
+       .add_previous_sibling(geoblacklight_icon(item.value, aria_hidden: true, classes: 'svg_tooltip'))
     doc.to_html.html_safe
   end
 
@@ -320,9 +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?
+    icon_options = {}
+    icon_options = { classes: 'svg_tooltip' } if Settings.USE_GEOM_FOR_RELATIONS_ICON
+    geoblacklight_icon(icon_name, icon_options)
   end
 end