spotlight

https://github.com/projectblacklight/spotlight/compare/v1.5.1...v2.0.0

Spotlight v2.0.0 adds a new major feature, the ability for curators and exhibit administrators to create multi-lingual exhibits.

Upgrade guide

Install new database migrations

$ bundle exec rake spotlight:install:migrations

Migrate Page content to provide a locale in a scope

After updating to Spotlight v2.0.0 and running the new migrations, update the FriendlyId::Slugs of your pages by running:

$ bundle exec rake spotlight:migrate_pages_language

Move spotlight_initializer.rb to using Spotlight::UploadFieldConfig

Spotlight v2.0.0 allows you to configure upload fields using a new class Spotlight::UploadFieldConfig. You should use a separate config for each Solr field.

Known Issues / Potential Gotchas

Switching locales between pages in an exhibit whose translated pages are in an incomplete created/published status will raise the same redirect/error (unauthorized or not found) that would normally be returned for any page. See more conversation/status in #2052.

Commit history

Bug Fixes

#2015 fixes issue #2014 causing a memory leak

Commit history

The v1.5.0 is the last planned release before the Spotlight v2.0. It includes several test suite optimization improvements and other bug fixes.

Upgrade Notes
One dependency update that may cause issues for consumers is the Leaflet-IIIF update to v2.0.0. This will only be the case if users have a customized IIIF cropper, but is unlikely.

Adopters will likely want to copy the translations initializer to their config/initializers directory: https://github.com/projectblacklight/spotlight/blob/v1.5.0/lib/generators/spotlight/templates/config/initializers/translation.rb

Improvements

ef2b91c Resets the timestamp on our Solr documents, allowing for an accurate Solr timestamp when using atomic updates
977275c, c391357 Enables i18n-active_record to be used as an i18n backend. Turned off by default
03c92c0 Specify Spotlight as Rails 5+
29a48c2 Update Leaflet-Editable to v1.1.0
3b45855, a322713, e102e2e Pin and then update to Capybara 3
e33bb72 Blacklight-gallery optional in gemspec

Bug Fixes

#1989 Fixes issue #1802 where metadata may be present on search results when it has been deselected by an exhibit curator
14312fa Right-aligns numeric analytics table
e282297 Fixes #1944 where tags were not working properly
d996507 Fixes #1965 where exhibit indexing polling was continually polling unexpectedly

Test suite / maintenance improvements

4488848 Minor test suite optimization, removing unused variable assignment
b889656, 436212d Do not allow external requests in our test suite
4d412e1 Test on latest versions of Rails 5.0, 5.1
3973dd4 Explicitly name js linting approach
462a400 Disable jQuery animations in our test suite
7f6afb3 Reenable travis container environment and use chrome with no sandbox
6ad507a Move from FactorBot.create to build_stubbed to help with test suite performance
b14026d More specific selector to make test not pending
9a76dc1 Try bundler and sprockets caching
d9b1682 Disable image loading in CI
a850aed Update flaky js tests
54438c1 Move feature test to view+controller tests
ebb56f4 Update travis build matrix
aa1cfc2 Update to engine_cart to help with caching test app
43df67a Drop Rails 5 build
9366036 Remove unnecessary test
#2020 Significant improvements to the reliability of the test suite

Commit history

Improvements

44444c6 Update description for "Embed + Text" widget with examples of embed resources
0a3e430 Limit max-width of iframe in "Embed + Text" widget

Bugs

1dd21c6 Fix bug that was causing browse category show page to display incorrect item counts
128612c Update default_browse_thumbnail extension so that it's included in the asset pipeline
b460861 Restore tests that are now compatible with chromedriver
0ff1457 Only copy over original for non-custom facet fields
3f1d2d0 Add iiif-presentation a a dependency

Commit history

Note: This release includes a new migration

New features

#1888 Add a configurable search box to browse categories

Fixes and improvements

83ff64a Fix some missing i18n keys from the metadata configuration page
9e4b2ab Use Bootstrap_form_for to handle honeypot field label
fd94c37 Reduce exhibits pagination size to 48 to improve tiling on index pages

Commit history

New features and improvements

