blacklight_allmaps 0.2.0 → 0.4.0

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Blacklight
+  module Allmaps
+    class BlacklightGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc <<-DESCRIPTION
+        This generator makes the following changes to your application:
+        1. Copies stylesheets to Blacklight app
+        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
+        append_to_file "app/assets/stylesheets/blacklight.scss" do
+          "@import 'blacklight/allmaps/base';"
+        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
+    # 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\""
+        end
+      end
+
+      def add_bl_georeferenced_facet
+        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: I18n.t('allmaps.bl_facet_label')"
+        end
+      end
+
+      def include_blacklight_allmaps_solrdocument
+        inject_into_file "app/models/solr_document.rb", after: "include Blacklight::Solr::Document" do
+          "\n include Blacklight::Allmaps::SolrDocument"
+        end
+      end
+    end
+  end
+end

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,69 +50,21 @@ 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_bl_stylesheets
-        return unless ENV["LIGHT"] == "blacklight"
-        append_to_file "app/assets/stylesheets/blacklight.scss" do
-          "@import 'blacklight/allmaps/base';"
-        end
+      def add_yarn_package
+        run "yarn add blacklight-allmaps"
       end
 
-      def add_gbl_stylesheets
-        return unless ENV["LIGHT"] == "geoblacklight"
-        append_to_file "app/assets/stylesheets/application.scss" do
-          "@import 'blacklight/allmaps/base';"
-        end
+      def set_routes
+        inject_into_file "config/routes.rb", "mount Blacklight::Allmaps::Engine => '/'\n", before: /^end/
       end
 
       def set_active_job_config
         inject_into_file "config/environments/development.rb", "  config.active_job.queue_adapter = :inline\n", after: "Rails.application.configure do\n"
       end
-
-      def add_geoblacklight
-        return unless ENV["LIGHT"] == "geoblacklight"
-        append_to_file "Gemfile", '"geoblacklight", "~> 4.4"'
-      end
-
-      def include_blacklight_allmaps_solrdocument
-        return unless ENV["LIGHT"] == "blacklight"
-        inject_into_file "app/models/solr_document.rb", after: "include Blacklight::Solr::Document" do
-          "\n include Blacklight::Allmaps::SolrDocument"
-        end
-      end
-
-      def add_gbl_tabbed_viewer
-        return unless ENV["LIGHT"] == "geoblacklight"
-        # Use the tabbed viewer
-        inject_into_file "app/controllers/catalog_controller.rb", after: "config.show.partials << \"show_default_viewer_container\"" do
-          "\n
-    # Blacklight::Allmaps Tabbed Viewer
-    config.show.partials << \"show_allmaps_tabbed_viewer_container\""
-        end
-
-        # Remove the default viewer
-        gsub_file("app/controllers/catalog_controller.rb", "config.show.partials << \"show_default_viewer_container\"", "#config.show.partials << \"show_default_viewer_container\"")
-      end
-
-      def add_bl_allmaps_viewer
-        return unless ENV["LIGHT"] == "blacklight"
-        # Use the allmaps viewer
-        inject_into_file "app/controllers/catalog_controller.rb", after: "#config.show.thumbnail_field = 'thumbnail_path_ss'" do
-          "\n
-    # Blacklight::Allmaps Viewer
-    config.show.partials.insert(1, :blacklight_allmaps)"
-        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: 'Allmaps Georeferenced'"
-        end
-      end
     end
   end
 end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Blacklight
+  module Allmaps
+    class GeoblacklightGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc <<-DESCRIPTION
+        This generator makes the following changes to your application:
+        1. Adds stylesheets to application.scss
+        2. Adds GeoBlacklight to Gemfile
+        3. Adds Blacklight::Allmaps configuration to CatalogController
+        4. Adds Blacklight::Allmaps Tabbed Viewer to CatalogController
+      DESCRIPTION
+
+      def add_gbl_stylesheets
+        append_to_file "app/assets/stylesheets/application.scss" do
+          "@import 'blacklight/allmaps/base';"
+        end
+      end
+
+      def add_geoblacklight
+        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
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.raw_endpoint.enabled = true" do
+          "\n
+    # Blacklight::Allmaps Viewer
+    config.default_solr_unique_key = \"id\"
+    config.default_georeferenced_field = \"gbl_georeferenced_b\""
+        end
+      end
+
+      def add_gbl_tabbed_viewer
+        # Use the tabbed viewer
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.show.partials << \"show_default_viewer_container\"" do
+          "\n
+    # Blacklight::Allmaps Tabbed Viewer
+    config.show.partials << \"show_allmaps_tabbed_viewer_container\""
+        end
+
+        # Remove the default viewer
+        gsub_file("app/controllers/catalog_controller.rb", "config.show.partials << \"show_default_viewer_container\"", "#config.show.partials << \"show_default_viewer_container\"")
+      end
+    end
+  end
+end

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

@@ -13,6 +13,16 @@ module Blacklight
         generate "blacklight:allmaps:config"
       end
 
+      def generate_blacklight_config
+        return unless ENV["LIGHT"] == "blacklight"
+        generate "blacklight:allmaps:blacklight"
+      end
+
+      def generate_geoblacklight_config
+        return unless ENV["LIGHT"] == "geoblacklight"
+        generate "blacklight:allmaps:geoblacklight"
+      end
+
       def generate_models
         generate "blacklight:allmaps:models"
       end

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":[]}

data/solr/blacklight/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/blacklight/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/blacklight/conf/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"

data/solr/blacklight/conf/protwords.txt

@@ -0,0 +1,21 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#-----------------------------------------------------------------------
+# Use a protected word file to protect against the stemmer reducing two
+# unrelated words to the same base word.
+
+# Some non-words that normally won't be encountered,
+# just to test that they won't be stemmed.
+dontstems
+zwhacky
+