sufia 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f58a172c978631ed2850516f2ab9502cd114d61a
+  data.tar.gz: 1fd149a51495e374d2b9dab1baca7b121521fe2a
+SHA512:
+  metadata.gz: 57bc995e34962a7babd5c8c19e22ee51e96fdadefbbfc6c553b2d266183178df62b831f7c5fedee29309de2d4c5bbbeccbb06cd7678940f4f6a72e7b5eaee8c4
+  data.tar.gz: 34eb247bfe4bc0baf28dc6fcaecda85eac8b4025883b02ec85dc043be93b4cdc7e72403d20ed79d654dca114a2ef3be05061cf496071582a9529559d31fce626

data/.gitignore

@@ -7,6 +7,10 @@ config/hydra-ldap.yml
 config/redis.yml
 
 # bad gem etiquette, man
+.ruby-version
+.ruby-gemset
+ruby-version
+ruby-gemset
 .rvmrc
 Gemfile.lock
 

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+notifications:
+  irc: "irc.freenode.org#scholarsphere"

data/Gemfile

@@ -3,9 +3,11 @@ source 'http://rubygems.org'
 # Please see sufia.gemspec for dependency information.
 gemspec
 
-gem 'hydra-head', github: 'projecthydra/hydra-head'
-#gem 'mail_form', :git => 'git://github.com/psu-stewardship/mail_form.git', :ref => '50c00f0'
+# Required for doing pagination inside an engine. See https://github.com/amatsuda/kaminari/pull/322
+gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'
+
 group :development, :test do
+  gem 'activerecord-import', '0.3.0'
   gem 'sqlite3'
   gem 'selenium-webdriver'
   gem 'rspec-rails', '~> 2.12.0'
@@ -16,4 +18,5 @@ group :development, :test do
   gem 'bcrypt-ruby'
   gem "jettywrapper"
   gem "factory_girl_rails", "~> 4.1.0"
+  gem "simplecov", :require => false
 end # (leave this comment here to catch a stray line inserted by blacklight!)

data/History.md

@@ -0,0 +1,6 @@
+# History of Sufia releases
+
+## 1.0.0
+* Initial API-stable release
+
+

data/README.md

@@ -1,4 +1,44 @@
 # Sufia
