blacklight_allmaps 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6dd1b81643cf47fb27e96e46ebd57783c7a276f0c62d4a955358eddaccaa2ba
-  data.tar.gz: 55425ab5cabddc7f09b8da4bf81a421c5fbbc57e9b5e5925a874750a285cb9e0
+  metadata.gz: 36ee8dcecb6fdfe204e03e183438a3a41e09dd802e6efaa42f2e865aacdef99b
+  data.tar.gz: ad4a15de994f88bae9597e26761d5ad4aceb7ddfd227a823b68287f44043f75b
 SHA512:
-  metadata.gz: cb4bf70dcd2491554327acaae79c8fd8fa0ff0eff8fa4a32728f602090072a5ca59c961003db9f9847f4cdbac61c22cab8dfd7358f223b62b7209da72e32631b
-  data.tar.gz: 1fbab7b1404ff1ddb861df8163c2ac17e5f5105bad2e5947170032f0002363e5576656d39459504c584317e8df169e5e382a8efc47e3814dc3ffccc4987e53b3
+  metadata.gz: 5699838093c01346ad2dd666d3c930b002fbd00aa65909441c184b8f6b0906957b2a1e0195dddde11502864583273580558ac593e4e10280be028bc01e1ea292
+  data.tar.gz: 5fe0001de0341c5289d3914b1df02ec8425e6fe88fa26c28f6b8976a241fca3186e5d82b336776c773d8fc1b215fa34484f021f1f14362daa6a09fcd66e01f88

