v1.1.0

Overview

ArcLight v1.1.0 is the culmination of work completed for the ArcLight Community Sprint 3 project, spanning Dec 4-15, 2023. The primary goals of the sprint were to resolve bugs, make accessibility improvements, and update documentation.

Many thanks to all participants in the sprint:

• Columbia University: @bonniegee
• Duke University: @mmmmcode , @seanaery
• Harvard University: @alexduryee, @dl-maura
• Indiana University: @randalldfloyd
• Stanford University: @corylown , @dinahhandel, @marlo-longley
• University at Albany: @gwiedeman
• University of North Carolina at Chapel Hill: @lfarrell

Breaking Change

The default component identifier format has changed in v1.1.0. Component IDs, and therefore the component URLs, now have an underscore separating the collection-level root_id and the component ref_id. E.g.:

• Old component path: /catalog/aoa271aspace_24d96d896c187b4e90ebb6c910f0462f
• New component path: /catalog/aoa271_aspace_24d96d896c187b4e90ebb6c910f0462f

If you wish to retain the old-style component IDs & URLs, please use the following to override the component_identifier_format provided in ead2_component_config.rb; note the omission of an underscore:

provide 'component_identifier_format', '%<root_id>s%<ref_id>s'

Find more about this change in #1478 and in the Indexing EAD docs on the ArcLight wiki.

Upgrade Notes

To upgrade an existing ArcLight 1.0.x application, please review all changes in files the arclight install_generator will create for a newly-generated app and update your existing versions of these files accordingly. This v1.1.0 version includes several revisions in these files:

• catalog_controller.rb
• locales/arclight.en.yml
• solr/conf/schema.xml
• solr/conf/solrconfig.xml

Completing this upgrade will require a full reindex to get all bugfixes and enhancements reflected in your UI. There may be a few areas in the UI that will not work well until the reindex is finished, e.g., breadcrumb links.

Accessibility Fixes

• Fix issues with duplicate item ids by @lfarrell in #1435
• Remove aria-hidden attribute by @lfarrell in #1473
• Don't link to currently selected document in the tree by @lfarrell in #1469
• Wrap grouped results in dl tag as their contents have dt and dd tags by @lfarrell in #1470
• Add "collapsible-hierarchy" as a prefix instead of as a suffix. by @lfarrell in #1475
• Show "View More/View Less" links as a darker color by @lfarrell in #1472
• Fix issue with breadcrumbs having invalid markup by @lfarrell in #1468
• Fix issue with duplicate ids on the page by @lfarrell in #1471

Bugfixes

• Ensures the display of containers only changes the case of first character. by @randalldfloyd in #1442
• Allow autocomplete items to wrap. Otherwise, very long suggestions can bleed off the screen. by @lfarrell in #1428
• Allow for multiple extents by @marlo-longley in #1446
• Fix issue with bookmarked records not staying checked by @lfarrell in #1465
• Update broken repository thumbnail links by @marlo-longley in #1485
• Align facets for subjects, places with terms used elsewhere by @bonniegee in #1489
• All <unitdates> now display by @gwiedeman in #1486
• Bugfix: retain the search scope and query terms in the search form on search results pages by @seanaery in #1504
• Fix template with generator by @marlo-longley in #1437

Display, Formatting, & Indexing Changes

• Convert XML <title> to HTML <span> by @marlo-longley in #1445
• Format all EAD link elements (extptr extref extrefloc ptr ref) by @seanaery in #1480
• Convert lb tags to br tags in HTML output by @lfarrell in #1484
• Adding missing elements from physdesc by @randalldfloyd in #1482
• Index date range years as integers rather than strings. Closes #1017. by @seanaery in #1444
• Format EAD index/indexentry and EAD table elements as HTML tables. Cl… by @seanaery in #1495
• Display related fields at component level by @marlo-longley in #1493
• Do not have components inherit collection-level acqinfo values. Close… by @seanaery in #1496
• Display <odd> at component and collection levels by @marlo-longley in #1498
• Adds creator field for components by @gwiedeman in #1501
• Fixes missing _html_tesm fields and <note>s by @gwiedeman in #1500
• Display the language field at the component level if present. Closes … by @seanaery in #1509
• Adds missing elements by @gwiedeman in #1466

