blacklight-spotlight 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a7be9158cfe934e098624ab9c62efd1145b57a9
-  data.tar.gz: 055cae6350b02d852a09c2c53cb1db5f904acd97
+  metadata.gz: c7804a1ca073fa41b52454ee8819a13934538b9b
+  data.tar.gz: 304a43a49d75a5428eab6c7d4d2b431238cabf38
 SHA512:
-  metadata.gz: 6fa2558ac7267d5d61dab56a383e0456d7636b8c127a4e572d5d774981c27630aa11fe50d4a26a56683122e45c7151c8d6602a989d3492ed57fbbf6940f2092f
-  data.tar.gz: 221614d88e3d997ab92d9506dd60a2ac5f25e4dea3f7e865824b8f87d64276c5e4efe3195ed84fc0c32aa426d6bd6f1856538b7105cbc7581961c91e4c83c74f
+  metadata.gz: eb998380f5c4d6a87e8af83ccce236386d8830a8576059923797e43fd94350c2a6e40c6d253d04aa1da3f76a996ce8b4031f5b743853f6853bb21941b8d5d4e3
+  data.tar.gz: 8abac5e56f43c4ca950c418c2ffc29f8bb7bf94784a83c66034ba7780c16d3cb87045f8fedee62206606d7fafdf95d00b7452812f994f4157a03c71b142428d2

data/README.md

@@ -63,6 +63,22 @@ Create an administrator
 $ rake spotlight:initialize
 ```
 
+## Configuration
+
+### Blacklight configuration
+
+Spotlight uses your application's Blacklight configuration to provide default values for an exhibit. The Blacklight configuration options are documented on the [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki#blacklight-configuration).
+
+### Default ActionMailer configuration
+
+Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (See the Rails Guide for [Action Mailer Configuration](http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration) ).
+
+### Solr Indexing
+
+Spotlight needs the ability to write exhibit-specific content to your Solr index. The default indexing strategy uses [Atomic Updates](https://cwiki.apache.org/confluence/display/solr/Updating+Parts+of+Documents), introduced in Solr 4.x. Note the [caveats, limitations and required configuration](https://wiki.apache.org/solr/Atomic_Updates#Caveats_and_Limitations) necessary to use this feature. The rake task `spotlight:check:solr` will test if your Solr configuration is suitable for Atomic Updates.
+
+If you are unable to use the Atomic Update strategy, your `SolrDocument` class must implement a `#reindex` method that can update the document in Solr with the exhibit-specific data provided by `#to_solr`.
+
 ## To set up your development environment
 
 **Note:** rake commands MAY need to be prefixed with `bundle exec`, depending on your environment.
@@ -79,4 +95,3 @@ $ rake spotlight:initialize
  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/Rakefile

@@ -24,6 +24,8 @@ RSpec::Core::RakeTask.new(:spec)
 require 'jettywrapper'
 
 require 'engine_cart/rake_task'
+require 'spotlight/version'
+EngineCart.fingerprint = Spotlight::VERSION
 task :ci => ['engine_cart:generate', 'jetty:clean', 'spotlight:configure_jetty'] do
   ENV['environment'] = "test"
   jetty_params = Jettywrapper.load_config
@@ -53,6 +55,35 @@ namespace :spotlight do
       abort "Error running fixtures" unless $?.success?
     end
   end
+
+  task :server do
+    if File.exists? 'spec/internal'
+      within_test_app do
+        system "bundle update"
+      end
+    else
+      Rake::Task['engine_cart:generate'].invoke
+    end
+
+    unless File.exists? 'jetty'
+      Rake::Task['jetty:clean'].invoke
+      Rake::Task['spotlight:configure_jetty'].invoke
+    end
+
+    jetty_params = Jettywrapper.load_config
+    jetty_params[:startup_wait]= 60
+
+    Jettywrapper.wrap(jetty_params) do
+      within_test_app do
+        unless File.exists? '.initialized'
+          system "bundle exec rake spotlight:initialize"
+          system "bundle exec rake spotlight_test:solr:seed"
+          File.open('.initialized', "w") {}
+        end
+        system "bundle exec rails s"
+      end
+    end
+  end
 end
 
 task default: :ci

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

@@ -1,6 +1,4 @@
 Spotlight.onLoad(function(){
-  $('#nested-navigation').nestable({maxDepth: 1});
-  updateWeightsAndRelationships($('#nested-navigation'));
   addRestoreDefaultBehavior();
 });
 

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

@@ -11,13 +11,15 @@
 // about supported directives.
 //
 //= require jquery
+//= require lodash
 //= require sir-trevor
 //= require nestable
 //= require spotlight/spotlight
