blacklight_folders 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27067bbaefd718b0c485c4c1f13941fcb53a6e8b
+  data.tar.gz: cbb26a51baaed6c6f17f499d1d46b47254f6c669
+SHA512:
+  metadata.gz: 5cd3259a5737051c56a80e8346d48b7379062141b285baa1b2abae6917470c8e4c41a1134855627674f16b1745e837f279e1d058265eef06990088fc58c560e5
+  data.tar.gz: d7f809c3483b7c176083f6f5b1cfd6d2fb12a4e578f086289b293e87d44d0e24fe5239b09f8138a265bfbf95fff19979d171122004966ea6822ef878d559b14a

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2014 Indiana University, Data Curation Experts
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.rdoc

@@ -0,0 +1,50 @@
+{<img src="https://travis-ci.org/projectblacklight/blacklight_folders.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/projectblacklight/blacklight_folders]
+= Blacklight Folders
+{<img src="https://cloud.githubusercontent.com/assets/92044/5508092/f2ad37b0-876e-11e4-8f73-f08afe23c17b.png" alt="screenshot" />}[https://cloud.githubusercontent.com/assets/92044/5508092/f2ad37b0-876e-11e4-8f73-f08afe23c17b.png]
+---
+{<img src="https://cloud.githubusercontent.com/assets/92044/5416801/a437a8c0-81f8-11e4-9285-01d230caf80c.png" alt="screenshot" />}[https://cloud.githubusercontent.com/assets/92044/5416801/a437a8c0-81f8-11e4-9285-01d230caf80c.png]
+---
+{<img src="https://cloud.githubusercontent.com/assets/92044/5416800/a434b49e-81f8-11e4-85a0-d302aa5c7e24.png" alt="screenshot" />}[https://cloud.githubusercontent.com/assets/92044/5416800/a434b49e-81f8-11e4-85a0-d302aa5c7e24.png]
+---
+
+== To create a new blacklight application with blacklight_folders
+
+* Create a new rails application
+
+* Add the <code>blacklight</code> gem and the <code>blacklight_folders</code> gem to your Gemfile
+
+* Run <code>bundle install</code>
+
+* Run the blacklight generator with the <code>--devise</code> switch, following the {instructions on the blacklight wiki}[https://github.com/projectblacklight/blacklight/wiki/Quickstart#creating-a-new-application-the-hard-way] to set up your blacklight app. _NOTE:_ If you're using blacklight_folders for a library catalog, you probably want the <code>--marc</code> switch as well; if you're running it locally (for testing, etc.), you probably want the <code>--jettywrapper</code> switch too. 
+
+    $ rails g blacklight:install --devise --marc --jettywrapper
+
+* Run the blacklight_folders generator
+
+    $ rails g blacklight_folders:install
+
+== To add blacklight_folders to an existing blacklight application
+
+* Add the <code>blacklight_folders</code> gem to your Gemfile, and run <code>bundle install</code>
+
+* Run the blacklight_folders generator
+
+    $ rails g blacklight_folders:install
+
+==== Migrate Existing Data
+
+* If your blacklight app has existing users that already have bookmarks saved, run the migration task to add each user's existing bookmarks to their default folder.
+
+    $ rake blacklight_folders:db:migrate_data
+
+== Configuration
+
+* By default, the user's 5 most recently updated folders will appear in the drop-down menu in the navigation bar.  If you want to change the number of folders that appear in the list, you can set the MENU_LIMIT constant in an initializer (config/initializers/blacklight_folders.rb).
+
+        Blacklight::Folders::Folder::MENU_LIMIT = 5
+
+* If you wish to change the name of each user's default folder, override the entry for <code>default_folder_name</code> in the localization files, using the <code>config/locales/blacklight_folders.en.yml</code> file as an example.
+
+---
+
+{Developers Guide}[https://github.com/projectblacklight/blacklight_folders/wiki/Developer-Guide]

data/Rakefile

@@ -0,0 +1,68 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'engine_cart/rake_task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blacklight::Folders'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.6.0.zip"
+require 'jettywrapper'
+
+task :default => [:spec]
+
+
+desc "Clean out the test rails app"
+task :clean => ['engine_cart:clean', 'jetty:clean'] do
+end
+
+
+desc "Run test suite"
+task :ci => ['clean', 'jetty:add_test_core'] do
+  jetty_params = Jettywrapper.load_config('test')
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['engine_cart:generate'].invoke
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
+
+namespace :jetty do
+
+  desc 'Add test-core to solr for test environment'
+  task :add_test_core do
+    require 'nokogiri'
+
+    # copy config files
+    FileUtils.mkdir_p('jetty/solr/test-core/conf')
+    FileList['jetty/solr/blacklight-core/conf/*'].each do |f|
+      cp_r("#{f}", 'jetty/solr/test-core/conf/', :verbose => true)
+    end
+
+    # add test-core to solr.xml
+    file = File.read("jetty/solr/solr.xml")
+    doc = Nokogiri::XML(file)
+    blacklight = doc.at_css("core[name='blacklight-core']")
+    test = blacklight.clone
+    test['name'] = 'test'
+    test['instanceDir'] = 'test-core'
+    blacklight.add_next_sibling(test)
+    File.open("jetty/solr/solr.xml", "w") do |f|
+      f.write doc.to_xml
+    end
+  end
+end

data/app/assets/javascripts/blacklight_folders/catalog/edit.js

@@ -0,0 +1,28 @@
+// This is for the catalog show page
+BlacklightFolders.FolderEditController = function(elem) {
+  this.$form = $('form.folder-actions', elem);
+  this.$select = $('select', this.$form);
+
+  var addAutocomplete = this.addAutocomplete;
+  $.each(this.$select, function(_, select){
+    addAutocomplete(select);
+  });
+}
+
+BlacklightFolders.FolderEditController.prototype = {
+  addAutocomplete: function(select) {
+    select = $(select);
+
+    // Remove the bootstrap class so that select2 can apply its own styles
+    select.removeClass('form-control');
+
+    // The first element has a prompt. We remove it from the list.
+    var element = $('option:first-child', select);
+    var label = element.text();
+    element.empty();
+
+    select.select2({placeholder: label});
+  }
+}
+
+Blacklight.onLoad(function() { new BlacklightFolders.FolderEditController($('.blacklight-folders-edit')) });

data/app/assets/javascripts/blacklight_folders/catalog/index.js

@@ -0,0 +1,65 @@
+// This is for the catalog index page
+BlacklightFolders.CatalogIndexController = function(elem) {
+  if (elem.length == 0) {
+    return null;
+  }
+
+  this.$element = elem
+  this.$checkboxes = $('input[type=checkbox][name="folder_ids[]"]', elem);
+  this.$form = $('form[data-behavior=move-to-folder]', elem);
+  this.$select = $('select', this.$form);
+  this.$hidden = $('input[name="document_ids"]', this.$form);
+
+  this.addControls();
+  this.addAutocomplete();
+  this.attachEvents();
+}
+
+BlacklightFolders.CatalogIndexController.prototype = {
+  addControls: function() {
+    this.$checkboxes.show();
+  },
+
+  addAutocomplete: function() {
+    // Remove the bootstrap class so that select2 can apply its own styles
+    this.$select.removeClass('form-control');
+    // The first element has a prompt. We remove it from the list.
+    var element = $('option:first-child', this.$select);
+    var label = element.text();
+    element.empty();
+    this.$select.select2({placeholder: label});
+  },
+
+
+  showForm: function() {
+    this.$form.show();
+  },
+
+  hideForm: function() {
+    this.$form.hide();
+  },
+
+  showOrHideForm: function () {
+    if (this.$checkboxes.is(":checked")) {
+      this.showForm();
+    } else {
+      this.hideForm();
+    }
+  },
+
+  submit: function(event) {
+    var folder_id = $(event.currentTarget).val();
+    var vals = $.map(this.$checkboxes.filter(':checked'), function(e) { return $(e).val(); })
+    this.$hidden.val(vals.join());
+    this.$form.submit();
+  },
+
+  attachEvents: function() {
+    that = this;
+    this.$checkboxes.on('change', function() { that.showOrHideForm(); });
+    this.$select.on('change', function(event) { that.submit(event); });
+  }
+
+}
+
+Blacklight.onLoad(function() { new BlacklightFolders.CatalogIndexController($('.blacklight-catalog-index')) });

data/app/assets/javascripts/blacklight_folders/catalog/show.js

@@ -0,0 +1,27 @@
+// This is for the catalog show page
+BlacklightFolders.CatalogShowController = function(elem) {
+  if (elem.length == 0) {
+    return null;
+  }
+
+  this.$element = elem
+  this.$form = $('.show-tools .folder form', elem);
+  this.$select = $('select', this.$form);
+
+  this.addAutocomplete();
+}
+
+BlacklightFolders.CatalogShowController.prototype = {
+  addAutocomplete: function() {
+    // Remove the bootstrap class so that select2 can apply its own styles
+    this.$select.removeClass('form-control');
+    // The first element has a prompt. We remove it from the list.
+    var element = $('option:first-child', this.$select);
+    var label = element.text();
+    element.empty();
+    this.$select.select2({placeholder: label});
+  }
+}
+
+Blacklight.onLoad(function() { new BlacklightFolders.CatalogShowController($('.blacklight-catalog-show')) });
+

data/app/assets/javascripts/blacklight_folders/catalog.js

@@ -0,0 +1 @@
+BlacklightFolders = {}

data/app/assets/javascripts/blacklight_folders/folder_items.js

@@ -0,0 +1,36 @@
+// This is for the folders edit page
+Blacklight.onLoad(function(){
+
+  // Display the drag handle
+  $('.dd-handle').removeClass('hidden');
+
+  // Initialize drag-and-drop behavior
+  $('.dd').nestable({ maxDepth: 1, dropCallback: function(data){
+    allItemsData = $('.dd').nestable('serialize');
+    itemsContainer = $('.dd');
+    reorderItems(allItemsData, itemsContainer);
+  } });
+
+  var reorderItems = function(data, container) {
+    var folderId = container.data('folder_id');
+    var items = data;
+    for(var i in data){
+      items[i]['position'] = (parseInt(i) + 1).toString();
+    }
+
+    $.ajax({
+      type: "PATCH",
+      url: '/blacklight/folders/' + folderId + '.json',
+      data: { folder: {items_attributes: items}},
+      success: function(data, status){
+      }
+    });
+
+    // Update the position text in the form
+    var textElements = $('.dd .position-input');
+    for(var i in textElements) {
+      textElements[i].value = parseInt(i) + 1;
+    }
+  };
+
+});

data/app/assets/javascripts/blacklight_folders/sort.js

@@ -0,0 +1,10 @@
+/*
+ * Sort the list of folders when the dropdown is changed
+ *
+ */
+
+Blacklight.onLoad(function() {
+  $('#order_by').change(function() {
+    $(this).closest('form').submit();
+  });
+});

data/app/assets/javascripts/blacklight_folders.js

@@ -0,0 +1,8 @@
+//= require blacklight_folders/sort
+//= require blacklight_folders/catalog
+//= require blacklight_folders/catalog/index
+//= require blacklight_folders/catalog/show
+//= require blacklight_folders/catalog/edit
+//= require blacklight_folders/folder_items
+//= require jquery.nestable
+//= require select2

data/app/assets/stylesheets/blacklight_folders/_blacklight_folders.css.scss

@@ -0,0 +1,4 @@
+@import 'select2';
+@import "blacklight_folders/forms";
+@import "blacklight_folders/folders";
+@import "blacklight_folders/nestable";

data/app/assets/stylesheets/blacklight_folders/_folders.css.scss

@@ -0,0 +1,56 @@
+$table-border-color: #dddddd;
+$table_border: 1px dotted $table-border-color;
+
+.folder-index {
+  #sort-tool {
+    margin-top: 30px
+  }
+}
+
+.folder-view {
+  .bookmarkTools {
+    margin-top: 20px;
+  }
+}
+
+.blacklight-folders-edit {
+  ol {
+    list-style-type: none;
+    border: 1px solid $table-border-color;
+    padding: 0;
+    margin-top: 20px;
+
+    li {
+      padding: 5px;
+      margin: 0;
+      border-top:    $table_border;
+
+      .title {
+        padding-top: 6px;
+        padding-left: 0;
+      }
+    }
+
+    li:first-child {
+      border-top: none;
+    }
+  }
+}
+
+.glyphicon-unlock:before {
+  // The Bootstrap halflings doesn't have the unlock icon, so we'll use the globe
+  // You should be able to override this if you meet the license terms for
+  // glyphicons. See: http://glyphicons.com/license/
+  content: "\e135"
+}
+
+#folder-tools {
+  margin-top: 5px;
+  height: 25px;
+}
+
+.position-input {
+  width: 40%;
+  text-align: center;
+}
+

data/app/assets/stylesheets/blacklight_folders/_forms.css.scss

@@ -0,0 +1,11 @@
+
+.actions {
+  padding: 1px;
+  margin-top: 1em;
+  @extend .clearfix;
+}
+
+.primary-actions {
+  margin-top: 3px;
+  @extend .pull-right;
+}

data/app/assets/stylesheets/blacklight_folders/_nestable.css.scss

@@ -0,0 +1,129 @@
+// Drag and drop elements for 'nestable' gem
+
+.dd {
+  position: relative;
+  display: block;
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+tbody.dd-list {
+  display: table-row-group;
+  padding-left: 0;
+}
+
+tbody.dd-dragel {
+  display: table;
+}
+
+li.dd-item {
+  list-style: none;
+}
+
+tr.dd-item {
+  display: table-row;
+  position: relative;
+}
+
+.dd-list { display: block; position: relative; margin: 0; padding: 0; list-style: none; }
+.dd-list .dd-list { padding-left: 30px; }
+.dd-collapsed .dd-list { display: none; }
+
+.dd-item,
+.dd-empty,
+.dd-placeholder { display: block; position: relative; margin: 0; padding: 0; min-height: 20px; line-height: 20px; }
+
+.dd-handle {
+    display: inline-block;
+    height: 100%;
+    margin: 0 0.2em 0 0;
+    padding: 5px 10px;
+    color: #333;
+    text-decoration: none;
+    text-align: center;
+    font-size: 1.5em;
+    font-weight: bold;
+    border: 1px solid #ccc;
+    background: #fafafa;
+    background: -webkit-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:    -moz-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:         linear-gradient(top, #fafafa 0%, #eee 100%);
+    -webkit-border-radius: 3px;
+            border-radius: 3px;
+    box-sizing: border-box; -moz-box-sizing: border-box;
+}
+.dd-handle:hover {
+  color: #2ea8e5;
+  background: #fff;
+  cursor: grab;
+}
+
+.dd-item > button { display: block; position: relative; cursor: pointer; float: left; width: 25px; height: 20px; margin: 5px 0; padding: 0; text-indent: 100%; white-space: nowrap; overflow: hidden; border: 0; background: transparent; line-height: 1; text-align: center; font-weight: bold; }
+.dd-item > button:before { content: '+'; display: block; position: absolute; width: 100%; text-align: center; text-indent: 0; }
+.dd-item > button[data-action="collapse"]:before { content: '-'; }
+
+.dd-placeholder,
+.dd-empty { margin: 5px 0; padding: 0; min-height: 30px; border: 1px dashed #b6bcbf; box-sizing: border-box; -moz-box-sizing: border-box; }
+.dd-empty { border: 1px dashed #bbb; min-height: 100px; 
+    background-image: -webkit-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff), 
+                      -webkit-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-image:    -moz-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff), 
+                         -moz-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-image:         linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff), 
+                              linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-size: 60px 60px;
+    background-position: 0 0, 30px 30px;
+}
+
+.dd-dragel { position: absolute; pointer-events: none; z-index: 9999; }
+.dd-dragel > .dd-item .dd-handle { margin-top: 0; }
+.dd-dragel .dd-handle {
+    -webkit-box-shadow: 2px 4px 6px 0 rgba(0,0,0,.1);
+            box-shadow: 2px 4px 6px 0 rgba(0,0,0,.1);
+}
+
+/**
+ * Nestable Extras
+ */
+
+.nestable-lists { display: block; clear: both; padding: 30px 0; width: 100%; border: 0; border-top: 2px solid #ddd; border-bottom: 2px solid #ddd; }
+
+
+.dd-hover > .dd-handle { background: #2ea8e5 !important; }
+
+/**
+ * Nestable Draggable Handles
+ */
+
+.dd3-content { display: block; margin: 5px 0; padding: 0 0 0 30px;
+    background: #fafafa;
+    background: -webkit-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:    -moz-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:         linear-gradient(top, #fafafa 0%, #eee 100%);
+    -webkit-border-radius: 3px;
+            border-radius: 3px;
+    box-sizing: border-box; -moz-box-sizing: border-box;
+}
+.dd3-content.page-admin {
+  position: relative;
+}
+.dd3-content .panel-body {background: white;}
+.dd-dragel > .dd3-item > .dd3-content { margin: 0; }
+
+.dd3-item > button { margin-left: 30px; }
+
+.dd3-handle { 
+    position: absolute; margin: 0; left: 0; top: 0; cursor: pointer; width: 30px;
+    text-indent: 100px;
+    white-space: nowrap; overflow: hidden;
+    border: 1px solid #aaa;
+    background: #ddd;
+    background: -webkit-linear-gradient(top, #ddd 0%, #bbb 100%);
+    background:    -moz-linear-gradient(top, #ddd 0%, #bbb 100%);
+    background:         linear-gradient(top, #ddd 0%, #bbb 100%);
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+}
+.dd3-handle:before { content: '≡'; display: block; position: absolute; left: 0; top: 9px; width: 100%; text-align: center; text-indent: 0; color: #fff; font-weight: normal; }
+.dd3-handle:hover { background: #ddd; }

data/app/controllers/blacklight/folders/application_controller.rb

@@ -0,0 +1,11 @@
+module Blacklight::Folders
+
+  # Inherit from the main app's ApplicationController
+  # so that we can inherit the main app's layout.
+  class ApplicationController < ::ApplicationController
+
+    include Blacklight::Folders::ApplicationControllerBehavior
+    check_authorization
+
+  end
+end