arclight 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa0be8b6a63486a158607273080d3bc226029d05c8d8b76b73f72a60dc6afa3
-  data.tar.gz: 155b435d83af03435aff13db82a1509148da62a84fa960135d1c73b5dfa335ae
+  metadata.gz: cc33edce733f7fd511703a9d4b1b7fa7152dc7136a5c0ff06d6cb08891e7bdb4
+  data.tar.gz: f698894daf2a17d75db46a8cbc8c8517aaee3168ae62caa6c21f4bb9b5b9e310
 SHA512:
-  metadata.gz: 22eeea5a79c6fc8a777a42eff6f9c0ebd2be7bead5a4a3e92277be5a88936b5628b89042999c7b21c3963824767dadc0448f9912ebf9d76fbd9b630e98dfa7e6
-  data.tar.gz: d5b7a8fa47adfa754db93b8fe0012b7bf51c38f6c10a801b762610b4ca0621fae43a9f80cef4bb71264a90ecebb2bfe002f6b99b02ab36698e86fda7e10e6842
+  metadata.gz: 16bbb85fa76bf4003cbc8dbcc38299ba6c7461c0fbc952ee02dbcfddc8ec19fa37f04b595de248a4bd6c39ce69a083f607a6a17a64aa043a94026b4a5249de36
+  data.tar.gz: d176c37652331ad6b229412caaf5488cd84cb06a555bc48dd7c4184fabda4ff1f47e8927c8babe7eaeb6fc665c63faf6ec4ebfc5b16b6f89247aec9ac9b1830d

data/.gitignore

@@ -9,6 +9,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/app/assets/builds/
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -117,7 +117,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 When any of the javascript components or SASS sources in the gem are changed, this package should be published to NPM with the following steps:
 1. [Install npm](https://www.npmjs.com/get-npm)
 2. Bump the version number in `package.json`
-3. run `npm publish` to push the javascript package to https://npmjs.org/package/arclight
+3. run `npm run build && npm publish` to push the javascript package to https://npmjs.org/package/arclight
 
 ## Contributing
 

data/app/assets/stylesheets/arclight/build.scss

@@ -0,0 +1,4 @@
+@import "bootstrap/scss/functions";
+@import "bootstrap/scss/mixins/breakpoints";
+@import "bootstrap/scss/variables";
+@import "application";

data/app/assets/stylesheets/arclight/modules/hierarchy_and_online_contents.scss

@@ -46,11 +46,16 @@ $hierarchy-view-collapse-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3
     display: none;
   }
 
