geoblacklight 4.7.0 → 5.0.0.pre.alpha.11

data/spec/components/geoblacklight/download_links_component_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::DownloadLinksComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(component)
+  end
+  let(:downloadable) { true }
+  let(:document) { instance_double(SolrDocument, id: 123, downloadable?: downloadable) }
+  let(:component) { described_class.new(document: document) }
+
+  before do
+    allow_any_instance_of(GeoblacklightHelper).to receive(:document_available?).and_return(true)
+  end
+
+  context "when rendering is required" do
+    before do
+      allow(document).to receive(:direct_download).and_return(test: :test)
+      allow(document).to receive(:iiif_download).and_return({})
+      allow(document).to receive(:download_types).and_return(shapefile: {})
+    end
+
+    it "shows download link" do
+      expect(rendered).to have_text("Download")
+      expect(rendered).to have_text("Export Shapefile")
+    end
+  end
+
+  context "when rendering is not required" do
+    context "because there are no download links" do
+      before do
+        allow(document).to receive(:direct_download).and_return({})
+        allow(document).to receive(:iiif_download).and_return({})
+        allow(document).to receive(:download_types).and_return({})
+      end
+
+      it "does not render anything" do
+        expect(rendered).not_to have_text("Download")
+        expect(rendered).not_to have_text("Export Shapefile")
+      end
+    end
+
+    context "because you aren't allowed" do
+      let(:downloadable) { false }
+
+      it "does not render anything" do
+        expect(rendered).not_to have_text("Download")
+        expect(rendered).not_to have_text("Export Shapefile")
+      end
+    end
+  end
+
+  describe "#download_link_file" do
+    let(:label) { "Test Link Text" }
+    let(:id) { "test-id" }
+    let(:url) { "http://example.com/urn:hul.harvard.edu:HARVARD.SDE2.TG10USAIANNH/data.zip" }
+
+    it "generates a link to download the original file" do
+      expect(component.download_link_file(label, id, url)).to eq '<a contentUrl="http://example.com/urn:hul.harvard.edu:HARVARD.SDE2.TG10USAIANNH/data.zip" data-download="trigger" data-download-type="direct" data-download-id="test-id" href="http://example.com/urn:hul.harvard.edu:HARVARD.SDE2.TG10USAIANNH/data.zip">Test Link Text</a>'
+    end
+  end
+
+  describe "#download_link_iiif" do
+    let(:references_field) { Settings.FIELDS.REFERENCES }
+    let(:document_attributes) do
+      {
+        references_field => {
+          "http://iiif.io/api/image" => "https://example.edu/image/info.json"
+        }.to_json
+      }
+    end
+    let(:document) { SolrDocument.new(document_attributes, downloadable?: downloadable) }
+
+    before do
+      allow(component).to receive(:download_text).and_return("Original JPG")
+      allow_any_instance_of(Geoblacklight::Reference).to receive(:to_hash).and_return(iiif: "https://example.edu/image/info.json")
+    end
+
+    it "generates a link to download the JPG file from the IIIF server" do
+      expect(component.download_link_iiif).to eq '<a contentUrl="https://example.edu/image/full/full/0/default.jpg" data-download="trigger" href="https://example.edu/image/full/full/0/default.jpg">Original JPG</a>'
+    end
+  end
+
+  describe "#download_link_generated" do
+    let(:download_type) { "SHAPEFILE" }
+
+    before do
+      allow(component).to receive(:download_path).and_return("/download/test-id?type=SHAPEFILE")
+      allow(component).to receive(:export_format_label).and_return("Shapefile Export Customization")
+      allow(document).to receive(:id).and_return("test-id")
+      allow(document).to receive(:to_s).and_return("test-id")
+    end
+
+    it "generates a link to download the JPG file from the IIIF server" do
+      # Stub I18n to ensure the link can be customized via `export_` labels.
+      allow(component).to receive(:t).with("geoblacklight.download.export_shapefile_link").and_return("Shapefile Export Customization")
+      allow(component).to receive(:t).with("geoblacklight.download.export_link", {download_format: "Shapefile Export Customization"}).and_return("Export Shapefile Export Customization")
+      expect(component.download_link_generated(download_type, document)).to eq '<a data-download-path="/download/test-id?type=SHAPEFILE" data-download="trigger" data-action="downloads#download:once" data-download-type="SHAPEFILE" data-download-id="test-id" href="">Export Shapefile Export Customization</a>'
+    end
+  end
+end

