hyrax 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '081daeb5064ca757527e98cfbbea41846b8a15440a26a2d152b1ad7a1c7f395b'
-  data.tar.gz: 70e52823ff8ef7546510db08f28c22207488952f146be3bb63b9ecba440ebb81
+  metadata.gz: 83e192b584ccacb1817682f20c3f92863142dcd6bb0f5cf3ad94510c9bfd8b6e
+  data.tar.gz: 0f4e5459438aa41d335cad94e3c4fa9167d5dbc7eb52323cbb56a532e91c76a3
 SHA512:
-  metadata.gz: a36054d54da990c0ea0ab03ce538a903ceed121026e1ac160b1dc2226a21fc12a8b8d422d99b71e545048af33318ab86ae90e8e3a906b6bcb1061983059ac4d4
-  data.tar.gz: 5b8b6759915c77982125b0c33b6f8681dd7ea61c0cce63b0665567fd00e47be468d097e6653cdfd65df5db35ff1ac4f01c98cb39b12d774c741b8cd6ff086e1a
+  metadata.gz: bc71e039869a7b368cdeb864333683d3b9079fb2d4191d70c8bbdb1cd32c8686060814846590d5b418321c9f57b28ab8b35989a86b02282453761a2c90d26467
+  data.tar.gz: 6540b1bcb3b98e523cf5d1790ca160ccb39a1cc0ecec77e2747205727c699710cb67f063fafd3030f8433b8ce0ce85ecc3b075a8e744ad5a8519a8a61ecd4e34

data/.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
         default: 1.17.3
       rails_version:
         type: string
-        default: '5.2.2'
+        default: '5.2.6'
     executor:
       name: 'samvera/ruby'
       ruby_version: << parameters.ruby_version >>
@@ -22,6 +22,17 @@ jobs:
       NOKOGIRI_USE_SYSTEM_LIBRARIES: true
     steps:
       - samvera/cached_checkout
+
+      - run:
+          name: Check for a branch named 'master'
+          command: |
+            git fetch --all --quiet --prune --prune-tags
+            if [[ -n "$(git branch --all --list master */master)" ]]; then
+              echo "A branch named 'master' was found. Please remove it."
+              echo "$(git branch --all --list master */master)"
+            fi
+            [[ -z "$(git branch --all --list master */master)" ]]
+
       - samvera/bundle_for_gem:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
@@ -63,7 +74,7 @@ jobs:
         default: 1.17.3
       rails_version:
         type: string
-        default: '5.2.2'
+        default: '5.2.6'
     executor:
       name: 'samvera/ruby_fcrepo_solr_redis_postgres'
       ruby_version: << parameters.ruby_version >>
@@ -131,10 +142,10 @@ workflows:
     jobs:
       - bundle:
           ruby_version: "2.5.8"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
       - build:
           ruby_version: "2.5.8"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           requires:
             - bundle
       - test:
@@ -146,10 +157,10 @@ workflows:
     jobs:
       - bundle:
           ruby_version: "2.6.6"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
       - build:
           ruby_version: "2.6.6"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           requires:
             - bundle
       - test:
@@ -167,11 +178,11 @@ workflows:
     jobs:
       - bundle:
           ruby_version: "2.7.2"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           bundler_version: "2.1.4"
       - build:
           ruby_version: "2.7.2"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           bundler_version: "2.1.4"
           requires:
             - bundle

data/.dassie/config/role_map.yml

@@ -1,4 +1,6 @@
 development:
+  admin:
+    - admin@example.com
   archivist:
     - archivist1@example.com
 

data/.dassie/db/seeds.rb

@@ -6,7 +6,7 @@
 #   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
 #   Character.create(name: 'Luke', movie: movies.first)
 
-Hyrax::Engine.load_seed
+Hyrax::Engine.load_seed unless ActiveModel::Type::Boolean.new.cast(ENV["SKIP_HYRAX_ENGINE_SEED"])
 
 puts "\n== Loading users"
 User.where(email: 'admin@example.com').first_or_create do |f|

data/.env

@@ -7,7 +7,7 @@ DB_PORT=5432
 DB_HOST=postgres
 FCREPO_PORT=8080
 FCREPO_HOST=fcrepo
