Blacklight 5.6.0

Updates

#946 Require Bootstrap 3.2, and use bootstrap-sockets to fix asset pipeline problems with bootstrap-provided fonts, images, etc.

Upgrade guide

If you want to use bootstrap-sockets, you'll need to add it to your application in app/assets/stylesheets/blacklight.css.scss, e.g.

@import 'bootstrap-sprockets';
@import 'bootstrap';
@import 'blacklight/blacklight';

Blacklight 5.5.3

Bug fixes

#960 Words break when facet labels are too long
#958 Don't show "more" link for every facet
#962 Added missing SMS POST route
#963 Set the stylesheets to media=all so printed pages look better
#965 Corrected SMS carrier email addresses
#957 Catalog partial path lookup to include the view root too

v5.5.2

Bug fixes

#953 Fix another regression in FacetPaginator to allow the paginator to work with multiple pages
#951 Allow #back_to_search helper to work when no search is available
#944 Allow :route_set option for #render_constraints_query
#920 Hide view types if there are no results

Updates and other improvements

#950 Update to rspec3
#949 Test Blacklight against Solr 4.9
#947 Test Blacklight against the latest versions of Rails 3.2, 4.0, and 4.1
#945 Use Rails APIs to discover appropriate document type partials

Version 5.5.1

Bug fixes

#942 FacetPaginator paginates the results passed in, but they're already paginated by solr. Fixed by (#943)

v5.5.0

Commit History | Milestone

New Features and improvements

#888 Improve the responsive design of the facet sidebar to maintain a 2-column layout on tablet-sized browsers
#913 Update the AJAX Modal to detect and gracefully handle network errors
#914 Extract catalog/search_results partial from catalog/index to render the search result, search controls, etc.
#919 Add debug logging to the solr document partial lookup logic

Bug Fixes

#918 Ignore an empty f[facet][] query parameter.
#922 Update the bookmarks HTML to match the expected bootstrap form DOM
#928 Fix the FacetPaginator for kaminari 0.16
#935 Support i18n keys for constraint field labels
#940 Update the constraints HTML to remove a bad anchor tag

Upgrade Guide

v5.4.0

Commit History | Milestone

New Features and improvements

#864 Configuration for facets, index and show fields, sort fields, and document_index_views should support configurable if and unless constraints
#852 support bookmark export using a callback url
support Rails 4.1
polymorphic associations from bookmarks to solr documents

New translations

#854 Add pt-BR translation (h/t @rvalyi)

Bug Fixes

#872 render_document_index helper should pass locals through to the templates
#868 clicking a facet label should not scroll the user's browser
#866 escape date values for sending to solr
#850 search bar in Firefox is truncated
#848 set the Solr :row parameter if no default parameter is provided
#880 bookmark cite and email links should be restricted to the current page

Upgrade Guide

• This release includes a new database migration. After updating the gem, you should also run:

  $ rake blacklight:install:migrations

  to get the latest migrations.

• If you are running Rails 3, you MUST set Blacklight.secret_key in an initializer. Consider using something like value of SecureRandom.hex(64) to seed this secret. This value should be private.

  Under Rails 4, Blacklight will use the application-wide secret key base.

Blacklight 5.3.0

Commit History | Milestone

New Features and improvements

• #840 add blacklight_config.show.route configuration for generating links to solr documents
• #842 extract#type_field_to_partial_name helper to translate a document format to a partial suffix
• #845 extract useful partials and helpers from layouts/blacklight so local applications can override the layout, but continue to use blacklight-provided functionality
• #846 add blacklight:check:solr and blacklight:check:controller rake tasks for validating Blacklight's connection to Solr

Bug Fixes

• #844 Fix the "Back to Search" behavior (arguably broken since Blacklgiht 4.5) from search results not on the first page. The new behavior also ensures if the user navigates to a result using the catalog#show pagination, the Back to Search link returns them to the search result page that includes their current document, not the one they started from.
• Fix ajax modal form selector to ensure forms within an ajax modal stay within the modal

Blacklight 5.2.0

Commit History | Milestone

This release contains a number of new features, but most importantly adds compatibility with Rails 4.1 and Ruby 2.1.1.

New Features and improvements

#787 Extract DocumentPresenter module from BlacklightHelperBehavior methods

#788 Extract RequestBuilder module from SolrHelper

#811 Add Spanish locale file

#783 add :include_in_request configuration option to augment add_facet_fields_to_solr_request! and add_field_configuration_to_solr_request!

#819 Add new configuration options for Solr requests for single documents, document_solr_path and document_unique_id_param, allowing Blacklight to work with the RealTimeGetComponent in Solr 4.x

#818 Add default_per_page configuration to the Blacklight configuration

#814 Generate jettywrapper as part of the blacklight:install process

#796 OpenStructWithHashAccess should respond to #to_json/#as_json as if it were a hash

#795 Facet HTML id attributes should be a parameterized version of the field name, not the field label

#794 Add more configuration examples to the generated blacklight config

#831 pass the current partial name to the document_partial_name helper, to allow partial-specific formats for documents

Bug Fixes

#821 Fix catalog#opensearch view under Rails 3.x

#791 Use ActiveSupport::Benchmarkable with instance-level accessors, not class-level accessors

#786 Ensure page titles are HTML safe

#785 Fix two-arg form of SolrHelper#find to pass through the solr request path

#780 remove unused #history_session accessor

#778, #808, #806, #798 General test suite improvements

Upgrade Notes

The HTML ID change in #795 may be backwards-incompatible in some applications. If your application's css or javascript uses the old-style HTML id calculation, you will need to either update your assets to use the new ID, or override the #facet_field_id helper to restore the old behavior.

Blacklight 5.1.0

Commit History | Milestone

New Features

• #764 Support for wild-card based field configuration, e.g.

config.add_facet_field '*_facet'
config.add_show_field '*_display'
config.add_index_field 'title_*'

• #762 Add solr_params configuration option for index, show and facet fields to add field-scoped parameters to the solr request.

config.add_index_field 'an_index_field', solr_params: { 'hl.alternativeField' => 'field_x'}
config.add_show_field 'a_show_field', solr_params: { 'hl.alternativeField' => 'field_y'}
config.add_field_configuration_to_solr_request!
config.add_facet_field 'some-field', solr_params: { 'facet.mincount' =>15 }
config.add_facet_fields_to_solr_request!

• #761 Add configuration for registering additional search result (catalog#index) response formats

    config.index.respond_to.yaml = true
    config.index.respond_to.yaml = { layout: 'custom-layout' }

Bug fixes and improvements

• #766 Update InvalidSolrID rescuing to provide a regular HTTP 404 page instead of rendering the search page with a flash message.
• #777 Merge the code for rendering facets at catalog#facetwith the code that renders facets on a search results page. This fixes also fixes bug where facets configured with single: true would not be rendered correctly on catalog#facet.
• #776 Updates Blacklight-provided URL helpers (e.g.link_to_query) to use #search_action_url and #search_action_path to ensure they can be properly used outside of a Blacklight::Catalog instance, or within another Rails engine.

This also adds #search_action_path, an equivalent to #search_action_url, producing a relative path instead of an absolute URL

• #774 When rendering the Blacklight thumbnail partial, allow the renderer to disable linking the thumbnail to the search result (the default)

Blacklight 5.0.2

Commit History | Milestone

This release fixes two defects discovered in Blacklight 5.0.1:

• #772 Multiple form submit events sent when using ajax-modal
• #757 Remove unnecessary .navbar-default class from navbar