arclight 0.2.0 → 0.3.0

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

@@ -1,2 +1,22 @@
+// Colors
+$background-highlight: #ffffaa;
+$default-border-color: $border-color;
+
+// Spacing
 $result-item-body-padding: 12px;
-$result-item-border-styling: 1px solid #ccc;
+
+// Mixins
+$default-border-styling: 1px solid $default-border-color;
+
+@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/controllers/concerns/arclight/ead_format_helpers.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+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.map! do |value|
+        transform_ead_to_html(value)
+      end
+      values.map! { |value| wrap_in_paragraph(value) } if values.count > 1
+      safe_join(values.map(&:html_safe))
+    end
+
+    private
+
+    def transform_ead_to_html(value)
+      Loofah.xml_fragment(condense_whitespace(value))
+            .scrub!(ead_to_html_scrubber)
+            .scrub!(:strip).to_html
+    end
+
+    def ead_to_html_scrubber
+      Loofah::Scrubber.new do |node|
+        format_render_attributes(node) if node.attr('render').present?
+        format_lists(node) if %w[list chronlist].include? node.name
+        node
+      end
+    end
+
+    def condense_whitespace(str)
+      str.squish.strip.gsub(/>[\n\s]+</, '><')
+    end
+
+    def wrap_in_paragraph(value)
+      if value.start_with?('<')
+        value
+      else
+        content_tag(:p, value)
+      end
+    end
+
+    def format_render_attributes(node) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+      case node.attr('render')
+      when 'altrender'
+        node.name = 'span'
+        node['class'] = node['altrender']
+      when 'bold'
+        node.name = 'strong'
+      when 'bolddoublequote'
+        node.name = 'strong'
+        node.prepend_child '"'
+        node.add_child '"'
+      when 'bolditalic'
+        node.name = 'strong'
+        node.wrap('<em/>')
+      when 'boldsinglequote'
+        node.name = 'strong'
+        node.prepend_child '\''
+        node.add_child '\''
+      when 'boldsmcaps'
+        node.name = 'strong'
+        node.wrap('<small/>')
+        node['class'] = 'text-uppercase'
+      when 'boldunderline'
+        node.name = 'strong'
+        node['class'] = 'text-underline'
+      when 'doublequote'
+        node.name = 'span'
+        node.prepend_child '"'
+        node.add_child '"'
+      when 'italic'
+        node.name = 'em'
+      when 'nonproport'
+        node.name = 'em'
+      when 'singlequote'
+        node.name = 'span'
+        node.prepend_child '\''
+        node.add_child '\''
+      when 'smcaps'
+        node.name = 'small'
+        node['class'] = 'text-uppercase'
+      when 'sub'
+        node.name = 'sub'
+      when 'super'
+        node.name = 'sup'
+      when 'underline'
+        node.name = 'span'
+        node['class'] = 'text-underline'
+      end
+    end
+
+    def format_lists(node)
+      format_simple_lists(node) if node.name == 'list' && node['type'] != 'deflist'
+      format_deflists(node) if node.name == 'list' && node['type'] == 'deflist'
+      format_chronlists(node) if node.name == 'chronlist'
+    end
+
+    def format_simple_lists(node)
+      node.name = 'ul' if (%w[simple marked].include? node['type']) || node['type'].blank?
+      node.name = 'ol' if node['type'] == 'ordered'
+      node.remove_attribute('type')
+      head_node = node.at_css('head')
+      format_list_head(head_node) if head_node.present?
+      items = node.css('item')
+      items.each { |item_node| item_node.name = 'li' }
+    end
+
+    def format_list_head(node)
+      node['class'] = 'list-head'
+      node.name = 'div'
+      node.parent.previous = node # move it from within the list to above it
+    end
+
+    def format_deflists(node)
+      listhead_node = node.at_css('listhead')
+      labels = node.css('label')
+      items = node.css('item')
+      defitems = node.css('defitem')
+      node.remove_attribute('type')
+
+      if listhead_node.present?
+        format_deflist_as_table(node, labels, items, defitems)
+      else
+        format_deflist_as_dl(node, labels, items, defitems)
+      end
+    end
+
+    def format_deflist_as_table(node, labels, items, defitems)
+      node.name = 'table'
+      node['class'] = 'table deflist'
+      listhead_node = node.at_css('listhead')
+      format_deflist_table_head(listhead_node)
+      node.at_css('thead').next = '<tbody/>'
+      labels.each { |label_node| label_node.name = 'td' }
+      items.each { |item_node| item_node.name = 'td' }
+      defitems.each do |defitem_node|
+        defitem_node.name = 'tr'
+        defitem_node.parent = node.at_css('tbody')
+      end
+    end
+
+    def format_deflist_table_head(listhead_node)
+      listhead_node.at_css('head01').name = 'th'
+      listhead_node.at_css('head02').name = 'th'
+      listhead_node.name = 'tr'
+      listhead_node.wrap('<thead/>')
+    end
+
+    def format_deflist_as_dl(node, labels, items, defitems)
+      node.name = 'dl'
+      node['class'] = 'deflist'
+      labels.each { |label_node| label_node.name = 'dt' }
+      items.each { |item_node| item_node.name = 'dd' }
+      defitems.each { |defitem_node| defitem_node.swap(defitem_node.children) } # unwrap
+    end
+
+    def format_chronlists(node)
+      node.name = 'table'
+      node['class'] = 'table chronlist'
+      eventgrps = node.css('eventgrp')
+      single_events = node.css('chronitem > event')
+      multi_events = node.css('eventgrp > event')
+      format_chronlist_header(node)
+      node.at_css('thead').next = '<tbody/>'
+      format_chronlist_caption(node)
+      format_chronlist_chronitems(node)
+      format_chronlist_dates(node)
+      format_chronlist_events(eventgrps, single_events, multi_events)
+    end
+
+    def format_chronlist_header(node)
+      node.add_child('<thead><tr><th>Date</th><th>Event</th></tr></thead>')
+      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?
+
+      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
+      listhead_node.remove
+    end
+
+    def format_chronlist_caption(node)
+      head_node = node.at_css('head')
+      return unless head_node.present?
+
+      head_node.name = 'caption'
+      head_node['class'] = 'chronlist-head'
+      node.children.first.add_previous_sibling(head_node) # make the caption first
+    end
+
+    def format_chronlist_chronitems(node)
+      chronitems = node.css('chronitem')
+      chronitems.each do |chronitem_node|
+        chronitem_node.name = 'tr'
+        chronitem_node.parent = node.at_css('tbody')
+      end
+    end
+
+    def format_chronlist_dates(node)
+      dates = node.css('date')
+      dates.each do |date_node|
+        date_node.name = 'td'
+        date_node['class'] = 'chronlist-item-date'
+      end
+    end
+
+    def format_chronlist_events(eventgrps, single_events, multi_events)
+      eventgrps.each do |eventgrp_node|
+        eventgrp_node.name = 'td'
+        eventgrp_node['class'] = 'chronlist-item-event'
+      end
+      single_events.each do |event_node|
+        event_node.name = 'td'
+        event_node['class'] = 'chronlist-item-event'
+      end
+      multi_events.each { |event_node| event_node.name = 'div' }
+    end
+  end
+end

