arclight 0.2.0 → 0.3.0

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

@@ -1,18 +0,0 @@
-Blacklight.onLoad(function () {
-  'use strict';
-
-  $('[data-arclight-collection-context="true"]').each(function (i, element) {
-    var $el = $(element);
-    var data = $el.data();
-    $.ajax({
-      url: data.arclightCollectionContextUrl
-    }).done(function (response) {
-      var resp = $.parseHTML(response);
-      var $doc = $(resp);
-      var link = $('<a></a>').attr('href', data.arclightCollectionContextUrl);
-      var addedSection = $doc.find('.al-show-header-section');
-      addedSection.find('h1').wrapInner(link);
-      $el.hide().html(addedSection).fadeIn(500);
-    });
-  });
-});

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

@@ -1,56 +0,0 @@
-(function (global) {
-  var ComponentAncestors = {
-    init: function (el) {
-      var $el = $(el);
-      var data = $el.data();
-      var ancestors = $('<div>');
-      var collectionId = data.arclightAncestors.shift();
-      var allDone = $.Deferred();
-
-      data.arclightAncestors.forEach(function (id, i) {
-        var requestId = collectionId + id;
-        var currentDiv = $('<div class="documents-hierarchy extra-indent al-hierarchy-level-' + (i) + '">');
-        ancestors.append(currentDiv);
-
-        $.ajax({
-          url: data.arclightPath,
-          data: {
-            q: 'id:' + requestId,
-            search_field: 'all_fields',
-            view: 'hierarchy'
-          }
-        }).done(function (response) {
-          var resp = $.parseHTML(response);
-          var $doc = $(resp);
-          var thisAncestor = $doc.find('article.document-position-0');
-
-          // Remove collapsible stuff
-          thisAncestor.find('.al-toggle-view-more').remove();
-          thisAncestor.find('.collapse').remove();
-          thisAncestor.find('hr').remove();
-
-          currentDiv.append(thisAncestor);
-          if (i + 1 === data.arclightAncestors.length) {
-            allDone.resolve();
-          }
-        });
-      });
-
-      // Wait for all requests to finish
-      allDone.done(function () {
-        $el.html(ancestors);
-      });
-    }
-  };
-
-  global.ComponentAncestors = ComponentAncestors;
-}(this));
-
-
-Blacklight.onLoad(function () {
-  'use strict';
-
-  $('[data-arclight-ancestors]').each(function (i, e) {
-    ComponentAncestors.init(e); // eslint-disable-line no-undef
-  });
-});

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

@@ -1,15 +0,0 @@
-Blacklight.onLoad(function () {
-  'use strict';
-
-  var histogramContent = $('#al-date-range-histogram-content');
-  var showSpan = $('#al-date-range-histogram-show');
-  var hideSpan = $('#al-date-range-histogram-hide');
-  histogramContent.on('show.bs.collapse', function () {
-    showSpan.attr('hidden', 'hidden');
-    hideSpan.removeAttr('hidden');
-  });
-  histogramContent.on('hide.bs.collapse', function () {
-    hideSpan.attr('hidden', 'hidden');
-    showSpan.removeAttr('hidden');
-  });
-});

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

@@ -1,21 +0,0 @@
-.al-in-person-repository-location {
-  clear: left;
-}
-
-.al-digital-object {
-  margin-bottom: $spacer;
-
-  .al-digital-object-label {
-    margin-bottom: ($spacer / 2);
-  }
-}
-
-// Hiding this from display since we don't need it.
-dt.blacklight-digital_objects_ssm {
-  display: none;
-}
-
-.al-sticky-sidebar .al-request-button {
-  border: 0;
-  padding-left: 0;
-}

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

@@ -1,7 +0,0 @@
-<% if collection_active? %>
-  <div class='al-collection-count'>
-    <p class='lead'>
-      <%= pluralize(number_with_delimiter(collection_count), t('arclight.views.index.collection_search.count')) %>
-    </p>
-  </div>
-<% end %>

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

