hyrax 2.3.3 → 2.4.0

data/lib/hyrax/transactions/create_work.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    ##
+    # A transaction for creating a Work ready for use in Hyrax. Handles
+    # ensuring admin sets and permission templates are present, and setting
+    # system managed dates prior to save.
+    #
+    # @note This is an experimental replacement for the actor stack's `#create`
+    #   stack. In time, we hope this will have feature parity with that stack,
+    #   along with improved architecture, error handling, readability, and
+    #   customizability. While this develops, please provide feedback.
+    #
+    # @since 2.4.0
+    #
+    # @example Creating a work transactionally
+    #   work   = MyWork.new(title: ['Comet in Moominland'])
+    #   result = Hyrax::Transactions::CreateWork.call(work)
+    #   result.success? => true
+    #
+    # @example Handling errors with procedural style
+    #   work   = MyWork.new # invalid work (no title)
+    #   result = Hyrax::Transactions::CreateWork.call(work)
+    #   result.success? => false
+    #
+    #   result.failure # => failure description or object
+    #
+    # @example Handling errors with `#or`
+    #   work   = MyWork.new # invalid work (no title)
+    #
+    #   Hyrax::Transactions::CreateWork
+    #     .call(work)
+    #     .or { |error| handle_error(error) }
+    #
+    # @see https://dry-rb.org/gems/dry-transaction/
+    class CreateWork
+      include Dry::Transaction(container: Hyrax::Transactions::Container)
+
+      step :set_default_admin_set,     with: 'work.set_default_admin_set'
+      step :ensure_admin_set,          with: 'work.ensure_admin_set'
+      step :apply_permission_template, with: 'work.apply_permission_template'
+      step :set_modified_date,         with: 'work.set_modified_date'
+      step :set_uploaded_date,         with: 'work.set_uploaded_date'
+      step :save_work,                 with: 'work.save_work'
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transcation` step that applies a permission template.
+      #
+      # @since 2.4.0
+      class ApplyPermissionTemplate
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result]
+        def call(work)
+          return Failure(:missing_permission) unless
+            (template = work&.admin_set&.permission_template)
+
+          Hyrax::PermissionTemplateApplicator.apply(template).to(model: work)
+
+          Success(work)
+        rescue ActiveRecord::RecordNotFound => err
+          Failure(err)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that ensures the input `work` has an AdminSet.
+      #
+      # @since 2.4.0
+      class EnsureAdminSet
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result] `Failure` if there is no `AdminSet` for
+        #   the input; `Success(input)`, otherwise.
+        def call(work)
+          work.admin_set_id ? Success(work) : Failure(:no_admin_set_id)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that ensures the input `work` has a permission
+      # template.
+      #
+      # @since 2.4.0
+      class EnsurePermissionTemplate
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result] `Failure` if there is no
+        #   `PermissionTemplate` for the input; `Success(input)`, otherwise.
+        def call(work)
+          return Failure(:no_permission_template) unless
+            Hyrax::PermissionTemplate.find_by(source_id: work.admin_set&.id)
+
+          Success(work)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that saves an input work.
+      #
+      # @example saving a work
+      #   step = Hyrax::Transactions::Steps::SaveWork.new
+      #   work = MyWork.new(title: ['Comet in Moominland'])
+      #
+      #   step.call(work) # => Success
+      #
+      # @example handling error cases
+      #   step = Hyrax::Transactions::Steps::SaveWork.new
+      #   work = MyWork.new(title: [:invalid_title])
+      #
+      #   step.call(work).or { |err| puts err.messages }
+      #
+      # @since 2.4.0
+      class SaveWork
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result] `Failure` if the work fails to save;
+        #   `Success(input)`, otherwise.
+        def call(work)
+          work.save ? Success(work) : Failure(work.errors)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that sets the `AdminSet` for an input work to
+      # the default admin set, if none is already set. Creates the default
+      # admin set if it doesn't already exist.
+      class SetDefaultAdminSet
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result]
+        def call(work)
+          work.admin_set ||=
+            AdminSet.find(AdminSet.find_or_create_default_admin_set_id)
+
+          Success(work)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that sets the modified date to now for an
+      # input work.
+      #
+      # @since 2.4.0
+      class SetModifiedDate
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result]
+        def call(work)
+          work.date_modified = Hyrax::TimeService.time_in_utc
+
+          Success(work)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transaction` step that sets the uploaded date to now for an
+      # input work.
+      #
+      # @since 2.4.0
+      class SetUploadedDate
+        include Dry::Transaction::Operation
+
+        ##
+        # @note the current implementation sets the uploaded date to
+        #   `#date_modified` if it exists, falling back on the current datetime.
+        #
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result]
+        def call(work)
+          work.date_uploaded =
+            work.date_modified || Hyrax::TimeService.time_in_utc
+          Success(work)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/version.rb

