geoblacklight 4.5.1 → 4.7.0

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

@@ -6,6 +6,13 @@ module Geoblacklight
       include ActionView::Helpers::OutputSafetyHelper
 
       def geoblacklight_citation(solr_document_url)
+        if Array(self[Settings.FIELDS.PUBLISHER]).size > 1
+          Geoblacklight.deprecation.warn(
+            "Geoblacklight::SolrDocument::Citation#geoblacklight_citation includes every value of " \
+            "#{Settings.FIELDS.PUBLISHER}; GeoBlacklight 5 reads the publisher as a single value and keeps " \
+            "only the first, so citations for this document will lose its other publishers"
+          )
+        end
         [
           fetch(Settings.FIELDS.CREATOR, nil),
           ("(#{issued})" if issued),

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

@@ -10,7 +10,7 @@ module Geoblacklight
       # @return [Boolean]
       def inspectable?
         %w[wms feature_layer dynamic_map_layer tiled_map_layer]
-          .include? viewer_protocol
+          .include? Geoblacklight.deprecation.silence { viewer_protocol }
       end
     end
   end

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

@@ -24,6 +24,13 @@ module Geoblacklight
     end
 
     def restricted?
+      if key?(Settings.FIELDS.ACCESS_RIGHTS) && self[Settings.FIELDS.ACCESS_RIGHTS].blank?
+        Geoblacklight.deprecation.warn(
+          "Geoblacklight::SolrDocument#restricted? returns true for a document whose " \
+          "#{Settings.FIELDS.ACCESS_RIGHTS} is present but blank; GeoBlacklight 5 returns false for the " \
+          "same document, because it tests the value for nil rather than for blankness"
+        )
+      end
       rights_field_data.blank? || rights_field_data.casecmp("restricted").zero?
     end
 
@@ -43,9 +50,14 @@ module Geoblacklight
       fetch(Settings.FIELDS.DISPLAY_NOTE, "")
     end
 
+    # @deprecated
     def hgl_download
-      references.hgl.to_hash if references.hgl.present?
+      Geoblacklight.deprecation.silence do
+        references.hgl.to_hash if references.hgl.present?
+      end
     end
+    Geoblacklight.deprecation.deprecate_methods(Geoblacklight::SolrDocument,
+      hgl_download: "the Harvard Geospatial Library download integration is removed without replacement in GeoBlacklight 5")
 
     def oembed
       references.oembed.endpoint if references.oembed.present?
@@ -76,14 +88,16 @@ module Geoblacklight
     end
 
     def geom_field
+      warn_about_blank_default(Settings.FIELDS.GEOMETRY, "geom_field")
       fetch(Settings.FIELDS.GEOMETRY, "")
     end
 
     def geometry
-      @geometry ||= Geoblacklight::Geometry.new(geom_field)
+      @geometry ||= Geoblacklight::Geometry.new(Geoblacklight.deprecation.silence { geom_field })
     end
 
     def wxs_identifier
+      warn_about_blank_default(Settings.FIELDS.WXS_IDENTIFIER, "wxs_identifier")
       fetch(Settings.FIELDS.WXS_IDENTIFIER, "")
     end
 
@@ -103,6 +117,20 @@ module Geoblacklight
 
     private
 
+    ##
+    # In GeoBlacklight 5 these readers are Blacklight `attribute` declarations, which
+    # return nil rather than "" when the Solr field is missing.
+    # @param field [String] the Solr field backing the reader
+    # @param reader [String] the name of the reader, for the warning
+    def warn_about_blank_default(field, reader)
+      return if key?(field)
+
+      Geoblacklight.deprecation.warn(
+        "Geoblacklight::SolrDocument##{reader} returns \"\" for a document with no #{field}; " \
+        "GeoBlacklight 5 returns nil instead, so calls like ##{reader}.empty? or ##{reader}.split will raise"
+      )
+    end
+
     def rights_field_data
       fetch(Settings.FIELDS.ACCESS_RIGHTS, "")
     end

data/app/presenters/geoblacklight/document_presenter.rb

@@ -3,13 +3,20 @@
 module Geoblacklight
   ##
   # Adds custom functionality for Geoblacklight document presentation
+  #
+  # @deprecated This class is removed in GeoBlacklight 5. Applications that set
+  #   `config.index.document_presenter_class = Geoblacklight::DocumentPresenter`
+  #   in their CatalogController must drop that line, because the constant no
+  #   longer exists.
   class DocumentPresenter < Blacklight::IndexPresenter
     include ActionView::Helpers::OutputSafetyHelper
+
     ##
     # Presents configured index fields in search results. Passes values through
     # configured helper_method. Multivalued fields separated by presenter
     # field_value_separator (default: comma). Fields separated by period.
     # @return [String]
+    # @deprecated
     def index_fields_display
       fields_values = []
       @configuration.index_fields.each do |_field_name, field_config|
@@ -21,5 +28,7 @@ module Geoblacklight
       end
       safe_join(fields_values, " ")
     end
+    Geoblacklight.deprecation.deprecate_methods(Geoblacklight::DocumentPresenter,
+      index_fields_display: "use Geoblacklight::SearchResultComponent instead")
   end
 end

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

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

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

@@ -1,4 +1,4 @@
 <% document ||= @document %>
-<%= link_to carto_link(document.carto_reference), target: '_blank' do %>
+<%= link_to Geoblacklight.deprecation.silence { 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_collapse.html.erb

@@ -1,3 +1,5 @@
+<%# This template is removed in GeoBlacklight 5. The deprecated download helpers it calls are silenced here so that a stock application is not warned once per request; Geoblacklight::DeprecatedConfiguration warns at boot if an application overrides it. %>
+<% Geoblacklight.deprecation.silence do %>
 <%# Renders the options of the downloads dropdown button %>
 <% document ||= @document %>
 
@@ -25,3 +27,4 @@
     <%= download_link_generated(type.first, document) %>
   <% end %>
 <% end %>
+<% end %>

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

@@ -24,7 +24,7 @@
 <div class='more-info-area'>
   <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
     <small itemprop="description">
-      <%= geoblacklight_present(:index_fields_display, document) %>
+      <%= Geoblacklight.deprecation.silence { geoblacklight_present(:index_fields_display, document) } %>
     </small>
   </div>
 </div>

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

@@ -1,4 +1,4 @@
-<% if show_attribute_table? %>
+<% if Geoblacklight.deprecation.silence { show_attribute_table? } %>
   <div class='row'>
     <div id='table-container' class='col-md-12'>
       <table id="attribute-table" class="table table-hover table-condensed table-striped table-bordered col-md-12">

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

@@ -2,8 +2,8 @@
 <div class='row'>
   <div id='viewer-container' class="col-md-12">
 
-    <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
-      <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
+    <% if Geoblacklight.deprecation.silence { show_help_text?('viewer_protocol', document.viewer_protocol) } %>
+      <%= Geoblacklight.deprecation.silence { render_help_text_entry('viewer_protocol', document.viewer_protocol) } %>
     <% end %>
 
     <% if document.item_viewer.index_map %>
@@ -23,6 +23,6 @@
       </div>
     <% end %>
 
-    <%= viewer_container %>
+    <%= Geoblacklight.deprecation.silence { viewer_container } %>
   </div>
 </div>

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

@@ -1,3 +1,5 @@
+<%# This template is removed in GeoBlacklight 5. The deprecated download helpers it calls are silenced here so that a stock application is not warned once per request; Geoblacklight::DeprecatedConfiguration warns at boot if an application overrides it. %>
+<% Geoblacklight.deprecation.silence do %>
 <% document ||= @document %>
 
 <% if document_downloadable? %>
@@ -21,3 +23,4 @@
     </div>
   </div>
 <% end %>
+<% end %>

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

@@ -1,4 +1,4 @@
-<%= render :partial => 'show_sidebar_static_map' if render_sidebar_map?(@document) %>
+<%= render :partial => 'show_sidebar_static_map' if Geoblacklight.deprecation.silence { render_sidebar_map?(@document) } %>
 <%= render :partial => 'show_tools' %>
 
 <div class="sidebar-buttons">

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

@@ -1,3 +1,5 @@
+<%# Rendered by GeoBlacklight itself, so the deprecated helpers and accessors it calls are silenced here; Geoblacklight::DeprecatedConfiguration warns at boot if an application overrides it. %>
+<% Geoblacklight.deprecation.silence do %>
 <div class="card">
   <div class="card-header">
     <%= I18n.t('geoblacklight.location') %>
@@ -8,3 +10,4 @@
     <% end %>
   </div>
 </div>
+<% end %>

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

@@ -3,7 +3,7 @@
 <% document.references.refs.each do |reference| %>
   <% if Settings.WEBSERVICES_SHOWN.include? reference.type.to_s %>
     <div class="web-services-modal-entry">
-      <%= render_web_services(reference) %>
+      <%= Geoblacklight.deprecation.silence { render_web_services(reference) } %>
     </div>
   <% end %>
 <% end %>

data/geoblacklight.gemspec

@@ -35,11 +35,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "engine_cart", "~> 2.0"
   spec.add_development_dependency "capybara", ">= 2.5.0"
-  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "selenium-webdriver", ">= 4.11"
   spec.add_development_dependency "factory_bot_rails"
   spec.add_development_dependency "database_cleaner", "~> 2.0"
   spec.add_development_dependency "simplecov", "~> 0.22"
   spec.add_development_dependency "foreman"
-  spec.add_development_dependency "standardrb", "1.0.1"
+  spec.add_development_dependency "standard", "~> 1.56.0"
   spec.add_development_dependency "webmock", "~> 3.14"
 end

data/lib/generators/geoblacklight/install_generator.rb

@@ -124,7 +124,7 @@ module Geoblacklight
       if propshaft_present
         gsub_file "Gemfile", /^(\s*gem\s+["']propshaft["'].*)$/, '# \1'
       end
-      unless gemfile.match?(/gem ['\"]sprockets-rails['\"]/)
+      unless gemfile.match?(/gem ['"]sprockets-rails['"]/)
         append_to_file "Gemfile" do
           "\ngem 'sprockets-rails'\n"
         end

data/lib/generators/geoblacklight/templates/catalog_controller.rb

@@ -317,12 +317,11 @@ class CatalogController < ApplicationController
     # 'positron'
     # 'darkMatter'
     # 'positronLite'
-    # 'worldAntique'
-    # 'worldEco'
-    # 'flatBlue'
-    # 'midnightCommander'
     # 'openstreetmapHot'
     # 'openstreetmapStandard'
+    #
+    # To change one of these basemaps' tile URLs, or to add a basemap of your
+    # own and name it here, set LEAFLET.BASEMAPS in settings.yml
 
     config.basemap_provider = "positron"
 

data/lib/generators/geoblacklight/templates/settings.yml

@@ -229,6 +229,25 @@ WMS_PARAMS:
 # Settings for leaflet
 LEAFLET:
   MAP:
+  # Basemap definitions, keyed by the name config.basemap_provider selects.
+  # Anything set here is merged over the basemap GeoBlacklight ships with, so
+  # you can change just the url and keep the rest of the definition.
+  #
+  # CARTO now watermarks raster tiles requested without an API key, which
+  # affects the positron, positronLite and darkMatter basemaps. Request a free
+  # key at https://carto.com/basemaps/apikey/ and pass it as a key parameter:
+  # BASEMAPS:
+  #   positron:
+  #     url: 'https://basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png?key=YOUR_KEY'
+  #   darkMatter:
+  #     url: 'https://basemaps.cartocdn.com/dark_all/{z}/{x}/{y}.png?key=YOUR_KEY'
+  #
+  # You can also define a basemap of your own here and select it with
+  # config.basemap_provider = 'myBasemap' in your CatalogController:
+  #   myBasemap:
+  #     url: 'https://tiles.example.edu/{z}/{x}/{y}.png'
+  #     attribution: 'Tiles courtesy of Example University'
+  #     maxZoom: 18
   LAYERS:
     DETECT_RETINA: true
     INDEX: