geoblacklight 4.3.0 → 4.4.0

data/app/assets/images/blacklight/northwestern-university.svg

@@ -0,0 +1,5 @@
+<!-- Generated by IcoMoon.io -->
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="33" height="32" viewBox="0 0 33 32">
+<title>northwestern-university</title>
+<path fill="#6c757d" d="M21.118 0.238v2.258l3.79 0.953 0.749 0.93v18.088l-18.984-22.468h-5.583v1.691l3.087 3.472v23.455l-4.176 1.169v1.974h11.972v-1.986l-3.711-0.987-0.76-0.942v-18.86l19.325 23.013h2.235v-28.437l4.199-1.271v-2.054z"></path>
+</svg>

data/app/javascript/index.js

@@ -0,0 +1,7 @@
+import OlInitializer from './openlayers/ol_initializer'
+import CloverInitializer from './clover/clover_initializer'
+
+export {
+  OlInitializer,
+  CloverInitializer
+}

data/app/javascript/stylesheets/openlayers.css

@@ -0,0 +1 @@
+@import "../../../node_modules/ol/ol.css";

data/config/locales/geoblacklight.en.yml

@@ -166,7 +166,8 @@ en:
       multilinestring: Multi-line string
       multipoint: Multi-point
       multipolygon: Multi-polygon
-      nebraska: University of Nebraska
+      nebraska: University of Nebraska-Lincoln
+      northwestern-university: Northwestern University
       nyu: New York University
       ohio-state: The Ohio State University
       penn-state: Penn State University

data/lib/generators/geoblacklight/install_generator.rb

@@ -5,9 +5,10 @@ require "rails/generators"
 module Geoblacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path("../templates", __FILE__)
-
     desc "Install Geoblacklight"
 
+    class_option :test, type: :boolean, default: false, aliases: "-t", desc: "Indicates that app will be installed in a test environment"
+
     def allow_geoblacklight_params
       gbl_params = <<-PARAMS
         before_action :allow_geoblacklight_params
@@ -116,28 +117,35 @@ module Geoblacklight
       copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb"
     end
 
-    # Run bundle with vite install
-    def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
-        run "bundle exec vite install"
+    def copy_package_json
+      if options[:test]
+        # If building engine cart test app, use specific package.json so the
+        # locally built frontend javascript is used instead of the npm package.
+        copy_file "package-test.json", "package.json"
+      else
+        copy_file "package.json", "package.json"
       end
     end
 
     # Vite - Config files
     def copy_config_vite_json
       copy_file "vite.json", "config/vite.json"
-      copy_file "vite.rb", "config/vite.rb"
       copy_file "vite.config.ts", "vite.config.ts"
-      copy_file "package.json", "package.json"
-
       run "yarn install"
     end
 
+    # Run bundle with vite install
+    def bundle_install
+      Bundler.with_clean_env do
+        run "bundle install"
+        run "bundle exec vite install"
+      end
+    end
+
     # Vite - Copy over the Vite entrypoints
     def copy_vite_entrypoints
-      copy_file "clover.js", "app/frontend/entrypoints/clover.js"
-      copy_file "ol.js", "app/frontend/entrypoints/ol.js"
+      copy_file "clover.js", "app/javascript/entrypoints/clover.js"
+      copy_file "ol.js", "app/javascript/entrypoints/ol.js"
     end
   end
 end

data/lib/generators/geoblacklight/templates/clover.js

