geoblacklight 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a9b830e90a8580443044e898289baf0c5cf4406256b5d7a559be7feda46b046
-  data.tar.gz: c8fcc76101713b079a36a8bbb17709b4a8ce4554d2021abaa198e8c501b08434
+  metadata.gz: 46c8d4fb0425f7226b0b649f1d1c32b57299b683db1296c7dfb981952e4626d1
+  data.tar.gz: 8f64af5a2d95ab6b517860b19db043545eb9a74f7a73aa62ed759473d21449ae
 SHA512:
-  metadata.gz: 45b0e722ebb055ecc603e8fa39a8473910aa5a703dfcc8c0d489c6bc490ca840ec2f257adb7ba04ac563fd103912f78a39da8004cebc1bae79df4030c82a249c
-  data.tar.gz: 3fb12b9e06b472fbc3b87e822644721c151052d0082888e758e27067df1c5e50434d792e3e8f57239ab34dff18eee5778a66ba1e52509562923505c9c111075d
+  metadata.gz: 641fbb57de92e4006a757ee6d61f1abb447b4939b9fd86ce7e4bbfcaa4e6129a3d7a48effa6bc3a6c1181aaf061824e382c6b15eba143c25b47302abcc7d84aa
+  data.tar.gz: db8fea6b8af4a6749a37c6cddd8ec43088bfeeb03bf16b808d9b1c900cd9a1aabe518af1de0f8b94b4980483d059119ab2f39c93929562c040f9c3e0c12ab7d8

data/.github/workflows/ruby.yml

@@ -65,7 +65,7 @@ jobs:
       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'
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test --skip-webpack-install --skip-javascript'
         SOLR_URL: http://solr:SolrRocks@localhost:8983/solr/blacklight-core
     - name: Upload coverage artifacts
       uses: actions/upload-artifact@v2

data/app/frontend/entrypoints/application.js

@@ -3,7 +3,7 @@
 //
 //    <%= vite_client_tag %>
 //    <%= vite_javascript_tag 'application' %>
-console.log('Vite ⚡️ Rails')
+console.log('Vite ⚡️ Rails - Engine')
 
 // If using a TypeScript entrypoint file:
 //     <%= vite_typescript_tag 'application' %>

data/app/frontend/openlayers/ol_initializer.js

@@ -1,4 +1,4 @@
-import '@/stylesheets/openlayers.css'
+import '../stylesheets/openlayers.css'
 import { Map, View } from 'ol'
 import TileLayer from 'ol/layer/Tile'
 import VectorTile from 'ol/layer/VectorTile'

data/app/frontend/stylesheets/openlayers.css

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

data/geoblacklight.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", "~> 2.0"
   spec.add_dependency "coderay"
   spec.add_dependency "deprecation"
-  spec.add_dependency "geo_combine", "~> 0.8"
+  spec.add_dependency "geo_combine", "~> 0.9"
   spec.add_dependency "mime-types"
   spec.add_dependency "handlebars_assets"
   spec.add_dependency "rgeo-geojson"

data/lib/generators/geoblacklight/install_generator.rb

@@ -116,11 +116,6 @@ module Geoblacklight
       copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb"
     end
 
-    # Vite - Copy config file
-    def copy_config_vite_json
-      copy_file "vite.json", "config/vite.json"
-    end
-
     # Run bundle with vite install
     def bundle_install
       Bundler.with_clean_env do
@@ -128,5 +123,21 @@ module Geoblacklight
         run "bundle exec vite install"
       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
+
+    # 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"
+    end
   end
 end

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

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

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

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

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

@@ -0,0 +1,7 @@
+{
+  "devDependencies": {
+    "vite": "^5.1.5",
+    "vite-plugin-ruby": "^5.0.0",
+    "vite-plugin-rails": "^0.5.0"
+  }
+}

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

@@ -0,0 +1,19 @@
+import { defineConfig } from 'vite'
+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.rb

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

data/lib/geoblacklight/engine.rb

@@ -8,33 +8,9 @@ require "geoblacklight/version"
 require "nokogiri"
 require "mime/types"
 require "handlebars_assets"
-require "vite_ruby"
 
 module Geoblacklight
   class Engine < ::Rails::Engine
-    delegate :vite_ruby, to: :class
-
-    def self.vite_ruby
-      @vite_ruby ||= ViteRuby.new(root: root)
-    end
-
-    # Expose compiled assets via Rack::Static when running in the host app.
-    config.app_middleware.use(Rack::Static,
-      urls: ["/#{vite_ruby.config.public_output_dir}"],
-      root: root.join(vite_ruby.config.public_dir))
-
-    initializer "vite_rails_engine.proxy" do |app|
-      if vite_ruby.run_proxy?
-        app.middleware.insert_before 0, ViteRuby::DevServerProxy, ssl_verify_none: true, vite_ruby: vite_ruby
-      end
-    end
-
-    initializer "vite_rails_engine.logger" do
-      config.after_initialize do
-        vite_ruby.logger = Rails.logger
-      end
-    end
-
     # GeoblacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer "geoblacklight.helpers" do

data/lib/geoblacklight/version.rb

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

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

@@ -7,6 +7,15 @@ class TestAppGenerator < Rails::Generators::Base
 
   def add_gems
     gem "blacklight"
+
+    # In CI, Javascript and Webpacker are removed when generating Rails 6.x
+    # applications to enable Vite. Disabling javascript during test app
+    # generation removes Turbolinks. This gem is required and needs to be
+    # re-added.
+    if ENV["RAILS_VERSION"] && Gem::Version.new(ENV["RAILS_VERSION"]) < Gem::Version.new("7.0")
+      gem "turbolinks"
+    end
+
     Bundler.with_clean_env do
       run "bundle install"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Mike Graves
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,14 +109,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -559,7 +559,6 @@ files:
 - app/helpers/arcgis_helper.rb
 - app/helpers/blacklight_helper.rb
 - app/helpers/carto_helper.rb
-- app/helpers/geoblacklight/application_helper.rb
 - app/helpers/geoblacklight/geoblacklight_helper_behavior.rb
 - app/helpers/geoblacklight_helper.rb
 - app/models/concerns/geoblacklight/bbox_filter_field.rb
@@ -626,9 +625,14 @@ files:
 - lib/generators/geoblacklight/templates/assets/geoblacklight.js
 - lib/generators/geoblacklight/templates/base.html.erb
 - lib/generators/geoblacklight/templates/catalog_controller.rb
+- lib/generators/geoblacklight/templates/clover.js
+- lib/generators/geoblacklight/templates/ol.js
+- 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
@@ -905,7 +909,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.5.2
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A discovery platform for geospatial holdings

data/app/helpers/geoblacklight/application_helper.rb

@@ -1,8 +0,0 @@
-module Geoblacklight
-  module ApplicationHelper
-    # Override: Returns the engine assets manifest.
-    def vite_manifest
-      Geoblacklight::Engine.vite_ruby.manifest
-    end
-  end
-end