geoblacklight 4.0.0.pre.alpha.3 → 4.0.0.pre.rc3

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class BboxFilterField < Blacklight::SearchState::FilterField
+    # this accessor is unnecessary after Blacklight 7.25.0
+    attr_accessor :filters_key
+
+    def initialize(*args)
+      super
+      @filters_key = :bbox
+    end
+
+    # @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[filters_key] = 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(filters_key)
+      new_state.reset(params)
+    end
+
+    # @return [Array] an array of applied filters
+    def values(except: [])
+      params = search_state.params
+      return [] if except.include?(:filters) || params[filters_key].blank?
+
+      [Geoblacklight::BoundingBox.from_rectangle(params[filters_key])]
+    rescue Geoblacklight::Exceptions::WrongBoundingBoxFormat => e
+      Rails.logger.warn(e)
+
+      []
+    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
+
+    # @since Blacklight v7.25.0
+    # normal filter fields demangle when they encounter a hash, which they assume to be a number-indexed map
+    def needs_normalization?(value_params)
+      value_params.is_a?(Hash) && value_params.keys.map(&:to_s).all? { |k| k =~ /^\d+$/ }
+    end
+
+    # @since Blacklight v7.25.0
+    # value should be the first value from a mangled hash,
+    # otherwise return the value as-is
+    def normalize(value_params)
+      needs_normalization?(value_params) ? value_params.values : value_params
+    end
+  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,31 @@
+# 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 suppressed records when searching relationships
+      return if blacklight_params.fetch(:f,
+                                        {}).keys.any? do |field|
+                  Settings.RELATIONSHIPS_SHOWN.map do |_key, value|
+                    value.field
+                  end.include?(field)
+                end
+
+      # 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/shared/_header_navbar.html.erb

@@ -10,11 +10,16 @@
     </div>
   </div>
 </nav>
-
+<%- renderable_fields = blacklight_config.search_fields.values.collect { |field_def| [label_for_search_field(field_def.key), field_def.key] if should_render_field?(field_def)}.compact %>
 <% if controller_name == 'catalog' && (has_search_parameters? || params[:action] == 'show') %>
   <div class="navbar-search navbar navbar-light bg-faded" role="navigation">
     <div class="<%= container_classes %> stuff">
-      <%= render_search_bar  %>
+      <%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component ||Blacklight::SearchBarComponent).new(
+          url: search_action_url,
+          advanced_search_url: search_action_url(action: 'advanced_search'),
+          search_fields: renderable_fields,
+          params: search_state.params_for_search.except(:qt),
+          autocomplete_path: search_action_path(action: :suggest)))  %>
     </div>
   </div>
 <% else %>
@@ -28,7 +33,12 @@
     <div class='row justify-content-md-center'>
       <div class='col-md-6 col-sm-12'>
         <div class='navbar-search'>
-          <%= render_search_bar %>
+          <%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component ||Blacklight::SearchBarComponent).new(
+          url: search_action_url,
+          advanced_search_url: search_action_url(action: 'advanced_search'),
+          search_fields: renderable_fields,
+          params: search_state.params_for_search.except(:qt),
+          autocomplete_path: search_action_path(action: :suggest))) %>
         </div>
       </div>
     </div>

data/config/locales/geoblacklight.en.yml

@@ -16,10 +16,11 @@ 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'
+      export_geotiff_link: 'GeoTIFF'
     home:
       headline: 'Explore and discover...'
       search_heading: 'Find the maps and data you need'
@@ -65,11 +66,15 @@ 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'
       member_of: 'Belongs to collection...'
       part_of: 'Is part of...'
+      part_of_descendants: 'Has part...'
       relation: 'Related Records'
       replaces: 'Item replaces...'
       replaced_by: 'Item replaced by...'

data/geoblacklight.gemspec

@@ -19,11 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   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 'rails', '>= 6.1', '< 7.1'
+  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/assets_generator.rb

@@ -17,7 +17,7 @@ module Geoblacklight
     def add_javascript
       copy_file 'assets/geoblacklight.js', 'app/assets/javascripts/geoblacklight.js'
 
-      if Rails.version.to_i == 6
+      if Rails.version.to_i >= 6
         append_to_file 'app/assets/javascripts/application.js',
                        "\n// Required by GeoBlacklight\n//= require geoblacklight"
       end

data/lib/generators/geoblacklight/install_generator.rb

@@ -7,6 +7,23 @@ module Geoblacklight
 
     desc 'Install Geoblacklight'
 
+    def allow_geoblacklight_params
+      gbl_params = <<-"PARAMS"
+        before_action :allow_geoblacklight_params
+
+        def allow_geoblacklight_params
+          # Blacklight::Parameters will pass these to params.permit
+          blacklight_config.search_state_fields.append(Settings.GBL_PARAMS)
+        end
+      PARAMS
+
+      inject_into_file 'app/controllers/application_controller.rb', gbl_params, before: /^end/
+    end
+
+    def raise_unpermitted_params
+      inject_into_file 'config/environments/test.rb', "config.action_controller.action_on_unpermitted_parameters = :raise\n", before: /^end/
+    end
+
     def mount_geoblacklight_engine
       inject_into_file 'config/routes.rb', "mount Geoblacklight::Engine => 'geoblacklight'\n", before: /^end/
     end
@@ -62,7 +79,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
 

data/lib/generators/geoblacklight/templates/assets/_customizations.scss

@@ -13,16 +13,17 @@ $logo-image: image_url('blacklight/logo.svg') !default;
 // Override default Bootstrap variables here
 
 // Example: Bootstrap Colors
-$blue:    #007bff !default;
+$blue:    #0d6efd !default;
 $indigo:  #6610f2 !default;
 $purple:  #6f42c1 !default;
-$pink:    #e83e8c !default;
+$pink:    #d63384 !default;
 $red:     #dc3545 !default;
 $orange:  #fd7e14 !default;
 $yellow:  #ffc107 !default;
-$green:   #28a745 !default;
+$green:   #198754 !default;
 $teal:    #20c997 !default;
-$cyan:    #17a2b8 !default;
+$cyan:    #0dcaf0 !default;
+$dark:    #212529 !default; // $gray-900
 
 // Example: Bootstrap Link color
 $link-color: $blue;

data/lib/generators/geoblacklight/templates/assets/application.scss

@@ -1,6 +1,3 @@
-/*
-*= require leaflet-label
-*/
 @import 'customizations';
 @import 'bootstrap';
 @import 'blacklight';