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

data/spec/components/geoblacklight/metadata_description_markdown_component_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe Geoblacklight::MetadataDescriptionMarkdownComponent, type: :compo
       key: "dct_description_sm",
       label: "Description",
       render_field?: true,
+      layout_component: nil,
       values: ["a **short**", "description"])
   end
 
@@ -29,10 +30,4 @@ RSpec.describe Geoblacklight::MetadataDescriptionMarkdownComponent, type: :compo
     expect(page).to have_css("div.truncate-abstract p", count: 2)
     expect(page).to have_css("div.truncate-abstract p strong", text: "short")
   end
-
-  describe "#markdown_to_html" do
-    it "transforms markdown into HTML" do
-      expect(component.markdown_to_html("a **short** description")).to eq "<p>a <strong>short</strong> description</p>\n"
-    end
-  end
 end

data/spec/components/geoblacklight/overview_map_component_spec.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::OverviewMapComponent, type: :component do
+  let(:url) { "/catalog?q=water" }
+  let(:options) { {geosearch: true} }
+  let(:homepage_map_geom) { nil }
+  let(:light_basemap_url) { nil }
+  let(:dark_basemap_url) { nil }
+
+  subject(:map) { page.find("ogm-overview") }
+
+  before do
+    # Stubbed for every example, because the one that reads it renders through the hook below
+    allow(Geoblacklight.logger).to receive(:warn)
+    allow(Geoblacklight.configuration).to receive(:homepage_map_geom).and_return(homepage_map_geom)
+    allow(Geoblacklight.configuration).to receive(:light_basemap_url).and_return(light_basemap_url)
+    allow(Geoblacklight.configuration).to receive(:dark_basemap_url).and_return(dark_basemap_url)
+
+    with_controller_class(CatalogController) do
+      with_request_url(url) do
+        render_inline(described_class.new(**options))
+      end
+    end
+  end
+
+  it "renders an overview map that the controller can find and size" do
+    expect(map[:id]).to eq "overview-map"
+    expect(map[:class]).to eq "viewer overview-map"
+    expect(map["data-controller"]).to eq "overview-map"
+  end
+
+  it "leaves the theme to the page's color mode" do
+    expect(map[:theme]).to be_nil
+  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
+      let(:light_basemap_url) { "https://tiles.example.edu/styles/light/style.json" }
+      let(:dark_basemap_url) { "https://tiles.example.edu/styles/dark/style.json" }
+
+      it "names a style document for each mode" do
+        expect(map["light-basemap"]).to eq "https://tiles.example.edu/styles/light/style.json"
+        expect(map["dark-basemap"]).to eq "https://tiles.example.edu/styles/dark/style.json"
+      end
+    end
+
+    context "when only the light-mode basemap is configured" do
+      let(:light_basemap_url) { "https://tiles.example.edu/styles/light/style.json" }
+
+      it "leaves dark mode to the viewer rather than reusing the light one" do
+        expect(map["light-basemap"]).to eq "https://tiles.example.edu/styles/light/style.json"
+        expect(map["dark-basemap"]).to be_nil
+      end
+    end
+  end
+
+  it "asks the controller for a search of the area a reader draws, and for the row a number belongs to" do
+    expect(map["data-action"]).to eq "boundsChange->overview-map#search highlightChange->overview-map#highlight"
+    expect(map["data-overview-map-catalog-url-value"]).to be_present
+  end
+
+  # ogm-overview keeps its map alive across a disconnect that turns out to be a reconnect rather than
+  # a removal, so the element carrying it can survive a search rather than being rebuilt
+  it "is carried over a search" do
+    expect(map["data-turbo-permanent"]).to be_present
+  end
+
+  describe "searching the map" do
+    it "is offered" do
+      expect(map[:geosearch]).to eq "true"
+    end
+
+    it "says how to go about it in the language the rest of the page is in" do
+      expect(map["search-help-text"]).to eq I18n.t("geoblacklight.map.geosearch.search_help")
+    end
+
+    context "when there is no searching to do" do
+      let(:options) { {} }
+
+      it "is left off entirely, and there is nowhere for a search to go" do
+        expect(map[:geosearch]).to be_nil
+        expect(map["search-help-text"]).to be_nil
+        expect(map["data-overview-map-catalog-url-value"]).to be_nil
+      end
+    end
+  end
+
+  # The area a search is filtered to is the other thing that says where to look; that one is in
+  # spec/requests/index_view_spec.rb, where the controller permits the parameter it comes from, and
+  # where the box beside the map that restates it for a later search is checked too - view-bounds
+  # doesn't need restating the same way, since the home page's default doesn't change request to
+  # request the way a search's bounding box does.
+  describe "where the map opens by default" do
+    context "on the home page" do
+      let(:url) { "/" }
+      let(:options) { {map_geometry: '{"type":"Polygon","coordinates":[[[-73.58,42.93],[-73.58,41.2],[-69.9,41.2],[-69.9,42.93]]]}', geosearch: true} }
+
+      it "is the box around the geometry the home page is configured to open on" do
+        expect(map["view-bounds"]).to eq "-73.58 41.2 -69.9 42.93"
+      end
+    end
+
+    context "when the home page's configured geometry isn't overridden by the caller" do
+      let(:url) { "/" }
+      let(:options) { {geosearch: true} }
+      let(:homepage_map_geom) { '{"type":"Polygon","coordinates":[[[-73.58,42.93],[-73.58,41.2],[-69.9,41.2],[-69.9,42.93]]]}' }
+
+      it "reads Geoblacklight.configuration.homepage_map_geom as its default" do
+        expect(map["view-bounds"]).to eq "-73.58 41.2 -69.9 42.93"
+      end
+    end
+
+    context "when the configured geometry can't be read" do
+      let(:url) { "/" }
+      let(:options) { {map_geometry: "somewhere near Boston"} }
+
+      it "is left to the map, and says so" do
+        expect(map["view-bounds"]).to be_nil
+        expect(Geoblacklight.logger).to have_received(:warn).with(/somewhere near Boston/)
+      end
+    end
+
+    context "when nothing says where to look" do
+      it "is left to the map, which opens on the whole world" do
+        expect(map["view-bounds"]).to be_nil
+      end
+    end
+  end
+end

