Create instruments work type and pathway

.rubocop.yml

@@ -156,4 +156,5 @@ Style/EmptyCaseCondition:
 Layout/LineLength:
   Exclude:
     - 'spec/features/dashboard/work_version_form_spec.rb'
+    - 'spec/forms/work_deposit_pathways/instrument/publish_form_spec.rb'
 

app/components/citation_component.rb

@@ -13,7 +13,7 @@ def render?
   end
 
   def citation_display
-    return unless deposit_pathway.data_and_code?
+    return unless deposit_pathway.data_and_code? || deposit_pathway.instrument?
 
     "#{creators_citation_display}(#{year_published}). #{work_version.title} [Data set]. Scholarsphere.#{doi_url}"
   end

app/components/delete_resource_button_component.rb

@@ -57,7 +57,9 @@ def work_version?
         'WorkDepositPathway::ScholarlyWorks::PublishForm',
         'WorkDepositPathway::General::DetailsForm',
         'WorkDepositPathway::DataAndCode::DetailsForm',
-        'WorkDepositPathway::DataAndCode::PublishForm'
+        'WorkDepositPathway::DataAndCode::PublishForm',
+        'WorkDepositPathway::Instrument::DetailsForm',
+        'WorkDepositPathway::Instrument::PublishForm'
       ].include?(type)
     end
 

app/components/thumbnail_component.rb

@@ -60,6 +60,7 @@ def icon_map
                                       dataset: 'analytics',
                                       dissertation: 'subject',
                                       image: 'image',
+                                      instrument: 'precision_manufacturing',
                                       journal: 'subject',
                                       map_or_cartographic_material: 'map',
                                       masters_culminating_experience: 'landscape',

app/components/work_version_metadata_component.rb

@@ -23,7 +23,18 @@ class WorkVersionMetadataComponent < BaseMetadataComponent
     :based_near,
     :related_url,
     :source,
