blacklight_allmaps 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b77dce03fda3d3aab9db13861e8e1fc6b0dc8e39db47dcf75a8dc8ee34a27f2
-  data.tar.gz: 83e85dc411bcacefcb92b0b9b12701e778c58116e6cefda56768de040f0d7c50
+  metadata.gz: 36ee8dcecb6fdfe204e03e183438a3a41e09dd802e6efaa42f2e865aacdef99b
+  data.tar.gz: ad4a15de994f88bae9597e26761d5ad4aceb7ddfd227a823b68287f44043f75b
 SHA512:
-  metadata.gz: b182818f63f0e5a5fca137c8e7fbb8373a8e7955ffb93650a9fb0ccae01fbe2daaecedf29967c73bb5617c86cd92672653c67291bb3fe8244e0459180d4f205a
-  data.tar.gz: c9419afe74db352bdf7160b3900a856914b73f2171f9f13b0425dbe8087feb8b6142ccf78f000ec8dc4f545ce8064b938dec9452ee72a4417e37fd4ae0899b7b
+  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/app/assets/stylesheets/blacklight/allmaps/base.scss

@@ -1,9 +1,12 @@
 @charset "UTF-8";
 
 // Blacklight::Allmaps
+// Via NPM
 @import "leaflet";
 @import "leaflet.fullscreen";
-@import "leaflet.opacity";
+
+// Via 
+@import "modules/leaflet.opacity";
 
 #blacklight-allmaps-map { height: 400px; }
 #geoblacklight-allmaps-map { height: 400px; }

data/app/assets/stylesheets/blacklight/allmaps/modules/leaflet.opacity.css

@@ -0,0 +1,76 @@
+.leaflet-control.opacity-control {
+  background-color: #a9acb1;
+  border-radius: 15px;
+  color: black;
+  font: bold 18px 'Lucida Console', Monaco, monospace;
+  display: block;
+  height: 200px;
+  left: 11px;
+  position: relative;
+  top: 15px;
+  width: 5px;
+}
+.leaflet-control.opacity-control .opacity-handle {
+  background-color: #fff;
+  border-radius: 4px;
+  border: 1px solid #eee;
+  cursor: ns-resize;
+  font-size: 10px;
+  height: 26px;
+  left: -11px;
+  line-height: 26px;
+  position: absolute;
+  text-align: center;
+  top: 0;
+  width: 26px;
+}
+.leaflet-control.opacity-control .opacity-handle:hover {
+  background-color: #f4f4f4;
+}
+.leaflet-control.opacity-control .opacity-arrow-up {
+  color: #aaa;
+  position: absolute;
+  top: -11px;
+  text-align: center;
+  width: 100%;
+}
+.leaflet-control.opacity-control .opacity-arrow-up:before {
+  content: '=';
+}
+.leaflet-control.opacity-control .opacity-arrow-down {
+  bottom: -10px;
+  color: #aaa;
+  position: absolute;
+  text-align: center;
+  width: 100%;
+}
+.leaflet-control.opacity-control .opacity-arrow-down:before {
+  content: '=';
+}
+.leaflet-control.opacity-control .opacity-bottom {
+  background-color: #017afd;
+  border-radius: 15px;
+  display: block;
+  height: 137px;
+  left: 0px;
+  position: relative;
+  top: 63px;
+  width: 5px;
+}
+.leaflet-control.opacity-control .opacity-area {
+  padding: 14px;
+  cursor: default;
+  height: 200px;
+  left: -11px;
+  position: absolute;
+  top: 0px;
+  width: 20px;
+}
+.opacity-control.unselectable {
+  -webkit-touch-callout: none;
+  -webkit-user-select: none;
+  -khtml-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}

data/app/jobs/blacklight/allmaps/store_sidecar_annotation.rb

@@ -10,6 +10,9 @@ module Blacklight
         sidecar = solr_document.sidecar_allmaps
 
         if ApplicationController.helpers.georeferenceable?(solr_document)
+          # Sleep for a random amount of time to crawl politely
+          sleep(rand(1..5))
+
           # Store the IIIF Manifest
           response = HTTParty.get(solr_document.iiif_manifest_url, follow_redirects: true)
           if response.code == 200

data/blacklight_allmaps.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blacklight/allmaps/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "blacklight_allmaps"
+  spec.version = Blacklight::Allmaps::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Eric Larson"]
+  spec.email = ["ewlarson@gmail.com"]
+  spec.homepage = "https://github.com/bplmaps/blacklight-allmaps"
+  spec.summary = "Blacklight::Allmaps plugin"
+  spec.description = "Description of Blacklight::Allmaps"
+  spec.license = "Apache 2.0"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.add_dependency "blacklight", ">= 7.25.2", "< 9"
+  spec.add_dependency "httparty", "~> 0.20"
+
+  spec.add_development_dependency "solr_wrapper"
+  spec.add_development_dependency "rails-controller-testing"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "engine_cart", "~> 2.1"
+  spec.add_development_dependency "factory_bot_rails"
+  spec.add_development_dependency "capybara", "~> 3"
+  spec.add_development_dependency "webdrivers"
+  spec.add_development_dependency "standard", "~> 1.34"
+  spec.add_development_dependency "sqlite3"
+end

data/doc/development.md

@@ -0,0 +1,72 @@
+# Development Notes
+
+## Running the Application
+
+### Blacklight / MARC
+
+IIIF Manifest URI is likely in 856 4#$u
+https://www.loc.gov/marc/bibliographic/bd856.html
+
+Solr Field: iiif_manifest_url_ssi (from Spotlight fixtures)
+Georeferenced Field: georeferenced_bsi (Blacklight dynamicField Schema)
+
+@TODO: Use mods_xml_ssm instead of marc_ss?
+
+#### TERMINAL 1 / Run Solr
+
+```
+bundle exec rake engine_cart:clean
+LIGHT=blacklight bundle exec rake blacklight_allmaps:solr
+```
+
+#### TERMINAL 2 / Index
+```
+cd .internal_test_app
+rake blacklight_allmaps:index:bl_fixtures
+rake blacklight_allmaps:sidecars:harvest:allmaps
+rake blacklight_allmaps:index:georeferenced_facet
+rails s
+```
+
+### GeoBlacklight / Aardvark Schema
+
+IIIF Manifest URI is in dct_references_s
+https://opengeometadata.org/ogm-aardvark/#references
+Key: http://iiif.io/api/presentation#manifest
+
+Solr Field: dct_references_s
+Georeferenced Field: gbl_georeferenced_b (Aardvark Schema)
+
+#### TERMINAL 1 / Run Solr
+```
+bundle exec rake engine_cart:clean
+LIGHT=geoblacklight bundle exec rake blacklight_allmaps:solr
+```
+
+#### TERMINAL 2 / Index, Harvest, Facet
+```
+cd .internal_test_app
+rake blacklight_allmaps:index:gbl_fixtures
+rake blacklight_allmaps:sidecars:harvest:allmaps
+rake blacklight_allmaps:index:georeferenced_facet
+rails s
+```
+
+## Building the Javascript / Publishing the NPM Package
+
+The javascript is built by npm from sources in `app/javascript` into a bundle
+in `app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.js`. This file should not be edited by hand as any changes would be overwritten.  When any of the javascript
+components in the gem are changed, this bundle should be rebuild with the
+following steps:
+1. [Install npm](https://www.npmjs.com/get-npm)
+1. run `npm install` to download dependencies
+1. run `npm run prepare` to build the bundle
+1. run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-allmaps
+
+## Running the Test suite
+
+```LIGHT=blacklight bundle exec rake ci```
+
+or 
+
+```LIGHT=geoblacklight bundle exec rake ci```

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "blacklight"
+require "blacklight/allmaps/version"
 
 namespace :blacklight_allmaps do
   namespace :index do

data/lib/blacklight/allmaps/version.rb

@@ -1,6 +1,6 @@
 module Blacklight
   module Allmaps
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
 
     def self.version
       @version ||= VERSION

data/lib/blacklight/allmaps.rb

@@ -1,8 +1,16 @@
 require "blacklight"
+require "blacklight/allmaps/version"
+require "blacklight/allmaps/engine"
 
 module Blacklight
   module Allmaps
-    require "blacklight/allmaps/engine"
-    require "blacklight/allmaps/version"
+    def self.version
+      @version ||= VERSION
+    end
+
+    # returns the full path the the plugin installation
+    def self.root
+      @root ||= __dir__
+    end
   end
 end

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

@@ -10,9 +10,10 @@ module Blacklight
       desc <<-DESCRIPTION
         This generator makes the following changes to your application:
         1. Copies stylesheets to Blacklight app
-        2. Adds Blacklight::Allmaps configuration to CatalogController
-        3. Adds georeferenced facet to CatalogController
-        4. Includes Blacklight::Allmaps::SolrDocument in SolrDocument
+        2. Add yarn package
+        3. Adds Blacklight::Allmaps configuration to CatalogController
+        4. Adds georeferenced facet to CatalogController
+        5. Includes Blacklight::Allmaps::SolrDocument in SolrDocument
       DESCRIPTION
 
       def add_bl_stylesheets
@@ -21,6 +22,11 @@ module Blacklight
         end
       end
 
+      def add_yarn_package
+        copy_file "package.json", "package.json"
+        run "yarn install"
+      end
+
       def add_configuration
         inject_into_file "app/controllers/catalog_controller.rb", after: "#config.show.thumbnail_field = 'thumbnail_path_ss'" do
           "\n

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

@@ -20,6 +20,7 @@ module Blacklight
         append_to_file "config/initializers/assets.rb" do
           "
           # Blacklight Allmaps
+          Rails.application.config.assets.paths << Rails.root.join('node_modules')
           Rails.application.config.assets.paths << Rails.root.join('vendor', 'assets', 'images')
           Rails.application.config.assets.precompile += %w( blacklight/allmaps/allmaps-logo.svg )"
         end
@@ -40,6 +41,7 @@ module Blacklight
             pin "leaflet", to: "https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.js", preload: true
             pin "leaflet-fullscreen", to: "https://cdn.jsdelivr.net/npm/leaflet-fullscreen@1.0.2/dist/Leaflet.fullscreen.min.js", preload: true
             pin "@allmaps/leaflet", to: "https://cdn.jsdelivr.net/npm/@allmaps/leaflet/dist/bundled/allmaps-leaflet-1.9.umd.js", preload: true
+            pin_all_from File.expand_path("../app/javascript/blacklight/allmaps", __dir__), under: "blacklight-allmaps"
           CONTENT
         end
       end
@@ -48,10 +50,14 @@ module Blacklight
         inject_into_file "app/assets/javascripts/application.js", after: "//= require blacklight/blacklight" do
           "\n
     // Required by Blacklight::Allmaps
-    //= require blacklight/allmaps/blacklight-allmaps"
+    //= require blacklight-allmaps/app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.js"
         end
       end
 
+      def add_yarn_package
+        run "yarn add blacklight-allmaps"
+      end
+
       def set_routes
         inject_into_file "config/routes.rb", "mount Blacklight::Allmaps::Engine => '/'\n", before: /^end/
       end

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

@@ -22,7 +22,16 @@ module Blacklight
       end
 
       def add_geoblacklight
-        append_to_file "Gemfile", '"geoblacklight", "~> 4.4"'
+        gemfile_path = "Gemfile"
+
+        # Check if the 'geoblacklight' gem is already included in the Gemfile
+        if File.read(gemfile_path).include?("geoblacklight")
+          say_status("skipped", "geoblacklight gem already included in the Gemfile", :yellow)
+        else
+          append_to_file "Gemfile" do
+            "\ngem \"geoblacklight\", \"~> 4.4\""
+          end
+        end
       end
 
       def add_configuration

data/lib/generators/blacklight/allmaps/templates/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "blacklight-allmaps": "^0.3.1",
+    "leaflet": "^1.9.4"
+  }
+}

