blacklight-spotlight 4.7.0 → 5.0.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 051b1798794393c2afeb19a83437d9d0bde7c2bd5861a1684b08bb89fe948a51
-  data.tar.gz: '058d356020bd76fccf4124dee494114640ecb514ecabe06220a3ad2628ce9510'
+  metadata.gz: ce44443bbb2fb8d5c0a1d0d7aad9bc0b897e7fd69a508f0c657e9d6afef88c0c
+  data.tar.gz: 1634dbfb882f80488abd0c32351a78f11c46664c2f0ce81a16baca9c1807c663
 SHA512:
-  metadata.gz: 2489cb7dd18bcd3369a41e0991349617ed3a49adedb9859d79eb9b0938f70f712cf6325c2e9eb48754d2b691f1a1ae6c32e7f3c8393a2083f3984248d166dd6c
-  data.tar.gz: a636d0dabffd8633a2a293c8433dada5c3df367512df0232ea366b193300e2828d6e973cc38bc31f7279cf486e1505c77cea8c6c7f5c181adec80dbd6f97f40d
+  metadata.gz: c9e40d3004bc25781c5a49fa4bcfc2e1ff22bf7c8bb173b269b41d9db1493b98a2d1597f8f996f0fa5214aa3d52e10d032c20196573dd7838ff27bc1d34aa344
+  data.tar.gz: ec53a3c1124ed3477744063462e7f5860d5fad382b3dcd33cf96ea2ee1e752204c7dff36864978ba354c11a570f55c7eea7bcc709ad14ed3789190ccb02997f3

data/README.md

@@ -9,17 +9,23 @@ Read more about what Spotlight is, our motivations for creating it, and how to i
 
 ## Requirements
 
-1. Ruby (2.7 or greater)
-2. Rails (5.2 or greater)
-3. Java (7 or greater) *for Solr*
+1. [Ruby](https://www.ruby-lang.org/) 3.1+
+2. [Ruby on Rails](https://rubyonrails.org/) 7.1+
+3. Java (11 or greater) *for Solr*
 4. ImageMagick (http://www.imagemagick.org/script/index.php) due to [carrierwave](https://github.com/carrierwaveuploader/carrierwave#adding-versions)
 
 ## Installation
 
-To bootstrap a new Rails application:
+To bootstrap a new Rails application using [importmap-rails](https://github.com/rails/importmap-rails):
 
 ```
-$ SKIP_TRANSLATION=1 rails new app-name -m https://raw.githubusercontent.com/projectblacklight/spotlight/main/template.rb
+$ SKIP_TRANSLATION=1 rails new app-name -m https://raw.githubusercontent.com/projectblacklight/spotlight/main/template.rb -a propshaft --css bootstrap
+```
+
+or using [jsbundling-rails](https://github.com/rails/jsbundling-rails) with [esbuild](https://esbuild.github.io/):
+
+```
+$ SKIP_TRANSLATION=1 rails new app-name -m https://raw.githubusercontent.com/projectblacklight/spotlight/main/template.rb -a propshaft -j esbuild --css bootstrap
 ```
 
 or from an existing Rails application:
@@ -51,7 +57,7 @@ $ solr_wrapper
 and the Rails development server:
 
 ```
-$ rails server
+$ bin/dev
 ```
 
 Go to http://localhost:3000 in your browser.
@@ -60,22 +66,34 @@ Go to http://localhost:3000 in your browser.
 
 ### Default ActionMailer configuration
 
-Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (see the Rails Guide for [Action Mailer Configuration](http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration)).
+Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (see the Rails Guide for [Action Mailer Configuration](https://guides.rubyonrails.org/v7.2/action_mailer_basics.html#action-mailer-configuration)).
 
 See the [Spotlight wiki](https://github.com/projectblacklight/spotlight/wiki) for more detailed information on configuring Spotlight.
 
 # Developing Spotlight
 
-Spotlight:
+## Branches
+
+* The `main` branch is for development of the upcoming 5.0 release.
+* The `4.x` series is on the [release-4.x](https://github.com/projectblacklight/spotlight/tree/release-4.x) branch for backports of features and bug fixes.
+
+## Spotlight
 
 * is a Rails engine and needs to be used in the context of a Rails application. We use [engine_cart](https://github.com/cbeer/engine_cart) to create an internal test application at .internal_test_app/
 * uses Solr as part of its integration tests. We use [solr_wrapper](https://github.com/cbeer/solr_wrapper) to manage the Solr instance used for development and test.
 
-Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing rails app automatically.
-
 See more detailed instructions for development environment setup at ["Contributing to Spotlight"](https://github.com/projectblacklight/spotlight/wiki/Contributing-to-Spotlight)
 
-## With Docker
+## Run a development server
+
+### With EngineCart
+```
+$ rake spotlight:server
+```
+
+Then visit http://localhost:3000. A Solr instance will be running on port 8983. When using importmap (the default configuration), JavaScript changes in development should not require [bundling](#updating-the-javascript-bundle) or a server restart.
+
+### With Docker
 
 ```sh
 # because of how docker compose handles named images, running `docker compose up --build` will error when the Rails images have not been built locally
@@ -134,4 +152,4 @@ You only need to update `package.json` and prepare/publish the JavaScript packag
 5. Push the release to rubygems and GitHub: `bundle exec rake release`
 6. Run `npm publish` to push the JavaScript package to https://npmjs.org/package/spotlight-frontend
 
-See "Updating the JavaScript bundle" above for more details.
+See [Updating the JavaScript bundle](#updating-the-javascript-bundle) above for more details.

data/Rakefile

@@ -31,6 +31,13 @@ require 'engine_cart/rake_task'
 
 require 'spotlight/version'
 
+# Build with our opinionated defaults if none are provided.
+rails_options = ENV.fetch('ENGINE_CART_RAILS_OPTIONS', '')
+rails_options = "#{rails_options} -a propshaft" unless rails_options.match?(/-a\s|--asset-pipeline/)
+rails_options = "#{rails_options} -j importmap" unless rails_options.match?(/-j\s|--javascript/)
+rails_options = "#{rails_options} --css bootstrap" unless rails_options.match?(/--css/)
+ENV['ENGINE_CART_RAILS_OPTIONS'] = rails_options
+
 def system_with_error_handling(*args)
   Open3.popen3(*args) do |_stdin, stdout, stderr, thread|
     puts stdout.read
@@ -93,7 +100,7 @@ namespace :spotlight do
             system 'bin/rails spotlight:initialize spotlight_test:solr:seed'
             File.open('.initialized', 'w') {}
           end
-          system 'bin/rails s'
+          system 'bin/dev'
         end
       end
     end

data/app/assets/javascripts/spotlight/application.js

@@ -3,6 +3,5 @@
 //= require sir-trevor
 //= require clipboard
 //= require tiny-slider
-//= require typeahead.bundle.min.js
 
 //= require spotlight/spotlight