@@ -1,3 +1,3 @@
 module Hyrax
-  VERSION = '2.3.3'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/spec/actors/hyrax/actors/create_with_files_ordered_members_actor_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Hyrax::Actors::CreateWithFilesOrderedMembersActor do
+  let(:user) { create(:user) }
+  let(:ability) { ::Ability.new(user) }
+  let(:work) { create(:generic_work, user: user) }
+  let(:env) { Hyrax::Actors::Environment.new(work, ability, attributes) }
+  let(:terminator) { Hyrax::Actors::Terminator.new }
+  let(:uploaded_file1) { create(:uploaded_file, user: user) }
+  let(:uploaded_file2) { create(:uploaded_file, user: user) }
+  let(:uploaded_file_ids) { [uploaded_file1.id, uploaded_file2.id] }
+  let(:attributes) { { uploaded_files: uploaded_file_ids } }
+
+  subject(:middleware) do
+    stack = ActionDispatch::MiddlewareStack.new.tap do |middleware|
+      middleware.use described_class
+    end
+    stack.build(terminator)
+  end
+
+  [:create, :update].each do |mode|
+    context "on #{mode}" do
+      before do
+        allow(terminator).to receive(mode).and_return(true)
+      end
+      context "when uploaded_file" do
+        it "invoke the job" do
+          expect(AttachFilesToWorkWithOrderedMembersJob).to receive(:perform_later)
+          middleware.public_send(mode, env)
+        end
+      end
+
+      context "when no uploaded_file" do
+        let(:uploaded_file_ids) { [] }
+
+        it "doesn't invoke job" do
+          expect(AttachFilesToWorkWithOrderedMembersJob).not_to receive(:perform_later)
+          expect(middleware.public_send(mode, env)).to be true
+        end
+      end
+    end
+  end
+end

data/spec/actors/hyrax/actors/create_with_remote_files_ordered_members_actor_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Hyrax::Actors::CreateWithRemoteFilesOrderedMembersActor do
+  let(:terminator) { Hyrax::Actors::Terminator.new }
+  let(:actor) { stack.build(terminator) }
+  let(:stack) do
+    ActionDispatch::MiddlewareStack.new.tap do |middleware|
+      middleware.use described_class
+    end
+  end
+  let(:user) { create(:user) }
+  let(:ability) { Ability.new(user) }
+  let(:work) { create(:generic_work, user: user) }
+  let(:url1) { "https://dl.dropbox.com/fake/blah-blah.filepicker-demo.txt.txt" }
+  let(:url2) { "https://dl.dropbox.com/fake/blah-blah.Getting%20Started.pdf" }
+
+  let(:remote_files) do
+    [{ url: url1,
+       expires: "2014-03-31T20:37:36.214Z",
+       file_name: "filepicker-demo.txt.txt" },
+     { url: url2,
+       expires: "2014-03-31T20:37:36.731Z",
+       file_name: "Getting+Started.pdf" }]
+  end
+  let(:attributes) { { remote_files: remote_files } }
+  let(:environment) { Hyrax::Actors::Environment.new(work, ability, attributes) }
+
+  before do
+    allow(terminator).to receive(:create).and_return(true)
+  end
+
+  context "with two file_sets" do
+    let(:remote_files) do
+      [{ url: url1,
+         expires: "2014-03-31T20:37:36.214Z",
+         file_name: "filepicker-demo.txt.txt" },
+       { url: url2,
+         expires: "2014-03-31T20:37:36.731Z",
+         file_name: "Getting+Started.pdf" }]
+    end
+
+    it "attaches files and passes ordered_members to OrderedMembersActor in correct order" do
+      expect(Hyrax::Actors::OrderedMembersActor).to receive(:new).with([FileSet, FileSet], user).and_return(Hyrax::Actors::OrderedMembersActor)
+      expect(Hyrax::Actors::OrderedMembersActor).to receive(:attach_ordered_members_to_work).with(work)
+      expect(ImportUrlJob).to receive(:perform_later).with(FileSet, Hyrax::Operation, {}).twice
+      expect(actor.create(environment)).to be true
+      expect(actor.ordered_members.first.label).to eq('filepicker-demo.txt.txt')
+      expect(actor.ordered_members.last.label).to eq('Getting+Started.pdf')
+    end
+  end
+end

