geoblacklight 3.2.0 → 4.0.0.pre.alpha

data/app/components/geoblacklight/homepage_feature_facet_component.html.erb

@@ -0,0 +1,11 @@
+<div class='category-block col-sm'>
+  <div class='category-icon'>
+    <%= geoblacklight_icon(@icon) %>
+  </div>
+  <%= content_tag :h4, t(@label) %>
+  <%- facets = @response.aggregations[@facet_field].items.map { |item|
+    link_to(item.value, search_catalog_path("f[#{@facet_field}][]": item.value), class: 'home-facet-link')
+  } %>
+  <%- facets << link_to('more »', facet_catalog_path(@facet_field), class: 'more_facets_link') %>
+  <%= facets.join(', ').html_safe %>
+</div>

data/app/components/geoblacklight/homepage_feature_facet_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class HomepageFeatureFacetComponent < ViewComponent::Base
+    def initialize(icon:, label:, facet_field:, response:)
+      @icon = icon
+      @label = label
+      @facet_field = facet_field
+      @response = response
+      super
+    end
+  end
+end

data/{lib → app/helpers}/geoblacklight/geoblacklight_helper_behavior.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
+##
+# Adds helper behavior logic for GeoBlacklight, to used alongside
+# BlacklightHelperBehavior
 module Geoblacklight
-  ##
-  # Adds helper behavior logic for GeoBlacklight, to used alongside
-  # BlacklightHelperBehavior
   module GeoblacklightHelperBehavior
+    include Blacklight::BlacklightHelperBehavior
+
     ##
     # Calls the presenter on the requested method
     # @param [Symbol, String] presenting_method
     # @return [String]
     def geoblacklight_present(presenting_method, document = @document)
-      presenter(document).try(presenting_method.to_sym) || ''
+      document_presenter(document).try(presenting_method.to_sym) || ''
     end
   end
 end

data/app/helpers/geoblacklight_helper.rb

@@ -91,12 +91,6 @@ module GeoblacklightHelper
     truncate(Array(args[:value]).flatten.join(' '), length: 150)
   end
 
-  def render_facet_tags(facet)
-    render_facet_limit(facets_from_request(facet).first,
-                       partial: 'facet_tag_item',
-                       layout: 'facet_tag_layout')
-  end
-
   ##
   # Returns an SVG icon or empty HTML span element
   # @return [SVG or HTML tag]
@@ -173,7 +167,7 @@ module GeoblacklightHelper
     if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
       help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
       tag.h3 class: 'help-text viewer_protocol h6' do