data/spec/components/geoblacklight/header_icons_component_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::HeaderIconsComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(document: document))
+  end
+
+  let(:document) { SolrDocument.new(document_attributes) }
+  let(:resource_class) { [] }
+  let(:resource_type) { [] }
+  let(:document_attributes) do
+    {
+      "gbl_resourceClass_sm" => resource_class,
+      "gbl_resourceType_sm" => resource_type,
+      "schema_provider_s" => "Stanford",
+      "dct_accessRights_s" => "Public"
+    }
+  end
+
+  it "renders the provider icon" do
+    expect(rendered).to have_css(".blacklight-icons-stanford")
+  end
+
+  it "renders the access rights icon" do
+    expect(rendered).to have_css(".blacklight-icons-public")
+  end
+
+  context "when there are no resource types with icons" do
+    let(:resource_class) { ["Datasets"] }
+    let(:resource_type) { ["Census data", "Statistical maps"] }
+
+    it "renders the resource class icon" do
+      expect(rendered).to have_css(".blacklight-icons-datasets")
+    end
+  end
+
+  context "when there is a 'data' resource type with an icon" do
+    let(:resource_class) { ["Datasets"] }
+    let(:resource_type) { ["Raster data"] }
+
+    it "renders the resource type icon" do
+      expect(rendered).to have_css(".blacklight-icons-raster")
+    end
+  end
+
+  context "when there are multiple resource types and one has an icon" do
+    let(:resource_class) { ["Datasets"] }
+    let(:resource_type) { ["Nautical charts", "Raster data"] }
+
+    it "renders the resource type that has an icon" do
+      expect(rendered).to have_css(".blacklight-icons-raster")
+    end
+  end
+end

data/spec/components/geoblacklight/iiif_drag_drop_component_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::IiifDragDropComponent, type: :component do
+  describe "#iiifdragdropcomponet" do
+    let(:reference) { instance_double(Geoblacklight::Reference, endpoint: endpoint) }
+    let(:item_viewer) { instance_double(Geoblacklight::ItemViewer, iiif_manifest: reference) }
+    let(:document) { instance_double(SolrDocument, id: 123, item_viewer: item_viewer) }
+    let(:component) { described_class.new(document: document) }
+    let(:rendered) { render_inline_to_capybara_node(component) }
+
+    context "does not have viewer_endpoint url" do
+      let(:endpoint) { nil }
+
+      it "does not render" do
+        expect(component.render?).to be false
+      end
+    end
+
+    context "has viewer_endpoint url" do
+      let(:endpoint) { "https://url.com/manifest.json" }
+      it "renders iiif drag and drop icon" do
+        expect(component.render?).to be true
+        expect(rendered).to have_selector(:css, ".blacklight-icons-iiif-drag-drop")
+        expect(rendered).to have_selector(:css, "a[href='https://url.com/manifest.json?manifest=https://url.com/manifest.json']")
+      end
+    end
+  end
+end

data/spec/components/geoblacklight/index_map_legend_component_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::IndexMapLegendComponent, type: :component do
+  let(:document) { instance_double(SolrDocument) }
+
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(document:))
+  end
+
+  context "when the document has an index map" do
+    before do
+      allow(document).to receive_message_chain(:item_viewer, :index_map).and_return(true)
+    end
+
+    it "shows available map text" do
+      expect(rendered).to have_text("Green tile indicates")
+      expect(rendered).to have_selector(:css, ".index-map-legend-default")
+    end
+
+    it "shows unavailable map text" do
+      expect(rendered).to have_text("Yellow tile indicates")
+      expect(rendered).to have_selector(:css, ".index-map-legend-unavailable")
+    end
+
+    it "shows selected map text" do
+      expect(rendered).to have_text("Blue tile indicates")
+      expect(rendered).to have_selector(:css, ".index-map-legend-selected")
+    end
+  end
+
+  context "when the document does not have an index map" do
+    before do
+      allow(document).to receive_message_chain(:item_viewer, :index_map).and_return(false)
+    end
+
+    it "does not render" do
+      expect(rendered.text.strip).to be_empty
+    end
+  end
+end

