sufia 7.2.0 → 7.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e82d102b1ebefbdcf3159286939f5441474cf3ce
-  data.tar.gz: 2f7bc9edb6ab9d90d937784572f2d9c0872f1ab8
+  metadata.gz: f8da2d85b23ab091afabbe8a3fc3f547fff86b94
+  data.tar.gz: 149f28dc13a30a9141d30b3035c0afaa4cd087a6
 SHA512:
-  metadata.gz: d1f345c73b9488a4846b11fb0272b8dae814e88ab9c1a0f559e78b91af54691a30d363430b70c27e36ba9cb24fa830ca5de182c0fd6d0d2a8ec3927769801bae
-  data.tar.gz: 47aec3915b098278458093b316a4d15c19796bcc3a7c8755113b4971cba4f4d16a72388bdb3fda401f6ef9590a40048db9e5a160cd174ff9dffdfac4d38bd427
+  metadata.gz: 7dfb177dad78057657aecbabcb3afc5f72d821ec24b98e6d6d2a87795f7e14c23c400e80b8818eac2252850d414d3b912c4ab354ee2dc28a2b15d0dd69e31f5a
+  data.tar.gz: 6dd363cc82aabe925013a2e8bf2de2d2c77651dd29ac10c8cabd19bbac949dda976abfd9913a0c4c89e0dbbb8b4f5fa0a72d0c466add9b4d2f038d291d5d68dd

data/.codeclimate.yml

@@ -23,6 +23,8 @@ engines:
       - javascript
   eslint:
     enabled: true
+    exclude_fingerprints:
+      - 673b54674f33c17cc8d5683c1e469b15
     config:
       extensions:
         - .es6

data/.rubocop.yml

@@ -100,3 +100,6 @@ RSpec/NestedGroups:
 
 RSpec/LeadingSubject:
   Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false

data/.rubocop_todo.yml

@@ -51,7 +51,7 @@ RSpec/NamedSubject:
   Enabled: false
 
 RSpec/ExampleLength:
-  Max: 7 
+  Max: 7
   Exclude:
     - 'spec/controllers/api/items_controller_spec.rb'
     - 'spec/controllers/authorities_controller_spec.rb'
@@ -113,4 +113,3 @@ RSpec/AnyInstance:
     - 'spec/presenters/sufia/work_usage_spec.rb'
     - 'spec/presenters/sufia/file_usage_spec.rb'
     - 'spec/services/sufia/repository_audit_service_spec.rb'
-

data/.travis.yml

@@ -27,7 +27,6 @@ notifications:
   irc:
     channels:
       - "irc.freenode.org#scholarsphere"
-      - "irc.freenode.org#projecthydra"
     template:
       - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"
 services:

data/Gemfile

@@ -5,8 +5,9 @@ gemspec
 
 group :development, :test do
   gem "simplecov", require: false
-  gem 'byebug' unless ENV['CI']
   gem 'coveralls', require: false
+  gem 'pry' unless ENV['CI']
+  gem 'pry-byebug' unless ENV['CI']
 end
 
 # BEGIN ENGINE_CART BLOCK

data/README.md

