blacklight-spotlight 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bdbb10f6cb2fbf6d332bc75089b5d27ad566638
-  data.tar.gz: 01a61aec3ece010e4075f8e33b408b6c8a6dff79
+  metadata.gz: 08801de0ceb8e82515d08ceaad4bab28feb4abaf
+  data.tar.gz: c3d7458402364cad94982cfac35232f036ec2b0c
 SHA512:
-  metadata.gz: 5f0e48275439041e2b7aafc297e0bff5d51ca8de091e275e608258476da5c056c2e716d6e46acb018dd16070adcc3ea9a0802409a310ee19b612c152f3d8cd4c
-  data.tar.gz: 699ef5bab725d826dd4544c2b0eb461cef4bfd06fc4db4589d435ced433788221c8fa55f9540e0cc262af86dfc3f13f8c8da8229a06db85cd58dd462ad99c3d8
+  metadata.gz: 66909d964b55ce89b690f17232abc66a25f68900dcf1a52b79834d545fc5bf37bf437d13c58816af1e8dda25227384bfc1903dc713aadd8ab058a8f623759e00
+  data.tar.gz: c8dee63a79069cd5c797c94c5a9e9dcfd3576ff8882f7d04ef5e63343a384866f9402f6fe462b8abbd4e28bdb712a1708bc5fba06f6d95b4b4bc20fc090e7009

data/README.md