data/spec/components/geoblacklight/item_map_viewer_component_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::ItemMapViewerComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(document:))
+  end
+
+  context "IIIF viewer" do
+    let(:fixture) { JSON.parse(read_fixture("solr_documents/iiif-eastern-hemisphere.json")) }
+    let(:document) { SolrDocument.new(fixture) }
+
+    it "uses the IIIF tag" do
+      expect(rendered).to have_css("div#clover-viewer")
+    end
+  end
+
+  context "Open layers viewer" do
+    let(:fixture) { JSON.parse(read_fixture("solr_documents/public_pmtiles_princeton.json")) }
+    let(:document) { SolrDocument.new(fixture) }
+
+    it "uses the open layers tag" do
+      expect(rendered).to have_css("div#openlayers-viewer")
+    end
+  end
+
+  context "Base or leaflet viewer" do
+    let(:fixture) { JSON.parse(read_fixture("solr_documents/actual-polygon1.json")) }
+    let(:document) { SolrDocument.new(fixture) }
+
+    it "uses the IIIF tag" do
+      expect(rendered).to have_css("div#leaflet-viewer")
+    end
+  end
+end

data/spec/components/geoblacklight/login_link_component_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::LoginLinkComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(document: document))
+  end
+  let(:document) { instance_double(SolrDocument, id: 123) }
+
+  context "when rendering is required" do
+    before do
+      allow_any_instance_of(GeoblacklightHelper).to receive(:document_available?).and_return(false)
+      allow(document).to receive(:restricted?).and_return(true)
+      allow(document).to receive(:same_institution?).and_return(true)
+    end
+
+    it "shows download link" do
+      expect(rendered).to have_text(I18n.t("geoblacklight.tools.login_to_view"))
+    end
+  end
+
+  context "when rendering is not required" do
+    before do
+      allow(document).to receive(:restricted?).and_return(false)
+      allow(document).to receive(:same_institution?).and_return(false)
+    end
+
+    it "does not render anything" do
+      expect(rendered).not_to have_text(I18n.t("geoblacklight.tools.login_to_view"))
+    end
+  end
+end

data/spec/{lib/geoblacklight/document_presenter_spec.rb → components/geoblacklight/search_result_component_spec.rb}

@@ -2,10 +2,8 @@
 
 require "spec_helper"
 
-describe Geoblacklight::DocumentPresenter do
-  # Please see https://github.com/projectblacklight/blacklight/blob/v6.15.0/spec/presenters/index_presenter_spec.rb#L4
-  subject { presenter }
-  let(:request_context) { double(document_index_view_type: "list") }
+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"
@@ -16,7 +14,7 @@ describe Geoblacklight::DocumentPresenter do
   end
   let(:solr_fields) { Settings.FIELDS }
   let(:presenter) do
-    described_class.new(document, request_context, blacklight_config)
+    Blacklight::DocumentPresenter.new(document, request_context, blacklight_config)
   end
 
   let(:document) do
@@ -28,35 +26,45 @@ describe Geoblacklight::DocumentPresenter do
       multi_display: %w[blue blah]
     )
   end
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(document: presenter))
+  end
+
+  before do
+    allow(request_context).to receive(:snippit)
+    allow_any_instance_of(BlacklightHelper).to receive(:link_to_document)
+    allow_any_instance_of(GeoblacklightHelper).to receive(:blacklight_config).and_return(blacklight_config)
+  end
 
   describe "#index_fields_display" do
-    let(:rendered_index_text) { subject.index_fields_display }
     let(:multi_valued_text) { document["multi_display"].join(" and ") }
     let(:combined_fields) { document["gbl_wxsIdentifier_s"] + ". " + document["period"] }
 
+    subject(:index_fields_display) { rendered.find("[itemprop=description]").text }
+
     context "with multi-valued field" do
       it "each value is separated by comma" do
-        expect(rendered_index_text).to include(multi_valued_text)
+        expect(index_fields_display).to include(multi_valued_text)
       end
     end
     context "with document fields not configured as index field" do
       it "does not render" do
-        expect(rendered_index_text).not_to include(document["non_index_field"])
+        expect(index_fields_display).not_to include(document["non_index_field"])
       end
     end
     context "with multiple document index fields present" do
       it "separates fields by period followed by a space" do
-        expect(rendered_index_text).to include(combined_fields)
+        expect(index_fields_display).to include(combined_fields)
       end
       context "with index field ending in period" do
         it "renders only 1 period" do
-          expect(rendered_index_text).to include(document["period"] + " ")
+          expect(index_fields_display).to include(document["period"] + " ")
         end
       end
     end
     context "with document empty configured index field" do
       it "does not render a period followed by a space" do
