geoblacklight 4.0.0.pre.alpha.1 → 4.0.0.pre.rc1

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

@@ -5,3 +5,71 @@
     margin: 5px 0;
   }
 }
+
+#map[data-protocol="IndexMap"] {
+  .leaflet-interactive {
+    stroke: black;
+    fill-opacity: 0.65;
+  }
+}
+
+.index-map-legend {
+  font-size: 15px;
+  display: flex;
+  position: absolute;
+  right: 15px;
+  top: -2px;
+  left: 90px;
+
+  &-info {
+    display: flex;
+    flex-wrap: nowrap;
+    align-items: center;
+    margin-left: 15px;
+  }
+
+  span {
+    display: inline-block;
+    border: 1px solid black;
+    margin-right: 10px;
+    height: 24px;
+    width: 24px;
+    min-height: 24px;
+    min-width: 24px;
+  }
+
+  p {
+    margin-bottom: 0;
+  }
+
+  &-default {
+    background: #7FCDBB;
+  }
+  &-unavailable {
+    background: #EDF8B1;
+  }
+  &-selected {
+    background: #2C7FB8;
+  }
+  &-default, &-unavailable, &-selected {
+    opacity: 0.65;
+  }
+
+  @media(max-width: 768px){
+    position: revert;
+    margin-bottom: 1.25rem;
+
+    :first-child {
+      margin-left: 0;
+    }
+  }
+
+  @media(max-width: 480px){
+    display: block;
+
+    .index-map-legend-info {
+      margin-left: 0;
+      margin-bottom: 10px;
+    }
+  }
+}

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

@@ -9,6 +9,11 @@
     [data-map="item"] {
       border: 1px solid $gray-400;
       height: 27.5rem;
+
+      // Ensure oembed iframe is the same height as its container
+      iframe {
+        height: 27.5rem;
+      }
     }
 
     [data-inspect="true"][data-available="true"] {
@@ -19,6 +24,7 @@
         cursor: crosshair;
       }
     }
+    margin-bottom: 1rem;
   }
 
   .help-text {
@@ -36,4 +42,14 @@
     -webkit-box-orient: vertical;
     -webkit-line-clamp: 8;
   }
+
+  #table-container{
+    overflow:scroll;
+    max-height: 450px;
+    margin-bottom: 1rem;
+
+    table {
+      margin-bottom: 0px;
+    }
+  }
 }

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

@@ -12,3 +12,9 @@
   }
 
 }
+
+// Add some separation between web services entries
+.web-services-modal-body > div + div {
+  border-top: 1px solid #dee2e6;
+  padding-top: 1rem;
+}

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

@@ -28,3 +28,7 @@
     }
   }
 }
+
+.card.relations {
+  margin-bottom: 20px;
+}

data/app/components/geoblacklight/icon_facet_item_component.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # Display facet values with a decorative icon
+  # @example Usage in the blacklight configuration:
+  #   config.add_facet_field 'provider_facet', [...], item_component: Geoblacklight::IconFacetItemComponent
+  class IconFacetItemComponent < Blacklight::FacetItemComponent
+    delegate :safe_join, :geoblacklight_icon, to: :helpers
+
+    def initialize(facet_item:, **)
+      super
+
+      # store a copy of the original label value
+      @undecorated_label = @label
+    end
+
+    def before_render
+      # replace the original label with an icon-decorated version; this has to be done in
+      # #before_render or #render so we have access to the icon helpers.
+      @label = decorated_label
+
+      super
+    end
+
+    private
+
+    def decorated_label
+      icon = geoblacklight_icon(@facet_item.value, aria_hidden: true, classes: 'svg_tooltip')
+
+      safe_join([icon, @undecorated_label], ' ')
+    end
+  end
+end

data/app/helpers/geoblacklight_helper.rb

@@ -17,7 +17,6 @@ module GeoblacklightHelper
       label,
       url,
       'contentUrl' => url,
