arclight 0.1.0 → 1.6.2

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

@@ -0,0 +1,10 @@
+<div id="embed" class="mb-2">
+  <h2 class="al-show-sub-heading"><%= t('arclight.views.show.embedded_content') %></h2>
+  <%= render Arclight::OembedViewerComponent.with_collection(embeddable_resources, document: @document) %>
+
+  <% linked_resources.each do |resource| %>
+    <div class="al-digital-object">
+      <%= link_to(resource.label, resource.href) %>
+    </div>
+  <% end %>
+</div>

data/app/components/arclight/embed_component.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render digital object links for a document
+  class EmbedComponent < ViewComponent::Base
+    def initialize(document:, presenter:, **kwargs) # rubocop:disable Lint/UnusedMethodArgument
+      super()
+
+      @document = document
+      @presenter = presenter
+    end
+
+    def render?
+      resources.any?
+    end
+
+    def embeddable_resources
+      resources.first(1).select { |object| embeddable?(object) }
+    end
+
+    def linked_resources
+      resources - embeddable_resources
+    end
+
+    def resources
+      @resources ||= @document.digital_objects || []
+    end
+
+    def depth
+      @document.parents.length || 0
+    end
+
+    def embeddable?(object)
+      exclude_patterns.none? do |pattern|
+        object.href =~ pattern
+      end
+    end
+
+    def exclude_patterns
+      Arclight::Engine.config.oembed_resource_exclude_patterns
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<ul>
+  <li>
+    <%= expand_link %>
+  </li>
+</ul>

data/app/components/arclight/expand_hierarchy_button_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Component for rendering an expand button in the hierarchy view
+  class ExpandHierarchyButtonComponent < Blacklight::Component
+    def initialize(path:, classes: 'btn btn-secondary btn-sm')
+      super()
+      @path = path
+      @classes = classes
+    end
+
+    def expand_link
+      link_to t('arclight.views.show.expand'), @path, class: @classes
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+<div class='al-grouped-title-bar'>
+  <div class='row'>
+    <div class='col-md-12'>
+      <% if document.repository_config.present? %>
+        <div class='al-grouped-repository breadcrumb-links'>
+          <%= link_to(document.repository_config.name, helpers.arclight_engine.repository_path(document.repository_config.slug)) %>
+        </div>
+      <% end %>
+      <h3><%= helpers.link_to_document document %></h3>
+      <% document.extent.each do |extent| %>
+        <%= tag.span extent, class: 'al-document-extent badge' unless compact? %>
+      <% end %>
+      <dl>
+        <%= render Arclight::IndexMetadataFieldComponent.with_collection(presenter.field_presenters.select { |field| !compact? || field.field_config.compact }) %>
+      </dl>
+    </div>
+  </div>
+</div>
+
+<div class="grouped-documents">
+  <div class="al-grouped-more">
+    <% if @group.total > 3 %>
+      <%= t('arclight.views.index.top_group_results', count: 3) %>
+      <%= link_to(
+        t('arclight.views.index.all_group_results', count: @group.total),
+        search_within_collection_url)
+      %>
+    <% else %>
+      <%= t('arclight.views.index.group_results_count', count: @group.total) %>
+    <% end %>
+  </div>
+
+  <%= helpers.render_document_index @group.docs %>
+</div>

data/app/components/arclight/group_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a collection document for a
+  # grouped search result view
+  class GroupComponent < Blacklight::Document::GroupComponent
+    def compact?
+      helpers.document_index_view_type.to_s == 'compact'
+    end
+
+    def document
+      @document ||= @group.docs.first.collection
+    end
+
+    def presenter
+      @presenter ||= Arclight::ShowPresenter.new(document, helpers).with_field_group('group_header_field')
+    end
+
+    def search_within_collection_url
+      search_catalog_path(helpers.search_without_group.deep_merge(f: { collection: [document.collection_name] }))
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<header>
+  <%= top_bar %>
+  <%= masthead %>
+  <%= search_bar %>
+</header>

data/app/components/arclight/header_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Provides a header with a masthead
+  class HeaderComponent < Blacklight::HeaderComponent
+    def masthead
+      render Arclight::MastheadComponent.new
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+<div class="row">
+  <%= tag.dt @field.label, class: 'visually-hidden' %>
+  <% if truncate? %>
+    <%= tag.dd(class: @classes + ['truncator'], data: { controller: 'arclight-truncate' }) do %>
+      <%= tag.div @field.render, class: 'content', data: { arclight_truncate_target: 'content' } %>
+      <%= button_tag(type: :button, class: 'btn btn-sm btn-link px-0',
+                     data: { action: 'click->arclight-truncate#trigger' }) do %>
+        <%= tag.span t('arclight.truncation.view_more'), class: 'view-more' %>
+        <%= tag.span t('arclight.truncation.view_less'), class: 'view-less' %>
+        <%= tag.span(class: 'icon') %>
+      <% end %>
+    <% end %>
+  <% else %>
+    <%= tag.dd @field.render, class: @classes %>
+  <% end %>
+</div>