@@ -1,4 +1,4 @@
-import CloverInitializer from '@gbl/clover/clover_initializer'
+import { CloverInitializer } from '@geoblacklight/frontend'
 
 document.addEventListener('DOMContentLoaded', () => {
   new CloverInitializer().run()

data/lib/generators/geoblacklight/templates/ol.js

@@ -1,4 +1,5 @@
-import OlInitializer from '@gbl/openlayers/ol_initializer'
+import '@geoblacklight/frontend/dist/style.css'
+import { OlInitializer } from '@geoblacklight/frontend'
 
 document.addEventListener('DOMContentLoaded', () => {
   new OlInitializer().run()

data/lib/generators/geoblacklight/templates/package-test.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "vite": "^5.1.5",
+    "vite-plugin-ruby": "^5.0.0",
+    "vite-plugin-rails": "^0.5.0"
+  },
+  "scripts": {
+    "postinstall": "yarn link @geoblacklight/frontend"
+  }
+}

data/lib/generators/geoblacklight/templates/package.json

@@ -1,4 +1,7 @@
 {
+  "dependencies": {
+    "@geoblacklight/frontend": "^4.4"
+  },
   "devDependencies": {
     "vite": "^5.1.5",
     "vite-plugin-ruby": "^5.0.0",

data/lib/generators/geoblacklight/templates/vite.config.ts

@@ -4,16 +4,5 @@ import rails from 'vite-plugin-rails'
 export default defineConfig({
   plugins: [
     rails(),
-  ],
-  // GeoBlacklight: Import assets from arbitrary paths.
-  resolve: {
-    alias: {
-      '@gbl/': `${process.env.GBL_ASSETS_PATH}/`,
-    },
-  },
-  server: {
-    fs: {
-      allow: [process.env.GBL_ASSETS_PATH!],
-    },
-  },
+  ]
 })

data/lib/generators/geoblacklight/templates/vite.json

@@ -1,6 +1,6 @@
 {
   "all": {
-    "sourceCodeDir": "app/frontend",
+    "sourceCodeDir": "app/javascript",
     "watchAdditionalPaths": []
   },
   "development": {

data/lib/geoblacklight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

data/package.json

@@ -1,8 +1,29 @@
 {
-  "name": "geoblacklight",
-  "version": "4.0.0",
-  "private": true,
+  "name": "@geoblacklight/frontend",
+  "type": "module",
+  "version": "4.4.6",
   "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "watch": "vite build --watch"
+  },
+  "files": ["dist"],
+  "main": "./dist/frontend.js",
+  "module": "./dist/frontend.umd.cjs",
+  "exports": {
+    ".": {
+      "import": "./dist/frontend.js",
+      "require": "./dist/frontend.umd.cjs"
+    },
+    "./dist/style.css": {
+      "import": "./dist/style.css",
+      "require": "./dist/style.css"
+    }
+  },
   "dependencies": {
     "@samvera/clover-iiif": "^2.3.2",
     "ol": "8.1.0",
@@ -10,7 +31,6 @@
     "react": "^18.2.0"
   },
   "devDependencies": {
-    "vite": "^5.0.0",
-    "vite-plugin-ruby": "^5.0.0"
+    "vite": "^5.0.0"
   }
 }

data/spec/features/full_screen_controll_spec.rb

@@ -17,6 +17,6 @@ end
 feature "Clover IIIF fullscreen control", js: true do
   scenario "IIIF layer should have full screen control" do
     visit solr_document_path("princeton-sx61dn82p")
-    expect(page).to have_css("#fullPage")
+    expect(page).to have_button("Toggle full page")
   end
 end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -21,14 +21,25 @@ class TestAppGenerator < Rails::Generators::Base
     end
   end
 
+  def build_frontend
+    run "yarn install && yarn build"
+  end
+
+  # Ensure local frontend build is linked so internal test app
+  # can use local javascript instead of npm package.
+  def link_frontend
+    run "yarn link"
+  end
+
   def run_blacklight_generator
     say_status("warning", "GENERATING BL", :yellow)
 
     generate "blacklight:install", "--devise"
   end
 
+  # Install geoblacklight with the `test` option
   def install_engine
-    generate "geoblacklight:install", "-f"
+    generate "geoblacklight:install", "-f --test"
   end
 
   # Symlink fixture document directories so the test app doesn't have to be

data/vite.config.ts

@@ -1,8 +1,24 @@
+import { resolve } from 'path'
 import { defineConfig } from 'vite'
-import RubyPlugin from 'vite-plugin-ruby'
+import { exec } from 'child_process'
 
 export default defineConfig({
-  plugins: [
-    RubyPlugin(),
-  ],
+  build: {
+    manifest: true,
+    minify: true,
+    reportCompressedSize: true,
+    lib: {
+      entry: resolve(__dirname, 'app/javascript/index.js'),
+      name: '@geoblacklight/frontend',
+      fileName: 'frontend'
+    }
+  },
+  "plugins": [
+    {
+      name: 'clobber internal test app vite files and cache',
+      buildEnd: async() => {
+        exec("cd .internal_test_app && bundle exec vite clobber")
+      }
+    }
+  ]
 })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Mike Graves
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -435,6 +435,7 @@ files:
 - app/assets/images/blacklight/multipoint.svg
 - app/assets/images/blacklight/multipolygon.svg
 - app/assets/images/blacklight/nebraska.svg
+- app/assets/images/blacklight/northwestern-university.svg
 - app/assets/images/blacklight/nyu.svg
 - app/assets/images/blacklight/ohio-state.svg
 - app/assets/images/blacklight/pagelines-brands.svg
@@ -549,18 +550,16 @@ files:
 - app/controllers/download_controller.rb
 - app/controllers/relation_controller.rb
 - app/controllers/wms_controller.rb
-- app/frontend/clover/clover_initializer.js
-- app/frontend/entrypoints/application.js
-- app/frontend/entrypoints/clover.js
-- app/frontend/entrypoints/ol.js
-- app/frontend/openlayers/basemaps.js
-- app/frontend/openlayers/ol_initializer.js
-- app/frontend/stylesheets/openlayers.css
 - app/helpers/arcgis_helper.rb
 - app/helpers/blacklight_helper.rb
 - app/helpers/carto_helper.rb
 - app/helpers/geoblacklight/geoblacklight_helper_behavior.rb
 - app/helpers/geoblacklight_helper.rb
+- app/javascript/clover/clover_initializer.js
+- app/javascript/index.js
+- app/javascript/openlayers/basemaps.js
+- app/javascript/openlayers/ol_initializer.js
+- app/javascript/stylesheets/openlayers.css
 - app/models/concerns/geoblacklight/bbox_filter_field.rb
 - app/models/concerns/geoblacklight/bbox_filter_query.rb
 - app/models/concerns/geoblacklight/solr_document.rb
@@ -613,7 +612,6 @@ files:
 - config/initializers/new_gbl_settings_defaults_4.1.yml
 - config/initializers/rails_config.rb
 - config/locales/geoblacklight.en.yml
-- config/vite.json
 - geoblacklight.gemspec
 - jest.config.js
 - lib/generators/geoblacklight/assets_generator.rb
@@ -627,12 +625,12 @@ files:
 - lib/generators/geoblacklight/templates/catalog_controller.rb
 - lib/generators/geoblacklight/templates/clover.js
 - lib/generators/geoblacklight/templates/ol.js
+- lib/generators/geoblacklight/templates/package-test.json
 - lib/generators/geoblacklight/templates/package.json
 - lib/generators/geoblacklight/templates/settings.gbl_v1.yml
 - lib/generators/geoblacklight/templates/settings.yml
 - lib/generators/geoblacklight/templates/vite.config.ts
 - lib/generators/geoblacklight/templates/vite.json
-- lib/generators/geoblacklight/templates/vite.rb
 - lib/geoblacklight.rb
 - lib/geoblacklight/bounding_box.rb
 - lib/geoblacklight/constants.rb

data/app/frontend/entrypoints/application.js

@@ -1,28 +0,0 @@
-// To see this message, add the following to the `<head>` section in your
-// views/layouts/application.html.erb
-//
-//    <%= vite_client_tag %>
-//    <%= vite_javascript_tag 'application' %>
-console.log('Vite ⚡️ Rails - Engine')
-
-// If using a TypeScript entrypoint file:
-//     <%= vite_typescript_tag 'application' %>
-//
-// If you want to use .jsx or .tsx, add the extension:
-//     <%= vite_javascript_tag 'application.jsx' %>
-
-console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
-
-// Example: Load Rails libraries in Vite.
-//
-// import * as Turbo from '@hotwired/turbo'
-// Turbo.start()
-//
-// import ActiveStorage from '@rails/activestorage'
-// ActiveStorage.start()
-//
-// // Import all channels.
-// const channels = import.meta.globEager('./**/*_channel.js')
-
-// Example: Import a stylesheet in app/frontend/index.css
-// import '~/index.css'

data/app/frontend/entrypoints/clover.js

@@ -1,5 +0,0 @@
-import CloverInitializer from '@/clover/clover_initializer'
-
-document.addEventListener('DOMContentLoaded', () => {
-  new CloverInitializer().run()
-})

data/app/frontend/entrypoints/ol.js

@@ -1,5 +0,0 @@
-import OlInitializer from '@/openlayers/ol_initializer'
-
-document.addEventListener('DOMContentLoaded', () => {
-  new OlInitializer().run()
-})

data/app/frontend/stylesheets/openlayers.css

@@ -1 +0,0 @@
-@import "../../../node_modules/ol/ol.css";

data/config/vite.json

@@ -1,14 +0,0 @@
-{
-  "all": {
-    "sourceCodeDir": "app/frontend",
-    "publicOutputDir": "geoblacklight-vite",
-    "watchAdditionalPaths": []
-  },
-  "development": {
-    "autoBuild": true,
-    "port": 3037
-  },
-  "test": {
-    "autoBuild": true
-  }
-}

data/lib/generators/geoblacklight/templates/vite.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-ViteRuby.env["GBL_ASSETS_PATH"] =
-  "#{Gem.loaded_specs["geoblacklight"].full_gem_path}/app/frontend"