b1776731-62d7-41a7-882d-6a5b4760db75

Committed 14 May 2024 12:28PM UTC coverage: 79.223% (-16.7%) from 95.9%

Build # b1776731-62d7-41a7-882d-6a5b4760db75

Build Type

push

circleci

Committed by

carolyncole

Commit Message

Adding a submission completion page

fixes #1791

Run Details

9 of 9 new or added lines in 2 files covered. (100.0%)

567 existing lines in 42 files now uncovered.

2692 of 3398 relevant lines covered (79.22%)

60.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.07

/app/services/work_validator.rb

# frozen_string_literal: true
class WorkValidator
  attr_reader :work

  delegate :errors, :metadata, :resource, :ark, :doi, :user_entered_doi, :id, :group,
           :pre_curation_uploads, :post_curation_uploads, to: :work

  def initialize(work)
    @work = work
  end

  def valid?
    if work.none?
      validate_ids
    elsif work.draft?
      valid_to_draft
    else
      valid_to_submit
    end
  end

  def valid_to_draft(*)
    errors.add(:base, "Must provide a title") if resource.main_title.blank?
    validate_ark
    validate_creators
    validate_related_objects if resource.present? && !resource.related_objects.empty?
    errors.count == 0
  end

  def valid_to_complete(*args)
    validate_files
    valid_to_submit(args)
  end

  def valid_to_submit(*args)
    valid_to_draft(args)
    validate_metadata
    if errors.count == 0
      valid_datacite? # test if the datacite update will be valid
    end
    errors.count == 0
  end

  def valid_to_approve(user)
    if resource.doi.blank?
      errors.add :base, "DOI must be present for a work to be approved"
    end
    valid_to_submit(user)
    unless user.has_role? :group_admin, group
      errors.add :base, "Unauthorized to Approve"
    end
    validate_files
    if pre_curation_uploads.empty? && post_curation_uploads.empty?
      errors.add :base, "Uploads must be present for a work to be approved"
    end
    errors.count == 0
  end

  def valid_datacite?
    datacite_serialization = resource.datacite_serialization
    datacite_serialization.valid?
    datacite_serialization.errors.each { |error| errors.add(:base, error) }
    errors.count == 0
  rescue ArgumentError => error
    argument_path = error.backtrace_locations.first.path
    argument_file = argument_path.split("/").last
    argument_name = argument_file.split(".").first
    errors.add(:base, "#{argument_name.titleize}: #{error.message}")
    false
  end

  private

    def validate_ark
      return if ark.blank?
      return false unless unique_ark
      first_save = id.blank?
      changed_value = metadata["ark"] != ark
      if first_save || changed_value
        errors.add(:base, "Invalid ARK provided for the Work: #{ark}") unless Ark.valid?(ark)
      end
    end

    def validate_related_objects
      return if resource.related_objects.empty?
      invalid = resource.related_objects.reject(&:valid?)
      if invalid.count.positive?
        related_object_errors = "Related Objects are invalid: "
        prev_errors = errors.to_a
        prev_related_object_errors = prev_errors.map { |e| e.include?(related_object_errors) }.reduce(:|)

        errors.add(:base, "#{related_object_errors}#{invalid.map(&:errors).join(', ')}") unless prev_related_object_errors
      end
    end

    def validate_creators
      if resource.creators.count == 0
        errors.add(:base, "Must provide at least one Creator")
      else
        resource.creators.each do |creator|
          if creator.orcid.present? && Orcid.invalid?(creator.orcid)
            errors.add(:base, "ORCID for creator #{creator.value} is not in format 0000-0000-0000-0000")
          end
        end
      end
    end

    def validate_required_metadata
      return if metadata.blank?
      errors.add(:base, "Must provide a title") if resource.main_title.blank?
      validate_creators
    end

    def validate_doi
      return true unless user_entered_doi
      return false unless unique_doi
      if /^10.\d{4,9}\/[-._;()\/:a-z0-9\-]+$/.match?(doi.downcase)
        response = Faraday.get("#{Rails.configuration.datacite.doi_url}#{doi}")
        errors.add(:base, "Invalid DOI: can not verify it's authenticity") unless response.success? || response.status == 302
      else
        errors.add(:base, "Invalid DOI: does not match format")
      end
      errors.count == 0
    end

    def unique_ark
      return true if ark.blank?
      other_record = Work.find_by_ark(ark)
      return true if other_record == work
      errors.add(:base, "Invalid ARK: It has already been applied to another work #{other_record.id}")
      false
    rescue ActiveRecord::RecordNotFound
      true
    end

    def validate_ids
      validate_doi
      unique_ark
    end

    def unique_doi
      other_record = Work.find_by_doi(doi)
      return true if other_record == work
      errors.add(:base, "Invalid DOI: It has already been applied to another work #{other_record.id}")
      false
    rescue ActiveRecord::RecordNotFound
      true
    end

    def validate_metadata
      return if metadata.blank?
      validate_required_metadata
      errors.add(:base, "Must provide a description") if resource.description.blank?
      errors.add(:base, "Must indicate the Publisher") if resource.publisher.blank?
      errors.add(:base, "Must indicate the Publication Year") if resource.publication_year.blank?
      errors.add(:base, "Must indicate at least one Rights statement") if resource.rights_many.count == 0
      errors.add(:base, "Must provide a Version number") if resource.version_number.blank?
      validate_related_objects
    end

    def validate_files
      return if @work.resource.migrated
      readme = Readme.new(work, nil)
      errors.add(:base, "Must provide a README") if readme.blank?
    end
