sufia 7.0.0.beta4 → 7.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e48d49a101fe907425b8153aa726ea8643f897d
-  data.tar.gz: 43cc5a32c71d57f9b013c7ab253d9072c3e41f10
+  metadata.gz: ac6f239c006772685658115ca65e17cefcb60838
+  data.tar.gz: 61e9010739cf96f205a4288ac9868ea881d06800
 SHA512:
-  metadata.gz: cec16b9098ee70db08ab1e3b728884c34b8bb7c967992c6af08ea01720eb20f2f8650e203bc63cfbc505587f79cc1fd8218e7c75764758fe0313e2fef5616144
-  data.tar.gz: dab357b2da1216878cd10d0b45a3063ce500c0363bd4729dbc841356b38e0abdfe2432f83d09636db7dd5520ea2c3e1d1c28619fd946335edcbd4238e08b4e34
+  metadata.gz: 24f73b89ad7008c00580a7505a51ac0ebf506807eab9212d1f0fd0c21d3364f21d86827a7f53e3a35d207edacdaaf68ddd6f6c6b7062eafb831c1dbb9d629223
+  data.tar.gz: 399cc1c453ec1430f577b73889d30a6b259074708096cd974173e171a8a3880b25c79f6fcaf9fded7ff5374c6a2404a1b814029fe121922b12fa4fd2490d421a

data/.rubocop.yml

@@ -90,4 +90,3 @@ RSpec/DescribeClass:
     - 'spec/features/**/*'
     - 'spec/config/sufia_events_spec.rb'
 
-

data/.rubocop_todo.yml

@@ -8,6 +8,7 @@ Metrics/ClassLength:
   Exclude:
     - 'lib/generators/sufia/templates/catalog_controller.rb'
     - 'lib/generators/sufia/install_generator.rb'
+    - 'lib/sufia/configuration.rb'
     - 'app/services/sufia/user_stat_importer.rb'
 
 Metrics/ParameterLists:
@@ -24,7 +25,6 @@ Metrics/MethodLength:
     - 'lib/generators/sufia/templates/migrations/create_local_authorities.rb'
     - 'app/helpers/sufia/citations_behaviors/formatters/endnote_formatter.rb'
     - 'app/models/concerns/sufia/solr_document/export.rb'
-    - 'app/models/local_authority.rb'
     - 'lib/generators/sufia/install_generator.rb'
     - 'lib/sufia/arkivo/metadata_munger.rb'
 
@@ -40,7 +40,6 @@ Style/PredicateName:
 Rails/Output:
   Exclude:
     - 'lib/generators/**/*'
-    - 'app/services/sufia/user_stat_importer.rb'
 
 Rails/HasAndBelongsToMany:
   Exclude:

data/.travis.yml

@@ -7,6 +7,7 @@ cache:
     - "travis_phantomjs"
 
 before_install:
+  - gem install bundler
   - "phantomjs --version"
   - "export PATH=$PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
   - "phantomjs --version"

data/Gemfile

@@ -10,10 +10,10 @@ group :development, :test do
 end
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.8.0
-# engine_cart stanza: 0.8.0
+# engine_cart: 0.10.0
+# engine_cart stanza: 0.10.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
   begin
     eval_gemfile file
@@ -24,13 +24,22 @@ if File.exist?(file)
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
 
-  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'responders', "~> 2.0"
-    gem 'sass-rails', ">= 5.0"
-  else
-    gem 'sass-rails', "< 5.0"
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -1,16 +1,18 @@
 # Sufia
 
