geoblacklight 6.0.0.pre.alpha.7 → 6.0.0.pre.beta.2

data/lib/geoblacklight/relations/query.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  module Relations
+    # Shared Solr query machinery for finding documents related to a given id via a
+    # single field. Subclasses only need to supply the `fq` that expresses their
+    # direction (ancestors vs. descendants); everything else - the fields fetched,
+    # how many rows, and how the query is executed - is identical either way.
+    class Query
+      MAX_ROWS = 3
+
+      def initialize(id, field, repository)
+        @search_id = id
+        @field = field
+        @repository = repository
+      end
+
+      def execute_query
+        @repository.connection.send_and_receive(
+          @repository.blacklight_config.solr_path,
+          params: create_search_params
+        )
+      end
+
+      def results
+        execute_query["response"]
+      end
+
+      private
+
+      def shared_search_params
+        {rows: MAX_ROWS,
+         fl: [Geoblacklight.configuration.fields.title, Geoblacklight.configuration.fields.id,
+           Geoblacklight.configuration.fields.resource_type, Geoblacklight.configuration.fields.description,
+           Geoblacklight.configuration.fields.resource_class, Geoblacklight.configuration.fields.access_rights]}
+      end
+    end
+  end
+end

data/lib/geoblacklight/{relation → relations}/relation_response.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  module Relation
+  module Relations
     class RelationResponse
-      attr_reader :search_id, :link_id
+      attr_reader :search_id, :link_id, :repository
+
       def initialize(id, repository)
         @link_id = id
         @search_id = RSolr.solr_escape(id)
@@ -29,9 +30,9 @@ module Geoblacklight
       def query_type(option)
         case option.query_type
         when "ancestors"
-          Geoblacklight::Relation::Ancestors
+          Geoblacklight::Relations::Ancestors
         when "descendants"
-          Geoblacklight::Relation::Descendants
+          Geoblacklight::Relations::Descendants
         else
           fail ArgumentError, "Bad RelationResponse query_type: #{option.query_type}. Only 'ancestors' or 'descendants' is allowed."
         end

data/lib/geoblacklight/routes/exportable.rb

@@ -11,7 +11,8 @@ module Geoblacklight
         mapper.member do
           mapper.get "web_services"
           mapper.get "metadata"
-          mapper.get "relations" => "relation#index"
+          mapper.get "relations" => "relations#index"
+          mapper.get "viewer" => "viewer_record#show"
         end
       end
     end

data/lib/geoblacklight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  VERSION = "6.0.0-alpha.7"
+  VERSION = "6.0.0-beta.2"
 end

data/lib/geoblacklight/viewer_record.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  # A record as the item viewer is allowed to see it
+  class ViewerRecord
+    # These references aren't previewable data, so we don't need to restrict them
+    METADATA_REFERENCES = %i[mods fgdc iso19139 html url data_dictionary].freeze
+
+    # @param document [SolrDocument] the record as indexed
+    # @param available [Boolean] see the document_available? helper
+    def initialize(document, available:)
+      @document = document
+      @available = available
+    end
+
+    # If the record is available (public, or restricted and we're authed), return
+    # as-is; otherwise strip out references that are previewable data
+    # @return [Hash]
+    def as_json(options = nil)
+      record = @document.as_json(options)
+      return record if @available || !record.key?(reference_field)
+
+      record.merge(reference_field => metadata_references.to_json)
+    end
+
+    private
+
+    def reference_field
+      @document.references.reference_field.to_s
+    end
+
+    # The references we're keeping
+    def metadata_references
+      @document.references.refs
+        .select { |reference| METADATA_REFERENCES.include?(reference.type) }
+        .to_h { |reference| reference.reference }
+    end
+  end
+end

data/lib/geoblacklight.rb

@@ -3,7 +3,7 @@
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/generators")
-loader.collapse("#{__dir__}/geoblacklight/wms_layer")
+loader.ignore("#{__dir__}/tasks")
 loader.setup
 require "geoblacklight/engine"
 

data/lib/tasks/geoblacklight.rake

@@ -2,23 +2,7 @@
 
 require "rails/generators"
 require "generators/geoblacklight/install_generator"
