sufia 7.3.0.rc3 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bac8c45d5973e94def8f5a7d7d2241e6d8e492a6
-  data.tar.gz: ff143be07e8ca19044b9cade1910e1843cd80b78
+  metadata.gz: 1796e607d146678e8569583b7ac12eb043543d6e
+  data.tar.gz: '01839aa30ae6849f657879ab9fc31762b8e9f619'
 SHA512:
-  metadata.gz: ce1118d2b2269c1eee9ff03dc78bc32bc4790fb0847ec26c62729596956b56013cb2289efa7c9856238522bd3a4e14ea184e2895fd5e90da6a296646d5496031
-  data.tar.gz: 36f2c7e153ed19f9f1034bb9364849bcbd262d89d4b47b6a5bfaa98d142655901f2bd433318f2aea01093a7220154f8b4541efd1cad0f636849aa6a39441fd93
+  metadata.gz: ecab36e574a7eebfeeb6b9590eafc351ca283a245f843842c898df8afa01b4ada033c5cdba77d8d96d9c58f01cafa87570cab22f8a6a0df759eeb6fc76b97247
+  data.tar.gz: 72724cf04ec14999a11b496cc361bd50916f2c5ee6750019be25982772e06b87ba82808bf200a759f430564a7f8de74aeced9fd18b630604bad17c323d4cf33f

data/.codeclimate.yml

@@ -28,6 +28,7 @@ engines:
     config:
       extensions:
         - .es6
+      ignore_warnings: true
   fixme:
     enabled: false
   rubocop:

data/.eslintrc

@@ -1,6 +1,7 @@
-ecmaFeatures:
-  modules: true
-  jsx: true
+parserOptions:
+  sourceType: module
+  ecmaFeatures:
+    jsx: true
 
 env:
   amd: true
@@ -61,7 +62,7 @@ rules:
   no-empty-pattern: 2
   no-eq-null: 2
   no-eval: 2
-  no-extend-native: 2
+  no-extend-native: 1
   no-extra-bind: 2
   no-fallthrough: 2
   no-floating-decimal: 0
@@ -78,7 +79,7 @@ rules:
   no-native-reassign: 2
   no-new-func: 2
   no-new-wrappers: 2
-  no-new: 2
+  no-new: 1
   no-octal-escape: 2
   no-octal: 2
   no-proto: 2

data/.rubocop.yml

@@ -22,7 +22,6 @@ Metrics/LineLength:
 Metrics/AbcSize:
   Max: 30
   Exclude:
-    - 'app/controllers/concerns/sufia/admin/depositor_stats.rb'
     - 'app/controllers/concerns/sufia/my_controller_behavior.rb'
     - 'app/services/sufia/user_stat_importer.rb'
     - 'lib/sufia/arkivo/metadata_munger.rb'

data/.rubocop_todo.yml

@@ -22,8 +22,6 @@ Metrics/ModuleLength:
 
 Metrics/MethodLength:
   Exclude:
-    - '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/controllers/concerns/sufia/my_controller_behavior.rb'
     - 'lib/generators/sufia/install_generator.rb'
@@ -42,11 +40,6 @@ Rails/Output:
   Exclude:
     - 'lib/generators/**/*'
 
-Rails/HasAndBelongsToMany:
-  Exclude:
-    - 'app/models/domain_term.rb'
-    - 'app/models/local_authority.rb'
-
 RSpec/NamedSubject:
   Enabled: false
 
@@ -54,7 +47,6 @@ RSpec/ExampleLength:
   Max: 7
   Exclude:
     - 'spec/controllers/api/items_controller_spec.rb'
-    - 'spec/controllers/authorities_controller_spec.rb'
     - 'spec/controllers/collections_controller_spec.rb'
     - 'spec/controllers/curation_concerns/file_sets_controller_spec.rb'
     - 'spec/controllers/my/highlights_controller_spec.rb'

data/README.md