@@ -1,15 +0,0 @@
-<% if downloads.present? && (downloads[:pdf].present? || downloads[:ead].present?) %>
-<div class='dropdown al-collection-actions-menu'>
-  <button class='btn btn-secondary btn-sm dropdown-toggle' type="button" id="download-dropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-    <%= t 'arclight.views.show.download.default' %>
-  </button>
-  <div class="dropdown-menu dropdown-menu-right" aria-labelledby="download-dropdown">
-    <% if downloads[:pdf].present? %>
-      <a class="dropdown-item" href="<%= downloads[:pdf][:href] %>"><%= t('arclight.views.show.download.pdf', size: downloads[:pdf][:size]) %></a>
-    <% end %>
-    <% if downloads[:ead].present? %>
-      <a class="dropdown-item" href="<%= downloads[:ead][:href] %>"><%= t('arclight.views.show.download.ead', size: downloads[:ead][:size]) %></a>
-    <% end  %>
-  </div>
-</div>
-<% end %>

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

@@ -1,7 +0,0 @@
-<h2 class="sr-only">Collection description</h2>
-<% unless blacklight_config.show.metadata_partials.nil? %>
-  <% blacklight_config.show.metadata_partials.each do |metadata| %>
-    <% next unless fields_have_content?(@document, metadata) %>
-    <%= render partial: 'custom_metadata', locals: { document: @document, field_accessor: metadata } %>
-  <% end %>
-<% end %>

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

@@ -1,16 +0,0 @@
-<% document ||= @document %>
-<% @sub_level ||= document.component_level + 1 %>
-
-
-<h2 class="sr-only">Component inventory</h2>
-<div class="component-level-only">
-  <%= content_tag(
-    :div, '',
-    class: 'al-contents',
-    data: {
-      arclight: {
-        hierarchy: true, level: @sub_level, path: search_catalog_path, name: document.collection_name, parent: document.reference
-      }
-    }
-  ) %>
-</div>

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

@@ -1,40 +0,0 @@
-<h2 class="sr-only">Component description</h2>
-<!-- Section below will be moved into its own partial later -->
-<%= content_tag(:div, id: t("arclight.views.show.sections.collection_context_field").parameterize) do %>
-  <h3 class='al-show-sub-heading'>
-    <%= t("arclight.views.show.sections.collection_context_field") %>
-  </h3>
-  <%= content_tag(
-    :div, '',
-    class: 'al-context',
-    data: {
-      arclight_collection_context: true,
-      arclight_collection_context_url: solr_document_path(
-        normalize_id(@document.eadid)
-      )
-    }
-  ) %>
-  <%= content_tag(
-    :div, '',
-    class: 'al-ancestors',
-    data: {
-      arclight_ancestors: @document.parent_ids,
-      arclight_path: search_catalog_path(hierarchy_context: 'component')
-    }
-  ) %>
-  <%= content_tag(
-    :div, '',
-    class: "al-contents al-hierarchy-level-#{@document.component_level} extra-indent documents-hierarchy",
-    data: {
-      arclight: {
-        hierarchy: true,
-        level: @document.component_level,
-        path: search_catalog_path(hierarchy_context: 'component'),
-        name: @document.collection_name,
-        parent: @document.parent_ids.last,
-        highlightId: @document.id
-      }
-    }
-  ) %>
-
-<% end %>

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

@@ -1,42 +0,0 @@
-<div class="documentHeader row" data-document-id="<%= document.id %>">
-  <% requestable = item_requestable?('', { document: document }) %>
-  <h3 class="index_title document-title-heading col-md-8">
-    <% if document.containers.present? %>
-      <span class="document-title-containers">
-        <%= document.containers.join(', ') %>:
-      </span>
-    <% end %>
-    <% counter = document_counter_with_offset(document_counter) %>
-    <%= link_to_document document, document_show_link_field(document), counter: counter %>
-    <%= render_document_partial(document, 'arclight_online_content_indicator') %>
-    <% if document.children? %>
-      <div class='al-hierarchy-children-status'>
-        <span class='badge badge-default al-number-of-children-badge'>
-          <%= t(:'arclight.views.index.number_of_children', count: document.number_of_children) %>
-          <% unless hierarchy_component_context? %>
-            <%= link_to(
-              t('arclight.hierarchy.view_all'),
-              "##{document.reference}-collapsible-hierarchy",
-              class: 'al-toggle-view-all',
-                data: {
-                  toggle: 'collapse'
-                }
-              )
-            %>
-          <% end %>
-        </span>
-      </div>
-    <% end %>
-  </h3>
-
-  <div class="al-hierarchy-side-content float-right col">
-    <% unless hierarchy_component_context? %>
-      <div class="index-document-functions">
-        <%= render partial: 'catalog/bookmark_control', locals: { document: document } %>
-      </div>
-    <% end %>
-    <% if requestable %>
-      <%= render partial: 'arclight/requests/google_form', locals: { document: document } %>
-    <% end %>
-  </div>
-</div>

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

