Merge pull request #1250 from projectblacklight/extract-collection-sidebar

Extract CollectionSidebarComponent

Author: thatbudakguy

.rubocop.yml

@@ -33,6 +33,10 @@ Metrics/BlockLength:
     - 'spec/**/*'
     - 'tasks/**/*'
 
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - _is
+
 Layout/LineLength:
   Max: 160
 

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

@@ -91,18 +91,6 @@
   }
 }
 
-// Show page metadata.
-// Indent to match terminal show page breadcrumb.
-@for $i from 1 to 20 {
-  .al-metadata-section.breadcrumb-item-#{$i} {
-    padding-left: 0;
-
-    @media (min-width: 768px) {
-      padding-left: ($i * 10) + 10px;
-    }
-  }
-}
-
 .bookmark-toggle .toggle-bookmark {
   display: inline;
   margin-bottom: 0;

app/components/arclight/collection_sidebar_component.html.erb

@@ -0,0 +1,15 @@
+<nav id="about-collection-nav" class="al-sidebar-navigation-context sidebar-section">
+  <h2><%= t('arclight.views.show.context_nav.title') %></h2>
+  <ul class='nav flex-column'>
+    <% partials.each do |section| %>
+      <% next unless has_section?(section) %>
+      <li class='nav-item'>
+        <%= link_to section_label(section),
+          document_section_path(section),
+          class: 'nav-link pl-0',
+          data: { turbolinks: 'false' }
+        %>
+      </li>
+    <% end %>
+  </ul>
+</nav>

app/components/arclight/collection_sidebar_component.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Draw the links to the collection info in the sidebar
+  class CollectionSidebarComponent < ViewComponent::Base
+    def initialize(document:, partials:, collection_presenter:)
+      super
+
+      @document = document
+      @partials = Array(partials)
+      @collection_presenter = collection_presenter
+    end
+
+    attr_reader :document, :partials, :collection_presenter
+
+    def has_section?(section)
+      # Access field data comes from repositories.yml not from solr, so handle it in a different way.
+      return true if section == :access_field
+
+      collection_presenter.with_field_group(section).fields_to_render.any?
+    end
+
+    def document_section_path(section)
+      [document_path, section_anchor(section)].join
+    end
+
+    def section_label(section)
+      t("arclight.views.show.sections.#{section}")
+    end
+
+    def document_path
+      @document_path ||= solr_document_path(normalized_eadid)
+    end
+
+    def section_anchor(section)
+      "##{t("arclight.views.show.sections.#{section}").parameterize}"
+    end
+
+    delegate :normalized_eadid, to: :document
+  end
+end

app/components/arclight/document_component.html.erb

@@ -30,7 +30,9 @@
   <% end %>
 </div>
 
-<%= render Arclight::MetadataSectionComponent.with_collection(component_metadata_partials, metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent }, presenter: presenter, classes: ['al-metadata-section']) unless document.collection? %>
+<%= render Arclight::MetadataSectionComponent.with_collection(component_metadata_partials,
+             metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+             presenter: presenter) unless document.collection? %>
 
 <div class='row'>
   <div class='col-md-12'>
@@ -41,7 +43,9 @@
 <% if document.collection? %>
 <div id="metadata">
   <h2 class="sr-only visually-hidden"><%= t 'arclight.views.show.context' %></h2>
-  <%= render Arclight::MetadataSectionComponent.with_collection(metadata_partials, presenter: presenter, heading: true) %>
+  <%= render Arclight::MetadataSectionComponent.with_collection(metadata_partials,
+                metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+                presenter: presenter, heading: true) %>
 </div>
 <% elsif document.children? %>
 <div id="contents">
@@ -52,15 +56,19 @@
 
 <% access_content = capture do %>
   <% if @document.collection? %>
-    <%= render Arclight::MetadataSectionComponent.with_collection(context_access_tab_items, presenter: presenter) %>
+    <%= render Arclight::MetadataSectionComponent.with_collection(context_access_tab_items,
+                metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+                presenter: presenter) %>
   <% else %>
-    <%= render Arclight::MetadataSectionComponent.with_collection(component_access_tab_items, presenter: presenter) %>
+    <%= render Arclight::MetadataSectionComponent.with_collection(component_access_tab_items,
+                metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+                presenter: presenter) %>
   <% end %>
 <% end %>
 
 <% if access_content.present? %>
-  <div id="access">
-    <h2 class="al-show-sub-heading"><%= t 'arclight.views.show.access' %></h2>
+  <div id="<%= t('arclight.views.show.sections.access_field').parameterize %>">
+    <h2 class="al-show-sub-heading"><%= t 'arclight.views.show.sections.access_field' %></h2>
 
     <%= access_content%>
   </div>

app/components/arclight/upper_metadata_layout_component.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Arclight
-  # Override upstream to remove bootstrap column classes
+  # Override upstream to add an offset bootstrap column class
   class UpperMetadataLayoutComponent < Blacklight::MetadataFieldLayoutComponent
-    def initialize(field:, label_class: nil, value_class: nil)
+    def initialize(field:, label_class: 'col-md-3 offset-md-1', value_class: 'col-md-8')
       super
     end
   end

app/views/catalog/_show_sidebar.html.erb

@@ -3,24 +3,9 @@
 </div>
 
 <%= render 'show_tools' %>
-<nav id="about-collection-nav" class="al-sidebar-navigation-context sidebar-section">
-  <h2><%= t('arclight.views.show.context_nav.title') %></h2>
-  <ul class='nav flex-column'>
-    <% unless blacklight_config.show.metadata_partials.nil? %>
-      <% blacklight_config.show.metadata_partials.each do |item| %>
-        <% next unless document_presenter(document.collection).with_field_group(item).fields_to_render.any? %>
-        <li class='nav-item'>
-          <%= link_to t("arclight.views.show.sections.#{item}"),
-            [
-              solr_document_path(document.normalized_eadid),
-              "##{t("arclight.views.show.sections.#{item}").parameterize}"
-            ].join, class: 'nav-link pl-0', data: { turbolinks: 'false' }
-          %>
-        </li>
-      <% end %>
-    <% end %>
-  </ul>
-</nav>
+<%= render Arclight::CollectionSidebarComponent.new(document: @document,
+                                                    collection_presenter: document_presenter(@document.collection),
+                                                    partials: blacklight_config.show.metadata_partials) %>
 
 <div id="collection-context" class="sidebar-section">
   <h2><%= t('arclight.views.show.has_content') %></h2>

config/locales/arclight.en.yml

@@ -52,7 +52,6 @@ en:
         view_all_collections: View all of our collections
         view_more: View more
       show:
-        access: Access
         collection_id: 'Collection ID: %{id}'
         contents: Contents
         context: Collection context

lib/generators/arclight/templates/catalog_controller.rb

@@ -78,10 +78,10 @@ class CatalogController < ApplicationController
     config.show.document_presenter_class = Arclight::ShowPresenter
     config.show.metadata_partials = %i[
       summary_field
-      access_field
       background_field
       related_field
       indexed_terms_field
+      access_field
     ]
 
     config.show.context_access_tab_items = %i[

spec/components/arclight/collection_sidebar_component_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Arclight::CollectionSidebarComponent, type: :component do
+  subject(:component) do
+    described_class.new(document: document,
+                        partials: CatalogController.blacklight_config.show.metadata_partials,
+                        collection_presenter: collection_presenter)
+  end
+
+  before do
+    render_inline(component)
+  end
+
+  let(:document) { instance_double(SolrDocument, normalized_eadid: 'foo') }
+  let(:collection_presenter) { instance_double(Arclight::ShowPresenter, with_field_group: group_presenter) }
+  let(:group_presenter) { instance_double(Arclight::ShowPresenter, fields_to_render: [double]) }
+
+  it 'has navigation links' do
+    expect(page).to have_link 'Summary'
+    expect(page).to have_link 'Background'
+    expect(page).to have_link 'Related'
+    expect(page).to have_link 'Indexed Terms'
+    expect(page).to have_link 'Access and Use'
+  end
+end