blacklight_allmaps 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4303c5d59179db61e16867a11549e7c4ef6f642b6732619c3a78967b0d089655
-  data.tar.gz: 5d294dc06d1b846b631d43c7af5ff30b93a79a27fff0b20ce8281d13a3a1d032
+  metadata.gz: b6dd1b81643cf47fb27e96e46ebd57783c7a276f0c62d4a955358eddaccaa2ba
+  data.tar.gz: 55425ab5cabddc7f09b8da4bf81a421c5fbbc57e9b5e5925a874750a285cb9e0
 SHA512:
-  metadata.gz: e3afe56c0665e20d189436302c1a37609a73d4b07d46c390a70e392f1bc7f2625e509f2e53ce35b338a272163836e343226778a3ffc71d973d3e4f67b8449ed7
-  data.tar.gz: ed11adf2ed33e2abf96747df563e91a85b2dacacb62fe71aa90e504d52eebfbb52c51b7abf189e4c2c52793fd3b581d3e503b2dba1094ff6f16f60bfe967aac7
+  metadata.gz: cb4bf70dcd2491554327acaae79c8fd8fa0ff0eff8fa4a32728f602090072a5ca59c961003db9f9847f4cdbac61c22cab8dfd7358f223b62b7209da72e32631b
+  data.tar.gz: 1fbab7b1404ff1ddb861df8163c2ac17e5f5105bad2e5947170032f0002363e5576656d39459504c584317e8df169e5e382a8efc47e3814dc3ffccc4987e53b3

data/README.md

@@ -1,6 +1,7 @@
 # Blacklight::Allmaps
 
 ![CI](https://github.com/bplmaps/blacklight-allmaps/actions/workflows/ci.yml/badge.svg) 
+[![Gem Version](https://img.shields.io/gem/v/blacklight_allmaps.svg)](https://github.com/bplmaps/blacklight-allmaps/releases)
 
 <img alt="Allmaps Logo" src="app/assets/images/blacklight/allmaps/allmaps-logo.svg" height="40px"/> <img alt="Blacklight Logo" src="app/assets/images/blacklight/allmaps/blacklight-logo.png" height="40px"/> <img alt="GeoBlacklight Logo" src="app/assets/images/blacklight/allmaps/geoblacklight-logo.png" height="40px"/>
 
@@ -11,7 +12,7 @@ A [Blacklight](https://projectblacklight.org/) / [GeoBlacklight](https://geoblac
 ## Dependencies
 
 * Blacklight v7 (v8 forthcoming)
-* GeoBlacklight v4.1 (v4.2+ forthcoming)
+* GeoBlacklight v4.4+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -29,14 +30,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 +57,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 +67,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 +79,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 +119,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