arclight 0.0.1 → 1.6.2

data/app/models/arclight/requests/aeon_web_ead.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This object relies on the ability to respond to attributes passed in as
+    # query parameters from the form mapping configuration
+    class AeonWebEad
+      attr_reader :document, :ead_url
+
+      ##
+      # @param [SolrDocument] document
+      # @param [String] ead_url
+      def initialize(document, ead_url)
+        @document = document
+        @ead_url = ead_url
+      end
+
+      ##
+      # Url target for Aeon request params
+      def request_url
+        request_config['request_url']
+      end
+
+      ##
+      # Constructed request URL
+      def url
+        "#{request_url}?#{form_mapping.to_query}"
+      end
+
+      ##
+      # Converts mappings as a query url param into a Hash used for sending
+      # messages
+      # If a defined method is provided as a value, that method will be invoked
+      # "collection_name=entry.123" => { "collection_name" => "entry.123" }
+      # @return [Hash]
+      def form_mapping
+        form_hash = Rack::Utils.parse_nested_query(
+          request_config['request_mappings']
+        )
+        form_hash.each do |key, value|
+          respond_to?(value) && form_hash[key] = send(value)
+        end
+        form_hash
+      end
+
+      def request_config
+        document.repository_config.request_config_for_type('aeon_web_ead')
+      end
+    end
+  end
+end

data/app/models/arclight/requests/google_form.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This object relies on the ability to respond to attributes passed in as
+    # query parameters from the form mapping configuratino
+    class GoogleForm
+      attr_reader :document, :presenter, :document_url
+
+      delegate :collection_name, :collection_creator, :eadid, :containers, to: :document
+
+      ##
+      # @param [SolrDocument] document
+      # @param [Arclight::ShowPresenter] presenter
+      # @param [String] document_url
+      def initialize(document, presenter, document_url)
+        @document = document
+        @presenter = presenter
+        @document_url = document_url
+      end
+
+      ##
+      # Url of form to fill
+      def url
+        request_config['request_url']
+      end
+
+      ##
+      # Converts mappings as a query url param into a Hash used for sending
+      # messages and providing pre-filled form fields
+      # "collection_name=entry.123" => { "collection_name" => "entry.123" }
+      # @return [Hash]
+      def form_mapping
+        Rack::Utils.parse_nested_query(
+          request_config['request_mappings']
+        )
+      end
+
+      def title
+        presenter.heading
+      end
+
+      def request_config
+        document.repository_config&.request_config_for_type('google_form')
+      end
+    end
+  end
+end

data/app/models/concerns/arclight/catalog.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Arclight specific methods for the Catalog
+  module Catalog
+    extend ActiveSupport::Concern
+
+    included do
+      before_action only: :index do
+        if (params.dig(:f, :collection) || []).any?(&:blank?)
+          params[:f][:collection].compact_blank!
+          params[:f].delete(:collection) if params[:f][:collection].blank?
+        end
+      end
+
+      before_action only: :hierarchy do
+        blacklight_config.search_state_fields += %i[id limit offset]
+      end
+
+      Blacklight::Configuration.define_field_access :summary_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :background_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :related_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :indexed_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :in_person_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :cite_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :contact_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_indexed_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :group_header_field, Blacklight::Configuration::IndexField
+    end
+
+    def hierarchy
+      @response = search_service.search_results
+    end
+
+    # Overrides blacklight search state so we can exclude some parameters from being passed into the SearchState
+    def search_state
+      @search_state ||= search_state_class.new(params.except('hierarchy', 'nest_path'), blacklight_config, self)
+    end
+  end
+end

data/app/models/concerns/arclight/search_behavior.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Customized Search Behavior for Arclight
+  module SearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += %i[
+        add_highlighting
+        add_grouping
+        add_hierarchy_behavior
+      ]
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def add_hierarchy_behavior(solr_parameters)
+      return unless search_state.controller&.action_name == 'hierarchy'
+
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "_nest_parent_:#{blacklight_params[:id]}"
+      solr_parameters[:rows] = blacklight_params[:per_page]&.to_i || blacklight_params[:limit]&.to_i || 999_999_999
+      solr_parameters[:start] = blacklight_params[:offset] if blacklight_params[:offset]
+      solr_parameters[:sort] = 'sort_isi asc'
+      solr_parameters[:facet] = false
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+    ##
+    # Add highlighting
+    def add_highlighting(solr_params)
+      solr_params['hl'] = true
+      solr_params['hl.fl'] = CatalogController.blacklight_config.highlight_field
+      solr_params['hl.snippets'] = 3
+      solr_params
+    end
+
+    ##
+    # Adds grouping parameters for Solr if enabled
+    def add_grouping(solr_params)
+      solr_params.merge!(Arclight::Engine.config.catalog_controller_group_query_params) if blacklight_params[:group] == 'true'
+
+      solr_params
+    end
+  end
+end