-    :deposited_at
+    :deposited_at,
+    :owner,
+    :manufacturer,
+    :model,
+    :instrument_type,
+    :measured_variable,
+    :available_date,
+    :decommission_date,
+    :related_identifier,
+    :alternative_identifier,
+    :instrument_resource_type,
+    :funding_reference
   ].freeze
 
   MINI_ATTRIBUTES = [

app/controllers/catalog_controller.rb

@@ -142,6 +142,17 @@ def index
     config.add_show_field 'language_tesim', label: 'Language'
     config.add_show_field 'identifier_tesim', label: 'Identifier'
     config.add_show_field 'based_near_tesim', label: 'Based Near'
+    config.add_show_field 'owner_tesim', label: 'Owner'
+    config.add_show_field 'manufacturer_tesim', label: 'Manufacturer'
+    config.add_show_field 'model_tesim', label: 'Model'
+    config.add_show_field 'instrument_type_tesim', label: 'Instrument Type'
+    config.add_show_field 'measured_variable_tesim', label: 'Measured Variable'
+    config.add_show_field 'available_date_tesim', label: 'Available Date'
+    config.add_show_field 'decommission_date_tesim', label: 'Decommission Date'
+    config.add_show_field 'related_identifier_tesim', label: 'Related Identifier'
+    config.add_show_field 'alternative_identifier_tesim', label: 'Alternative Identifier'
+    config.add_show_field 'instrument_resource_type_tesim', label: 'Resource Type'
+    config.add_show_field 'funding_reference_tesim', label: 'Funding Reference'
     config.add_show_field 'related_url_tesim', label: 'Related URL'
     config.add_show_field 'source_tesim', label: 'Source'
     config.add_show_field 'version_number_isi', label: 'Version Number'

app/controllers/dashboard/form/publish_controller.rb

@@ -121,6 +121,17 @@ def work_version_params
               :published_date,
               :depositor_agreement,
               :draft_curation_requested,
+              :owner,
+              :manufacturer,
+              :model,
+              :instrument_type,
+              :measured_variable,
+              :available_date,
+              :decommission_date,
+              :related_identifier,
+              :alternative_identifier,
+              :instrument_resource_type,
+              :funding_reference,
               :mint_doi_requested,
               keyword: [],
               contributor: [],

app/controllers/dashboard/form/work_version_details_controller.rb

@@ -64,6 +64,17 @@ def work_version_params
               :rights,
               :version_name,
               :published_date,
+              :owner,
+              :manufacturer,
+              :model,
+              :instrument_type,
+              :measured_variable,
+              :available_date,
+              :decommission_date,
+              :related_identifier,
+              :alternative_identifier,
+              :instrument_resource_type,
+              :funding_reference,
               keyword: [],
               contributor: [],
               publisher: [],

app/controllers/dashboard/work_versions_controller.rb

@@ -139,6 +139,17 @@ def metadata_params
             :rights,
             :version_name,
             :published_date,
+            :owner,
+            :manufacturer,
+            :model,
+            :instrument_type,
+            :measured_variable,
+            :available_date,
+            :decommission_date,
+            :related_identifier,
+            :alternative_identifier,
+            :instrument_resource_type,
+            :funding_reference,
             keyword: [],
             contributor: [],
             publisher: [],

app/forms/work_deposit_pathway.rb

@@ -10,6 +10,8 @@ def details_form
       ScholarlyWorks::DetailsForm.new(resource)
     elsif data_and_code?
       DataAndCode::DetailsForm.new(resource)
+    elsif instrument?
+      Instrument::DetailsForm.new(resource)
     else
       General::DetailsForm.new(resource)
     end
@@ -20,6 +22,8 @@ def publish_form
       ScholarlyWorks::PublishForm.new(resource)
     elsif data_and_code?
       DataAndCode::PublishForm.new(resource)
+    elsif instrument?
+      Instrument::PublishForm.new(resource)
     else
       resource
     end
@@ -34,7 +38,7 @@ def allows_curation_request?
   end
 
   def allows_mint_doi_request?
-    data_and_code? && @resource.doi_blank? && DoiMintingStatus.new(@resource.work).blank?
+    (data_and_code? || instrument?) && @resource.doi_blank? && DoiMintingStatus.new(@resource.work).blank?
   end
 
   def work?
@@ -45,6 +49,10 @@ def data_and_code?
     Work::Types.data_and_code.include?(work_type)
   end
 
+  def instrument?
+    Work::Types.instrument.include?(work_type)
+  end
+
   private
 
     attr_reader :resource
@@ -282,4 +290,113 @@ def includes_readme_file
           end
       end
     end
+
+    module Instrument
+      class DetailsForm < DetailsFormBase
+        def self.form_fields
+          WorkVersionFormBase::COMMON_FIELDS.union(
+            %w{
+              title
+              owner
+              identifier
+              manufacturer
+              model
+              instrument_type
+              measured_variable
+              available_date
+              decommission_date
+              related_identifier
+              alternative_identifier
+              instrument_resource_type
+              funding_reference
+            }
+          ).freeze
+        end
+
+        form_fields.each do |attr_name|
+          delegate attr_name, to: :work_version, prefix: false
+          delegate "#{attr_name}=", to: :work_version, prefix: false
+        end
+
+        def form_partial
+          'instrument_work_version'
+        end
+      end
+
+      class PublishForm < WorkVersionFormBase
+        def self.form_fields
+          WorkVersionFormBase::COMMON_FIELDS.union(
+            %w{
+              title
+              owner
+              identifier
+              manufacturer
+              model
+              instrument_type
+              measured_variable
+              available_date
+              decommission_date
+              related_identifier
+              alternative_identifier
+              instrument_resource_type
+              funding_reference
+              rights
+              depositor_agreement
+              contributor
+            }
+          ).freeze
+        end
+
+        form_fields.each do |attr_name|
+          delegate attr_name, to: :work_version, prefix: false
+          delegate "#{attr_name}=", to: :work_version, prefix: false
+        end
+
+        validate :includes_readme_file_and_image,
+                 if: :published?
+
+        validates :decommission_date,
+                  edtf_date: true
+
+        validates :available_date,
+                  edtf_date: true
+
+        def form_partial
+          'instrument_work_version'
+        end
+
+        delegate :aasm_state=,
+                 :aasm_state,
+                 :publish,
+                 :file_resources,
+                 :work_attributes=,
+                 :creators_attributes=,
+                 :creators,
+                 :contributor,
+                 :file_version_memberships,
+                 :initial_draft?,
+                 :aasm,
+                 :update_column,
+                 :draft_curation_requested=,
+                 :mint_doi_requested=,
+                 :set_thumbnail_selection,
+                 :set_publisher_as_scholarsphere,
+                 to: :work_version,
+                 prefix: false
+
+        private
+
+          def includes_readme_file_and_image
+            unless file_resources.find do |fr|
+              fr.file_data['metadata']['size'].positive? &&
+                  fr.file_data['metadata']['filename'] =~ /readme/i
+            end && file_resources.find do |fr|
+              (fr.file_data['metadata']['filename'] !~ /readme/i &&
+              fr.file_data['metadata']['filename'] =~ /png|jpeg|tiff/i)
+            end
+              errors.add(:file_resources, :readme_and_image)
+            end
+          end
+      end
+    end
 end

app/javascript/controllers/work_type_controller.js

@@ -0,0 +1,18 @@
+import { Controller } from 'stimulus'
+
+export default class extends Controller {
+  static targets = ['workTypeSelect', 'helpText']
+
+  connect () {
+    this.toggleHelpText()
+    this.workTypeSelectTarget.addEventListener('change', () => this.toggleHelpText())
+  }
+
+  toggleHelpText () {
+    if (this.workTypeSelectTarget.value === 'instrument') {
+      this.helpTextTarget.style.display = 'block'
+    } else {
+      this.helpTextTarget.style.display = 'none'
+    }
+  }
+}

app/models/work.rb

@@ -61,7 +61,7 @@ class Work < ApplicationRecord
 
   module Types
     def self.all
-      general.union(scholarly_works).union(data_and_code).freeze
+      general.union(scholarly_works).union(data_and_code).union(instrument).freeze
     end
 
     def self.general
@@ -102,6 +102,12 @@ def self.data_and_code
       ].freeze
     end
 