data/spec/components/geoblacklight/relations/relation_component_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::Relations::RelationComponent, type: :component do
+  let(:document) { SolrDocument.new(document_attributes) }
+  let(:description) { [] }
+  let(:document_attributes) do
+    {
+      "id" => "related-doc",
+      "dct_title_s" => "A Related Record",
+      "dct_description_sm" => description
+    }
+  end
+
+  describe "rendering the related document" do
+    before { render_inline(described_class.new(document: document)) }
+
+    it "links to the related document's show page" do
+      expect(page).to have_link("A Related Record", href: Rails.application.routes.url_helpers.solr_document_path(document))
+    end
+
+    it "renders the document's status icon badges" do
+      expect(page).to have_css(".badges")
+    end
+
+    it "does not render a description block when there is no description" do
+      expect(page).to have_no_css(".truncate-abstract")
+    end
+
+    it "does not render a sibling browse link when no sibling_count is given" do
+      expect(page).to have_no_css("a.browse-all")
+    end
+  end
+
+  context "when the document has a description" do
+    let(:description) { ["First paragraph.", "Second paragraph."] }
+
+    before { render_inline(described_class.new(document: document)) }
+
+    it "renders each description value as its own paragraph" do
+      expect(page).to have_css(".truncate-abstract p", count: 2)
+      expect(page).to have_content("First paragraph.")
+      expect(page).to have_content("Second paragraph.")
+    end
+
+    it "sets up the truncation data attributes for the JS initializer" do
+      expect(page).to have_css(
+        ".truncate-abstract[data-max-lines='5'][data-read-more-text='Read more'][data-close-text='Close']"
+      )
+    end
+  end
+
+  context "when sibling_count is nil (not an ancestor relationship)" do
+    before do
+      render_inline(described_class.new(document: document, field: "dct_isPartOf_sm", sibling_count: nil, browse_label_key: "part_of"))
+    end
+
+    it "does not render a sibling browse link" do
+      expect(page).to have_no_css("a.browse-all")
+    end
+  end
+
+  context "when sibling_count is zero (the ancestor reference doesn't resolve to anything)" do
+    before do
+      render_inline(described_class.new(document: document, field: "dct_isPartOf_sm", sibling_count: 0, browse_label_key: "part_of"))
+    end
+
+    it "does not render a sibling browse link" do
+      expect(page).to have_no_css("a.browse-all")
+    end
+  end
+
+  context "when sibling_count is one (the current document is the only one that matches)" do
+    before do
+      render_inline(described_class.new(document: document, field: "dct_isPartOf_sm", sibling_count: 1, browse_label_key: "part_of"))
+    end
+
+    it "does not render a sibling browse link, since the search would only return this document" do
+      expect(page).to have_no_css("a.browse-all")
+    end
+  end
+
+  context "when sibling_count is greater than one" do
+    before do
+      render_inline(described_class.new(document: document, field: "dct_isPartOf_sm", sibling_count: 4, browse_label_key: "part_of"))
+    end
+
+    it "renders a sibling browse link scoped to this document's id on the given field" do
+      expected_href = Rails.application.routes.url_helpers.search_catalog_path(f: {"dct_isPartOf_sm" => ["related-doc"]})
+      expect(page).to have_css("a.browse-all[href='#{expected_href}']")
+    end
+
+    it "renders the browse link text from the browse_label_key locale scope, matching the search's true total" do
+      expect(page).to have_link(I18n.t("geoblacklight.relations.browse.part_of", count: 4), class: "browse-all")
+    end
+  end
+end