Search and Relevance Improvements

• Fix typo in solr schema by @marlo-longley in #1440
• Set the default SearchHandler to just return all fields. Advances #532 by @seanaery in #1477
• Improve and document use of mm (minimum should match) param in Solr config by @seanaery in #1476
• Improve search relevance by enabling queries for ids, containers, language by @seanaery in #1487
• Boost relevance scoring when search terms appear in close proximity. Followup to #532. by @seanaery in #1506

Configuration Improvements

• Breaking change: component identifier format by @marlo-longley in #1478
• Replicate the configurable date & title normalizer classes from component config… by @seanaery in #1479

Dependency Updates

• Update .solr_wrapper by @cbeer in #1421
• Webdrivers dependency is no longer needed by @jcoyne in #1425

New Contributors

• @lfarrell made their first contribution in #1435
• @randalldfloyd made their first contribution in #1442
• @bonniegee made their first contribution in #1489

Full Changelog: v1.0.1...v1.1.0

v1.0.1

What's Changed

• Update README with v1.0 supported Ruby/Rails versions by @corylown in #1418
• Provide a checksum to solr_wrapper by @jcoyne in #1420
• Use the slots API in a v3 compatible way by @jcoyne in #1419

Full Changelog: v1.0.0...v1.0.1

v1.0.0

What's Changed