data/app/components/arclight/index_metadata_field_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a simple metadata field (e.g. without labels) in a .row div
+  class IndexMetadataFieldComponent < Blacklight::MetadataFieldComponent
+    def initialize(field:, classes: ['col'], **kwargs)
+      super(field: field, **kwargs)
+
+      @classes = classes + ["al-document-#{@field.key.dasherize}"]
+    end
+
+    def render?
+      helpers.document_index_view_type != :compact || @field.field_config.compact
+    end
+
+    def truncate?
+      !!@field.field_config.truncate
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+<div class='al-masthead bg-light'>
+  <div class="container">
+    <div class="row align-items-center">
+      <div class="col-md-8" >
+        <div class="h1 my-4 text-center text-md-start"><%= heading %></div>
+      </div>
+
+      <div class="col-md-4">
+        <nav class="navbar navbar-expand d-flex justify-content-md-end justify-content-center" aria-label="browse">
+          <ul class="navbar-nav">
+            <%= render 'shared/main_menu_links' %>
+          </ul>
+        </nav>
+      </div>
+    </div>
+  </div>
+</div>

data/app/components/arclight/masthead_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render the masthead
+  class MastheadComponent < Blacklight::Component
+    def heading
+      t('arclight.masthead_heading_html')
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+<%= tag.div id: t("arclight.views.show.sections.#{@section}").parameterize do %>
+  <% if @heading %>
+    <h3 class='al-show-sub-heading'>
+      <%= t("arclight.views.show.sections.#{@section}", level: @presenter.document.level) %>
+    </h3>
+  <% end %>
+
+  <%= tag.dl class: @classes do %>
+    <% @presenter.field_presenters.each do |field_presenter| %>
+      <%= render (field_presenter.component || Blacklight::MetadataFieldComponent).new(field: field_presenter, show: true, **@metadata_attr) %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/arclight/metadata_section_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a simple metadata field (e.g. without labels) in a .row div
+  class MetadataSectionComponent < ViewComponent::Base
+    with_collection_parameter :section
+
+    def initialize(section:, presenter:, metadata_attr: {}, classes: %w[row dl-invert], heading: false)
+      super()
+
+      @classes = classes
+      @section = section
+      @presenter = presenter.with_field_group(section)
+      @heading = heading
+      @metadata_attr = metadata_attr
+    end
+
+    def render?
+      @presenter.fields_to_render.any?
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<%= tag.div(class: 'al-oembed-viewer', data: { controller: 'arclight-oembed', arclight_oembed_url_value: @resource.href }) do %>
+  <div class="al-digital-object">
+    <%= link_to(@resource.label, @resource.href) %>
+  </div>
+<% end %>

data/app/components/arclight/oembed_viewer_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render an oembed viewer for a document
+  class OembedViewerComponent < ViewComponent::Base
+    with_collection_parameter :resource
+
+    def initialize(resource:, document:, depth: 0)
+      super()
+
+      @resource = resource
+      @document = document
+      @depth = depth
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+<div class="card online-contents">
+  <div class="card-body d-flex align-items-center">
+    <div class="d-flex">
+      <span class="al-online-content-icon mr-2 me-2" aria-hidden="true"><%= helpers.blacklight_icon :online %></span>
+      <h2 class="d-none d-lg-inline">
+        <span class="visually-hidden">Filter</span>
+        <%= t('arclight.views.show.online_content.title') %>
+      </h2>
+    </div>
+    <div class="ms-3 ms-xl-5">
+      <div><%= t('arclight.views.show.online_content.description') %></div>
+      <%= link_to t('arclight.views.show.online_content.link_text'), helpers.search_action_path(f: { collection: [collection_name], access: ['online'] }) %>
+    </div>
+  </div>
+</div>

data/app/components/arclight/online_content_filter_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render the box that displays a link to filter only for online content
+  class OnlineContentFilterComponent < Blacklight::Component
+    def initialize(document:)
+      @document = document
+      super()
+    end
+
+    def render?
+      @document.collection? && @document.online_content?
+    end
+
+    delegate :collection_name, to: :@document
+  end
+end