data/app/controllers/concerns/arclight/field_config_helpers.rb

@@ -7,18 +7,22 @@ module Arclight
     extend ActiveSupport::Concern
     include ActionView::Helpers::OutputSafetyHelper
     include ActionView::Helpers::TagHelper
+    include Arclight::EadFormatHelpers
 
     included do
       if respond_to?(:helper_method)
         helper_method :repository_config_present
         helper_method :request_config_present
-        helper_method :context_sidebar_repository
+        helper_method :context_access_tab_repository
+        helper_method :access_repository_contact
         helper_method :before_you_visit_note_present
-        helper_method :context_sidebar_visit_note
+        helper_method :context_access_tab_visit_note
+        helper_method :highlight_terms
         helper_method :context_sidebar_containers_request
         helper_method :item_requestable?
         helper_method :paragraph_separator
         helper_method :link_to_name_facet
+        helper_method :render_html_tags
       end
     end
 
@@ -28,16 +32,15 @@ module Arclight
 
     def item_requestable?(_, options)
       document = options[:document]
-      request_config_present('', document) && document.containers.present?
+      request_config_present('', document)
     end
 
     def request_config_present(var, document)
       repository_config_present(var, document) &&
-        document.repository_config.google_request_url.present? &&
-        document.repository_config.google_request_mappings.present?
+        document.repository_config.request_config_present?
     end
 
-    def context_sidebar_repository(args)
+    def context_access_tab_repository(args)
       document = args[:document]
       ApplicationController.renderer.render(
         'arclight/repositories/_in_person_repository',
@@ -46,15 +49,28 @@ module Arclight
       )
     end
 
+    def access_repository_contact(args)
+      document = args[:document]
+      ApplicationController.renderer.render(
+        'arclight/repositories/_repository_contact',
+        layout: false,
+        locals: { repository: document.repository_config }
+      )
+    end
+
     def before_you_visit_note_present(_, document)
       document.repository_config && document.repository_config.visit_note.present?
     end
 
-    def context_sidebar_visit_note(args)
+    def context_access_tab_visit_note(args)
       document = args[:document]
       document.repository_config.visit_note
     end
 