+    def self.instrument
+      %w[
+        instrument
+      ].freeze
+    end
+
     def self.default
       'dataset'
     end

app/models/work_version.rb

@@ -31,7 +31,18 @@ class WorkVersion < ApplicationRecord
                  identifier: [:string, array: true, default: []],
                  based_near: [:string, array: true, default: []],
                  related_url: [:string, array: true, default: []],
-                 source: [:string, array: true, default: []]
+                 source: [:string, array: true, default: []],
+                 owner: :string,
+                 manufacturer: :string,
+                 model: :string,
+                 instrument_type: :string,
+                 measured_variable: :string,
+                 available_date: :string,
+                 decommission_date: :string,
+                 related_identifier: :string,
+                 alternative_identifier: :string,
+                 instrument_resource_type: :string,
+                 funding_reference: :string
 
   belongs_to :work,
              inverse_of: :versions
@@ -160,6 +171,14 @@ def label(id)
             edtf_date: true,
             if: :published?
 
+  validates :decommission_date,
+            edtf_date: true,
+            if: :published?
+
+  validates :available_date,
+            edtf_date: true,
+            if: :published?
+
   validates :description,
             presence: true,
             if: :published?
@@ -188,6 +207,7 @@ def label(id)
                   to: :published,
                   after: Proc.new {
                     work.try(:update_deposit_agreement)
+                    set_publisher_as_scholarsphere if work_type == 'instrument'
                     self.reload_on_index = true
                   }
     end
@@ -227,6 +247,17 @@ def label(id)
     rights
     subtitle
     version_name
+    owner
+    manufacturer
+    model
+    instrument_type
+    measured_variable
+    available_date
+    decommission_date
+    related_identifier
+    alternative_identifier
+    instrument_resource_type
+    funding_reference
   ].each do |field|
     define_method "#{field}=" do |val|
       super(val.presence)
@@ -299,6 +330,10 @@ def set_thumbnail_selection
     end
   end
 
+  def set_publisher_as_scholarsphere
+    metadata['publisher'] = ['Scholarsphere']
+  end
+
   def initial_draft?
     version_number == 1 &&
       (draft? || temporarily_published_draft?)