@@ -27,15 +27,10 @@ Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack
     * [Environments](#environments)
     * [Ruby](#ruby)
   * [Creating a Sufia\-based app](#creating-a-sufia-based-app)
+    * [Redis](#redis)
     * [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)
-    * [Start FCRepo](#start-fcrepo)
-    * [Spin up the web server](#spin-up-the-web-server)
+    * [Start servers](#start-servers)
   * [Managing a Sufia\-based app](#managing-a-sufia-based-app)
   * [License](#license)
   * [Contributing](#contributing)
@@ -49,49 +44,7 @@ Sufia uses the full power of [Hydra](http://projecthydra.org/) and extends it to
 
 ## Feature list
 
-Sufia has the following features:
-
-* Multiple file upload, and folder uploads (for Chrome browser only)
-* Flexible user- and group-based access controls
-* Transcoding of audio and video files
-* Generation and validation of identifiers
-* Generation of derivatives (served from the filesystem, not the repository)
-* Fixity checking
-* Version control
-* Characterization of uploaded files
-* Forms for batch editing metadata
-* Faceted search and browse
-* 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
-* Google Analytics for usage statistics
-* Integration w/ cloud storage providers
-* Google Scholar-specific metadata embedding
-* Schema.org microdata, Open Graph meta tags, and Twitter cards for rich snippets
-* User-managed collections for grouping files
-* Full-text indexing & searching
-* Responsive, fluid, Bootstrap 3-based UI
-* 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)
-* [ResourceSync](http://www.openarchives.org/rs/1.0/resourcesync) capability lists and resource lists
-* Administrative sets (curated collections)
-* Administrative dashboard, w/ feature flippers to turn features on and off in the UI
-* Contact form
-* Customizable banner image
-* Flexible object model: upload and manage single-file works, multi-file works, zero-file works, and works-within-works
-* Geonames integration for location-oriented metadata fields
-* Virus detection for uploaded files
-* Citation formatting suggestions
-
-See the [Sufia Management Guide](https://github.com/projecthydra/sufia/wiki/Sufia-Management-Guide) to learn which features listed above are turned on by default and which require configuration.
+Sufia has many features. [Read more about what they are and how to turn them on](https://github.com/projecthydra/sufia/wiki/Feature-matrix). See the [Sufia Management Guide](https://github.com/projecthydra/sufia/wiki/Sufia-Management-Guide) to learn more.
 
 For non-technical documentation about Sufia, see its [documentation site](http://sufia.io/).
 
@@ -115,15 +68,15 @@ After installing the Prerequisites:
 
 Sufia 7.x requires the following software to work:
 
-1. Solr version >= 5.x (tested up to 6.2.0)
-1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.5.1 (tested up to 4.6.0)
+1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 6.3.0)
+1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.5.1 (tested up to 4.7.0)
 1. A SQL RDBMS (MySQL, PostgreSQL), though **note** that SQLite will be used by default if you're looking to get up and running quickly
 1. [Redis](http://redis.io/), a key-value store
 1. [ImageMagick](http://www.imagemagick.org/) with JPEG-2000 support
 1. [FITS](#characterization) version 0.8.x (0.8.5 is known to be good)
 1. [LibreOffice](#derivatives)
 
-**NOTE: If you do not already have Solr and Fedora instances you can use in your development environment, you may use hydra-jetty (instructions are provided below to get you up and running quickly and with minimal hassle).**
+**NOTE: The [Sufia Development Guide](https://github.com/projecthydra/sufia/wiki/Sufia-Development-Guide) has instructions for installing Solr and Fedora in a development environment.**
 
 ### Characterization
 
@@ -154,32 +107,29 @@ We recommend either Ruby 2.3 or the latest 2.2 version.
 
 # Creating a Sufia-based app
 
-## Rails
+## Redis
 
-Generate a new Rails application. We recommend the latest Rails 5.0 or 4.2 release.
+[Redis](http://redis.io/) is a key-value store that Sufia uses to provide activity streams on repository objects and users, and to prevent race conditions as a global mutex when modifying order-persisting objects.
 
-```
-gem install rails -v 5.0.0.1
-rails new my_app
-```
+Starting up Redis will depend on your operating system, and may in fact already be started on your system. You may want to consult the [Redis documentation](http://redis.io/documentation) for help doing this.
 
-## Sufia's Ruby-related dependencies
+## Rails
 
-Add the following lines to your application's Gemfile.
+Generate a new Rails application. We recommend the latest Rails 5.0 or 4.2 release.
 
 ```
-gem 'sufia', '7.2.0'
+# If you don't already have Rails at your disposal...
+gem install rails -v 5.0.0.1
+rails new my_app -m https://raw.githubusercontent.com/projecthydra/sufia/master/template.rb
 ```
 
-Then install Sufia as a dependency of your app via `bundle install`
-
-## Install Sufia
-
-Install Sufia into your app using its built-in install generator. This step adds a number of files that Sufia requires within your Rails app, including e.g. a number of database migrations.
+Generating a new Rails application using Sufia's template above takes cares of a number of steps for you, including:
 
-```
-rails generate sufia:install -f
-```
+* Adding Sufia (and any of its dependencies) to your application `Gemfile`, to declare that Sufia is a dependency of your application
+* Running `bundle install`, to install Sufia and its dependencies
+* Running Sufia's install generator, to add a number of files that Sufia requires within your Rails app, including e.g. database migrations
+* 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
 
@@ -197,45 +147,12 @@ 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.
-
-```
-rake db:migrate
-```
-
-## Start Redis
-
-[Redis](http://redis.io/) is a key-value store that Sufia uses to provide activity streams on repository objects and users, and to prevent race conditions as a global mutex when modifying order-persisting objects.
-
-Starting up Redis will depend on your operating system, and may in fact already be started on your system. You may want to consult the [Redis documentation](http://redis.io/documentation) for help doing this.
-
-## Start Solr
-
-If you already have an instance of Solr that you would like to use, you may skip this step.  Open a new terminal window and type:
-```
-solr_wrapper -d solr/config/ --collection_name hydra-development
-```
-
-You can check to see if Solr is started by going to [localhost:8983](http://localhost:8983/).
-
-## Start FCRepo
-
-If you already have an instance of FCRepo that you would like to use, you may skip this step.  Open a new terminal window and type:
-
-```
-fcrepo_wrapper -p 8984
-```
-
-You can check to see if FCRepo is started by going to [localhost:8984](http://localhost:8984/).
-
-## Spin up the web server
+## Start servers
 
-To test-drive your new Sufia application, spin up the web server that Rails provides:
+To test-drive your new Sufia application in development mode, spin up the servers that Sufia needs (Solr, Fedora, and Rails):
 
 ```
-rails server
+rake hydra:server
 ```
 
 And now you should be able to browse to [localhost:3000](http://localhost:3000/) and see the application. Note that this web server is purely for development purposes; you will want to use a more fully featured [web server](#web-server) for production-like environments.

data/app/actors/sufia/apply_permission_template_actor.rb

@@ -0,0 +1,19 @@
+module Sufia
+  class ApplyPermissionTemplateActor < CurationConcerns::Actors::AbstractActor
+    def create(attributes)
+      add_edit_users(attributes)
+      next_actor.create(attributes)
+    end
+
+    protected
+
+      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)
+      end
+  end
+end

data/app/actors/sufia/create_with_remote_files_actor.rb

@@ -31,9 +31,9 @@ module Sufia
           actor = CurationConcerns::Actors::FileSetActor.new(fs, user)
           actor.create_metadata(curation_concern, visibility: curation_concern.visibility)
           fs.save!
-          uri = URI.parse(url)
+          uri = URI.parse(URI.encode(url))
           if uri.scheme == 'file'
-            IngestLocalFileJob.perform_later(fs, uri.path, user)
+            IngestLocalFileJob.perform_later(fs, URI.decode(uri.path), user)
           else
             ImportUrlJob.perform_later(fs, log(actor.user))
           end

data/app/actors/sufia/default_admin_set_actor.rb

@@ -0,0 +1,42 @@
+module Sufia
+  # Ensures that the default AdminSet id is set if this form doesn't have
+  # an admin_set_id provided. This should come before the
+  # CurationConcerns::Actors::InitializeWorkflowActor, so that the correct
+  # workflow can be kicked off.
+  class DefaultAdminSetActor < CurationConcerns::Actors::AbstractActor
+    def create(attributes)
+      ensure_admin_set_attribute!(attributes)
+      next_actor.create(attributes)
+    end
+
+    def update(attributes)
+      ensure_admin_set_attribute!(attributes)
+      next_actor.update(attributes)
+    end
+
+    private
+
+      def ensure_admin_set_attribute!(attributes)
+        return if attributes[:admin_set_id].present?
+        attributes[:admin_set_id] = default_admin_set_id
+      end
+
+      DEFAULT_ID = 'admin_set/default'.freeze
+
+      def default_admin_set_id
+        create_default_admin_set unless default_exists?
+        DEFAULT_ID
+      end
+
+      def default_exists?
+        AdminSet.exists?(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')
+        end
+      end
+  end
+end

data/app/actors/sufia/interpret_visibility_actor.rb

@@ -0,0 +1,115 @@
+module Sufia
+  class InterpretVisibilityActor < CurationConcerns::Actors::InterpretVisibilityActor
+    # Override CC to ensure our custom 'validate' method is used
+    def create(attributes)
+      @intention = Intention.new(attributes)
+      attributes = @intention.sanitize_params
+      validate(attributes) && apply_visibility(attributes) && next_actor.create(attributes)
+    end
+
+    # Override CC to ensure our custom 'validate' method is used
+    def update(attributes)
+      @intention = Intention.new(attributes)
+      attributes = @intention.sanitize_params
+      validate(attributes) && apply_visibility(attributes) && next_actor.update(attributes)
+    end
+
+    private
+
+      # Validate against selected AdminSet's PermissionTemplate (if any)
+      def validate(attributes)
+        # If AdminSet was selected, look for its PermissionTemplate
+        template = Sufia::PermissionTemplate.find_by(admin_set_id: attributes[:admin_set_id]) if attributes[:admin_set_id].present?
+
+        validate_lease(template) && validate_release_type(template) && validate_visibility(attributes, template) && validate_embargo(attributes, template)
+      end
+
+      # Validate that a lease is allowed by AdminSet's PermissionTemplate
+      def validate_lease(template)
+        # Leases are only allowable if a template doesn't require a release period or have any specific visibility requirement
+        # (Note: permission template release/visibility options do not support leases)
+        return true unless @intention.wants_lease? && template.present? && (template.release_period.present? || template.visibility.present?)
+
+        curation_concern.errors.add(:visibility, 'Lease option is not allowed by permission template for selected AdminSet.')
+        false
+      end
+
+      # Validate the selected release settings against template, checking for when embargoes/leases are not allowed
+      def validate_release_type(template)
+        # It's valid as long as embargo is not specified when a template requires no release delays
+        return true unless @intention.wants_embargo? && template.present? && template.release_no_delay?
+
+        curation_concern.errors.add(:visibility, 'Visibility specified does not match permission template "no release delay" requirement for selected AdminSet.')
+        false
+      end
+
+      # Validate visibility complies with AdminSet template requirements
+      def validate_visibility(attributes, template)
+        # NOTE: For embargo/lease, attributes[:visibility] will be nil (see sanitize_params), so visibility will be validated as part of embargo/lease
+        return true unless attributes[:visibility].present?
+
+        # Validate against template's visibility requirements
+        return true if validate_template_visibility(attributes[:visibility], template)
+
+        curation_concern.errors.add(:visibility, 'Visibility specified does not match permission template visibility requirement for selected AdminSet.')
+        false
+      end
+
+      # When specified, validate embargo is a future date that complies with AdminSet template requirements (if any)
+      def validate_embargo(attributes, template)
+        return true unless @intention.wants_embargo?
+
+        embargo_release_date = parse_date(attributes[:embargo_release_date])
+
+        # When embargo required, date must be in future AND matches any template requirements
+        return true if valid_future_date?(embargo_release_date) &&
+                       valid_template_embargo_date?(embargo_release_date, template) &&
+                       valid_template_visibility_after_embargo?(attributes, template)
+
+        curation_concern.errors.add(:visibility, 'When setting visibility to "embargo" you must also specify embargo release date.') unless embargo_release_date.present?
+        false
+      end
+
+      # Validate an date attribute is in the future
+      def valid_future_date?(date, attribute_name: :embargo_release_date)
+        return true if date.present? && date.future?
+
+        curation_concern.errors.add(attribute_name, "Must be a future date.")
+        false
+      end
+
+      # Validate an embargo date against permission template restrictions
+      def valid_template_embargo_date?(date, template)
+        return true unless template.present?
+
+        # Validate against template's release_date requirements
+        return true if template.valid_release_date?(date)
+
+        curation_concern.errors.add(:embargo_release_date, "Release date specified does not match permission template release requirements for selected AdminSet.")
+        false
+      end
+
+      # Validate the post-embargo visibility against permission template requirements (if any)
+      def valid_template_visibility_after_embargo?(attributes, template)
+        # Validate against template's visibility requirements
+        return true if validate_template_visibility(attributes[:visibility_after_embargo], template)
+
+        curation_concern.errors.add(:visibility_after_embargo, "Visibility after embargo does not match permission template visibility requirements for selected AdminSet.")
+        false
+      end
+
+      # Validate that a given visibility value satisfies template requirements
+      def validate_template_visibility(visibility, template)
+        return true unless template.present?
+
+        template.valid_visibility?(visibility)
+      end
+
+      # Parse date from string. Returns nil if date_string is not a valid date
+      def parse_date(date_string)
+        datetime = Time.zone.parse(date_string) if date_string.present?
+        return datetime.to_date unless datetime.nil?
+        nil
+      end
+  end
+end

data/app/assets/javascripts/sufia.js

@@ -52,6 +52,9 @@
 //= require sufia/flot_stats
 // Provide AMD module support
 //= require almond
+//= require sufia/admin/admin_set_controls
+//= require sufia/admin/admin_set/participants
+//= require sufia/admin/admin_set/visibility
 //= require sufia/save_work
 //= require sufia/permissions
 //= require sufia/notifications
@@ -59,7 +62,9 @@
 //= require sufia/autocomplete/location
 //= require sufia/autocomplete/subject
 //= require sufia/autocomplete/language
+//= require sufia/autocomplete/work
 //= require sufia/relationships
+//= require sufia/select_work_type
 //= require curation_concerns/collections
 //= require hydra-editor/hydra-editor
 //= require nestable
@@ -67,6 +72,7 @@
 //= require curation_concerns/file_manager/save_manager
 //= require curation_concerns/file_manager/member
 //= require curation_concerns/file_manager
+//= require sufia/workflow_actions_affix
 
 // this needs to be after batch_select so that the form ids get setup correctly
 //= require sufia/batch_edit