data/app/components/arclight/online_status_indicator_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render an online status indicator for a document
+  class OnlineStatusIndicatorComponent < Blacklight::Component
+    def initialize(document:, **)
+      @document = document
+      super()
+    end
+
+    def render?
+      @document.online_content?
+    end
+
+    def call
+      tag.span helpers.blacklight_icon(:online), class: 'al-online-content-icon'
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+<li class='breadcrumb-item'>
+  <span class="ms-3" aria-hidden="true">
+    <%= blacklight_icon(:repository, classes: 'al-repository-content-icon') %>
+  </span>
+  <% if repository_path %>
+    <%= link_to(@document.repository, helpers.arclight_engine.repository_path(repository_path)) %>
+  <% else %>
+    <%= @document.repository %>
+  <% end %>
+</li>

data/app/components/arclight/repository_breadcrumb_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Draws the repository breadcrumb item for a search result
+  class RepositoryBreadcrumbComponent < ViewComponent::Base
+    def initialize(document:)
+      super()
+      @document = document
+    end
+
+    delegate :blacklight_icon, to: :helpers
+
+    def repository_path
+      @document.repository_config&.slug
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+<%= render(@layout.new(field: @field)) do |component| %>
+  <% component.with_label do %>
+    <%= label %>
+  <% end %>
+  <% component.with_value do %>
+    <div class='al-in-person-repository-name'>
+      <% if repository.thumbnail_url %>
+        <%= image_tag repository.thumbnail_url, alt: '', class: 'img-fluid float-left' %>
+      <% end %>
+      <div>
+        <%= link_to(repository.name, helpers.arclight_engine.repository_path(repository.slug)) %>
+      </div>
+    </div>
+    <div class='al-in-person-repository-location'>
+      <address>
+        <%= repository.location %>
+      </address>
+    </div>
+  <% end %>
+<% end %>

data/app/components/arclight/repository_location_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render the repository location card as a metadata field
+  class RepositoryLocationComponent < Blacklight::MetadataFieldComponent
+    def repository
+      @field.values.first
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+<%= render(Blacklight::SearchBarComponent.new(
+      **@kwargs,
+      params: @params.merge(f: (@params[:f] || {}).except(:collection)),
+                            q: @q,
+                            search_field: @search_field)) do |c| %>
+
+  <% c.with_before_input_group do %>
+    <div class="input-group within-collection-dropdown">
+      <label class="input-group-text" for="within_collection">
+        <%= t('arclight.within_collection_dropdown.label_html') %>
+      </label>
+      <%= select_tag ('f[collection][]' if collection_name.present?), within_collection_options, id: 'within_collection', class: 'form-select search-field rounded-end' %>
+    </div>
+  <% end %>
+
+  <% c.with_prepend do %>
+    <%= prepend %>
+  <% end %>
+
+  <% c.with_append do %>
+    <%= append %>
+  <% end if append? %>
+
+  <% c.with_search_button do %>
+    <%= search_button %>
+  <% end if respond_to?(:search_button?) && search_button? # only BL8 has this option %>
+<% end %>

data/app/components/arclight/search_bar_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Override Blacklight's SearchBarComponent to add a dropdown for choosing
+  # the context of the search (within "this collection" or "all collections").
+  # If a collection has not been chosen, it displays a dropdown with only "all collections"
+  # as the only selectable option.
+  class SearchBarComponent < Blacklight::SearchBarComponent
+    def initialize(**kwargs)
+      super
+
+      @kwargs = kwargs
+    end
+
+    def within_collection_options
+      value = collection_name || 'none-selected'
+      options_for_select(
+        [
+          [t('arclight.within_collection_dropdown.all_collections'), ''],
+          [t('arclight.within_collection_dropdown.this_collection'), value]
+        ],
+        selected: collection_name,
+        disabled: 'none-selected'
+      )
+    end
+
+    def collection_name
+      @collection_name ||= Array(@params.dig(:f, :collection)).reject(&:empty?).first ||
+                           helpers.current_context_document&.collection_name
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+<dt class="visually-hidden">Collection Context</dt>
+<dd>
+  <div class='breadcrumb-links'>
+    <%= rendered_breadcrumbs %>
+  </div>
+</dd>

