blacklight-gallery 4.9.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d221305a94421df76f54ae679c513b790baef5b4afdc1abfc9b24ff5146208
-  data.tar.gz: 258056988445e95af342620ff965d6ab274f46365eacec66290ba934fc2a78e7
+  metadata.gz: 13baf24ed76a1d17d236045a5c0cc02d58c9c6705f5d65b522931c3e195c6cb9
+  data.tar.gz: f79f91f11e213e7faa9afbf8e482cb3e28dd128aac06febc89d9f6e949cbd568
 SHA512:
-  metadata.gz: 2331c4e448b020b45a3109bbf71dc054e688bd7ee8283b774a23560d7a32455a0dce5305a2951355fda9e50c40cbb3a1bd532eba14839ea3900dd569ac34cc42
-  data.tar.gz: 31741518979dc275175681c555bdf6db5a101fb1444db4b9a39eecb502d28481b416cfea06539ef255c5bf46b3f139b1357a88701b2b957882b056cf8110c172
+  metadata.gz: a435ab07aea7fe74f4189523f5f3b5c1dd2dd6ccee5b11e9d58eab3cd618b0e5cef945cdb2ee59d8d44899dfe004463040c700cca6a6934f78c35bd5cbdf56b5
+  data.tar.gz: 2337f6bb523acc96a45f9fe262a6774f125f8d29f5c6788d170cf877305f4971005ccb22d0fa90bd39d40473324ec9ddbc21d2a68a909faf41aa31665362a880

data/README.md

@@ -19,32 +19,15 @@ Or install it yourself as:
 
 ## Usage
 
-### With Sprockets
+### Installation with Sprockets/Propshaft and Importmaps
 
-If your asset pipeline uses Sprockets, simply run the gallery generator:
+If your asset pipeline uses Sprockets/Propshaft with Importmaps, run the gallery generator:
 
 ```sh
 $ rails g blacklight_gallery:install
 ```
 