+
+## Code Status
+
+[![Build Status](https://travis-ci.org/curationexperts/sufia.png?branch=master)](https://travis-ci.org/curationexperts/sufia)
+[![Dependencies Status](https://gemnasium.com/curationexperts/sufia.png)](https://gemnasium.com/curationexperts/sufia)
+
+## What is Sufia?
+Sufia is a component that adds self-deposit institutional repository features to a Rails app. 
+Sufia is created with Ruby on Rails and builds on the Hydra Framework.
+
+Sufia has the following features:
+
+* Multiple file, or folder, upload
+* Flexible user- and group-based access controls
+* Transcoding of audio and video files 
+* Generation and validation of identifiers
+* Fixity checking
+* Version control
+* Characterization of uploaded files
+* Forms for batch editing metadata
+* Faceted search and browse (based on Blacklight)
+* Social media interaction
+* User profiles
+* User dashboard for file management
+* Highlighted files on profile
+* Sharing w/ groups and users
+* User notifications
+* Activity streams
+* Background jobs
+* Single-use links
+
+Sufia needs the following software to work:
+* Solr
+* Fedora Commons
+* A SQL RDBMS (MySQL, SQLite)
+* Redis
+* Ruby
+
+
+
 ## Creating an application
 ### Generate base Rails install
 ```rails new my_app```

data/Rakefile

@@ -3,3 +3,7 @@
 require "bundler/gem_tasks"
 Dir.glob('tasks/*.rake').each { |r| import r }
 
+desc 'Run CI tests in Travis environment'
+task :travis => ['clean', 'ci']
+
+task :default => [:travis]

data/app/assets/javascripts/sufia.js

@@ -41,6 +41,9 @@ limitations under the License.
 //= require sufia/permissions
 //= require sufia/tabs
 //= require sufia/trophy
+//= require sufia/batch_select_all
+//= require sufia/multiForm
+//= require sufia/edit_metadata
 
 //over ride the blacklight default to submit
 //form when sort by or show per page change
@@ -86,121 +89,6 @@ $(function() {
         }
     });
   };
-    // there are two levels of vocabulary auto complete.
-    // currently we have this externally hosted vocabulary
-    // for geonames.  I'm not going to make these any easier
-    // to implement for an external url (it's all hard coded)
-    // because I'm guessing we'll get away from the hard coding
-  var cities_autocomplete_opts = {
-    source: function( request, response ) {
-      $.ajax( {
-        url: "http://ws.geonames.org/searchJSON",
-        dataType: "jsonp",
-        data: {
-          featureClass: "P",
-          style: "full",
-          maxRows: 12,
-          name_startsWith: request.term
-        },
-        success: function( data ) {        response( $.map( data.geonames, function( item ) {
-            return {
-              label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName,
-              value: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName
-            };
-          }));
-        },
-      });
-    },
-    minLength: 2
-  };
-  $("#generic_file_based_near").autocomplete(get_autocomplete_opts("location"));
-
-
-  function get_autocomplete_opts(field) {
-    var autocomplete_opts = {
-      minLength: 2,
-      source: function( request, response ) {
-        $.getJSON( "/authorities/generic_files/" + field, {
-          q: request.term
-        }, response );
-      },
-      focus: function() {
-        // prevent value inserted on focus
-        return false;
-      },
-      complete: function(event) {
-        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
-      }
-    };
-    return autocomplete_opts;
-  }
-
-  var autocomplete_vocab = new Object();
-
-  autocomplete_vocab.url_var = ['subject', 'language'];   // the url variable to pass to determine the vocab to attach to
-  autocomplete_vocab.field_name = new Array(); // the form name to attach the event for autocomplete
-  autocomplete_vocab.add_btn_id = new Array(); // the id of the button pressed when adding an additional form element
-
-  // loop over the autocomplete fields and attach the
-  // events for autocomplete and create other array values for autocomplete
-  for (var i=0; i < autocomplete_vocab.url_var.length; i++) {
-    autocomplete_vocab.field_name.push('generic_file_' + autocomplete_vocab.url_var[i]);
-    autocomplete_vocab.add_btn_id.push('additional_' + autocomplete_vocab.url_var[i] + '_submit');
-    // autocompletes
-    $("#" + autocomplete_vocab.field_name[i])
-        // don't navigate away from the field on tab when selecting an item
-        .bind( "keydown", function( event ) {
-            if ( event.keyCode === $.ui.keyCode.TAB &&
-                    $( this ).data( "autocomplete" ).menu.active ) {
-                event.preventDefault();
-            }
-        })
-        .autocomplete( get_autocomplete_opts(autocomplete_vocab.url_var[i]) );
-
-  }
-
-  /*
-   * adds additional metadata elements
-   */
-  $('.adder').click(function() {
-    var cloneId = this.id.replace("submit", "clone");
-    var newId = this.id.replace("submit", "elements");
-    var cloneElem = $('#'+cloneId).clone();
-    // change the add button to a remove button
-    var plusbttn = cloneElem.find('#'+this.id);
-    plusbttn.html('-<span class="accessible-hidden">remove this '+ this.name.replace("_", " ") +'</span>');
-    plusbttn.on('click',removeField);
-
-    // remove the help tag on subsequent added fields
-    cloneElem.find('.formHelp').remove();
-    cloneElem.find('i').remove();
-    cloneElem.find('.modal-div').remove();
-
-    //clear out the value for the element being appended
-    //so the new element has a blank value
-    cloneElem.find('input[type=text]').attr("value", "");
-    cloneElem.find('input[type=text]').attr("required", false);
-
-    // should we attach an auto complete based on the input
-    if (this.id == 'additional_based_near_submit') {
-      cloneElem.find('input[type=text]').autocomplete(cities_autocomplete_opts);
-    }
-    else if ( (index = $.inArray(this.id, autocomplete_vocab.add_btn_id)) != -1 ) {
-      cloneElem.find('input[type=text]').autocomplete(get_autocomplete_opts(autocomplete_vocab.url_var[index]));
-    }
-
-    $('#'+newId).append(cloneElem);
-    cloneElem.find('input[type=text]').focus();
-    return false;
-  });
-
-  $('.remover').click(removeField);
-
-  function removeField () {
-    // get parent and remove it
-    $(this).parent().remove();
-    return false;
-  }
 
   // show/hide more information on the dashboard when clicking
   // plus/minus

data/app/assets/javascripts/sufia/batch_select_all.js

@@ -0,0 +1,179 @@
+  // function to hide or show the batch update buttons based on how may items are checked
+  function toggleButtons(forceOn, otherPage ){
+    forceOn = typeof forceOn !== 'undefined' ? forceOn : false
+    otherPage = typeof otherPage !== 'undefined' ? otherPage : !window.batch_part_on_other_page;
+    var n = $(".batch_toggle:checked").length;
+    if ((n>0) || (forceOn)) {
+        $('.batch-select-all').show();
+        $('.button_to').show();
+    } else if ( otherPage){
+        $('.batch-select-all').hide();
+        $('.button_to').hide();
+    }
+    $("body").css("cursor", "auto");
+  }
+
+  function toggleState (obj, state) {
+    if (state == 'on'){
+      obj.attr("data-state", 'on');
+      obj.find('a i').addClass('icon-ok');
+    }else {
+      obj.attr("data-state", 'off');
+      obj.find('a i').removeClass('icon-ok');
+    }
+
+  }
+
+  function check_all_page(e) {
+     var checked = $("#check_all")[0]['checked'];
+
+     // only check the current page
+     var timeout = 0;
+     var timeoutInc = 60;
+     
+     $("input[type='checkbox'].batch_toggle").each(function(index, value) {
+        // check each individual box
+        var ck = value['checked'];
+        console.log("status for ");
+        console.log(value);
+        // not the same state click the box
+        if (checked != ck) {
+          console.log("click it");
+          window.parent.setTimeout(function(){value.click();},timeout);
+        }
+        timeout+=timeoutInc; 
+     });
+     window.parent.setTimeout(toggleButtons,timeout+500);     
+     $("#check_all").attr('checked', checked);
+  }
+
+  function clear_batch () {
+    var url = '<%=clear_batch_edits_path %>';
+    var clearState = $.ajax({
+      headers: {           
+           Accept : "application/javascript",          
+       },      
+      type: 'PUT',
+      url: url,
+      async: false,
+    });
+
+  }
+  
+  function set_all_checkboxes(checked){
+    $("input[type='checkbox'].batch_toggle").each(function(){
+      $(this).attr('checked', checked);   
+      
+      // make sure the form is set correctly
+      form = $($(this).parent()[0]);      
+      if (checked) {
+        form.find("input[name=_method]").val("delete");
+
+      } else {
+        form.find("input[name=_method]").val("put");
+      }
+    });
+    
+  }
+ 
+
+$(document).ready(function() { 
+
+  $("[data-behavior='batch-edit-select-page']").bind('click', function(e) {
+    $("body").css("cursor", "progress");
+    e.preventDefault();
+    $("#check_all").attr('checked', true);
+    toggleState($(this),'on');    
+    toggleState($("[data-behavior='batch-edit-select-all']"),'off');    
+    toggleState($("[data-behavior='batch-edit-select-none']"),'off');    
+    clear_batch();
+    
+    // uncheck everything on the current page
+    set_all_checkboxes(false);
+    
+    // check everything on the current page
+    check_all_page();
+    
+  });
+
+  $("[data-behavior='batch-edit-select-all']").bind('click', function(e) {
+    $("body").css("cursor", "progress");
+    e.preventDefault();
+    $("#check_all").attr('checked', true);
+    toggleState($(this), 'on');    
+    toggleState($("[data-behavior='batch-edit-select-page']"),'off');    
+    toggleState($("[data-behavior='batch-edit-select-none']"),'off');    
+    var url =  '<%=all_batch_edits_path %>';
+    var clearState = $.ajax({
+      headers: {           
+           Accept : "application/javascript",          
+       },      
+      type: 'PUT',
+      url: url,
+      async: false,
+    });
+    
+    // show that update on the local screen
+    set_all_checkboxes(true)
+    $("body").css("cursor", "auto");
+    toggleButtons(true);
+  });
+
+  $("[data-behavior='batch-edit-select-none']").bind('click', function(e) {
+    $("body").css("cursor", "progress");
+    e.preventDefault();
+    $("#check_all").attr('checked', false);
+    toggleState($(this), 'on');    
+    toggleState($("[data-behavior='batch-edit-select-page']"),'off');    
+    toggleState($("[data-behavior='batch-edit-select-all']"),'off');  
+    clear_batch();  
+
+    // show that update on the local screen
+    set_all_checkboxes(false)
+    $("body").css("cursor", "auto");
+    toggleButtons(false, true);
+  });
+
+  
+  
+  // check all buttons
+  $("#check_all").bind('click', check_all_page);
+  
+
+  $(".batch_toggle").bind('click', function(e) {
+
+      // if we are unchecking a box remove the group selections
+      if ($(e.currentTarget).attr('checked') != "checked") {
+        toggleState($("[data-behavior='batch-edit-select-all']"),'off');    
+        toggleState($("[data-behavior='batch-edit-select-page']"),'off');    
+        toggleState($("[data-behavior='batch-edit-select-none']"),'off');
+        $("#check_all").attr('checked', false);
+      }
+      // checking a single box see if we need to turn on one of the groups    
+      else {
+        var n = $(".batch_toggle:checked").length;
+        if (n == window.document_list_count) {
+            $("#check_all").attr('checked', true);
+            if (!window.batch_part_on_other_page) {
+              toggleState($("[data-behavior='batch-edit-select-page']"),'on');    
+            } else if ((n + window.batch_size_on_other_page) == window.result_set_size){
+              toggleState($("[data-behavior='batch-edit-select-all']"),'on');    
+            }
+        } else {            
+            if ((n + window.batch_size_on_other_page) == 0){
+              toggleState($("[data-behavior='batch-edit-select-none']"),'on');                 
+            }
+        }
+      }
+    });
+  
+});
+
+  // hide or show the batch update buttons file selections
+  function setup_buttontoggle(checkbox) {
+    checkbox.bind('click', function(e) {
+         e.preventDefault();
+         toggleButtons();
+     });  
+  }
+

data/app/assets/javascripts/sufia/edit_metadata.js

@@ -0,0 +1,86 @@
+$(function() {
+  function get_autocomplete_opts(field) {
+    var autocomplete_opts = {
+      minLength: 2,
+      source: function( request, response ) {
+        $.getJSON( "/authorities/generic_files/" + field, {
+          q: request.term
+        }, response );
+      },
+      focus: function() {
+        // prevent value inserted on focus
+        return false;
+      },
+      complete: function(event) {
+        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+      }
+    };
+    return autocomplete_opts;
+  }
+
+    // there are two levels of vocabulary auto complete.
+    // currently we have this externally hosted vocabulary
+    // for geonames.  I'm not going to make these any easier
+    // to implement for an external url (it's all hard coded)
+    // because I'm guessing we'll get away from the hard coding
+  var cities_autocomplete_opts = {
+    source: function( request, response ) {
+      $.ajax( {
+        url: "http://ws.geonames.org/searchJSON",
+        dataType: "jsonp",
+        data: {
+          featureClass: "P",
+          style: "full",
+          maxRows: 12,
+          name_startsWith: request.term
+        },
+        success: function( data ) {        response( $.map( data.geonames, function( item ) {
+            return {
+              label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName,
+              value: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName
+            };
+          }));
+        },
+      });
+    },
+    minLength: 2
+  };
+  $("#generic_file_based_near").autocomplete(get_autocomplete_opts("location"));
+
+  var autocomplete_vocab = new Object();
+
+  autocomplete_vocab.url_var = ['subject', 'language'];   // the url variable to pass to determine the vocab to attach to
+  autocomplete_vocab.field_name = new Array(); // the form name to attach the event for autocomplete
+  autocomplete_vocab.add_btn_id = new Array(); // the id of the button pressed when adding an additional form element
+
+  // loop over the autocomplete fields and attach the
+  // events for autocomplete and create other array values for autocomplete
+  for (var i=0; i < autocomplete_vocab.url_var.length; i++) {
+    autocomplete_vocab.field_name.push('generic_file_' + autocomplete_vocab.url_var[i]);
+    autocomplete_vocab.add_btn_id.push('additional_' + autocomplete_vocab.url_var[i] + '_submit');
+    // autocompletes
+    $("#" + autocomplete_vocab.field_name[i])
+        // don't navigate away from the field on tab when selecting an item
+        .bind( "keydown", function( event ) {
+            if ( event.keyCode === $.ui.keyCode.TAB &&
+                    $( this ).data( "autocomplete" ).menu.active ) {
+                event.preventDefault();
+            }
+        })
+        .autocomplete( get_autocomplete_opts(autocomplete_vocab.url_var[i]) );
+
+  }
+
+
+  function setup_autocomplete(obj, cloneElem) {
+    // should we attach an auto complete based on the input
+    if (obj.id == 'additional_based_near_submit') {
+      cloneElem.find('input[type=text]').autocomplete(cities_autocomplete_opts);
+    }
+    else if ( (index = $.inArray(obj.id, autocomplete_vocab.add_btn_id)) != -1 ) {
+      cloneElem.find('input[type=text]').autocomplete(get_autocomplete_opts(autocomplete_vocab.url_var[index]));
+    }
+  }
+
+  $('form').multiForm({afterAdd: setup_autocomplete});
+});