Add ProFormA validity checks and disable exporting not invalid

Author: kkoehn

app/assets/stylesheets/tasks.css.scss

@@ -110,6 +110,16 @@
     margin-bottom: 0 !important;
   }
 }
+.button-box{
+
+  .btn.disabled{
+    border: 1px solid lightgray;
+  }
+}
+
+.disabled-btn-wrapper {
+  width: 100%;
+}
 
 .completeness-checklist-container {
   background: white;

app/controllers/task_contributions_controller.rb

@@ -45,6 +45,7 @@ def show
     @files = @task.files
     @tests = @task.tests
     @model_solutions = @task.model_solutions
+    @proforma_valid = [nil, *ProformaXML::SCHEMA_VERSIONS].index_with {|v| @task.proforma_valid?(schema_version: v) }
 
     @user_rating = @task.ratings&.find_by(user: current_user)&.rating
     render 'tasks/show'

app/controllers/tasks_controller.rb

@@ -38,6 +38,7 @@ def show
     @tests = @task.tests
     @model_solutions = @task.model_solutions
 
+    @proforma_valid = [nil, *ProformaXML::SCHEMA_VERSIONS].index_with {|v| @task.proforma_valid?(schema_version: v) }
     @user_rating = @task.ratings&.find_by(user: current_user) || Rating.new(Rating::CATEGORIES.index_with {|_category| 0 })
   end
 

app/models/task.rb

@@ -259,6 +259,17 @@ def url_for(action)
     Rails.application.routes.url_helpers.url_for(controller:, action:, **id_options, only_path: true)
   end
 
+  def proforma_valid?(schema_version: nil)
+    check_versions = schema_version.nil? ? ProformaXML::SCHEMA_VERSIONS : [schema_version]
+
+    check_versions.all? do |version|
+      ProformaService::ExportTask.call(task: self, options: {version:})
+      true
+    rescue ProformaXML::PostGenerateValidationError
+      false
+    end
+  end
+
   private
 
   def duplicate_tests(set_parent_id: true)

app/views/tasks/show.html.slim

@@ -519,13 +519,22 @@
       .wrapper
         - if policy(@task).download?
           .dropdown.btn-group
-            = button_tag class: 'btn btn-light dropdown-toggle', 'data-bs-toggle': 'dropdown' do
-              = t('common.button.download_zip')
+            - if @proforma_valid[nil]
+              = button_tag class: 'btn btn-light dropdown-toggle', 'data-bs-toggle': 'dropdown' do
+                = t('common.button.download_zip')
+            - else
+              .disabled-btn-wrapper data-bs-toggle='tooltip' title=t('.not_proforma_valid', version: '')
+                = button_tag class: 'btn btn-light dropdown-toggle disabled', 'data-bs-toggle': 'dropdown' do
+                  = t('common.button.download_zip')
             ul.scrollable.dropdown-menu role='menu'
               li.dropdown-header = "#{t('common.button.available_versions')}: "
               - ProformaXML::SCHEMA_VERSIONS.each do |proforma_version|
                 li
-                  = link_to proforma_version, download_task_path(@task, version: proforma_version), class: 'btn btn-light dropdown-item', target: '_blank', rel: 'noopener noreferrer'
+                  - if @proforma_valid[proforma_version]
+                    = link_to proforma_version, download_task_path(@task, version: proforma_version), class: 'btn btn-light dropdown-item', target: '_blank', rel: 'noopener noreferrer'
+                  - else
+                    .disabled-btn-wrapper data-bs-toggle='tooltip' title=t('.not_proforma_valid', version: " (#{proforma_version})")
+                      = link_to proforma_version, download_task_path(@task, version: proforma_version), class: 'btn btn-light dropdown-item disabled', target: '_blank', rel: 'noopener noreferrer'
 
         - else
           div data-bs-toggle='tooltip' title=unavailable_tooltip data-bs-delay=150
@@ -535,6 +544,7 @@
           .dropdown.btn-group
             = button_tag class: 'btn btn-light dropdown-toggle', 'data-bs-toggle': 'dropdown' do
               = t('.button.export')
+
             ul.scrollable.dropdown-menu role='menu'
               li.dropdown-header = "#{t('tasks.show.export_to')}: "
               - if current_user.available_account_links.empty?
@@ -543,7 +553,12 @@
               - else
                 - current_user.available_account_links.each do |acc_link|
                   li
-                    = link_to acc_link.name, export_external_start_task_path(account_link: acc_link), method: :post, remote: true, class: 'dropdown-item export-test'
+                    - if @proforma_valid[acc_link.proforma_version || ProformaXML::SCHEMA_VERSION_LATEST]
+                      = link_to acc_link.name, export_external_start_task_path(account_link: acc_link), method: :post, remote: true, class: 'dropdown-item export-test'
+                    - else
+                      .disabled-btn-wrapper data-bs-toggle='tooltip' title=t('.not_proforma_valid', version: " (#{acc_link.proforma_version || ProformaXML::SCHEMA_VERSION_LATEST})")
+                        = link_to acc_link.name, export_external_start_task_path(account_link: acc_link), method: :post, remote: true, class: 'dropdown-item export-test disabled'
+
         - else
           div data-bs-toggle='tooltip' title=unavailable_tooltip data-bs-delay=150
             = button_tag class: 'btn btn-outline-dark dropdown-toggle disabled', 'data-bs-toggle': 'dropdown' do

config/locales/de/views/tasks.yml

@@ -111,6 +111,7 @@ de:
       no_license: Keine
       no_model_solution_present: Keine Musterlösungen vorhanden
       no_tests: Keine Tests enthalten
+      not_proforma_valid: Die Aufgabe ist nicht in ProFormA%{version} exportierbar
       owner_required_tooltip: Sie müssen der Autor der Aufgabe sein, um die Funktion zu verwenden.
       remove_task_from_collection_warning: Sind Sie sicher, dass Sie diese Aufgabe aus der Sammlung entfernen wollen?
       task_contribution:

config/locales/en/views/tasks.yml

@@ -111,6 +111,7 @@ en:
       no_license: None
       no_model_solution_present: No Model Solutions present
       no_tests: No Tests included
+      not_proforma_valid: The task is not exportable in ProFormA%{version}.
       owner_required_tooltip: This feature can only be used by the owner of the task.
       remove_task_from_collection_warning: Are you sure you want to remove this Task from the Collection?
       task_contribution:

spec/controllers/tasks_controller_spec.rb

@@ -219,6 +219,29 @@
           expect(response).to redirect_to([contribution.base, contribution])
         end
       end
+
+      context 'when checking proforma validity' do
+        before do
+          stub_const('ProformaXML::SCHEMA_VERSIONS', ['2.0'])
+
+          task_double = task
+
+          allow(Task).to receive(:find).with(task.to_param).and_return(task_double)
+
+          allow(task_double).to receive(:proforma_valid?).with(schema_version: nil).and_return(true)
+          allow(task_double).to receive(:proforma_valid?).with(schema_version: '2.0').and_return(false)
+        end
+
+        it 'assigns proforma_valid to instance variable' do
+          get_request
+          expect(assigns(:proforma_valid)).to be_a(Hash)
+        end
+
+        it 'includes all values in proforma_valid hash' do
+          get_request
+          expect(assigns(:proforma_valid)).to eql({nil => true, '2.0' => false})
+        end
+      end
     end
   end
 

spec/models/task_spec.rb

@@ -666,4 +666,47 @@
       end
     end
   end
+
+  describe '#proforma_valid?' do
+    subject(:proforma_valid) { task.proforma_valid?(schema_version:) }
+
+    let(:task) { create(:task) }
+    let(:schema_version) { nil }
+
+    context 'when the task is valid for all schema versions' do
+      before do
+        allow(ProformaService::ExportTask).to receive(:call).and_return(true)
+      end
+
+      it { is_expected.to be true }
+    end
+
+    context 'when the task is invalid for a schema version' do
+      before do
+        allow(ProformaService::ExportTask).to receive(:call).and_raise(ProformaXML::PostGenerateValidationError, '["version not supported"]')
+      end
+
+      it { is_expected.to be false }
+    end
+
+    context 'when a specific schema version is provided' do
+      let(:schema_version) { '2.0' }
+
+      context 'when the task is valid for the specified schema version' do
+        before do
+          allow(ProformaService::ExportTask).to receive(:call).with(task: task, options: {version: schema_version}).and_return(true)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context 'when the task is invalid for the specified schema version' do
+        before do
+          allow(ProformaService::ExportTask).to receive(:call).with(task: task, options: {version: schema_version}).and_raise(ProformaXML::PostGenerateValidationError, '["version not supported"]')
+        end
+
+        it { is_expected.to be false }
+      end
+    end
+  end
 end