+    def highlight_terms(args)
+      safe_join(args[:value].map { |value| content_tag(:span, value, class: 'bg-info') })
+    end
+
     def context_sidebar_containers_request(args)
       document = args[:document]
       presenter = Arclight::ShowPresenter.new(document, view_context)

data/app/factories/blacklight_field_configuration_factory.rb

@@ -16,6 +16,7 @@ class BlacklightFieldConfigurationFactory
 
   def field_config
     return null_field unless config.respond_to?(:"#{field_group}s")
+
     config.send(:"#{field_group}s").fetch(field) { null_field }
   end
 

data/app/helpers/arclight_helper.rb

@@ -3,12 +3,87 @@
 ##
 # Generic Helpers used in Arclight
 module ArclightHelper
+  def aria_hidden_breadcrumb_separator
+    safe_join(
+      [
+        '<span aria-hidden="true">'.html_safe,
+        t('arclight.breadcrumb_separator'),
+        '</span>'.html_safe
+      ]
+    )
+  end
+
   ##
   # @param [SolrDocument]
   def parents_to_links(document)
-    safe_join(Arclight::Parents.from_solr_document(document).as_parents.map do |parent|
+    breadcrumb_links = []
+
+    breadcrumb_links << build_repository_link(document)
+
+    breadcrumb_links << document_parents(document).map do |parent|
+      link_to parent.label, solr_document_path(parent.global_id)
+    end
+
+    safe_join(breadcrumb_links, aria_hidden_breadcrumb_separator)
+  end
+
+  ##
+  # For a non-grouped compact view, display the breadcrumbs with the following
+  # algorithm:
+  #  - Display only the first two parts of the item breadcrumb: the repository
+  #    and the collection.
+  #  - After the collection and the breadcrumb divider icon, show an ellipses as
+  #    shown in the mockup above. The repository and the collection parts are
+  #    linked as usual; the ellipses is not linked.
+  def regular_compact_breadcrumbs(document)
+    breadcrumb_links = [build_repository_link(document)]
+
+    parents = document_parents(document)
+    breadcrumb_links << parents[0, 1].map do |parent|
+      link_to parent.label, solr_document_path(parent.global_id)
+    end
+
+    breadcrumb_links << '&hellip;'.html_safe if parents.length > 1
+
+    safe_join(
+      breadcrumb_links,
+      aria_hidden_breadcrumb_separator
+    )
+  end
+
+  ##
+  # @param [SolrDocument]
+  def component_parents_to_links(document)
+    parents = document_parents(document)
+    return unless parents.length > 1
+
+    safe_join(parents.slice(1, 999).map do |parent|
       link_to parent.label, solr_document_path(parent.global_id)
-    end, t('arclight.breadcrumb_separator'))
+    end, aria_hidden_breadcrumb_separator)
+  end
+
+  ##
+  # @param [SolrDocument]
+  def component_top_level_parent_to_links(document)
+    parents = document_parents(document)
+    return unless parents.length > 1
+
+    parent_link = link_to(parents[1].label, solr_document_path(parents[1].global_id))
+    return parent_link if parents.length == 2
+
+    safe_join(
+      [
+        parent_link,
+        aria_hidden_breadcrumb_separator,
+        '&hellip;'.html_safe
+      ]
+    )
+  end
+
+  ##
+  # @param [SolrDocument]
+  def document_parents(document)
+    Arclight::Parents.from_solr_document(document).as_parents
   end
 
   def repository_collections_path(repository)
@@ -20,6 +95,17 @@ module ArclightHelper
     )
   end
 
+  # Returns the i18n-ed string to be used as the h1 in search results
+  def search_results_header_text
+    if (repo = repository_faceted_on).present?
+      t('arclight.search.repository_header', repository: repo.name)
+    elsif collection_active?
+      t('arclight.search.collections_header')
+    else
+      t('blacklight.search.header')
+    end
+  end
+
   ##
   # Classes used for customized show page in arclight
   def custom_show_content_classes
@@ -42,15 +128,20 @@ module ArclightHelper
     @response.response['numFound']
   end
 
-  ##
-  # Looks for `document.unitid` in the downloads configuration
-  # @param [SolrDocument] `document`
-  # @param [Hash] `config` metadata for downloadable files
-  # @return [Hash] with `:href` and `:size` keys
-  def collection_downloads(document, config = load_download_config)
-    config = config[document.unitid] if config.present?
-    return {} if config.blank?
-    parse_collection_downloads(config)
+  def grouped?
+    try(:search_state) && search_state.params_for_search.try(:[], 'group') == 'true'
+  end
+
+  def search_with_group
+    search_state.params_for_search.merge('group' => 'true').except('page')
+  end
+
+  def search_without_group
+    search_state.params_for_search.except('group', 'page')
+  end
+
+  def search_within_collection(collection_name, search)
+    search.merge(f: { collection_sim: [collection_name] })
   end
 
   def on_repositories_show?