-  turbo-frame[loading]:not([complete]) {
-    &::after {
-      @extend .placeholder !optional;
+  turbo-frame[busy] {
+    &::before {
       animation: placeholder-glow 2s ease-in-out infinite;
-      content: 'Loading...';
+      background-color: currentcolor;
+      content: "Loading...";
+      cursor: wait;
+      display: inline-block;
+      min-height: 1em;
+      opacity: 0.5;
+      vertical-align: middle;
       display: inline-block;
       margin-left: 1.5rem;
     }
@@ -101,8 +106,8 @@ $hierarchy-view-collapse-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3
 
 .title-container {
   border-bottom: $border-width solid $border-color;
-  padding-bottom: $spacer * .5;
-  margin-bottom: $spacer * .75;
+  padding-bottom: $spacer * 0.5;
+  margin-bottom: $spacer * 0.75;
   display: grid;
   gap: 0.5rem;
   grid-template-areas:
@@ -142,7 +147,7 @@ $hierarchy-view-collapse-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3
   .online-contents {
     grid-area: online-contents;
     margin-bottom: 1rem;
-  
+
     h2 {
       font-size: 1rem;
       text-transform: uppercase;

data/app/assets/stylesheets/arclight/modules/icons.scss

@@ -1,5 +1,7 @@
-
-.toggle-bookmark, .breadcrumb-item, .document, .al-online-content-icon {
+.toggle-bookmark,
+.breadcrumb-item,
+.document,
+.al-online-content-icon {
   .blacklight-icons svg {
     height: 1rem;
     width: 1rem;
@@ -11,5 +13,5 @@
 }
 
 .btn > .bi:first-child {
-  @extend .me-1
+  margin-inline-end: 0.25rem !important;
 }

data/app/assets/stylesheets/arclight/modules/layout.scss

@@ -7,7 +7,7 @@
 .al-show-breadcrumb {
   border-bottom: $border-width solid $border-color;
   padding-bottom: $spacer;
-  margin-bottom: $spacer * .75;
+  margin-bottom: $spacer * 0.75;
   width: 100%;
 
   $bent-arrow: "data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' width='20' height='15'><path fill-rule='evenodd' d='M1.5 1.5A.5.5 0 0 0 1 2v4.8a2.5 2.5 0 0 0 2.5 2.5h9.793l-3.347 3.346a.5.5 0 0 0 .708.708l4.2-4.2a.5.5 0 0 0 0-.708l-4-4a.5.5 0 0 0-.708.708L13.293 8.3H3.5A1.5 1.5 0 0 1 2 6.8V2a.5.5 0 0 0-.5-.5z'></path></svg>";
@@ -53,7 +53,9 @@
     }
   }
 
-  .breadcrumb-item-1, .breadcrumb-item-4 { // breadcrumb-item-3 can have multiple on one line
+  .breadcrumb-item-1,
+  .breadcrumb-item-4 {
+    // breadcrumb-item-3 can have multiple on one line
     flex: 1 0 100%;
     color: $gray-600;
   }
@@ -100,14 +102,14 @@
   border: $default-border-styling;
   background-color: $gray-200;
   font-size: $font-size-sm;
-  padding: ($spacer * .5) $spacer ($spacer * .75);
+  padding: ($spacer * 0.5) $spacer ($spacer * 0.75);
 
   @media (max-width: 767px) {
     margin-top: $spacer;
   }
 
   .al-collection-id {
-    margin-bottom: $spacer * .75;
+    margin-bottom: $spacer * 0.75;
   }
 
   &-options {
@@ -153,12 +155,16 @@
 }
 
 .show-document {
-  @extend .ps-lg-4;
-
   .title-container .bookmark-toggle {
-    @extend .card;
-    @extend .bg-light;
-    @extend .p-2;
+    border: var(--bs-card-border-width) solid var(--bs-card-border-color);
+    background-color: rgba(var(--bs-light-rgb), var(--bs-bg-opacity));
+    padding: 0.5rem;
+  }
+}
+
+@media (min-width: 992px) {
+  .show-document {
+    padding-left: 1.5rem !important;
   }
 }
 
@@ -177,7 +183,10 @@ dl.deflist dt {
   text-align: left;
 }
 
-.chronlist-head, .list-head, .index-head, .table-head {
+.chronlist-head,
+.list-head,
+.index-head,
+.table-head {
   caption-side: top;
   font-size: 1.25rem;
   font-weight: 500;

data/app/assets/stylesheets/arclight/modules/mastheads.scss

@@ -1,9 +1,13 @@
 .navbar-search {
+  border-bottom: $default-border-styling;
+  border-top: $default-border-styling;
+  margin-bottom: ($spacer * 0.5);
   z-index: 10;
+
   .search-query-form {
-    max-width: 100% !important;   // work around blacklight styles
+    max-width: 100% !important; // work around blacklight styles
     display: flex;
-    gap: .5rem;
+    gap: 0.5rem;
 
     // wrap collection dropdown onto its own line on smaller screens
     @include media-breakpoint-down(md) {
@@ -22,9 +26,12 @@
 }
 
 .al-masthead {
-  h1, .h1 {
+  --al-mastead-active-link-color: var(--bs-gray-700);
+  --al-masthead-title-size: #{$h2-font-size};
+
+  .h1 {
     display: block;
-    font-size: $h2-font-size;
+    font-size: var(--al-masthead-title-size);
     margin: 0;
     padding: ($spacer * 1.5) ($spacer * 0.5);
   }
@@ -33,31 +40,8 @@
     flex-direction: row;
     font-weight: 700;
 
-  .active a {
-      color: $gray-700;
-    }
-  }
-
-  + .navbar-search {
-    border-bottom: $default-border-styling;
-    border-top: $default-border-styling;
-    margin-bottom: ($spacer * 0.5);
-
-    a {
-      font-weight: $font-weight-bold;
-    }
-
     .active a {
-      color: $gray-700;
-    }
-
-    .navbar-toggler {
-      background-color: $white;
-      border: $default-border-styling;
-    }
-
-    .navbar-toggler-icon {
-      background-image: $navbar-light-toggler-icon-bg;
+      color: var(--al-mastead-active-link-color);
     }
   }
 
@@ -66,8 +50,7 @@
       justify-content: center !important;
     }
 
-    h1,
-    + .navbar-search {
+    h1 {
       text-align: center;
     }
   }

data/app/assets/stylesheets/arclight/modules/search_results.scss

@@ -35,7 +35,7 @@
     }
 
     .al-document-abstract-or-scope {
-      margin-bottom: $spacer * .5;
+      margin-bottom: $spacer * 0.5;
       max-width: 45em;
     }
   }
@@ -51,7 +51,7 @@ article.document {
   div.breadcrumb-links,
   dd.al-document-abstract-or-scope,
   dd.al-document-creator {
-    margin-top: ($spacer * .5);
+    margin-top: ($spacer * 0.5);
   }
 
   form.bookmark-toggle.col-auto {
@@ -66,12 +66,12 @@ article.document {
 
   .al-document-abstract-or-scope {
     margin-bottom: 0;
-    margin-top: $spacer * .75;
+    margin-top: $spacer * 0.75;
     max-width: 45em;
   }
   .al-grouped-repository {
     font-size: $font-size-sm;
-    margin-bottom: $spacer * .75;
+    margin-bottom: $spacer * 0.75;
   }
   .al-grouped-title-bar {
     background-color: $gray-200;
@@ -91,7 +91,7 @@ article.document {
     .al-grouped-more {
       border-bottom: $default-border-styling;
       margin-bottom: $spacer;
-      padding: ($spacer * .5) 0;
+      padding: ($spacer * 0.5) 0;
     }
 
     .document {
@@ -121,7 +121,6 @@ article.document {
   margin-bottom: ($spacer * 3) !important;
 }
 
-
 // Compact Search Results
 .documents-compact {
   margin-bottom: $spacer;
@@ -147,7 +146,7 @@ article.document {
 
 .index-document-functions {
   display: flex;
-  @extend .justify-content-end;
+  justify-content: flex-end !important;
 }
 
 .al-document-container.text-muted {
@@ -176,13 +175,14 @@ article.document {
 
 .breadcrumb-links .col {
   flex-basis: auto;
- }
+}
 
 .btn-outline-secondary svg {
   fill: $gray-600;
 }
 
-.btn-outline-secondary:not(:disabled):not(.disabled).active svg, .btn-outline-secondary:hover svg {
+.btn-outline-secondary:not(:disabled):not(.disabled).active svg,
+.btn-outline-secondary:hover svg {
   fill: $white;
 }
 
@@ -197,11 +197,10 @@ article.document {
   justify-content: flex-end;
 }
 
-
 .result-type-group {
   order: -1;
   flex-grow: 1;
-  &.btn-group>.btn {
+  &.btn-group > .btn {
     flex-grow: 0;
   }
 }
@@ -246,6 +245,5 @@ article.document {
     .bookmark-toggle {
       display: none;
     }
-
   }
 }

data/app/components/arclight/collection_sidebar_component.rb

@@ -29,13 +29,11 @@ module Arclight
     end
 
     def document_path
-      @document_path ||= solr_document_path(normalized_eadid)
+      @document_path ||= solr_document_path(document.collection_id)
     end
 
     def section_anchor(section)
       "##{t("arclight.views.show.sections.#{section}").parameterize}"
     end
-
-    delegate :normalized_eadid, to: :document
   end
 end

data/app/models/arclight/parents.rb

@@ -29,7 +29,7 @@ module Arclight
     # @param [SolrDocument] document
     def self.from_solr_document(document)
       ids = document.parent_ids
-      legacy_ids = document.legacy_parent_ids.map { |legacy_id| document.eadid == legacy_id ? legacy_id : "#{document.eadid}#{legacy_id}" }
+      legacy_ids = document.legacy_parent_ids.map { |legacy_id| document.collection_id == legacy_id ? legacy_id : "#{document.collection_id}#{legacy_id}" }
       labels = document.parent_labels
       eadid = document.eadid
       levels = document.parent_levels

data/app/models/concerns/arclight/solr_document.rb

@@ -7,6 +7,7 @@ module Arclight
     extend ActiveSupport::Concern
 
     included do
+      attribute :collection_id, :string, '_root_'
       attribute :parent_ids, :array, 'parent_ids_ssim'
       attribute :legacy_parent_ids, :array, 'parent_ssim'
       Arclight.deprecation.deprecate_methods(self, legacy_parent_ids: 'Use `parent_ids` instead')
@@ -50,6 +51,7 @@ module Arclight
     def normalized_eadid
       Arclight::NormalizedId.new(eadid).to_s
     end
+    Arclight.deprecation.deprecate_methods(self, normalized_eadid: 'Use `collection_id` instead')
 
     def repository
       first('repository_ssm') || collection&.first('repository_ssm')

data/lib/arclight/normalized_id.rb

@@ -5,9 +5,11 @@ require 'arclight/exceptions'
 module Arclight
   ##
   # A simple utility class to normalize identifiers
-  # to be used around the application for linking
   class NormalizedId
-    def initialize(id)
+    # Accepts unused kwargs from the ead2_config.rb id to_field directive
+    # (:title and :repository) so that applications can provide a custom
+    # id_normalizer class to traject to form the collection id from these attributes.
+    def initialize(id, **_kwargs)
       @id = id
     end
 

data/lib/arclight/traject/ead2_config.rb

@@ -6,6 +6,7 @@ require 'traject/nokogiri_reader'
 require 'traject_plus'
 require 'traject_plus/macros'
 require 'arclight/level_label'
+require 'arclight/normalized_id'
 require 'arclight/normalized_date'
 require 'arclight/normalized_title'
 require 'active_model/conversion' ## Needed for Arclight::Repository
@@ -53,6 +54,7 @@ DID_SEARCHABLE_NOTES_FIELDS = %w[
 
 settings do
   provide 'component_traject_config', File.join(__dir__, 'ead2_component_config.rb')
+  provide 'id_normalizer', 'Arclight::NormalizedId'
   provide 'date_normalizer', 'Arclight::NormalizedDate'
   provide 'title_normalizer', 'Arclight::NormalizedTitle'
   provide 'reader_class_name', 'Arclight::Traject::NokogiriNamespacelessReader'
@@ -75,7 +77,13 @@ end
 # NOTE: All fields should be stored in Solr
 # ==================
 
-to_field 'id', extract_xpath('/ead/eadheader/eadid'), strip, gsub('.', '-')
+to_field 'id' do |record, accumulator|
+  id = record.at_xpath('/ead/eadheader/eadid')&.text
+  title = record.at_xpath('/ead/archdesc/did/unittitle')&.text
+  repository = settings['repository']
+  accumulator << settings['id_normalizer'].constantize.new(id, title: title, repository: repository).to_s
+end
+
 to_field 'title_filing_ssi', extract_xpath('/ead/eadheader/filedesc/titlestmt/titleproper[@type="filing"]')
 to_field 'title_ssm', extract_xpath('/ead/archdesc/did/unittitle')
 to_field 'title_tesim', extract_xpath('/ead/archdesc/did/unittitle')

data/lib/arclight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arclight
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arclight",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "The frontend for arclight",
   "main": "app/assets/javascript/arclight/arclight.js",
   "files": [
@@ -9,9 +9,12 @@
   "devDependencies": {
     "eslint": "^8.26.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.2.0"
+    "eslint-plugin-import": "^2.2.0",
+    "sass": "^1.59.3",
+    "bootstrap": "^5.2.0"
   },
   "scripts": {
+    "build": "sass ./app/assets/stylesheets/arclight/build.scss:./app/assets/builds/arclight.css --no-source-map --load-path=node_modules",
     "lint": "eslint './app/assets/javascripts/**/*.{js,es6}'",
     "lint:fix": "eslint --fix './app/assets/javascripts/**/*.{js,es6}'",
     "test": "echo \"Error: no test specified\" && exit 1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arclight
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Darren Hardy
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -314,6 +314,7 @@ files:
 - app/assets/javascripts/arclight/oembed_controller.js
 - app/assets/javascripts/arclight/truncate_controller.js
 - app/assets/stylesheets/arclight/application.scss
+- app/assets/stylesheets/arclight/build.scss
 - app/assets/stylesheets/arclight/modules/collection_search.scss
 - app/assets/stylesheets/arclight/modules/hierarchy_and_online_contents.scss
 - app/assets/stylesheets/arclight/modules/highlights.scss
@@ -501,7 +502,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: A Blacklight-based environment to support discovery and delivery for archives