blacklight-spotlight 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bac2d83148f6c9a1aa532408a2effa05bc24a90
-  data.tar.gz: 159afad18eb3f2517565a596ae5370fe03886b3f
+  metadata.gz: 4a7be9158cfe934e098624ab9c62efd1145b57a9
+  data.tar.gz: 055cae6350b02d852a09c2c53cb1db5f904acd97
 SHA512:
-  metadata.gz: cfd4c44bb04e705ca0a1efead0491ca55d2ead843f0a7a22e009471a6426213072a6d9bdd0ddcce12973dc346f43b6d8382e996aafb665cceb69d7c0d44c01b4
-  data.tar.gz: fbd5a0e58e03d519febe79fe96ca6b0bcbdde3bdb92b4f11c0ebb07d46e2b6cb711f935d2de6ea3b550eacf587421c6ea94d765cf143bc468e03dcc6428f3736
+  metadata.gz: 6fa2558ac7267d5d61dab56a383e0456d7636b8c127a4e572d5d774981c27630aa11fe50d4a26a56683122e45c7151c8d6602a989d3492ed57fbbf6940f2092f
+  data.tar.gz: 221614d88e3d997ab92d9506dd60a2ac5f25e4dea3f7e865824b8f87d64276c5e4efe3195ed84fc0c32aa426d6bd6f1856538b7105cbc7581961c91e4c83c74f

data/README.md

@@ -1,10 +1,21 @@
 spotlight
 =========
 
