geoblacklight 1.9.1 → 2.0.0

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

@@ -0,0 +1,60 @@
+// 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;
+
+  .card-header {
+    h2 {
+      display: inline-block;
+      padding-top: 8px;
+      padding-bottom: 8px;
+      margin-bottom: 0px;
+      font-size: 1rem;
+    }
+  }
+
+  .card-subtitle {
+    margin: 1rem 0 .2rem;
+    font-size: .9rem;
+    font-weight: normal;
+    color: $gray-600;
+  }
+
+  .list-group {
+    padding-top: 24px;
+    padding-bottom: 24px;
+    padding-left: 4px;
+    padding-right: 4px;
+
+    .list-group-item {
+      border-color: $white;
+      padding: 8px 16px;
+
+      a {
+        @extend %list-group-item-children;
+
+        .geoblacklight {
+          color: $gray-600;
+        }
+      }
+    }
+
+    &-nested {
+      padding: 0;
+
+      .list-group-item {
+        padding: 8px 0;
+      }
+    }
+  }
+}

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

@@ -1,46 +1,66 @@
 .show-tools {
-  a .geoblacklight {
-    color: $gray-light;
-  }
+  @include sidebar-children;
 
-  .geoblacklight-citation {
-    text-align: center;
-    width: 1.4em;
-  }
+  .list-group {
 
-  .geoblacklight-data-dictionary {
-    text-align: center;
-    width: 1.4em;
-  }
+    .list-group-item {
 
-  .geoblacklight-sms {
-    text-align: center;
-    width: 1.4em;
-  }
+      form {
+        @extend %list-group-item-children;
 
-  .geoblacklight-email {
-    text-align: center;
-    width: 1.4em;
-  }
+        .checkbox {
+          margin-left: 4px;
+          margin-right: 4px;
 
-  .geoblacklight-web_services {
-    text-align: center;
-    width: 1.4em;
-  }
+          label {
+            margin-bottom: inherit;
+          }
+        }
+      }
 
-  .geoblacklight-metadata {
-    text-align: center;
-    width: 1.4em;
-  }
+      a {
 
-  .geoblacklight-carto {
-    text-align: center;
-    width: 1.4em;
-  }
+        .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;
+          }
+        }
+      }
+    }
 
-  // DEPRECATED: Will be removed in GeoBlacklight v2.0
-  .geoblacklight-cartodb {
-    text-align: center;
-    width: 1.4em;
+    .downloads {
+      margin-left: 4px;
+      margin-right: 4px;
+    }
   }
 }

data/app/controllers/download_controller.rb

@@ -1,5 +1,6 @@
 class DownloadController < ApplicationController
-  include Blacklight::SearchHelper
+  # include Blacklight::SearchHelper
+  include Blacklight::Catalog
 
   rescue_from Geoblacklight::Exceptions::ExternalDownloadFailed do |exception|
     Geoblacklight.logger.error exception.message + ' ' + exception.url
@@ -18,7 +19,7 @@ class DownloadController < ApplicationController
   end
 
   def show
-    @response, @document = fetch params[:id]
+    @response, @document = search_service.fetch params[:id]
     restricted_should_authenticate
     response = check_type
     validate response
@@ -30,13 +31,13 @@ class DownloadController < ApplicationController
 
   def file
     # Grab the solr document to check if it should be public or not
-    @response, @document = fetch(file_name_to_id(params[:id]))
+    @response, @document = search_service.fetch(file_name_to_id(params[:id]))
     restricted_should_authenticate
     send_file download_file_path_and_name, x_sendfile: true
   end
 
   def hgl
-    @response, @document = fetch params[:id]
+    @response, @document = search_service.fetch params[:id]
     if params[:email]
       response = Geoblacklight::HglDownload.new(@document, params[:email]).get
       if response.nil?

data/app/controllers/relation_controller.rb

@@ -1,10 +1,20 @@
 class RelationController < ApplicationController
   include Blacklight::Configurable
-  include Blacklight::SearchHelper
+  # include Blacklight::SearchHelper
   copy_blacklight_config_from(CatalogController)
 
   def index
     @relations = Geoblacklight::Relation::RelationResponse.new(params[:id], repository)
     render layout: !request.xhr?
   end
+
+  private
+
+  def repository_class
+    blacklight_config.repository_class
+  end
+
+  def repository
+    @repository ||= repository_class.new(blacklight_config)
+  end
 end

data/app/helpers/carto_helper.rb

@@ -1,6 +1,6 @@
 module CartoHelper
   ##
