arclight 0.4.0 → 1.0.0.beta1

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,24 @@
+# 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
+
+    # We need to initialize the view component counter variable
+    # See https://viewcomponent.org/guide/collections.html#collection-counter
+    def initialize(search_result_counter: nil, **kwargs)
+      super
+    end
+
+    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,13 @@
+<header class="documentHeader row" data-document-id="<%= @document.id %>">
+  <h3 class="index_title document-title-heading col">
+    <%= helpers.link_to_document @document, counter: @counter %>
+    <%= tag.span @document.extent, class: 'al-document-extent badge' if @document.extent && !compact? %>
+    <%= tag.span class: 'al-document-container text-muted ml-auto' 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' %>
+  <%= 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

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The compact icon
+    class CompactComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path d="M3,15H21V13H3Zm0,4H21V17H3Zm0-8H21V9H3ZM3,5V7H21V5Z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The container icon
+    class ContainerComponent < 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" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The ead icon
+    class EadComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M149.9 349.1l-.2-.2-32.8-28.9 32.8-28.9c3.6-3.2 4-8.8.8-12.4l-.2-.2-17.4-18.6c-3.4-3.6-9-3.7-12.4-.4l-57.7 54.1c-3.7 3.5-3.7 9.4 0 12.8l57.7 54.1c1.6 1.5 3.8 2.4 6 2.4 2.4 0 4.8-1 6.4-2.8l17.4-18.6c3.3-3.5 3.1-9.1-.4-12.4zm220-251.2L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM256 51.9l76.1 76.1H256zM336 464H48V48h160v104c0 13.3 10.7 24 24 24h104zM209.6 214c-4.7-1.4-9.5 1.3-10.9 6L144 408.1c-1.4 4.7 1.3 9.6 6 10.9l24.4 7.1c4.7 1.4 9.6-1.4 10.9-6L240 231.9c1.4-4.7-1.3-9.6-6-10.9zm24.5 76.9l.2.2 32.8 28.9-32.8 28.9c-3.6 3.2-4 8.8-.8 12.4l.2.2 17.4 18.6c3.3 3.5 8.9 3.7 12.4.4l57.7-54.1c3.7-3.5 3.7-9.4 0-12.8l-57.7-54.1c-3.5-3.3-9.1-3.2-12.4.4l-17.4 18.6c-3.3 3.5-3.1 9.1.4 12.4z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The file icon
+    class FileComponent < 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 384 512"><path d="M224 136V0H24C10.7 0 0 10.7 0 24v464c0 13.3 10.7 24 24 24h336c13.3 0 24-10.7 24-24V160H248c-13.2 0-24-10.8-24-24zm160-14.1v6.1H256V0h6.1c6.4 0 12.5 2.5 17 7l97.9 98c4.5 4.5 7 10.6 7 16.9z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The folder icon
+    class FolderComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The online icon
+    class OnlineComponent < 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" height="24" width="24" viewBox="0 0 640 512"><path d="M608 0H160a32 32 0 0 0-32 32v96h160V64h192v320h128a32 32 0 0 0 32-32V32a32 32 0 0 0-32-32zM232 103a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm352 208a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm-168 57H32a32 32 0 0 0-32 32v288a32 32 0 0 0 32 32h384a32 32 0 0 0 32-32V192a32 32 0 0 0-32-32zM96 224a32 32 0 1 1-32 32 32 32 0 0 1 32-32zm288 224H64v-32l64-64 32 32 128-128 96 96z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The pdf icon
+    class PdfComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M369.9 97.9L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM332.1 128H256V51.9l76.1 76.1zM48 464V48h160v104c0 13.3 10.7 24 24 24h104v288H48zm250.2-143.7c-12.2-12-47-8.7-64.4-6.5-17.2-10.5-28.7-25-36.8-46.3 3.9-16.1 10.1-40.6 5.4-56-4.2-26.2-37.8-23.6-42.6-5.9-4.4 16.1-.4 38.5 7 67.1-10 23.9-24.9 56-35.4 74.4-20 10.3-47 26.2-51 46.2-3.3 15.8 26 55.2 76.1-31.2 22.4-7.4 46.8-16.5 68.4-20.1 18.9 10.2 41 17 55.8 17 25.5 0 28-28.2 17.5-38.7zm-198.1 77.8c5.1-13.7 24.5-29.5 30.4-35-19 30.3-30.4 35.7-30.4 35zm81.6-190.6c7.4 0 6.7 32.1 1.8 40.8-4.4-13.9-4.3-40.8-1.8-40.8zm-24.4 136.6c9.7-16.9 18-37 24.7-54.7 8.3 15.1 18.9 27.2 30.1 35.5-20.8 4.3-38.9 13.1-54.8 19.2zm131.6-5s-5 6-37.3-7.8c35.1-2.6 40.9 5.4 37.3 7.8z"/></svg>
+      SVG
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The repository icon
+    class RepositoryComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M4 10v7h3v-7H4zm6 0v7h3v-7h-3zM2 22h19v-3H2v3zm14-12v7h3v-7h-3zm-4.5-9L2 6v2h19V6l-9.5-5z"/></svg>
+      SVG
+    end
+  end
+end