data/spec/components/geoblacklight/relations/relations_component_spec.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::Relations::RelationsComponent, type: :component do
+  let(:repository) { Blacklight::Solr::Repository.new(CatalogController.blacklight_config) }
+  let(:relations) { Geoblacklight::Relations::RelationResponse.new(id, repository) }
+  let(:rel_type_info) { Geoblacklight.configuration.relationships_shown[relationship_type] }
+  let(:component) { described_class.new(relations: relations, relationship_type: relationship_type, rel_type_info: rel_type_info) }
+
+  describe "#render?" do
+    context "with a document that has matching relations" do
+      let(:id) { "nyu_2451_34502" }
+      let(:relationship_type) { :source_ancestors }
+
+      it "is true" do
+        expect(component.render?).to be true
+      end
+    end
+
+    context "with a document that has no matching relations" do
+      let(:id) { "berkeley-s7pq31" }
+      let(:relationship_type) { :source_ancestors }
+
+      it "is false, so the component renders nothing" do
+        expect(component.render?).to be false
+      end
+    end
+  end
+
+  describe "#browse_label_key" do
+    let(:id) { "nyu_2451_34502" }
+
+    it "strips the _ancestors suffix" do
+      expect(described_class.new(relations: relations, relationship_type: :part_of_ancestors, rel_type_info: Geoblacklight.configuration.relationships_shown.part_of_ancestors).browse_label_key).to eq("part_of")
+    end
+
+    it "strips the _descendants suffix" do
+      expect(described_class.new(relations: relations, relationship_type: :part_of_descendants, rel_type_info: Geoblacklight.configuration.relationships_shown.part_of_descendants).browse_label_key).to eq("part_of")
+    end
+  end
+
+  describe "#sibling_count" do
+    context "for an ancestor relationship" do
+      let(:relationship_type) { :source_ancestors }
+
+      context "when the current document is the only one that shares this ancestor" do
+        let(:id) { "nyu_2451_34502" }
+        let(:ancestor) { SolrDocument.new("id" => "nyu_2451_34636") }
+
+        it "counts just the current document itself" do
+          expect(component.sibling_count(ancestor)).to eq(1)
+        end
+      end
+
+      context "when other documents also share this ancestor" do
+        let(:id) { "757d0f6e-2e04-4ac1-bd28-a5204df46ac1" }
+        let(:relationship_type) { :part_of_ancestors }
+        let(:ancestor) { SolrDocument.new("id" => "eee6150b-ce2f-4837-9d17-ce72a0c1c26f") }
+
+        it "returns the total number of documents that share that ancestor, including this one" do
+          expect(component.sibling_count(ancestor)).to eq(4)
+        end
+      end
+
+      context "with an ancestor id containing Solr special characters" do
+        let(:id) { "nyu_2451_34502" }
+        let(:ancestor) { SolrDocument.new("id" => "ark:/12345/x6") }
+
+        it "escapes the id instead of raising" do
+          expect { component.sibling_count(ancestor) }.not_to raise_error
+          expect(component.sibling_count(ancestor)).to be_a(Integer)
+        end
+      end
+    end
+
+    context "for a descendant relationship" do
+      let(:id) { "nyu_2451_34502" }
+      let(:relationship_type) { :source_descendants }
+      let(:ancestor) { SolrDocument.new("id" => "nyu_2451_34636") }
+
+      it "returns nil, since there is nothing to browse to from a descendant" do
+        expect(component.sibling_count(ancestor)).to be_nil
+      end
+    end
+  end
+
+  describe "rendering" do
+    context "when there are 3 or fewer related documents" do
+      let(:id) { "nyu_2451_34502" }
+      let(:relationship_type) { :source_ancestors }
+
+      before { render_inline(component) }
+
+      it "renders the pluralized relationship label with the result count" do
+        expect(page).to have_css(".card-header h2", text: "Sourced from 2 items")
+      end
+
+      it "renders one row per related document" do
+        expect(page).to have_css(".list-group-item", count: 2)
+      end
+
+      it "does not render a browse-all footer" do
+        expect(page).to have_no_css(".card-footer")
+      end
+    end
+
+    context "when there are more than 3 related documents, but the relationship is an ancestor relationship" do
+      # browse_all_path always filters on the current document's own id, which only finds
+      # results for descendant relationships - there's no fixture with >3 real ancestors of
+      # one type, so the scenario is forced here to prove the footer is suppressed rather
+      # than linking to a query that would return the wrong (or zero) results.
+      let(:id) { "nyu_2451_34502" }
+      let(:relationship_type) { :source_ancestors }
+
+      before do
+        allow(component).to receive(:result_count).and_return(5)
+        render_inline(component)
+      end
+
+      it "does not render a browse-all footer, since browse_all_path would search the wrong direction" do
+        expect(page).to have_no_css(".card-footer")
+      end
+    end
+
+    context "when there are more than 3 related documents" do
+      let(:id) { "eee6150b-ce2f-4837-9d17-ce72a0c1c26f" }
+      let(:relationship_type) { :part_of_descendants }
+
+      before { render_inline(component) }
+
+      it "renders the pluralized relationship label with the result count" do
+        expect(page).to have_css(".card-header h2", text: "Has 4 parts")
+      end
+
+      it "renders only the first 3 related documents" do
+        expect(page).to have_css(".list-group-item", count: 3)
+      end
+
+      it "renders a browse-all footer linking to the rest of the results" do
+        expected_href = Rails.application.routes.url_helpers.search_catalog_path(f: {"dct_isPartOf_sm" => ["eee6150b-ce2f-4837-9d17-ce72a0c1c26f"]})
+        expect(page).to have_css(".card-footer a[href='#{expected_href}']", text: "Browse all 4 parts of this item")
+      end
+    end
+  end
+end