-        expect(rendered_index_text).not_to include(". .")
+        expect(index_fields_display).not_to include(". .")
       end
     end
   end

data/spec/components/geoblacklight/static_map_component_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::StaticMapComponent, type: :component do
+  let(:document) { SolrDocument.new(id: 1) }
+
+  subject(:rendered) do
+    render_inline(described_class.new(document: document))
+  end
+
+  before do
+    allow(document).to receive(:viewer_protocol).and_return("map")
+    allow(Settings).to receive(:SIDEBAR_STATIC_MAP).and_return(["map"])
+  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
+    end
+  end
+end

data/spec/components/geoblacklight/viewer_help_text_component_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::ViewerHelpTextComponent, type: :component do
+  let(:feature) { "viewer_protocol" }
+  let(:key) { "wms" }
+
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(feature, key))
+  end
+
+  context "when the help text exists for an existing viewer protocol" do
+    it "shows correct help text title for wms" do
+      expect(rendered).to have_text(I18n.t("geoblacklight.help_text.viewer_protocol.wms.title"))
+    end
+  end
+
+  context "when the help text is missing for a viewer protocol that exists" do
+    before do
+      allow(I18n).to receive(:exists?).and_return(false)
+    end
+
+    it "shows missing help text class" do
+      expect(render_inline_to_capybara_node(described_class.new(feature, key))).to have_css(".translation-missing")
+    end
+  end
+end

data/spec/components/geoblacklight/web_services_component_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Geoblacklight::WebServicesComponent, type: :component do
+  let(:document) { instance_double(SolrDocument, id: 123, wxs_identifier: "wxs_identifier") }
+  let(:ref) { instance_double(Geoblacklight::Reference, type: type, endpoint: "endpoint") }
+  let(:component) { described_class.new(document: document, ref: ref) }
+  subject(:rendered) do
+    render_inline_to_capybara_node(component)
+  end
+
+  context "when wms is rendered" do
+    let(:type) { "wms" }
+    it "shows the web mapping service and layers" do
+      expect(rendered).to have_text("Web Mapping Service (WMS)")
+      expect(rendered).to have_text("WMS layers")
+      expect(rendered).to have_css(".web-services-form")
+    end
+  end
+
+  context "when wfs is rendered" do
+    let(:type) { "wfs" }
+    it "shows the web mapping service and typeNames" do
+      expect(rendered).to have_text("Web Feature Service (WFS)")
+      expect(rendered).to have_text("WFS typeNames")
+      expect(rendered).to have_css(".web-services-form")
+    end
+  end
+
+  context "when iiif is rendered" do
+    let(:type) { "iiif" }
+    it "shows the service" do
+      expect(rendered).to have_text("International Image Interoperability Framework (IIIF)")
+      expect(rendered).to have_css(".web-services-form")
+    end
+  end
+
+  context "when non service is passed" do
+    let(:type) { "iiif2" }
+    it "shows nothing" do
+      expect(component.render?).to be false
+    end
+  end
+end

data/spec/controllers/download_controller_spec.rb

@@ -76,46 +76,23 @@ describe DownloadController, type: :controller do
         expect(response.body).to include "Your file file.tiff is ready for download"
       end
     end
-  end
-
-  describe "#hgl" do
-    let(:hgl_download) { instance_double(Geoblacklight::HglDownload) }
-
-    it "requests file" do
-      allow(hgl_download).to receive(:get).and_return("success")
-      allow(Geoblacklight::HglDownload).to receive(:new).and_return(hgl_download)
-
-      get :hgl, params: {id: "harvard-g7064-s2-1834-k3", email: "foo@example.com"}
-      expect(response).to have_http_status :ok
-    end
-
-    it "renders form" do
-      allow(Geoblacklight::HglDownload).to receive(:new).and_return(hgl_download)
-
-      get :hgl, params: {id: "harvard-g7064-s2-1834-k3"}
-      expect(response).to render_template("hgl")
-    end
 
-    context "when an error occurs while downloading a file" do
-      let(:exception) { Geoblacklight::Exceptions::ExternalDownloadFailed.new(url: nil) }
-
-      it "uses the default error message when the exception does not have a URL" do
-        allow(Geoblacklight::HglDownload).to receive(:new).and_raise(exception)
+    context "when requesting CSV files" do
+      let(:id) { "tufts-cambridgegrid100-04" }
+      let(:type) { "csv" }
+      let(:csv_download) { instance_double(Geoblacklight::CsvDownload) }
 