data/app/components/arclight/search_result_breadcrumbs_component.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render the breadcrumbs for a search result document
+  class SearchResultBreadcrumbsComponent < Blacklight::MetadataFieldComponent
+    delegate :document, to: :@field
+
+    def initialize(field:, **kwargs)
+      @field = field
+      super
+    end
+
+    def breadcrumbs
+      offset = grouped? ? 2 : 0
+
+      Arclight::BreadcrumbComponent.new(document: document, count: breadcrumb_count, offset: offset)
+    end
+
+    def rendered_breadcrumbs
+      @rendered_breadcrumbs ||= capture { render breadcrumbs }
+    end
+
+    def render?
+      rendered_breadcrumbs.present?
+    end
+
+    def breadcrumb_count
+      @field.field_config.compact&.dig(:count) if compact?
+    end
+
+    delegate :grouped?, to: :helpers
+
+    def compact?
+      helpers.document_index_view_type == :compact
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+<%= content_tag @component,
+  id: @id,
+  data: {
+    'document-id': @document.id.to_s.parameterize,
+    'document-counter': @counter,
+  },
+  itemscope: true,
+  itemtype: @document.itemtype,
+  class: classes.flatten.join(' ') do %>
+    <div class="px-2 document-type-icon">
+      <%= icon %>
+    </div>
+    <div class="container">
+      <%= render Arclight::SearchResultTitleComponent.new(document: document, compact: compact?) %>
+
+      <div class="row">
+        <%= metadata %>
+      </div>
+    </div>
+<% end %>

data/app/components/arclight/search_result_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a document for a search result; this works with
+  # both the compact and list views for grouped or ungrouped
+  # results.
+  class SearchResultComponent < Blacklight::DocumentComponent
+    attr_reader :document
+
+    def compact?
+      presenter.view_config.key.to_s == 'compact'
+    end
+
+    def icon
+      helpers.blacklight_icon helpers.document_or_parent_icon(@document)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+<header class="documentHeader row" data-document-id="<%= @document.id %>">
+  <h3 class="index_title document-title-heading col">
+    <%= helpers.link_to_document @document, counter: @counter %>
+    <% @document.extent.each do |extent| %>
+      <%= tag.span extent, class: 'al-document-extent badge' unless compact? %>
+    <% end %>
+    <%= tag.span class: 'al-document-container text-muted' do %>
+      <%= @document.containers.join(', ') %>
+    <% end if @document.containers.present? %>
+  </h3>
+
+  <% actions.each do |action| %>
+    <%= action %>
+  <% end %>
+</header>

data/app/components/arclight/search_result_title_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render a document title for a search result
+  class SearchResultTitleComponent < Blacklight::DocumentTitleComponent
+    def initialize(compact:, **args)
+      @compact = compact
+      super(**args)
+    end
+
+    def compact?
+      @compact
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<div class="offcanvas-lg offcanvas-start p-3 p-lg-1" tabindex="-1" id="sidebar">
+  <%= collection_context %>
+  <%= render 'show_tools', document: document %>
+  <%= collection_sidebar %>
+  <div id="collection-context" class="sidebar-section">
+    <h2><%= t('arclight.views.show.has_content') %></h2>
+    <%= turbo_frame_tag "al-hierarchy-#{document.root}", loading: 'lazy', src: hierarchy_solr_document_path(id: document.root, nest_path: @document.nest_path, hierarchy: true) %>
+  </div>
+</div>

data/app/components/arclight/sidebar_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Arclight
+  # A sidebar with collection context widget and tools
+  class SidebarComponent < Blacklight::Document::SidebarComponent
+    delegate :blacklight_config, :document_presenter, :should_render_field?,
+             :turbo_frame_tag, to: :helpers
+
+    def collection_context
+      render Arclight::CollectionContextComponent.new(presenter: document_presenter(document), download_component: Arclight::DocumentDownloadComponent)
+    end
+
+    def collection_sidebar
+      render Arclight::CollectionSidebarComponent.new(document: document,
+                                                      collection_presenter: document_presenter(document.collection),
+                                                      partials: blacklight_config.show.metadata_partials)
+    end
+  end
+end

data/app/components/arclight/upper_metadata_layout_component.rb

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

data/app/components/blacklight/icons/bookmark_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The bookmark icon
+    class BookmarkComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 384 512"><path d="M0 512V48C0 21.49 21.49 0 48 0h288c26.51 0 48 21.49 48 48v464L192 400 0 512z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/collection_component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The collection icon
+    class CollectionComponent < Blacklight::Icons::IconComponent
+      # Used unmodified from https://fontawesome.com
+      # CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 512 512"><path d="M32 448c0 17.7 14.3 32 32 32h384c17.7 0 32-14.3 32-32V160H32v288zm160-212c0-6.6 5.4-12 12-12h104c6.6 0 12 5.4 12 12v8c0 6.6-5.4 12-12 12H204c-6.6 0-12-5.4-12-12v-8zM480 32H32C14.3 32 0 46.3 0 64v48c0 8.8 7.2 16 16 16h480c8.8 0 16-7.2 16-16V64c0-17.7-14.3-32-32-32z"/></svg>
+      SVG
+    end
+  end
+end