arclight 0.4.0 → 1.0.0.beta1

data/app/assets/javascripts/arclight/context_navigation.js

@@ -1,351 +0,0 @@
-class NavigationDocument {
-  constructor(el) {
-    this.el = $(el);
-  }
-
-  get id() {
-    return this.el.find('[data-document-id]').data().documentId;
-  }
-
-  setAsHighlighted() {
-    this.el.find('li.al-collection-context').addClass('al-hierarchy-highlight');
-  }
-
-  makeCollapsible() {
-    this.el.find('li.al-collection-context').addClass('collapsible');
-  }
-
-  collapse() {
-    this.el.find('li.al-collection-context').addClass('collapsed');
-  }
-
-  render() {
-    return this.el.html();
-  }
-}
-
-/**
- * Models the "Expand"/"Collapse" button, and provides an onClick event handler
- * for the jQuery element
- * @class
- */
-class ExpandButton {
-  /**
-   * This retrieves the <li> elements which are hidden/rendered in response to
-   *   clicking the <button> element
-   * @param {jQuery} $li - the <button> element
-   * @return {jQuery} - a jQuery object containing the targeted <li>
-   */
-  findCollapsibleSiblings() {
-    const $siblings = this.$el.parent().children('li.collapsible');
-    return $siblings;
-  }
-
-  /**
-   * This adds a "collapsed" class to all of the <li> children, as well as
-   *   updates the text for the <button> element
-   * @param {Event} event - the event propagated in response to clicking on the
-   *   <button> element
-   */
-  handleClick() {
-    const $targeted = this.findCollapsibleSiblings();
-
-    $targeted.toggleClass('collapsed');
-    this.$el.toggleClass('collapsed');
-
-    const containerText = this.$el.hasClass('collapsed') ? this.collapseText : this.expandText;
-    this.$el.text(containerText);
-  }
-
-  /**
-   * @constructor
-   */
-  constructor(data) {
-    this.collapseText = data.collapse;
-    this.expandText = data.expand;
-
-    this.$el = $(`<button class="my-3 btn btn-secondary btn-sm">${this.expandText}</button>`);
-    this.handleClick = this.handleClick.bind(this);
-    this.$el.click(this.handleClick);
-  }
-}
-
-/**
- * Models the placeholder display elements for content loading from AJAX
- *   requests
- * @class
- */
-class Placeholder {
-  /*
-   * Builds the element set which contains the placeholder markup
-   *   classes
-   */
-  /* eslint-disable class-methods-use-this */
-  buildElement() {
-    const elementMarkup = '<div class="al-hierarchy-placeholder">' +
-      '<h3 class="col-md-9"></h3>' +
-      '<p class="col-md-6"></p>' +
-      '<p class="col-md-12"></p>' +
-      '<p class="col-md-3"></p>' +
-      '</div>';
-    const markup = Array(3).join(elementMarkup);
-
-    return $(markup);
-  }
-  /* eslint-enable class-methods-use-this */
-
-  /*
-   * @constructor
-   */
-  constructor() {
-    this.$el = this.buildElement();
-  }
-}
-
-class ContextNavigation {
-  constructor(el, originalParents = null, originalDocument = null) {
-    this.el = $(el);
-    this.data = this.el.data();
-    this.parentLi = this.el.parent();
-    this.eadid = this.data.arclight.eadid;
-    this.originalParents = originalParents; // let originalParents stay null
-    this.originalDocument = originalDocument || this.data.arclight.originalDocument;
-    this.ul = $('<ul class="al-context-nav-parent"></ul>');
-  }
-
-  // Gets the targetId to select, based off of parents and current level
-  get targetId() {
-    if (this.originalParents && this.originalParents[this.data.arclight.level]) {
-      return `${this.eadid}${this.originalParents[this.data.arclight.level]}`;
-    }
-    return this.data.arclight.originalDocument;
-  }
-
-  get requestParent() {
-    // Cases where you're viewing a component page (use its ancestor trail)...
-    if (this.originalParents && this.originalParents[this.data.arclight.level - 1]) {
-      return this.originalParents[this.data.arclight.level - 1];
-    }
-    // Cases where there are no parents provided...
-    //   1) when on a top-level collection page
-    //   2) when +/- gets clicked
-    return this.data.arclight.originalDocument.replace(this.eadid, '');
-  }
-
-  getData() {
-    const that = this;
-    // Add a placeholder so flashes of text are not as significant
-    const placeholder = new Placeholder();
-    this.el.after(placeholder.$el);
-    $.ajax({
-      url: this.data.arclight.path,
-      data: {
-        'f[component_level_isim][]': this.data.arclight.level,
-        'f[has_online_content_ssim][]': this.data.arclight.access,
-        'f[collection_sim][]': this.data.arclight.name,
-        'f[parent_ssi][]': this.requestParent,
-        search_field: this.data.arclight.search_field,
-        original_parents: this.data.arclight.originalParents,
-        original_document: this.originalDocument,
-        view: 'collection_context'
-      }
-    }).done((response) => that.updateView(response));
-  }
-
-  /**
-   * Constructs a <ul> container element with an ElementButton instance appended
-   * within it
-   * @returns {jQuery}
-   */
-  buildExpandList() {
-    const $ul = $('<ul></ul>');
-    $ul.addClass('pl-0');
-    $ul.addClass('prev-siblings');
-    const button = new ExpandButton(this.data);
-    $ul.append(button.$el);
-    return $ul;
-  }
-
-  /**
-   * Highlights the <li> element for the current Document and appends <li> the
-   *   sibling documents for a given Document element
-   * @param {NavigationDocument[]} newDocs - the NavigationDocument objects for
-   *   each resulting Solr Document
-   * @param {number} originalDocumentIndex
-   */
-  updateSiblings(newDocs, originalDocumentIndex) {
-    newDocs[originalDocumentIndex].setAsHighlighted();
-
-    // Hide all but the first previous sibling
-    const prevSiblingDocs = newDocs.slice(0, originalDocumentIndex);
-    let nextSiblingDocs = [];
-
-    if (prevSiblingDocs.length > 1 && originalDocumentIndex > 0) {
-      const hiddenPrevSiblingDocs = prevSiblingDocs.slice(0, -1);
-      hiddenPrevSiblingDocs.forEach(siblingDoc => {
-        siblingDoc.makeCollapsible();
-        siblingDoc.collapse();
-      });
-
-      const prevSiblingList = this.buildExpandList();
-      const renderedPrevSiblingItems = prevSiblingDocs.map(doc => doc.render()).join('');
-
-      prevSiblingList.append(renderedPrevSiblingItems);
-      this.ul.append(prevSiblingList);
-
-      nextSiblingDocs = newDocs.slice(originalDocumentIndex);
-    } else {
-      nextSiblingDocs = newDocs;
-    }
-
-    const renderedNextSiblingItems = nextSiblingDocs.map(newDoc => newDoc.render()).join('');
-
-    // Insert the rendered sibling documents before the <li> elements
-    this.ul.append(renderedNextSiblingItems);
-    this.el.html(this.ul);
-  }
-
-  /**
-   * Inserts <li> elements for parents (e. g. components or collections) for the
-   *   current Document and appends <li> for each of these
-   * @param {NavigationDocument[]} newDocs - the NavigationDocument objects for
-   *   each resulting Solr Document
-   */
-  updateParents(newDocs) {
-    const that = this;
-    // Case where this is a parent list and needs to be filed correctly
-    //
-    // Otherwise, retrieve the parent...
-    let newDocIndex = newDocs.findIndex(doc => doc.id === this.targetId);
-
-    if (newDocIndex === -1) {
-      const renderedDocs = newDocs.map(newDoc => newDoc.render()).join('');
-      this.ul.append(renderedDocs);
-      this.el.html(this.ul);
-      return;
-    }
-    // Update the docs before the item
-    // Retrieves the documents up to and including the "new document"
-    const beforeDocs = newDocs.slice(0, newDocIndex);
-    let prevParentList = null;
-    let renderedBeforeDocs;
-    if (beforeDocs.length > 1) {
-      beforeDocs.forEach(function (parentDoc) {
-        parentDoc.makeCollapsible();
-        parentDoc.collapse();
-      });
-      renderedBeforeDocs = beforeDocs.map(newDoc => newDoc.render()).join('');
-      prevParentList = this.buildExpandList();
-      prevParentList.append(renderedBeforeDocs);
-    } else {
-      renderedBeforeDocs = beforeDocs.map(newDoc => newDoc.render()).join('');
-    }
-
-    // Silly but works for now
-    this.ul.append(prevParentList || renderedBeforeDocs);
-
-    let itemDoc = newDocs.slice(newDocIndex, newDocIndex + 1);
-    let renderedItemDoc = itemDoc.map(doc => doc.render()).join('');
-
-    // Update the item
-    const $itemDoc = $(renderedItemDoc);
-    this.ul.append($itemDoc);
-
-    // Update the docs after the item
-    const afterDocs = newDocs.slice(newDocIndex + 1, newDocs.length);
-    const renderedAfterDocs = afterDocs.map(newDoc => newDoc.render()).join('');
-
-    // Insert the documents after the current
-    this.ul.append(renderedAfterDocs);
-    this.el.html(this.ul);
-
-    // Initialize additional things
-    $itemDoc.find('.context-navigator').each(function (i, e) {
-      const contextNavigation = new ContextNavigation(
-        e, that.originalParents, that.originalDocument
-      );
-      contextNavigation.getData();
-    });
-  }
-
-  /**
-   * This updates the elements in the View DOM using an AJAX response containing
-   *   the HTML of a server-rendered View template.
-   * It is this which is primarily used to populate the <ul> element with
-   *   children for the navigation context, containing <li> elements for
-   *   collections, components, and containers.
-   * @param {string} response - the AJAX response body
-   */
-  updateView(response) {
-    const that = this;
-    var resp = $.parseHTML(response);
-    var $doc = $(resp);
-    var newDocs = $doc.find('#documents')
-      .find('article')
-      .toArray().map(el => new NavigationDocument(el));
-
-    // See if the original document is located in the returned documents
-    const originalDocumentIndex = newDocs
-      .findIndex(doc => doc.id === that.originalDocument);
-    that.parentLi.find('.al-hierarchy-placeholder').remove();
-
-    // If the original document in the results, update it. If not update with a
-    // more complex procedure
-    if (originalDocumentIndex !== -1) {
-      this.updateSiblings(newDocs, originalDocumentIndex);
-    } else {
-      this.updateParents(
-        newDocs,
-        that.data.arclight.originalParents,
-        that.data.arclight.parent,
-        that.parentLi
-      );
-    }
-    this.el.parent().data('resolved', true);
-    this.addListenersForPlusMinus();
-    this.enablebuttons();
-    Blacklight.doBookmarkToggleBehavior();
-    this.el.trigger('navigation.contains.elements');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  enablebuttons() {
-    var toEnable = $('[data-hierarchy-enable-me]');
-    var srOnly = $('h2[data-sr-enable-me]');
-    toEnable.removeClass('disabled');
-    toEnable.text(srOnly.data('hasContents'));
-    srOnly.text(srOnly.data('hasContents'));
-  }
-
-  addListenersForPlusMinus() {
-    const that = this;
-    this.ul.find('.al-toggle-view-children').on('click', (e) => {
-      e.preventDefault();
-      const targetArea = $($(e.currentTarget).attr('href'));
-      if (!targetArea.data('resolved') === true) {
-        targetArea.find('.context-navigator').each((i, ee) => {
-          const contextNavigation = new ContextNavigation(
-            // Send null for originalParents. We want to disregard the original
-            // component's ancestor trail and instead use the current ID as the
-            // parent in the query to populate the navigator.
-            ee, null, that.originalDocument
-          );
-          contextNavigation.getData();
-        });
-      }
-    });
-  }
-}
-
-/**
- * Integrate the behavior into the DOM using the Blacklight#onLoad callback
- *
- */
-Blacklight.onLoad(function () {
-  $('.context-navigator').each(function (i, e) {
-    const contextNavigation = new ContextNavigation(
-        e, $(this).data('arclight').originalParents, $(this).data('arclight').originalDocument
-      );
-    contextNavigation.getData();
-  });
-});

data/app/assets/javascripts/arclight/truncator.js.erb

@@ -1,29 +0,0 @@
-Blacklight.onLoad(function () {
-  'use strict';
-
-  // Any element on page load
-  $('[data-arclight-truncate="true"]').each(function (i, e) {
-    $(e).responsiveTruncate({
-      more: "<%= I18n.t 'arclight.truncation.view_more' %>",
-      less: "<%= I18n.t 'arclight.truncation.view_less' %>"
-    });
-  });
-
-  // When elements get loaded from hierarchy
-  $('.al-contents, .context-navigator').on('navigation.contains.elements', function (e) {
-    $('a[data-toggle="tab"]').on('shown.bs.tab', function () {
-      $('[data-arclight-truncate="true"]').each(function (_, el) {
-        $(el).responsiveTruncate({
-          more: "<%= I18n.t 'arclight.truncation.view_more' %>",
-          less: "<%= I18n.t 'arclight.truncation.view_less' %>"
-        });
-      });
-    });
-    $(e.target).find('[data-arclight-truncate="true"]').each(function (_, el) {
-      $(el).responsiveTruncate({
-        more: "<%= I18n.t 'arclight.truncation.view_more' %>",
-        less: "<%= I18n.t 'arclight.truncation.view_less' %>"
-      });
-    });
-  });
-});

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

@@ -1,26 +0,0 @@
-.nav.nav-pills {
-  margin-bottom: $spacer;
-}
-
-.nav.nav-tabs {
-  margin-bottom: 0;
-  flex-wrap: nowrap;
-  & .nav-item .nav-link:not(.active) {
-    background: $gray-100;
-    border-color: $nav-tabs-border-color;
-  }
-  & .nav-item .nav-link {
-    height: 100%;
-  }
-  & .nav-item {
-      overflow-wrap: break-word;
-  }
-}
-
-.tab-pane {
-  border-style: solid;
-  border-width: 0 1px 1px 1px;
-  border-color: $nav-tabs-border-color;
-  border-radius: 0px 0px $nav-tabs-border-radius $nav-tabs-border-radius;
-  padding: $spacer*2;
-}

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

@@ -1,75 +0,0 @@
-#contents > .context-navigator,
-#collection-context > .context-navigator {
-  padding-left: $spacer;
-}
-
-ul.al-context-nav-parent {
-  padding-left: 0px;
-}
-
-li.al-collection-context  {
-  flex-grow: 1;
-  margin-right: 0;
-  margin-left: 0;
-  padding-left: 15px;
-  max-width: 100%;
-
-  .al-collection-context-collapsible {
-    width: 100%;
-  }
-
-  .blacklight-icons {
-    padding-top: $spacer * .25;
-  }
-
-  .al-number-of-children-badge {
-    font-size: 12px;
-    vertical-align: middle;
-  }
-
-  .documentHeader {
-    flex-grow: 1;
-    margin-bottom: $spacer;
-    width: 100%;
-  }
-
-  .document-title-heading {
-    font-size: 1.25rem;
-  }
-
-  .col.col-no-left-padding.d-flex.flex-wrap {
-    flex-grow: 1;
-  }
-  .order-2 .row {
-    margin-left: 0;
-  }
-
-  .al-document-abstract-or-scope {
-    max-width: 45em;
-  }
-
-  .blacklight-icons svg {
-    fill: $gray-600;
-  }
-
-  .al-online-content-icon svg {
-    fill: $green;
-  }
-  @media (max-width: 767px) {
-    padding-left: 0;
-    .al-document-abstract-or-scope {
-      max-width: 25em;
-    }
-  }
-}
-
-@media (max-width: 767px) {
-  .blacklight-catalog.blacklight-catalog-show {
-    #context {
-      padding: 10px;
-    }
-  }
-  ul.al-context-nav-parent {
-    padding-left: 40px;
-  }
-}

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

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module Arclight
-  ##
-  # A module to add configuration helpers for certain fields used by Arclight
-  module FieldConfigHelpers
-    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_access_tab_repository
-        helper_method :access_repository_contact
-        helper_method :before_you_visit_note_present
-        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
-
-    def repository_config_present(_, document)
-      document.repository_config.present?
-    end
-
-    def item_requestable?(_, options)
-      document = options[:document]
-      request_config_present('', document)
-    end
-
-    def request_config_present(var, document)
-      repository_config_present(var, document) &&
-        document.repository_config.request_config_present?
-    end
-
-    def context_access_tab_repository(args)
-      document = args[:document]
-      ApplicationController.renderer.render(
-        'arclight/repositories/_in_person_repository',
-        layout: false,
-        locals: { repository: document.repository_config }
-      )
-    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_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)
-      ApplicationController.renderer.render(
-        'arclight/requests/_google_form',
-        layout: false,
-        locals: {
-          google_form: Arclight::Requests::GoogleForm.new(document, presenter, solr_document_url(document))
-        }
-      )
-    end
-
-    def paragraph_separator(args)
-      safe_join(args[:value].map { |paragraph| content_tag(:p, paragraph) })
-    end
-
-    def link_to_name_facet(args)
-      options = args[:config].try(:separator_options) || {}
-      values = args[:value] || []
-
-      values.map do |value|
-        view_context.link_to(
-          value,
-          view_context.search_action_path(f: { names_ssim: [value] })
-        )
-      end.to_sentence(options).html_safe
-    end
-  end
-end

