Releases: projectblacklight/blacklight
Blacklight 5.10.2
Blacklight 5.10.1
Bug Fixes
#1131 Move deprecation warnings context for #solr_search_params_logic into Blacklight::RequestBuilders
Blacklight 5.10.0
Refactoring
In Blacklight 5.9, we added functionality to begin supporting search backends other than Solr. In recognition of this work, we’ve started pulling out hard-coded references to Solr where generic or Blacklight-specific terms may be more appropriate, and leaving deprecation warnings in the place of old methods and functionality. The deprecated behavior will be removed in Blacklight 6.x. Below is a table showing examples of the renaming effort:
| Blacklight 5.x | Blacklight 5.10 |
|---|---|
Blacklight::SolrHelper |
Blacklight::SearchHelper |
| solr_repository | repository |
| get_search_results | search_results |
| blacklight_solr | connection |
| solr_search_params_logic | search_params_logic |
Blacklight::Configuration#solr_document_model |
Blacklight::Configuration#document_model |
Blacklight::Configuration#solr_response_model |
Blacklight::Configuration#response_model |
Blacklight::Exceptions::InvalidSolrID |
Blacklight::Exceptions::RecordNotFound |
Blacklight::Configuration::SolrField |
Blacklight::Configuration::Field` |
Blacklight::Document#solr_response |
Blacklight::Document#response |
SearchHelper#get_solr_response_for_doc_id |
SearchHelper#fetch |
SearchHelper#get_solr_response_for_document_ids |
SearchHelper#fetch |
rake blacklight:solr:seed |
rake blacklight:index:seed |
config/solr.yml |
config/blacklight.yml |
Additional work went into creating generic versions of solr functionality, including
- The configuration file
config/solr.ymlhas been renamedconfig/blacklight.ymland the structure of the file has changed slightly to include anadapterelement. - Extracted
Blacklight::SearchBuilderfromBlacklight::SearchHelper(wasBlacklight::SolrHelper) - Extract
Blacklight::AbstractRepositoryfromBlacklight::SolrRepository - Extract
Blacklight::DocumentfromBlacklight::Solr::Document - Wrap access to RSolr in a
Blacklight::SolrRepositoryinstead of providing direct access to RSolr
We've also changed the behavior of CatalogController.search_params_logic (was .solr_search_params_logic), which defined the translation between Rails' URL parameters and the Solr request parameters. This used to call methods directly on the controller. As of Blacklight 5.10, we've added a Blacklight::SearchBuilder class to contain those methods.
Features
- Add
document_presenter_class,repository_class, andsearch_builder_classto the blacklight configuration. This configuration was previously connected with the controller. - #1115 Blacklight's index, show and facet fields should support internal keys that may be different from the field name
- #1125 Change the link for facet pagination to include the name of the facet for screen readers (e.g.
more >>tomore locations >>)
Bug Fixes
- #1082 Bookmarks should use the same
idconstraints as the primary resource - #1061 Class references in the Blacklight configuration should not be deep-duped.
- #1098 Only use the user's stored view preference if it is available
- #1127 Fix indenting for the remove icon for pivot facets (@wlayton)
- #1126 Use more granular
RSolr.solr_escapeto escape facet values
Development tools
- Extract granular generators for controllers and models from the
blacklight:installgenerator. - Extract
additional_export_formatsmethod fromcatalog#show
Upgrade Guide
After updating to Blacklight 5.10, you should expect to see many deprecation warnings. Most of them can be resolved by following the directions given in the deprecation message.
v5.9.3
Blacklight 5.9.3 backports several changes from 5.10.0 for working with non-traditional Blacklight applications.
- Bookmarks should respect routing constraints for document ids
- #1061
solr_response_modelandsolr_document_modelshould not be duplicated
Version 5.9.2
Changes:
- Use blacklight-jetty 4.10.3
- Update to jettywrapper 2
Version 5.9.1
Changes:
- pull in tzinfo-data if on windows in the demo template
- SolrDocument.primary_key should be the same as Solr's unique key.
Blacklight 5.9.0
New Features
#1068 Render atom and rss feeds using the document partial rendering pipeline, so items in the feeds can have type-specific formats
#1063 Allow the blacklight configuration for the title field to accept multiple field names
Bug Fixes and improvements
#1067 RSS and Atom feeds should use #url_for_document helper
#1066 #current_sort_field should use the sort field that matches the sort value actually sent to solr
#1065 Searches with a single result should show "back to search" and "start over" buttons
#1064 Update tests to use blacklight_config.solr_document_model, and not hardcode SolrDocument
#1058 add X-UA-Compatible tag "to ensure the best rendering possible in each supported version of Internet Explorer."
Blacklight 5.8.2
Changes:
- Removed deprecation warnings in Rails 4.2
- Renamed *.css.scss files to *.scss
- Removed string keys: 'controller' and 'action' from the parameters passed to the URL helpers
- Fix default record email fields
Blacklight 5.8.1
Blacklight 5.8.1 addresses backwards incompatible behavior introduced in 5.8.0, including:
- #1037 adding deprecation warnings for
SolrHelper#blacklight_solr - #1042, #1043 Opening refworks and endnote actions without the modal behavior
- #1043 Incompatibility with methods defined in blacklight-marc
- #1045 Preserving the type of hash passed to
SolrRepository, fixing an incompatibility with applications that expectHashWithIndifferentAccess-like behavior
Blacklight 5.8.0
New Features and improvements
#908 Update render_document_class helper to support view-specific classes
#1005 Update render_document_class helper to support multi-valued fields, with a new class name for each value
#982 Store the current search results view in the session and use it by default for new search requests in that session
#986 When a facet, index, or show field does not have a label, or is not configured for display, construct a placeholder label using humanize (fixes #974)
#998 Provide an extendable action framework for customizing (and allowing plugins to customize) what actions are available for a document
#1019 Refactored the signature of #link_to_document helper to accept the label or solr field as an argument instead of an option in a hash
#1034 Extract Blacklight::SolrRepository out of SolrHelper for managing requests to Solr
UI
#925 Truncate long constraint values to avoid wrapping or side-scrolling behavior
#1007 Make the solr document presenter class part of the blacklight configuration
#1008 Update the search bar styling to use the bootstrap <select> styling and a responsive-sized search box
#1009 Update the "remove facet" glyphicon alignment and add a hover state
#1011 Improve the :focus state of the Bootstrap .navbar-toggle element on an inverse navbar (Blacklight's default)
Bug Fixes
#904 The pagination's current page should not be wrapped in an <a> tag
#1004 The pagination's "gap" element should not be a <a>
#907 Fix a divide-by-zero exception if the per_page value is 0
#921 Fix the "zero results" message; don't show the "try searching everything" message when the current search field is the same as the suggestion
#983 the out-of-the-box record email template should include the format (fixes a regression in 2a7898)
Development tools
#964 Provide a nil logger when SolrHelper is used outside an ActiveController context
#1012 Add blacklight:server rake task for starting and stopping solr and the rails server in development
Upgrade Guide
Prior to Blacklight 5.8, #render_show_doc_actions only rendered the Bookmarks control. With the document action framework, it now renders all the available document actions.