-[![Version](https://badge.fury.io/rb/sufia.png)](http://badge.fury.io/rb/sufia)
+Code: [![Version](https://badge.fury.io/rb/sufia.png)](http://badge.fury.io/rb/sufia)
 [![Build Status](https://travis-ci.org/projecthydra/sufia.png?branch=master)](https://travis-ci.org/projecthydra/sufia)
 [![Dependency Status](https://gemnasium.com/projecthydra/sufia.png)](https://gemnasium.com/projecthydra/sufia)
 [![Coverage Status](https://coveralls.io/repos/projecthydra/sufia/badge.svg)](https://coveralls.io/r/projecthydra/sufia)
 [![Documentation Status](https://inch-ci.org/github/projecthydra/sufia.svg?branch=master)](https://inch-ci.org/github/projecthydra/sufia)
 [![Code Climate](https://codeclimate.com/github/projecthydra/sufia/badges/gpa.svg)](https://codeclimate.com/github/projecthydra/sufia)
-[![Ready Tickets](https://badge.waffle.io/projecthydra/sufia.png?label=ready&title=Ready)](https://waffle.io/projecthydra/sufia)
-[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Docs: [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./.github/CONTRIBUTING.md)
 [![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/sufia)
 
+Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/) [![Ready Tickets](https://badge.waffle.io/projecthydra/sufia.png?label=ready&milestone=7.0.0&title=Ready)](https://waffle.io/projecthydra/sufia?milestone=7.0.0)
+
 # Table of Contents
 
   * [What is Sufia?](#what-is-sufia)
@@ -26,6 +28,7 @@
     * [Rails](#rails)
     * [Sufia's Ruby\-related dependencies](#sufias-ruby-related-dependencies)
     * [Install Sufia](#install-sufia)
+    * [Generate a primary work type](#generate-a-primary-work-type)
     * [Database tables and indexes](#database-tables-and-indexes)
     * [Start Redis](#start-redis)
     * [Start Solr](#start-solr)
@@ -75,6 +78,7 @@ Sufia has the following features:
 * Dynamically configurable featured works and researchers on homepage
 * Proxy deposit and transfers of ownership
 * Integration with Zotero for automatic population of user content
+* Suggested values from controlled vocabularies provided by [Questioning Authority](https://github.com/projecthydra-labs/questioning_authority)
 
 See [Sufia's documentation site](http://sufia.io/) for more non-technical documentation.
 
@@ -164,6 +168,22 @@ Install Sufia into your app using its built-in install generator. This step adds
 rails generate sufia:install -f
 ```
 
+## Generate a primary work type
+
+While earlier versions of Sufia came with a pre-defined object model, Sufia 7.0 and greater allow you to specify your primary work type by using tooling provided by the CurationConcerns gem. Work on the 7.x series will include adding support for users to generate an arbitrary number of work types, not **just** a primary work type. At this time we do *not* recommend generating multiple work types.
+
+Pass a (CamelCased) model name to Sufia's work generator to get started, e.g.:
+
+```
+rails generate sufia:work Work
+```
+
+or
+
+```
+rails generate sufia:work MovingImage
+```
+
 ## Database tables and indexes
 
 Now that Sufia's required database migrations have been generated into your app, you'll need to load them into your application's database.

data/app/assets/javascripts/sufia.js

@@ -34,7 +34,6 @@
 //= require sufia/featured_works
 //= require sufia/featured_researcher
 //= require sufia/batch_select_all
-//= require sufia/edit_metadata
 //= require sufia/single_use_link
 //= require sufia/search
 //= require sufia/editor
@@ -53,6 +52,10 @@
 //= require sufia/save_work
 //= require sufia/permissions
 //= require sufia/notifications
+//= require sufia/autocomplete
+//= require sufia/autocomplete/location
+//= require sufia/autocomplete/subject
+//= require sufia/autocomplete/language
 
 //= require curation_concerns/collections
 //= require hydra-editor/hydra-editor

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

@@ -2,6 +2,7 @@
 // code should be called from here.
 Sufia = {
     initialize: function () {
+        this.autocomplete();
         this.saveWorkControl();
         this.saveWorkFixed();
         this.popovers();
@@ -10,9 +11,20 @@ Sufia = {
         this.transfers();
     },
 
+    autocomplete: function () {
+        var ac = require('sufia/autocomplete');
+        var autocomplete = new ac.Autocomplete()
+        $('.multi_value.form-group').manage_fields({
+          add: function(e, element) {
+            autocomplete.fieldAdded(element)
+          }
+        });
+        autocomplete.setup();
+    },
+
     saveWorkControl: function () {
         var sw = require('sufia/save_work/save_work_control');
-        new sw.SaveWorkControl($("#form-progress")).activate();
+        var control = new sw.SaveWorkControl($("#form-progress"))
     },
 
     saveWorkFixed: function () {
@@ -31,8 +43,8 @@ Sufia = {
 
     permissions: function () {
         var perm = require('sufia/permissions/control');
-        new perm.PermissionsControl($("#share"), 'generic_work', 'tmpl-work-grant');
-        new perm.PermissionsControl($("#permission"), 'file_set', 'tmpl-file-set-grant');
+        new perm.PermissionsControl($("#share"), 'tmpl-work-grant');
+        new perm.PermissionsControl($("#permission"), 'tmpl-file-set-grant');
     },
 
     notifications: function () {

data/app/assets/javascripts/sufia/autocomplete.es6

@@ -0,0 +1,51 @@
+export class Autocomplete {
+  constructor() {
+  }
+
+  // This is the initial setup for the form.
+  setup() {
+      $('[data-autocomplete]').each((index, value) => {
+          let selector = $(value)
+          switch (selector.data('autocomplete')) {
+            case "subject":
+              this.autocompleteSubject(selector);
+              break;
+            case "language":
+              this.autocompleteLanguage(selector);
+              break;
+            case "based_near":
+              this.autocompleteLocation(selector);
+              break;
+          }
+      });
+  }
+
+  // attach an auto complete based on the field
+  fieldAdded(cloneElem) {
+    var $cloneElem = $(cloneElem);
+    // FIXME this code (comparing the id) depends on a bug. Each input has an id and
+    // the id is duplicated when you press the plus button. This is not valid html.
+    if (/_based_near$/.test($cloneElem.attr("id"))) {
+        this.autocompleteLocation($cloneElem);
+    } else if (/_language$/.test($cloneElem.attr("id"))) {
+        this.autocompleteLanguage($cloneElem);
+    } else if (/_subject$/.test($cloneElem.attr("id"))) {
+        this.autocompleteSubject($cloneElem);
+    }
+  }
+
+  autocompleteLocation(field) {
+      var loc = require('sufia/autocomplete/location');
+      new loc.Location(field, field.data('autocomplete-url'))
+  }
+
+  autocompleteSubject(field) {
+      var subj = require('sufia/autocomplete/subject');
+      new subj.Subject(field, field.data('autocomplete-url'))
+  }
+
+  autocompleteLanguage(field) {
+      var lang = require('sufia/autocomplete/language');
+      new lang.Language(field, field.data('autocomplete-url'))
+  }
+}

data/app/assets/javascripts/sufia/autocomplete/language.es6

@@ -0,0 +1,25 @@
+export class Language {
+  constructor(element, url) {
+    this.url = url
+    element.autocomplete(this.options());
+  }
+
+  options() {
+    return {
+      minLength: 2,
+      source: (request, response) => {
+        $.getJSON(this.url, {
+          q: request.term
+        }, response );
+      },
+      focus: function() {
+        // prevent value inserted on focus
+        return false;
+      },
+      complete: function(event) {
+        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+      }
+    };
+  }
+}
+

data/app/assets/javascripts/sufia/autocomplete/location.es6

@@ -0,0 +1,24 @@
+export class Location {
+  constructor(element, url) {
+    this.url = url
+    element.autocomplete(this.options());
+  }
+
+  options() {
+    return {
+      minLength: 2,
+      source: ( request, response ) => {
+        $.getJSON(this.url, {
+          q: request.term
+        }, response );
+      },
+      focus: function() {
+        // prevent value inserted on focus
+        return false;
+      },
+      complete: function(event) {
+        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+      }
+    };
+  }
+}

data/app/assets/javascripts/sufia/autocomplete/subject.es6

@@ -0,0 +1,26 @@
+export class Subject {
+  constructor(element, url) {
+    this.url = url
+    element.autocomplete(this.options());
+  }
+
+  options() {
+    return {
+      minLength: 2,
+      source: ( request, response ) => {
+        $.getJSON(this.url, {
+          q: request.term
+        }, response );
+      },
+      focus: function() {
+        // prevent value inserted on focus
+        return false;
+      },
+      complete: function(event) {
+        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+      }
+    };
+  }
+}
+
+

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

@@ -87,7 +87,7 @@ function batch_edit_init () {
 
                     for (key in  Object.keys(adata)) {
                         curKey = Object.keys(adata)[key];
-                        if (curKey.slice(0, 12) == "generic_work") {
+                        if (curKey.slice(0, 12) == req.key) {
                             data[curKey] = adata[curKey];
                             form.push(req.form);
                         }
@@ -100,10 +100,8 @@ function batch_edit_init () {
         };
     }());
 
-
     ajaxManager.run();
 
-
     function after_ajax(form) {
         form.enableForm();
     }
@@ -145,6 +143,7 @@ function batch_edit_init () {
 
         ajaxManager.addReq({
             form: form_id,
+            key: form.data('model'),
             queue: "add_doc",
             url: form.attr("action"),
             dataType: "json",
@@ -165,8 +164,12 @@ function batch_edit_init () {
 }
 
 Blacklight.onLoad(function() {
-  // set up global batch edit options to override the ones in the gem
-  window.batch_edits_options = { checked_label: "",unchecked_label: "",progress_label: "",status_label: "",css_class: "batch_toggle"};
+  // set up global batch edit options to override the ones in the hydra-batch-edit gem
+  window.batch_edits_options = { checked_label: "",
+                                 unchecked_label: "",
+                                 progress_label: "",
+                                 status_label: "",
+                                 css_class: "batch_toggle" };
   batch_edit_init();
 
 }); //end of Blacklight.onload

data/app/assets/javascripts/sufia/permissions/control.es6

@@ -6,17 +6,21 @@ export class PermissionsControl {
   /**
    * Initialize the save controls
    * @param {jQuery} element the jquery selector for the permissions container
-   * @param {String} object_name the name of the object to create 
    * @param {String} template_id the identifier of the template for the added elements 
    */
-  constructor(element, object_name, template_id) {
+  constructor(element, template_id) {
     if (element.size() == 0) {
       return
     }
     this.element = element
 
-    this.registry = new Registry(this.element, object_name, template_id)
+    this.registry = new Registry(this.element, this.object_name(), template_id)
     this.user_controls = new UserControls(this.element, this.registry)
     this.group_controls = new GroupControls(this.element, this.registry)
   }
+
+  // retrieve object_name the name of the object to create 
+  object_name() {
+    return this.element.data('param-key')
+  }
 }

data/app/assets/javascripts/sufia/save_work/required_fields.es6

@@ -2,12 +2,18 @@ export class RequiredFields {
   // Monitors the form and runs the callback if any of the required fields change
   constructor(form, callback) {
     this.form = form
-    // ":input" matches all input, select or textarea fields.
-    this.requiredFields = this.form.find(':input[required]')
-    this.requiredFields.change(callback)
+    this.callback = callback
+    this.reload()
   }
 
-  get areComplete(){
+  get areComplete() {
     return this.requiredFields.filter((n, elem) => { return $(elem).val().length < 1 } ).length == 0
   }
+
+  // Reassign requiredFields because fields may have been added or removed.
+  reload() {
+    // ":input" matches all input, select or textarea fields.
+    this.requiredFields = this.form.find(':input[required]')
+    this.requiredFields.change(this.callback)
+  }
 }

data/app/assets/javascripts/sufia/save_work/save_work_control.es6

@@ -26,6 +26,7 @@ export class SaveWorkControl {
     this.element = element
     this.form = element.closest('form')
     element.data('save_work_control', this)
+    this.activate();
   }
 
   /**
@@ -56,24 +57,33 @@ export class SaveWorkControl {
     if (!this.form) {
       return
     }
-    this.requiredFields = new RequiredFields(this.form, () => this.formChanged())
-    this.uploads = new UploadedFiles(this.form, () => this.formChanged())
+    this.requiredFields = new RequiredFields(this.form, () => this.formStateChanged())
+    this.uploads = new UploadedFiles(this.form, () => this.formStateChanged())
 
     this.saveButton = this.element.find(':submit')
 
-    this.depositAgreement = new DepositAgreement(this.form, () => this.formChanged())
+    this.depositAgreement = new DepositAgreement(this.form, () => this.formStateChanged())
 
     this.requiredMetadata = new ChecklistItem(this.element.find('#required-metadata'))
     this.requiredFiles = new ChecklistItem(this.element.find('#required-files'))
     new VisibilityComponent(this.element.find('.visibility'))
     this.preventSubmitUnlessValid()
+    $('.multi_value.form-group', this.form).bind('managed_field:add', () => this.formChanged())
+    $('.multi_value.form-group', this.form).bind('managed_field:remove', () => this.formChanged())
     this.formChanged()
   }
 
-  formChanged() {
+  // Called when a file has been uploaded, the deposit agreement is clicked or a form field has had text entered.
+  formStateChanged() {
     this.saveButton.prop("disabled", !this.isValid());
   }
 
+  // called when a new field has been added to the form.
+  formChanged() {
+    this.requiredFields.reload();
+    this.formStateChanged();
+  }
+
   isValid() {
     // avoid short circuit evaluation. The checkboxes should be independent.
     let metadataValid = this.validateMetadata()