+//= require bootstrap/tab
 //= require bootstrap/tooltip
 //= require bootstrap/popover
 //= require bootstrap/carousel
 //= require bootstrap-tagsinput
 //= require social-share-button
-//= require openseadragon/rails
+//= require jquery.jcrop
 //= require_tree .

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

@@ -2,17 +2,9 @@ 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});
-
-  // Handle weighting the pages and their children.
-  updateWeightsAndRelationships($('#nested-fields .metadata_fields'));
-  updateWeightsAndRelationships($('#nested-fields.facet_fields'));
-
   $("[data-in-place-edit-target]").on('click.inplaceedit', function() {
-    var $input = $(this).find('input');
     var $label = $(this).find($(this).data('in-place-edit-target'));
+    var $input = $(this).find($(this).data('in-place-edit-field-target'));
 
     // hide the edit-in-place affordance icon while in edit mode
     $(this).addClass('hide-edit-icon');

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

@@ -1,7 +1,7 @@
 (function ($){
   Spotlight.Block = SirTrevor.Block.extend({
     editorHTML: function() {
-      return this.template(this);
+      return _.template(this.template)(this);
     },
     formId: function(id) {
       return this.blockID + "_" + id;
@@ -9,17 +9,14 @@
     onBlockRender: function() {
       addAutocompletetoSirTrevorForm();
     },
-    toData: function() {
+    _serializeData: 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 = "";
+        data.text = this.getTextBlockHTML();
+        if (data.text.length > 0 && this.options.convertToMarkdown) {
+          data.text = stToMarkdown(data.text, this.type);
         }
       }
 
@@ -53,10 +50,7 @@
         });
       }
 
-      // Set
-      if(!_.isEmpty(data)) {
-        this.setData(data);
-      }
+      return data;
     },
 
     loadFormDataByKey: function(data) {
@@ -77,7 +71,7 @@
 
     afterLoadData: function(data) { },
 
-    caption_field_template: _.template(['<option value="<%= field %>"><%= label %></option>'].join("\n")),
+    caption_field_template: ['<option value="<%= field %>"><%= label %></option>'].join("\n"),
 
     loadCaptionField: function(){
       var block = this;
@@ -95,7 +89,7 @@
         if($("option", primary_caption_field).length == 2){
           var options = "";
           $.each(data, function(i, field){
-            options += block.caption_field_template(field);
+            options += _.template(block.caption_field_template)(field);
           });
 
           primary_caption_field.append(options);

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

@@ -11,4 +11,23 @@ SirTrevor.Blocks.ItemFeatures =  (function(){
 
     description: "This widget displays one to five thumbnail images of repository items in a slideshow."
   });
-})();;
+})();;
+
+
+(function($){
+  // Plugin definition
+  $.fn.featuredItemsCarousel = function(options) {
+    var indicators = $(this).find('.slideshow-indicators li');
+
+    indicators.each(function(){
+      $(this).on('click', function(){
+        indicators.removeClass("active");
+        $(this).addClass("active");
+      });
+    });
+  };
+
+  Spotlight.onLoad(function(){
+    $('.item-features').featuredItemsCarousel();
+  });
+})(jQuery);

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

@@ -25,6 +25,8 @@ SirTrevor.Blocks.ItemText =  (function(){
 
     type: "item-text",
 
+    blockGroup: 'Exhibit item widgets',
+
     title: function() { return "Item + Text"; },
 
     icon_name: "item-text",
@@ -42,18 +44,25 @@ SirTrevor.Blocks.ItemText =  (function(){
       this.$('select#' + this.formId(this.primary_field_key)).data('select-after-ajax', data[this.primary_field_key]);
       this.$('select#' + this.formId(this.secondary_field_key)).data('select-after-ajax', data[this.secondary_field_key]);
       var context = this;
-      context.$('[data-target-panel]').each(function(){
-        if ($(this).prop("value") != "") {
-          swapInputForPanel($(this), context.$($(this).data('target-panel')), {
-            id: data[context.id_key],
-            title: data[context.id_text_key],
-            thumbnail: data[context.thumbnail_key + "_0"]
+      $.ajax($('form[data-autocomplete-url]').data('autocomplete-url') + '?q=id:' + data[context.id_key])
+        .success(function(ajaxData){
+          var thumbnails   = ajaxData['docs'][0]['thumbnails'],
+              privateLabel = ajaxData['docs'][0]['private'];
+          context.$('[data-target-panel]').each(function(){
+            if ($(this).prop("value") != "") {
+              swapInputForPanel($(this), context.$($(this).data('target-panel')), {
+                id: data[context.id_key],
+                title: data[context.id_text_key],
+                thumbnail: data[context.thumbnail_key + "_0"],
+                thumbnails: thumbnails,
+                private: privateLabel
+              });
+            }
           });
-        }
-      });
+        });
     },
 
-    template: _.template([
+    template: [
     '<div class="form-horizontal item-text-admin">',
       '<div class="widget-header">',
         'This widget displays a thumbnail image of the repository item you selected and a text block to the left or right of it.',
@@ -72,6 +81,7 @@ SirTrevor.Blocks.ItemText =  (function(){
                   '<div class="main">',
                     '<div class="title panel-title" data-panel-title="true"></div>',
                     '<div data-panel-id-display="true"></div>',
+                    '<div data-panel-image-pagination="true"></div>',
                   '</div>',
                   '<div class="remove pull-right">',
                     '<a data-item-grid-panel-remove="true" href="#">Remove</a>',
@@ -97,7 +107,7 @@ SirTrevor.Blocks.ItemText =  (function(){
           '<label for="<%= formId(show_primary_field_key) %>">Primary caption</label>',
           '<select name="<%= primary_field_key %>" id="<%= formId(primary_field_key) %>">',
             '<option value="">Select...</option>',
-            '<%= caption_field_template({field: title_key, label: "Title", selected: ""}) %>',
+            '<%= _.template(caption_field_template)({field: title_key, label: "Title", selected: ""}) %>',
           '</select>',
         '</div>',
         '<div class="field-select secondary-caption" data-behavior="item-caption-admin">',
@@ -105,7 +115,7 @@ SirTrevor.Blocks.ItemText =  (function(){
           '<label for="<%= formId(show_secondary_field_key) %>">Secondary caption</label>',
           '<select name="<%= secondary_field_key %>" id="<%= formId(secondary_field_key) %>">',
             '<option value="">Select...</option>',
-            '<%= caption_field_template({field: title_key, label: "Title", selected: ""}) %>',
+            '<%= _.template(caption_field_template)({field: title_key, label: "Title", selected: ""}) %>',
           '</select>',
         '</div>',
         '<div class="text-align">',
@@ -118,6 +128,6 @@ SirTrevor.Blocks.ItemText =  (function(){
       '</div>',
       '<div class="clearFix"></div>',
     '</div>'
-  ].join("\n"))
+  ].join("\n")
   });
 })();

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

@@ -29,6 +29,8 @@ SirTrevor.Blocks.MultiUpItemGrid =  (function(){
 
     title: function() { return "Multi-Up Item Grid"; },
 
+    blockGroup: 'Exhibit item widgets',
+
     icon_name: "multi-up-item-grid",
 
     inputFieldsCount: 5,
@@ -55,29 +57,37 @@ SirTrevor.Blocks.MultiUpItemGrid =  (function(){
       this.$('select#' + this.formId(this.primary_field_key)).data('select-after-ajax', data[this.primary_field_key]);
       this.$('select#' + this.formId(this.secondary_field_key)).data('select-after-ajax', data[this.secondary_field_key]);
       var context = this;
-      var i = 0;
-      context.$('[data-target-panel]').each(function(){
+      context.$('[data-target-panel]').each(function(i){
         if ($(this).prop("value") != "") {
-          swapInputForPanel($(this), context.$($(this).data('target-panel')), {
-            id: data[context.id_key + "_" + i],
-            title: data[context.id_key + "_" + i + "_title"],
-            thumbnail: data[context.thumbnail_key + "_" + i]
+          var target_panel = $(this),
+              object_id = data[context.id_key + "_" + i],
+              object_title = data[context.id_key + "_" + i + "_title"],
+              object_thumbnail = data[context.thumbnail_key + "_" + i];
+          $.ajax($('form[data-autocomplete-url]').data('autocomplete-url') + '?q=id:' + object_id).success(function(ajaxData){
+            var thumbnails   = ajaxData['docs'][0]['thumbnails'],
+                privateLabel = ajaxData['docs'][0]['private'];
+            swapInputForPanel(target_panel, context.$(target_panel.data('target-panel')), {
+              id: object_id,
+              title: object_title,
+              thumbnail: object_thumbnail,
+              thumbnails: thumbnails,
+              private: privateLabel
+            });
           });
         }
-        i++;
       });
     },
 
     description: "This widget displays one to five thumbnail images of repository items in a single row grid. Optionally, you can a caption below each image..",
 
-    template: _.template([
+    template: [
       '<div class="form-inline <%= key %>-admin clearfix">',
         '<div class="widget-header">',
           '<%= description %>',
         '</div>',
         '<div class="col-sm-8">',
           '<label for="<%= formId(id_key) %>_0" class="control-label">Selected items to display</label>',
-          '<div class="form-group panel-group dd nestable-item-grid">',
+          '<div class="form-group panel-group dd nestable-item-grid" data-behavior="nestable" data-max-depth="1">',
             '<ol class="dd-list">',
               '<%= buildInputFields(inputFieldsCount) %>',
             '</ol>',
@@ -89,7 +99,7 @@ SirTrevor.Blocks.MultiUpItemGrid =  (function(){
             '<label for="<%= formId(show_primary_caption) %>">Primary caption</label>',
             '<select name="<%= primary_field_key %>" id="<%= formId(primary_field_key) %>">',
               '<option value="">Select...</option>',
-              '<%= caption_field_template({field: title_key, label: "Title", selected: ""}) %>',
+              '<%= _.template(caption_field_template)({field: title_key, label: "Title", selected: ""}) %>',
             '</select>',
           '</div>',
           '<div class="field-select secondary-caption" data-behavior="item-caption-admin">',
@@ -97,16 +107,16 @@ SirTrevor.Blocks.MultiUpItemGrid =  (function(){
             '<label for="<%= formId(show_secondary_caption) %>">Secondary caption</label>',
             '<select name="<%= secondary_field_key %>" id="<%= formId(secondary_field_key) %>">',
               '<option value="">Select...</option>',
-              '<%= caption_field_template({field: title_key, label: "Title", selected: ""}) %>',
+              '<%= _.template(caption_field_template)({field: title_key, label: "Title", selected: ""}) %>',
             '</select>',
           '</div>',
           '<%= addCarouselFields() %>',
         '</div>',
       '</div>'
-    ].join("\n")),
+    ].join("\n"),
 
     makeItemGridNestable: function() {
-      $('.nestable-item-grid').nestable({maxDepth: 1});
+      SpotlightNestable.init();
       $('.nestable-item-grid').on('change', function(){
         var i = 0;
         $('li.dd-item', $(this)).each(function(){
@@ -140,6 +150,7 @@ SirTrevor.Blocks.MultiUpItemGrid =  (function(){
                 output += '<div class="main">';
                   output += '<div class="title panel-title" data-panel-title="true"></div>';
                   output += '<div data-panel-id-display="true"></div>';
+                  output += '<div data-panel-image-pagination="true"></div>';
                 output += '</div>';
                 output += '<div class="remove pull-right">';
                   output += '<a data-item-grid-panel-remove="true" href="#">Remove</a>'

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

@@ -21,7 +21,7 @@ SirTrevor.Blocks.Oembed =  (function(){
 
     icon_name: "oembed",
 
-    template: _.template([
+    template: [
     '<div class="form-horizontal oembed-text-admin clearfix">',
       '<div class="widget-header">',
         'This widget embeds a web resource and a text block to the left or right of it.',
@@ -51,6 +51,6 @@ SirTrevor.Blocks.Oembed =  (function(){
       '</div>',
       '<div class="clearFix"></div>',
     '</div>'
-  ].join("\n"))
+  ].join("\n")
   });
 })();

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

@@ -10,17 +10,19 @@ SirTrevor.Blocks.SearchResults =  (function(){
 
   view_types_key: '[data-behavior="result-view-types"]',
 
+  blockGroup: 'Exhibit item widgets',
+
   description: "This widget displays a set of search results on a page. Specify a search result set by selecting an existing browse category. You can also select the view types that are available to the user when viewing the result set.",
 
-  template: _.template([
+  template: [
     '<div class="search-block-admin clearFix">',
       '<div class="widget-header">',
         '<%= description %>',
       '</div>',
       '<div class="col-sm-8">',
-        '<label for="<%= this.formId(this.searches_key) %>">Browse category</label>',
+        '<label for="<%= formId(searches_key) %>">Browse category</label>',
         '<div>',
-          '<select name="<%= this.searches_key %>" id="<%= this.formId(this.searches_key) %>">',
+          '<select name="<%= searches_key %>" id="<%= formId(searches_key) %>">',
             '<option value="">Select...</option>',
           '</select>',
         '</div>',
@@ -29,7 +31,7 @@ SirTrevor.Blocks.SearchResults =  (function(){
         '<h4>Result view types</h4>',
       '</div>',
     '</div>'
-  ].join("\n")),
+  ].join("\n"),
 
   onBlockRender: function(data){
     Spotlight.Block.prototype.onBlockRender.apply();
@@ -54,7 +56,7 @@ SirTrevor.Blocks.SearchResults =  (function(){
     }).success(function(data){
       if($("option", searches_field).length == 1){
         var options = "";
-        $.each(data.searches, function(i, search){
+        $.each(data, function(i, search){
           options += "<option value='" + search.id + "'>" + search.title + "</option>";
         });
 
@@ -113,6 +115,8 @@ SirTrevor.Blocks.SearchResults =  (function(){
   checkViewType: function(type){
     if (this.viewTypeSelected(type)) {
       return " checked='checked'";
+    } else {
+      return "";
     }
   },