data/app/models/concerns/arclight/solr_document.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Extends Blacklight::Solr::Document to provide Arclight specific behavior
+  module SolrDocument
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :collection_id, :string, '_root_'
+      Arclight.deprecation.deprecate_methods(self, collection_id: 'Use `root` instead')
+      attribute :parent_ids, :array, 'parent_ids_ssim'
+      attribute :legacy_parent_ids, :array, 'parent_ssim'
+      Arclight.deprecation.deprecate_methods(self, legacy_parent_ids: 'Use `parent_ids` instead')
+      attribute :parent_labels, :array, 'parent_unittitles_ssm'
+      attribute :parent_levels, :array, 'parent_levels_ssm'
+      attribute :unitid, :string, 'unitid_ssm'
+      attribute :extent, :array, 'extent_ssm'
+      attribute :abstract, :string, 'abstract_html_tesm'
+      attribute :scope, :string, 'scopecontent_html_tesm'
+      attribute :creator, :string, 'creator_ssm'
+      attribute :level, :string, 'level_ssm'
+      attribute :terms, :string, 'userestrict_html_tesm'
+      # Restrictions for component sidebar
+      attribute :parent_restrictions, :string, 'parent_access_restrict_tesm'
+      # Terms for component sidebar
+      attribute :parent_terms, :string, 'parent_access_terms_tesm'
+      attribute :reference, :string, 'ref_ssm'
+      attribute :normalized_title, :string, 'normalized_title_ssm'
+      attribute :normalized_date, :string, 'normalized_date_ssm'
+      attribute :total_component_count, :string, 'total_component_count_is'
+      attribute :online_item_count, :string, 'online_item_count_is'
+      attribute :last_indexed, :date, 'timestamp'
+    end
+
+    def repository_config
+      return unless repository
+
+      @repository_config ||= Arclight::Repository.find_by(name: repository)
+    end
+
+    def parents
+      @parents ||= Arclight::Parents.from_solr_document(self).as_parents
+    end
+
+    # Get this document's EAD ID, or fall back to the collection (especially
+    # for components that may not have their own.
+    def eadid
+      first('ead_ssi')&.strip || collection&.first('ead_ssi')&.strip
+    end
+
+    def normalized_eadid
+      Arclight::NormalizedId.new(eadid).to_s
+    end
+    Arclight.deprecation.deprecate_methods(self, normalized_eadid: 'Use `root` instead')
+
+    def repository
+      first('repository_ssm') || collection&.first('repository_ssm')
+    end
+
+    def repository_and_unitid
+      [repository, unitid].compact.join(': ')
+    end
+
+    # @return [SolrDocument] a SolrDocument representing the EAD collection
+    #   that this document belongs to
+    def collection
+      return self if collection?
+
+      @collection ||= self.class.new(self['collection']&.dig('docs', 0), @response)
+    end
+
+    def collection_name
+      collection&.normalized_title
+    end
+
+    def collection_unitid
+      collection&.unitid
+    end
+
+    def abstract_or_scope
+      abstract || scope
+    end
+
+    def collection_creator
+      collection&.creator
+    end
+
+    def online_content?
+      first('has_online_content_ssim') == 'true'
+    end
+
+    def number_of_children
+      first('child_component_count_isi') || 0
+    end
+
+    def children?
+      number_of_children.positive?
+    end
+
+    def component_level
+      first('component_level_isim')
+    end
+
+    def collection?
+      level&.parameterize == 'collection'
+    end
+
+    def digital_objects
+      digital_objects_field = fetch('digital_objects_ssm', []).reject(&:empty?)
+      return [] if digital_objects_field.blank?
+
+      digital_objects_field.map do |object|
+        Arclight::DigitalObject.from_json(object)
+      end
+    end
+
+    def containers
+      # NOTE: Keep uppercase characters if present, but upcase the first if not already
+      containers_field = fetch('containers_ssim', []).reject(&:empty?)
+      return [] if containers_field.blank?
+
+      containers_field.map do |container|
+        container.dup.sub!(/\A./, &:upcase)
+      end
+    end
+
+    # @return [Array<String>] with embedded highlights using <em>...</em>
+    def highlights
+      highlight_field(CatalogController.blacklight_config.highlight_field)
+    end
+
+    # Factory method for constructing the Object modeling downloads
+    # @return [DocumentDownloads]
+    def downloads
+      @downloads ||= DocumentDownloads.new(self)
+    end
+
+    def ead_file
+      @ead_file ||= begin
+        files = Arclight::DocumentDownloads.new(self, collection_unitid).files
+        files.find do |file|
+          file.type == 'ead'
+        end
+      end
+    end
+
+    def nest_path
+      self['_nest_path_']
+    end
+
+    def root
+      self['_root_'] || self['id']
+    end
+
+    def requestable?
+      repository_config&.request_types&.any?
+    end
+  end
+end