-### With Importmaps
-
-New installations of Blacklight will probably use [Importmaps](https://github.com/rails/importmap-rails) to manage javascript assets. In order to support the masonry and slideshow views, jQuery needs to be added to your application Importmaps configuration.
-
-In addition to running the `blacklight_gallery:install` generator, add this line to `/config/importmap.rb`:
-
-```ruby
-pin "jquery", to: "https://code.jquery.com/jquery-3.7.1.min.js"
-```
-
-Then append import declarations in your `app/assets/javascript/application.js`:
-
-```js
-import 'jquery'
-import 'blacklight-gallery'
-```
-
-### With Node-based JS bundlers
+### Installation for Node-based JS bundlers
 
 For node-based bundlers add `blacklight-gallery masonry-layout@v4` as a dependency and add this to your entrypoint:
 ```js
@@ -53,11 +36,6 @@ import 'blacklight-gallery/app/javascript/blacklight-gallery/slideshow'
 import 'blacklight-gallery/app/javascript/blacklight-gallery/masonry'
 ```
 
-### With Propshaft
-
-Propshaft will process and include any CSS files in your `app/assets/stylesheets` directory. The `blacklight_gallery:install` generator adds [a file](https://github.com/projectblacklight/blacklight-gallery/blob/v4.8.4/lib/generators/blacklight_gallery/templates/blacklight_gallery.css.scss) to `app/assets/stylesheets` that loads the included styles for all views.
-The styles require compilation from SASS to CSS, which will require usage of a compiler like [`dartsass-rails`](https://github.com/rails/dartsass-rails).
-
 ## Manual Installation
 
 See the wiki page on [manual installation](https://github.com/projectblacklight/blacklight-gallery/wiki/Manual-Installation) to customize which views and related assets to install into your application.
@@ -76,73 +54,39 @@ See the wiki page on [manual installation](https://github.com/projectblacklight/
 - Java >= openjdk-21
   - Building the internal test app will install Solr 9.6.1 locally via [`solr_wrapper`](https://github.com/cbeer/solr_wrapper)
 
-### Building Internal Test App
+### Building and testing test application
+By default, the rake tasks below run with the current Rails and Blacklight versions defined in the gemspec file. You can modify the rake task with the following environment variables:
+- Pass custom options to the rails engine cart using the `ENGINE_CART_RAILS_OPTIONS` environment variable.
+- Set a specific Rails version with `export RAILS_VERSION=some_version_#`.
+- Set a specific Blacklight version with `export BLACKLIGHT_VERSION=some_version_#`.
+- Use Blacklight on the latest commit from the repository with `export BLACKLIGHT_VERSION=github`
 
-Within the blacklight-gallery root directory
+#### Building Internal Test App
+Within the blacklight-gallery root directory:
 - Install gems
-```
-bundle install
-```
-- Run the rake task that builds internal test app and runs the test suite.  
-```
-bundle exec rake
-```
-
-- By default, the rake task runs with the current rails and blacklight versions defined in the gemspec file, you can modify the rake task with the following environment variables:
-  - Pass custom options to the rails engine cart using the `ENGINE_CART_OPTIONS` environment variable. 
-  - Set a specific rails version with `export RAILS_VERSION=some_version_#`.
-  - Set a specific blacklight version with `export BLACKLIGHT_VERSION=some_version_#`.
-
-
-### Stylesheets
-
-- When using the modern rails asset pipeline (`importmap` + `propshaft`) to build the internal test app, we need to manually include the `.scss` stylesheets in the host application's stylesheet entrypoint
-- Copy the gem's `.scss` stylesheets in `/app/assets/stylesheets` to `/.internal_test_app/assets/stylesheets`
-- Import stylesheets in internal test app stylesheet entrypoint.
-```
-# internal_test_app stylesheet entrypoint 
-
-@import 'gallery';
-@import 'slideshow';
-@import 'masonry';
-@import 'osd_viewer';
   ```
-- Compile scss from within `/.internal_test_app` with the following `yarn` command
-
-```
-yarn build:css
-```
-
-### Jquery
-- The masonry and slideshow views require jquery. There are multiple ways to do this, and we document the
-- When running the generator with the current gemspec, and the modern rails asset pipeline (`importmap`, `propshaft`, and/or `node` based bundlers), 
-we have to import jquery manually in the internal test app. You can do this with importmaps with the following additions to your `/.internal_test_app/config/importmap.rb` file:
-
-```
-# /.internal_test_app/config/importmap.rb
-
-pin "jquery", to: "https://code.jquery.com/jquery-3.7.1.min.js"
-```
-- Once jquery is added to the internal test app, import the following to the internal test app `application.js` entrypoint
-```
-# /.internal_test_app/javascrpt/application.js
-
-# import jquery and 'blacklight-gallery'
+  bundle install
+  ```
 
-import 'jquery'
-import 'blacklight-gallery'
-```
+- Run the rake task that builds internal test app  
+  ```
+  bundle exec rake engine_cart:generate
+  ```
 
-### Start Rails Server
-- Run the rake task to start the rails server for the internal test app from the blacklight gallery root directory
-```
-bundle exec rake server
-```
+- A test Rails application is built in the `.internal_test_app` directory with Blacklight and Blacklight-Gallery 
 
-### Specs
+#### Start Rails Server
+Within the blacklight-gallery root directory:
+- Run the rake task to start the rails server and Solr for the internal test app
+  ```
+  bundle exec rake server
+  ```
 
-- Run specs with current internal test app configuration
-  `bundle exec rake`
+#### Run Specs in test application
+- Run specs with current internal test app configuration. Generates internal test app, if not already present.
+  ```
+  bundle exec rake
+  ```
 
 ### Solr
 - The default solr port is at 8983

data/Rakefile

@@ -13,7 +13,7 @@ task :default => :ci
 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/)
+rails_options = "#{rails_options} --css bootstrap" unless rails_options.match?(/--css\s|sprockets/)
 ENV['ENGINE_CART_RAILS_OPTIONS'] = rails_options
 
 desc "Load fixtures"
@@ -26,10 +26,14 @@ end
 
 desc "Execute Continuous Integration build"
 task :ci => ['engine_cart:generate'] do
-
   require 'solr_wrapper'
   SolrWrapper.wrap(port: '8983') do |solr|
     solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path(File.dirname(__FILE__)), 'solr', 'conf')) do
+      within_test_app do
+        # Precompiles the assets
+        `bin/rails spec:prepare`
+      end
+
       Rake::Task['fixtures'].invoke
       Rake::Task['spec'].invoke
     end
@@ -47,7 +51,9 @@ task :server do
         ENV['FILE'] = File.join(__dir__, 'spec', 'fixtures', 'sample_solr_documents.yml')
         system 'rake blacklight:index:seed'
         ENV.delete('FILE')
-        system 'bundle exec rails s'
+
+        system "yarn build:css"
+        system "bundle exec rails s"
       end
     end
   end

data/app/assets/javascripts/blacklight_gallery/blacklight-gallery.esm.js

@@ -1,5 +1,3 @@
-import Blacklight from 'blacklight-frontend';
-
 /*!
  * imagesLoaded PACKAGED v5.0.0
  * JavaScript is all like "You images are done yet or what?"
@@ -574,11 +572,6 @@ return ImagesLoaded;
 
 })(jQuery);
 
-
-Blacklight.onLoad(function() {
-  $('.documents-slideshow').slideshow();
-});
-
 (function($){
   $.fn.BlacklightMasonry = function() {
     var container = this;
@@ -591,8 +584,4 @@ Blacklight.onLoad(function() {
 
   $.fn.BlacklightMasonry.options = { gutter: 8 };
 })(jQuery);
-
-Blacklight.onLoad(function() {
-  $('.documents-masonry').BlacklightMasonry();
-});
 //# sourceMappingURL=blacklight-gallery.esm.js.map