hyrax 2.0.3 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa5aeb61448a7bb4c3f3e44853a9ab847456ae9f
-  data.tar.gz: e13c7998086b013f8e1dd4717d79171e5fee0891
+  metadata.gz: e42502331d699a799fad6da0360519ece766d82c
+  data.tar.gz: a15052167c02906f25795e0ca1032d0e3348db91
 SHA512:
-  metadata.gz: ee5994be411f64cced03b2bdc1204423fe026e396be07cc568f13823ce7fa4a9367214da5ea4be9f10c702e03453a583645b480816c7de215e8375851fc40579
-  data.tar.gz: 779f0003fd4c0a235987ef5f1c594797aeb2523106866120ddd7be27a71e509be01cda3a4a70727d36eb694854562c4542a18da2caf995b803b08e4c47ddc838
+  metadata.gz: 935f31ae4c0dd84119ea4166186d1da09b941e96d63c72663d5358485b11416ce3ef5d5dabd940555549898836b46c79e5464ab305986b2a609dc2019999a8de
+  data.tar.gz: dfee962f81193815a33cea4417737f4cf6c08981c323df9b9b3035047ead86163d05fc571992846eeed49ac15a693b0537f6a97a405b0942c0f2b275e4e35d59

data/.eslintrc

@@ -70,7 +70,6 @@ rules:
   no-implied-eval: 2
   no-invalid-this: 0
   no-iterator: 2
-  no-labels: 0
   no-lone-blocks: 2
   no-loop-func: 2
   no-magic-number: 0

data/.github/CONTRIBUTING.md

@@ -51,7 +51,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * Please avoid working directly on the `master` branch.
   * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
 * Make sure you have added sufficient tests and documentation for your changes.
-  * Test functionality with RSpec; est features / UI with Capybara.
+  * Test functionality with RSpec; Test features / UI with Capybara.
 * Run _all_ the tests to assure nothing else was accidentally broken.
 
 ### Documenting Code

data/.rubocop.yml

@@ -44,11 +44,16 @@ Metrics/BlockLength:
     - 'lib/generators/hyrax/templates/catalog_controller.rb'
     - 'lib/generators/hyrax/templates/config/initializers/simple_form_bootstrap.rb'
     - 'lib/hyrax/rails/routes.rb'
+    - 'lib/tasks/*.rake'
     - 'spec/**/*.rb'
 
 Metrics/MethodLength:
   Max: 13
 
+Naming/FileName: # https://github.com/bbatsov/rubocop/issues/2973
+  Exclude:
+    - 'Gemfile'
+
 Style/AsciiComments:
   Enabled: false
 
@@ -60,10 +65,6 @@ Style/CollectionMethods:
     detect: 'find'
     find_all: 'select'
 
-Style/FileName: # https://github.com/bbatsov/rubocop/issues/2973
-  Exclude:
-    - 'Gemfile'
-
 Style/MethodMissing:
   Exclude:
     - 'app/models/concerns/hyrax/file_set/characterization.rb'
@@ -140,6 +141,9 @@ RSpec/DescribeClass:
     - 'spec/tasks/rake_spec.rb'
     - 'spec/views/**/*'
 
+RSpec/ContextWording:
+  Enabled: false
+
 # By default RSpec/MessageSpies has the following:
 #   Prefer have_received for setting message expectations. Setup form as a spy using allow or instance_spy.
 # The default assumes EnforcedStyle is 'have_received'. Most of our specs are 'receive'

data/.rubocop_fixme.yml

@@ -5,9 +5,11 @@ Security/MarshalLoad:
 Metrics/ClassLength:
   Exclude:
     - 'app/controllers/hyrax/dashboard/collections_controller.rb'
+    - 'app/controllers/hyrax/admin/admin_sets_controller.rb'
     - 'app/controllers/hyrax/file_sets_controller.rb'
     - 'app/forms/hyrax/forms/permission_template_form.rb'
     - 'app/presenters/hyrax/work_show_presenter.rb'