2ac31c1 Add an indexed Solr field for which exhibits an object appears in
3ed9e74 Add help text to the new admin / curator form
99c7df3 Add support for Solr 7.2.0
b58381c Allow field-specific display settings in Blacklight Configuration
085cdff Improve a flaky JS feature test
325626a Add TravisCI's recommended workaround for a Chrome permissions bug (travis-ci/travis-ci#8836)

Commit history

New features

1c4921a Add support for configuring views as title-only by default

Bug fixes

edb76a7 Deliver email to resource users created by invite

Commit History

This update adds both bug fixes and new features to Spotlight

New Features and improvements

401cc47 Throw out documents on index that do not have an id
6a6f7ec Remove duplication in scss
9e5bccb Allow contact emails to be deleted
02b4c3f Use leaflet-rails rather than checked in vendor file
34dd772 Allow search and sort fields to be enabled/disabled by default
1624b7d Validates sir trevor block data types
33c97ee Truncates exhibit whitespace
4527b14 Removes phantomjs in favor of chromeheadless
0a5fb66 FactoryGirl -> FactoryBot
8ba821f Add papertrail to additional models
e7c2af0 Add "Link to search" block

Bug Fixes

8461d034841355a8e5ded92b24be329b0e4c73df Custom theme image extension
8a79778 UJS backwards compatibility
aa319e2 Adds missing migration from acts as taggable

Bug fixes:

• Allow feedback link to be opened in a new tab/window.
• Allow Spotlight::Resources::Upload to be migrated to IIIF.
• Don't allow leaflet controls to overlay the typeahead dropdown.

Improvements:

• Replace leaflet-areaselect crop box with leaflet-editable
• #1407 - Add instructions to the filter form
• Change browse category layout to use a single column of text for shorter descriptions

Bg fixes:

• Fix CSV upload job
• Handle edge cases in IIIF migration script

Features

IIIF support

• Serve uploaded images via IIIF Image API
• Create IIIF manifests for exhibit-specific resources
• Require IIIF-backed images for cropping thumbnails and masthead images
• Require IIIF manifests for multi-image object support in pages

Other features

• Add immutable configuration for blacklight fields and disallow metadata field changes for those values
• Add support for exhibit-specific themes

Improvements

• Replace openseadragon-based cropper with leaflet-iiif
• Improve the user actions dropdown menu for site administrators
• Initialize the "All Exhibit Items" browse category with a placeholder thumbnail
• Allow any kind of page (feature, about, home) to be highlighted using the pages widget
• Allow curators to update browse category restrictions

Upgrade guide:

• remove jquery.jcrop references from application.scss
• add leaflet css references (spotlight.scss)

  @import 'leaflet';
  @import 'leaflet-areaselect';

• run iiif migration rake task:

$ rake spotlight:migrate_to_iiif[http://example.com]

Where http://example.com is the public host name of your application.

Improvements:

• Move SolrDocumentSidecar#index_status into a new database field
• Override typeahead z-index to float over all elements
• Invite unknown users when they are added to exhibit roles

Bug fixes:

• #1591 Preserve user's pagination parameters in browse categories

Improvements:

• Add JSON response to browse#show to support additional search results views

Bug fixes:

• Handle empty input to sir-trevor

Bug fixes:

• #1599 Fix typo in drag + drop initialization
• #1598 Fix item tag field styling
• #1597 Fix sir-trevor upload block by passing CSRF tokens with the upload action

Bug fixes:

• #1608 - Search configuration sort fields are not re-orderable for values with spaces
• #1614 : Allow autocomplete/typeahead dropdown to overflow blocks

Improvements:

• Add default sir-trevor text selection color
• Allow blocks to extend autocomplete/typeahead options
• Return 100 results for autocomplete/typeahead

• Fix sir-trevor block display regression
• Update typeahead/autocomplete regression

Features:

• #1621 : Allow browse category descriptions to use markdown formatting
• #1662 : Add reindexing job summary and improve the display of the reindexing progress bar

Performance improvements:

• #1657 : Use the exhibit cache key for the browse#index, and break the exhibit cache when resources are changed
• #1682 : Improve performance of catalog#edit page with many custom fields

Other:

• Update ExhibitExportSerializer for compatibility with roar v1.1

Performance:

• Add database index for solr document sidecar lookups
• Remove n+1 query for the exhibits#index page

Improvements:

• Update to sir-trevor v0.6.4
• Parse CSV uploads as UTF-8 encoded files