blacklight_allmaps 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4303c5d59179db61e16867a11549e7c4ef6f642b6732619c3a78967b0d089655
-  data.tar.gz: 5d294dc06d1b846b631d43c7af5ff30b93a79a27fff0b20ce8281d13a3a1d032
+  metadata.gz: 68d2d44ebaeae3f57846f37606e6a576e06a50d452e629cc715fbaf68a307f59
+  data.tar.gz: 61c1cb052866a522abe1e743da1e15d483e86ee96550f7081bacdb491f69c83c
 SHA512:
-  metadata.gz: e3afe56c0665e20d189436302c1a37609a73d4b07d46c390a70e392f1bc7f2625e509f2e53ce35b338a272163836e343226778a3ffc71d973d3e4f67b8449ed7
-  data.tar.gz: ed11adf2ed33e2abf96747df563e91a85b2dacacb62fe71aa90e504d52eebfbb52c51b7abf189e4c2c52793fd3b581d3e503b2dba1094ff6f16f60bfe967aac7
+  metadata.gz: 62f5d6a8a91d32fe95b3f205e31eb1a9d92776239aae871d8984feb65660b8bd4e6ba9133fde12bd49a1cee547eae5bef894e013aa54672853cef08be3a9278b
+  data.tar.gz: 49efe24708e9ca9e04308a591e82e7e48baf85b4c4ef5fc4b2e650ce53024e5ad86ff8510a90fb1dd86d7a0a2602b9f68a82cec9854afb0470d6b7b0dc86be51

data/README.md

@@ -29,14 +29,26 @@ Run the install generator:
 
 ```bash
 # For Blacklight...
-LIGHT=blacklight bundle exec rake blacklight:allmaps:install
+LIGHT=blacklight bundle exec rails generate blacklight:allmaps:install
 
 # For GeoBlacklight
-LIGHT=geoblacklight bundle exec rake blacklight:allmaps:install
+LIGHT=geoblacklight bundle exec rails generate blacklight:allmaps:install
 ```
 
 ## Rake Tasks
 
+### Seed Fixtures
+
+To populate Solr with some example data, you can run these tasks
+
+```bash
+# For Blacklight...
+LIGHT=blacklight rake blacklight_allmaps:index:bl_fixtures
+
+# For GeoBlacklight...
+LIGHT=geoblacklight rake rake blacklight_allmaps:index:gbl_fixtures
+```
+
 ### Harvest Allmaps IIIF Annotation Data
 
 We harvest and store Allmaps IIIF Annotation data locally — see the Blacklight::Allmaps::Sidecar section below.
@@ -44,6 +56,7 @@ We harvest and store Allmaps IIIF Annotation data locally — see the Blacklight
 The rake task here kicks off a background harvest process that walks through your Solr index documents (using CursorMark) and checks each document for `georeferenceable?` - the presence of a IIIF Manifest. If the document is indeed georeferenceable? (true) we ping the Allmaps API to determine if the map/item has already been georeferenced in Allmaps.
 
 ```bash
+# For Blacklight or GeoBlacklight
 rake blacklight_allmaps:sidecars:harvest:allmaps
 ```
 
@@ -53,13 +66,11 @@ We expose the georeferenced items in the Blacklight user interface via a Georefe
 
 ![Screen shot](doc/georeferenced_facet.png)
 
-#### Blacklight
-
-@TODO
-
-#### GeoBlacklight
-
 ```bash
+# For Blacklight...
+LIGHT=blacklight rake blacklight_allmaps:index:bl_georeferenced_facet
+
+# For GeoBlacklight...
 LIGHT=geoblacklight rake blacklight_allmaps:index:gbl_georeferenced_facet
 ```
 