+    - 'app/presenters/hyrax/collection_presenter.rb'
     - 'app/services/hyrax/user_stat_importer.rb'
     - 'lib/generators/hyrax/templates/catalog_controller.rb'
     - 'lib/generators/hyrax/install_generator.rb'
@@ -29,6 +31,8 @@ Metrics/ModuleLength:
     - 'app/models/concerns/hyrax/ability.rb'
     - 'app/services/hyrax/workflow/permission_query.rb'
     - 'spec/services/hyrax/workflow/permission_query_spec.rb'
+    # TODO:  extract CollectionAccessControls or something, so we don't have to skip this check?
+    - 'app/models/concerns/hyrax/collection_behavior.rb'
 
 Metrics/MethodLength:
   Exclude:
@@ -42,14 +46,28 @@ Metrics/MethodLength:
     - 'lib/hyrax/rails/routes.rb'
     - 'spec/support/**/*'
 
+
+Naming/PredicateName:
+  Exclude:
+    - 'app/helpers/hyrax/collections_helper.rb'
+
+
 # TODO: remove when https://github.com/bbatsov/rubocop/issues/4539 is fixed
 Style/FormatStringToken:
   Exclude:
     - 'config/routes.rb'
 
-Style/PredicateName:
+Style/DateTime:
+  Enabled: false
+
+# TODO: remove when https://github.com/bbatsov/rubocop/issues/5161 is fixed
+Style/CommentedKeyword:
   Exclude:
-    - 'app/helpers/hyrax/collections_helper.rb'
+    - 'app/models/vocab/fedora_resource_status.rb'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'tasks/hyrax_dev.rake'
 
 Rails/Output:
   Exclude:

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-sudo: required
+sudo: false
 dist: trusty
 
 addons:
@@ -10,10 +10,10 @@ cache:
 before_install:
   - gem update --system
   - gem install bundler
-  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
+  - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 
 rvm:
-  - 2.4.2
+  - 2.5.0
 
 env:
   global:

data/README.md