-
-def system_with_error_handling(*args)
-  Open3.popen3(*args) do |_stdin, stdout, stderr, thread|
-    puts stdout.read
-    raise "Unable to run #{args.inspect}: #{stderr.read}" unless thread.value.success?
-  end
-end
-
-def with_solr(&block)
-  puts "Starting Solr"
-  system_with_error_handling "docker compose up -d solr"
-  sleep 5 # give solr a few seconds to load the core config and be ready
-  yield
-ensure
-  puts "Stopping Solr"
-  system_with_error_handling "docker compose stop solr"
-end
+require "tasks/solr"
 
 namespace :geoblacklight do
   desc "Run Solr and GeoBlacklight for interactive development"

data/lib/tasks/solr.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Helpers for interacting with Solr via docker compose
+
+require "open3"
+
+# Run in a thread with error handling, so we can ensure Solr gets stopped on failure
+def system_with_error_handling(*args)
+  Open3.popen3(*args) do |_stdin, stdout, stderr, thread|
+    puts stdout.read
+    raise "Unable to run #{args.inspect}: #{stderr.read}" unless thread.value.success?
+  end
+end
+
+# Downstream applications can create their own compose.yml which will shadow
+# ours; in that case they can change the name of the solr service and set it here.
+def solr_service
+  ENV.fetch("SOLR_SERVICE", "solr")
+end
+
+def wait_for_solr
+  script = File.expand_path("../../script/wait-for-solr", __dir__)
+  # Not system_with_error_handling: that buffers stdout until the process exits, so the
+  # progress lines would only appear once the wait was already over.
+  raise "Unable to run #{script}" unless system(script)
+end
+
+# Replacement for solr_wrapper.
+def with_solr(&block)
+  puts "Starting Solr"
+  system_with_error_handling "docker compose up -d #{solr_service}"
+  wait_for_solr
+  yield
+ensure
+  puts "Stopping Solr"
+  system_with_error_handling "docker compose stop #{solr_service}"
+end

data/schema/readme.md