-[![Build Status](https://travis-ci.org/sul-dlss/spotlight.png?branch=master)](https://travis-ci.org/sul-dlss/spotlight) | [Release Notes](https://github.com/sul-dlss/spotlight/releases) | [Design Documents](https://github.com/sul-dlss/spotlight/releases/tag/v0.0.0)
+[![Build Status](https://travis-ci.org/sul-dlss/spotlight.png?branch=master)](https://travis-ci.org/sul-dlss/spotlight) | [![Coverage Status](https://coveralls.io/repos/sul-dlss/spotlight/badge.png?branch=master)](https://coveralls.io/r/sul-dlss/spotlight) | [![Gem Version](https://badge.fury.io/rb/blacklight-spotlight.png)](http://badge.fury.io/rb/blacklight-spotlight) | [Release Notes](https://github.com/sul-dlss/spotlight/releases) | [Design Documents](https://github.com/sul-dlss/spotlight/releases/tag/v0.0.0)
 
 Spotlight is intended to enable librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that feature these collections. The curator should be able to use Spotlight to produce a website that highlights a digital collection, drawn from a digital library repository, entirely on his or her own, without programming. The development and ongoing management of the website should be relatively simple and follow familiar conventions for producing online content (e.g., similar to writing and managing a blog or working with a content management system).
 
+### Demo Videos
+* [Sprint 9](https://www.youtube.com/watch?v=ALVwecIw5Rw)
+* [Sprint 8](https://www.youtube.com/watch?v=l25_TWTV1uE)
+* [Sprint 7](https://www.youtube.com/watch?v=qTv33JqUoH8)
+* [Sprint 6](https://www.youtube.com/watch?v=HxQ6khYqezU)
+* [Sprint 5](https://www.youtube.com/watch?v=pnpqiIDXHHw)
+* [Sprint 4](https://www.youtube.com/watch?v=4S0iRzvdk5M)
+* [Sprint 3](https://www.youtube.com/watch?v=XEOsMRY_3mY)
+* [Sprint 2](https://www.youtube.com/watch?v=8BqWSEmOK3g)
+* [Sprint 1](https://www.youtube.com/watch?v=LAoTIdP2Gsk)
+
 ## Tests
 
 Run tests:
@@ -15,6 +26,20 @@ $ rake
 
 ## Installation
 
+To bootstrap a new Rails application:
+
+```
+$ rails new app-name -m https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
+```
+
+or
+
+```
+$ rake rails:template LOCATION=https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
+```
+
+Or do it manually:
+
 Add this line to your application's Gemfile:
 
 ```
@@ -37,3 +62,21 @@ Create an administrator
 ```
 $ rake spotlight:initialize
 ```
+
+## To set up your development environment
+
+**Note:** rake commands MAY need to be prefixed with `bundle exec`, depending on your environment.
+
+ 1. Clone this repo, `cd` in and run `$ bundle install`
+ 2. Get and configure Jetty/Solr:
+     1. `$ rake jetty:download`
+     2. `$ rake jetty:unzip`
+     3. `$ rake spotlight:configure_jetty`
+ 3.  Generate the internal test application (will be in `spec/internal`): `$ rake engine_cart:generate` 
+ 4. Start Jetty `$ rake jetty:start` (may take a moment, use e.g. `$ fuser 8983/tcp` or `$ ps aux | grep jetty` to see when it's actually up)
+ 3. Index fixtures: `TEST_JETTY_PORT=8983 rake spotlight:fixtures`
+ 4. `$ cd spec/internal`
+ 5. Run `$ rake spotlight:initialize` and answer prompts
+ 6. Start the dev server `rails s`
+ 7. Visit [http://localhost:3000](http://localhost:3000) and sign in.
+

data/app/assets/javascripts/spotlight/add_new_page_button.js

@@ -0,0 +1,74 @@
+(function($){
+  $.fn.addNewPageButton = function( options ) {
+    $.each(this, function(){
+      addExpandBehaviorToButton($(this));
+    });
+    function addExpandBehaviorToButton(button){
+      var settings = $.extend({
+        speed: (button.data('speed') || 450),
+        animate_width: (button.data('animate_width') || 425)
+      }, options);
+      var target = $(button.data('field-target'));
+      var save   = $("input[data-behavior='save']", target);
+      var cancel = $("input[data-behavior='cancel']", target);
+      var input  = $("input[type='text']", target);
+      var original_width  = button.outerWidth();
+
+      // Animate button open when the mouse enters or
+      // the button is given focus (i.e. clicked/tabbed)
+      button.on("mouseenter focus", function(){
+        expandButton();
+      });
+
+      // Don't allow blank titles
+      save.on('click', function(){
+        if ( inputEmpty() ) {
+          return false;
+        }
+      });
+
+      // Empty input and collapse
+      // button on cancel click
+      cancel.on('click', function(e){
+        e.preventDefault();
+        input.val('');
+        collapseButton();
+      });
+
+      // Collapse the button on when
+      // an empty input loses focus
+      input.on("blur", function(){
+        if ( inputEmpty() ) {
+          collapseButton();
+        }
+      });
+      function expandButton(){
+        if(button.outerWidth() <= (original_width + 5)) {
+          button.animate(
+            {width: settings.animate_width + 'px'}, settings.speed, function(){
+              target.show(0, function(){
+                input.focus();
+                // Set the button to auto width to make
+                // sure it has room for any inputs
+                button.width("auto");
+                // Explicitly set the width of the button
+                // so the close animation works properly
+                button.width(button.width());
+              });
+            }
+          )
+        }
+      }
+      function collapseButton(){
+        target.hide();
+        button.animate({width: original_width + 'px'}, settings.speed);
+      }
+      function inputEmpty(){
+        return $.trim(input.val()) == "";
+      }
+    }
+  }
+})( jQuery );
+Spotlight.onLoad(function() {
+  $("[data-expanded-add-button]").addNewPageButton();
+});

data/app/assets/javascripts/spotlight/appearance.js

@@ -0,0 +1,26 @@
+Spotlight.onLoad(function(){
+  $('#nested-navigation').nestable({maxDepth: 1});
+  updateWeightsAndRelationships($('#nested-navigation'));
+  addRestoreDefaultBehavior();
+});
+
+function addRestoreDefaultBehavior(){
+  $("[data-behavior='restore-default']").each(function(){
+    var hidden = $("[data-default-value]", $(this));
+    var value = $($("[data-in-place-edit-target]", $(this)).data('in-place-edit-target'), $(this));
+    var button = $("[data-restore-default]", $(this));
+    hidden.on('blur', function(){
+      if( $(this).val() == $(this).data('default-value') ) {
+        button.addClass('hidden');
+      } else {
+        button.removeClass('hidden');
+      }
+    });
+    button.on('click', function(e){
+      e.preventDefault();
+      hidden.val(hidden.data('default-value'));
+      value.text(hidden.data('default-value'));
+      button.hide();
+    });
+  });
+}

data/app/assets/javascripts/spotlight/application.js

@@ -16,5 +16,8 @@
 //= require spotlight/spotlight
 //= require bootstrap/tooltip
 //= require bootstrap/popover
+//= require bootstrap/carousel
 //= require bootstrap-tagsinput
-//= require_tree .
+//= require social-share-button
+//= require openseadragon/rails
+//= require_tree .

data/app/assets/javascripts/spotlight/blacklight_configuration.js

@@ -1,4 +1,7 @@
 Spotlight.onLoad(function() {
+  // Add Select/Deselect all button behavior
+  addCheckboxToggleBehavior();
+
   // Initialize Nestable for nested pages
   $('#nested-fields .metadata_fields').nestable({maxDepth: 1, listNodeName: "tbody", itemNodeName: "tr", expandBtnHTML: "", collapseBtnHTML: "" });
   $('#nested-fields.facet_fields').nestable({maxDepth: 1});
@@ -7,10 +10,12 @@ Spotlight.onLoad(function() {
   updateWeightsAndRelationships($('#nested-fields .metadata_fields'));
   updateWeightsAndRelationships($('#nested-fields.facet_fields'));
 
-  $('.field-label').on('click.inplaceedit', function() {
-    var $input = $(this).next('input');
-    var $label = $(this);
+  $("[data-in-place-edit-target]").on('click.inplaceedit', function() {
+    var $input = $(this).find('input');
+    var $label = $(this).find($(this).data('in-place-edit-target'));
 
+    // hide the edit-in-place affordance icon while in edit mode
+    $(this).addClass('hide-edit-icon');
     $label.hide();
     $input.val($label.text());
     $input.attr('type', 'text');
@@ -28,6 +33,8 @@ Spotlight.onLoad(function() {
       $label.text($input.val());
       $label.show();
       $input.attr('type', 'hidden');
+      // when leaving edit mode, should no longer hide edit-in-place affordance icon
+      $("[data-in-place-edit-target]").removeClass('hide-edit-icon');
 
       return false;
     });
@@ -35,3 +42,46 @@ Spotlight.onLoad(function() {
     return false;
   });
 });
+
+// Add Select/Deselect all button behavior
+function addCheckboxToggleBehavior() {
+  $("[data-behavior='metadata-select']").each(function(){
+    var button = $(this)
+    var parentCell = button.parents("th");
+    var table = parentCell.closest("table");
+    var columnRows = $("tr td:nth-child(" + (parentCell.index() + 1) + ")", table);
+    var checkboxes = $("input[type='checkbox']", columnRows);
+    swapSelectAllButtonText(button, columnRows);
+    // Add the check/uncheck behavior to the button
+    // and swap the button text if necessary
+    button.on('click', function(e){
+      e.preventDefault();
+      var allChecked = allCheckboxesChecked(columnRows);
+      columnRows.each(function(){
+        $("input[type='checkbox']", $(this)).prop('checked', !allChecked);
+        swapSelectAllButtonText(button, columnRows);
+      });
+    });
+    // Swap button text when a checkbox value changes
+    checkboxes.each(function(){
+      $(this).on('change', function(){
+        swapSelectAllButtonText(button, columnRows);
+      });
+    });
+  });
+  // Check number of checkboxes against the number of checked
+  // checkboxes to determine if all of them are checked or not
+  function allCheckboxesChecked(elements) {
+    return ($("input[type='checkbox']", elements).length == $("input[type='checkbox']:checked", elements).length)
+  }
+  // Swap the button text to "Deselect all"
+  // when all the checkboxes are checked and
+  // "Select all" when any are unchecked
+  function swapSelectAllButtonText(button, elements) {
+    if ( allCheckboxesChecked(elements) ) {
+      button.text(button.data('deselect-text'));
+    } else {
+      button.text(button.data('select-text'));
+    }
+  }
+}

data/app/assets/javascripts/spotlight/blocks/block.js

@@ -0,0 +1,135 @@
+(function ($){
+  Spotlight.Block = SirTrevor.Block.extend({
+    editorHTML: function() {
+      return this.template(this);
+    },
+    formId: function(id) {
+      return this.blockID + "_" + id;
+    },
+    onBlockRender: function() {
+      addAutocompletetoSirTrevorForm();
+    },
+    toData: function() {
+      var data = {};
+
+
+      /* Simple to start. Add conditions later */
+      if (this.hasTextBlock()) {
+        var content = this.getTextBlock().html();
+        if (content.length > 0) {
+          data.text = SirTrevor.toMarkdown(content, this.type);
+        } else {
+          data.text = "";
+        }
+      }
+
+      // Add any inputs to the data attr
+      var inputs = this.$(':input').
+          not('.st-paste-block').
+          not('button').
+          not(':input:checkbox,:input:radio').
+          add(this.$(':input:checkbox:checked')).
+          add(this.$(':input:radio:checked')).
+          add(this.$('select'))
+
+      // unchecked checkboxes
+      this.$(':input:checkbox,:input:radio').not(':input:checkbox:checked').not(':input:radio:checked').each(function(index,input) {
+        var key = $(input).data('key') || input.getAttribute('name');
+        if (key) {
+          data[key] = null;
+        }
+      });
+
+      if(inputs.length > 0) {
+        inputs.each(function(index,input){
+          var key = $(input).data('key') || input.getAttribute('name');
+          if (key) {
+            if($(input).is(':checkbox') && $(input).val() == "true") {
+              data[key] = true;
+            } else {
+              data[key] = $(input).val();
+            }
+          }
+        });
+      }
+
+      // Set
+      if(!_.isEmpty(data)) {
+        this.setData(data);
+      }
+    },
+
+    loadFormDataByKey: function(data) {
+      this.$(':input').not('button').each(function(index, input) {
+        var key = $(input).data('key') || input.getAttribute('name');
+        // by wrapping it in an array, it'll "just work" for radio and checkbox fields too
+        $(this).val([data[key]]);
+      });
+    },
+
+    loadData: function(data){
+      if (this.hasTextBlock()) {
+        this.getTextBlock().html(SirTrevor.toHTML(data.text, this.type));
+      }
+      this.loadFormDataByKey(data);
+      this.afterLoadData(data);
+    },
+
+    afterLoadData: function(data) { },
+
+    caption_field_template: _.template(['<option value="<%= field %>"><%= label %></option>'].join("\n")),
+
+    loadCaptionField: function(){
+      var block = this;
+      var metadata_url = $('form[data-metadata-url]').data('metadata-url');
+      var primary_caption_field = $('#' + this.formId(this.primary_field_key));
+      var secondary_caption_field = $('#' + this.formId(this.secondary_field_key));
+      var primary_caption_selected_value = primary_caption_field.data("select-after-ajax");
+      var secondary_caption_selected_value = secondary_caption_field.data("select-after-ajax");
+      $.ajax({
+        accepts: "json",
+        url: metadata_url
+      }).success(function(data){
+        // Only checking the primary caption field
+        // Could check both but I'm not sure it's necessary
+        if($("option", primary_caption_field).length == 2){
+          var options = "";
+          $.each(data, function(i, field){
+            options += block.caption_field_template(field);
+          });
+
+          primary_caption_field.append(options);
+          secondary_caption_field.append(options);
+
+          primary_caption_field.val([primary_caption_selected_value]);
+          secondary_caption_field.val([secondary_caption_selected_value]);
+          // re-serialize the form so the form observer
+          // knows about the new drop down options.
+          serializeFormStatus($('form[data-metadata-url]'));
+        }
+      });
+    },
+
+    addCaptionSelectFocus: function(){
+      $("[data-behavior='item-caption-admin']").each(function(){
+        var checkbox = $('input[type="checkbox"]', $(this));
+        var select = $('select', $(this));
+        checkbox.on('change', function(){
+          if ( $(this).is(':checked') ) {
+            select.focus();
+          }
+        });
+        select.on('change', function(){
+          checkbox.prop('checked', !($(this).val() == ""))
+        });
+      });
+    }
+
+  });
+
+
+  SirTrevor.BlockControl.prototype.render = function() {
+    this.$el.html('<span class="st-icon st-icon-'+ _.result(this.block_type, "type") + '">'+ _.result(this.block_type, 'icon_name') +'</span>' + _.result(this.block_type, 'title'));
+    return this;
+  };
+})(jQuery);

data/app/assets/javascripts/spotlight/blocks/item_carousel_block.js

@@ -0,0 +1,14 @@
+//= require 'spotlight/blocks/multi_up_item_grid.js'
+SirTrevor.Blocks.ItemCarousel =  (function(){
+
+  return SirTrevor.Blocks.MultiUpItemGrid.extend({
+
+    type: "item-carousel",
+
+    title: function() { return "Carousel"; },
+
+    icon_name: "item-carousel",
+
+    description: "This widget displays one to five thumbnail images of repository items in a carousel. You can configure the captions that appear below each carousel image and how the images are cycled."
+  });
+})();;

data/app/assets/javascripts/spotlight/blocks/item_features_block.js

@@ -0,0 +1,14 @@
+//= require 'spotlight/blocks/multi_up_item_grid.js'
+SirTrevor.Blocks.ItemFeatures =  (function(){
+
+  return SirTrevor.Blocks.MultiUpItemGrid.extend({
+
+    type: "item-features",
+
+    title: function() { return "Featured Items"; },
+
+    icon_name: "item-features",
+
+    description: "This widget displays one to five thumbnail images of repository items in a slideshow."
+  });
+})();;