data/spec/actors/hyrax/actors/file_set_ordered_members_actor_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe Hyrax::Actors::FileSetOrderedMembersActor do
+  include ActionDispatch::TestProcess
+
+  let(:user)          { create(:user) }
+  let(:file_path)     { File.join(fixture_path, 'world.png') }
+  let(:file)          { fixture_file_upload(file_path, 'image/png') } # we will override for the different types of File objects
+  let(:local_file)    { File.open(file_path) }
+  let(:file_set)      { create(:file_set, content: local_file) }
+  let(:actor)         { described_class.new(file_set, user) }
+  let(:relation)      { :original_file }
+  let(:file_actor)    { Hyrax::Actors::FileActor.new(file_set, relation, user) }
+
+  describe 'creating metadata, content and attaching to a work' do
+    let(:work) { create(:generic_work) }
+    let(:date_today) { DateTime.current }
+
+    subject { file_set.reload }
+
+    before do
+      allow(DateTime).to receive(:current).and_return(date_today)
+      allow(actor).to receive(:acquire_lock_for).and_yield
+      actor.create_metadata
+      actor.create_content(file)
+      actor.attach_to_work(work)
+    end
+
+    context 'when a work is provided' do
+      it 'does not add the FileSet to the parent work' do
+        expect(subject.parents).to eq []
+        expect(subject.visibility).to eq 'restricted'
+        expect(work.reload.file_sets).not_to include(subject)
+      end
+    end
+  end
+end

data/spec/actors/hyrax/actors/ordered_members_actor_spec.rb

@@ -0,0 +1,59 @@
+require 'redlock'
+
+RSpec.describe Hyrax::Actors::OrderedMembersActor do
+  include ActionDispatch::TestProcess
+
+  let(:user)          { create(:user) }
+  let(:actor)         { described_class.new([file_set], user) }
+  let(:file_set) { build(:file_set) }
+  let(:work) { create(:generic_work) }
+
+  describe 'attaching to a work' do
+    before do
+      allow(actor).to receive(:acquire_lock_for).and_yield
+      actor.attach_ordered_members_to_work(work)
+    end
+
+    context 'when a work is provided' do
+      it 'adds the FileSet to the parent work' do
+        expect(file_set.parents).to eq [work]
+        expect(work.reload.file_sets).to include(file_set)
+      end
+    end
+
+    context 'with multiple file_sets' do
+      let(:work_v1) { create(:generic_work) } # this version of the work has no members
+
+      before do # another file_set is added
+        work.ordered_members << create(:file_set)
+        work.save!
+      end
+
+      it "now contains two file_sets" do
+        expect(work.members.size).to eq 2
+      end
+    end
+
+    context 'with multiple versions' do
+      let(:work_v1) { create(:generic_work) } # this version of the work has no members
+
+      before do # another version of the same work is saved with a member
+        work_v2 = ActiveFedora::Base.find(work_v1.id)
+        work_v2.ordered_members << create(:file_set)
+        work_v2.save!
+      end
+
+      it "writes to the most up to date version" do
+        actor.attach_ordered_members_to_work(work_v1)
+        expect(work_v1.members.size).to eq 2
+      end
+    end
+  end
+
+  describe "#runs callbacks" do
+    it 'runs callbacks' do
+      expect(FileSetAttachedEventJob).to receive(:perform_later).with(file_set, user)
+      actor.attach_ordered_members_to_work(work)
+    end
+  end
+end

data/spec/controllers/hyrax/embargoes_controller_spec.rb

@@ -107,6 +107,7 @@ RSpec.describe Hyrax::EmbargoesController do
           expect(a_work.reload.visibility).to eq Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
           expect(file_set.reload.visibility).to eq Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
           expect(response).to redirect_to embargoes_path
+          expect(flash[:notice]).to be_present
         end
       end
 
@@ -138,6 +139,7 @@ RSpec.describe Hyrax::EmbargoesController do
           expect(file_set2.reload.visibility).to eq Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
           expect(file_set3.reload.visibility).to eq Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
           expect(response).to redirect_to embargoes_path
+          expect(flash[:notice]).to be_present
         end
       end
     end