@@ -76,41 +167,49 @@ module ArclightHelper
   #
   # @return [Repository]
   def repository_faceted_on
-    return unless try(:search_state)
-    repos = facets_from_request.find { |f| f.name == 'repository_sim' }.try(:items)
-    faceted = repos && repos.length == 1 && repos.first.value
-    Arclight::Repository.find_by(name: repos.first.value) if faceted
+    return unless try(:search_state) && facet_field_in_params?('repository_sim')
+
+    repos = Array(facet_params('repository_sim'))
+    faceted = repos && repos.length == 1 && repos.first
+    Arclight::Repository.find_by(name: repos.first) if faceted
   end
 
   def hierarchy_component_context?
     params[:hierarchy_context] == 'component'
   end
 
-  # @return [Hash] loaded from config/downloads.yml, or `{}` if missing file
-  def load_download_config(filename = Rails.root.join('config', 'downloads.yml'))
-    YAML.safe_load(File.read(filename))
-  rescue Errno::ENOENT
-    {}
+  def online_contents_context?
+    params[:view] == 'online_contents'
   end
 
-  # @return [Hash] the downloads for the given configuration using Hash symbols
-  # @example `{ pdf: { href: 'http://...', size: '123 KB' } }`
-  def parse_collection_downloads(config, results = {})
-    %w[pdf ead].each do |type|
-      next if config[type].blank?
-      results[type.to_sym] = {
-        href: config[type]['href'],
-        size: display_size(config[type]['size'])
-      }
+  # determine which icon to show in search results header
+  # these icon names will need to be updated when the icons are determined
+  def document_or_parent_icon(document)
+    case document.level&.downcase
+    when 'collection'
+      'collection'
+    when 'file'
+      'file'
+    when 'series', 'subseries'
+      'folder'
+    else
+      'container'
     end
-    results
   end
 
-  # Show a human readable size, or if it's already a string, show that
-  # @return [String] human readable siz
-  def display_size(size)
-    size = number_to_human_size(size.to_i + 1) if size.is_a?(Numeric) || size =~ /^[0-9]+$/ # assumes bytes
-    size.to_s
+  def render_grouped_documents(documents)
+    safe_join(
+      documents.each_with_index.map do |document, i|
+        render_document_partial(document, :arclight_index_group_document, document_counter: i)
+      end
+    )
+  end
+
+  def ead_files(document)
+    files = Arclight::DocumentDownloads.new(document, document.collection_unitid).files
+    files.find do |file|
+      file.type == 'ead'
+    end
   end
 
   ##
@@ -170,4 +269,67 @@ module ArclightHelper
   def generic_render_document_field_label(config_field, document, field: field_name)
     send(:"render_document_#{config_field}_label", document, field: field)
   end
+
+  def show_expanded?(document)
+    !original_document?(document) && within_original_tree?(document)
+  end
+
+  def within_original_tree?(document)
+    Array.wrap(params['original_parents']).map do |parent|
+      Arclight::Parent.new(id: parent, eadid: document.parent_ids.first, level: nil, label: nil).global_id
+    end.include?(document.id)
+  end
+
+  def original_document?(document)
+    document.id == params['original_document']
+  end
+
+  def generic_context_navigation(document, original_parents: document.parent_ids, component_level: 1)
+    content_tag(
+      :div,
+      '',
+      class: 'context-navigator',
+      data: {
+        collapse: I18n.t('arclight.views.show.collapse'),
+        expand: I18n.t('arclight.views.show.expand'),
+        arclight: {
+          level: component_level,
+          path: search_catalog_path(hierarchy_context: 'component'),
+          name: document.collection_name,
+          originalDocument: document.id,
+          originalParents: original_parents,
+          eadid: document.eadid
+        }
+      }
+    )
+  end
+
+  ##
+  # Determine if the user is currently under a collection context
+  # This is any record view (because it is either the collection or a component w/i a collection)
+  # or in a result view where a collection facet has been selected
+  def within_collection_context?
+    return true if record_view?
+
+    results_view? && params.dig(:f, 'collection_sim')
+  end
+
+  def results_view?
+    controller_name == 'catalog' && action_name == 'index'
+  end
+
+  def record_view?
+    controller_name == 'catalog' && action_name == 'show'
+  end
+
+  private
+
+  def build_repository_link(document)
+    repository_path = document.repository_config&.slug
+    if repository_path.present?
+      link_to(document.repository, arclight_engine.repository_path(repository_path))
+    else
+      content_tag(:span, document.repository)
+    end
+  end
 end