Add packages individually

projectblacklight · Oct 1, 2024 · aef96c8 · aef96c8
1 parent f3eaaf1
commit aef96c8
Show file tree

Hide file tree

Showing 13 changed files with 93 additions and 69,907 deletions.
diff --git a/app/assets/javascripts/spotlight/spotlight.esm.js b/app/assets/javascripts/spotlight/spotlight.esm.js
diff --git a/app/assets/javascripts/spotlight/spotlight.esm.js.map b/app/assets/javascripts/spotlight/spotlight.esm.js.map
diff --git a/app/assets/javascripts/spotlight/spotlight.js b/app/assets/javascripts/spotlight/spotlight.js
diff --git a/app/assets/javascripts/spotlight/spotlight.js.map b/app/assets/javascripts/spotlight/spotlight.js.map
diff --git a/app/javascript/spotlight/core.js b/app/javascript/spotlight/core.js
@@ -1,4 +1,5 @@
-import Blacklight from "blacklight-frontend";
+import Blacklight from "blacklight-frontend"
+import SirTrevor from "sir-trevor"
 
 const Spotlight = function() {
   var buffer = [];
@@ -26,7 +27,7 @@ const Spotlight = function() {
 
 // This allows us to configure Spotlight in app/views/layouts/base.html.erb
 window.Spotlight = Spotlight
-
+window.SirTrevor = SirTrevor
 export default Spotlight
 
 Blacklight.onLoad(function() {

diff --git a/lib/generators/spotlight/assets/propshaft_generator.rb b/lib/generators/spotlight/assets/propshaft_generator.rb
@@ -18,7 +18,14 @@ class PropshaftGenerator < Rails::Generators::Base
       DESCRIPTION
 
       def install_dependencies
-        copy_file 'package.json', 'package.json'
+        copy_file 'package.json', 'package.json' unless File.exist?('package.json')
+        run 'yarn add @hotwired/turbo-rails'
+        run 'yarn add clipboard'
+        run 'yarn add jquery'
+        run 'yarn add jquery-serializejson'
+        run 'yarn add leaflet'
+        run 'yarn add leaflet-iiif'
+        run 'yarn add sir-trevor'
         run 'yarn install'
       end
 
@@ -28,6 +35,11 @@ def add_blacklight_frontend
 
       def add_bootstrap
         run "yarn add bootstrap@\"~#{bootstrap_yarn_version}\""
+        if bootstrap4?
+          run 'yarn add popper.js'
+        else
+          run 'yarn add @popperjs/core'
+        end
       end
 
       def install_gems
@@ -62,12 +74,20 @@ def add_frontend
       end
 
       def add_javascript
-        copy_file 'assets/spotlight.js', 'app/javascript/application.js', force: true
+        gsub_file 'app/javascript/application.js', 'import "controllers"', '// import "controllers"'
+
+        append_to_file 'app/javascript/application.js', "\n// Bootstrap\nimport * as Bootstrap from 'bootstrap'\n"
+
+        if Blacklight::VERSION.start_with?('7')
+          append_to_file 'app/javascript/application.js', "\n// Blacklight\nimport \"blacklight-frontend/app/assets/javascripts/blacklight/blacklight.js\"\n"
+        end
+
+        append_to_file 'app/javascript/application.js', "\n// Spotlight\nimport Spotlight from \"spotlight-frontend\"\n"
       end
 
       def add_stylesheets
-        copy_file 'assets/application.sass.scss', 'app/assets/stylesheets/application.sass.scss', force: true
         copy_file 'assets/spotlight.scss', 'app/assets/stylesheets/spotlight.scss'
+        append_to_file 'app/assets/stylesheets/application.sass.scss', "\n@import \"spotlight\";\n"
       end
 
       # This resolves a bundling issue with bootstrap/popper on esbuild.
@@ -84,6 +104,10 @@ def bootstrap_yarn_version
         options[:'bootstrap-version'].match(/(\d+(\.\d+)*)/)[0]
       end
 
+      def bootstrap4?
+        bootstrap_yarn_version.start_with?('4')
+      end
+
       # Yarn link was including so many files (and a circular reference) that Propshaft was having a bad time.
       def link_spotlight_frontend
         empty_directory 'node_modules/spotlight-frontend'

diff --git a/lib/generators/spotlight/templates/assets/application.sass.scss b/lib/generators/spotlight/templates/assets/application.sass.scss
diff --git a/lib/generators/spotlight/templates/assets/spotlight.js b/lib/generators/spotlight/templates/assets/spotlight.js
diff --git a/lib/generators/spotlight/templates/package.json b/lib/generators/spotlight/templates/package.json
@@ -1,13 +1,5 @@
 {
   "dependencies": {
-    "@hotwired/turbo-rails": "^8.0.4",
-    "@popperjs/core": "2.11.8",
-    "clipboard": "^2.0.11",
-    "jquery": "^3.7.1",
-    "jquery-serializejson": "^3.2.1",
-    "leaflet-iiif": "^3.0.0",
-    "leaflet": "^1.9.4",
-    "sass": "^1.77.7"
   },
   "devDependencies": {
     "esbuild": "^0.23.1"

diff --git a/package.json b/package.json
@@ -37,6 +37,7 @@
     "jquery": "^3.7.1",
     "jquery-serializejson": "^3.2.1",
     "leaflet": "^1.9.4",
-    "leaflet-iiif": "^3.0.0"
+    "leaflet-iiif": "^3.0.0",
+    "sir-trevor": "^0.8.2"
   }
 }
diff --git a/rollup.config.js b/rollup.config.js
@@ -14,13 +14,15 @@ const external = [
   'clipboard',
   'jquery-serializejson',
   'jquery',
-  'leaflet'
+  'leaflet',
+  'sir-trevor'
 ]
 const globals = {
   'blacklight-frontend': 'Blacklight',
   clipboard: 'Clipboard',
   jquery: 'jQuery',
-  leaflet: 'L'
+  leaflet: 'L',
+  'sir-trevor': 'SirTrevor'
 }
 
 let includePathOptions = {

diff --git a/template.rb b/template.rb
@@ -9,7 +9,7 @@
 bootstrap_version = ENV.fetch('BOOTSTRAP_VERSION', '4')
 
 # Add gem dependencies to the application
-gem 'blacklight', ' ~> 7.0'
+gem 'blacklight', ' ~> 7.38'
 gem 'blacklight-spotlight', ENV['SPOTLIGHT_GEM'] ? { path: ENV['SPOTLIGHT_GEM'] } : { github: 'projectblacklight/spotlight' }
 gem 'sidekiq'
 gem 'bootstrap_form', /(\d)(?:\.\d){0,2}/.match(bootstrap_version)[1].to_i == 5 ? '~> 5.4' : '~> 4.5'