@@ -13,7 +13,7 @@ Docs: [![Documentation Status](https://inch-ci.org/github/projecthydra/sufia.svg
 [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
 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.3.0&title=Ready)](https://waffle.io/projecthydra/sufia?milestone=7.3.0)
+[![Ready Tickets](https://badge.waffle.io/projecthydra/sufia.png?label=ready&title=Ready)](https://waffle.io/projecthydra/sufia)
 
 # Table of Contents
 
@@ -31,6 +31,7 @@ Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack
   * [Creating a Sufia\-based app](#creating-a-sufia-based-app)
     * [Generate a primary work type](#generate-a-primary-work-type)
     * [Start servers](#start-servers)
+    * [Add Default Admin Set](#add-default-admin-set)
   * [Managing a Sufia\-based app](#managing-a-sufia-based-app)
   * [License](#license)
   * [Contributing](#contributing)
@@ -66,7 +67,7 @@ After installing the Prerequisites:
 
 ## Prerequisites
 
-Sufia 7.x requires the following software to work:
+Sufia 7 requires the following software to work:
 
 1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 6.4.1)
 1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.5.1 (tested up to 4.7.1)
@@ -135,9 +136,9 @@ Generating a new Rails application using Sufia's template above takes cares of a
 * Loading all of Sufia's database migrations into your application's database
 * Loading Sufia's default workflows into your application's database
 
-## Generate a primary work type
+## Generate a work type
 
-While earlier versions of Sufia came with a pre-defined object model, Sufia 7.x 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.
+While earlier versions of Sufia came with a pre-defined object model, Sufia 7 allows you to generate an arbitrary number of work types. Let's start by generating one.
 
 Pass a (CamelCased) model name to Sufia's work generator to get started, e.g.:
 
@@ -169,7 +170,11 @@ After Fedora and Solr are running, create the default administrative set by runn
 rake sufia:default_admin_set:create
 ```
 
-You will want to run this command the first time this code is deployed to a new environment as well.
+You will want to run this command the first time this code is deployed to a new environment as well. Note it depends on loading workflows, which is run by the install template but also needs to be run in a new environment:
+
+```
+rake curation_concerns:workflow:load
+```
 
 # Managing a Sufia-based app
 

data/app/actors/sufia/actors/attach_members_actor.rb

@@ -0,0 +1,70 @@
+module Sufia
+  module Actors
+    # Attach or remove child works to/from this work. This decodes parameters
+    # that follow the rails nested parameters conventions:
+    # e.g.
+    #   'work_members_attributes' => {
+    #     '0' => { 'id' = '12312412'},
+    #     '1' => { 'id' = '99981228', '_destroy' => 'true' }
+    #   }
+    #
+    # The goal of this actor is to mutate the ordered_members with as few writes
+    # as possible, because changing ordered_members is slow. This class only
+    # writes changes, not the full ordered list.
+    #
+    # TODO: Perhaps this can subsume AttachFilesActor
+    class AttachMembersActor < CurationConcerns::Actors::AbstractActor
+      def update(attributes)
+        attributes_collection = attributes.delete(:work_members_attributes)
+        assign_nested_attributes_for_collection(attributes_collection) &&
+          next_actor.update(attributes)
+      end
+
+      private
+
+        # Attaches any unattached members.  Deletes those that are marked _delete
+        # @param [Hash<Hash>] a collection of members
+        def assign_nested_attributes_for_collection(attributes_collection)
+          return true unless attributes_collection
+          attributes_collection = attributes_collection.sort_by { |i, _| i.to_i }.map { |_, attributes| attributes }
+          # checking for existing works to avoid rewriting/loading works that are
+          # already attached
+          existing_works = curation_concern.member_ids
+          attributes_collection.each do |attributes|
+            next if attributes['id'].blank?
+            if existing_works.include?(attributes['id'])
+              remove(attributes['id']) if has_destroy_flag?(attributes)
+            else
+              add(attributes['id'])
+            end
+          end
+        end
+
+        def ability
+          @ability ||= ::Ability.new(user)
+        end
+
+        # Adds the item to the ordered members so that it displays in the items
+        # along side the FileSets on the show page
+        def add(id)
+          member = ActiveFedora::Base.find(id)
+          return unless ability.can?(:edit, member)
+          curation_concern.ordered_members << member
+        end
+
+        # Remove the object from the members set and the ordered members list
+        def remove(id)
+          member = ActiveFedora::Base.find(id)
+          curation_concern.ordered_members.delete(member)
+          curation_concern.members.delete(member)
+        end
+
+        # Determines if a hash contains a truthy _destroy key.
+        # rubocop:disable Style/PredicateName
+        def has_destroy_flag?(hash)
+          ActiveFedora::Type::Boolean.new.cast(hash['_destroy'])
+        end
+      # rubocop:enable Style/PredicateName
+    end
+  end
+end

data/app/actors/sufia/apply_permission_template_actor.rb

@@ -10,10 +10,10 @@ module Sufia
       def add_edit_users(attributes)
         return unless attributes[:admin_set_id].present?
         template = Sufia::PermissionTemplate.find_by!(admin_set_id: attributes[:admin_set_id])
-        curation_concern.edit_users = template.access_grants.where(agent_type: 'user', access: 'manage').pluck(:agent_id)
-        curation_concern.edit_groups = template.access_grants.where(agent_type: 'group', access: 'manage').pluck(:agent_id)
-        curation_concern.read_users = template.access_grants.where(agent_type: 'user', access: 'view').pluck(:agent_id)
-        curation_concern.read_groups = template.access_grants.where(agent_type: 'group', access: 'view').pluck(:agent_id)
+        curation_concern.edit_users += template.access_grants.where(agent_type: 'user', access: 'manage').pluck(:agent_id)
+        curation_concern.edit_groups += template.access_grants.where(agent_type: 'group', access: 'manage').pluck(:agent_id)
+        curation_concern.read_users += template.access_grants.where(agent_type: 'user', access: 'view').pluck(:agent_id)
+        curation_concern.read_groups += template.access_grants.where(agent_type: 'group', access: 'view').pluck(:agent_id)
       end
   end
 end

data/app/actors/sufia/default_admin_set_actor.rb

@@ -25,25 +25,28 @@ module Sufia
       end
 
       def ensure_permission_template!(admin_set_id:)
-        Sufia::PermissionTemplate.find_or_create_by!(admin_set_id: admin_set_id)
+        Sufia::PermissionTemplate.find_by(admin_set_id: admin_set_id) || create_permission_template!(admin_set_id: admin_set_id)
       end
 
-      DEFAULT_ID = 'admin_set/default'.freeze
-
       def default_admin_set_id
         create_default_admin_set unless default_exists?
-        DEFAULT_ID
+        AdminSet::DEFAULT_ID
       end
 
       def default_exists?
-        AdminSet.exists?(DEFAULT_ID)
+        AdminSet.exists?(AdminSet::DEFAULT_ID)
       end
 
       # Creates the default AdminSet and an associated PermissionTemplate with workflow
       def create_default_admin_set
-        AdminSet.create!(id: DEFAULT_ID, title: ['Default Admin Set']).tap do |_as|
-          PermissionTemplate.create!(admin_set_id: DEFAULT_ID, workflow_name: 'default')
+        AdminSet.create!(id: AdminSet::DEFAULT_ID, title: ['Default Admin Set']).tap do |_as|
+          create_permission_template!(admin_set_id: AdminSet::DEFAULT_ID)
         end
       end
+
+      # Creates a Sufia::PermissionTemplate for the given AdminSet
+      def create_permission_template!(admin_set_id:)
+        Sufia::PermissionTemplate.create!(admin_set_id: admin_set_id, workflow_name: AdminSet::DEFAULT_WORKFLOW_NAME)
+      end
   end
 end

data/app/assets/javascripts/sufia.js

@@ -38,7 +38,7 @@
 //= require sufia/batch_select_all
 //= require sufia/browse_everything
 //= require sufia/search
-//= require sufia/editor
+//= require sufia/content_blocks
 //= require sufia/ga_events
 //= require sufia/select_submit
 //= require sufia/tabs
@@ -55,6 +55,8 @@
 //= require sufia/admin/admin_set_controls
 //= require sufia/admin/admin_set/participants
 //= require sufia/admin/admin_set/visibility
+//= require sufia/editor
+//= require sufia/editor/admin_set_widget
 //= require sufia/save_work
 //= require sufia/permissions
 //= require sufia/notifications

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

@@ -3,13 +3,11 @@
 Sufia = {
     initialize: function () {
         this.autocomplete();
-        this.saveWorkControl();
-        this.saveWorkFixed();
         this.popovers();
         this.permissions();
         this.notifications();
         this.transfers();
-        this.relationshipsTable();
+        this.editor();
         this.fileManager();
         this.selectWorkType();
         this.datatable();
@@ -40,16 +38,14 @@ Sufia = {
         autocomplete.setup();
     },
 
-    saveWorkControl: function () {
-        var sw = require('sufia/save_work/save_work_control');
-        var control = new sw.SaveWorkControl($("#form-progress"))
+    editor: function () {
+        var element = $("[data-behavior='work-form']")
+        if (element.length > 0) {
+          var Editor = require('sufia/editor');
+          new Editor(element)
+        }
     },
 
-    saveWorkFixed: function () {
-        // Setting test to false to skip native and go right to polyfill
-        FixedSticky.tests.sticky = false;
-        $('#savewidget').fixedsticky();
-    },
 
     // initialize popover helpers
     popovers: function () {
@@ -82,13 +78,6 @@ Sufia = {
         $("#proxy_deposit_request_transfer_to").userSearch();
     },
 
-    relationshipsTable: function () {
-        var rel = require('sufia/relationships/table');
-        $('table.relationships-ajax-enabled').each(function () {
-            new rel.RelationshipsTable($(this));
-        });
-    },
-
     selectWorkType: function () {
         var selectWork = require('sufia/select_work_type');
         $("[data-behavior=select-work]").each(function () {

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

@@ -1,66 +1,65 @@
+import Location from 'sufia/autocomplete/location'
+import Subject from 'sufia/autocomplete/subject'
+import Language from 'sufia/autocomplete/language'
+import Work from 'sufia/autocomplete/work'
+
+
 export class Autocomplete {
-  constructor() {
-  }
+    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;
-            case "work":
-              var user = selector.data('user');
-              var id = selector.data('id');
-              this.autocompleteWork(selector, user, id);
-              break;
-          }
-      });
-  }
+    // 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;
+              case "work":
+                this.autocompleteWork(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);
+    // 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'))
-  }
+    autocompleteLocation(field) {
+        new Location(field, field.data('autocomplete-url'))
+    }
 
-  autocompleteSubject(field) {
-      var subj = require('sufia/autocomplete/subject');
-      new subj.Subject(field, field.data('autocomplete-url'))
-  }
+    autocompleteSubject(field) {
+        new Subject(field, field.data('autocomplete-url'))
+    }
 
-  autocompleteLanguage(field) {
-      var lang = require('sufia/autocomplete/language');
-      new lang.Language(field, field.data('autocomplete-url'))
-  }
+    autocompleteLanguage(field) {
+        new Language(field, field.data('autocomplete-url'))
+    }
 
-  autocompleteWork(field, user, id) {
-    var work = require('sufia/autocomplete/work')
-    new work.Work(
-      field,
-      field.data('autocomplete-url'),
-      user,
-      id
-    )
-  }
+    autocompleteWork(field, excludeWorkId) {
+        new Work(
+          field,
+          field.data('autocomplete-url'),
+          field.data('exclude-work')
+        )
+    }
 }