curation_concerns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89dd4ec9b6787f7448fa599e2d5ea3cd9ebc898f
+  data.tar.gz: 714d172c38c6b1201fe0f63bad2ce359f61073f4
+SHA512:
+  metadata.gz: 9658ecf651db9a338b058255881c6d536732bc9b4850574f94c9ee525e7e29df3b797d7e28d54aea6902836158e66ed0b95592fd38e17b220422dd6e7f29f4d1
+  data.tar.gz: 0e99bc7eaa29b260ceef72c541a75cd3ef72663f3152c290874ed2951d43e2f519fdc9bfd72f75bf2d21b215091ecc1a78262b126c8090d50100ddd9caf1fceb

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rbc
+.bundle
+Gemfile.lock
+coverage
+pkg
+tmp
+*.bundle
+spec/internal
+jetty
+.rvmrc
+.ruby-*
+./spec/internal
+.DS_store

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.2
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+notifications:
+  email:
+    recipients:
+      - "eliotj@princeton.edu"
+      - "kr2@princeton.edu"
+      - "jstroop@princeton.edu"
+    on_success: "change"
+    on_failure: "always"
+    template:
+      - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"

data/Gemfile

@@ -0,0 +1,31 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in curation_concerns.gemspec
+gemspec
+
+gem 'slop', '~> 3.6.0' # This just helps us generate a valid Gemfile.lock when Rails 4.2 is installed (which requires byebug which has a dependency on slop)
+
+gem 'curation_concerns-models', path: './curation_concerns-models'
+
+group :test do
+  gem 'simplecov', '~> 0.9', require: false
+  gem 'coveralls', require: false
+  gem 'poltergeist'
+end
+
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+else
+  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] !~ /^4.2/
+    gem 'sass-rails', "< 5.0"
+  else
+    gem 'responders', "~> 2.0"
+    gem 'sass-rails', ">= 5.0"
+  end
+
+  extra_file = File.expand_path("../spec/test_app_templates/Gemfile.extra", __FILE__)
+  instance_eval File.read(extra_file)
+end

data/LICENSE.txt

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2014 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.md

