Add icons to collection/component show page breadcrumbs #801 (#847)

Author: gordonleacock

.codeclimate.yml

@@ -1,4 +1,3 @@
----
 version: "2"
 exclude_patterns:
   - "app/assets/javascripts/arclight/context_navigation.js"

.rubocop.yml

@@ -17,6 +17,7 @@ AllCops:
 Metrics/ModuleLength:
   Exclude:
     - 'app/helpers/arclight_helper.rb'
+    - 'app/models/concerns/arclight/solr_document.rb'
 
 Metrics/BlockLength:
   Exclude:

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

@@ -8,6 +8,9 @@
   background-color: transparent;
   margin-bottom: 0;
   padding: 0;
+  .breadcrumb-item + .breadcrumb-item::before {
+    content: '';
+  }
 }
 
 .al-show-actions-box {

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

@@ -146,6 +146,14 @@ article.document {
   padding-right: 0 !important;
 }
 
+.breadcrumb .media .col, h1.media .col {
+  flex-basis: auto;
+}
+
+.breadcrumb .media svg, h1.media svg {
+  fill: $gray-600;
+}
+
 .breadcrumb-links a {
   color: $body-color;
 }

app/helpers/arclight_helper.rb

@@ -180,12 +180,14 @@ def hierarchy_component_context?
 
   # determine which icon to show in search results header
   # these icon names will need to be updated when the icons are determined
-  def document_header_icon(document)
+  def document_or_parent_icon(document)
     case document.level&.downcase
     when 'collection'
       'collection'
     when 'file'
       'file'
+    when 'series', 'subseries'
+      'folder'
     else
       'container'
     end

app/models/arclight/parent.rb

@@ -5,11 +5,12 @@ module Arclight
   # Logic containing information about Solr_Ead "Parent"
   # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
   class Parent
-    attr_reader :id, :label, :eadid
-    def initialize(id:, label:, eadid:)
+    attr_reader :id, :label, :eadid, :level
+    def initialize(id:, label:, eadid:, level:)
       @id = id
       @label = label
       @eadid = eadid
+      @level = level
     end
 
     ##

app/models/arclight/parents.rb

@@ -5,11 +5,12 @@ module Arclight
   # Object for parsing and formalizing Solr_Ead "Parents"
   # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
   class Parents
-    attr_reader :ids, :labels
-    def initialize(ids:, labels:, eadid:)
+    attr_reader :ids, :labels, :levels
+    def initialize(ids:, labels:, eadid:, levels:)
       @ids = ids
       @labels = labels
       @eadid = eadid
+      @levels = levels
     end
 
     def eadid
@@ -19,7 +20,7 @@ def eadid
     ##
     # @return [Array[Arclight::Parent]]
     def as_parents
-      Hash[ids.zip(labels)].map { |k, v| Arclight::Parent.new(id: k, label: v, eadid: eadid) }
+      ids.map.with_index { |_id, idx| Arclight::Parent.new(id: ids[idx], label: labels[idx], eadid: eadid, level: levels[idx]) }
     end
 
     ##
@@ -28,7 +29,8 @@ def self.from_solr_document(document)
       ids = document.parent_ids
       labels = document.parent_labels
       eadid = document.eadid
-      new(ids: ids, labels: labels, eadid: eadid)
+      levels = document.parent_levels
+      new(ids: ids, labels: labels, eadid: eadid, levels: levels)
     end
   end
 end

app/models/concerns/arclight/solr_document.rb

@@ -20,6 +20,10 @@ def parent_labels
       fetch('parent_unittitles_ssm', [])
     end
 
+    def parent_levels
+      fetch('parent_levels_ssm', [])
+    end
+
     def parent_document
       self.class.new fetch('parent').fetch('docs', []).first
     end

app/views/catalog/_arclight_document_header_icon.html.erb

@@ -1 +1 @@
-<%= blacklight_icon document_header_icon(document) %>
+<%= blacklight_icon document_or_parent_icon(document) %>

app/views/catalog/_arclight_index_compact_default.html.erb

@@ -1,6 +1,6 @@
 <div class="documentHeader row">
   <div class="col-auto">
-    <%= blacklight_icon document_header_icon(document) %>
+    <%= blacklight_icon document_or_parent_icon(document) %>
   </div>
   <div class="col col-no-left-padding col-no-right-padding">
     <div class="d-flex justify-content-between">

app/views/catalog/_arclight_index_group_document_compact_default.html.erb

@@ -2,7 +2,7 @@
   <% breadcrumbs = component_top_level_parent_to_links(document) %>
   <div class="documentHeader row">
     <div class="col-auto">
-      <%= blacklight_icon document_header_icon(document) %>
+      <%= blacklight_icon document_or_parent_icon(document) %>
     </div>
     <div class="col col-no-left-padding">
       <h4>

app/views/catalog/_arclight_index_group_document_default.html.erb

@@ -2,7 +2,7 @@
   <% breadcrumbs = parents_to_links(document) %>
   <div class="documentHeader row">
     <div class="col-auto">
-      <%= blacklight_icon document_header_icon(document) %>
+      <%= blacklight_icon document_or_parent_icon(document) %>
     </div>
     <div class="col col-no-left-padding">
       <h4>

app/views/shared/_show_breadcrumbs.html.erb

@@ -1,20 +1,24 @@
 <% parents = Arclight::Parents.from_solr_document(document).as_parents %>
 <nav aria-label="breadcrumb">
   <ol class="breadcrumb">
-    <li class="breadcrumb-item al-bc-item breadcrumb-item-1">
+    <li class="media breadcrumb-item  breadcrumb-item-1">
       <% if document.repository_config.present? %>
-        <%= link_to(document.repository_config.name, arclight_engine.repository_path(document.repository_config.slug)) %>
+        <span class="media-body" aria-hidden="true"><%= blacklight_icon :repository, classes: 'al-repository-content-icon' %></span>
+        <span class="col"><%= link_to(document.repository_config.name, arclight_engine.repository_path(document.repository_config.slug)) %></span>
       <% else %>
-          <span><%= t('arclight.show_breadcrumb_label') %></span>
+          <span class="media-body" aria-hidden="true"><%= blacklight_icon :repository, classes: 'al-repository-content-icon' %></span><span class="col"><%= t('arclight.show_breadcrumb_label') %></span>
       <% end %>
     </li>
     <% parents.each_with_index.map do |parent, index| %>
-      <%= content_tag :li, class: "breadcrumb-item breadcrumb-item-#{index + 2} al-bc-item" do %>
-        <%= link_to parent.label, solr_document_path(parent.global_id) %>
-      <% end %>
+      <%= content_tag :li, class: "breadcrumb-item breadcrumb-item-#{index + 1} media" do %>
+        <span class="media-body" aria-hidden="true"><%= blacklight_icon document_or_parent_icon(parent) %></span>
+        <span class="col"><%= link_to parent.label, solr_document_path(parent.global_id) %></span>
+      <% end %> 
     <% end %>
   </ol>
-  <h1 class="breadcrumb-item breadcrumb-item-<%= parents.length + 2 %> al-bc-item">
-    <%= document.normalized_title %>
-  </h1>
+
+  <%= content_tag :h1, class: "breadcrumb-item breadcrumb-item-#{parents.length + 2} media" do %>
+    <span class="media-body" aria-hidden="true"><%= blacklight_icon document_or_parent_icon(document) %></span>
+    <span class="col"><%= document.normalized_title %></span>
+  <% end %>
 </nav>

lib/arclight/traject/ead2_config.rb

@@ -332,6 +332,17 @@
     accumulator.concat context.output_hash['parent_unittitles_ssm']
   end
 
+  to_field 'parent_levels_ssm' do |_record, accumulator, context|
+    ## Top level document
+    accumulator.concat context.clipboard[:parent].output_hash['level_ssm']
+    ## Other components
+    context.output_hash['parent_ssm']&.drop(1)&.each do |id|
+      accumulator.concat Array
+        .wrap(context.clipboard[:parent].output_hash['components'])
+        .select { |c| c['ref_ssi'] == [id] }.map { |c| c['level_ssm'] }.flatten
+    end
+  end
+
   to_field 'unitid_ssm', extract_xpath('./did/unitid')
   to_field 'collection_unitid_ssm' do |_record, accumulator, context|
     accumulator.concat Array.wrap(context.clipboard[:parent].output_hash['unitid_ssm'])

spec/features/collection_page_spec.rb

@@ -334,7 +334,7 @@
     it 'links repository and shows collection header 1 text' do
       within '.al-show-breadcrumb' do
         expect(page).to have_css 'a', text: 'National Library of Medicine. History of Medicine Division'
-        expect(page).to have_css 'h1.breadcrumb-item-2', text: 'Alpha Omega Alpha Archives, 1894-1992'
+        expect(page).to have_css 'span', text: 'Alpha Omega Alpha Archives, 1894-1992'
       end
     end
   end

spec/features/traject/ead2_indexing_spec.rb

@@ -437,6 +437,14 @@
             aspace_238a0567431f36f49acea49ef576d408
           ]
         end