@@ -3,26 +3,16 @@ spotlight
 
 [![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)
+Spotlight is open source software that enables librarians, curators, and other content experts to easily build feature-rich websites that showcase collections and objects from a digital repository, uploaded items, or a combination of the two. Spotlight is a plug-in for [Blacklight](https://github.com/projectblacklight/blacklight), an open source, Ruby on Rails Engine that provides a basic discovery interface for searching an Apache Solr index.
 
-## Tests
+Read more about what Spotlight is, our motivations for creating it, and how to install and configure it in the [wiki pages](https://github.com/sul-dlss/spotlight/wiki). You might also want to take a look at our demo videos, especially the [tour of a completed Spotlight exhibit](https://www.youtube.com/watch?v=_A7vTbbiF4g) and the walkthrough of [building an exhibit with Spotlight](https://www.youtube.com/watch?v=qPJtgajJ4ic).
 
-Run tests:
+## Requirements
 
-```
-$ rake
-```
+1. Ruby (2.0.0 or greater)
+2. Rails (4.2.0 or greater)
+3. Java (7 or greater) *for solr*
+4. ImageMagick
 
 ## Installation
 
@@ -32,66 +22,61 @@ To bootstrap a new Rails application:
 $ rails new app-name -m https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
 ```
 
-or
+or from an existing Rails application:
 
 ```
 $ rake rails:template LOCATION=https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
 ```
 
-Or do it manually:
+*During this process you will be prompted to enter an initial administrator email and password (this is a super-admin that can administer any exhibit in the installation).* If you choose not to create one, the first user will be given administrative privileges.
 
-Add this line to your application's Gemfile:
+Change directories to your new application:
 
 ```
-gem 'blacklight-spotlight'
+$ cd app-name
 ```
 
-And then execute:
+Run the database migrations:
 
 ```
-$ bundle
+$ rake db:migrate
 ```
 
-Then run:
+Start solr:
 
 ```
-$ rails g spotlight:install
+$ rake jetty:start
 ```
 
-Create an administrator
+Start the rails development server:
+
 ```
-$ rake spotlight:initialize
+$ rails s
 ```
 
-## Configuration
+Go to http://localhost:3000 in your browser.
 
-### 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).
+## 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) ).
+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
+### More
 
-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.
+See the [Spotlight wiki](https://github.com/sul-dlss/spotlight/wiki) for more detailed information on configuring Spotlight.
 
-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 start the development/test application
 
-## To set up your development environment
+ 1. Clone this repo, `cd` in and run `$ bundle install`
+ 2. Start jetty and the dev server: `$ bundle exec rake spotlight:server` (this task will build a Spotlight-based application, start Solr, and run the built-in rails server)
+ 3. Visit [http://localhost:3000](http://localhost:3000)
 
-**Note:** rake commands MAY need to be prefixed with `bundle exec`, depending on your environment.
+## Tests
 
- 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.
+Run tests:
+
+```
+$ rake
+```

data/Rakefile

@@ -4,7 +4,7 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.6.0.zip"
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
 
 require 'rdoc/task'
 
@@ -27,7 +27,7 @@ require 'engine_cart/rake_task'
 EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 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
@@ -80,6 +80,47 @@ namespace :spotlight do
       end
     end
   end
+  
+  namespace :template do
+    task :server do
+      require 'tmpdir'
+      require 'fileutils'
+      template_path = File.expand_path(File.join(File.dirname(__FILE__), "template.rb"))
+
+      Dir.mktmpdir do |dir|
+
+        Dir.chdir(dir) do
+          Bundler.with_clean_env do
+            version = if Gem.loaded_specs["rails"]
+              "_#{Gem.loaded_specs["rails"].version}_"
+            end
+
+            Bundler.with_clean_env do
+              IO.popen({"SPOTLIGHT_GEM" => File.dirname(__FILE__)}, ["rails", version, "new", "internal", "--skip-spring", "-m", template_path] + [err: [:child, :out]]) do |io|
+                IO.copy_stream(io,$stderr)
+                
+                _, exit_status = Process.wait2(io.pid)
+
+                if exit_status != 0
+                  raise "Failed to generate spotlight"
+                end
+              end
+            end
+            
+            Bundler.with_clean_env do
+              Dir.chdir("internal") do
+                APP_ROOT = Dir.pwd
+                jetty_params = Jettywrapper.load_config   
+                Jettywrapper.wrap(jetty_params) do
+                  system "bundle exec rails s"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
 end
 
 task default: :ci

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

@@ -21,5 +21,6 @@
 //= require bootstrap/carousel
 //= require bootstrap-tagsinput
 //= require social-share-button
+//= require jquery.serializejson
 
 //= require_tree .

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

@@ -1,38 +1,6 @@
 Spotlight.onLoad(function() {
   // Add Select/Deselect all button behavior
   addCheckboxToggleBehavior();
-
-  $("[data-in-place-edit-target]").on('click.inplaceedit', function() {
-    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');
-    $label.hide();
-    $input.val($label.text());
-    $input.attr('type', 'text');
-    $input.select();
-    $input.focus();
-
-    $input.on('keypress', function(e) {
-      if(e.which == 13) {
-        $input.trigger('blur.inplaceedit');
-        return false;
-      }
-    });
-
-    $input.on('blur.inplaceedit', 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;
-    });
-
-    return false;
-  });
 });
 
 // Add Select/Deselect all button behavior

data/app/assets/javascripts/spotlight/block_mixins/autocompleteable.js

@@ -0,0 +1,65 @@
+(function ($){
+  SirTrevor.BlockMixins.Autocompleteable = {
+    mixinName: "Autocompleteable",
+    preload: true,
+
+    initializeAutocompleteable: function() {
+      this.on("onRender", this.addAutocompletetoSirTrevorForm);
+
+      if (_.isUndefined(this['autocomplete_url'])) {
+        this.autocomplete_url = function() { return $('form[data-autocomplete-url]').data('autocomplete-url').replace("%25QUERY", "%QUERY"); };
+      }
+
+      if (_.isUndefined(this['autocomplete_template'])) {
+        this.autocomplete_url = function() { return '<div class="autocomplete-item{{#if private}} blacklight-private{{/if}}">{{#if thumbnail}}<div class="document-thumbnail thumbnail"><img src="{{thumbnail}}" /></div>{{/if}}<span class="autocomplete-title">{{title}}</span><br/><small>&nbsp;&nbsp;{{description}}</small></div>' };
+      }
+
+      if (_.isUndefined(this['transform_autocomplete_results'])) {
+        this.transform_autocomplete_results = _.identity;
+      }
+    },
+
+    autocomplete_control: function() {
+      return '<input type="text" class="st-input-string form-control item-input-field" data-twitter-typeahead="true" placeholder="<%= i18n.t("blocks:autocompleteable:placeholder")%>"/>';
+    },
+
+    addAutocompletetoSirTrevorForm: function() {
+      this.$('[data-twitter-typeahead]').spotlightSearchTypeAhead({bloodhound: this.bloodhound(), template: this.autocomplete_template()}).on('typeahead:selected typeahead:autocompleted', this.autocompletedHandler()).on( 'focus', function() {
+        if($(this).val() === '') {
+          $(this).data().ttTypeahead.input.trigger('queryChanged', '');
+        }
+      });
+    },
+
+    autocompletedHandler: function(e, data) {
+      var context = this;
+
+      return function(e, data) {
+        $(this).typeahead("val", "");
+        $(this).val("");
+
+        context.createItemPanel($.extend(data, {display: "true"}));
+      }
+    },
+
+    bloodhound: function() {
+      var block = this;
+      var results = new Bloodhound({
+        datumTokenizer: function(d) {
+          return Bloodhound.tokenizers.whitespace(d.title);
+        },
+        queryTokenizer: Bloodhound.tokenizers.whitespace,
+        limit: 10,
+        remote: {
+          url: block.autocomplete_url(),
+          filter: block.transform_autocomplete_results
+        }
+      });
+      results.initialize();
+      return results;
+    },
+  },
+
+
+  SirTrevor.Block.prototype.availableMixins.push("autocompleteable");
+})(jQuery);

data/app/assets/javascripts/spotlight/block_mixins/formable.js

@@ -0,0 +1,72 @@
+(function ($){
+  SirTrevor.BlockMixins.Formable = {
+    mixinName: "Formable",
+    preload: true,
+
+    initializeFormable: function() {
+      
+      if (_.isUndefined(this['afterLoadData'])) {
+        this['afterLoadData'] = function(data) { };
+      }
+    },
+    
+    formId: function(id) {
+      return this.blockID + "_" + id;
+    },
+
+    _serializeData: function() {
+      
+      var data = this.$(":input,textarea,select").not(':input:radio').serializeJSON();
+
+      this.$(':input:radio:checked').each(function(index, input) {
+        var key = $(input).data('key') || input.getAttribute('name');
+
+        if (!key.match("\\[")) {
+          data[key] = $(input).val();
+        }
+      });
+
+      /* Simple to start. Add conditions later */
+      if (this.hasTextBlock()) {
+        data.text = this.getTextBlockHTML();
+        if (data.text.length > 0 && this.options.convertToMarkdown) {
+          data.text = stToMarkdown(data.text, this.type);
+        }
+      }
+
+      return data;
+    },
+    
+    loadData: function(data){
+      if (this.hasTextBlock()) {
+        this.getTextBlock().html(SirTrevor.toHTML(data.text, this.type));
+      }
+      this.loadFormDataByKey(data);
+      this.afterLoadData(data);
+    },
+    
+    loadFormDataByKey: function(data) {
+      this.$(':input').not('button,:input[type=hidden]').each(function(index, input) {
+        var key = $(input).data('key') || input.getAttribute('name');
+
+        if (key) {
+        
+          if (key.match("\\[\\]$")) {
+            key = key.replace("[]", "");
+          }
+          
+          // by wrapping it in an array, this'll "just work" for radio and checkbox fields too
+          var input_data = data[key];
+
+          if (!(input_data instanceof Array)) {
+            input_data = [input_data];
+          }
+          $(this).val(input_data);
+        }
+      });
+    },
+  },
+  
+
+  SirTrevor.Block.prototype.availableMixins.push("formable");
+})(jQuery);

data/app/assets/javascripts/spotlight/block_mixins/previewable.js

@@ -0,0 +1,103 @@
+(function ($){
+  SirTrevor.PreviewButton = function() {
+    this._ensureElement();
+    this._bindFunctions();
+  }
+
+  SirTrevor.PreviewButton.prototype = Object.create(SirTrevor.BlockDeletion.prototype);
+
+  SirTrevor.PreviewButton.prototype.attributes = {
+    html: 'preview',
+    'data-icon': 'preview'
+  };
+
+  SirTrevor.PreviewButton.prototype.className = 'st-block-ui-btn st-block-ui-btn--preview st-icon';
+
+  SirTrevor.EditButton = function() {
+    this._ensureElement();
+    this._bindFunctions();
+  }
+
+  SirTrevor.EditButton.prototype = Object.create(SirTrevor.BlockDeletion.prototype);
+  
+  SirTrevor.EditButton.prototype.attributes = {
+    html: 'edit',
+    'data-icon': 'edit'
+  };
+
+  SirTrevor.EditButton.prototype.className = 'st-block-ui-btn st-block-ui-btn--edit st-icon';
+
+
+  SirTrevor.BlockMixins.Previewable = {
+
+    mixinName: "Previewable",
+
+    initializePreviewable: function() {
+      this.on("onRender", this.addPreviewButton);
+      
+      if (_.isUndefined(this['afterPreviewLoad'])) {
+        this.afterPreviewLoad = function() { };
+      }
+    },
+
+    addPreviewButton: function() {
+      this._prependUIComponent(new SirTrevor.PreviewButton(), '.st-block-ui-btn--preview', this.previewHandler())
+    },
+
+    _prependUIComponent: function(component, className, callback) {
+      this.$ui.prepend(component.render().$el);
+      if (className && callback) {
+        this.$ui.on('click', className, callback);
+      }
+    },
+    
+    previewButton: '<button class="st-block-ui-btn preview-btn"><%= i18n.t("blocks:previewable:title") %></button>',
+
+    previewUrl: function(context) { return context.$el.closest('[data-preview-url]').data('preview-url'); },
+
+    previewHandler: function() {
+      var context = this;
+
+      return function(event) {
+        event.stopPropagation();
+        var $btn = $(this);
+
+        $btn.attr('disabled', 'disabled');
+
+        $.post(context.previewUrl(context), { block: JSON.stringify(context.getData()) }, function(preview) {
+          context.renderPreview(preview).insertAfter(context.$inner);
+          context.$inner.hide();
+
+          context.afterPreviewLoad();
+        });
+      }
+    },
+
+    renderPreview: function(preview) {
+      var btn = new SirTrevor.EditButton().render().$el;
+      btn.on('click', this.editHandler(btn));
+
+      var widget_bar = $('<div class="st-block__ui" />').append(btn);
+
+      var inner = $('<div class="preview clearfix st-block__inner">');
+
+      return inner.append(preview).append(widget_bar);
+    },
+
+    editHandler: function(btn) {
+      var context = this;
+      var $btn = btn;
+
+      return function(event) {
+        event.stopPropagation();
+        context.$inner.show();
+        $(this).closest('.preview').remove();
+        $btn.removeAttr('disabled');
+      }
+    },
+  },
+  
+
+  SirTrevor.Block.prototype.availableMixins.push("previewable");
+  SirTrevor.Block.prototype.previewable = true;
+})(jQuery);