DOI minting for data and code pathway

.rubocop.yml

@@ -57,6 +57,10 @@ Rails/ApplicationController:
   Exclude:
     - 'app/controllers/api/v1/rest_controller.rb'
 
+Rails/Blank:
+  Exclude:
+    - 'app/forms/work_deposit_pathway.rb' 
+
 Rails/SkipsModelValidations:
   Exclude:
     - 'app/controllers/dashboard/form/publish_controller.rb'

app/controllers/dashboard/form/base_controller.rb

@@ -82,6 +82,11 @@ def allow_curation?
           deposit_pathway.allows_curation_request? && in_publish_edit_action?
         end
 
+        helper_method :allow_mint_doi?
+        def allow_mint_doi?
+          deposit_pathway.allows_mint_doi_request?
+        end
+
         helper_method :allow_publish?
         def allow_publish?
           if deposit_pathway.work?

app/controllers/dashboard/form/publish_controller.rb

@@ -3,6 +3,8 @@
 module Dashboard
   module Form
     class PublishController < BaseController
+      class DoiIsMintingError < RuntimeError; end
+
       def edit
         @work_version = WorkVersion
           .includes(file_version_memberships: [:file_resource])
@@ -32,6 +34,9 @@ def update
           @resource.indexing_source = Proc.new { nil }
           @resource.save
           @resource.publish
+          if @resource.mint_doi_requested
+            allow_mint_doi? ? MintDoiAsync.call(@resource.work) : flash[:error] = t('dashboard.form.publish.doi.error')
+          end
         elsif request_curation? && [email protected]_curation_requested
           @resource.update_column(:draft_curation_requested, true)
           # We want validation errors to block curation requests and keep users on the edit page
@@ -115,6 +120,7 @@ def work_version_params
               :published_date,
               :depositor_agreement,
               :draft_curation_requested,
+              :mint_doi_requested,
               keyword: [],
               contributor: [],
               publisher: [],

app/forms/work_deposit_pathway.rb

@@ -33,6 +33,10 @@ def allows_curation_request?
     data_and_code? && [email protected]_curation_requested
   end
 
+  def allows_mint_doi_request?
+    data_and_code? && @resource.work.doi.blank? && !DoiMintingStatus.new(@resource.work).present?
+  end
+
   def work?
     Work::Types.all.include?(work_type)
   end
@@ -117,6 +121,7 @@ def imported_metadata_from_rmd?
                :update_doi=,
                :work_type,
                :draft_curation_requested,
+               :mint_doi_requested,
                to: :work_version, prefix: false
 
       private
@@ -258,6 +263,7 @@ def form_partial
                  :aasm,
                  :update_column,
                  :draft_curation_requested=,
+                 :mint_doi_requested=,
                  :set_thumbnail_selection,
                  to: :work_version,
                  prefix: false

app/jobs/doi_minting_job.rb

@@ -4,6 +4,7 @@ class DoiMintingJob < ApplicationJob
   queue_as :doi
 
   def perform(resource)
+    sleep(2)
     status = DoiMintingStatus.new(resource)
 
     status.minting!

app/views/dashboard/form/publish/_doi.html.erb

@@ -0,0 +1,20 @@
+<div class="form-group mt-5">
+  <div class="keyline keyline--left">
+    <h4><%= t '.header' %></h4>
+  </div>
+  <div>
+      <div>
+        <%= t '.request_description' %>
+      </div>
+      <br>
+      <div class="form-check">
+        <%= form.check_box :mint_doi_requested,
+                           required: false,
+                           class: 'form-check-input' %>
+
+        <%= form.label :mint_doi_requested, class: 'form-check-label' do %>
+          <%= t '.label' %>
+        <% end %>
+      </div>
+  </div>
+</div>

app/views/dashboard/form/publish/_fields.html.erb

@@ -30,6 +30,10 @@
       <%= render 'curation', form: form %>
     <% end %>
 
+    <% if allow_mint_doi? %>
+      <%= render 'doi', form: form %>
+    <% end %>
+
     <div class="form-group mt-5">
       <div class="keyline keyline--left">
         <h2 id="<%= WorkVersion.human_attribute_name(:depositor_agreement).parameterize %>" class="h4">

config/locales/en.yml

@@ -485,6 +485,11 @@ en:
           curation_requested: Curation has been requested. We will notify you when curation is complete and your work is ready to be published. If you have any questions in the meantime, please contact ScholarSphere curators via our 
           error: There was an error with your curation request. Please try again later or contact us if the problem persists.
           contact: contact form
+        doi:
+          header: Mint DOI (Optional)
+          request_description: Placeholder for mint doi description
+          label: I would like to mint a DOI upon publish.
+          error: There was an error minting your doi. Please try again later from Work Settings or contact us if the problem persists.
       members:
         heading: Works
         badge: Work 