@@ -1,28 +0,0 @@
-<%= content_tag('div', class: 'al-document-abstract-or-scope') do %>
-  <%= content_tag(:h4, I18n.t('arclight.hierarchy.scope_and_contents'), class: 'al-hierarchy-sub-heading') %>
-  <%= content_tag('div', 'data-arclight-truncate' => true) do %>
-    <%= document.abstract_or_scope %>
-  <% end %>
-<% end if document.abstract_or_scope %>
-
-<% if document.number_of_children > 0 %>
-  <%= content_tag(:div, id: "#{document.reference}-collapsible-hierarchy",
-    class: "collapse al-hierarchy-level-#{document.component_level}",
-  ) do %>
-
-    <%= content_tag(
-      :div, '',
-      class: 'al-contents',
-      data: {
-        arclight: {
-          hierarchy: true,
-          level: document.component_level + 1,
-          path: search_catalog_path,
-          name: document.collection_name,
-          parent: document.reference
-        }
-      }
-    ) %>
-
-  <% end %>
-<% end %>

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

@@ -1,15 +0,0 @@
-<div class='al-data-range-histogram row'>
-  <div class='col-md-12'>
-    <div id='al-date-range-histogram-content' class='collapse facet-content'>
-      <%= render partial: 'arclight_rangelimit', locals: { field_name: :date_range_sim, solr_field: :date_range_sim } %>
-    </div>
-    <a class='float-right' data-toggle='collapse' href='#al-date-range-histogram-content' aria-expanded='false' aria-controls='al-date-range-histogram-content'>
-      <span id="al-date-range-histogram-show">
-        <%= t('arclight.date_range_histogram.show') %>
-      </span>
-      <span id="al-date-range-histogram-hide" hidden="hidden">
-        <%= t('arclight.date_range_histogram.hide') %>
-      </span>
-    </a>
-  </div>
-</div>

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

@@ -1,12 +0,0 @@
-<div class='al-sticky-sidebar'>
-  <h2 class="sr-only">Sidebar</h2>
-
-  <% unless blacklight_config.show.component_sidebar_items.nil? %>
-    <div id="accordion" role="tablist" aria-multiselectable="true">
-      <% items = blacklight_config.show.component_sidebar_items.select { |i|  fields_have_content?(@document, i) }  %>
-      <% items.each_with_index do |item, index| %>
-        <%= render partial: 'context_card', locals: { document: @document, field_accessor: item, card_index: index} %>
-      <% end %>
-    </div>
-  <% end %>
-</div>

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

@@ -1,22 +0,0 @@
-<div class='al-sticky-sidebar'>
-  <h2 class="sr-only">Sidebar</h2>
-  <div class='al-sidebar-navigation-overview card'>
-    <div class='card-header'>
-      <h3 class="mb-0"><%= t('arclight.views.show.navigation_sidebar.title') %></h3>
-    </div>
-    <div class='card-body'>
-      <ul class='nav nav-pills flex-column'>
-        <% unless blacklight_config.show.metadata_partials.nil? %>
-          <% blacklight_config.show.metadata_partials.each do |item| %>
-            <% next unless fields_have_content?(@document, item) %>
-            <li class='nav-item'>
-              <%= link_to t("arclight.views.show.sections.#{item}"), "##{t("arclight.views.show.sections.#{item}").parameterize}", class: 'nav-link' %>
-            </li>
-          <% end %>
-        <% end %>
-      </ul>
-    </div>
-  </div>
-
-  <%= render 'shared/context_sidebar' %>
-</div>