@@ -1,7 +1,7 @@
 ![Logo](https://raw.githubusercontent.com/samvera/hyrax/gh-pages/assets/images/hyrax_logo_horizontal_white_background.png)
 
 Code: [![Version](https://badge.fury.io/rb/hyrax.png)](http://badge.fury.io/rb/hyrax)
-[![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=2.0-stable)](https://travis-ci.org/samvera/hyrax/branches)
+[![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=master)](https://travis-ci.org/samvera/hyrax)
 [![Coverage Status](https://coveralls.io/repos/github/samvera/hyrax/badge.svg?branch=master)](https://coveralls.io/github/samvera/hyrax?branch=master)
 [![Code Climate](https://codeclimate.com/github/samvera/hyrax/badges/gpa.svg)](https://codeclimate.com/github/samvera/hyrax)
 [![Dependency Update Status](https://gemnasium.com/samvera/hyrax.png)](https://gemnasium.com/samvera/hyrax)
@@ -63,7 +63,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v2.0.3__. If you are looking for instructions on installing a different
+v2.1.0.beta1__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -160,7 +160,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.0.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.0.3/template.rb
+rails _5.0.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.1.0.beta1/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
@@ -249,12 +249,20 @@ You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki
 
 Hyrax 2 uses a WebSocket-based user notifications system, which requires Redis. To enable user notifications, make sure that you have configured ActionCable to use Redis as the adapter in your application's `config/cable.yml`. E.g., for the `development` Rails environment:
 
-``` yaml
+```yaml
 development:
   adapter: redis
   url: redis://localhost:6379
 ```
 
+Using Rails up to version 5.1.4, ActionCable will not work with the 4.x series of the `redis` gem, so you will also need to pin your application to a 3.x release by adding this to your `Gemfile`:
+
+```ruby
+gem 'redis', '~> 3.0'
+```
+
+And then run `bundle update redis`.
+
 Note that the Hyrax Management Guide contains additional information on [how to configure ActionCable in production environments](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#notifications).
 
 # Managing a Hyrax-based app

data/app/actors/hyrax/actors/abstract_actor.rb

@@ -1,7 +1,7 @@
 module Hyrax
   module Actors
     ##
-    # `Hyrax::AbstractActor` implements the base (no-op) case for Hyrax Actor
+    # `Hyrax::Actors::AbstractActor` implements the base (no-op) case for Hyrax Actor
     # middleware. Concrete implementations may override any or all of the three
     # primary actions:
     #

data/app/actors/hyrax/actors/apply_permission_template_actor.rb

@@ -13,8 +13,24 @@ module Hyrax
       private
 
         def add_edit_users(env)
+          add_admin_set_participants(env)
+          add_collection_participants(env)
+        end
+
+        def add_admin_set_participants(env)
           return if env.attributes[:admin_set_id].blank?
-          template = Hyrax::PermissionTemplate.find_by!(admin_set_id: env.attributes[:admin_set_id])
+          template = Hyrax::PermissionTemplate.find_by!(source_id: env.attributes[:admin_set_id])
+          set_curation_concern_access(env, template)
+        end
+
+        def add_collection_participants(env)
+          return if env.attributes[:collection_id].blank?
+          collection_id = env.attributes.delete(:collection_id) # delete collection_id from attributes because works do not have a collection_id property
+          template = Hyrax::PermissionTemplate.find_by!(source_id: collection_id)
+          set_curation_concern_access(env, template)
+        end
+
+        def set_curation_concern_access(env, template)
           env.curation_concern.edit_users += template.agent_ids_for(agent_type: 'user', access: 'manage')
           env.curation_concern.edit_groups += template.agent_ids_for(agent_type: 'group', access: 'manage')
           env.curation_concern.read_users += template.agent_ids_for(agent_type: 'user', access: 'view')

data/app/actors/hyrax/actors/attach_members_actor.rb

@@ -56,11 +56,11 @@ module Hyrax
         end
 
         # Determines if a hash contains a truthy _destroy key.
-        # rubocop:disable Style/PredicateName
+        # rubocop:disable Naming/PredicateName
         def has_destroy_flag?(hash)
           ActiveFedora::Type::Boolean.new.cast(hash['_destroy'])
         end
-      # rubocop:enable Style/PredicateName
+      # rubocop:enable Naming/PredicateName
     end
   end
 end

data/app/actors/hyrax/actors/collections_membership_actor.rb

@@ -1,35 +1,170 @@
 module Hyrax
   module Actors
-    # Adds membership to and removes membership from collections
+    # Adds membership to and removes membership from collections.
+    # This decodes parameters that follow the rails nested parameters conventions:
+    #
+    # @example a collections attribute hash
+    #   'member_of_collections_attributes' => {
+    #     '0' => { 'id' = '12312412'},
+    #     '1' => { 'id' = '99981228', '_destroy' => 'true' }
+    #   }
+    #
     class CollectionsMembershipActor < AbstractActor
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
-        collection_ids = env.attributes.delete(:member_of_collection_ids)
-        assign_collections(env, collection_ids) && next_actor.create(env)
+        extract_collection_id(env)
+        assign_nested_attributes_for_collection(env) && next_actor.create(env)
       end
 
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if update was successful
       def update(env)
-        collection_ids = env.attributes.delete(:member_of_collection_ids)
-        assign_collections(env, collection_ids) && next_actor.update(env)
+        assign_nested_attributes_for_collection(env) && next_actor.update(env)
       end
 
       private
 
-        # Maps from collection ids to collection objects
-        def assign_collections(env, collection_ids)
-          return true unless collection_ids
-          # grab/save collections this user has no edit access to
-          other_collections = collections_without_edit_access(env)
-          env.curation_concern.member_of_collections = ::Collection.find(collection_ids)
-          env.curation_concern.member_of_collections.concat other_collections
+        ##
+        # Attaches any unattached members.  Deletes those that are marked _delete
+        #
+        # @param env [Hyrax::Actors::Enviornment]
+        # @return [Boolean]
+        #
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def assign_nested_attributes_for_collection(env)
+          attributes_collection = env.attributes.delete(:member_of_collections_attributes)
+
+          return assign_for_collection_ids(env) unless attributes_collection
+
+          emit_deprecation if env.attributes.delete(:member_of_collection_ids)
+
+          return false unless
+            valid_membership?(env, collection_ids: attributes_collection.map { |_, attributes| attributes['id'] })
+
+          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_collections = env.curation_concern.member_of_collection_ids
+          attributes_collection.each do |attributes|
+            next if attributes['id'].blank?
+            if existing_collections.include?(attributes['id'])
+              remove(env.curation_concern, attributes['id']) if has_destroy_flag?(attributes)
+            else
+              add(env, attributes['id'])
+            end
+          end
+
+          true
+        end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        ##
+        # @deprecated supports old :member_of_collection_ids arguments
+        def emit_deprecation
+          Deprecation.warn(self, ':member_of_collections_attributes and :member_of_collection_ids were both ' \
+                                 ' passed. :member_of_collection_ids is ignored when both are passed and is ' \
+                                 'deprecated for removal in Hyrax 3.0.')
+        end
+
+        ##
+        # @deprecated supports old :member_of_collection_ids arguments
+        def assign_for_collection_ids(env)
+          collection_ids = env.attributes.delete(:member_of_collection_ids)
+
+          return false unless valid_membership?(env, collection_ids: collection_ids)
+
+          if collection_ids
+            Deprecation.warn(self, ':member_of_collection_ids has been deprecated for removal in Hyrax 3.0. ' \
+                                   'use :member_of_collections_attributes instead.')
+
+            other_collections = collections_without_edit_access(env)
+
+            collections = ::Collection.find(collection_ids)
+            raise "Tried to assign collections with ids: #{collection_ids}, but none were found" unless
+              collections
+
+            env.curation_concern.member_of_collections = collections
+            env.curation_concern.member_of_collections.concat(other_collections)
+          end
+
+          true
         end
 
+        ##
+        # @deprecated supports old :member_of_collection_ids arguments
         def collections_without_edit_access(env)
           env.curation_concern.member_of_collections.select { |coll| env.current_ability.cannot?(:edit, coll) }
         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(env, id)
+          collection = Collection.find(id)
+          return unless env.current_ability.can?(:deposit, collection)
+          env.curation_concern.member_of_collections << collection
+        end
+
+        # Remove the object from the members set and the ordered members list
+        def remove(curation_concern, id)
+          collection = Collection.find(id)
+          curation_concern.member_of_collections.delete(collection)
+        end
+
+        # Determines if a hash contains a truthy _destroy key.
+        # rubocop:disable Naming/PredicateName
+        def has_destroy_flag?(hash)
+          ActiveFedora::Type::Boolean.new.cast(hash['_destroy'])
+        end
+        # rubocop:enable Naming/PredicateName
+
+        # Extact a singleton collection id from the collection attributes and save it in env.  Later in the actor stack,
+        # in apply_permission_template_actor.rb, `env.attributes[:collection_id]` will be used to apply the
+        # permissions of the collection to the created work.  With one and only one collection, the work is seen as
+        # being created directly in that collection.  The permissions will not be applied to the work if the collection
+        # type is configured not to allow that or if the work is being created in more than one collection.
+        #
+        # @param env [Hyrax::Actors::Enviornment]
+        #
+        # Given an array of collection_attributes when it is size:
+        # * 0 do not set `env.attributes[:collection_id]`
+        # * 1 set `env.attributes[:collection_id]` to the one and only one collection
+        # * 2+ do not set `env.attributes[:collection_id]`
+        #
+        # NOTE: Only called from create.  All collections are being added as parents of a work.  None are being removed.
+        def extract_collection_id(env)
+          attributes_collection =
+            env.attributes.fetch(:member_of_collections_attributes) { nil }
+
+          if attributes_collection
+            # Determine if the work is being created in one and only one collection.
+            return unless attributes_collection && attributes_collection.size == 1
+
+            # Extract the collection id from attributes_collection,
+            collection_id = attributes_collection.first.second['id']
+          else
+            collection_ids = env.attributes.fetch(:member_of_collection_ids) { [] }
+            return unless collection_ids.size == 1
+            collection_id = collection_ids.first
+          end
+
+          # Do not apply permissions to work if collection type is configured not to
+          collection = ::Collection.find(collection_id)
+          return unless collection.share_applies_to_new_works?
+
+          # Save the collection id in env for use in apply_permission_template_actor
+          env.attributes[:collection_id] = collection_id
+        end
+
+        def valid_membership?(env, collection_ids:)
+          multiple_memberships = Hyrax::MultipleMembershipChecker.new(item: env.curation_concern).check(collection_ids: collection_ids)
+          if multiple_memberships
+            env.curation_concern.errors.add(:collections, multiple_memberships)
+            return false
+          end
+          true
+        end
     end
   end
 end

data/app/actors/hyrax/actors/create_with_remote_files_actor.rb

@@ -5,6 +5,9 @@ module Hyrax
     #     attributes[:remote_files] = filenames.map do |name|
     #       { url: "https://example.com/file/#{name}", file_name: name }
     #     end
+    #
+    # Browse everything may also return a local file. And although it's in the
+    # url property, it may have spaces, and not be a valid URI.
     class CreateWithRemoteFilesActor < Hyrax::Actors::AbstractActor
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
@@ -26,10 +29,10 @@ module Hyrax
           Hyrax.config.whitelisted_ingest_dirs
         end
 
-        def validate_remote_url(url)
-          uri = URI.parse(URI.encode(url))
+        # @param uri [URI] the uri fo the resource to import
+        def validate_remote_url(uri)
           if uri.scheme == 'file'
-            path = File.absolute_path(URI.decode(uri.path))
+            path = File.absolute_path(CGI.unescape(uri.path))
             whitelisted_ingest_dirs.any? do |dir|
               path.start_with?(dir) && path.length > dir.length
             end
@@ -46,26 +49,29 @@ module Hyrax
           return true unless remote_files
           remote_files.each do |file_info|
             next if file_info.blank? || file_info[:url].blank?
-            unless validate_remote_url(file_info[:url])
+            # Escape any space characters, so that this is a legal URI
+            uri = URI.parse(Addressable::URI.escape(file_info[:url]))
+            unless validate_remote_url(uri)
               Rails.logger.error "User #{env.user.user_key} attempted to ingest file from url #{file_info[:url]}, which doesn't pass validation"
               return false
             end
-            create_file_from_url(env, file_info[:url], file_info[:file_name])
+            create_file_from_url(env, uri, file_info[:file_name])
           end
           true
         end
 
         # Generic utility for creating FileSet from a URL
         # Used in to import files using URLs from a file picker like browse_everything
-        def create_file_from_url(env, url, file_name)
-          ::FileSet.new(import_url: url, label: file_name) do |fs|
+        def create_file_from_url(env, uri, file_name)
+          ::FileSet.new(import_url: uri.to_s, label: file_name) do |fs|
             actor = Hyrax::Actors::FileSetActor.new(fs, env.user)
             actor.create_metadata(visibility: env.curation_concern.visibility)
             actor.attach_to_work(env.curation_concern)
             fs.save!
-            uri = URI.parse(URI.encode(url))
             if uri.scheme == 'file'
-              IngestLocalFileJob.perform_later(fs, URI.decode(uri.path), env.user)
+              # Turn any %20 into spaces.
+              file_path = CGI.unescape(uri.path)
+              IngestLocalFileJob.perform_later(fs, file_path, env.user)
             else
               ImportUrlJob.perform_later(fs, operation_for(user: actor.user))
             end