@@ -0,0 +1,46 @@
+# Curation Concern
+[![Build Status](https://travis-ci.org/projecthydra-labs/curation_concerns.svg?branch=master)](https://travis-ci.org/projecthydra-labs/curation_concerns)
+[![Coverage Status](https://coveralls.io/repos/projecthydra-labs/curation_concerns/badge.svg?branch=master)](https://coveralls.io/r/projecthydra-labs/curation_concerns?branch=master)
+
+A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) CurationConcern objects (a.k.a. "Works") and provides a generator for defining new CurationConcern types with custom workflow, views, access controls, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'curation_concerns'
+
+And then execute:
+
+    $ bundle
+
+Then:
+
+    $ rails generate curation_concerns:install
+    $ rake db:migrate
+
+# Usage
+
+## Generator
+
+To generate a new CurationConcern type, use the `curation_concerns:work` rails generator.  Follow the Usage instructions provided on the command line when you run:
+
+    rails generate curation_concerns:work
+
+## Virus Detection
+
+To turn on virus detection, install clamav on your system and add the `clamav` gem to your Gemfile
+
+    gem 'clamav'
+
+## Testing
+
+If you are modifying the curation_concerns gem and want to run the test suite, follow these steps to set up the test environment.
+
+```
+    $ rake engine_cart:generate
+    $ rake jetty:clean
+    $ rake curation_concerns:jetty:config
+    $ rake jetty:start
+    $ rake spec
+```

data/RELEASING.md

@@ -0,0 +1,2 @@
+* Bump version number in VERSION
+* Release the gem to rubygems.org: rake all:release

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+require 'jettywrapper'
+require 'engine_cart/rake_task'
+Jettywrapper.hydra_jetty_version = "v8.3.1"
+
+# This makes it possible to run curation_concerns:jetty:config from here.
+import 'curation_concerns-models/lib/tasks/curation_concerns-models_tasks.rake'
+
+task ci: ['engine_cart:generate', 'jetty:clean'] do
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait]= 90
+
+  Jettywrapper.wrap(jetty_params) do
+    # run the tests
+    Rake::Task["spec"].invoke
+  end
+end
+
+task clean: 'engine_cart:clean'
+task default: :ci

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,18 @@
+//= require jquery-ui-1.9.2/jquery.ui.widget
+//= require jquery-ui-1.9.2/jquery.ui.core
+//= require jquery-ui-1.9.2/jquery.ui.menu
+//= require jquery-ui-1.9.2/jquery.ui.position
+//= require jquery-ui-1.9.2/jquery.ui.autocomplete
+//
+//= require blacklight/blacklight
+//
+//= require bootstrap/dropdown
+//= require bootstrap/button
+//= require bootstrap/collapse
+//= require bootstrap/tooltip
+//= require bootstrap/popover
+//= require bootstrap/tab
+//
+//= require handlebars
+//= require jquery.tokeninput
+//= require curation_concerns/curation_concerns

data/app/assets/javascripts/curation_concerns/browse_everything_implement.js

@@ -0,0 +1,7 @@
+$(document).on('page:change', function() {
+	$('#browse').browseEverything()
+			.done(function(data) {
+				$('#status').html(data.length.toString() + " items selected")
+			})
+			.cancel(function()   { window.alert('Canceled!') });
+});

data/app/assets/javascripts/curation_concerns/curation_concerns.js

@@ -0,0 +1,28 @@
+//= require hydra-editor/hydra-editor
+//= require curation_concerns/help_modal
+//= require curation_concerns/select_works
+//= require curation_concerns/link_users
+//= require curation_concerns/link_groups
+//= require curation_concerns/proxy_rights
+//= require curation_concerns/facet_mine
+//= require curation_concerns/proxy_submission
+//= require curation_concerns/embargoes
+
+
+// Initialize plugins and Bootstrap dropdowns on jQuery's ready event as well as
+// Turbolinks's page change event.
+Blacklight.onLoad(function() {
+  $('abbr').tooltip();
+  $('.link-users').linkUsers();
+  $('.link-groups').linkGroups();
+  $('.proxy-rights').proxyRights();
+
+
+//  $('#set-access-controls .datepicker').datepicker({
+//    format: 'yyyy-mm-dd',
+//    startDate: '+1d'
+//  });
+
+  $("[data-toggle='dropdown']").dropdown();
+
+});

data/app/assets/javascripts/curation_concerns/embargoes.js

@@ -0,0 +1,17 @@
+Blacklight.onLoad(function () {
+  $("[data-behavior=\"extra\"]").hide()
+  function reveal(id) {
+    $("[data-behavior=\"extra\"][data-id=\"" + id + "\"]").show();
+  }
+
+  function hide(id) {
+    $("[data-behavior=\"extra\"][data-id=\"" + id + "\"]").hide();
+  }
+  $(".batch_document_selector").click(function() {
+    if (this.checked) {
+      reveal($(this).attr('value'));
+    } else {
+      hide($(this).attr('value'));
+    }
+  })
+});

data/app/assets/javascripts/curation_concerns/facet_mine.js

@@ -0,0 +1,22 @@
+//= require blacklight/core
+(function($) {
+  var facet_mine_behavior = function() {
+    $('#aux-search-submit-header').hide();
+
+    $('input[name="works"]').on("change", function(e) {
+      $(this).closest('form').submit();
+    });
+
+  };  
+
+
+  // TODO when we upgrade blacklight to 4.4+, we can use Blacklight.onLoad()
+  if (typeof Turbolinks !== "undefined") {
+    $(document).on('page:load', function() {
+      facet_mine_behavior();  
+    });
+  }
+  $(document).ready(function() {
+    facet_mine_behavior();  
+  });
+})(jQuery);

data/app/assets/javascripts/curation_concerns/help_modal.js

@@ -0,0 +1,36 @@
+$(function(){
+  var $window = $(window),
+      $modal = $('#ajax-modal'),
+      resolution = screen.width + 'x' + screen.height,
+      viewport = $window.width() + 'x' + $window.height(),
+      current_url = document.location.href;
+
+  function populateHelpForm(){
+    // Removing the "NOT" portion
+    $('#help-js strong').remove();
+    $('#help_request_javascript_enabled').val(1);
+
+    $('#help-resolution').text(resolution);
+    $('#help_request_resolution').val(resolution);
+
+    $('#help-viewport').text(viewport);
+    $('#help_request_view_port').val(viewport);
+
+    $('#help-url').text(current_url);
+    $('#help_request_current_url').val(current_url);
+  }
+  populateHelpForm();
+
+  $('.request-help').on('click', function(event){
+    event.preventDefault();
+
+    $('body').modalmanager('loading');
+
+    setTimeout(function(){
+      $modal.load('/help_requests/new #new_help_request', function(){
+        $modal.modal();
+        populateHelpForm();
+      });
+    }, 1000);
+  });
+});

data/app/assets/javascripts/curation_concerns/link_groups.js.coffee

@@ -0,0 +1,123 @@
+(($, window, document) ->
+  $this = undefined
+ 
+  # default settings
+  _settings =
+    default: 'cool!'
+    
+  _remover = $("<button class=\"btn btn-danger remove\"><i class=\"icon-white glyphicon-minus\"></i><span>Remove</span></button>")
+  _adder   = $("<button class=\"btn btn-success add\"><i class=\"icon-white glyphicon-plus\"></i><span>Add</span></button>")
+  
+ 
+  # This is your public API (no leading underscore, see?)
+  # All public methods must return $this so your plugin is chainable.
+  methods =
+    init: (options) ->
+      $this = $(@)
+      # The settings object is available under its name: _settings. Let's
+      # expand it with any custom options the user provided.
+      $.extend _settings, (options or {})
+      # Do anything that actually inits your plugin, if needed, right now!
+      # An important thing to keep in mind, is that jQuery plugins should be
+      # built so that one can apply them to more than one element, like so:
+      #
+      #  $('.matching-elements, #another-one').foobar()
+      #
+      
+      #This code sets up all the "Add" and "Remove" buttons for the autocomplete fields.
+      
+      #For each autocomplete set on the page, add the "Add" and "Remove" buttons
+      $this.each (index, el) ->
+        $('.autocomplete-groups').each (index, el) ->
+          _internals.autocompleteGroups(el)
+        
+        #Make sure these buttons have unique id's
+        _adder.id = "adder_" + index
+        _remover.id = "remover_" + index
+        
+        #Add the "Remove" button       
+        $('.field-wrapper:not(:last-child) .field-controls', this).append(_remover.clone())
+        
+        #Add the "Add" button
+        $('.field-controls:last', this).append(_adder.clone())
+        
+        #Bind the buttons to onClick events
+        $(el).on 'click', 'button.add', (e) ->
+          _internals.addToList(this)
+        $(el).on 'click', 'button.remove', (e) ->
+          _internals.removeFromList(this)
+        
+      return $this
+ 
+    # This method is often overlooked.
+    destroy: ->
+      # Do anything to clean it up (nullify references, unbind events…).
+      return $this
+ 
+  _internals =
+    addToList: (el) ->
+      $activeControls = $(el).closest('.field-controls')
+      $listing = $activeControls.closest('.listing')
+      $('.add', $activeControls).remove()
+      $removeControl = _remover.clone()
+      $activeControls.prepend($removeControl)
+      _internals.newRow($listing, el)
+      false
+
+    newRow: ($listing, el) ->
+      $listing.append _internals.newListItem($('li', $listing).size(), $listing, el)
+      _internals.autocompleteGroups($('.autocomplete-groups:last', $listing))
+
+
+    removeFromList: (el) ->
+      $currentGroup = $(el).closest('li')
+      $listing = $currentGroup.closest('.listing')
+      $currentGroup.hide()
+      # set the destroy flag
+      $('input:not([value])', $currentGroup).val('true')
+      false
+
+    newListItem: (index, el) ->
+      ## We have multiple places in a view where we need these autocomplete fields
+      ## (Work edit view for example), so we don't want to use the first #entry-template.
+      ## Using .closest isn't working, but this seems to for now.
+      source   =  $(el).parent().children().html()
+      template = Handlebars.compile(source)
+      template({index: index})
+
+    addExistingGroup: ($listItem, value, label) ->
+      source   = $listItem.parent().prev().html()
+      template = Handlebars.compile(source)
+      $list = $listItem.closest('ul')
+      $('input[required]', $list).removeAttr('required')
+      $listItem.replaceWith template({index: $('li', $list).index($listItem), value: value, label: label})
+      _internals.newRow($list)
+
+    autocompleteGroups: (el) ->
+      $targetElement = $(el)
+      $targetElement.autocomplete
+        source: (request, response) ->
+          $targetElement.data('url')
+          $.getJSON $targetElement.data('url'), { q: request.term + "*" }, ( data, status, xhr ) ->
+            matches = []
+            $.each data.response.docs, (idx, val) ->
+              matches.push {label: val['title_tesim'][0], value: val['id']}
+            response( matches )
+        minLength: 2
+        focus: ( event, ui ) ->
+          $targetElement.val(ui.item.label)
+          event.preventDefault()
+        select: ( event, ui ) ->
+          _internals.addExistingGroup($targetElement.closest('li'), ui.item.value, ui.item.label)
+          $targetElement.val('')
+          event.preventDefault()
+
+ 
+  $.fn.linkGroups = (method) ->
+    if methods[method]
+      methods[method].apply this, Array::slice.call(arguments, 1)
+    else if typeof method is "object" or not method
+      methods.init.apply this, arguments
+    else
+      $.error "Method " + method + " does not exist on jquery.linkGroups"
+) jQuery, window, document

data/app/assets/javascripts/curation_concerns/link_users.js.coffee

@@ -0,0 +1,126 @@
+(($, window, document) ->
+  $this = undefined
+ 
+  # default settings
+  _settings =
+    default: 'cool!'
+    
+  _remover = $("<button class=\"btn btn-danger remove\"><i class=\"icon-white icon-minus\"></i><span>Remove</span></button>")
+  _adder   = $("<button class=\"btn btn-success add\"><i class=\"icon-white icon-plus\"></i><span>Add</span></button>")
+  
+ 
+  # This is your public API (no leading underscore, see?)
+  # All public methods must return $this so your plugin is chainable.
+  methods =
+    init: (options) ->
+      $this = $(@)
+      # The settings object is available under its name: _settings. Let's
+      # expand it with any custom options the user provided.
+      $.extend _settings, (options or {})
+      # Do anything that actually inits your plugin, if needed, right now!
+      # An important thing to keep in mind, is that jQuery plugins should be
+      # built so that one can apply them to more than one element, like so:
+      #
+      #  $('.matching-elements, #another-one').foobar()
+      #
+      
+      #This code sets up all the "Add" and "Remove" buttons for the autocomplete fields.
+      
+      #For each autocomplete set on the page, add the "Add" and "Remove" buttons
+      $this.each (index, el) ->
+        $('.autocomplete-users').each (index, el) ->
+          _internals.autocompleteUsers(el)
+        
+        #Make sure these buttons have unique id's
+        _adder.id = "adder_" + index
+        _remover.id = "remover_" + index
+        
+        #Add the "Remove" button       
+        $('.field-wrapper:not(:last-child) .field-controls', this).append(_remover.clone())
+        
+        #Add the "Add" button
+        $('.field-controls:last', this).append(_adder.clone())
+        
+        #Bind the buttons to onClick events
+        $(el).on 'click', 'button.add', (e) ->
+          _internals.addToList(this)
+        $(el).on 'click', 'button.remove', (e) ->
+          _internals.removeFromList(this)
+        
+      return $this
+ 
+    # This method is often overlooked.
+    destroy: ->
+      # Do anything to clean it up (nullify references, unbind events…).
+      return $this
+ 
+  _internals =
+    addToList: (el) ->
+      $activeControls = $(el).closest('.field-controls')
+      $listing = $activeControls.closest('.listing')
+      $('.add', $activeControls).remove()
+      $removeControl = _remover.clone()
+      $activeControls.prepend($removeControl)
+      _internals.newRow($listing, el)
+      false
+
+    newRow: ($listing, el) ->
+      $listing.append _internals.newListItem($('li', $listing).size(), $listing, el)
+      _internals.autocompleteUsers($('.autocomplete-users:last', $listing))
+
+
+    removeFromList: (el) ->
+      $currentUser = $(el).closest('li')
+      $listing = $currentUser.closest('.listing')
+      $currentUser.hide()
+      # set the destroy flag
+      $('input:not([value])', $currentUser).val('true')
+      false
+
+    newListItem: (index, el) ->
+      ## We have multiple places in a view where we need these autocomplete fields
+      ## (Work edit view for example), so we don't want to use the first #entry-template.
+      ## Using .closest isn't working, but this seems to for now.
+      source   =  $(el).parent().children().html()
+      template = Handlebars.compile(source)
+      template({index: index})
+
+    addExistingUser: ($listItem, value, label) ->
+      ## We have multiple places in a view where we need these autocomplete fields
+      ## (Work edit view for example), so we don't want to use the first #existing-user-template.
+      ## Using .closest isn't working, but this seems to for now.
+      source   = $listItem.parent().prev().html()
+      template = Handlebars.compile(source)
+      $list = $listItem.closest('ul')
+      $('input[required]', $list).removeAttr('required')
+      $listItem.replaceWith template({index: $('li', $list).index($listItem), value: value, label: label})
+      _internals.newRow($list)
+
+    autocompleteUsers: (el) ->
+      $targetElement = $(el)
+      $targetElement.autocomplete
+        source: (request, response) ->
+          $targetElement.data('url')
+          $.getJSON $targetElement.data('url'), { q: request.term + "*" }, ( data, status, xhr ) ->
+            matches = []
+            $.each data.response.docs, (idx, val) ->
+              matches.push {label: val['name_tesim'][0], value: val['id']}
+            response( matches )
+        minLength: 2
+        focus: ( event, ui ) ->
+          $targetElement.val(ui.item.label)
+          event.preventDefault()
+        select: ( event, ui ) ->
+          _internals.addExistingUser($targetElement.closest('li'), ui.item.value, ui.item.label)
+          $targetElement.val('')
+          event.preventDefault()
+
+ 
+  $.fn.linkUsers = (method) ->
+    if methods[method]
+      methods[method].apply this, Array::slice.call(arguments, 1)
+    else if typeof method is "object" or not method
+      methods.init.apply this, arguments
+    else
+      $.error "Method " + method + " does not exist on jquery.linkUsers"
+) jQuery, window, document

data/app/assets/javascripts/curation_concerns/proxy_rights.js.coffee

@@ -0,0 +1,95 @@
+(($, window, document) ->
+  $this = undefined
+ 
+  # default settings
+  _settings =
+    default: 'cool!'
+    
+ 
+  # This is your public API (no leading underscore, see?)
+  # All public methods must return $this so your plugin is chainable.
+  methods =
+    init: (options) ->
+      $this = $(@)
+      # The settings object is available under its name: _settings. Let's
+      # expand it with any custom options the user provided.
+      $.extend _settings, (options or {})
+      # Do anything that actually inits your plugin, if needed, right now!
+      # An important thing to keep in mind, is that jQuery plugins should be
+      # built so that one can apply them to more than one element, like so:
+      #
+      #  $('.matching-elements, #another-one').foobar()
+      #
+      $this.each (index, el) ->
+        $('#user').each (index, el) ->
+          _internals.autocompleteUsers(el)
+
+        $(el).on 'click', '.remove-proxy-button', _internals.removeContributor
+
+      return $this
+ 
+    # This method is often overlooked.
+    destroy: ->
+      # Do anything to clean it up (nullify references, unbind events…).
+      return $this
+ 
+  _internals =
+    addContributor: (name, id) ->
+      source   = $("#tmpl-proxy-row").html()
+      template = Handlebars.compile(source)
+      row = template({name: name, id: id})
+      $('#authorizedProxies tbody', $this).append(row)
+
+      # if (settings.afterAdd) {
+      #   settings.afterAdd(this, cloneElem)
+      # }
+
+      $.ajax({
+        type: "POST",
+        url: 'depositors',
+        dataType: 'json',
+        data: {grantee_id: id}
+      })
+
+      false
+
+    removeContributor: ->
+      # remove the row
+      $.ajax({
+        url: $(this).closest('a').prop('href'),
+        type: "post",
+        dataType: "json",
+        data: {"_method":"delete"}
+      })
+      $(this).closest('tr').remove()
+      false
+
+    autocompleteUsers: (el) ->
+      # Remove the choice from the search widget and put it in the table.
+      $targetElement = $(el)
+      $targetElement.autocomplete
+        source: (request, response) ->
+          $targetElement.data('url')
+          $.getJSON $targetElement.data('url'), { q: request.term, user: true}, ( data, status, xhr ) ->
+            matches = []
+            $.each data.response.docs, (idx, val) ->
+              matches.push {label: val['name_tesim'][0], value: val['id']}
+            response( matches )
+        minLength: 2
+        focus: ( event, ui ) ->
+          $targetElement.val(ui.item.label)
+          event.preventDefault()
+        select: ( event, ui ) ->
+          _internals.addContributor(ui.item.label, ui.item.value)
+          $targetElement.val('')
+          event.preventDefault()
+
+ 
+  $.fn.proxyRights = (method) ->
+    if methods[method]
+      methods[method].apply this, Array::slice.call(arguments, 1)
+    else if typeof method is "object" or not method
+      methods.init.apply this, arguments
+    else
+      $.error "Method " + method + " does not exist on jquery.proxyRights"
+) jQuery, window, document