-        tag.a 'data': { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
+        tag.a data: { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
           help_text[:title]
         end
       end
@@ -280,6 +274,18 @@ module GeoblacklightHelper
     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)
+    geoblacklight_icon(icon_name, **icon_options)
+  end
+
+  ## Returns the data-map attribute value used as the JS map selector
+  def results_js_map_selector(controller_name)
+    case controller_name
+    when 'bookmarks'
+      'bookmarks'
+    when 'catalog'
+      'index'
+    else
+      'index'
+    end
   end
 end

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

@@ -18,11 +18,11 @@ module Geoblacklight
       private
 
       def issued
-        fetch(Settings.FIELDS.ISSUED, nil)
+        fetch(Settings.FIELDS.DATE_ISSUED, nil)
       end
 
       def format
-        fetch(Settings.FIELDS.FILE_FORMAT, nil)
+        fetch(Settings.FIELDS.FORMAT, nil)
       end
     end
   end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Geoblacklight
-  # Extends Blacklight::Solr::Document for GeoBlacklight specific functionalit
+  # Extends Blacklight::Solr::Document for GeoBlacklight specific functionality
   module SolrDocument
     extend Blacklight::Solr::Document
 
@@ -47,7 +48,7 @@ module Geoblacklight
     end
 
     def same_institution?
-      fetch(Settings.FIELDS.PROVENANCE, '').casecmp(Settings.INSTITUTION.downcase).zero?
+      fetch(Settings.FIELDS.PROVIDER, '').casecmp(Settings.INSTITUTION.downcase).zero?
     end
 
     def iiif_download
@@ -70,18 +71,12 @@ module Geoblacklight
       'http://schema.org/Dataset'
     end
 
-    def bounding_box_as_wsen
-      geom_field = fetch(Settings.FIELDS.GEOMETRY, '')
-      exp = /^\s*ENVELOPE\(
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*
-                  \)\s*$/x # uses 'x' option for free-spacing mode
-      bbox_match = exp.match(geom_field)
-      return geom_field unless bbox_match # return as-is, not a WKT
-      w, e, n, s = bbox_match.captures
-      "#{w} #{s} #{e} #{n}"
+    def geom_field
+      fetch(Settings.FIELDS.SPATIAL_EXTENT, '')
+    end
+
+    def geometry
+      @geometry ||= Geoblacklight::Geometry.new(geom_field)
     end
 
     def wxs_identifier
@@ -89,7 +84,7 @@ module Geoblacklight
     end
 
     def file_format
-      fetch(Settings.FIELDS.FILE_FORMAT)
+      fetch(Settings.FIELDS.FORMAT)
     end
 
     ##
@@ -105,7 +100,7 @@ module Geoblacklight
     private
 
     def rights_field_data
-      fetch(Settings.FIELDS.RIGHTS, '')
+      fetch(Settings.FIELDS.ACCESS_RIGHTS, '')
     end
 
     def method_missing(method, *args, &block)

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

@@ -16,14 +16,14 @@ module Geoblacklight
     def add_spatial_params(solr_params)
       if blacklight_params[:bbox]
         solr_params[:bq] ||= []
-        solr_params[:bq] << "#{Settings.FIELDS.GEOMETRY}:\"IsWithin(#{envelope_bounds})\"#{boost}"
+        solr_params[:bq] << "#{Settings.FIELDS.SPATIAL_EXTENT}:\"IsWithin(#{envelope_bounds})\"#{boost}"
         solr_params[:fq] ||= []
-        solr_params[:fq] << "#{Settings.FIELDS.GEOMETRY}:\"Intersects(#{envelope_bounds})\""
+        solr_params[:fq] << "#{Settings.FIELDS.SPATIAL_EXTENT}:\"Intersects(#{envelope_bounds})\""
 
         if Settings.OVERLAP_RATIO_BOOST
           solr_params[:bf] ||= []
           solr_params[:overlap] =
-            "{!field uf=* defType=lucene f=solr_bboxtype score=overlapRatio}Intersects(#{envelope_bounds})"
+            "{!field uf=* defType=lucene f=#{Settings.FIELDS.OVERLAP_FIELD} score=overlapRatio}Intersects(#{envelope_bounds})"
           solr_params[:bf] << "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
         end
       end
@@ -62,10 +62,10 @@ module Geoblacklight
 
       # Do not suppress action_documents method calls for individual documents
       # ex. CatalogController#web_services (exportable views)
-      return if solr_params[:q]&.include?('{!lucene}layer_slug_s:')
+      return if solr_params[:q]&.include?("{!lucene}#{Settings.FIELDS.ID}:")
 
       solr_params[:fq] ||= []
-      solr_params[:fq] << '-suppressed_b: true'
+      solr_params[:fq] << "-#{Settings.FIELDS.SUPPRESSED}: true"
     end
   end
 end

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

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

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

@@ -1,6 +1,5 @@
 <% if document.data_dictionary_download.present? %>
     <%= link_to document.data_dictionary_download[:data_dictionary] do %>
-        <%= geoblacklight_icon('book', aria_hidden: true) %>
-        <%= t('geoblacklight.references.data_dictionary') %>
+        <%= geoblacklight_icon('book', aria_hidden: true) %><%= t('geoblacklight.references.data_dictionary') %>
     <% end %>
 <% end %>

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

@@ -2,5 +2,5 @@
   <div id="documents" class="documents-list col-md-6">
     <%= render documents, :as => :document %>
   </div>
-  <%= content_tag :div, '', id: 'map', class: 'col-md-6', aria: { label: t('geoblacklight.map.label') }, data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+  <%= content_tag :div, '', id: 'map', class: 'col-md-6', aria: { label: t('geoblacklight.map.label') }, data: { map: results_js_map_selector(controller.controller_name), 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
 </div>

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.PROVENANCE], classes: 'svg_tooltip') %>
+<%= geoblacklight_icon(document[Settings.FIELDS.PROVIDER], classes: 'svg_tooltip') %>
 <%= geoblacklight_icon(document[Settings.FIELDS.RIGHTS], classes: 'svg_tooltip') %>

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

@@ -3,41 +3,19 @@
     <div class='col-sm'>
       <%= content_tag :h3, t('geoblacklight.home.category_heading') %>
       <div class='row'>