-FCREPO_REST_PATH=fcrepo/rest
+FCREPO_REST_PATH=rest
 FCREPO_TEST_BASE_PATH=/test
 HUB_URL=http://chrome:4444/wd/hub
 HYRAX_DERIVATIVES_PATH=/app/samvera/hyrax-webapp/derivatives/

data/CONTAINERS.md

@@ -107,6 +107,26 @@ I (Jeremy) find myself wanting to debug the application.  This requires a somewh
 
 This advice comes from [Debugging Rails App With Docker Compose: How to use Byebug in a dockerized rails app](https://medium.com/gogox-technology/debugging-rails-app-with-docker-compose-39a3767962f4).
 
+### Troubleshooting
+
+#### Bad Address SOLR
+
+With `docker-compose up` running, if you see the following, then there may be issues with file permissions:
+
+```
+db_migrate_1  | waiting for solr:8983
+db_migrate_1  | nc: bad address 'solr'
+```
+
+Check the Docker application logs and look for permission errors:
+
+```
+Executing /opt/docker-solr/scripts/precreate-core hyrax_test /opt/solr/server/configsets/hyraxconf
+cp: cannot create directory '/var/solr/data/hyrax_test': Permission denied
+```
+
+The solution that appears to work is to `docker-compose down --volumes`; This will tear down the docker instance, and remove the volumes.  You can then run `docker-compose up` to get back to work.  _**Note:** the `--volumes` switch will remove all custom data._
+
 <!-- NOTE: This title is referenced in the top-level documentation/developing-your-hyrax-based-app.md. Keep that in mind if you change it. -->
 ## Docker Image for Hyrax-based Applications
 

data/app/actors/hyrax/actors/file_set_actor.rb

@@ -31,10 +31,9 @@ module Hyrax
           # hand. Do this because we don't have the underlying UploadedFile instance
           file_actor = build_file_actor(relation)
           file_actor.ingest_file(wrapper!(file: file, relation: relation))
-          # Copy visibility and permissions from parent (work) to
-          # FileSets even if they come in from BrowseEverything
-          VisibilityCopyJob.perform_later(file_set.parent)
-          InheritPermissionsJob.perform_later(file_set.parent)
+          parent = parent_for(file_set: file_set)
+          VisibilityCopyJob.perform_later(parent)
+          InheritPermissionsJob.perform_later(parent)
         else
           IngestJob.perform_later(wrapper!(file: file, relation: relation))
         end
@@ -138,6 +137,12 @@ module Hyrax
         @ability ||= ::Ability.new(user)
       end
 
+      # @param file_set [FileSet]
+      # @return [ActiveFedora::Base]
+      def parent_for(file_set:)
+        file_set.parent
+      end
+
       def build_file_actor(relation)
         fs = use_valkyrie ? file_set.valkyrie_resource : file_set
         file_actor_class.new(fs, relation, user, use_valkyrie: use_valkyrie)
@@ -179,7 +184,7 @@ module Hyrax
       # Although ActiveFedora clears the children nodes it leaves those fields in Solr populated.
       # rubocop:disable Metrics/CyclomaticComplexity
       def unlink_from_work
-        work = file_set.parent
+        work = parent_for(file_set: file_set)
         return unless work && (work.thumbnail_id == file_set.id || work.representative_id == file_set.id || work.rendering_ids.include?(file_set.id))
         work.thumbnail = nil if work.thumbnail_id == file_set.id
         work.representative = nil if work.representative_id == file_set.id

data/app/controllers/hyrax/admin/permission_template_accesses_controller.rb

@@ -30,10 +30,6 @@ module Hyrax
         false
       end
 
-      def update_access(manage_changed:)
-        permission_template_form.update_access(manage_changed: manage_changed)
-      end
-
       def after_destroy_success
         if source.admin_set?
           redirect_to hyrax.edit_admin_admin_set_path(source_id,

data/app/forms/hyrax/forms/resource_form.rb

@@ -91,7 +91,12 @@ module Hyrax
       property :date_uploaded, readable: false
       property :agreement_accepted, virtual: true, default: false, prepopulator: ->(_opts) { self.agreement_accepted = !model.new_record }
 
-      collection :permissions, virtual: true, default: [], form: Permission, prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions }
+      collection(:permissions,
+                 virtual: true,
+                 default: [],
+                 form: Permission,
+                 populator: :permission_populator,
+                 prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
 
       # virtual properties for embargo/lease;
       property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
@@ -201,6 +206,11 @@ module Hyrax
 
       private
 
+      # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
+      def permission_populator(collection:, index:, **)
+        Permission.new(collection[index])
+      end
+
       def _form_field_definitions
         self.class.definitions
       end

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -7,25 +7,40 @@ module Hyrax
 
     # @param user [User]
     # @param where [Hash] applied as the where clause when querying the Hyrax::WorkRelation
-    #
+    # @return [Integer] number of works matching the where that the user deposited
     # @see Hyrax::WorkRelation
     def number_of_works(user = current_user, where: { generic_type_sim: "Work" })
-      where_clause = where.merge(DepositSearchBuilder.depositor_field => user.user_key)
-      Hyrax::WorkRelation.new.where(where_clause).count
+      field_pairs = field_pairs(user)
+      field_pairs.merge!(where)
+      count(Hyrax::SolrQueryBuilderService.construct_query(field_pairs))
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
 
+    # @param user [User]
+    # @return [Integer] number of FileSets the user deposited
     def number_of_files(user = current_user)
-      ::FileSet.where(DepositSearchBuilder.depositor_field => user.user_key).count
+      count(Hyrax::SolrQueryBuilderService.construct_query_for_model(::FileSet, field_pairs(user)))
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
 
+    # @param user [User]
+    # @return [Integer] number of Collections the user created
     def number_of_collections(user = current_user)
-      ::Collection.where(DepositSearchBuilder.depositor_field => user.user_key).count
+      count(Hyrax::SolrQueryBuilderService.construct_query_for_model(::Collection, field_pairs(user)))
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
+
+    private
+
+    def field_pairs(user)
+      { DepositSearchBuilder.depositor_field => user.user_key }
+    end
+
+    def count(query)
+      Hyrax::SolrService.count(query)
+    end
   end
 end

data/app/helpers/hyrax/embargo_helper.rb

@@ -25,6 +25,10 @@ module Hyrax
     #   holder until we switch to Valkyrie::ChangeSet instead of Form
     #   objects
     def embargo_enforced?(resource)
+      # This is a guard; from the UI rendering perspective, there's no
+      # active embargo enforcement until the object is saved.
+      return false unless resource.persisted?
+
       case resource
       when Hydra::AccessControls::Embargoable
         !resource.embargo_release_date.nil?

data/app/helpers/hyrax/lease_helper.rb

@@ -25,6 +25,10 @@ module Hyrax
     #   holder until we switch to Valkyrie::ChangeSet instead of Form
     #   objects
     def lease_enforced?(resource)
+      # This is a guard; from the UI rendering perspective, there's no
+      # active lease enforcement until the object is saved.
+      return false unless resource.persisted?
+
       case resource
       when Hydra::AccessControls::Embargoable
         !resource.lease_expiration_date.nil?

data/app/helpers/hyrax/url_helper.rb

@@ -4,7 +4,10 @@ module Hyrax
     # generated models get registered as curation concerns and need a
     # track_model_path to render Blacklight-related views
     (['FileSet', 'Collection'] + Hyrax.config.registered_curation_concern_types).each do |concern|
-      define_method("track_#{concern.constantize.model_name.singular_route_key}_path") { |*args| main_app.track_solr_document_path(*args) }
+      model = concern.safe_constantize
+      model_name = model.respond_to?(:model_name) && model.model_name
+      next unless model_name
+      define_method("track_#{model_name.singular_route_key}_path") { |*args| main_app.track_solr_document_path(*args) }
     end
   end
 end

data/app/indexers/hyrax/valkyrie_file_set_indexer.rb

@@ -14,6 +14,8 @@ module Hyrax
 
     def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       super.tap do |solr_doc| # rubocop:disable Metrics/BlockLength
+        solr_doc['generic_type_si'] = 'FileSet'
+
         # Metadata from the FileSet
         solr_doc['file_ids_ssim']         = resource.file_ids&.map(&:to_s)
         solr_doc['original_file_id_ssi']  = resource.original_file_id.to_s

data/app/indexers/hyrax/valkyrie_work_indexer.rb

@@ -11,7 +11,7 @@ module Hyrax
 
     def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       super.tap do |solr_doc|
-        solr_doc['generic_type_sim'] = ['Work']
+        solr_doc['generic_type_si'] = 'Work'
         solr_doc['suppressed_bsi'] = suppressed?(resource)
         solr_doc['admin_set_id_ssim'] = [resource.admin_set_id.to_s]
         solr_doc['member_of_collection_ids_ssim'] = resource.member_of_collection_ids.map(&:to_s)

data/app/jobs/ingest_local_file_job.rb

@@ -2,13 +2,29 @@
 class IngestLocalFileJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
-  # @param [FileSet] file_set
+  # @param [FileSet, Hyrax::FileSet] file_set
   # @param [String] path
   # @param [User] user
   def perform(file_set, path, user)
+    case file_set
+    when ActiveFedora::Base
+      __perform(file_set, path, user, use_valkyrie: false)
+    else
+      __perform(file_set, path, user, use_valkyrie: true)
+    end
+  end
+
+  private
+
+  # @note Based on the present implementation (see SHA a8597884e) of
+  # the Hyrax::Actors::FileSetActor, we wouldn't need to pass the
+  # `use_valkyrie` parameter.  However, I want to include this logic
+  # to demonstrate that "Yes, the IngestLocalFileJob has been tested
+  # for Valkyrie usage"
+  def __perform(file_set, path, user, use_valkyrie:)
     file_set.label ||= File.basename(path)
 
-    actor = Hyrax::Actors::FileSetActor.new(file_set, user)
+    actor = Hyrax::Actors::FileSetActor.new(file_set, user, use_valkyrie: use_valkyrie)
 
     if actor.create_content(File.open(path))
       Hyrax.config.callback.run(:after_import_local_file_success, file_set, user, path, warn: false)

data/app/models/collection_branding_info.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 class CollectionBrandingInfo < ApplicationRecord
-  # i = ColectionImageInfo.new()
-
   def initialize(collection_id:,
                  filename:,
                  role:,
@@ -13,20 +11,32 @@ class CollectionBrandingInfo < ApplicationRecord
     self.role = role
     self.alt_text = alt_txt
     self.target_url = target_url
-
-    self.local_path = find_local_filename(collection_id, role, filename)
+    self.local_path = File.join(role, filename)
   end
 
   def save(file_location, copy_file = true)
-    local_dir = find_local_dir_name(collection_id, role)
-    FileUtils.mkdir_p local_dir
-    FileUtils.cp file_location, local_path unless file_location == local_path || !copy_file
+    filename = File.split(local_path).last
+    role_and_filename = File.join(role, filename)
+
+    storage.upload(resource: Hyrax::PcdmCollection.new(id: collection_id),
+                   file: File.open(file_location),
+                   original_filename: role_and_filename)
+    self.local_path = find_local_filename(collection_id, role, filename)
+
     FileUtils.remove_file(file_location) if File.exist?(file_location) && copy_file
     super()
   end
 
-  def delete(location_path)
-    FileUtils.remove_file(location_path) if File.exist?(location_path)
+  def delete(location_path = nil)
+    id = if location_path
+           Deprecation.warn('Passing an explict location path is ' \
+                            'deprecated. Call without arguments instead.')
+           location_path
+         else
+           local_path
+         end
+
+    storage.delete(id: id)
   end
 
   def find_local_filename(collection_id, role, filename)
@@ -37,4 +47,10 @@ class CollectionBrandingInfo < ApplicationRecord
   def find_local_dir_name(collection_id, role)
     File.join(Hyrax.config.branding_path, collection_id.to_s, role.to_s)
   end
+
+  private
+
+  def storage
+    Hyrax.config.branding_storage_adapter
+  end
 end

data/app/models/concerns/hyrax/embargoable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Hyrax
+  module Embargoable
+    extend ActiveSupport::Concern
+    include Hydra::AccessControls::Embargoable
+
+    included do
+      validates :lease_expiration_date, 'hydra/future_date': true, on: :create
+      validates :embargo_release_date, 'hydra/future_date': true, on: :create
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_embargo?
+      false
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_lease?
+      false
+    end
+  end
+end

data/app/models/concerns/hyrax/work_behavior.rb

@@ -14,7 +14,7 @@ module Hyrax
     include Naming
     include CoreMetadata
     include InAdminSet
-    include Hydra::AccessControls::Embargoable
+    include Hyrax::Embargoable
     include GlobalID::Identification
     include NestedWorks
     include Suppressible