arclight 0.0.1 → 0.1.0

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

@@ -0,0 +1,114 @@
+(function (global) {
+  var CollectionNavigation;
+  /**
+   * Converts documents that should be used in a hierarchy, to highlighted
+   * localized siblings.
+   */
+  function convertDocsForContext(id, $doc) {
+    var newDocs;
+    var $currentDoc;
+    var $previousDocs;
+    var $nextDocs;
+    var headers = $doc.find('article header[data-document-id="' + id + '"]')
+    if (headers.length == 0) {
+      $.error('Document is missing id=' + id);
+    }
+    $currentDoc = $(headers[0].parentNode); // need article element
+    $currentDoc.addClass('al-hierarchy-highlight');
+
+    // We want to show 0-1 or 0-2 siblings depending on where highlighted component is
+    $previousDocs = $currentDoc.prevUntil().slice(0, 2);
+    $nextDocs = $currentDoc.nextUntil().slice(0, 2);
+
+    if ($previousDocs.length > 0 && $nextDocs.length > 0) {
+      // Case where there are siblings on both sides, show 1 each
+      newDocs = $('<div>');
+      newDocs.append($previousDocs.first());
+      newDocs.append($currentDoc);
+      newDocs.append($nextDocs.first());
+    } else if ($previousDocs.length > 0) {
+      // Case where there are only previous siblings, show 2 of them
+      newDocs = $('<div>');
+      newDocs.append($previousDocs.get().reverse()); // previous is not in the order we need
+      newDocs.append($currentDoc);
+    } else {
+      // Case where there are only next siblings, show 2 of them
+      newDocs = $('<div>');
+      newDocs.append($currentDoc);
+      newDocs.append($nextDocs);
+    }
+    // Cleanup to remove collapsible children stuff
+    newDocs.find('.al-toggle-view-more').remove();
+    newDocs.find('.collapse').remove();
+    newDocs.find('hr').remove();
+    return newDocs;
+  }
+
+  CollectionNavigation = {
+    init: function (el) {
+      var $el = $(el);
+      var data = $el.data();
+      // Add a placeholder so flashes of text are not as significant
+      var placeholder = '<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>';
+      placeholder = new Array(3).join(placeholder);
+      $el.html(placeholder);
+      $.ajax({
+        url: data.arclight.path,
+        data: {
+          'f[component_level_isim][]': data.arclight.level,
+          'f[has_online_content_ssim][]': data.arclight.access,
+          'f[collection_sim][]': data.arclight.name,
+          'f[parent_ssi][]': data.arclight.parent,
+          search_field: data.arclight.search_field,
+          view: data.arclight.view || 'hierarchy'
+        }
+      }).done(function (response) {
+        var resp = $.parseHTML(response);
+        var $doc = $(resp);
+        var showDocs = $doc.find('article.document');
+        var newDocs = $doc.find('#documents');
+
+        // Add a highlight class for the article matching the highlight id
+        if (data.arclight.highlightId) {
+          newDocs = convertDocsForContext(data.arclight.highlightId, $doc);
+        }
+
+        $el.hide().html(newDocs).fadeIn(500);
+        if (showDocs.length > 0) {
+          $el.trigger('navigation.contains.elements');
+        }
+        Blacklight.do_bookmark_toggle_behavior();
+      });
+    }
+  };
+
+  global.CollectionNavigation = CollectionNavigation;
+}(this));
+
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('.al-contents').each(function (i, element) {
+    CollectionNavigation.init(element); // eslint-disable-line no-undef
+  });
+
+  $('.al-contents').on('navigation.contains.elements', function (e) {
+    var toEnable = $('[data-hierarchy-enable-me]');
+    toEnable.removeClass('disabled');
+    toEnable.text('Contents');
+
+    $(e.target).find('.collapse').on('show.bs.collapse', function (ee) {
+      var $newTarget = $(ee.target);
+      $newTarget.find('.al-contents').each(function (i, element) {
+        CollectionNavigation.init(element); // eslint-disable-line no-undef
+        // Turn off additional ajax requests on show
+        $newTarget.off('show.bs.collapse');
+      });
+    });
+  });
+});

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

@@ -0,0 +1,6 @@
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('.al-sticky-sidebar').Stickyfill();
+  $('body').scrollspy({ target: '.al-sidebar-navigation-overview' });
+});

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

@@ -0,0 +1,56 @@
+(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/oembed_viewer.js

@@ -0,0 +1,39 @@
+Blacklight.onLoad(function () {
+  'use strict';
+  var onlineContentTabSelector = '[data-arclight-online-content-tab="true"]';
+  var oEmbedViewerSelector = '[data-arclight-oembed="true"]';
+
+  $(onlineContentTabSelector).on('shown.bs.tab', function() {
+    var $viewerElements = $(oEmbedViewerSelector);
+    if($viewerElements.length === 0) {
+      return;
+    }
+
+    $viewerElements.each(function (i, element) {
+      var $el = $(element);
+      var data = $el.data();
+      var resourceUrl = data.arclightOembedUrl;
+      $.ajax({
+        url: resourceUrl,
+        dataType: 'html'
+      }).done(function (response) {
+        var links = $('<div>' + response.match(/<link .*>/g).join('') + '</div>'); // Parse out link elements so image assets are not loaded
+        var oEmbedEndPoint = links.find('link[rel="alternate"][type="application/json+oembed"]').prop('href');
+
+        if(!oEmbedEndPoint || oEmbedEndPoint.length === 0) {
+          return;
+        }
+
+        $.ajax({
+          url: oEmbedEndPoint
+        }).done(function (oEmbedResponse) {
+          if(oEmbedResponse.html) {
+            $el.hide()
+               .html(oEmbedResponse.html)
+               .fadeIn(500);
+          }
+        });
+      });
+    });
+  });
+});

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

@@ -0,0 +1,23 @@
+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').on('navigation.contains.elements', function () {
+    $('a[data-toggle="pill"]').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' %>"
+        });
+      });
+    });
+  });
+});

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