data/app/controllers/arclight/repositories_controller.rb

@@ -12,7 +12,7 @@ module Arclight
       @repository = Arclight::Repository.find_by!(slug: params[:id])
       search_service = Blacklight.repository_class.new(blacklight_config)
       @response = search_service.search(
-        q: "level_sim:Collection repository_sim:\"#{@repository.name}\"",
+        q: "level_ssim:Collection repository_ssim:\"#{@repository.name}\"",
         rows: 100
       )
       @collections = @response.documents
@@ -30,11 +30,11 @@ module Arclight
     def fetch_collection_counts
       search_service = Blacklight.repository_class.new(blacklight_config)
       results = search_service.search(
-        q: 'level_sim:Collection',
-        'facet.field': 'repository_sim',
+        q: 'level_ssim:Collection',
+        'facet.field': 'repository_ssim',
         rows: 0
       )
-      Hash[*results.facet_fields['repository_sim']]
+      Hash[*results.facet_fields['repository_ssim']]
     end
   end
 end

data/app/{controllers/concerns → helpers}/arclight/ead_format_helpers.rb

@@ -5,10 +5,9 @@ module Arclight
   # A module to add EAD to HTML transformation rules for Arclight
   module EadFormatHelpers # rubocop:disable Metrics/ModuleLength
     extend ActiveSupport::Concern
-    include ActionView::Helpers::OutputSafetyHelper
 
     def render_html_tags(args)
-      values = args[:value] || []
+      values = Array(args[:value])
       values.map! do |value|
         transform_ead_to_html(value)
       end
@@ -73,9 +72,7 @@ module Arclight
         node.name = 'span'
         node.prepend_child '"'
         node.add_child '"'
-      when 'italic'
-        node.name = 'em'
-      when 'nonproport'
+      when 'italic', 'nonproport'
         node.name = 'em'
       when 'singlequote'
         node.name = 'span'
@@ -178,7 +175,7 @@ module Arclight
       table_head = node.at_css('thead')
       node.children.first.add_previous_sibling(table_head)
       listhead_node = node.at_css('listhead')
-      return unless listhead_node.present?
+      return if listhead_node.blank?
 
       node.at_css('thead tr th:nth-of-type(1)').content = node.at_css('listhead/head01').content
       node.at_css('thead tr th:nth-of-type(2)').content = node.at_css('listhead/head02').content
@@ -187,7 +184,7 @@ module Arclight
 
     def format_chronlist_caption(node)
       head_node = node.at_css('head')
-      return unless head_node.present?
+      return if head_node.blank?
 
       head_node.name = 'caption'
       head_node['class'] = 'chronlist-head'

data/app/helpers/arclight/field_config_helpers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # A module to add configuration helpers for certain fields used by Arclight
+  module FieldConfigHelpers
+    include Arclight::EadFormatHelpers
+
+    def item_requestable?(document)
+      document.requestable?
+    end
+    Arclight.deprecation.deprecate_methods(self, item_requestable?: 'Call e.g. `document.requestable?` instead')
+
+    def link_to_name_facet(args)
+      options = args[:config]&.separator_options || {}
+      values = args[:value] || []
+
+      values.map do |value|
+        link_to(
+          value,
+          search_action_path(f: { names: [value] })
+        )
+      end.to_sentence(options).html_safe
+    end
+  end
+end