-      class: ['btn', 'btn-default', 'download', 'download-original'],
       data: {
         download: 'trigger',
         download_type: 'direct',
@@ -30,7 +29,6 @@ module GeoblacklightHelper
     link_to(
       text,
       download_hgl_path(id: document),
-      class: ['btn', 'btn-default', 'download', 'download-original'],
       data: {
         blacklight_modal: 'trigger',
         download: 'trigger',
@@ -47,7 +45,6 @@ module GeoblacklightHelper
       download_text('JPG'),
       iiif_jpg_url,
       'contentUrl' => iiif_jpg_url,
-      class: ['btn', 'btn-default', 'download', 'download-generated'],
       data: {
         download: 'trigger'
       }
@@ -56,9 +53,8 @@ module GeoblacklightHelper
 
   def download_link_generated(download_type, document)
     link_to(
-      t('geoblacklight.download.export_link', download_format: proper_case_format(download_type)),
+      t('geoblacklight.download.export_link', download_format: export_format_label(download_type)),
       '',
-      class: ['btn', 'btn-default', 'download', 'download-generated'],
       data: {
         download_path: download_path(document.id, type: download_type),
         download: 'trigger',
@@ -88,16 +84,6 @@ module GeoblacklightHelper
     end
   end
 
-  ##
-  # Renders an unique array of search links based off of terms
-  # passed in using the facet parameter
-  #
-  def render_facet_links(facet, items)
-    items.uniq.map do |item|
-      link_to item, search_catalog_path(f: { facet => [item] })
-    end.join(', ').html_safe
-  end
-
   ##
   # Looks up properly formatted names for formats
   #
@@ -105,6 +91,11 @@ module GeoblacklightHelper
     t("geoblacklight.formats.#{format.to_s.parameterize(separator: '_')}")
   end
 
+  # Format labels are customized for exports - look up the appropriate key.
+  def export_format_label(format)
+    t("geoblacklight.download.export_#{format.to_s.parameterize(separator: '_')}_link")
+  end
+
   ##
   # Looks up formatted names for references
   # @param (String, Symbol) reference
@@ -122,22 +113,6 @@ module GeoblacklightHelper
     value.html_safe
   end
 
-  def download_generated_body(format)
-    value = proper_case_format(format)
-    value = case value
-            when t('geoblacklight.formats.shapefile')
-              t('geoblacklight.download.export_shapefile_link')
-            when t('geoblacklight.formats.kmz')
-              t('geoblacklight.download.export_kmz_link')
-            when t('geoblacklight.formats.geojson')
-              t('geoblacklight.download.export_geojson_link')
-            else
-              value
-            end
-
-    value.html_safe
-  end
-
   ##
   # Deteremines if a feature should include help text popover
   # @return [Boolean]
@@ -206,18 +181,6 @@ module GeoblacklightHelper
     Settings.LEAFLET
   end
 
-  ##
-  # Renders a facet item with an icon placed as the first child of
-  # `.facet-label`. This works with `render_facet_value` and
-  # `render_selected_facet_value`
-  # @return String
-  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, classes: 'svg_tooltip'))
-    doc.to_html.html_safe
-  end
-
   ##
   # Renders the transformed metadata
   # (Renders a partial when the metadata isn't available)
@@ -267,8 +230,6 @@ module GeoblacklightHelper
     case controller_name
     when 'bookmarks'
       'bookmarks'
-    when 'catalog'
-      'index'
     else
       'index'
     end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class BboxFilterField < Blacklight::SearchState::FilterField
+    # @param [String,#value] a filter item to add to the url
+    # @return [Blacklight::SearchState] new state
+    def add(item)
+      new_state = search_state.reset_search
+      params = new_state.params
+      value = as_url_parameter(item)
+
+      params[:bbox] = value.to_param
+
+      new_state.reset(params)
+    end
+
+    # @param [String,#value] a filter to remove from the url
+    # @return [Blacklight::SearchState] new state
+    def remove(_item)
+      new_state = search_state.reset_search
+      params = new_state.params
+
+      params.delete(:bbox)
+      new_state.reset(params)
+    end
+
+    # @return [Array] an array of applied filters
+    def values
+      params = search_state.params
+      return super unless params[:bbox]
+
+      bbox = Geoblacklight::BoundingBox.from_rectangle(params[:bbox])
+
+      super + [bbox]
+    rescue Geoblacklight::Exceptions::WrongBoundingBoxFormat => e
+      Rails.logger.warn(e)
+
+      super
+    end
+
+    # @param [String,#value] a filter to remove from the url
+    # @return [Boolean] whether the provided filter is currently applied/selected
+    delegate :include?, to: :values
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class BboxFilterQuery
+    def self.call(_search_builder, filter, solr_params)
+      bbox_filter_query = Geoblacklight::BboxFilterQuery.new(filter, solr_params)
+
+      [bbox_filter_query.intersects_filter, bbox_filter_query.relevancy_boost]
+    end
+
+    def initialize(filter, solr_params)
+      @filter = filter
+      @solr_params = solr_params
+    end
+
+    def intersects_filter
+      "#{@filter.key}:\"Intersects(#{envelope_bounds})\""
+    end
+
+    def relevancy_boost
+      boosted_params = @solr_params.slice(:bq, :bf)
+
+      boosted_params[:bq] ||= []
+      boosted_params[:bq] << "#{@filter.key}:\"IsWithin(#{envelope_bounds})\"#{boost}"
+
+      if field_config.overlap_boost
+        boosted_params[:bf] ||= []
+        boosted_params[:overlap] =
+          "{!field uf=* defType=lucene f=#{field_config.overlap_field} score=overlapRatio}Intersects(#{envelope_bounds})"
+        boosted_params[:bf] << "$overlap^#{field_config.overlap_boost}"
+      end
+
+      boosted_params
+    end
+
+    def envelope_bounds
+      @filter.values.first.to_envelope
+    end
+
+    def boost
+      "^#{field_config.within_boost || '10'}"
+    end
+
+    private
+
+    def field_config
+      @filter.config
+    end
+  end
+end

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

@@ -72,7 +72,7 @@ module Geoblacklight
     end
 
     def geom_field
-      fetch(Settings.FIELDS.SPATIAL_EXTENT, '')
+      fetch(Settings.FIELDS.GEOMETRY, '')
     end
 
     def geometry

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Geoblacklight
+  module SuppressedRecordsSearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += [:hide_suppressed_records]
+    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?
+
+      # Do not suppress action_documents method calls for individual documents
+      # ex. CatalogController#web_services (exportable views)
+      return if solr_params[:q]&.include?("{!lucene}#{Settings.FIELDS.ID}:")
+
+      solr_params[:fq] ||= []
+      solr_params[:fq] << "-#{Settings.FIELDS.SUPPRESSED}: true"
+    end
+  end
+end

data/app/presenters/geoblacklight/bbox_item_presenter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class BboxItemPresenter < Blacklight::FacetItemPresenter
+    def label
+      super.to_param
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+<%# Renders the options of the downloads dropdown button %>
+<% document ||= @document %>
+
+<% if document.direct_download.present? %>
+  <% if document.direct_download[:download].is_a? Array %>
+    <% document.direct_download[:download].each do |download| %>
+      <%= download_link_file(download['label'], document.id, download['url']) %>
+    <% end %>
+  <% end %>
+  <% if document.direct_download[:download].is_a? String %>
+    <%= download_link_file(download_text(document.file_format), document.id, document.direct_download[:download]) %>
+  <% end %>
+<% end %>
+
+<% if document.hgl_download.present? %>
+  <%= download_link_hgl(download_text(document.download_types.first[0]), document) %>
+<% end %>
+
+<% if document.iiif_download.present? %>
+  <%= download_link_iiif %>
+<% end %>
+
+<% if document.download_types.present? %>
+  <% document.download_types.each do |type| %>
+    <%= download_link_generated(type.first, document) %>
+  <% end %>
+<% end %>

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

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

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

@@ -5,7 +5,7 @@
     <span class="document-counter">
       <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
     </span>
-    <%= link_to_document document, counter: counter %>
+    <%= link_to_document document, counter: counter, itemprop: "name" %>
   </h3>
   <span class='status-icons'>
     <%= render partial: 'header_icons', locals: { document: document } %>
@@ -23,7 +23,7 @@
 
 <div class='more-info-area'>
   <div id="doc-<%= document.id %>-fields-collapse" class='collapse'>
-    <small>
+    <small itemprop="description">
       <%= geoblacklight_present(:index_fields_display, document) %>
     </small>
   </div>

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

@@ -6,6 +6,23 @@
       <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
     <% end %>
 
+    <% if document.item_viewer.index_map %>
+      <div class="index-map-legend">
+        <div class="index-map-legend-info">
+          <span class="index-map-legend-default"></span>
+          <p><span class="sr-only">Green tile indicates </span>Map held by collection</p>
+        </div>
+        <div class="index-map-legend-info">
+          <span class="index-map-legend-unavailable"></span>
+          <p><span class="sr-only">Yellow tile indicates </span>Map not held by collection</p>
+        </div>
+        <div class="index-map-legend-info">
+          <span class="index-map-legend-selected"></span>
+          <p><span class="sr-only">Blue tile indicates </span>Selected map tile</p>
+        </div>
+      </div>
+    <% end %>
+
     <%= 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-geom' => document.geometry.geojson, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
     <% end %>
   </div>

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

@@ -1,28 +1,17 @@
 <% document ||= @document %>
 
 <% if document_downloadable? %>
-  <% if document.direct_download.present? || document.hgl_download.present? || document.iiif_download.present? %>
-    <div class="card downloads">
-      <div class="card-header">
-        <h2><%= t('geoblacklight.download.download').pluralize %></h2>
+  <% if document.direct_download.present? || document.hgl_download.present? || document.iiif_download.present? || document.download_types.present? %>
+    <div class="downloads-sidebar">
+      <%# the dropdown-toggle class gives us the little arrow %>
+      <button type="button" class="btn btn-primary dropdown-toggle sidebar-btn" id="downloads-button" data-toggle="collapse" data-target="#downloads-collapse" aria-expanded="false" aria-controls="downloads-collapse">
+        Download
+      </button>
+      <div class="collapse" id="downloads-collapse">
+        <div class="card card-body">
+          <%= render 'downloads_collapse' %>
+        </div>
       </div>
-
-      <ul class="list-group list-group-flush js-download-list">
-        <%= render 'downloads_primary' %>
-      </ul>
-    </div>
-  <% end %>
-
-  <% if document.download_types.present? %>
-    <div class="card exports">
-      <div class="card-header">
-
-        <h2><%= t('geoblacklight.download.export_formats') %></h2>
-      </div>
-
-      <ul class="list-group list-group-flush">
-        <%= render 'downloads_generated' %>
-      </ul>
     </div>
   <% end %>
 <% elsif document.restricted? && document.same_institution? %>

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

@@ -1,6 +1,9 @@
 <%= render :partial => 'show_tools' %>
 
+<div class="sidebar-buttons">
+<%= render :partial => "show_web_services" %>
 <%= render :partial => "show_downloads" %>
+</div>
 
 <% unless @document.more_like_this.empty? %>
   <div class="card">

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

@@ -0,0 +1,11 @@
+<% document ||= @document %>
+
+<% if (Settings.WEBSERVICES_SHOWN & document.references.refs.map(&:type).map(&:to_s)).any? %>
+  <div class="web-services-sidebar">
+    <%= link_to "Web services",
+      web_services_solr_document_path(id: document.id),
+      class: ['btn', 'btn-primary', 'sidebar-btn'],
+      id: "web-services-button",
+      data: {blacklight_modal: "trigger"} %>
+  </div>
+<% end %>

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

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

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

@@ -4,7 +4,7 @@
     <span aria-hidden="true">&times;</span>
   </button>
 </div>
-<div class="modal-body">
+<div class="modal-body web-services-modal-body">
   <%= render partial: 'web_services' %>
 </div>
 <div class="modal-footer">

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

@@ -8,7 +8,7 @@
 <% end %>
 <% unless (@relations.send(rel)['numFound'].to_i <= 3) %>
   <li class="list-group-item border-bottom-0">
-    <%= link_to search_catalog_path({f: {"#{Settings.FIELDS.SOURCE}" => [@relations.link_id]}}) do %>
+    <%= link_to search_catalog_path({f: {"#{Settings.RELATIONSHIPS_SHOWN.send(rel).field}" => [@relations.link_id]}}) do %>
       <%= t('geoblacklight.relations.browse_all', count: @relations.send(rel)['numFound']) %>
     <% end %>
   </li>

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

@@ -1,6 +1,6 @@
 <%- Settings.RELATIONSHIPS_SHOWN.each do |rel, value| %>
   <% unless @relations.send(rel)['numFound'].to_i.zero? %>
-    <div class="card relations">
+    <div class="card relations relationship-<%= rel.downcase %>">
       <div class="card-header">
         <h2 class="mb-0 h6"><%= t("#{value.label}") %></h2>
       </div>

data/config/locales/geoblacklight.en.yml

@@ -16,7 +16,7 @@ en:
       error: 'Sorry, the requested file could not be downloaded'
       error_with_url: 'Sorry, the requested file could not be downloaded. Try downloading it directly from: %{link}'
       export_formats: 'Export Formats'
-      export_link: 'Export'
+      export_link: 'Export %{download_format}'
       export_shapefile_link: 'Shapefile'
       export_kmz_link: 'KMZ'
       export_geojson_link: 'GeoJSON'
@@ -65,6 +65,9 @@ en:
       services: 'Web services'
       services_close: 'Close'
       tms: 'Tile Map Service'
+      tilejson: 'TileJSON Document'
+      xyz: 'XYZ Tiles'
+      wmts: 'Web Map Tile Service'
     relations:
       ancestor: 'Source Datasets'
       descendant: 'Derived Datasets'

data/geoblacklight.gemspec

@@ -20,10 +20,9 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = '>= 2.5.2'
 
   spec.add_dependency 'rails', '>= 5.2.4', '< 6.2'
-  spec.add_dependency 'blacklight', '~> 7.8'
+  spec.add_dependency 'blacklight', '~> 7.12'
   spec.add_dependency 'config'
-  spec.add_dependency 'faraday', '~> 1.0'
-  spec.add_dependency 'faraday_middleware', '~> 1.0.0.rc1'
+  spec.add_dependency 'faraday', '>= 1.0'
   spec.add_dependency 'coderay'
   spec.add_dependency 'deprecation'
   spec.add_dependency 'geo_combine', '~> 0.4'
@@ -41,7 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'foreman'
-  spec.add_development_dependency 'rubocop', '~> 1.10'
-  spec.add_development_dependency 'rubocop-rails', '~> 2.9'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.13'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.8'
+  spec.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/generators/geoblacklight/install_generator.rb

@@ -62,7 +62,7 @@ module Geoblacklight
 
     def add_spatial_search_behavior
       inject_into_file 'app/models/search_builder.rb', after: 'include Blacklight::Solr::SearchBuilderBehavior' do
-        "\n  include Geoblacklight::SpatialSearchBehavior"
+        "\n  include Geoblacklight::SuppressedRecordsSearchBehavior"
       end
     end