end

1	# frozen_string_literal: true
2	class WorkValidator	1✔
3	attr_reader :work	1✔
4
5	delegate :errors, :metadata, :resource, :ark, :doi, :user_entered_doi, :id, :group,	1✔
6	:pre_curation_uploads, :post_curation_uploads, to: :work
7
8	def initialize(work)	1✔
9	@work = work	261✔
10	end
11
12	def valid?	1✔
13	if work.none?	301✔
14	validate_ids	40✔
15	elsif work.draft?	261✔
16	valid_to_draft	210✔
17	else
18	valid_to_submit	51✔
19	end
20	end
21
22	def valid_to_draft(*)	1✔
23	errors.add(:base, "Must provide a title") if resource.main_title.blank?	302✔
24	validate_ark	302✔
25	validate_creators	302✔
26	validate_related_objects if resource.present? && !resource.related_objects.empty?	302✔
27	errors.count == 0	302✔
28	end
29
30	def valid_to_complete(*args)	1✔
31	validate_files	15✔
32	valid_to_submit(args)	15✔
33	end
34
35	def valid_to_submit(*args)	1✔
36	valid_to_draft(args)	75✔
37	validate_metadata	75✔
38	if errors.count == 0	75✔
39	valid_datacite? # test if the datacite update will be valid	74✔
40	end
41	errors.count == 0	75✔
42	end
43
44	def valid_to_approve(user)	1✔
45	if resource.doi.blank?	9✔
UNCOV 46	errors.add :base, "DOI must be present for a work to be approved"	×
47	end
48	valid_to_submit(user)	9✔
49	unless user.has_role? :group_admin, group	9✔
50	errors.add :base, "Unauthorized to Approve"	3✔
51	end
52	validate_files	9✔
53	if pre_curation_uploads.empty? && post_curation_uploads.empty?	9✔
54	errors.add :base, "Uploads must be present for a work to be approved"	1✔
55	end
56	errors.count == 0	9✔
57	end
58
59	def valid_datacite?	1✔
60	datacite_serialization = resource.datacite_serialization	77✔
61	datacite_serialization.valid?	76✔
62	datacite_serialization.errors.each { \|error\| errors.add(:base, error) }	77✔
63	errors.count == 0	76✔
64	rescue ArgumentError => error
65	argument_path = error.backtrace_locations.first.path	1✔
66	argument_file = argument_path.split("/").last	1✔
67	argument_name = argument_file.split(".").first	1✔
68	errors.add(:base, "#{argument_name.titleize}: #{error.message}")	1✔
69	false	1✔
70	end
71
72	private	1✔
73
74	def validate_ark	1✔
75	return if ark.blank?	302✔
76	return false unless unique_ark	28✔
77	first_save = id.blank?	28✔
78	changed_value = metadata["ark"] != ark	28✔
79	if first_save \|\| changed_value	28✔
80	errors.add(:base, "Invalid ARK provided for the Work: #{ark}") unless Ark.valid?(ark)	15✔
81	end
82	end
83
84	def validate_related_objects	1✔
85	return if resource.related_objects.empty?	95✔
86	invalid = resource.related_objects.reject(&:valid?)	25✔
87	if invalid.count.positive?	25✔
UNCOV 88	related_object_errors = "Related Objects are invalid: "	×
UNCOV 89	prev_errors = errors.to_a	×
UNCOV 90	prev_related_object_errors = prev_errors.map { \|e\| e.include?(related_object_errors) }.reduce(:\|)	×
91
UNCOV 92	errors.add(:base, "#{related_object_errors}#{invalid.map(&:errors).join(', ')}") unless prev_related_object_errors	×
93	end
94	end
95
96	def validate_creators	1✔
97	if resource.creators.count == 0	377✔
UNCOV 98	errors.add(:base, "Must provide at least one Creator")	×
99	else
100	resource.creators.each do \|creator\|	377✔
101	if creator.orcid.present? && Orcid.invalid?(creator.orcid)	718✔
UNCOV 102	errors.add(:base, "ORCID for creator #{creator.value} is not in format 0000-0000-0000-0000")	×
103	end
104	end
105	end
106	end
107
108	def validate_required_metadata	1✔
109	return if metadata.blank?	75✔
110	errors.add(:base, "Must provide a title") if resource.main_title.blank?	75✔
111	validate_creators	75✔
112	end
113
114	def validate_doi	1✔
115	return true unless user_entered_doi	40✔
116	return false unless unique_doi	1✔
117	if /^10.\d{4,9}\/[-._;()\/:a-z0-9\-]+$/.match?(doi.downcase)	1✔
118	response = Faraday.get("#{Rails.configuration.datacite.doi_url}#{doi}")	1✔
119	errors.add(:base, "Invalid DOI: can not verify it's authenticity") unless response.success? \|\| response.status == 302	1✔
120	else
UNCOV 121	errors.add(:base, "Invalid DOI: does not match format")	×
122	end
123	errors.count == 0	1✔
124	end
125
126	def unique_ark	1✔
127	return true if ark.blank?	68✔
128	other_record = Work.find_by_ark(ark)	46✔
129	return true if other_record == work	12✔
UNCOV 130	errors.add(:base, "Invalid ARK: It has already been applied to another work #{other_record.id}")	×
UNCOV 131	false	×
132	rescue ActiveRecord::RecordNotFound
133	true	34✔
134	end
135
136	def validate_ids	1✔
137	validate_doi	40✔
138	unique_ark	40✔
139	end
140
141	def unique_doi	1✔
142	other_record = Work.find_by_doi(doi)	1✔
UNCOV 143	return true if other_record == work	×
UNCOV 144	errors.add(:base, "Invalid DOI: It has already been applied to another work #{other_record.id}")	×
UNCOV 145	false	×
146	rescue ActiveRecord::RecordNotFound
147	true	1✔
148	end
149
150	def validate_metadata	1✔
151	return if metadata.blank?	75✔
152	validate_required_metadata	75✔
153	errors.add(:base, "Must provide a description") if resource.description.blank?	75✔
154	errors.add(:base, "Must indicate the Publisher") if resource.publisher.blank?	75✔
155	errors.add(:base, "Must indicate the Publication Year") if resource.publication_year.blank?	75✔
156	errors.add(:base, "Must indicate at least one Rights statement") if resource.rights_many.count == 0	75✔
157	errors.add(:base, "Must provide a Version number") if resource.version_number.blank?	75✔
158	validate_related_objects	75✔
159	end
160
161	def validate_files	1✔
162	return if @work.resource.migrated	24✔
163	readme = Readme.new(work, nil)	23✔
164	errors.add(:base, "Must provide a README") if readme.blank?	23✔
165	end
166	end

pulibrary / pdc_describe / b1776731-62d7-41a7-882d-6a5b4760db75

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous