arclight 0.4.0 → 1.6.2

data/app/components/arclight/breadcrumb_component.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Display the document hierarchy as "breadcrumbs"
+  class BreadcrumbComponent < ViewComponent::Base
+    # @param [Integer] count if provided the number of bookmarks is limited to this number
+    def initialize(document:, count: nil, offset: 0)
+      @document = document
+      @count = count
+      @offset = offset
+      super()
+    end
+
+    def call
+      return unless breadcrumb_links.any?
+
+      tag.ol class: 'breadcrumb' do
+        safe_join(breadcrumb_links)
+      end
+    end
+
+    def components
+      return to_enum(:components) unless block_given?
+
+      yield build_repository_link
+
+      @document.parents.each do |parent|
+        yield tag.li(class: 'breadcrumb-item') { link_to(parent.label, solr_document_path(parent.id)) }
+      end
+    end
+
+    def build_repository_link
+      render Arclight::RepositoryBreadcrumbComponent.new(document: @document)
+    end
+
+    private
+
+    def breadcrumb_links
+      @breadcrumb_links ||= limit_breadcrumb_links(components.drop(@offset))
+    end
+
+    def limit_breadcrumb_links(links)
+      return links unless @count && links.length > @count
+
+      limited_links = links.first(@count)
+      limited_links << tag.li('&hellip;'.html_safe, class: 'breadcrumb-item')
+      limited_links
+    end
+  end
+end

data/app/components/arclight/breadcrumbs_hierarchy_component.html.erb

@@ -0,0 +1,34 @@
+<ol class="breadcrumb">
+  <li class="breadcrumb-home-link">
+    <%= link_to t('arclight.routes.home'), root_path %>
+  </li>
+  <li class="breadcrumb-item breadcrumb-item-1">
+    <span aria-hidden="true"><%= blacklight_icon :repository, classes: 'al-repository-content-icon' %></span>
+    <span class="breadcrumb-text"><%= repository %></span>
+    <ol class="breadcrumb">
+      <% if collection %>
+        <li class="breadcrumb-item breadcrumb-item-2">
+          <span aria-hidden="true"><%= blacklight_icon :collection, classes: 'al-collection-content-icon' %></span>
+          <span class="breadcrumb-text"><%= link_to collection.label, solr_document_path(collection.id) %></span>
+
+          <ol class="breadcrumb">
+            <% parents_under_collection.each do |parent| %>
+              <li class="breadcrumb-item breadcrumb-item-3">
+                <span class="breadcrumb-text"><%= link_to parent.label, solr_document_path(parent.id) %></span>
+              </li>
+            <% end %>
+
+            <li class="breadcrumb-item breadcrumb-item-4">
+             <span class="breadcrumb-text"><%= @presenter.heading %></span>
+            </li>
+          </ol>
+        </li>
+      <% else # this is a collection %>
+        <li class="breadcrumb-item breadcrumb-item-4">
+          <span aria-hidden="true"><%= blacklight_icon :collection, classes: 'al-collection-content-icon' %></span>
+          <span class="breadcrumb-text"><%= @presenter.heading %></span>
+        </li>
+      <% end %>
+    </ol>
+  </li>
+</ol>

data/app/components/arclight/breadcrumbs_hierarchy_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render the hierarchy for a document
+  class BreadcrumbsHierarchyComponent < ViewComponent::Base
+    delegate :document, to: :@presenter
+    delegate :blacklight_icon, to: :helpers
+
+    def initialize(presenter:)
+      super()
+
+      @presenter = presenter
+      collections, @parents_under_collection = document.parents.partition(&:collection?)
+      @collection = collections.first
+    end
+
+    attr_reader :collection, :parents_under_collection
+
+    def repository
+      return tag.span(t('arclight.show_breadcrumb_label')) if document.repository_config.blank?
+
+      link_to(document.repository_config.name, helpers.arclight_engine.repository_path(document.repository_config.slug))
+    end
+  end
+end

data/app/components/arclight/collection_context_component.html.erb

@@ -0,0 +1,12 @@
+<div class='al-show-actions-box mb-3'>
+  <div class="al-actions-box-container">
+    <button type="button" class="btn-close d-lg-none float-end mt-1 me-1" data-bs-dismiss="offcanvas" data-bs-target="#sidebar" aria-label="Close"></button>
+    <h2>Collection</h2>
+    <h3><%= title %></h3>
+
+    <div class="al-collection-context-actions d-flex flex-wrap gap-1">
+      <%= document_download %>
+      <%= collection_info %>
+    </div>
+  </div>
+</div>

data/app/components/arclight/collection_context_component.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render various actions for a collection (e.g. requesting, download links, etc)
+  class CollectionContextComponent < ViewComponent::Base
+    def initialize(presenter:, download_component:)
+      super()
+
+      @collection = presenter.document.collection
+      @download_component = download_component
+    end
+
+    attr_reader :collection
+
+    def title
+      collection.normalized_title
+    end
+
+    def document_download
+      render @download_component.new(downloads: collection.downloads) || Arclight::DocumentDownloadComponent.new(downloads: collection.downloads)
+    end
+
+    def collection_info
+      render Arclight::CollectionInfoComponent.new(collection: collection)
+    end
+  end
+end

data/app/components/arclight/collection_info_component.html.erb

@@ -0,0 +1,28 @@
+<div class='al-show-actions-box-info'>
+
+  <div class="dropdown">
+    <button class="dropdown-toggle btn btn-secondary btn-sm" type="button" data-bs-toggle="dropdown" aria-expanded="false">
+      <%= info_icon %> <%= t('.more_info') %>
+    </button>
+    <div class="dropdown-menu shadow-lg p-2" style="min-width: 300px;" >
+      <table style="width: 100%">
+        <tr>
+          <th scope="row"><%= t('.collection_id') %></th>
+          <td><%= collection_unitid %></td>
+        </tr>
+        <tr>
+          <th scope="row"><%= t('.total_components') %></th>
+          <td><%= total_component_count %></td>
+        </tr>
+        <tr>
+          <th scope="row"><%= t('.online_items') %></th>
+          <td><%= tag.span blacklight_icon(:online), class: 'al-online-content-icon' %><%= online_item_count %></td>
+        </tr>
+        <tr>
+          <th scope="row"><%= t('.last_indexed') %></th>
+          <td><%= last_indexed.strftime('%F') %></td>
+        </tr>
+      </table>
+    </div>
+  </div>
+</div>

data/app/components/arclight/collection_info_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render information about the collection
+  class CollectionInfoComponent < ViewComponent::Base
+    def initialize(collection:)
+      super()
+
+      @collection = collection
+    end
+
+    attr_reader :collection
+
+    delegate :total_component_count, :online_item_count, :last_indexed, :collection_unitid, to: :collection
+    delegate :blacklight_icon, to: :helpers
+
+    def info_icon
+      icon = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-info-circle-fill" viewBox="0 0 16 16">
+          <path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194 0 .487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703 0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 1 1 0-2 1 1 0 0 1 0 2z"/>
+        </svg>
+      SVG
+      icon.html_safe # rubocop:disable Rails/OutputSafety
+    end
+  end
+end

data/app/components/arclight/collection_sidebar_component.html.erb

@@ -0,0 +1,15 @@
+<nav class="al-sidebar-navigation-context sidebar-section" aria-labelledby="collection-nav">
+  <h2 id="collection-nav"><%= 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 ps-0 py-1',
+          data: { turbolinks: 'false' }
+        %>
+      </li>
+    <% end %>
+  </ul>
+</nav>

data/app/components/arclight/collection_sidebar_component.rb

@@ -0,0 +1,39 @@
+# 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(document.root)
+    end
+
+    def section_anchor(section)
+      "##{t("arclight.views.show.sections.#{section}").parameterize}"
+    end
+  end
+end

data/app/{views/catalog/_search_results_repository.html.erb → components/arclight/constraints_component.html.erb}

@@ -1,6 +1,7 @@
-<% repository = repository_faceted_on %>
 <% if repository %>
   <div class="al-repository-card">
     <%= render repository %>
   </div>
 <% end %>
+
+<%= render Blacklight::ConstraintsComponent.new(**@kwargs) %>

data/app/components/arclight/constraints_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Extend the upstream constraints with breadcrumbs and
+  # repository context information
+  class ConstraintsComponent < Blacklight::ConstraintsComponent
+    def initialize(**kwargs)
+      super
+
+      @kwargs = kwargs
+    end
+
+    def repository
+      @repository ||= helpers.repository_faceted_on
+    end
+  end
+end

data/app/components/arclight/document_collection_context_component.html.erb

@@ -0,0 +1,29 @@
+<%= tag.tr(
+  id: @document.id,
+  data: {
+    'document-id': @document.id.to_s.parameterize,
+    'document-counter': @counter,
+  },
+  itemscope: true,
+  itemtype: @document.itemtype,
+  class: classes.join(' ')) do %>
+  <td data-document-id="<%= document.id %>">
+    <div class="index_title document-title-heading" data-turbo="false">
+      <%= helpers.link_to_document document, counter: @counter %>
+      <% if document.children? %>
+        <span class="badge badge-pill bg-secondary badge-secondary al-number-of-children-badge"><%= document.number_of_children %><span class="sr-only visually-hidden"><%= t(:'arclight.views.index.number_of_components', count: document.number_of_children) %></span></span>
+      <% end %>
+    </div>
+  </td>
+
+    <%= tag.td class: 'text-muted' do %>
+      <%= document.containers.join(', ') %>
+    <% end %>
+
+    <%= tag.td class: 'text-end' do %>
+    <%= helpers.render_index_doc_actions document, wrapping_class: 'd-inline-flex justify-content-end' %>
+    <% end %>
+  </div>
+
+  <%= render Arclight::IndexMetadataFieldComponent.with_collection(@presenter&.field_presenters.select { |field| field.field_config.collection_context }, classes: ['col pl-0 my-0']) %>
+<% end %>

data/app/components/arclight/document_collection_context_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Display a single document in the collection
+  class DocumentCollectionContextComponent < Arclight::SearchResultComponent
+    # @param [SolrDocument] document
+    def initialize(document: nil, blacklight_config: nil, **kwargs)
+      super(document: document, **kwargs)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    def classes
+      (super - ['row'] + ['al-collection-context']).flatten
+    end
+
+    private
+
+    def online_status
+      render online_status_component.new(document: @document)
+    end
+
+    def online_status_component
+      blacklight_config.show.online_status_component || Arclight::OnlineStatusIndicatorComponent
+    end
+  end
+end

data/app/components/arclight/document_collection_hierarchy_component.html.erb

@@ -0,0 +1,50 @@
+<%= content_tag :li,
+  id: "#{@document.id}-hierarchy-item",
+  data: {
+    'document-id': @document.id.to_s.parameterize,
+    'document-counter': @counter,
+  },
+  itemscope: true,
+  itemtype: @document.itemtype,
+  class: (classes.flatten + ['al-collection-context', ('al-hierarchy-highlight' if current_target?)].compact).join(' ') do %>
+  <div class="documentHeader" data-document-id="<%= document.id %>">
+    <% if document.children? %>
+      <%= link_to('',
+          "#collapsible-hierarchy-#{document.id}",
+          class: "al-toggle-view-children#{ ' collapsed' unless show_expanded?}",
+          aria: {
+            label: t('arclight.hierarchy.view_all'),
+            expanded: show_expanded?
+          },
+          data: {
+            bs_toggle: 'collapse',
+            toggle: 'collapse'
+          }
+        )
+      %>
+    <% end %>
+    <div class="index_title document-title-heading" data-turbo="false">
+      <% if current_target? %>
+        <%= document.normalized_title %>
+      <% else %>
+        <%= helpers.link_to_document document, counter: @counter %>
+      <% end %>
+      <% if document.children? %>
+        <span class="badge badge-pill bg-secondary badge-secondary al-number-of-children-badge"><%= document.number_of_children %><span class="sr-only visually-hidden"><%= t(:'arclight.views.index.number_of_components', count: document.number_of_children) %></span></span>
+      <% end %>
+      <%= online_status %>
+    </div>
+    <%= content_tag('div', class: 'al-document-container text-muted') do %>
+      <%= document.containers.join(', ') %>
+    <% end if document.containers.present? %>
+  </div>
+  
+  <%= render Arclight::IndexMetadataFieldComponent.with_collection(@presenter&.field_presenters.select { |field| field.field_config.collection_context }, classes: ['col pl-0 my-0']) %>
+  <% if document.number_of_children > 0 %>
+    <%= content_tag(:div, id: "collapsible-hierarchy-#{document.id}",
+      class: "collapse al-collection-context-collapsible al-hierarchy-level-#{document.component_level} #{'show' if show_expanded?}"
+    ) do %>
+      <%= render Arclight::DocumentComponentsHierarchyComponent.new(document: @document, target_index: target_index) %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/arclight/document_collection_hierarchy_component.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Display a single document in the collection hierarchy
+  class DocumentCollectionHierarchyComponent < Arclight::SearchResultComponent
+    # @param [Blacklight::DocumentPresenter] document
+    # @param [String] nest_path determines which element to highlight
+    def initialize(document: nil, nest_path: nil, blacklight_config: nil, **kwargs)
+      super(document: document, **kwargs)
+      @nest_path = nest_path
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    def classes
+      super - ['row']
+    end
+
+    # we want to eager-load this document's children if we're in the
+    # target document's component hierarchy
+    def show_expanded?
+      within_original_tree?
+    end
+
+    # Solr nest paths are constructed using the path name and an index, e.g.
+    # `/components#5/components#3`.
+    #
+    # @return [String] the targeted index for this level of the hierarchy
+    def target_index
+      return -1 unless within_original_tree?
+
+      remaining_path = nest_path.sub("#{@document.nest_path}/", '')
+      current_component, _rest = remaining_path.split('/', 2)
+      _name, index = current_component.split('#', 2)
+
+      index&.to_i
+    end
+
+    private
+
+    # We're in the targeted document's original tree if the target nest path
+    # includes this document's path.
+    def within_original_tree?
+      nest_path&.start_with? "#{@document.nest_path}/"
+    end
+
+    def current_target?
+      nest_path == @document.nest_path
+    end
+
+    def online_status
+      render online_status_component.new(document: @document)
+    end
+
+    def online_status_component
+      blacklight_config.show.online_status_component || Arclight::OnlineStatusIndicatorComponent
+    end
+
+    attr_reader :nest_path
+  end
+end

data/app/components/arclight/document_component.html.erb

@@ -0,0 +1,39 @@
+<div class='d-md-flex justify-content-between al-show'>
+  <div class='al-show-breadcrumb'>
+    <nav aria-label="breadcrumb">
+      <%= render breadcrumb_component.new(presenter: presenter) %>
+    </nav>
+  </div>
+</div>
+
+<div class="title-container">
+  <%= content_tag :h1 do %>
+    <%= document.normalized_title %>
+  <% end %>
+  <%= render 'arclight/requests', document: document %>
+  <%= render Arclight::BookmarkComponent.new document: document, action: bookmark_config %>
+  <%= toggle_sidebar %>
+  <%= online_filter %>
+</div>
+
+<%= render Arclight::MetadataSectionComponent.with_collection(component_metadata_partials,
+             metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+             presenter: presenter) unless document.collection? %>
+
+<%= embed %>
+
+<% 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,
+                metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+                presenter: presenter, heading: true) %>
+</div>
+<% elsif document.children? %>
+<div id="contents">
+  <h2 class="al-show-sub-heading"><%= t 'arclight.views.show.contents' %></h2>
+  <%= helpers.turbo_frame_tag "al-hierarchy-#{document.id}-document", loading: 'lazy', src: helpers.hierarchy_solr_document_path(id: document.id, paginate: true, key: '-document', per_page: 50) %>
+</div>
+<% end %>
+
+<%= access %>