data/spec/components/geoblacklight/search_result_component_spec.rb

@@ -4,63 +4,90 @@ require "spec_helper"
 
 RSpec.describe Geoblacklight::SearchResultComponent, type: :component do
   let(:request_context) { double(document_index_view_type: "list", action_name: :index) }
-  let(:blacklight_config) do
-    Blacklight::Configuration.new.configure do |config|
-      config.add_index_field "gbl_wxsIdentifier_s"
-      config.add_index_field "index_display"
-      config.add_index_field "period"
-      config.add_index_field "multi_display"
-    end
-  end
+  let(:blacklight_config) { Blacklight::Configuration.new }
   let(:presenter) do
     Blacklight::DocumentPresenter.new(document, request_context, blacklight_config)
   end
 
-  let(:document) do
-    SolrDocument.new(
-      id: 1,
-      gbl_wxsIdentifier_s: "druid:abc123",
-      non_index_field: "do not render",
-      period: "Ends with period.",
-      multi_display: %w[blue blah]
-    )
-  end
+  let(:document) { SolrDocument.new(id: 1, dct_description_sm: description) }
+  let(:description) { [] }
+
   before do
-    allow(request_context).to receive(:snippit)
-    allow_any_instance_of(BlacklightHelper).to receive(:link_to_document)
+    allow_any_instance_of(BlacklightHelper).to receive(:link_to_document) do |_instance, _doc, value = nil, *|
+      value
+    end
     allow_any_instance_of(GeoblacklightHelper).to receive(:blacklight_config).and_return(blacklight_config)
     render_inline(described_class.new(document: presenter))
   end
 