data/app/factories/blacklight_field_configuration_factory.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-##
-# A factory to return blacklight field configurations given a field key
-# that represents a field group (e.g. summary_fields, access_fields, etc)
-class BlacklightFieldConfigurationFactory
-  def self.for(config:, field:, field_group:)
-    new(config: config, field: field, field_group: field_group).field_config
-  end
-
-  def initialize(config:, field:, field_group:)
-    @config = config
-    @field = field
-    @field_group = field_group
-  end
-
-  def field_config
-    return null_field unless config.respond_to?(:"#{field_group}s")
-
-    config.send(:"#{field_group}s").fetch(field) { null_field }
-  end
-
-  private
-
-  attr_reader :config, :field, :field_group
-
-  def null_field
-    Blacklight::Configuration::NullField.new(field)
-  end
-end

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

@@ -1,19 +0,0 @@
-<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, arclight_engine.repository_path(repository.slug)) %>
-  </div>
-</div>
-<div class='al-in-person-repository-location'>
-  <address>
-    <% %i[building address1 address2 city_state_zip_country].each do |f| %>
-      <% if repository.send(f).present? %>
-        <div class='al-repository-contact-<%= f %>'>
-          <%= repository.send(f) %>
-        </div>
-      <% end %>
-    <% end %>
-  </address>
-</div>

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