@@ -67,22 +78,26 @@ LIGHT=geoblacklight rake blacklight_allmaps:index:gbl_georeferenced_facet
 
 Blacklight::Allmaps adopts the SolrDocumentSidecar "sidecar" pattern from [Spotlight](https://github.com/projectblacklight/spotlight), adding an ActiveRecord object to the database for each SolrDocument object in the index.
 
-The Blacklight::Allmaps::Sidecar object contains:
+We use this `document.sidecar_allmaps` object to hold the results of the Allmaps Annotation harvest task.
 
-* id: primary key
-* solr_document_id: solr document primary key
-* document_type SolrDocument
-* manifest_id: IIIF Manifest ID
-* annotated: boolean (true|false)
-* allmaps_id: Allmaps ID
-* iiif_manifest: Copy of the IIIF Manifest
-* allmaps_annotation: Copy of the Allmaps IIIF Annotation
-* solr_version: solr document version number
-* created_at: created at
-* updated_at: updated at
+The Blacklight::Allmaps::Sidecar object contains:
+| Field | Value |
+| --- | --- |
+| id | primary key |
+| solr_document_id | solr document primary key |
+| document_type | SolrDocument |
+| manifest_id | IIIF Manifest ID |
+| annotated | boolean (true\|false) |
+| allmaps_id | Allmaps ID |
+| iiif_manifest | Copy of the IIIF Manifest |
+| allmaps_annotation | Copy of the Allmaps IIIF Annotation |
+| solr_version | solr document version number |
+| created_at | timestamp |
+| updated_at | timestamp |
 
 ```ruby
-document.sidecar =>
+document = SolrDocument.find('harvard-g4124-m2-1855-m3')
+document.sidecar_allmaps =>
 #<Blacklight::Allmaps::Sidecar:0x0000000141991a50
  id: 1,
  solr_document_id: "harvard-g4124-m2-1855-m3",
@@ -103,7 +118,5 @@ document.sidecar =>
 
 For Developer documentation see [doc/developer.md](./doc/development.md)
 
-Additional Contribution directions to come...
-
 ## License
 The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/license/apache-2-0).

data/Rakefile

@@ -40,7 +40,8 @@ namespace :blacklight_allmaps do
       end
 
       # Harvest Allmaps data
-      system "rake blacklight_allmaps:sidecars:harvest:allmaps"
+      # rake db:fixtures:load (if necessary)
+      # system "rake blacklight_allmaps:sidecars:harvest:allmaps"
     end
   end
 

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

@@ -16,34 +16,36 @@
     </ul>
 
     <div class="tab-content mt-3">
-      <div class="tab-pane fade show active" id="item-viewer-tab" role="tabpanel" aria-labelledby="item-viewer-tab">
-        <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
-          <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
-        <% end %>
+      <div class="tab-pane active" id="item-viewer-tab" role="tabpanel" aria-labelledby="item-viewer-tab">
+        <div id="viewer-wrapper">
+          <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
+            <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
+          <% end %>
 
-        <% if document.item_viewer.index_map %>
-          <div class="index-map-legend">
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-default"></span>
-              <p><span class="sr-only">Green tile indicates </span>Map held by collection</p>
+          <% if document.item_viewer.index_map %>
+            <div class="index-map-legend">
+              <div class="index-map-legend-info">
+                <span class="index-map-legend-default"></span>
+                <p><span class="sr-only">Green tile indicates </span>Map held by collection</p>
+              </div>
+              <div class="index-map-legend-info">
+                <span class="index-map-legend-unavailable"></span>
+                <p><span class="sr-only">Yellow tile indicates </span>Map not held by collection</p>
+              </div>
+              <div class="index-map-legend-info">
+                <span class="index-map-legend-selected"></span>
+                <p><span class="sr-only">Blue tile indicates </span>Selected map tile</p>
+              </div>
             </div>
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-unavailable"></span>
-              <p><span class="sr-only">Yellow tile indicates </span>Map not held by collection</p>
-            </div>
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-selected"></span>
-              <p><span class="sr-only">Blue tile indicates </span>Selected map tile</p>
-            </div>
-          </div>
-        <% end %>
+          <% end %>
 
-        <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-geom' => document.geometry.geojson, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
-        <% end %>
+          <%= 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>
       
       <% if document.sidecar_allmaps.georeferenced? %>
-        <div class="tab-pane fade" id="georeferenced-tab" role="tabpanel" aria-labelledby="georeferenced-tab">
+        <div class="tab-pane" id="georeferenced-tab" role="tabpanel" aria-labelledby="georeferenced-tab">
           <%= render partial: 'allmaps/show/geoblacklight', locals: { document: document } %>
         </div>
       <% end %>

data/db/migrate/{20240307155110_create_solr_document_sidecars.rb → 20240307155110_create_solr_document_sidecar_allmaps.rb}

@@ -1,4 +1,4 @@
-class CreateSolrDocumentSidecars < ActiveRecord::Migration[7.0]
+class CreateSolrDocumentSidecarAllmaps < ActiveRecord::Migration[7.0]
   def change
     create_table :blacklight_allmaps_sidecars do |t|
       t.string :solr_document_id, index: true

data/lib/blacklight/allmaps/tasks/index.rake

@@ -6,15 +6,14 @@ namespace :blacklight_allmaps do
   namespace :index do
     desc "Index - add Allmaps fixture data to Blacklight solr"
     task :bl_fixtures do
-      # @TODO: JSON works when pasted into Solr, but fails here?
-      docs = Dir["spec/fixtures/solr_documents/bl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
+      docs = Dir["#{Blacklight::Allmaps.root}/spec/fixtures/solr_documents/blacklight/bl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
       Blacklight.default_index.connection.add docs
       Blacklight.default_index.connection.commit
     end
 
     desc "Index - add Allmaps fixture data to GeoBlacklight solr"
     task :gbl_fixtures do
-      docs = Dir["spec/fixtures/solr_documents/gbl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
+      docs = Dir["#{Blacklight::Allmaps.root}/spec/fixtures/solr_documents/geoblacklight/gbl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
       Blacklight.default_index.connection.add docs
       Blacklight.default_index.connection.commit
     end
@@ -44,7 +43,7 @@ namespace :blacklight_allmaps do
         response["response"]["docs"].each do |doc|
           # 2. Determine which documents have georeferenced data
           solr_document = SolrDocument.find(doc["id"])
-          if solr_document.sidecar.present? && solr_document.sidecar.annotated?
+          if solr_document.sidecar_allmaps.present? && solr_document.sidecar_allmaps.annotated?
 
             # 3. Clean JSON for re-indexing
             keys_for_deletion = %w[
@@ -73,5 +72,55 @@ namespace :blacklight_allmaps do
       end
       Blacklight.default_index.connection.commit
     end
+
+    desc "Index - add Allmaps facet data to Blacklight solr"
+    task bl_georeferenced_facet: [:environment] do
+      # Steps
+      # 1. Use cursor to paginate all documents in Solr
+      # 2. Determine which documents have georeferenced data
+      # 3. Clean JSON for re-indexing
+      # 4. Add bl_georeferenced_bsi values
+      # 5. Re-index the georeferenced documents
+
+      # 1. Get all the documents from Solr
+      cursor_mark = "*"
+      loop do
+        response = Blacklight.default_index.connection.get(
+          "select", params: {
+            q: "*:*", # all docs
+            fl: "*",  # all fields
+            cursorMark: cursor_mark, # use the cursor mark to handle paging
+            rows: 1000,
+            sort: "id asc" # must sort by id to use the cursor mark
+          }
+        )
+
+        response["response"]["docs"].each do |doc|
+          # 2. Determine which documents have georeferenced data
+          solr_document = SolrDocument.find(doc["id"])
+          if solr_document.sidecar_allmaps.present? && solr_document.sidecar_allmaps.annotated?
+
+            # 3. Clean JSON for re-indexing
+            keys_for_deletion = %w[
+              _version_
+              timestamp
+            ]
+
+            cleaned_doc = doc.except!(*keys_for_deletion)
+
+            # 4. Add gbl_georeferenced_b value
+            # @TODO: add allmaps_id?
+            cleaned_doc["bl_georeferenced_bsi"] = true
+
+            # 5. Re-index the georeferenced documents
+            Blacklight.default_index.connection.add cleaned_doc
+          end
+        end
+
+        break if response["nextCursorMark"] == cursor_mark # this means the result set is finished
+        cursor_mark = response["nextCursorMark"]
+      end
+      Blacklight.default_index.connection.commit
+    end
   end
 end

data/lib/blacklight/allmaps/version.rb

@@ -1,5 +1,14 @@
 module Blacklight
   module Allmaps
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
+
+    def self.version
+      @version ||= VERSION
+    end
+
+    # returns the full path the the plugin installation
+    def self.root
+      @root ||= File.expand_path(File.dirname(__FILE__, 4))
+    end
   end
 end

data/lib/blacklight/allmaps.rb

@@ -3,5 +3,6 @@ require "blacklight"
 module Blacklight
   module Allmaps
     require "blacklight/allmaps/engine"
+    require "blacklight/allmaps/version"
   end
 end

data/lib/generators/blacklight/allmaps/config_generator.rb

@@ -16,13 +16,21 @@ module Blacklight
         copy_file "manifest.js", "app/assets/config/manifest.js", force: true
       end
 
+      def add_assets_initialier
+        append_to_file "config/initializers/assets.rb" do
+          "
+          # Blacklight Allmaps
+          Rails.application.config.assets.precompile += %w( blacklight/allmaps/allmaps-logo.svg )"
+        end
+      end
+
       def copy_rake_tasks
         append_to_file "Rakefile", "require 'blacklight/allmaps/rake_task'\n"
       end
 
       def prioritize_blacklight_allmaps_views
-        inject_into_file "config/application.rb", "\nrequire \"blacklight/allmaps/engine\"\n", after: "require \"action_cable/engine\""
-        inject_into_file "config/application.rb", "\nconfig.railties_order = [Blacklight::Allmaps::Engine, :main_app, :all]\n", after: "class Application < Rails::Application\n"
+        inject_into_file "config/application.rb", "\nrequire \"blacklight/allmaps/engine\"\n", before: "# Require the gems listed in Gemfile"
+        inject_into_file "config/application.rb", "\n    config.railties_order = [Blacklight::Allmaps::Engine, :main_app, :all]\n", after: "class Application < Rails::Application\n"
       end
 
       def add_importmap_pins
@@ -49,6 +57,13 @@ module Blacklight
           "\n include Blacklight::Allmaps::SolrDocument"
         end
       end
+
+      def add_bl_georeferenced_facet
+        return unless ENV["LIGHT"] == "blacklight"
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.add_facet_field 'subject_era_ssim', label: 'Era'" do
+          "\n    config.add_facet_field 'bl_georeferenced_bsi', label: 'Georeferenced'"
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_allmaps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Larson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -190,7 +190,7 @@ files:
 - app/views/catalog/_show_sidebar_blacklight.html.erb
 - app/views/catalog/_show_sidebar_geoblacklight.html.erb
 - config/routes.rb
-- db/migrate/20240307155110_create_solr_document_sidecars.rb
+- db/migrate/20240307155110_create_solr_document_sidecar_allmaps.rb
 - lib/blacklight/allmaps.rb
 - lib/blacklight/allmaps/engine.rb
 - lib/blacklight/allmaps/rake_task.rb