-  describe "#index_fields_display" do
-    let(:multi_valued_text) { document["multi_display"].join(" and ") }
-    let(:combined_fields) { document["gbl_wxsIdentifier_s"] + ". " + document["period"] }
+  describe "#description" do
+    it "does not render a description block when there is no description" do
+      expect(page).to have_no_css(".truncate-abstract")
+    end
+
+    context "when the document has a description" do
+      let(:description) { ["First paragraph.", "Second paragraph."] }
+
+      it "renders each description value as its own paragraph" do
+        expect(page).to have_css(".truncate-abstract p", count: 2)
+        expect(page).to have_content("First paragraph.")
+        expect(page).to have_content("Second paragraph.")
+      end
 
-    subject(:index_fields_display) { page.find("[itemprop=description]").text }
+      it "sets up the truncation data attributes for the JS initializer" do
+        expect(page).to have_css(
+          ".truncate-abstract[data-max-lines='4'][data-read-more-text='Read more'][data-close-text='Close']"
+        )
+      end
 
-    context "with multi-valued field" do
-      it "each value is separated by comma" do
-        expect(index_fields_display).to include(multi_valued_text)
+      it "exposes the description as schema.org markup" do
+        expect(page).to have_css(".truncate-abstract[itemprop='description']")
       end
     end
-    context "with document fields not configured as index field" do
-      it "does not render" do
-        expect(index_fields_display).not_to include(document["non_index_field"])
+  end
+
+  describe "thumbnails" do
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.index.thumbnail_method = :geoblacklight_thumbnail
+        config.index.default_thumbnail = :geoblacklight_default_thumbnail
       end
     end
-    context "with multiple document index fields present" do
-      it "separates fields by period followed by a space" do
-        expect(index_fields_display).to include(combined_fields)
+    let(:presenter) do
+      Blacklight::IndexPresenter.new(document, request_context, blacklight_config)
+    end
+
+    context "when a thumbnail is available" do
+      let(:request_context) do
+        double(document_index_view_type: "list", action_name: :index,
+          geoblacklight_thumbnail: '<img src="http://example.com/thumb.jpg" alt="">'.html_safe)
       end
-      context "with index field ending in period" do
-        it "renders only 1 period" do
-          expect(index_fields_display).to include(document["period"] + " ")
-        end
+
+      it "renders the thumbnail image" do
+        expect(page).to have_css ".document-thumbnail img[src='http://example.com/thumb.jpg']"
       end
     end
-    context "with document empty configured index field" do
-      it "does not render a period followed by a space" do
-        expect(index_fields_display).not_to include(". .")
+
+    context "when no thumbnail is available but a default exists" do
+      let(:request_context) do
+        double(document_index_view_type: "list", action_name: :index,
+          geoblacklight_thumbnail: nil,
+          geoblacklight_default_thumbnail: '<span class="blacklight-icons"></span>'.html_safe)
+      end
+
+      it "renders the default thumbnail" do
+        expect(page).to have_css ".document-thumbnail .blacklight-icons"
+      end
+    end
+
+    context "when neither a thumbnail nor a default is available" do
+      let(:request_context) do
+        double(document_index_view_type: "list", action_name: :index,
+          geoblacklight_thumbnail: nil, geoblacklight_default_thumbnail: nil)
+      end
+
+      it "does not render a thumbnail" do
+        expect(page).not_to have_css ".document-thumbnail"
       end
     end
   end