data/app/presenters/arclight/index_presenter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Custom presentation methods for index partials
+  class IndexPresenter < Blacklight::IndexPresenter
+    def label(*)
+      document.normalized_title
+    end
+  end
+end

data/app/presenters/arclight/show_presenter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Custom presentation methods for show partial
+  class ShowPresenter < Blacklight::ShowPresenter
+    attr_accessor :field_group
+
+    delegate :collection?, to: :document
+
+    def heading
+      document.normalized_title
+    end
+
+    def with_field_group(group)
+      if block_given?
+        old_group = field_group
+
+        begin
+          self.field_group = group
+          yield(self)
+        ensure
+          self.field_group = old_group if block_given?
+        end
+      else
+        dup.tap { |x| x.field_group = group }
+      end
+    end
+
+    private
+
+    # @return [Hash<String,Configuration::Field>] all the fields for this index view
+    def fields
+      if field_group
+        configuration["#{field_group}s"] || []
+      else
+        super
+      end
+    end
+
+    def field_config(field)
+      return super unless field_group
+
+      fields.fetch(field) do
+        if defined?(Blacklight::Configuration::NullDisplayField)
+          # For Blacklight 8:
+          Blacklight::Configuration::NullDisplayField.new(field)
+        else
+          # Blacklight 7
+          Blacklight::Configuration::NullField.new(field)
+        end
+      end
+    end
+  end
+end

data/app/views/arclight/_requests.html.erb

@@ -0,0 +1,7 @@
+<% if document.requestable? %>
+  <div class='al-request'>
+    <% document.repository_config.available_request_types.each do |request_type| %>
+      <%= render partial: "arclight/requests/#{request_type}", locals: { document: document } %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/arclight/repositories/_repository.html.erb

@@ -0,0 +1,43 @@
+<div class="mb-3 mx-auto al-repository">
+  <div class="container">
+    <div class='row'>
+      <div class='col-2 align-self-center d-none d-lg-block al-repository-thumbnail'>
+        <%= image_tag repository.thumbnail_url, alt: repository.name, class: 'img-fluid d-block mx-auto' %>
+      </div>
+
+      <div class="col-sm-12 col-lg-10 py-3 al-repository-information">
+        <%= content_tag(params[:id] == repository.slug ? :h1 : :h2, class: 'h5 mb-3 repo-name') do %>
+        <%= link_to_unless(params[:id] == repository.slug, repository.name, arclight_engine.repository_path(repository.slug)) %>
+        <% end %>
+        <div class='row no-gutters justify-content-center'>
+          <div class='col-12 col-sm-4 col-md-3 fw-light al-repository-contact'>
+            <address class="text-break">
+              <div class="mb-3 al-repository-street-address">
+                <%= repository.location %>
+              </div>
+
+              <div class="al-repository-contact-info">
+                <%= repository.contact %>
+              </div>
+            </address>
+          </div>
+
+          <div class='col-12 col-sm mt-3 mt-sm-0 al-repository-description'>
+            <%= repository.description %>
+          </div>
+
+          <% if on_repositories_index? %>
+          <div class='col-12 col-lg-2 mt-3 mt-lg-0 text-center al-repository-extra'>
+            <div class='mb-1 fst-italic fw-bold'>
+              <%= t(:'arclight.views.repositories.number_of_collections', count: repository.collection_count) %>
+            </div>
+            <% if repository.collection_count&.positive? %>
+            <%= link_to(t(:'arclight.views.repositories.view_more'), arclight_engine.repository_path(repository.slug), class: 'btn btn-secondary btn-sm') %>
+            <% end %>
+          </div>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/arclight/repositories/index.html.erb