• rename master to main, update host org references to projectblacklight by @tampakis in #1039
• Remove outdated news update by @jcoyne in #1040
• Update dependencies in the README by @jcoyne in #1044
• Test on latest rails versions by @jcoyne in #1042
• Add ruby 3.1 to the test matrix by @jcoyne in #1041
• Remove cruft by @jcoyne in #1045
• Remove the Stickyfill polyfill by @jcoyne in #1043
• Remove unnecessary gems from Gemfile.extra. by @jcoyne in #1047
• Drop Rails 6.0.x support by @jcoyne in #1049
• Update rubocop rules by @cbeer in #1052
• Remove facet_limit_fortest by @cbeer in #1053
• Use HiddenSearchStateComponent by @cbeer in #1054
• Allow using the ScrollSpy component from Bootstrap 5 by @jcoyne in #1051
• Use the SearchBarComponent to override less upstream stuff by @cbeer in #1055
• Fix namespace of rubocop rule by @jcoyne in #1058
• Upgrade engine-cart stanza by @jcoyne in #1059
• Stop using deprecated method document_show_link_field by @jcoyne in #1062
• Don't configure show tools just to remove them later by @cbeer in #1064
• Address DEPRECATION WARNING: Initializing a Blacklight::Configuration::ViewConfig implicitly by @cbeer in #1063
• Avoid deprecated show_presenter method by @jcoyne in #1066
• Use the tag helper to replace some html_safe-ing by @cbeer in #1065
• Remove unnecessary use of Pathname by @jcoyne in #1060
• Rubocopping by @cbeer in #1068
• Explicitly configure the show partials by @cbeer in #1069
• Make controller concerns that want to be helpers, actually helpers by @cbeer in #1067
• Move fields_have_content? to the presenter by @jcoyne in #1071
• Remove unused helpers by @jcoyne in #1072
• Consolidate the view configurations by @cbeer in #1070
• Bugfix for view more truncator in Firefox (evaluate pixel height as i… by @seanaery in #1034
• Use an explicit, fully qualified name for the File class by @cbeer in #1075
• Remove unused teplates by @jcoyne in #1074
• Remove Gemfile.extra by @jcoyne in #1057
• Use the presenter to handle document fields by @cbeer in #1080
• Add a SolrDocument#parents accessor by @cbeer in #1079
• Use OpenStruct instead of implementing our own version by @cbeer in #1078
• Refactor breadcrumb methods to share some common behavior by @cbeer in #1077
• Avoid deprecation warning about filtering parameters. by @jcoyne in #1084
• Avoid a deprecated blacklight method render_opensearch_response_metadata by @jcoyne in #1086
• Avoid deprecated blacklight method render_grouped_document_index by @jcoyne in #1087
• Remove babel and webpacker by @jcoyne in #1082
• Pass documents to render_document_index to avoid blacklight deprecation by @jcoyne in #1094
• There is no discernable reason to have rexml in the Gemfile by @jcoyne in #1088
• Update the rubocop_todo.yml by @jcoyne in #1089
• Move the responsiveTruncator script to local (From vendor/) by @jcoyne in #1092
• Stop using Capybara in a deprecated way by @jcoyne in #1093
• Lookup the repository using the search_state by @jcoyne in #1097
• Adds :original_parents param to search_state_fields as an array by @corylown in #1100
• Update workflow by @jcoyne in #1102
• Move the configuration from the initializer to the catalog by @jcoyne in #1104
• Use public_send rather than send by @jcoyne in #1105
• Get rid of the BlacklightFieldConfigurationFactory by @cbeer in #1103
• Remove unused date distribution chart partial by @cbeer in #1111
• Remove orphaned partials by @cbeer in #1113
• Extract Arclight::SearchBarComponent by @cbeer in #1112
• Use a little flexbox so we don't need to override the sort + per page… by @cbeer in #1110
• Use repositories#index as the default home page by @cbeer in #1108
• Test the autocomplete functionality without depending on a specific i… by @jcoyne in #1109
• Render the SearchBarComponent by @jcoyne in #1085
• Bump the version by @cbeer in #1114
• Allow the install generator to fail gracefully by @jcoyne in #1116
• Allow assets to work when using importmap-rails by @jcoyne in #1118
• Add visually-hidden where sr-only is present by @jcoyne in #1119
• Use the Bootstrap 5 data attributes by @jcoyne in #1120
• Use search_state to do parameter lookups by @cbeer in #1099
• Fix slot API calls by @jcoyne in #1124
• Extract document-level components by @cbeer in #1123
• Reserve document actions for action-like things by @cbeer in #1127
• Stop overriding catalog/search_results by implementing our own constr… by @cbeer in #1126
• Extract Arclight::GroupComponent by @cbeer in #1125
• See if we can now lower the default_max_wait_time by @cbeer in #1128
• Clean up some helpers by @cbeer in #1134
• Remove blacklight_range_limit as a dependency by @jcoyne in #1136
• Pull out HTML formatting from Arclight::SolrDocument by @cbeer in #1137
• Require Ruby 3.0+ and Rails 7.0+ by @jcoyne in #1138
• Require Arclight rather than import by @jcoyne in #1139
• Use the presenters + components to render the abstract by @cbeer in #1140
• Fix typo by @jcoyne in #1141
• Use the strings set on the data attributes when truncating by @jcoyne in #1143
• Make Arclight::Repository an ActiveModel::Model,not an OpenStruct by @cbeer in #1145
• Move code out of the partial into the component class by @jcoyne in #1152
• Remove unnecessary 'that' by @jcoyne in #1156
• Add aria-expanded attribute to the collapse control by @jcoyne in #1160
• Replace jquery ajax with fetch() by @jcoyne in #1158
• Disentangle screenReader text from enablebuttons() by @jcoyne in #1159
• Add Bootstrap 5 compatible collapse markup by @cbeer in #1169
• Fix the suggest path by @cbeer in #1171
• Run bundle install in the lint pipelin...

v1.0.0.beta2

What's Changed since beta 1

• Deconflict the arclight logo from the blacklight logo by @jcoyne in #1404
• Update for Blacklight::DocumentComponent changes by @jcoyne in #1405
• Bump tested version of blacklight to beta7 by @jcoyne in #1402
• Convert oembed to stimulus by @jcoyne in #1406
• Stop looking for a flag in importmap javascript by @jcoyne in #1399

Full Changelog: v1.0.0.beta1...v1.0.0.beta2

Install directions

1. rails new my-app
2. cd my-app
3. bundle add arclight -v 1.0.0.beta2
4. bin/rails g blacklight:install --devise
5. bin/rails g arclight:install -f
6. bin/rails db:migrate
7. In one shell run solr_wrapper and in another shell start the dev server: bin/rails s

v1.0.0.beta1

Major themes

• Drop Rails 6 support, require Ruby 3.0+ and Rails 7.0
• Bootstrap 5
• Blacklight 8
• New customization options / componentization: use more view components
• Indexing: add hierarchical indexing, remove unused fields
• Display and styles: refine, improve accessibility and mobile. Implement collection navigation in sidebar like Duke.
• Javascript refactoring + front end assets: add importmaps compatibility, remove babel and webpacker, remove jQuery where we came across it in hopes of removing dependency altogether soon

What's changed

• rename master to main, update host org references to projectblacklight by @tampakis in #1039
• Remove outdated news update by @jcoyne in #1040
• Update dependencies in the README by @jcoyne in #1044
• Test on latest rails versions by @jcoyne in #1042
• Add ruby 3.1 to the test matrix by @jcoyne in #1041
• Remove cruft by @jcoyne in #1045
• Remove the Stickyfill polyfill by @jcoyne in #1043
• Remove unnecessary gems from Gemfile.extra. by @jcoyne in #1047
• Drop Rails 6.0.x support by @jcoyne in #1049
• Update rubocop rules by @cbeer in #1052
• Remove facet_limit_fortest by @cbeer in #1053
• Use HiddenSearchStateComponent by @cbeer in #1054
• Allow using the ScrollSpy component from Bootstrap 5 by @jcoyne in #1051
• Use the SearchBarComponent to override less upstream stuff by @cbeer in #1055
• Fix namespace of rubocop rule by @jcoyne in #1058
• Upgrade engine-cart stanza by @jcoyne in #1059
• Stop using deprecated method document_show_link_field by @jcoyne in #1062
• Don't configure show tools just to remove them later by @cbeer in #1064
• Address DEPRECATION WARNING: Initializing a Blacklight::Configuration::ViewConfig implicitly by @cbeer in #1063
• Avoid deprecated show_presenter method by @jcoyne in #1066
• Use the tag helper to replace some html_safe-ing by @cbeer in #1065
• Remove unnecessary use of Pathname by @jcoyne in #1060
• Rubocopping by @cbeer in #1068
• Explicitly configure the show partials by @cbeer in #1069
• Make controller concerns that want to be helpers, actually helpers by @cbeer in #1067
• Move fields_have_content? to the presenter by @jcoyne in #1071
• Remove unused helpers by @jcoyne in #1072
• Consolidate the view configurations by @cbeer in #1070
• Bugfix for view more truncator in Firefox (evaluate pixel height as i… by @seanaery in #1034
• Use an explicit, fully qualified name for the File class by @cbeer in #1075
• Remove unused teplates by @jcoyne in #1074
• Remove Gemfile.extra by @jcoyne in #1057
• Use the presenter to handle document fields by @cbeer in #1080
• Add a SolrDocument#parents accessor by @cbeer in #1079
• Use OpenStruct instead of implementing our own version by @cbeer in #1078
• Refactor breadcrumb methods to share some common behavior by @cbeer in #1077
• Avoid deprecation warning about filtering parameters. by @jcoyne in #1084
• Avoid a deprecated blacklight method render_opensearch_response_metadata by @jcoyne in #1086
• Avoid deprecated blacklight method render_grouped_document_index by @jcoyne in #1087
• Remove babel and webpacker by @jcoyne in #1082
• Pass documents to render_document_index to avoid blacklight deprecation by @jcoyne in #1094
• There is no discernable reason to have rexml in the Gemfile by @jcoyne in #1088
• Update the rubocop_todo.yml by @jcoyne in #1089
• Move the responsiveTruncator script to local (From vendor/) by @jcoyne in #1092
• Stop using Capybara in a deprecated way by @jcoyne in #1093
• Lookup the repository using the search_state by @jcoyne in #1097
• Adds :original_parents param to search_state_fields as an array by @corylown in #1100
• Update workflow by @jcoyne in #1102
• Move the configuration from the initializer to the catalog by @jcoyne in #1104
• Use public_send rather than send by @jcoyne in #1105
• Get rid of the BlacklightFieldConfigurationFactory by @cbeer in #1103
• Remove unused date distribution chart partial by @cbeer in #1111
• Remove orphaned partials by @cbeer in #1113
• Extract Arclight::SearchBarComponent by @cbeer in #1112
• Use a little flexbox so we don't need to override the sort + per page… by @cbeer in #1110
• Use repositories#index as the default home page by @cbeer in #1108
• Test the autocomplete functionality without depending on a specific i… by @jcoyne in #1109
• Render the SearchBarComponent by @jcoyne in #1085
• Bump the version by @cbeer in #1114
• Allow the install generator to fail gracefully by @jcoyne in #1116
• Allow assets to work when using importmap-rails by @jcoyne in #1118
• Add visually-hidden where sr-only is present by @jcoyne in #1119
• Use the Bootstrap 5 data attributes by @jcoyne in #1120
• Use search_state to do parameter lookups by @cbeer in #1099
• Fix slot API calls by @jcoyne in #1124
• Extract document-level components by @cbeer in #1123
• Reserve document actions for action-like things by @cbeer in #1127
• Stop overriding catalog/search_results by implementing our own constr… by @cbeer in #1126
• Extract Arclight::GroupComponent by @cbeer in #1125
• See if we can now lower the default_max_wait_time by @cbeer in #1128
• Clean up some helpers by @cbeer in #1134
• Remove blacklight_range_limit as a dependency by @jcoyne in #1136
• Pull out HTML formatting from Arclight::SolrDocument by @cbeer in #1137
• Require Ruby 3.0+ and Rails 7.0+ by @jcoyne in #1138
• Require Arclight rather than import by @jcoyne in #1139
• Use the presenters + components to render the abstract by @cbeer in #1140
• Fix typo by @jcoyne in #1141
• Use the strings set on the data attributes when truncating by @jcoyne in #1143
• Make Arclight::Repository an ActiveModel::Model,not an OpenStruct by @cbeer in #1145
• Move code out of the partial into the component class by @jcoyne in #1152
• Remove unnecessary 'that' by @jcoyne in #1156
• Add aria-expanded attribute to t...

v0.5.0

What's Changed

• Replace try with safe navigation by @jkeck in #1023
• Use suggest_index_catalog_path explicitly for the search form's … by @jkeck in #1026
• Fixes for Ruby 3.0 support by @anarchivist in #1030
• Update CI versions by @cbeer in #1036
• Bugfix for context nav when using Blacklight 7.13.0+ -- configures pa… by @seanaery in #1033
• template.rb now installs the latest release by @gwiedeman in #1006
• Off-by-one error on breadcrumb nesting issue #958 by @gordonleacock in #959
• Support Rails 7 by @cbeer in #1038

Full Changelog: v0.4.0...v0.5.0

v0.4.0

v0.3.3...v0.4.0

• Updates to allow for rails 6.1 compatibility
• Fixes bug with certain expand buttons in Contents tab #1008
• Fixes IE/Edge bug with +/- navigation #1009

Thanks to @cbeer, @jkeck, @mejackreed, & @seanaery for the contributions to this release.

Upgrade Note

The catalog controller is now generated with two additional facet configurations for component_level_isim and parent_ssim (source). The application uses these facets for querying documents for components like the Contents tab. In modern versions of Blacklight these facets need to be configured in order for the querying to work (even though they're never intended to be displayed).

You'll likely want to add these fields to your application configuration to ensure that the Arclight features continue to work as expected.

v0.3.3

v0.3.2...v0.3.3

• Updates height/width for BlacklightIcons
• Adds rails 6 support

v0.3.1

v0.3.0...v0.3.1

#986 adds Solr requirement to README
#991 Fixes a bug in the context navigation

v0.3.0

v0.3.0 represents the 2019 ArcLight Community Workcycle

Highlights include:

• Redesign/restyle
  • Search results
    • Updated list view
    • Compact view
    • Group by collection
  • Updated page header for components
  • Accessibility review
  • Updated component show page layout
  • Collection context tree revamp
  • Online content tab
  • Better responsive layout
• Search bar updates - search within collection
• Action box
  • Aeon integration
    • Web hosted EAD
    • External request endpoint (single item request)
  • Programmatic download links
• Language picker
• Rewritten indexing pipeline
  • Traject
  • Performance improvements
  • Parallelization
• Accessibility changes - both in ArcLight and upstream in Blacklight