data/.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec standardrb
+
+  test_blacklight:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [3.3]
+        rails_version: [7.1.3.2]
+
+    name: Test Blacklight / Ruby ${{ matrix.ruby_version }} / Rails ${{ matrix.rails_version }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - name: Create Solr container
+        run: docker run -d -p 8983:8983 geoblacklight/solr:8.9-v1.0.0 server/scripts/ci-start.sh
+      - name: Lock platform version
+        run: bundle lock --add-platform ruby
+      - name: Install dependencies
+        run: bundle install
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+          LIGHT: geoblacklight
+      - name: Setup Yarn
+        run: exec "yarnpkg"
+      - name: Load config into solr
+        run: |
+            cd solr/blacklight/conf
+            zip -1 -r solr_config.zip ./*
+            curl -H "Content-type:application/octet-stream" --data-binary @solr_config.zip "http://solr:SolrRocks@127.0.0.1:8983/solr/admin/configs?action=UPLOAD&name=blacklight"
+            curl -H 'Content-type: application/json' http://solr:SolrRocks@127.0.0.1:8983/api/collections/  -d '{create: {name: blacklight-core, config: blacklight, numShards: 1}}'
+      - name: Run tests
+        run: bundle exec rake ci
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+          ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+          SOLR_URL: http://solr:SolrRocks@localhost:8983/solr/blacklight-core
+          LIGHT: blacklight
+
+  test_geoblacklight:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [3.3]
+        rails_version: [7.1.3.2]
+
+    name: Test GeoBlacklight / Ruby ${{ matrix.ruby_version }} / Rails ${{ matrix.rails_version }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - name: Create Solr container
+        run: docker run -d -p 8983:8983 geoblacklight/solr:8.9-v1.0.0 server/scripts/ci-start.sh
+      - name: Lock platform version
+        run: bundle lock --add-platform ruby
+      - name: Install dependencies
+        run: bundle install
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+          LIGHT: geoblacklight
+      - name: Setup Yarn
+        run: exec "yarnpkg"
+      - name: Load config into solr
+        run: |
+            cd solr/geoblacklight/conf
+            zip -1 -r solr_config.zip ./*
+            curl -H "Content-type:application/octet-stream" --data-binary @solr_config.zip "http://solr:SolrRocks@127.0.0.1:8983/solr/admin/configs?action=UPLOAD&name=blacklight"
+            curl -H 'Content-type: application/json' http://solr:SolrRocks@127.0.0.1:8983/api/collections/  -d '{create: {name: blacklight-core, config: blacklight, numShards: 1}}'
+      - name: Run tests
+        run: bundle exec rake ci
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+          ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+          SOLR_URL: http://solr:SolrRocks@localhost:8983/solr/blacklight-core
+          LIGHT: geoblacklight

data/.gitignore

@@ -0,0 +1,20 @@
+.ruby-version
+*.gem
+Gemfile.lock
+/.bundle/
+/log/*.log
+/pkg/
+/tmp/
+
+.internal_test_app
+
+# Setup local JavaScript ignores
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+yarn.lock
+
+node_modules
+package-lock.json
+dist

data/.standard.yml

@@ -0,0 +1 @@
+format: progress

data/Gemfile

@@ -0,0 +1,50 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in blacklight_allmaps.gemspec.
+gemspec
+
+group :test do
+  gem "capybara", require: false
+  gem "engine_cart", require: false
+  gem "factory_bot_rails", require: false
+  gem "rails-controller-testing", require: false
+  gem "rspec-rails", require: false
+  gem "standardrb", require: false
+  gem "webdrivers", require: false
+end
+
+# Start debugger with binding.b [https://github.com/ruby/debug]
+# gem "debug", ">= 1.0.0"
+
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 2.6.0
+# engine_cart stanza: 2.5.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path("Gemfile", ENV["ENGINE_CART_DESTINATION"] || ENV["RAILS_ROOT"] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn "[EngineCart] Skipping Rails application dependencies:"
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV["RAILS_VERSION"]
+    if ENV["RAILS_VERSION"] == "edge"
+      gem "rails", github: "rails/rails"
+      ENV["ENGINE_CART_RAILS_OPTIONS"] = "--edge --skip-turbolinks"
+    else
+      gem "rails", ENV["RAILS_VERSION"]
+    end
+  end
+end
+
+if File.exist?("spec/test_app_templates/Gemfile.extra")
+  # rubocop:disable Security/Eval
+  eval File.read("spec/test_app_templates/Gemfile.extra"), nil, "spec/test_app_templates/Gemfile.extra"
+  # rubocop:enable Security/Eval
+end
+# END ENGINE_CART BLOCK

data/README.md

@@ -36,6 +36,27 @@ LIGHT=blacklight bundle exec rails generate blacklight:allmaps:install
 LIGHT=geoblacklight bundle exec rails generate blacklight:allmaps:install
 ```
 
+## CatalogController Configuration
+
+Configure options for local use are set into the `catalog_controller.rb` file. 
+
+### Blacklight
+
+```ruby
+    # Blacklight::Allmaps Viewer
+    config.show.partials.insert(1, :blacklight_allmaps)
+    config.default_solr_unique_key = "id"
+    config.default_georeferenced_field = "bl_georeferenced_bsi"
+    config.default_iiif_manifest_field = "iiif_manifest_url_ssi"
+```
+
+### GeoBlacklight
+```ruby
+    # Blacklight::Allmaps Viewer
+    config.default_solr_unique_key = "id"
+    config.default_georeferenced_field = "gbl_georeferenced_b"
+```
+
 ## Rake Tasks
 
 ### Seed Fixtures
@@ -61,6 +82,13 @@ The rake task here kicks off a background harvest process that walks through you
 rake blacklight_allmaps:sidecars:harvest:allmaps
 ```
 
+Alternatively, you can harvest Allmaps data for a list of identifers
+
+```bash
+# For Blacklight or GeoBlacklight
+rake "blacklight_allmaps:sidecars:harvest_ids[id1 id2 ...]"
+```
+
 ### Populate the Georeferenced Facet
 
 We expose the georeferenced items in the Blacklight user interface via a Georeferenced facet:
@@ -68,11 +96,8 @@ We expose the georeferenced items in the Blacklight user interface via a Georefe
 ![Screen shot](doc/georeferenced_facet.png)
 
 ```bash
-# For Blacklight...
-LIGHT=blacklight rake blacklight_allmaps:index:bl_georeferenced_facet
-
-# For GeoBlacklight...
-LIGHT=geoblacklight rake blacklight_allmaps:index:gbl_georeferenced_facet
+# For Blacklight or GeoBlacklight
+rake blacklight_allmaps:index:georeferenced_facet
 ```
 
 ## ActiveRecord Objects — Blacklight::Allmaps::Sidecar 
@@ -81,7 +106,8 @@ Blacklight::Allmaps adopts the SolrDocumentSidecar "sidecar" pattern from [Spotl
 
 We use this `document.sidecar_allmaps` object to hold the results of the Allmaps Annotation harvest task.
 
-The Blacklight::Allmaps::Sidecar object contains:
+The `Blacklight::Allmaps::Sidecar` object contains:
+
 | Field | Value |
 | --- | --- |
 | id | primary key |
@@ -115,6 +141,21 @@ document.sidecar_allmaps =>
  updated_at: Tue, 26 Mar 2024 16:39:42.427682000 UTC +00:00>
 ```
 
+## Allmaps::AnnotationsController
+
+We've added an annotations controller to the application to expose the `Blacklight::Allmaps::Sidecar` data we've harvested. This controller returns only JSON. 
+
+The `#fetch` method will query Allmaps in real time for updated annotation data, should a nightly harvest (rake) be insufficient for Solr indexing or local development needs.
+
+```
+Routes for Blacklight::Allmaps::Engine:
+fetch_allmaps_annotation GET   /allmaps/annotations/:id/fetch(.:format) allmaps/annotations#fetch {:format=>:json}
+     allmaps_annotations GET   /allmaps/annotations(.:format)           allmaps/annotations#index {:format=>:json}
+      allmaps_annotation GET   /allmaps/annotations/:id(.:format)       allmaps/annotations#show {:format=>:json}
+                         PATCH /allmaps/annotations/:id(.:format)       allmaps/annotations#update {:format=>:json}
+                         PUT   /allmaps/annotations/:id(.:format)       allmaps/annotations#update {:format=>:json}
+```
+
 ## Contributing
 
 For Developer documentation see [doc/developer.md](./doc/development.md)

data/Rakefile

@@ -1,12 +1,16 @@
+require "rails"
 require "rake"
 require "bundler"
+
 Bundler::GemHelper.install_tasks
 
+require "bundler/setup"
 require "bundler/gem_tasks"
 
 require "rspec/core/rake_task"
 require "engine_cart/rake_task"
 require "solr_wrapper"
+require "solr_wrapper/rake_task"
 require "blacklight/allmaps/rake_task"
 
 task default: :ci

data/app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.esm.js

@@ -26771,6 +26771,47 @@ function initializeBlacklightMap() {
 }
 // app/javascript/blacklight/allmaps/initialize_blacklight_map.js
 
+// update_georef_links.js
+const updateGeorefLinks = async () => {
+  const sidebarElement = document.getElementById('allmaps-sidebar');
+  if (sidebarElement) {
+    const manifestUrl = sidebarElement.getAttribute('data-iiif-manifest');
+    const documentId = sidebarElement.getAttribute('data-document-id');
+    const georefDiv = document.getElementById('georeferencing');
+    const annotationUrlByIIIFUri = `https://annotations.allmaps.org/?url=${manifestUrl}`;
+
+    try {
+      const response = await fetch(annotationUrlByIIIFUri);
+      if (!response.ok) {
+        georefDiv.innerHTML = `<a href="https://editor.allmaps.org/#/collection?url=${manifestUrl}" target="_blank">Georeference this item</a>`;
+
+        const csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute("content");
+        fetch(`/allmaps/annotations/${documentId}`, {
+          method: "PUT",
+          headers: {
+            "X-CSRF-Token": csrfToken,
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+          }
+        })
+        .then(response => response.json())
+        .then(data => console.log(data))
+        .catch(error => console.error(error));
+
+      } else {
+        const annotationUrl = response.url;
+        georefDiv.innerHTML = `<a href="https://viewer.allmaps.org/?url=${annotationUrl}" target="_blank">View this georeferenced item</a>`;
+      }
+    } catch (error) {
+      console.error("Fetch error:", error);
+    }
+  }
+};
+
 initializeGeoBlacklightMap();
 initializeBlacklightMap();
+
+document.addEventListener('DOMContentLoaded', () => {
+  updateGeorefLinks();
+});
 //# sourceMappingURL=blacklight-allmaps.esm.js.map