@@ -0,0 +1,9 @@
+<% breadcrumb :repositories %>
+
+<h1 class="sr-only visually-hidden"><%= t('arclight.repositories') %></h1>
+
+<div class="al-repositories">
+  <% @page_title = t('arclight.views.repositories.title') %>
+  <%= render 'shared/breadcrumbs' %>
+  <%= render @repositories %>
+</div>

data/app/views/arclight/repositories/show.html.erb

@@ -0,0 +1,37 @@
+<% @page_title = t(:'arclight.views.repositories.show', name: @repository.name) %>
+<% breadcrumb :repository, @repository %>
+<%= render 'shared/breadcrumbs' %>
+<%= render @repository %>
+<div class="row al-repository-show-header">
+  <div class="col col-md-8 col-lg-9">
+    <h2 class="h4">
+      <%= t('arclight.views.show.our_collections') %>
+    </h2>
+  </div>
+  <div class="col text-right">
+    <span class="al-repository-collections">
+      <%= link_to(t(:'arclight.views.repositories.view_all_collections'), repository_collections_path(@repository)) %>
+    </span>
+  </div>
+</div>
+
+<div class="row">
+  <% @collections.each do |document| %>
+    <% doc_presenter = Arclight::IndexPresenter.new(document, self, CatalogController.blacklight_config) %>
+    <div class="col-md-12">
+      <div class='al-document-title-bar'>
+        <div class='row'>
+          <div class='col-md-10 col-lg-9'>
+            <h3 class="h5"><%= link_to doc_presenter.label, solr_document_path(document.id) %></h3>
+            <%= render Arclight::IndexMetadataFieldComponent.with_collection(doc_presenter.field_presenters.select { |p| p.field_config.repository_context }) %>
+          </div>
+          <% if document.unitid %>
+            <div class='col text-right al-collection-id'>
+              <%= t(:'arclight.views.show.collection_id', id: document.unitid) %>
+            </div>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/arclight/requests/_aeon_external_request_endpoint.html.erb

@@ -0,0 +1,8 @@
+<% aeon_external_request ||= Arclight::Requests::AeonExternalRequest.new(document, document_presenter(document)) %>
+
+<%= form_tag aeon_external_request.url, method: :post, class: 'd-inline-block al-request-form' do |f| %>
+  <%= render(Blacklight::HiddenSearchStateComponent.new(params: aeon_external_request.form_mapping)) %>
+  <button type='submit' class='al-request-button btn btn-primary btn-sm me-1'>
+    <%= t('arclight.request.container') %>
+  </button>
+<% end %>

data/app/views/arclight/requests/_aeon_web_ead.html.erb

@@ -0,0 +1,6 @@
+<% if parsed_files = document.ead_file %>
+  <% aeon_web_ead ||= Arclight::Requests::AeonWebEad.new(document, parsed_files.href) %>
+  <% aeon_web_ead_url = aeon_web_ead&.url %>
+
+  <%= link_to 'Request', aeon_web_ead_url, class: 'al-request-button btn btn-primary btn-sm me-1' %>
+<% end %>

data/app/views/arclight/requests/_google_form.html.erb

@@ -0,0 +1,10 @@
+<% google_form ||= Arclight::Requests::GoogleForm.new(document, document_presenter(document), solr_document_path(document)) %>
+
+<%= form_tag google_form.url, method: :get, class: 'd-inline-block al-request-form' do |f| %>
+  <% google_form.form_mapping.each do |key, value| %>
+    <%= hidden_field_tag value, google_form.public_send(key) %>
+  <% end %>
+  <button type='submit' class='al-request-button btn btn-primary btn-sm me-1'>
+    <%= t('arclight.request.container') %>
+  </button>
+<% end %>

data/app/views/catalog/_document_list.html.erb