-        get :hgl, params: {id: "harvard-g7064-s2-1834-k3", email: "foo@example.com"}
-        expect(response.body).to include("danger")
-        expect(response.body).to include("Sorry, the requested file could not be downloaded")
+      before do
+        allow(csv_download).to receive(:get).and_return("file.csv")
+        allow(Geoblacklight::CsvDownload).to receive(:new).and_return(csv_download)
       end
-    end
 
-    context "when downloading the requested file fails" do
-      it "flashes the error message" do
-        allow(hgl_download).to receive(:get).and_return(nil)
-        allow(Geoblacklight::HglDownload).to receive(:new).and_return(hgl_download)
+      it "downloads the files and notifies the user" do
+        expect(Geoblacklight::CsvDownload).to receive(:new)
+        get :show, params: {id: id, type: type}
 
-        get :hgl, params: {id: "harvard-g7064-s2-1834-k3", email: "foo@example.com"}
-        expect(response.body).to include("danger")
-        expect(response.body).to include("Sorry, the requested file could not be downloaded")
+        expect(response.body).to include "success"
+        expect(response.body).to include "Your file file.csv is ready for download"
       end
     end
   end

data/spec/features/axe_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "axe-rspec"
+require "spec_helper"
+
+feature "Accessibility testing", js: true do
+  context "logged out tests" do
+    it "validates the home page" do
+      visit root_path
+      expect(page).to be_accessible
+    end
+
+    it "validates an item page" do
+      visit solr_document_path("tufts-cambridgegrid100-04")
+      expect(page).to be_accessible
+    end
+
+    it "validates an item page with relationships" do
+      visit solr_document_path("nyu_2451_34502")
+      sleep 5 # wait for relationships to be fully visible / faded in
+      expect(page).to be_accessible
+    end
+
+    it "validates an bookmarks page" do
+      visit solr_document_path("tufts-cambridgegrid100-04")
+      find(".checkbox.toggle-bookmark").click
+      visit bookmarks_path
+      expect(page).to be_accessible
+    end
+
+    it "validates the history page" do
+      visit "/search_history"
+      expect(page).to be_accessible
+      visit search_catalog_path({q: "index"})
+      visit "/search_history"
+      expect(page).to be_accessible
+    end
+  end
+
+  context "logged in tests" do
+    before do
+      sign_in
+    end
+
+    it "validates the home page" do
+      visit root_path
+      expect(page).to be_accessible
+    end
+
+    it "validates an item page" do
+      visit solr_document_path("princeton-02870w62c")
+      expect(page).to be_accessible
+    end
+
+    it "validates an bookmarks page" do
+      visit solr_document_path("nyu_2451_34502")
+      find(".checkbox.toggle-bookmark").click
+      visit "/bookmarks"
+      expect(page).to be_accessible
+    end
+  end
+
+  def be_accessible
+    be_axe_clean.excluding("#clover-viewer")
+  end
+end

data/spec/features/bookmarks_spec.rb

@@ -4,7 +4,7 @@ require "spec_helper"
 
 feature "Blacklight Bookmarks" do
   scenario "index has created bookmarks" do
-    visit solr_document_path "nyu-2451-34564"
+    visit solr_document_path "harvard-g7064-s2-1834-k3"
     click_button "Bookmark"
     visit bookmarks_path
     expect(page).to have_css ".document", count: 1

data/spec/features/citations_spec.rb

@@ -3,10 +3,14 @@
 require "spec_helper"
 
 feature "Blacklight Citation" do
-  scenario "index has created citations" do
-    sign_in
+  scenario "citations can be copied", js: true do
+    sign_in # NOTE: this seems to be required for clipboard permissions to be granted succesfully
+    page.driver.browser.add_permission("clipboard-read", "granted")
+    page.driver.browser.add_permission("clipboard-write", "granted")
     visit "/catalog/princeton-1r66j405w"
     click_link "Cite"
-    expect(page).to have_text "Copy Citation"
+    click_button "Copy Citation"
+    clip_text = page.evaluate_async_script("navigator.clipboard.readText().then(arguments[0])")
+    expect(clip_text).to include("Sanborn Map Company. Princeton, Mercer County, New Jersey.")
   end
 end