data/spec/components/geoblacklight/static_map_component_spec.rb

@@ -15,8 +15,14 @@ RSpec.describe Geoblacklight::StaticMapComponent, type: :component do
   end
 
   context "when the protocol matches the sidebar_static_map setting" do
-    it "renders the static map" do
-      expect(rendered.css("#static-map")).to be_present
+    it "renders a locator map of where the record is" do
+      expect(rendered.css("ogm-locator#locator-map")).to be_present
+    end
+
+    it "points it at the same endpoint the item viewer reads its own metadata from" do
+      map = rendered.css("ogm-locator").first
+      expect(map["record-url"]).to eq Rails.application.routes.url_helpers.viewer_solr_document_path(document)
+      expect(map["theme"]).to be_nil
     end
   end
 end

data/spec/components/geoblacklight/truncatable_metadata_field_layout_component_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::TruncatableMetadataFieldLayoutComponent, type: :component do
+  subject(:component) { described_class.new(field:) }
+
+  let(:field_config) { Blacklight::Configuration::Field.new(key: "dct_subject_sm") }
+  let(:field) { instance_double(Blacklight::FieldPresenter, key: "dct_subject_sm", field_config:) }
+
+  def render_field(component)
+    render_inline(component) do |layout|
+      layout.with_label { "Subject" }
+      layout.with_value(value: "Forests", index: 0)
+      layout.with_value(value: "Land use", index: 1)
+    end
+  end
+
+  it "wraps the label and the values in a row of their own" do
+    render_field(component)
+
+    expect(page).to have_css("div.truncate-field.row > dt.blacklight-dct_subject_sm", text: "Subject")
+    expect(page).to have_css("div.truncate-field.row > dd", count: 3) # two values plus the button slot
+  end
+
+  it "keeps each value in its own dd, in the columns the layout would have used" do
+    render_field(component)
+
+    expect(page).to have_css("dd.col-md-9.blacklight-dct_subject_sm", text: "Forests")
+    expect(page).to have_css("dd.offset-md-3.col-md-9.blacklight-dct_subject_sm", text: "Land use")
+  end
+
+  it "renders an empty dd for the initializer to put the button in" do
+    render_field(component)
+
+    # A <dl> may not hold a bare <button>, so the button cannot be a sibling of the values
+    expect(page).to have_css("div.truncate-field > dd.read-more-slot.offset-md-3.col-md-9")
+    expect(page.find("dd.read-more-slot").text).to be_empty
+  end
+
+  it "sets up the data attributes for the JS initializer" do
+    render_field(component)
+
+    expect(page).to have_css(
+      ".truncate-field[data-limit='5'][data-read-more-text='Read more'][data-close-text='Close']"
+    )
+    expect(page).to have_css(".truncate-field[data-button-label*='assistive technology']")
+  end
+
+  context "when the truncation parameters are given to the component" do
+    subject(:component) do
+      described_class.new(field:, limit: 2, read_more_text: "More", close_text: "Less")
+    end
+
+    it "uses them instead of the defaults" do
+      render_field(component)
+
+      expect(page).to have_css(
+        ".truncate-field[data-limit='2'][data-read-more-text='More'][data-close-text='Less']"
+      )
+    end
+  end
+
+  context "when the field configuration sets a limit" do
+    let(:field_config) { Blacklight::Configuration::Field.new(key: "dct_subject_sm", limit: 3) }
+
+    it "uses the configured limit" do
+      render_field(component)
+
+      expect(page).to have_css(".truncate-field[data-limit='3']")
+    end
+  end
+
+  context "when the layout is given different columns" do
+    subject(:component) { described_class.new(field:, label_class: "col-2", value_class: "col-10", offset_class: "offset-2") }
+
+    it "puts the button slot in the same columns as the values" do
+      render_field(component)
+
+      expect(page).to have_css("dd.read-more-slot.offset-2.col-10")
+    end
+  end
+end