@@ -0,0 +1,8 @@
+<% # Override to conditionally add id="documents" on div. When documents are grouped it causes duplicate id issues %>
+<% # https://github.com/projectblacklight/blacklight/blob/v8.1.0/app/views/catalog/_document_list.html.erb %>
+<% # container for all documents in index list view -%>
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
+<div <%= 'id="documents"'.html_safe unless grouped? %> class="al-document-listings documents-<%= view_config&.key || document_index_view_type %>">
+  <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
+  <%= render view_config.document_component.with_collection(document_presenters, partials: view_config.partials, counter_offset: @response&.start || 0) %>
+</div>

data/app/views/catalog/_group.html.erb

@@ -0,0 +1,4 @@
+<% # container for all groups in index view -%>
+<div id="documents" class='al-grouped-results'>
+  <%= render (blacklight_config.view_config(document_index_view_type).group_component || Arclight::GroupComponent).with_collection(@response.groups) %>
+</div>

data/app/views/catalog/_group_toggle.html.erb

@@ -0,0 +1,10 @@
+<div class="result-type-group btn-group" role="group" aria-label="<%= t('arclight.views.index.group_results') %>">
+  <%= link_to t('arclight.views.index.all_results'),
+              search_catalog_path(search_without_group),
+              class: "btn btn-outline-secondary #{'active' unless grouped?}"
+  %>
+  <%= link_to t('arclight.views.index.group_by_collection'),
+              search_catalog_path(search_with_group),
+              class: "btn btn-outline-secondary #{'active' if grouped?}"
+  %>
+</div>

data/app/views/catalog/_search_results_header.html.erb

@@ -0,0 +1,3 @@
+<%= render 'shared/breadcrumbs' %>
+
+<h1 class="sr-only visually-hidden top-content-title"><%= search_results_header_text %></h1>

data/app/views/catalog/hierarchy.html.erb

@@ -0,0 +1,19 @@
+<p><%= params[:id] %></p>
+<%= turbo_frame_tag "al-hierarchy-#{params[:id]}#{params[:key]}" do %>
+  <%= render partial: "paginate_compact", object: @response if show_pagination? && params[:paginate] %>
+  <% presenters = @response.documents.map{ | document | document_presenter(document) } %>
+  <% if params[:hierarchy].present? %>
+    <ul class="documents">
+      <%= render Arclight::DocumentCollectionHierarchyComponent.with_collection(presenters,
+                                                                                blacklight_config: blacklight_config,
+                                                                                nest_path: params[:nest_path]) %>
+    </ul>
+  <% else %>
+    <table class="table table-striped">
+      <%= render Arclight::DocumentCollectionContextComponent.with_collection(presenters,
+                                                                              blacklight_config: blacklight_config) %>
+    </table>
+  <% end %>
+
+  <%= render 'results_pagination' if params[:paginate] %>
+<% end %>

data/app/views/catalog/index.html.erb

@@ -0,0 +1,17 @@
+<% content_for(:sidebar) do %>
+  <% conf = blacklight_config.view_config(document_index_view_type) %>
+  <%= render conf.sidebar_component.new(blacklight_config: blacklight_config,
+                                        response: @response,
+                                        view_config: conf) %>
+<% end %>
+
+<% breadcrumb :search_results, search_state %>
+
+<%= render 'search_results' %>
+
+<%# override upstream to override the search results header, similar to https://github.com/projectblacklight/blacklight/pull/2831 %>
+<%# This section can be omitted in Blacklight 8 %>
+<% content_for(:container_header, flush: true) do -%>
+  <%= render 'search_results_header' %>
+  <%= render 'constraints' %>
+<% end %>

data/app/views/shared/_breadcrumbs.html.erb

@@ -0,0 +1,3 @@
+<nav class='al-search-breadcrumb' role='navigation' aria-label="<%= t('arclight.breadcrumbs.aria_label') %>">
+  <%= breadcrumbs style: :bootstrap5, aria_current: 'page', autoroot: true %>
+</nav>

data/app/views/shared/_main_menu_links.html.erb

@@ -0,0 +1,6 @@
+<li class="nav-item <%= repositories_active_class %>">
+  <%= link_to t('arclight.routes.repositories'), arclight_engine.repositories_path, class: 'nav-link' %>
+</li>
+<li class="nav-item ms-3 <%= collection_active_class %>">
+  <%= link_to t('arclight.routes.collections'), arclight_engine.collections_path, class: 'nav-link' %>
+</li>