hyrax 3.0.2 → 3.1.0

data/config/locales/hyrax.pt-BR.yml

@@ -1215,7 +1215,7 @@ pt-BR:
         subject: Carga em lote completo
         title: Arquivos carregados com sucesso
     models:
-      hyrax/file_set: Conjunto de arquivos
+      file_set: Conjunto de arquivos
       hyrax/pcdm_collection: Coleção
       hyrax/work: Trabalhar
     my:

data/config/locales/hyrax.zh.yml

@@ -1218,7 +1218,7 @@ zh:
         subject: 批量上传完成
         title: 文件上传成功
     models:
-      hyrax/file_set: 文件集
+      file_set: 文件集
       hyrax/pcdm_collection: 收藏
       hyrax/work: 工作
     my:

data/docker-compose.yml

@@ -109,6 +109,7 @@ services:
       context: .
       target: hyrax-engine-dev-worker
     image: ghcr.io/samvera/dassie-worker
+    user: root
     env_file:
       - .env
       - .dassie/.env

data/documentation/developing-your-hyrax-based-app.md

@@ -125,7 +125,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.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.2/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.1.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/documentation/legacyREADME.md

@@ -50,7 +50,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
-v3.0.2__. If you are looking for instructions on installing a different
+v3.1.0__. 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.
 

data/lib/generators/hyrax/templates/config/initializers/hyrax.rb

@@ -159,6 +159,11 @@ Hyrax.config do |config|
   # Should a button with "Share my work" show on the front page to all users (even those not logged in)?
   # config.display_share_button_when_not_logged_in = true
 
+  # This user is logged as the acting user for jobs and other processes that
+  # run without being attributed to a specific user (e.g. creation of the
+  # default admin set).
+  # config.system_user_key = 'systemuser@example.com'
+
   # The user who runs batch jobs. Update this if you aren't using emails
   # config.batch_user_key = 'batchuser@example.com'
 

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # @api public
+  #
+  # Given a model class and an +id+, provides +ActiveModel+ style methods. This
+  # is a tool for providing route resolution and other +ActiveModel+ behavior
+  # for +ActiveFedora+ without loading the object from the fedora backend.
+  #
+  # @note this was originally implemented for +SolrDocument+ as
+  #   +Hyrax::SolrDocumentBehavior::ModelWrapper+, but is useful in the more
+  #   general case that we know the model class and id, but don't have a full
+  #   model object.
+  #
+  class ActiveFedoraDummyModel
+    ##
+    # @api public
+    #
+    # @param [Class] model
+    # @param [String, nil] id
+    def initialize(model, id)
+      @model = model
+      @id = id
+    end
+
+    ##
+    # @api public
+    def persisted?
+      true
+    end
+
+    ##
+    # @api public
+    def to_param
+      @id
+    end
+
+    ##
+    # @api public
+    def model_name
+      @model.model_name
+    end
+
+    ##
+    # @api public
+    #
+    # @note uses the @model's `._to_partial_path` if implemented, otherwise
+    #   constructs a default
+    def to_partial_path
+      return @model._to_partial_path if
+        @model.respond_to?(:_to_partial_path)
+
+      "hyrax/#{model_name.collection}/#{model_name.element}"
+    end
+
+    ##
+    # @api public
+    def to_global_id
+      URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
+    end
+  end
+end

data/lib/hyrax/configuration.rb

@@ -643,6 +643,14 @@ module Hyrax
       @show_work_item_rows ||= 10 # rows on show view
     end
 
+    # This user is logged as the acting user for jobs and other processes that
+    # run without being attributed to a specific user (e.g. creation of the
+    # default admin set).
+    attr_writer :system_user_key
+    def system_user_key
+      @system_user_key ||= 'systemuser@example.com'
+    end
+
     attr_writer :batch_user_key
     def batch_user_key
       @batch_user_key ||= 'batchuser@example.com'

data/lib/hyrax/engine.rb

@@ -22,6 +22,7 @@ module Hyrax
     require 'valkyrie'
 
     require 'hydra/derivatives'
+    require 'hyrax/active_fedora_dummy_model'
     require 'hyrax/controller_resource'
     require 'hyrax/form_fields'
     require 'hyrax/indexer'

data/lib/hyrax/errors.rb

@@ -12,5 +12,7 @@ module Hyrax
 
   class SingleUseError < HyraxError; end
 
+  class SingleMembershipError < HyraxError; end
+
   class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
 end

data/lib/hyrax/specs/capybara.rb

@@ -40,7 +40,9 @@ if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
   Capybara.server_host = '0.0.0.0'
   Capybara.server_port = 3010