data/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "blacklight-allmaps",
+  "version": "0.3.1",
+  "description": "The frontend code and styles for Blacklight Allmaps",
+  "main": "app/assets/javascripts/blacklight/allmaps",
+  "module": "app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.esm.js",
+  "author": "Eric Larson",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepare": "rollup --config rollup.config.js --sourcemap && ESM=true rollup --config rollup.config.js --sourcemap"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bplmaps/blacklight-allmaps.git"
+  },
+  "files": [
+    "app/assets",
+    "app/javascript"
+  ],
+  "bugs": {
+    "url": "https://github.com/bplmaps/blacklight-allmaps/issues"
+  },
+  "homepage": "https://github.com/bplmaps/blacklight-allmaps#readme",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "rollup": "^2.60.0",
+    "rollup-plugin-includepaths": "^0.2.4"
+  },
+  "browserslist": [
+    "defaults",
+    "not IE 11"
+  ],
+  "dependencies": {
+    "@allmaps/leaflet": "^1.0.0-beta.33",
+    "blacklight-allmaps": "^0.3.1",
+    "leaflet": "^1.9.4",
+    "leaflet-fullscreen": "^1.0.2"
+  }
+}

data/rollup.config.js

@@ -0,0 +1,43 @@
+'use strict'
+
+import nodeResolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import includePaths from 'rollup-plugin-includepaths';
+
+const path = require('path')
+
+const BUNDLE = process.env.BUNDLE === 'true'
+const ESM = process.env.ESM === 'true'
+
+const fileDest = `blacklight-allmaps${ESM ? '.esm' : ''}`
+const external = []
+const globals = {}
+
+let includePathOptions = {
+  include: {},
+  paths: ['app/javascript'],
+  external: [],
+  extensions: ['.js']
+};
+
+const rollupConfig = {
+  input: path.resolve(__dirname, `app/javascript/blacklight/allmaps/index.js`),
+  output: {
+    file: path.resolve(__dirname, `app/assets/javascripts/blacklight/allmaps/${fileDest}.js`),
+    format: ESM ? 'esm' : 'umd',
+    globals,
+    generatedCode: 'es2015'
+  },
+  external,
+  plugins: [
+    includePaths(includePathOptions),
+    nodeResolve(),
+    commonjs()
+  ]
+}
+
+if (!ESM) {
+  rollupConfig.output.name = 'Blacklight'
+}
+
+module.exports = rollupConfig

data/solr/blacklight/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}