arclight 0.0.1 → 1.6.2

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

@@ -0,0 +1,250 @@
+:root {
+  --al-content-icon-color: #{$secondary};
+}
+
+.documents-list {
+  margin-bottom: $spacer;
+
+  // Result item header
+  .al-document-title-bar {
+    background-color: $gray-200;
+    border: $default-border-styling;
+    font-size: $font-size-sm;
+    margin: 0 (-$result-item-body-padding - 1px) 0.5rem;
+    padding: 3px $result-item-body-padding;
+  }
+
+  // Result item body
+  article.document {
+    border-bottom: $default-border-styling;
+    margin-top: 0;
+    padding: $spacer 0;
+
+    &:first-child {
+      padding-top: 0;
+    }
+
+    .document-title-heading {
+      font-size: $h5-font-size;
+      .al-document-extent {
+        @include extent-badge;
+      }
+    }
+
+    .breadcrumb-links,
+    .al-document-creator,
+    .al-document-extent,
+    .al-document-abstract-or-scope {
+      font-size: $font-size-sm;
+    }
+
+    .al-document-abstract-or-scope {
+      margin-bottom: $spacer * 0.5;
+      max-width: 45em;
+    }
+  }
+}
+
+article.document {
+  .blacklight-icons svg {
+    fill: var(--al-content-icon-color);
+  }
+  div.breadcrumb-links,
+  dd.al-document-abstract-or-scope,
+  dd.al-document-creator {
+    margin-top: ($spacer * 0.5);
+  }
+
+  form.bookmark-toggle.col-auto {
+    padding-right: 0;
+  }
+}
+
+.al-grouped-results {
+  .breadcrumb-links {
+    font-size: $font-size-sm;
+  }
+
+  .al-document-abstract-or-scope {
+    margin-bottom: 0;
+    margin-top: $spacer * 0.75;
+    max-width: 45em;
+  }
+  .al-grouped-repository {
+    font-size: $font-size-sm;
+    margin-bottom: $spacer * 0.75;
+  }
+  .al-grouped-title-bar {
+    background-color: $gray-200;
+    padding: $result-item-body-padding;
+
+    h3 {
+      display: inline;
+      font-size: $h4-font-size;
+    }
+  }
+  .grouped-documents {
+    margin: $result-item-body-padding 0;
+    h4 {
+      font-size: $h5-font-size;
+    }
+
+    .al-grouped-more {
+      border-bottom: $default-border-styling;
+      margin-bottom: $spacer;
+      padding: ($spacer * 0.5) 0;
+    }
+
+    .document {
+      border-bottom: $default-border-styling;
+      margin-top: 0;
+      padding: $spacer 0;
+
+      &:last-child {
+        border-bottom: 0;
+      }
+    }
+  }
+
+  .al-document-extent {
+    @include extent-badge;
+    background-color: $gray-100;
+    border-color: $gray-400;
+    color: $gray-700;
+  }
+}
+
+.al-data-range-histogram {
+  margin-bottom: $spacer;
+}
+
+.blacklight-catalog-index #appliedParams {
+  margin-bottom: ($spacer * 3) !important;
+}
+
+// Compact Search Results
+.documents-compact {
+  margin-bottom: $spacer;
+
+  h3 {
+    font-size: $h5-font-size;
+  }
+
+  .document {
+    border-bottom: $default-border-styling;
+    display: flex;
+    padding: $spacer 0;
+
+    &:first-child {
+      padding-top: 0;
+    }
+    .breadcrumb-links,
+    .al-repository-footer {
+      font-size: $font-size-sm;
+    }
+  }
+}
+
+.index-document-functions {
+  display: flex;
+  justify-content: flex-end !important;
+}
+
+.al-document-container.text-muted {
+  color: $gray-600 !important;
+  font-size: 16px;
+  float: right;
+}
+
+.col-no-left-padding {
+  padding-left: 0 !important;
+}
+
+.col-no-right-padding {
+  padding-right: 0 !important;
+}
+
+.breadcrumb-links a {
+  text-decoration-style: dotted;
+  color: $body-color;
+
+  &:hover,
+  &:active {
+    text-decoration-style: solid;
+  }
+}
+
+.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 {
+  fill: $white;
+}
+
+.sort-pagination {
+  flex-wrap: wrap;
+}
+
+.search-widgets {
+  width: 100%;
+  align-items: center;
+  flex-wrap: wrap;
+  justify-content: flex-end;
+}
+
+.result-type-group {
+  order: -1;
+  flex-grow: 1;
+  &.btn-group > .btn {
+    flex-grow: 0;
+  }
+}
+@include media-breakpoint-down(md) {
+  .result-type-group {
+    margin-bottom: 0.5rem;
+    width: 100%;
+  }
+
+  .search-widgets {
+    justify-content: flex-start;
+  }
+}
+
+.show-document {
+  .al-contents {
+    .breadcrumb-links {
+      display: none;
+    }
+
+    .sort-pagination {
+      margin-bottom: 0;
+    }
+
+    article {
+      padding-left: 1rem;
+      padding-right: 1rem;
+    }
+
+    article:first-child {
+      padding-top: 1rem;
+    }
+
+    article:nth-child(odd) {
+      background-color: $gray-100;
+    }
+
+    .index_title {
+      font-size: 1rem;
+    }
+
+    .bookmark-toggle {
+      display: none;
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+// Collection context
+.al-show-sub-heading {
+  font-size: $h6-font-size;
+  text-transform: uppercase;
+}
+
+.al-collection-actions-menu {
+  float: right;
+}
+
+// Access
+#access-and-use {
+  dl dd {
+    line-height: 1.4;
+    margin-bottom: $spacer;
+  }
+
+  img {
+    margin-bottom: $headings-margin-bottom;
+    margin-right: $spacer;
+    max-height: 150px;
+    max-width: 150px;
+  }
+
+  .al-in-person-repository-name,
+  .al-in-person-repository-location {
+    font-size: $font-size-sm;
+    line-height: 1.25;
+  }
+
+  .al-repository-contact-city_state_zip_country {
+    margin-bottom: ($spacer * 0.5);
+  }
+}
+
+.al-digital-object.breadcrumb-item {
+  margin-bottom: ($spacer * 0.5);
+}

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

@@ -0,0 +1,58 @@
+.truncator {
+  // content is clamped to 3 lines unless expanded
+  .content {
+    overflow: hidden;
+    display: -webkit-box;
+    text-overflow: ellipsis;
+    -webkit-box-orient: vertical;
+    -webkit-line-clamp: 3;
+  }
+
+  &.expanded .content {
+    display: initial;
+  }
+
+  // safari truncation fix
+  .content > * {
+    margin: 0;
+  }
+
+  // expand/collapse toggle is only shown if content is truncated
+  button {
+    display: none;
+  }
+
+  &.truncated button {
+    display: inline-block;
+  }
+
+  // "view more"/"view less" text swaps when content is expanded
+  .view-more {
+    color: shade-color($link-color, 20%);
+    display: inline;
+  }
+
+  .view-less {
+    color: shade-color($link-color, 20%);
+    display: none;
+  }
+
+  &.expanded {
+    .view-more {
+      display: none;
+    }
+
+    .view-less {
+      display: inline;
+    }
+  }
+
+  // icon rotates when content is expanded
+  .icon::before {
+    content: "▶";
+  }
+
+  &.expanded .icon::before {
+    content: "▼";
+  }
+}

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

@@ -0,0 +1,13 @@
+.my-w-25 {
+  width: 25% !important;
+}
+
+.my-w-75 {
+  width: 75% !important;
+}
+
+.w-md-100 {
+  @media (max-width: 767px) {
+    width: 100% !important;
+  }
+}

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

@@ -0,0 +1,25 @@
+// Colors
+$online-icon-color: $green !default;
+$background-highlight: #ffffaa !default;
+$default-border-color: $border-color  !default;
+$light-icon-color: #f5f5f5 !default;
+$dark-icon-color: $secondary !default;
+
+// Spacing
+$result-item-body-padding: 12px !default;
+
+// Mixins
+$default-border-styling: 1px solid $default-border-color !default;
+
+@mixin extent-badge {
+  background-color: $gray-200;
+  border: $default-border-styling;
+  border-radius: $border-radius-lg;
+  color: $dark;
+  font-size: $font-size-sm;
+  line-height: 1.2;
+  margin: 0;
+  padding: ($spacer * .25) ($spacer * .5);
+  text-align: left;
+  white-space: normal;
+}

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

@@ -0,0 +1,14 @@
+
+<% access_content = capture do %>
+  <%= render Arclight::MetadataSectionComponent.with_collection(section_names,
+              metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
+              presenter: presenter) %>
+<% end %>
+
+<% if access_content.present? %>
+  <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>
+<% end %>

data/app/components/arclight/access_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Render access information for a document
+  class AccessComponent < ViewComponent::Base
+    def initialize(presenter:)
+      super()
+      @show_config = presenter.configuration.show
+      @presenter = presenter
+    end
+
+    attr_reader :presenter, :show_config
+
+    delegate :collection?, to: :presenter
+
+    # @return Array<Symbol> a list of metadata section names
+    def section_names
+      return Array(collection_access_items) if collection?
+
+      Array(component_access_items)
+    end
+
+    delegate :collection_access_items, :component_access_items, to: :show_config
+  end
+end

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

@@ -0,0 +1,25 @@
+<% if current_or_guest_user %>
+  <%= form_tag(bookmark_path,
+              authenticity_token: false,
+              method:  bookmarked? ? :delete : :put,
+              class: "bookmark-toggle ms-2",
+              data: {
+                'doc-id' => document.id,
+                present: "#{blacklight_icon(:bookmark).html_safe}<span class=\"sr-only visually-hidden\">#{t('blacklight.search.bookmarks.present')}</span>",
+                absent: "#{blacklight_icon(:bookmark).html_safe}<span class=\"sr-only visually-hidden\">#{t('blacklight.search.bookmarks.absent')}</span>",
+                inprogress: t('blacklight.search.bookmarks.inprogress')
+              }) do %>
+    <div class="checkbox toggle-bookmark">
+      <label class="toggle-bookmark" data-checkboxsubmit-target="label">
+        <input type="checkbox" class="toggle-bookmark" data-checkboxsubmit-target="checkbox" <%= 'checked="checked"' if bookmarked? %>>
+        <span data-checkboxsubmit-target="span"><%= bookmarked? ? "#{blacklight_icon(:bookmark).html_safe}<span class=\"sr-only visually-hidden\">#{t('blacklight.search.bookmarks.present')}</span>".html_safe : "#{blacklight_icon(:bookmark).html_safe}<span class=\"sr-only visually-hidden\">#{t('blacklight.search.bookmarks.absent')}</span>".html_safe %></span>
+      </label>
+    </div>
+
+    <%= submit_tag(t(bookmarked? ? 'remove.button' : 'add.button', scope: 'blacklight.bookmarks'),
+                  id: "bookmark_toggle_#{document.id.to_s.parameterize}",
+                  class: "bookmark-#{bookmarked? ? 'remove' : 'add'} btn btn-outline-secondary") %>
+  <% end %>
+<% else %>
+  &nbsp;
+<% end %>

data/app/components/arclight/bookmark_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Arclight
+  # A component to render a bookmark button for a document
+  class BookmarkComponent < Blacklight::Document::BookmarkComponent
+    delegate :current_or_guest_user, :blacklight_icon, to: :helpers
+    attr_accessor :document
+  end
+end

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>