-  # Creates a Carto OneClick link link, using the configuration link
+  # Creates a Carto OneClick link, using the configuration link
   # @param [String] file_link
   # @return [String]
   def carto_link(file_link)
@@ -24,13 +24,6 @@ module CartoHelper
   ##
   # Method used to access setting and provide deprecation warnings to migrate
   def carto_oneclick_host
-    if Settings.CARTODB_ONECLICK_LINK.present?
-      Deprecation.warn(
-        GeoblacklightHelper,
-        'Settings.CARTODB_ONECLICK_LINK is deprecated and will be removed in ' \
-        'Geoblacklight 2.0.0, use Settings.CARTO_ONECLICK_LINK instead'
-      )
-    end
-    Settings.CARTO_ONECLICK_LINK || Settings.CARTODB_ONECLICK_LINK
+    Settings.CARTO_ONECLICK_LINK
   end
 end

data/app/helpers/geoblacklight_helper.rb

@@ -1,15 +1,4 @@
 module GeoblacklightHelper
-  extend Deprecation
-  self.deprecation_horizon = 'Geoblacklight 2.0.0'
-
-  def sms_helper
-    content_tag(:i, '', class: 'fa fa-mobile fa-fw') + ' ' + t('blacklight.tools.sms')
-  end
-
-  def email_helper
-    content_tag(:i, '', class: 'fa fa-envelope fa-fw') + ' ' + t('blacklight.tools.email')
-  end
-
   def document_available?
     @document.public? || (@document.same_institution? && user_signed_in?)
   end
@@ -27,7 +16,7 @@ module GeoblacklightHelper
       text,
       document.direct_download[:download],
       'contentUrl' => document.direct_download[:download],