@@ -0,0 +1,13 @@
+@import 'bootstrap/variables';
+@import 'bootstrap_overrides';
+@import 'variables';
+@import 'modules/collection_search';
+@import 'modules/highlights';
+@import 'modules/hierarchy_and_online_contents';
+@import 'modules/layout';
+@import 'modules/mastheads';
+@import 'modules/repositories.scss';
+@import 'modules/repository_card.scss';
+@import 'modules/search_results';
+@import 'modules/show_collection';
+@import 'modules/sidebar';

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

@@ -0,0 +1,3 @@
+.nav.nav-pills {
+  margin-bottom: $spacer;
+}

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

@@ -0,0 +1,3 @@
+.al-collection-count {
+  padding-top: 20px;
+}

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

@@ -0,0 +1,174 @@
+.documents-hierarchy,
+.documents-online_contents {
+  .document-title-heading {
+    font-size: $font-size-h5;
+  }
+
+  .document-title-containers {
+    &:after {
+      padding-right: 3px;
+    }
+  }
+
+  .al-toggle-view-all {
+    color: $gray-light;
+
+    &:before {
+      color: $gray-light;
+      content: "\2022";
+      padding-right: 3px;
+    }
+  }
+
+  .al-hierarchy-children-status {
+    text-align: right;
+  }
+
+  // Component title + children badge
+  .documentHeader {
+    border-bottom: $border-width dashed #ccc;
+    margin-bottom: ($spacer / 2);
+    margin-top: ($spacer * 2);
+  }
+
+  // Headings and text
+  .al-document-abstract-or-scope {
+    font-size: 0.85rem;
+    line-height: 1.25;
+  }
+
+  .al-hierarchy-sub-heading {
+    color: $gray-light;
+    font-size: $font-size-xs;
+    font-weight: normal;
+    text-transform: uppercase;
+  }
+
+  // Series level
+  .blacklight-series .document-title-heading,
+  .blacklight-file .document-title-heading,
+  .blacklight-otherlevel .document-title-heading {
+    font-size: $font-size-h5;
+    font-weight: 400;
+    margin-bottom: ($spacer / 2);
+
+    > a {
+      color: $gray-dark;
+    }
+  }
+
+  .blacklight-series,
+  .blacklight-file {
+    // Additional for levels below series
+    .blacklight-subseries .document-title-heading,
+    .blacklight-file .document-title-heading,
+    .blacklight-otherlevel .document-title-heading {
+      font-size: $font-size-h6;
+
+      .documentHeader {
+        margin-top: $spacer;
+      }
+    }
+
+    // Icongraphy for each level
+    .blacklight-subseries .document-title-heading,
+    .al-hierarchy-level-1 .blacklight-file .document-title-heading,
+    .al-hierarchy-level-1 .blacklight-otherlevel .document-title-heading {
+      border-left: ($border-width * 2) solid #999;
+      padding-left: 10px;
+    }
+
+    .al-hierarchy-level-2 .document-title-heading,
+    .al-hierarchy-level-2 .blacklight-file .document-title-heading {
+      border-left: 0;
+      padding-left: 0;
+
+      &:before {
+        color: $gray-light;
+        content: "\a6";
+        padding-right: 6px;
+      }
+    }
+
+    .al-hierarchy-level-3 .document-title-heading,
+    .al-hierarchy-level-3 .blacklight-file .document-title-heading {
+      &:before {
+        content: "\205D";
+      }
+    }
+  }
+}
+
+.al-hierarchy-highlight {
+  background: $state-warning-bg;
+}
+
+// Placeholder styling
+.al-hierarchy-placeholder {
+  margin-top: $spacer;
+
+  h3 {
+    background-color: $gray-lighter;
+    border-radius: 5px;
+    height: $font-size-h3;
+  }
+
+  p {
+    background-color: $gray-lighter;
+    border-radius: 5px;
+    height: $font-size-base;
+  }
+}
+
+// Component show page, Collection context section
+#collection-context {
+  h1 {
+    font-size: $font-size-h5;
+  }
+
+  .documents-hierarchy,
+  .documents-online_contents {
+    .documentHeader {
+      margin-top: 1.5rem;
+    }
+  }
+
+  // Top-level context
+  .al-hierarchy-level-0 .document-title-heading {
+    // background-color: red;
+    font-size: $font-size-h5;
+    font-weight: 400;
+    margin-bottom: ($spacer / 2);
+
+    > a {
+      color: $gray-dark;
+    }
+  }
+
+  // All subsequent levels
+  @for $i from 1 through 12 {
+    .al-hierarchy-level-#{$i} .document-title-heading {
+      font-size: $font-size-h6;
+      font-weight: 400;
+
+      > a {
+        color: $gray-dark;
+      }
+    }
+  }
+}
+
+// Indentation styling for all level hierarchies
+@mixin hierarchy-levels {
+  @for $i from 1 through 12 {
+    .al-hierarchy-level-#{$i} {
+      margin-left: 10px;
+      // provides for n indention
+      &.extra-indent {
+        margin-left: ($i * 10) + px;
+      }
+    }
+  }
+}
+
+@include hierarchy-levels;

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

@@ -0,0 +1,10 @@
+.al-document-highlight {
+  padding-top: 10px;
+  padding-left: 10px;
+  font-size: $font-size-xs;
+  font-style: italic;
+  em {
+    background-color: yellow;
+    font-weight: bold;
+  }
+}