data/lib/arclight/custom_component.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-module Arclight
-  ##
-  # An Arclight custom component indexing code
-  class CustomComponent < SolrEad::Component
-    extend Arclight::SharedTerminologyBehavior
-    include Arclight::SharedIndexingBehavior
-    use_terminology SolrEad::Component
-
-    # we extend the terminology to provide additional fields and/or indexing strategies
-    # than `solr_ead` provides as-is. in many cases we're doing redundant indexing, but
-    # we're trying to modify the `solr_ead` gem as little as possible
-    extend_terminology do |t|
-      # identifiers
-      t.level(path: 'c/@level', index_as: %i[displayable]) # machine-readable for string `level_ssm`
-      t.otherlevel(path: 'c/@otherlevel', index_as: %i[displayable])
-      t.ref_(path: '/c/@id', index_as: %i[displayable])
-
-      # facets
-      t.creator(path: "c/did/origination[@label='creator']/*/text()", index_as: %i[displayable facetable symbol])
-      t.places(path: 'c/controlaccess/geogname/text()', index_as: %i[displayable facetable symbol])
-
-      add_unitid(t, 'c/')
-      add_extent(t, 'c/')
-      add_dates(t, 'c/')
-      add_searchable_notes(t, 'c/')
-    end
-
-    def to_solr(solr_doc = {})
-      super
-      solr_doc['id'] = Arclight::NormalizedId.new(solr_doc['id']).to_s
-      solr_doc['creator_sort'] = creator.to_a.join(', ') if creator.present?
-      add_component_fields(solr_doc)
-      solr_doc
-    end
-
-    private
-
-    def add_component_fields(solr_doc)
-      component_field_definitions.each do |field|
-        # we want to use `set_field` rather than `insert_field` since we may be overriding fields
-        Solrizer.set_field(solr_doc, field[:name], field[:value], field[:index_as])
-      end
-      add_date_ranges(solr_doc)
-      add_normalized_title(solr_doc)
-      resolve_repository(solr_doc)
-      add_digital_content(prefix: 'c', solr_doc: solr_doc)
-      add_digital_content(prefix: 'c/did', solr_doc: solr_doc)
-    end
-
-    def component_field_definitions
-      [
-        { name: 'level', value: formatted_level, index_as: :facetable },
-        { name: 'names', value: names, index_as: :symbol },
-        { name: 'access_subjects', value: access_subjects, index_as: :symbol },
-        { name: 'containers', value: containers, index_as: :symbol },
-        { name: 'has_online_content', value: online_content?, index_as: :symbol }
-      ]
-    end
-
-    def resolve_repository(solr_doc)
-      repository = solr_doc[Solrizer.solr_name('repository', :displayable)]
-      %i[displayable facetable].each do |index_as|
-        Solrizer.set_field(solr_doc, 'repository', repository_as_configured(repository), index_as)
-      end
-    end
-
-    # @see http://eadiva.com/2/c/
-    def formatted_level
-      # terminology definitions for level yield Arrays and in this case single values
-      # TODO: OM changes the behavior of `level = level.first` such that it always returns `nil`
-      #       so need our own local variable here
-      actual_level = level.first.to_s if level.respond_to? :first
-
-      if actual_level == 'otherlevel'
-        alternative_level = otherlevel.first.to_s if otherlevel.respond_to? :first
-        alternative_level.present? ? alternative_level : 'Other'
-      elsif actual_level.present?
-        actual_level.capitalize
-      end
-    end
-
-    def names
-      names_array(%w[corpname famname name persname], parent: 'c')
-    end
-
-    def access_subjects
-      subjects_array(%w[subject function occupation genreform], parent: 'c')
-    end
-
-    def containers
-      contains = search('//container').to_a
-      contains.map do |c|
-        "#{c.attributes['type'].try(:value)} #{c.text}".strip
-      end
-    end
-  end
-end