db/migrate/20240910195820_add_mint_doi_requested_to_work_version.rb

@@ -0,0 +1,5 @@
+class AddMintDoiRequestedToWorkVersion < ActiveRecord::Migration[6.1]
+  def change
+    add_column :work_versions, :mint_doi_requested, :boolean
+  end
+end

db/schema.rb

@@ -10,7 +10,8 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2024_03_21_203236) do
+ActiveRecord::Schema.define(version: 2024_09_10_195820) do
+
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_stat_statements"
   enable_extension "plpgsql"
@@ -263,6 +264,7 @@
     t.boolean "imported_metadata_from_rmd"
     t.boolean "draft_curation_requested"
     t.datetime "sent_for_curation_at"
+    t.boolean "mint_doi_requested"
     t.index ["external_app_id"], name: "index_work_versions_on_external_app_id"
     t.index ["work_id", "version_number"], name: "index_work_versions_on_work_id_and_version_number", unique: true
     t.index ["work_id"], name: "index_work_versions_on_work_id"

spec/features/dashboard/work_version_form_spec.rb

@@ -1242,4 +1242,70 @@ def mock_solr_indexing_job
       end
     end
   end
+
+  describe 'minting a doi', js: true do
+    let(:user) { work_version.work.depositor.user }
+
+    context 'with a draft eligible for doi minting' do
+      let(:work) { create :work, work_type: 'dataset', versions_count: 1, has_draft: true, doi: nil }
+      let(:work_version) { work.versions.first }
+
+      it 'renders a checkbox requesting a doi be minted upon publish' do
+        visit dashboard_form_publish_path(work_version)
+
+        expect(page).to have_content(I18n.t('dashboard.form.publish.doi.label'))
+      end
+    end
+
+    context 'with a draft not eligible for doi minting' do
+      let(:work) { create :work, work_type: 'dataset', versions_count: 1, has_draft: true, doi: '10.26207/x8qe-xp35' }
+      let(:work_version) { work.versions.first }
+
+      it 'does not render a checkbox requesting a doi be minted upon publish' do
+        visit dashboard_form_publish_path(work_version)
+
+        expect(page).not_to have_content(I18n.t('dashboard.form.publish.doi.label'))
+      end
+    end
+
+    context 'when minting doi is successfully requested' do
+      let(:work_version) { create :work_version, :dataset_able_to_be_published }
+      let(:work) { create :work, work_type: 'dataset', versions_count: 1, has_draft: true, doi: nil, versions: [work_version] }
+
+      before do
+        allow(MintDoiAsync).to receive(:call).with(work_version.work)
+      end
+
+      it 'calls the MintDoi job' do
+        visit dashboard_form_publish_path(work_version)
+
+        check I18n.t('dashboard.form.publish.doi.label')
+        check 'I have read and agree to the deposit agreement.'
+
+        click_on 'Publish'
+
+        expect(MintDoiAsync).to have_received(:call).with(work_version.work)
+      end
+    end
+
+    context 'when an error occurs and the work version does not publish' do
+      let(:work_version) { create :work_version, :dataset_able_to_be_published }
+      let(:work) { create :work, work_type: 'dataset', versions_count: 1, has_draft: true, doi: nil, versions: [work_version] }
+
+      before do
+        work_version.work.doi = nil
+        allow(MintDoiAsync).to receive(:call).with(work_version.work)
+      end
+
+      it 'does not mint a doi' do
+        visit dashboard_form_publish_path(work_version)
+
+        check I18n.t('dashboard.form.publish.doi.label')
+
+        click_on 'Publish'
+
+        expect(MintDoiAsync).not_to have_received(:call).with(work_version.work)
+      end
+    end
+  end
 end

spec/forms/work_deposit_pathways/data_and_code/publish_form_spec.rb

@@ -89,6 +89,17 @@
     end
   end
 
+  describe '#mint_doi_requested=' do
+    before { allow(wv).to receive(:mint_doi_requested=) }
+
+    let(:arg) { double }
+
+    it 'delegates to the given work version' do
+      form.mint_doi_requested = arg
+      expect(wv).to have_received(:mint_doi_requested=).with(arg)
+    end
+  end
+
   describe '.form_fields' do
     it "returns a frozen array of the names of the form's fields" do
       expect(described_class.form_fields).to match_array %w{

spec/models/work_spec.rb

@@ -507,6 +507,7 @@
           keyword_sim
           keyword_tesim
           language_tesim
+          mint_doi_requested_tesim
           model_ssi
           proxy_id_isi
           published_date_dtrsi