-  Capybara.app_host = ENV['CAPYBARA_SERVER'] || 'http://127.0.0.1:3010'
+
+  ip = IPSocket.getaddress(Socket.gethostname)
+  Capybara.app_host = "http://#{ip}:#{Capybara.server_port}"
 else
   TEST_HOST = 'localhost:3000'.freeze
   # @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux

data/lib/hyrax/specs/shared_specs/valkyrie_storage_versions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a Valkyrie::StorageAdapter with versioning support' do
+  describe '#supports?' do
+    it 'supports versions' do
+      expect(storage_adapter.supports?(:versions)).to eq true
+    end
+  end
+end

data/lib/hyrax/transactions/container.rb

@@ -21,11 +21,13 @@ module Hyrax
       require 'hyrax/transactions/apply_change_set'
       require 'hyrax/transactions/create_work'
       require 'hyrax/transactions/destroy_work'
+      require 'hyrax/transactions/file_set_destroy'
       require 'hyrax/transactions/work_create'
       require 'hyrax/transactions/work_destroy'
       require 'hyrax/transactions/update_work'
       require 'hyrax/transactions/steps/add_file_sets'
       require 'hyrax/transactions/steps/add_to_collections'
+      require 'hyrax/transactions/steps/add_to_parent'
       require 'hyrax/transactions/steps/apply_collection_permission_template'
       require 'hyrax/transactions/steps/apply_permission_template'
       require 'hyrax/transactions/steps/apply_visibility'
@@ -33,6 +35,7 @@ module Hyrax
       require 'hyrax/transactions/steps/destroy_work'
       require 'hyrax/transactions/steps/ensure_admin_set'
       require 'hyrax/transactions/steps/ensure_permission_template'
+      require 'hyrax/transactions/steps/remove_file_set_from_work'
       require 'hyrax/transactions/steps/save'
       require 'hyrax/transactions/steps/save_work'
       require 'hyrax/transactions/steps/save_access_control'
@@ -92,11 +95,29 @@ module Hyrax
         end
       end
 
+      namespace 'file_set' do |ops| # Hyrax::FileSet
+        ops.register 'delete' do
+          Steps::DeleteResource.new
+        end
+
+        ops.register 'destroy' do
+          FileSetDestroy.new
+        end
+
+        ops.register 'remove_from_work' do
+          Steps::RemoveFileSetFromWork.new
+        end
+      end
+
       namespace 'work_resource' do |ops| # valkyrie works
         ops.register 'add_file_sets' do
           Steps::AddFileSets.new
         end
 
+        ops.register 'add_to_parent' do
+          Steps::AddToParent.new
+        end
+
         ops.register 'delete' do
           Steps::DeleteResource.new
         end

data/lib/hyrax/transactions/file_set_destroy.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # destroys a FileSet resource.
+    #
+    # @since 3.1.0
+    class FileSetDestroy < Transaction
+      DEFAULT_STEPS = ['file_set.remove_from_work',
+                       'file_set.delete'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/add_file_sets.rb

@@ -20,10 +20,11 @@ module Hyrax
         ##
         # @param [Hyrax::Work] obj
         # @param [Enumerable<UploadedFile>] uploaded_files
+        # @param [Enumerable<Hash>] file_set_params
         #
         # @return [Dry::Monads::Result]
-        def call(obj, uploaded_files: [])
-          if @handler.new(work: obj).add(files: uploaded_files).attach
+        def call(obj, uploaded_files: [], file_set_params: [])
+          if @handler.new(work: obj).add(files: uploaded_files, file_set_params: file_set_params).attach
             Success(obj)
           else
             Failure[:failed_to_attach_file_sets, uploaded_files]

data/lib/hyrax/transactions/steps/add_to_parent.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds a work to a parent work
+      #
+      # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
+      class AddToParent
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Hyrax::Work] obj
+        # @param [#to_s] parent_id
+        #
+        # @return [Dry::Monads::Result]
+        def call(obj, parent_id: nil, user: nil)
+          return Success(obj) if parent_id.blank?
+
+          parent = Hyrax.query_service.find_by(id: parent_id)
+          parent.member_ids << obj.id
+          Hyrax.persister.save(resource: parent)
+
+          user ||= ::User.find_by_user_key(obj.depositor)
+          Hyrax.publisher.publish('object.metadata.updated', object: parent, user: user)
+
+          Success(obj)
+        rescue Valkyrie::Persistence::ObjectNotFoundError => _err
+          Failure[:parent_object_not_found, parent_id]
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/remove_file_set_from_work.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'dry/monads'
+
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # removes the file set from all its parents, returning a
+      # `Dry::Monads::Result` (`Success`|`Failure`).
+      #
+      # there should normally be only one parent for a FileSet, but in the case
+      # that there are multiple, this step will remove the file set from all
+      # parents.
+      #
+      # if no user is provided to attribute the removal to, the step fails
+      # immediately.
+      #
+      # @see https://dry-rb.org/gems/dry-monads/1.0/result/
+      class RemoveFileSetFromWork
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Valkyrie::QueryService] query_service
+        def initialize(query_service: Hyrax.query_service, persister: Hyrax.persister)
+          @persister     = persister
+          @query_service = query_service
+        end
+
+        ##
+        # @param [Hyrax::FileSet] file_set
+        #
+        # @return [Dry::Monads::Result]
+        def call(file_set, user: nil)
+          return Failure('No user provided.') if user.nil?
+
+          @query_service.find_parents(resource: file_set).each do |parent|
+            parent.member_ids -= [file_set.id]
+            saved = @persister.save(resource: parent)
+            Hyrax.publisher.publish('object.metadata.updated', object: saved, user: user)
+          end
+
+          Success(file_set)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/work_create.rb