data/lib/arclight/custom_document.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Arclight
-  ##
-  # An Arclight custom document indexing code
-  class CustomDocument < SolrEad::Document
-    extend Arclight::SharedTerminologyBehavior
-    include Arclight::SharedIndexingBehavior
-    use_terminology SolrEad::Document
-
-    # we extend the terminology to provide additional fields and/or indexing strategies
-    # than `solr_ead` provides as-is. in many cases we're doing redundant indexing, but
-    # we're trying to modify the `solr_ead` gem as little as possible
-    extend_terminology do |t|
-      # facets
-      t.repository(path: 'archdesc/did/repository/corpname/text() | archdesc/did/repository/name/text()', index_as: %i[displayable facetable])
-      t.creator(path: "archdesc/did/origination[@label='creator']/*/text()", index_as: %i[displayable facetable symbol])
-      t.creator_persname(path: "archdesc/did/origination[@label='creator']/persname/text()", index_as: %i[displayable facetable symbol])
-      t.creator_corpname(path: "archdesc/did/origination[@label='creator']/corpname/text()", index_as: %i[displayable facetable symbol])
-      t.creator_famname(path: "archdesc/did/origination[@label='creator']/famname/text()", index_as: %i[displayable facetable symbol])
-      t.function(path: 'archdesc/controlaccess/function/text()', index_as: %i[displayable facetable])
-      t.occupation(path: 'archdesc/controlaccess/occupation/text()', index_as: %i[displayable facetable])
-      t.places(path: 'archdesc/controlaccess/geogname/text()', index_as: %i[displayable facetable symbol])
-
-      add_unitid(t, 'archdesc/')
-      add_extent(t, 'archdesc/')
-      add_dates(t, 'archdesc/')
-      add_searchable_notes(t, 'archdesc/')
-    end
-
-    def to_solr(solr_doc = {})
-      super
-      solr_doc['id'] = Arclight::NormalizedId.new(eadid.first).to_s
-      solr_doc['creator_sort'] = creator.to_a.join(', ') if creator.present?
-      add_document_fields(solr_doc)
-      solr_doc
-    end
-
-    private
-
-    def add_document_fields(solr_doc)
-      arclight_field_definitions.each do |field|
-        # we want to use `set_field` rather than `insert_field` since we may be overriding fields
-        Solrizer.set_field(solr_doc, field[:name], field[:value], field[:index_as])
-      end
-
-      add_date_ranges(solr_doc)
-      add_digital_content(prefix: 'ead/archdesc', solr_doc: solr_doc)
-      add_normalized_titles(solr_doc)
-    end
-
-    def add_normalized_titles(solr_doc)
-      title = add_normalized_title(solr_doc)
-      Solrizer.set_field(solr_doc, 'collection', title, :facetable)
-      Solrizer.set_field(solr_doc, 'collection', title, :displayable)
-    end
-
-    def arclight_field_definitions
-      [
-        { name: 'level', value: 'collection', index_as: :displayable },
-        { name: 'level', value: 'Collection', index_as: :facetable },
-        { name: 'names', value: names, index_as: :symbol },
-        { name: 'access_subjects', value: access_subjects, index_as: :symbol },
-        { name: 'creators', value: creators, index_as: :symbol },
-        { name: 'has_online_content', value: online_content?, index_as: :symbol },
-        { name: 'repository', value: repository_as_configured(repository), index_as: :displayable },
-        { name: 'repository', value: repository_as_configured(repository), index_as: :facetable },
-        { name: 'names_coll', value: names_coll, index_as: :symbol }
-      ]
-    end
-
-    def names
-      [corpname, famname, name, persname].flatten.compact.uniq - repository
-    end
-
-    def names_coll
-      names_array(%w[corpname famname name persname], parent: 'archdesc')
-    end
-
-    def creators
-      [creator_persname, creator_corpname, creator_famname].flatten.compact.uniq - repository
-    end
-
-    # Combine subjets into one group from
-    #  <controlaccess/><subject></subject>
-    #  <controlaccess/><function></function>
-    #  <controlaccess/><genreform></genreform>
-    #  <controlaccess/><occupation></occupation>
-    def access_subjects
-      subjects_array(%w[subject function occupation genreform], parent: 'archdesc')
-    end
-  end
-end