@@ -1,9 +0,0 @@
-<div class='al-in-person-repository-contact'>
-  <% %i[phone contact_info].each do |f| %>
-    <% if repository.send(f).present? %>
-      <div class='al-repository-contact-<%= f %>'>
-        <%= repository.send(f) %>
-      </div>
-    <% end %>
-  <% end %>
-</div>

data/app/views/arclight/viewers/_oembed.html.erb

@@ -1,8 +0,0 @@
-<% parents = Arclight::Parents.from_solr_document(viewer.document).as_parents %>
-<% viewer.resources.each do |resource| %>
-  <%= content_tag(:div, viewer.attributes_for(resource)) do %>
-    <div class="al-digital-object media breadcrumb-item breadcrumb-item-<%= parents.length + 6 %>"> 
-      <%= link_to(resource.label, resource.href) %>
-    </div>
-  <% end %>
-<% end %>

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

@@ -1,15 +0,0 @@
-<% doc_presenter = show_presenter(document).with_field_group(field_accessor) %>
-<div class="container">
-  <dl class="row dl-invert">
-    <% generic_document_fields(field_accessor).each do |field_name, field| %>
-      <% if generic_should_render_field?(field_accessor, document, field) %>
-        <dt class="blacklight-<%= field_name.parameterize %> col-md-2">
-          <%= generic_render_document_field_label(field_accessor, document, field: field_name).upcase %>
-        </dt>
-        <dd class="blacklight-<%= field_name.parameterize %> col-md-10">
-          <%= doc_presenter.field_value field %>
-        </dd>
-      <% end %>
-    <% end %>
-  </dl>
-</div>

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

@@ -1,5 +0,0 @@
-<%= content_tag('div', class: 'al-document-abstract-or-scope') do %>
-  <%= content_tag('div', data: { 'arclight-truncate': true, 'truncate-more': I18n.t('arclight.truncation.view_more'), 'truncate-less': I18n.t('arclight.truncation.view_less') } ) do %>
-    <%= content_tag(:span, I18n.t('arclight.hierarchy.scope_note')) %><%= document.abstract_or_scope %>
-  <% end %>
-<% end if document.abstract_or_scope %>