@@ -2,6 +2,6 @@
 
 This directory contains a [JSON schema vocabulary](http://json-schema.org) file. It is provided for documentation and testing purposes.
 
-- geoblacklight-schema-aardvark.json : This document is formatted in the [OpenGeoMetadata, version Aardvark schema](https://opengeometadata.org/docs/ogm-aardvark), compatible with Geoblacklight version 4.0+.
+- geoblacklight-schema-aardvark.json : This document is formatted in the [OpenGeoMetadata, version Aardvark schema](https://opengeometadata.org/ogm-aardvark), compatible with Geoblacklight version 4.0+.
 
 For more information on the metadata schema for GeoBlacklight, see [opengeometadata.org](https://opengeometadata.org)

data/script/wait-for-solr

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+#
+# Wait until Solr is serving the core, not merely running.
+#
+# `docker compose up -d` returns as soon as the container starts, which is well before Solr
+# has created and loaded its core. It also returns successfully when the host port fails to
+# publish, leaving a container that is healthy inside but unreachable from the host. Both
+# cases used to sail past a `sleep 5` and fail on the first Solr request.
+#
+# The check is deliberately core-scoped. A node-level endpoint such as
+# /solr/admin/info/system answers 200 while the core is still being created, which is the
+# window this is here to close; the core's ping handler answers 404 until the core is there.
+#
+# Usage: script/wait-for-solr
+#   SOLR_URL            full core URL to poll (default http://127.0.0.1:8983/solr/blacklight-core)
+#   SOLR_WAIT_ATTEMPTS  give up after this many 2s attempts (default 30)
+#   SOLR_SERVICE        name of the Solr service in docker-compose.yml (default solr)
+set -uo pipefail
+
+url="${SOLR_URL:-http://127.0.0.1:8983/solr/blacklight-core}"
+url="${url%/}"
+attempts="${SOLR_WAIT_ATTEMPTS:-30}"
+
+until [ "$(curl -s -o /dev/null -w '%{http_code}' --max-time 2 "$url/admin/ping")" = "200" ]; do
+  attempts=$((attempts - 1))
+  if [ "$attempts" -le 0 ]; then
+    echo "Solr never became ready at $url/admin/ping" >&2
+    echo "Check \`docker compose port ${SOLR_SERVICE:-solr} 8983\`; if it prints nothing, run" >&2
+    echo "\`docker compose up -d --force-recreate ${SOLR_SERVICE:-solr}\`" >&2
+    exit 1
+  fi
+  echo "Waiting for Solr to be ready..."
+  sleep 2
+done
+
+echo "Solr is up and running!"

data/solr/conf/solrconfig.xml

@@ -117,9 +117,9 @@
       <str name="q.alt">*:*</str>
       <str name="qf">
         text^1
-        dct_description_ti^2
+        dct_description_tmi^2
         dct_creator_tmi^3
-        dct_publisher_ti^3
+        dct_publisher_tmi^3
         dct_isPartOf_tmi^4
         dct_subject_tmi^5
         dct_spatial_tmi^5
@@ -127,16 +127,16 @@
         dct_title_ti^6
         dct_accessRights_ti^7
         dct_provider_ti^8
-        gbl_resourceClass_ti^9
-        gbl_resourceType_ti^9
-        dct_identifier_ti^10
+        gbl_resourceClass_tmi^9
+        gbl_resourceType_tmi^9
+        dct_identifier_tmi^10
         id_ti^10
       </str>
       <str name="pf"><!-- phrase boost within result set -->
         text^1
-        dct_description_ti^2
+        dct_description_tmi^2
         dct_creator_tmi^3
-        dct_publisher_ti^3
+        dct_publisher_tmi^3
         dct_isPartOf_tmi^4
         dct_subject_tmi^5
         dct_spatial_tmi^5
@@ -144,9 +144,9 @@
         dct_title_ti^6
         dct_accessRights_ti^7
         dct_provider_ti^8
-        gbl_resourceClass_ti^9
-        gbl_resourceType_ti^9
-        dct_identifier_ti^10
+        gbl_resourceClass_tmi^9
+        gbl_resourceType_tmi^9
+        dct_identifier_tmi^10
         id_ti^10
       </str>
       <bool name="facet">true</bool>
@@ -179,12 +179,6 @@
     <lst name="defaults">
       <str name="echoParams">all</str>
     </lst>
-    <!-- An optional feature of the PingRequestHandler is to configure the
-         handler with a "healthcheckFile" which can be used to enable/disable
-         the PingRequestHandler.
-         relative paths are resolved against the data dir
-      -->
-    <str name="healthcheckFile">server-enabled.txt</str>
   </requestHandler>
 
   <requestHandler name="/analysis/field"

data/spec/components/geoblacklight/document/sidebar_component_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Geoblacklight::Document::SidebarComponent, type: :component do
     allow_any_instance_of(Blacklight::DocumentHelperBehavior).to receive(:current_bookmarks).and_return([])
 
     with_controller_class(CatalogController) do
-      allow(vc_test_controller).to receive_messages(current_or_guest_user: User.new)
+      allow(vc_test_controller).to receive_messages(current_or_guest_user: nil)
       render_inline(component)
     end
   end
@@ -26,7 +26,7 @@ RSpec.describe Geoblacklight::Document::SidebarComponent, type: :component do
     let(:fixture) { "solr_documents/public_iiif_princeton.json" }
 
     it "renders the static map" do
-      expect(page).to have_css("#static-map")
+      expect(page).to have_css("#locator-map")
     end
 
     it "renders the Location label" do
@@ -38,7 +38,7 @@ RSpec.describe Geoblacklight::Document::SidebarComponent, type: :component do
     let(:fixture) { "solr_documents/restricted-line.json" }
 
     it "does not render the static map" do
-      expect(page).to have_no_css("#static-map")
+      expect(page).to have_no_css("#locator-map")
     end
 
     it "does not render the Location label" do

data/spec/components/geoblacklight/document_component_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Geoblacklight::DocumentComponent, type: :component do
 
   before do
     vc_test_controller.action_name = "show"
-    allow(vc_test_controller).to receive_messages(view_context: view_context, current_or_guest_user: User.new, blacklight_config: blacklight_config)
+    allow(vc_test_controller).to receive_messages(view_context: view_context, current_or_guest_user: nil, blacklight_config: blacklight_config)
     allow(view_context).to receive_messages(search_session: {}, current_search_session: nil, current_bookmarks: [])
     render_inline(component)
   end
@@ -42,51 +42,27 @@ RSpec.describe Geoblacklight::DocumentComponent, type: :component do
     end
   end
 
-  context "when the document is an index map" do
-    let(:fixture) { "solr_documents/index-map-stanford.json" }
-
-    it "renders the index map legend" do
-      expect(page).to have_css(".index-map-legend")
-    end
-
-    it "renders the index map inspection area" do
-      expect(page).to have_css(".viewer-information")
-    end
-  end
-
   context "when the document has a IIIF manifest" do
     let(:fixture) { "solr_documents/b1g_iiif_manifest.json" }
 
-    it "displays the IIIF help text" do
-      expect(page).to have_text(I18n.t("geoblacklight.help_text.viewer_protocol.iiif.title"))
-    end
-
-    it "uses the IIIF tag for the container" do
-      expect(page).to have_css("div#mirador")
+    it "uses the viewer for the container" do
+      expect(page).to have_css(".viewer")
     end
   end
 
   context "when the document has a pmtiles layer" do
     let(:fixture) { "solr_documents/public_pmtiles_princeton.json" }
 
-    it "displays the PM Tiles help text" do
-      expect(page).to have_text(I18n.t("geoblacklight.help_text.viewer_protocol.pmtiles.title"))
-    end
-
-    it "uses the Open Layers tag for the container" do
-      expect(page).to have_css("div#openlayers-viewer")
+    it "uses the viewer for the container" do
+      expect(page).to have_css(".viewer")
     end
   end
 
   context "when the document has a WMS layer" do
     let(:fixture) { "solr_documents/actual-polygon1.json" }
 
-    it "displays wms help text" do
-      expect(page).to have_text(I18n.t("geoblacklight.help_text.viewer_protocol.wms.title"))
-    end
-
-    it "uses the Leaflet tag for the container" do
-      expect(page).to have_css("div#leaflet-viewer")
+    it "uses the viewer for the container" do
+      expect(page).to have_css(".viewer")
     end
   end
 
@@ -94,9 +70,7 @@ RSpec.describe Geoblacklight::DocumentComponent, type: :component do
     let(:fixture) { "solr_documents/actual-papermap1.json" }
 
     it "does not render the viewer" do
-      expect(page).not_to have_css("div#leaflet-viewer")
-      expect(page).not_to have_css("div#openlayers-viewer")
-      expect(page).not_to have_css("div#mirador")
+      expect(page).not_to have_css(".viewer")
     end
   end
 end

data/spec/components/geoblacklight/{header_icons_component_spec.rb → header_badges_component_spec.rb}

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-RSpec.describe Geoblacklight::HeaderIconsComponent, type: :component do
+RSpec.describe Geoblacklight::HeaderBadgesComponent, type: :component do
   before do
     render_inline(described_class.new(document: document))
   end
@@ -10,11 +10,13 @@ RSpec.describe Geoblacklight::HeaderIconsComponent, type: :component do
   let(:document) { SolrDocument.new(document_attributes) }
   let(:resource_class) { [] }
   let(:resource_type) { [] }
+  let(:georeferenced) { nil }
   let(:document_attributes) do
     {
       "gbl_resourceClass_sm" => resource_class,
       "gbl_resourceType_sm" => resource_type,
-      "dct_accessRights_s" => "Public"
+      "dct_accessRights_s" => "Public",
+      "gbl_georeferenced_b" => georeferenced
     }
   end
 
@@ -48,4 +50,20 @@ RSpec.describe Geoblacklight::HeaderIconsComponent, type: :component do
       expect(page).to have_css(".blacklight-icons-raster")
     end
   end
+
+  context "when georeferenced" do
+    let(:georeferenced) { true }
+
+    it "renders the georeferenced icon" do
+      expect(page).to have_css(".blacklight-icons-georeferenced")
+    end
+  end
+
+  context "when not georeferenced" do
+    let(:georeferenced) { false }
+
+    it "does not render the georeferenced icon" do
+      expect(page).not_to have_css(".blacklight-icons-georeferenced")
+    end
+  end
 end

data/spec/components/geoblacklight/item_map_viewer_component_spec.rb

@@ -7,30 +7,80 @@ RSpec.describe Geoblacklight::ItemMapViewerComponent, type: :component do
     render_inline(described_class.new(document: document))
   end
 
-  context "IIIF viewer" do
-    let(:fixture) { JSON.parse(read_fixture("solr_documents/iiif-eastern-hemisphere.json")) }
-    let(:document) { SolrDocument.new(fixture) }
+  # One viewer for every protocol it can preview: what to show is the viewer's own decision, taken
+  # from the references in the record it fetches
+  ["solr_documents/iiif-eastern-hemisphere.json",
+    "solr_documents/public_pmtiles_princeton.json",
+    "solr_documents/actual-polygon1.json"].each do |fixture_path|
+    context "with #{File.basename(fixture_path, ".json")}" do
+      let(:document) { SolrDocument.new(JSON.parse(read_fixture(fixture_path))) }
 
-    it "uses the IIIF tag" do
-      expect(page).to have_css("div#mirador")
+      it "uses the viewer" do
+        expect(page).to have_css("ogm-viewer")
+      end
+
+      it "leaves the theme to the page's color mode" do
+        expect(page).to have_css("ogm-viewer:not([theme])")
+      end
+    end
+  end
+
+  describe "the basemap" do
+    let(:document) { SolrDocument.new(JSON.parse(read_fixture("solr_documents/actual-polygon1.json"))) }
+
+    it "is left to the viewer's own default when none is configured" do
+      expect(page).to have_css("ogm-viewer:not([light-basemap]):not([dark-basemap])")
+    end
+
+    context "when the application configures its own" do
+      before do
+        allow(Geoblacklight.configuration).to receive(:light_basemap_url)
+          .and_return("https://tiles.example.edu/styles/light/style.json")
+        render_inline(described_class.new(document: document))
+      end
+
+      it "names the style document on the viewer" do
+        expect(page).to have_css('ogm-viewer[light-basemap="https://tiles.example.edu/styles/light/style.json"]')
+      end
     end
   end
 
-  context "Open layers viewer" do
-    let(:fixture) { JSON.parse(read_fixture("solr_documents/public_pmtiles_princeton.json")) }
-    let(:document) { SolrDocument.new(fixture) }
+  describe "restricted origins in reference URLs" do
+    # Restricted, and provided by this app's own institution
+    let(:document) { SolrDocument.new(JSON.parse(read_fixture("solr_documents/actual-raster1.json"))) }
+
+    before do
+      allow(Geoblacklight.configuration).to receive(:restricted_origins).and_return(["https://stacks.stanford.edu/"])
+    end
+
+    context "when signed in" do
+      before do
+        allow(vc_test_controller).to receive(:current_user).and_return(instance_double(ActiveRecord::Base))
+        render_inline(described_class.new(document: document))
+      end
+
+      it "sends them to the viewer as a separate data param" do
+        expect(page).to have_css('ogm-viewer[data-restricted-origins=\'["https://stacks.stanford.edu/"]\']')
+      end
+    end
+
+    context "when not signed in" do
+      before do
+        allow(vc_test_controller).to receive(:current_user).and_return(nil)
+        render_inline(described_class.new(document: document))
+      end
 
-    it "uses the open layers tag" do
-      expect(page).to have_css("div#openlayers-viewer")
+      it "does not send them to the viewer" do
+        expect(page).to have_css("ogm-viewer:not([data-restricted-origins])")
+      end
     end
   end
 
-  context "Base or leaflet viewer" do
-    let(:fixture) { JSON.parse(read_fixture("solr_documents/actual-polygon1.json")) }
-    let(:document) { SolrDocument.new(fixture) }
+  context "with an oembed record" do
+    let(:document) { SolrDocument.new(JSON.parse(read_fixture("solr_documents/oembed.json"))) }
 
-    it "uses the IIIF tag" do
-      expect(page).to have_css("div#leaflet-viewer")
+    it "uses the oembed viewer instead" do
+      expect(page).to have_css("div#oembed-viewer")
     end
   end
 end

data/spec/components/geoblacklight/locator_map_component_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::LocatorMapComponent, type: :component do
+  let(:document) { SolrDocument.new(JSON.parse(read_fixture("solr_documents/actual-polygon1.json"))) }
+
+  subject(:map) { page.find("ogm-locator") }
+
+  before { render_inline(described_class.new(document: document)) }
+
+  it "renders a locator the stylesheet can size" do
+    expect(map[:id]).to eq "locator-map"
+    expect(map[:class]).to eq "viewer locator-map"
+  end
+
+  it "points at the same record endpoint the item viewer reads" do
+    expect(map["record-url"]).to be_present
+  end
+
+  it "leaves the theme to the page's color mode" do
+    expect(map[:theme]).to be_nil
+  end
+
+  context "when the application turns Blacklight's dark mode support off" do
+    before do
+      allow_any_instance_of(GeoblacklightHelper).to receive(:geoblacklight_viewer_theme).and_return("light")
+      render_inline(described_class.new(document: document))
+    end
+
+    it "passes the light default the helper states through to the viewer" do
+      expect(map[:theme]).to eq "light"
+    end
+  end
+
+  describe "the basemap" do
+    it "is left to the viewer's own default when none is configured" do
+      expect(map["light-basemap"]).to be_nil
+      expect(map["dark-basemap"]).to be_nil
+    end
+
+    context "when the application configures its own" do
+      before do
+        allow(Geoblacklight.configuration).to receive(:dark_basemap_url)
+          .and_return("https://tiles.example.edu/styles/dark/style.json")
+        render_inline(described_class.new(document: document))
+      end
+
+      it "names the style document on the locator too, so every map on the page matches" do
+        expect(map["dark-basemap"]).to eq "https://tiles.example.edu/styles/dark/style.json"
+      end
+    end
+  end
+end

data/spec/components/geoblacklight/login_link_component_spec.rb

@@ -3,26 +3,34 @@
 require "spec_helper"
 
 RSpec.describe Geoblacklight::LoginLinkComponent, type: :component do
-  let(:document) { instance_double(SolrDocument, id: 123) }
+  let(:document) { instance_double(SolrDocument, id: 123, restricted?: true, same_institution?: true) }
+  let(:login_path) { "/login" }
 
-  context "when rendering is required" do
-    before do
-      allow(vc_test_controller).to receive(:user_signed_in?).and_return(false)
-      allow(document).to receive(:restricted?).and_return(true)
-      allow(document).to receive(:same_institution?).and_return(true)
-    end
+  before do
+    allow(vc_test_controller).to receive(:blacklight_login_path).and_return(login_path)
+    allow(vc_test_controller).to receive(:current_user).and_return(nil)
+  end
 
-    it "shows download link" do
+  context "when the document is restricted to this institution and no one is signed in" do
+    it "links to the sign-in page" do
       render_inline(described_class.new(document: document))
-      expect(page).to have_text(I18n.t("geoblacklight.tools.login_to_view"))
+      expect(page).to have_link(I18n.t("geoblacklight.tools.login_to_view"), href: login_path)
     end
   end
 
-  context "when rendering is not required" do
+  context "when signed in" do
     before do
-      allow(document).to receive(:restricted?).and_return(false)
-      allow(document).to receive(:same_institution?).and_return(false)
+      allow(vc_test_controller).to receive(:current_user).and_return(instance_double(ActiveRecord::Base))
+    end
+
+    it "does not render anything" do
+      render_inline(described_class.new(document: document))
+      expect(page).not_to have_text(I18n.t("geoblacklight.tools.login_to_view"))
     end
+  end
+
+  context "when the app has no authentication" do
+    let(:login_path) { nil }
 
     it "does not render anything" do
       render_inline(described_class.new(document: document))