data/app/components/arclight/document_component.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a single document
+  class DocumentComponent < Blacklight::DocumentComponent
+    attr_reader :document
+
+    def online_content?
+      document.online_content? && (document.collection? || document.children?)
+    end
+
+    def blacklight_config
+      presenter.configuration
+    end
+
+    # @return [Blacklight::Configuration::ToolConfig] the configuration for the bookmark
+    def bookmark_config
+      blacklight_config.index.document_actions.arclight_bookmark_control
+    end
+
+    def breadcrumb_component
+      blacklight_config.show.breadcrumb_component || Arclight::BreadcrumbsHierarchyComponent
+    end
+
+    def metadata_partials
+      blacklight_config.show.metadata_partials || []
+    end
+
+    def component_metadata_partials
+      blacklight_config.show.component_metadata_partials || []
+    end
+
+    def online_filter
+      render Arclight::OnlineContentFilterComponent.new(document: document)
+    end
+
+    def access
+      render (blacklight_config.show.access_component || Arclight::AccessComponent).new(presenter: presenter)
+    end
+
+    def toggle_sidebar
+      button_tag(t('arclight.views.show.toggle_sidebar'),
+                 type: :button,
+                 class: 'btn btn-sm btn-secondary d-lg-none sidebar-toggle',
+                 data: { bs_toggle: 'offcanvas', bs_target: '#sidebar' },
+                 aria: { controls: 'sidebar' })
+    end
+  end
+end

data/app/components/arclight/document_components_hierarchy_component.html.erb

@@ -0,0 +1,20 @@
+<% if paginate? && @target_index >= 0 && @target_index >= @maximum_left_gap %>
+  <%# render the hierarchy as: outer (left) window ... window ... because our current document hierarchy is so far down the list it'd be buried %>
+  <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-left", loading: 'lazy', src: hierarchy_path(limit: @left_outer_window, key: '-left') %>
+  <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-gap" do %>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @left_outer_window, limit: @target_index - @left_outer_window - (@window / 2), key: '-gap')) %>
+  <% end %>
+  <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-window", src: hierarchy_path(offset: @target_index - (@window / 2), limit: @window, key: '-window') %>
+  <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @target_index + (@window / 2), key: '-right')) %>
+  <% end %>
+<% elsif paginate? %>
+  <%# render the first N documents, and let the user expand the remaining if desired %>
+  <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-sidebar", loading: ('lazy' unless @target_index >= 0), src: hierarchy_path(limit: @maximum_left_gap, key: '-sidebar') %>
+  <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @maximum_left_gap, key: '-right')) %>
+  <% end %>
+<% else %>
+  <%# there aren't enough to bother paginating, so load them all at once %>
+  <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-sidebar", loading: ('lazy' unless @target_index >= 0), src: hierarchy_path(key: '-sidebar') %>
+<% end %>

data/app/components/arclight/document_components_hierarchy_component.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Display a document's constituent components with appropriate lazy-loading
+  # to keep the page load time reasonable.
+  class DocumentComponentsHierarchyComponent < ViewComponent::Base
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(document: nil, target_index: -1, minimum_pagination_size: 20, left_outer_window: 3, maximum_left_gap: 10, window: 10)
+      super()
+
+      @document = document
+      @target_index = target_index&.to_i || -1
+      @minimum_pagination_size = minimum_pagination_size
+      @left_outer_window = left_outer_window
+      @maximum_left_gap = maximum_left_gap
+      @window = window
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def paginate?
+      @document.number_of_children > @minimum_pagination_size
+    end
+
+    def hierarchy_path(**kwargs)
+      helpers.hierarchy_solr_document_path(id: @document.id, hierarchy: true, nest_path: params[:nest_path], **kwargs)
+    end
+
+    def expand_hierarchy_component
+      blacklight_config.show.expand_hierarchy_component || Arclight::ExpandHierarchyButtonComponent
+    end
+
+    delegate :blacklight_config, to: :helpers
+  end
+end

data/app/components/arclight/document_download_component.html.erb

@@ -0,0 +1,24 @@
+<div class="al-show-actions-box-downloads-container">
+  <% case files.size %>
+  <% when 2 %>
+    <div class="dropdown">
+      <button class="btn btn-secondary btn-sm dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
+        <%= t("arclight.views.show.download.default") %>
+      </button>
+      <ul class="dropdown-menu">
+        <% files.each do |file| %>
+          <li><%= link_to(file.href, class: "dropdown-item", **@link_options) do %>
+            <%= icon_for(file.type) %> <%= dropdown_label(file) %>
+          <% end %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  <% when 1 %>
+    <% files.each do |file| %>
+      <%= link_to(file.href, class: "btn btn-secondary btn-sm", **@link_options) do %>
+        <%= download_icon %> <%= label(file) %>
+      <% end %>
+    <% end %>
+  <% end %>
+</div>