-        <div class='category-block col-sm'>
-          <div class='category-icon'>
-            <%= geoblacklight_icon('home') %>
-          </div>
-          <%= content_tag :h4, t('geoblacklight.home.institution') %>
-          <%= render_facet_tags [Settings.FIELDS.PROVENANCE] %>
-        </div>
-        <div class='category-block col-sm'>
-          <div class='category-icon'>
-            <%= geoblacklight_icon('arrow-circle-down') %>
-          </div>
-          <%= content_tag :h4, t('geoblacklight.home.data_type') %>
-          <%= render_facet_tags [Settings.FIELDS.GEOM_TYPE] %>
-        </div>
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'home', label: 'geoblacklight.home.institution', facet_field: Settings.FIELDS.PROVIDER, response: @response)) %>
+
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'arrow-circle-down', label: 'geoblacklight.home.data_type', facet_field: Settings.FIELDS.RESOURCE_TYPE, response: @response)) %>
       </div>
       <div class='row'>
-        <div class='category-block col-sm'>
-          <div class='category-icon'>
-            <%= geoblacklight_icon('globe') %>
-          </div>
-          <%= content_tag :h4, t('geoblacklight.home.placename') %>
-          <%= render_facet_tags [Settings.FIELDS.SPATIAL_COVERAGE] %>
-        </div>
-        <div class='category-block col-sm'>
-          <div class='category-icon'>
-            <%= geoblacklight_icon('tags') %>
-          </div>
-          <%= content_tag :h4, t('geoblacklight.home.subject') %>
-          <%= render_facet_tags [Settings.FIELDS.SUBJECT] %>
-        </div>
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'globe', label: 'geoblacklight.home.placename', facet_field: Settings.FIELDS.SPATIAL_COVERAGE, response: @response)) %>
+
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'tags', label: 'geoblacklight.home.subject', facet_field: Settings.FIELDS.SUBJECT, response: @response)) %>
       </div>
     </div>
     <div class='col-sm'>
       <%= content_tag :h3, t('geoblacklight.home.map_heading') %>
-      <%= content_tag :div, '', id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+      <%= content_tag :div, '', id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-geom' => Settings.HOMEPAGE_MAP_GEOM, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
     </div>
   </div>
   <div id="geoblacklight-version" class="text-right">

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

@@ -1,5 +1,5 @@
 <% # header bar for doc items in index view -%>
-<%= content_tag :div, class: 'documentHeader index-split row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+<%= content_tag :div, class: 'documentHeader index-split row', data: { layer_id: document.id, geom: document.geometry.geojson } do %>
   <h3 class="index_title col">
     <% counter = document_counter_with_offset(document_counter) %>
     <span class="document-counter">

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

@@ -6,7 +6,7 @@
       <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
     <% 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-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+    <%= 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>
 </div>

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

@@ -1,4 +1,4 @@
 <h2>
-  <span itemprop="name"><%= document_heading(document) %></span>
+  <span itemprop="name"><%= document_presenter(document).heading %></span>
   <%= render partial: 'header_icons', locals: { document: document } %>
 </h2>

data/app/views/download/hgl.html.erb

@@ -1,25 +1,27 @@
 <div class="modal-header">
-  <button type="button" class="close" data-dismiss="modal">
+  <h1 class="modal-title"><%= t('geoblacklight.download.hgl_request') %></h1>
+  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
     <span aria-hidden="true">&times;</span>
   </button>
- <%= content_tag :h4, t('geoblacklight.download.hgl_request'), class: 'text-center' %>
 </div>
 <div class="modal-body">
   <form class="form-horizontal" role="form" id="hglRequest">
     <p><%= t('geoblacklight.download.hgl_instructions')%></p>
     <div class="form-group">
-      <label for="requestEmail" class="col-sm-2 control-label"><%= t('geoblacklight.download.hgl_email')%></label>
-      <div class="col-sm-6">
-        <input class="form-control" type="email" id="requestEmail" />
-      </div>
-      <input type="hidden" id="requestUrl"
-        value="<%= download_hgl_path(id: @document) %>" />
-      <div class="col-sm-2">
-        <button type="submit" class="btn btn-primary"><%= t('geoblacklight.download.hgl_request_button')%></button>
+      <div class="row">
+        <label for="requestEmail" class="col-sm-2 control-label"><%= t('geoblacklight.download.hgl_email')%></label>
+        <div class="col-sm-6">
+          <input class="form-control" type="email" id="requestEmail" />
+        </div>
+        <input type="hidden" id="requestUrl"
+          value="<%= download_hgl_path(id: @document) %>" />
+        <div class="col-sm-2">
+          <button type="submit" class="btn btn-primary"><%= t('geoblacklight.download.hgl_request_button')%></button>
+        </div>
       </div>
     </div>
   </form>
 </div>
 <div class="modal-footer">
