Blacklight 5.0.1

Commit History | Milestone

Bug Fixes

This release fixes a minor packaging bug in Blacklight 5.0.0.

Blacklight 5.0.0

Commit History | Milestone

Major Changes

Bootstrap 3 (#640)

Blacklight 5.x updates the views and helpers to use Bootstrap 3.x. As part of this update, we've tweaked the default theme to align closer with Bootstrap conventions. This is a major change, and applications that have overridden the Blacklight / Bootstrap 2.x themes will need to be updated.

MARC-specific code extracted into blacklight-marc (#606)

We've extracted the library / MARC-format specific code from Blacklight into a separate gem, http://github.com/projectblacklight/blacklight_marc. Going forward, this gem will be a home for additional MARC-specific features that wouldn't make sense in the Blacklight core.

Remove deprecated code and views

Deprecated methods and templates have been marked as deprecated in Blacklight 4.x releases and have been removed in Blacklight 5.x.

Other methods have been marked as deprecated in Blacklight 5.x (to be removed in Blacklight 6.x):

• Blacklight.solr (use #blacklight_solr accessor instead)
• config.show and config.index parameters have been re-organized to use consistent methods

Features

#640 (and #642, #643, #651, #667, #671, #675, #677, #713, #720) Convert front end to Bootstrap 3 and improve default Blacklight theme.

#606 Refactor MARC-specific code from Blacklight into a separate blacklight-marc gem

#665 Add interface for building the Solr request parameters (instead of modifying a ruby hash directly)

#683 Allow blacklight's catalog configuration to control partials to render for index and show views

#680 Simple schema.org support in the Blacklight configuration

#721 Search results view type picker

#716 Add :collapse to add_facet_field configuration to determine if the facet should be displayed collapsed (the default) or expanded

#697 Add :accessor to add_index/show_field configuration to call a method on the SolrDocument instead of looking in a solr field for a value.

Improvements

#657 Improve the AJAX modal (details in ticket)

#656 Use a 303 See Other redirect to redirect from catalog#update to the catalog#show page (triggered by the search context javascript)

#655 Catalog controller routes should be configurable

#684 page_entries_info should use Rails-formatted numbers

#681 update blacklight-jetty to use Solr 4.6.0

#711 RSolr can be configured to use POST requests instead of PUT

#714 Ensure view types persist between searches

#729 Better support for different index views

#658 Remove zebra_stripe.js

Upgrade guide

1. Update your application to the terminal Blacklight 4.x release (4.7.0, as of this writing) to receive notices of deprecated behaviors used in your local application.

2. remove the line @import 'bootstrap-responsive'; from app/assets/stylesheets/blacklight.css.scss. This file has been removed in Bootstrap 3.

3. The FeedbackController (deprecated in 4.x) has been removed. If your application used this feature from Blacklight, consider a 3rd party implementation or roll your own.

4. Update your Gemfile to use Blacklight 5.0.0.

        gem 'blacklight', ' ~> 5.0'
   

5. Add the blacklight-marc gem to your Gemfile. If you are not using MARC-flavor metadata, you can omit them gem, and remove any references to Blacklight::Solr::Document::Marc from your SolrDocument class.

6. Update your CatalogController configuration to:

   • rename config.show.html_title to config.show.title_field

   • rename config.show.heading to config.show.title_field

   • rename config.show.display_type to config.show.display_type_field

   • rename config.index.show_link to config.index.title_field

   • rename config.index.record_display_type to config.index.display_type_field

     Note: config.show can be omitted if the fields to render are the same

Blacklight 4.7.0

Commit History

Blacklight 4.7.0 provides deprecation warnings and backports of features from Blacklight 5.0. It is the terminal release of Blacklight 4.x. Many of the listed features and deprecations were released as part of Blacklight 4.6 point releases.

Backports:

#711 Allowing solr query to use either get or post http method based on the http_method configuration parameter
#714 View type should persist between searches
#717 Add configuration options to add_facet_field 'field', :show => to allow "run-time" configuration when the solr data and request context are available, with a couple different options.
Add i18n strings for displaying index and show field labels
Add blacklight_solr and blaclight_solr_config helpers to Blacklight::SolrHelper

Deprecation warnings (including directions for updating to non-deprecated methods) are provided inline and as logged deprecation warnings.

Deprecated classes include:

• FeedbackController
• Mash

Deprecated helpers include:

• sidebar_items
• topbar_items
• default_html_head
• extra_head_content
• stylesheet_links
• javascript_includes
• render_head_content
• render_stylesheet_includes
• render_js_includes
• render_extra_head_content
• adjust_for_results_view
• render_pagination_info
• paginate_params
• paginate_rsolr_response
• adjust_for_results_view
• format_num
• index_field_names
• index_field_labels
• document_show_field_labels
• response_has_no_search_results?
• hash_as_hidden_fields
• citation_title

Other deprecations include:

• Blacklight.solr
• Blacklight.models_dir
• Blacklight.controllers_dir
• Blacklight.jruby?
• Blacklight.locate_path
• Hash#to_mash
• User#has_bookmarks?
• User#has_searches?
• User#documents_to_bookmark=

Blacklight 4.6.3

Commit History | Milestone

We’ve released Blacklight 4.6.3 with more deprecations and backports from the
Blacklight 5.x work:

Deprecations:

• FeedbackController
• #paginate_rsolr_response helper

Backports:

• #711 Allowing solr query to use either get or post http method based on the http_method configuration parameter
• #714 View type should persist between searches
• #717 Add configuration options to add_facet_field 'field', :show => to
  allow "run-time" configuration when the solr data and request context
  are available, with a couple different options.

Blacklight 4.6.0

Commit History | Milestone

Deprecation Warnings

Blacklight 4.6.0 introduces a number of deprecation warnings for features that will be removed in the upcoming Blacklight 5.0 release. Many of these features pre-date improvements made in Rails which render them obsolete. Deprecated methods include:

• sidebar_items
• topbar_items
• default_html_head
• extra_head_content
• stylesheet_links
• javascript_includes
• render_head_content
• render_stylesheet_includes
• render_js_includes
• render_extra_head_content
• adjust_for_results_view
• render_pagination_info
• index_field_names
• index_field_labels
• document_show_field_labels

Features

Move search results header content (did you mean, constraints, sort and per page tools, etc) into an overridable partial

Improvements

When removing the no-js class on , also add a js class

Provide kaminari-compatible implementations of #page_entries_info, and deprecate our custom #render_pagination_info.

Improve the pagination info text with only a single result.

#636 Fix a Rails 4.0.1 regression with the more-like-this feature

Blacklight 4.5.0

Commit History | Milestone

Features

#613 Add friendly error page when no search results are found

#619 (and #605) Store and retrieve "search history context" in the database, and add multi-tab search support for blacklight-4.3

Improvements

#621 Extract Blacklight::Base module out of Blacklight::Catalog with all the methods needed to work with Blacklight::SolrHelper

#615 Refactor the catalog/index.html.erb template to render e.g. facets in a separate partial

#629 Pass the Blacklight field configuration through to render_field_value, so we can pull a field-specific separator out as needed

#627 add :document_counter to render_document_partial call in atom builder

#626 JSON response from CatalogController#index can be overridden

#622 License missing from gemspec

Blacklight 4.5.0 Release Candidate 1

Commit History | Milestone

Features

#613 Add friendly error page when no search results are found

#619 (and #605) Store and retrieve "search history context" in the database, and add multi-tab search support for blacklight-4.3

Improvements

#621 Extract Blacklight::Base module out of Blacklight::Catalog with all the methods needed to work with Blacklight::SolrHelper

#615 Refactor the catalog/index.html.erb template to render e.g. facets in a separate partial

#627 add :document_counter to render_document_partial call in atom builder

#626 JSON response from CatalogController#index can be overridden

#622 License missing from gemspec

Blacklight 4.4.2

Commit History | Milestone

Bug Fixes

• #614 Support Kaminari master, but including Kaminari::ConfigurationMethods into our SolrResponse pagination.

Other improvements

• #618 Prune dead code for "result_view"
• #610 Add facet labels to the json response
• Adjust bookmark and refworks forms to style the submit tag, instead of adding a link-styled-as-abutton
• Address deprecation warnings (Relation#all, mock => double)
• Use the Rails url_options to construct ActionMailer URLs

Blacklight 4.4.1

Commit History | Milestone

Bug Fixes

• Various fixes to the thumbnail templates

Other improvements

• add Blacklight::Solr::Document#first to retrieve the first value from a field
• add facet=true to the solr request when config.add_facet_fields_to_solr_request is true
• pass the document_counter when rendering the document index partial

Blacklight 4.4.0

Commit History | Upgrade Guide | Milestone

Features

• #598 Show thumbnails (if available) for documents in search results
• #594 Provide Blacklight configuration support for linking field values to facets
• #589 Support Rails 4.x-style turbolinks (Blacklight-provided javascript should be loaded on document ready or the page:load event)
• #588 Provide an (experimental) JSON API for search and show
• #577 Add Solr Field Collapsing feature, if the Solr response includes a grouped element.

Bug Fixes

• #640 Fix the solr query Blacklight generates when the query contains Solr "local parameters" containing digits (e.g. $pf2_value)
• #590 Fix transferring unregistered guest user bookmarks to a newly registered user
• #587 Fix Zotero support, where ampersands in the context object were being double escaped
• #534 Blacklight::CatalogHelperBehavior#paginate_params values of first_page? and last_page? incorrectly set?
• #525 Add i18n support to Bookmarks javascript replacement
• #585 Add keyboard accessibility to the facet expanders
• #563 Login page should have focus in the email field, not the search field.

Other Improvements

• #600 Decomposing blacklight generator
• #599 Improving speed of blacklight generator
• #597 Rewrite document_counter logic in header
• #596 Don't generate devise views by default
• #595 Support kaminari pagination helpers in Blacklight::SolrResponse (kaminari can now work with our SolrResponse objects natively).
• #591 Remove cucumber. All features have been ported to rspec feature tests.
• #584 Move onload_text out of layouts/blacklight.html.erb
• #515 Ensure we run bundle install after generating bootstrap-sass into the Gemfile
• Update lightbox_dialog.js - Adding an event for DOM change when modal is already shown
• #607 Refactor catalog#email and catalog#sms methods
• #609 The solr facet :ex local parameter should work with pivot and facet
  field configurations.
• Convert some bare strings to i18n strings
• #608 Use ActiveRecord query methods in Blacklight::User mixin

Upgrade Guide

If you've overridden the catalog/sms.html.erb template or RecordMailer#sms action (e.g. to add custom SMS provider mappings), you should look at the changes in this patch, which moved the mappings and validation into the controller.