@@ -14,7 +14,8 @@ module Hyrax
                        'change_set.add_to_collections',
                        'change_set.apply',
                        'work_resource.save_acl',
-                       'work_resource.add_file_sets'].freeze
+                       'work_resource.add_file_sets',
+                       'work_resource.add_to_parent'].freeze
 
       ##
       # @see Hyrax::Transactions::Transaction

data/lib/hyrax/valkyrie_can_can_adapter.rb

@@ -19,6 +19,7 @@ module Hyrax
     #
     # @raise Hyrax::ObjectNotFoundError
     def self.find(_model_class, id)
+      return Hyrax.query_service.find_by(id: id) unless Hyrax.config.enable_noids?
       Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: id)
     rescue Valkyrie::Persistence::ObjectNotFoundError => err
       raise Hyrax::ObjectNotFoundError, err.message

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '3.0.2'
+  VERSION = '3.1.0'
 end

data/lib/hyrax.rb

@@ -25,6 +25,13 @@ require 'valkyrie/indexing_adapter'
 require 'valkyrie/indexing/solr/indexing_adapter'
 require 'valkyrie/indexing/null_indexing_adapter'
 
+##
+# Hyrax is a Ruby on Rails Engine built by the Samvera community. The engine
+# provides a foundation for creating many different digital repository
+# applications.
+#
+# @see https://samvera.org Samvera Community
+# @see https://guides.rubyonrails.org/engines.html Rails Guides: Getting Started with Engines
 module Hyrax
   extend ActiveSupport::Autoload
 
@@ -46,6 +53,8 @@ module Hyrax
   def self.GlobalID(input) # rubocop:disable Naming/MethodName
     case input
     when Valkyrie::Resource
+      return input.to_global_id if input.respond_to?(:to_global_id)
+
       ValkyrieGlobalIdProxy.new(resource: input).to_global_id
     else
       input.to_global_id if input.respond_to?(:to_global_id)

data/lib/tasks/collection_type_global_id.rake

@@ -2,7 +2,7 @@
 namespace :hyrax do
   namespace :collections do
     desc 'Update CollectionType global id references for Hyrax 3.0.0'
-    task :update_collection_type_global_ids do
+    task update_collection_type_global_ids: :environment do
       puts 'Updating collection -> collection type GlobalId references.'
 
       count = 0

data/lib/tasks/regenerate_derivatives.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :hyrax do
+  namespace :file_sets do
+    desc 'Regenerate derivatives for all FileSets in the repository'
+    task regenerate_derivatives: :environment do
+      FileSet.all.each do |fs|
+        fs.files.each { |fi| CreateDerivativesJob.perform_later(fs, fi) }
+      end
+    end
+  end
+end

data/lib/wings/orm_converter.rb

@@ -40,6 +40,12 @@ module Wings
             _canonical_valkyrie_model&.name
           end
 
+          ##
+          # @return [String]
+          def to_s
+            internal_resource
+          end
+
           ##
           # @api private
           def _canonical_valkyrie_model
@@ -47,8 +53,18 @@ module Wings
           end
         end
 
-        def self.to_s
-          internal_resource
+        ##
+        # @return [URI::GID]
+        def to_global_id
+          URI::GID.build([GlobalID.app, internal_resource, id, {}])
+        end
+
+        ##
+        # @return [ActiveModel::Base]
+        def to_model
+          model_class = internal_resource.safe_constantize || self
+
+          Hyrax::ActiveFedoraDummyModel.new(model_class, id)
         end
 
         klass.properties.each_key do |property_name|