+
+        it 'parents and levels' do
+          expect(component_with_many_parents['parent_levels_ssm']).to eq %w[
+            collection
+            Series
+            Subseries
+          ]
+        end
       end
     end
   end

spec/helpers/arclight_helper_spec.rb

@@ -339,18 +339,18 @@
     end
   end
 
-  describe 'document_header_icon' do
+  describe 'document_or_parent_icon' do
     let(:document) { SolrDocument.new('level_ssm': ['collection']) }
 
     it 'properly assigns the icon' do
-      expect(helper.document_header_icon(document)).to eq 'collection'
+      expect(helper.document_or_parent_icon(document)).to eq 'collection'
     end
 
     context 'there is no level_ssm' do
       let(:document) { SolrDocument.new }
 
       it 'gives the default icon' do
-        expect(helper.document_header_icon(document)).to eq 'container'
+        expect(helper.document_or_parent_icon(document)).to eq 'container'
       end
     end
   end

spec/models/arclight/parent_spec.rb

@@ -3,11 +3,11 @@
 require 'spec_helper'
 
 RSpec.describe Arclight::Parent do
-  subject(:instance) { described_class.new(id: 'abc', label: 'ABC', eadid: '123') }
+  subject(:instance) { described_class.new(id: 'abc', label: 'ABC', eadid: '123', level: 'collection') }
 
   describe '#global_id' do
     context 'when the eadid is the id' do
-      subject(:instance) { described_class.new(id: 'abc', label: 'ABC', eadid: 'abc') }
+      subject(:instance) { described_class.new(id: 'abc', label: 'ABC', eadid: 'abc', level: 'collection') }
 
       it 'returns the id (and does not duplicate the id)' do
         expect(instance.global_id).to eq 'abc'

spec/models/arclight/parents_spec.rb

@@ -7,15 +7,17 @@
     SolrDocument.new(
       parent_ssm: %w[def ghi],
       parent_unittitles_ssm: %w[DEF GHI],
-      ead_ssi: 'abc123'
+      ead_ssi: 'abc123',
+      parent_levels_ssm: %w[collection]
     )
   end
 
   let(:dot_eadid_doc) do
     SolrDocument.new(
       parent_ssm: %w[def ghi],
       parent_unittitles_ssm: %w[DEF GHI],
-      ead_ssi: 'abc123.xml'
+      ead_ssi: 'abc123.xml',
+      parent_levels_ssm: %w[collection]
     )
   end
 
@@ -33,6 +35,7 @@
         expect(good_instance.ids).to eq %w[def ghi]
         expect(good_instance.labels).to eq %w[DEF GHI]
         expect(good_instance.eadid).to eq 'abc123'
+        expect(good_instance.levels).to eq %w[collection]
       end
 
       it 'cleans up the eadid properly by replacing dots with dashes' do
@@ -63,11 +66,12 @@
         expect(good_instance.as_parents.first.id).to eq 'def'
         expect(good_instance.as_parents.first.label).to eq 'DEF'
         expect(good_instance.as_parents.first.eadid).to eq 'abc123'
+        expect(good_instance.as_parents.first.level).to eq 'collection'
       end
     end
     context 'with no data' do
       it 'returns an empty array' do
-        expect(described_class.new(ids: [], labels: [], eadid: '').as_parents).to eq []
+        expect(described_class.new(ids: [], labels: [], eadid: '', levels: '').as_parents).to eq []
       end
     end
   end