-  <button type="button" class="btn btn-default" data-dismiss="modal"><%= t('geoblacklight.download.hgl_close')%></button>
+  <button type="button" class="btn btn-default hide-without-js" data-dismiss="modal"><%= t('geoblacklight.references.services_close')%></button>
 </div>

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

@@ -0,0 +1,15 @@
+<% @relations.send(rel)['docs'][0..2].each do |entry| %>
+  <li class="list-group-item border-bottom-0">
+    <%= link_to solr_document_path(entry[Settings.FIELDS.ID]) do %>
+      <%= relations_icon(entry, value.icon) unless value.icon.nil? %>
+      <%= entry[Settings.FIELDS.TITLE] %>
+    <% end %>
+  </li>
+<% 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 %>
+      <%= t('geoblacklight.relations.browse_all', count: @relations.send(rel)['numFound']) %>
+    <% end %>
+  </li>
+<% end %>

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

@@ -1,24 +1,12 @@
-<% unless @relations.empty? %>
-  <% unless @relations.ancestors['numFound'].to_i.zero? %>
+<%- Settings.RELATIONSHIPS_SHOWN.each do |rel, value| %>
+  <% unless @relations.send(rel)['numFound'].to_i.zero? %>
     <div class="card relations">
       <div class="card-header">
-        <h2 class="mb-0 h6"><%= t('geoblacklight.relations.ancestor') %></h2>
+        <h2 class="mb-0 h6"><%= t("#{value.label}") %></h2>
       </div>
 
       <ul class="list-group list-group-flush">
-        <%= render 'ancestors' %>
-      </ul>
-    </div>
-  <% end %>
-
-  <% unless @relations.descendants['numFound'].to_i.zero? %>
-    <div class="card relations">
-      <div class="card-header">
-        <h2 class="mb-0 h6"><%= t('geoblacklight.relations.descendant') %></h2>
-      </div>
-
-      <ul class="list-group list-group-flush">
-        <%= render 'descendants' %>
+        <%= render partial: 'relations', locals: { rel: rel, value: value } %>
       </ul>
     </div>
   <% end %>

data/app/views/relation/index.json.jbuilder

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
-json.ancestors @relations.ancestors
-json.descendants @relations.descendants
+
 json.current_doc @relations.search_id
+json.relations do
+  Settings.RELATIONSHIPS_SHOWN.each do |key, _value|
+    json.set! key.downcase.to_s, @relations.send(key) unless @relations.send(key)['numFound'].to_i.zero?
+  end
+end

data/babel.config.json

@@ -0,0 +1,4 @@
+{
+  "plugins": ["@babel/plugin-transform-runtime"],
+  "presets": ["@babel/preset-env"]
+}

data/config/initializers/new_gbl_settings_defaults_3_4.yml

@@ -0,0 +1,6 @@
+# New GeoBlacklight v3.4
+# Homepage Map Geometry
+# Leave null to default to entire world
+# Add a stringified GeoJSON object to scope initial render (example from UMass)
+HOMEPAGE_MAP_GEOM: null
+# HOMEPAGE_MAP_GEOM: '{"type":"Polygon","coordinates":[[[-73.58,42.93],[-73.58,41.20],[-69.90,41.20],[-69.90,42.93]]]}'

data/config/locales/geoblacklight.en.yml

@@ -64,9 +64,18 @@ en:
       data_dictionary: 'Documentation'
       services: 'Web services'
       services_close: 'Close'
+      tms: 'Tile Map Service'
     relations:
       ancestor: 'Source Datasets'
       descendant: 'Derived Datasets'
+      member_of: 'Belongs to collection...'
+      part_of: 'Is part of...'
+      relation: 'Related Records'
+      replaces: 'Item replaces...'
+      replaced_by: 'Item replaced by...'
+      source: 'Source Datasets'
+      version_of: 'Version of...'
+
       browse_all: "Browse all %{count} records..."
     metadata:
       toggle_summary: 'Toggle summary'
@@ -104,6 +113,9 @@ en:
         tiled_map_layer:
           title: ArcGIS Tiled Map Layer
           content: An ArcGIS Tiled Map Layer Service displays set of web-accessible tiles that reside on a server.
+        tms:
+          title: Tile Map Service
+          content: A Tile Map Service displays georeferenced map tiles as an image on a map.
         wms:
           title: Web Map Service (WMS)
           content: A Web Map Service displays a geospatial dataset as map images.