-      class: ['btn', 'btn-primary', 'btn-block', 'download', 'download-original'],
+      class: ['btn', 'btn-default', 'download', 'download-original'],
       data: {
         download: 'trigger',
         download_type: 'direct',
@@ -40,9 +29,9 @@ module GeoblacklightHelper
     link_to(
       text,
       download_hgl_path(id: document),
-      class: ['btn', 'btn-primary', 'btn-block', 'download', 'download-original'],
+      class: ['btn', 'btn-default', 'download', 'download-original'],
       data: {
-        ajax_modal: 'trigger',
+        blacklight_modal: 'trigger',
         download: 'trigger',
         download_type: 'harvard-hgl',
         download_id: document.id
@@ -57,7 +46,7 @@ module GeoblacklightHelper
       download_text('JPG'),
       iiif_jpg_url,
       'contentUrl' => iiif_jpg_url,
-      class: ['btn', 'btn-primary', 'btn-block', 'download', 'download-generated'],
+      class: ['btn', 'btn-default', 'download', 'download-generated'],
       data: {
         download: 'trigger'
       }
@@ -68,7 +57,7 @@ module GeoblacklightHelper
     link_to(
       t('geoblacklight.download.export_link', download_format: proper_case_format(download_type)),
       '',
-      class: ['btn', 'btn-primary', 'btn-block', 'download', 'download-generated'],
+      class: ['btn', 'btn-default', 'download', 'download-generated'],
       data: {
         download_path: download_path(document.id, type: download_type),
         download: 'trigger',
@@ -100,10 +89,6 @@ module GeoblacklightHelper
                 title: name
   end
 
-  def render_search_form_no_navbar
-    render partial: 'catalog/search_form_no_navbar'
-  end
-
   ##
   # Renders an unique array of search links based off of terms
   # passed in using the facet parameter
@@ -179,14 +164,6 @@ module GeoblacklightHelper
     blacklight_config.basemap_provider || 'positron'
   end
 
-  ##
-  # Removes blank space from provider to accomodate CartoDB OneClick
-  # @deprecated Use {#carto_provider} instead.
-  def cartodb_provider
-    carto_provider
-  end
-  deprecation_deprecate cartodb_provider: 'use GeoblacklightHelper#carto_provider instead'
-
   ##
   # Creates a Carto OneClick link link, using the configuration link
   # @param [String] file_link
@@ -252,4 +229,14 @@ module GeoblacklightHelper
   def first_metadata?(document, metadata)
     document.references.shown_metadata.first.type == metadata.type
   end
+
+  ##
+  # Renders a reference url for a document
+  # @param [Hash] document, field_name
+  def render_references_url(args)
+    link_to(
+      args[:document].references.url.endpoint,
+      args[:document].references.url.endpoint
+    ) if args[:document]&.references&.url
+  end
 end

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

@@ -51,6 +51,10 @@ module Geoblacklight
       references.data_dictionary.to_hash unless references.data_dictionary.blank?
     end
 
+    def external_url
+      references.url.endpoint if references.url
+    end
+
     def item_viewer
       ItemViewer.new(references)
     end

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

@@ -3,7 +3,7 @@ module Geoblacklight
     extend ActiveSupport::Concern
 
     included do
-      self.default_processor_chain += [:add_spatial_params]
+      self.default_processor_chain += [:add_spatial_params, :hide_suppressed_records]
     end
 
     ##
@@ -18,6 +18,12 @@ module Geoblacklight
         solr_params[:bq] << "#{Settings.FIELDS.GEOMETRY}:\"IsWithin(#{envelope_bounds})\"#{boost}"
         solr_params[:fq] ||= []
         solr_params[:fq] << "#{Settings.FIELDS.GEOMETRY}:\"Intersects(#{envelope_bounds})\""
+
+        if Settings.OVERLAP_RATIO_BOOST
+          solr_params[:overlap] =
+            "{!field uf=* defType=lucene f=solr_bboxtype score=overlapRatio}Intersects(#{envelope_bounds})"
+          solr_params[:bf] = "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
+        end
       end
       solr_params
     rescue Geoblacklight::Exceptions::WrongBoundingBoxFormat
@@ -43,5 +49,16 @@ module Geoblacklight
     def bounding_box
       Geoblacklight::BoundingBox.from_rectangle(blacklight_params[:bbox])
     end
+
+    ##
+    # Hide suppressed records in search
+    # @param [Blacklight::Solr::Request]
+    # @return [Blacklight::Solr::Request]
+    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?
+      solr_params[:fq] ||= []
+      solr_params[:fq] << '-suppressed_b: true'
+    end
   end
 end

data/app/presenters/geoblacklight/document_presenter.rb

@@ -10,8 +10,8 @@ module Geoblacklight
     # @return [String]
     def index_fields_display
       fields_values = []
-      @configuration.index_fields.each do |field_name, _|
-        val = field_value(field_name)
+      @configuration.index_fields.each do |_field_name, field_config|
+        val = field_value(field_config)
         unless val.blank?
           val += '.' unless val.end_with?('.')
           fields_values << val

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(({ajax_modal: "trigger"} if document_action_config.modal != false) || {}) do %>
+            data: {}.merge(({blacklight_modal: "trigger"} if document_action_config.modal != false) || {}) do %>
     <%= content_tag :span, '', class: "geoblacklight geoblacklight-#{document_action_config.key}" %>
     <%= document_action_label(document_action_config.key, document_action_config) %>
-<% end %>
+<% end %>

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

@@ -1,4 +1,6 @@
-<div id="documents" class="docView col-md-6">
-  <%= render documents, :as => :document %>
+<div class='row'>
+  <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 } %>
 </div>
-<%= content_tag :div, '', id: 'map', data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>

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

@@ -0,0 +1,39 @@
+<%# Renders the secondary downloads displayed in the split dropdown %>
+<% document ||= @document %>
+
+<button type='button' class='btn btn-default dropdown-toggle download-dropdown-toggle' data-toggle='dropdown' aria-expanded='false'>
+  <span class='caret'></span>
+  <span class='sr-only'>Toggle Download Dropdown</span>
+</button>
+<ul class='dropdown-menu' role='menu'>
+  <% if document.hgl_download.present? %>
+    <li role="presentation" class="dropdown-header">Original</li>
+    <li>
+      <%= link_to(download_text(document.download_types.first[0]),
+      download_hgl_path(id: document), data: {blacklight_modal: 'trigger', download: 'trigger', download_type: 'harvard-hgl', download_id: document.id }) %>
+    </li>
+  <% else %>
+    <% if document.direct_download.present? %>
+      <li role="presentation" class="dropdown-header">Original</li>
+      <li>
+        <%= link_to(download_text(@document.file_format), document.direct_download[:download], 'contentUrl' => document.direct_download[:download], data: { download: 'trigger', download_type: 'direct', download_id: document.id }) %>
+      </li>
+    <% end %>
+    <% if document.download_types.present? || document.iiif_download.present? %>
+      <li role="presentation" class="dropdown-header">Generated</li>
+    <% end %>
+    <% if document.iiif_download.present? %>
+      <li>
+        <%= link_to "Download JPG", iiif_jpg_url, download: 'trigger' %>
+      </li>
+    <% end %>
+
+    <% if document.download_types.present? %>
+      <% document.download_types.each do |type| %>
+        <%= content_tag(:li) do %>
+          <% link_to(download_text(type[0]), '', data: { download_path: "#{download_path(document.id, type: type[0])}", download: 'trigger', download_type: type[0], download_id: document.id }) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+</ul>