Move issues to an extension of Proposal.Issue

dempseyatgithub · dempseyatgithub · commit e1475f286f9f · 2024-04-21T11:47:13.000-07:00
- Replace ValidationIssue enum with Proposal.Issue extension
- Change filename from ValidationIssue to ValidationIssues
- Use leading dot syntax for defined issues
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/EvolutionMetadataExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/EvolutionMetadataExtractor.swift
@@ -100,7 +100,7 @@ struct EvolutionMetadataExtractor {
 
         } catch {
             print(error)
-            return SortableProposalWrapper(proposal: Proposal(errors:[ValidationIssue.proposalContainsNoContent]), sortIndex: proposalSpec.sortIndex)
+            return SortableProposalWrapper(proposal: Proposal(errors:[.proposalContainsNoContent]), sortIndex: proposalSpec.sortIndex)
         }
     }
     
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/DiscussionExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/DiscussionExtractor.swift
@@ -28,7 +28,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {
             // format discussions correctly. Those issues should be corrected in the proposals themselves.
             // Once all of those issues are resolved, the legacy check can be removed.
             if discussions.isEmpty && !Legacy.discussionExtractionFailures.contains(sourceValues.proposalID) {
-                errors.append(ValidationIssue.discussionExtractionFailure)
+                errors.append(.discussionExtractionFailure)
             }
         } else {
             // VALIDATION ENHANCEMENT: Add field to proposals with missing field and remove special case logic.
@@ -37,7 +37,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {
             // Once all of those issues are resolved, the legacy check can be removed.
             // Note that some very early proposals may not have valid discussions be extracted.
             if !Legacy.missingReviewFields.contains(sourceValues.proposalID) {
-                errors.append(ValidationIssue.missingReviewField)
+                errors.append(.missingReviewField)
             }
         }
         
@@ -60,7 +60,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {
         if let discussionURL = linkInfo.swiftForumsDestination {
             discussions.append(Proposal.Discussion(name: linkInfo.text, link: discussionURL))
         } else {
-            warnings.append(ValidationIssue.invalidDiscussionLink)
+            warnings.append(.invalidDiscussionLink)
         }
     }
 }
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/ImplementationExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/ImplementationExtractor.swift
@@ -75,7 +75,7 @@ struct ImplementationExtractor: MarkupWalker, ValueExtractor {
         
         // VALIDATION ENHANCEMENT: The legacy tool lowercases the tested value. This is probably not necessary.
         guard account == "apple" else {
-            warnings.append(ValidationIssue.invalidImplementationLink)
+            warnings.append(.invalidImplementationLink)
             return
         }
         
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/PersonExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/PersonExtractor.swift
@@ -61,16 +61,16 @@ struct PersonExtractor: MarkupWalker {
         }
         // VALIDATION ENHANCEMENT: Add 'extra markup error' for review managers
         if !linkInfo.containsTextElement && role == .author {
-            errors.append(ValidationIssue.authorsHaveExtraMarkup)
+            errors.append(.authorsHaveExtraMarkup)
         }
         
         let destination: String
         if let validatedDestination = linkInfo.gitHubDestination {
             destination = validatedDestination
         } else {
             switch role {
-                case .author: warnings.append(ValidationIssue.invalidAuthorLink)
-                case .reviewManager: warnings.append(ValidationIssue.invalidReviewManagerLink)
+                case .author: warnings.append(.invalidAuthorLink)
+                case .reviewManager: warnings.append(.invalidReviewManagerLink)
             }
             destination = ""
         }
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/PreviousProposalExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/PreviousProposalExtractor.swift
@@ -27,7 +27,7 @@ struct PreviousProposalExtractor: MarkupWalker, ValueExtractor {
             
             // validate that if the header field is here at least one proposal ID was found
             if _previousProposalIDs.isEmpty {
-                errors.append(ValidationIssue.previousProposalIDsExtractionFailure)
+                errors.append(.previousProposalIDsExtractionFailure)
             }
         }
         
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/ProposalLinkExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/ProposalLinkExtractor.swift
@@ -20,24 +20,24 @@ struct ProposalLinkExtractor: MarkupWalker, ValueExtractor {
         if let headerField = headerFieldsByLabel["Proposal"] {
             visit(headerField)
         } else {
-            errors.append(ValidationIssue.missingProposalIDLink)
+            errors.append(.missingProposalIDLink)
         }
         if let proposalLink {
             
             if !proposalLink.containsTextElement {
-                warnings.append(ValidationIssue.proposalIDHasExtraMarkup)
+                warnings.append(.proposalIDHasExtraMarkup)
             }
             
             // VALIDATION ENHANCEMENT: To match legacy behavior, if ID has extra markup, the
             // ID is an empty string. An enhancement would be to capture the ID if possible
             if !proposalLink.text.isEmpty {
                 
                 if proposalLink.text == "SE-0000" {
-                    errors.append(ValidationIssue.reservedProposalID)
+                    errors.append(.reservedProposalID)
                 }
                 
                 if !proposalLink.text.contains(/^SE-\d\d\d\d$/) {
-                    errors.append(ValidationIssue.proposalIDWrongDigitCount)
+                    errors.append(.proposalIDWrongDigitCount)
                 }
                 
                 // VALIDATION ENHANCEMENT: Once we move from the legacy tool. Remove this.
@@ -58,14 +58,14 @@ struct ProposalLinkExtractor: MarkupWalker, ValueExtractor {
             }
             
         } else {
-            errors.append(ValidationIssue.missingProposalIDLink)
+            errors.append(.missingProposalIDLink)
         }
         return ExtractionResult(value: proposalLink ?? LinkInfo(text: "", destination: ""), warnings: warnings, errors: errors)
     }
     
     mutating func visitLink(_ link: Link) -> () {
         guard let value = LinkInfo(link: link) else {
-            errors.append(ValidationIssue.missingProposalIDLink)
+            errors.append(.missingProposalIDLink)
             return
         }
         proposalLink = value
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/StatusExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/StatusExtractor.swift
@@ -30,7 +30,7 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {
         
         // This checks both that the field is found and is successfully extracted
         if status == nil {
-            warnings.append(ValidationIssue.missingStatus)
+            warnings.append(.missingStatus)
         }
         return ExtractionResult(value: status, warnings: warnings, errors: errors)
     }
@@ -61,14 +61,14 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {
                     warnings.append(warning)
                 }
             } else {
-                warnings.append(ValidationIssue.missingOrInvalidReviewDates)
+                warnings.append(.missingOrInvalidReviewDates)
             }
         }
         
         if let rawStatus = Proposal.Status(name: statusString, version: version, start: start, end: end) {
             status = rawStatus
         } else {
-            errors.append(ValidationIssue.missingOrInvalidStatus)
+            errors.append(.missingOrInvalidStatus)
             status = .statusExtractionFailed
         }
     }
@@ -184,7 +184,7 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {
         // VALIDATION ENHANCEMENT: Add (x) days before showing this.
         var reviewEndedWarning: Proposal.Issue?
         if processingDate > wrappedEndDate {
-            reviewEndedWarning = ValidationIssue.reviewEnded(on: wrappedEndDate)
+            reviewEndedWarning = .reviewEnded(on: wrappedEndDate)
         }
         
         // Specify explicit GMT time zone and 'en_US_POSIX' locale
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/TitleExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/TitleExtractor.swift
@@ -28,7 +28,7 @@ struct TitleExtractor: ValueExtractor {
             title = titleElement.plainText
             
         } else {
-            errors.append(ValidationIssue.proposalContainsNoContent)
+            errors.append(.proposalContainsNoContent)
         }
         return ExtractionResult(value: title, warnings: warnings, errors: errors)
         
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/UpcomingFeatureFlagExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/FieldExtractors/UpcomingFeatureFlagExtractor.swift
@@ -36,10 +36,10 @@ struct UpcomingFeatureFlagExtractor: MarkupWalker, ValueExtractor {
             if let flag {
                 if flag.contains(/\s/) {
                     self.flag = nil
-                    errors.append(ValidationIssue.malformedUpcomingFeatureFlag)
+                    errors.append(.malformedUpcomingFeatureFlag)
                 }
             } else {
-                errors.append(ValidationIssue.upcomingFeatureFlagExtractionFailure)
+                errors.append(.upcomingFeatureFlagExtractionFailure)
             }
             
         }
diff --git a/Sources/EvolutionMetadataExtraction/Extractors/ProposalMetadataExtractor.swift b/Sources/EvolutionMetadataExtraction/Extractors/ProposalMetadataExtractor.swift
@@ -38,7 +38,7 @@ struct ProposalMetadataExtractor {
         let document = Document(parsing: markdown, options: [.disableSmartOpts])
         
         guard !document.isEmpty else {
-            proposal.errors = [ValidationIssue.emptyMarkdownFile]
+            proposal.errors = [.emptyMarkdownFile]
             return proposal
         }
         
@@ -57,14 +57,14 @@ struct ProposalMetadataExtractor {
             if let authors = extractValue(from: headerFieldsByLabel, with: AuthorExtractor.self), !authors.isEmpty {
                 proposal.authors = authors
             } else {
-                errors.append(ValidationIssue.missingAuthors)
+                errors.append(.missingAuthors)
             }
             
             if let reviewManagers = extractValue(from: headerFieldsByLabel, with: ReviewManagerExtractor.self), !reviewManagers.isEmpty {
                 proposal.reviewManager = reviewManagers.first!
                 proposal.reviewManagers = reviewManagers
             } else {
-                warnings.append(ValidationIssue.missingReviewManagers)
+                warnings.append(.missingReviewManagers)
             }
             
             proposal.upcomingFeatureFlag = extractValue(from: headerFieldsByLabel, with: UpcomingFeatureFlagExtractor.self)
@@ -79,7 +79,7 @@ struct ProposalMetadataExtractor {
             if let discussions = extractValue(from: (headerFieldsByLabel, proposalSpec.id), with: DiscussionExtractor.self) {
                 proposal.discussions = discussions
             } else {
-                errors.append(ValidationIssue.missingReviewField)
+                errors.append(.missingReviewField)
             }
             
             if let status = extractValue(from: (headerFieldsByLabel, extractionDate), with: StatusExtractor.self) {
@@ -100,7 +100,7 @@ struct ProposalMetadataExtractor {
                 proposal.status = .statusExtractionFailed
             }
         } else {
-            errors.append(ValidationIssue.missingMetadataFields)
+            errors.append(.missingMetadataFields)
         }
         
         // Add warnings and errors if present
diff --git a/Sources/EvolutionMetadataExtraction/Utilities/ValidationIssues.swift b/Sources/EvolutionMetadataExtraction/Utilities/ValidationIssues.swift
@@ -12,7 +12,7 @@ import EvolutionMetadataModel
 
 // VALIDATION ENHANCEMENTS: After validation enhancements, consider moving the full list of known issues to EvolutionMetadataModel as an extension to Proposal.Issue. Possibly then add ValidationIssue as a typealias.
 
-enum ValidationIssue {
+extension Proposal.Issue {
     
     // MARK: - Parse Errors
     // VALIDATION ENHANCEMENTS: Consider making a stronger 'unable to fetch or read proposal' statement

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ struct EvolutionMetadataExtractor {`
`100`	`100`
`101`	`101`	`} catch {`
`102`	`102`	`print(error)`
`103`		`- return SortableProposalWrapper(proposal: Proposal(errors:[ValidationIssue.proposalContainsNoContent]), sortIndex: proposalSpec.sortIndex)`
	`103`	`+ return SortableProposalWrapper(proposal: Proposal(errors:[.proposalContainsNoContent]), sortIndex: proposalSpec.sortIndex)`
`104`	`104`	`}`
`105`	`105`	`}`
`106`	`106`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {`
`28`	`28`	`// format discussions correctly. Those issues should be corrected in the proposals themselves.`
`29`	`29`	`// Once all of those issues are resolved, the legacy check can be removed.`
`30`	`30`	`if discussions.isEmpty && !Legacy.discussionExtractionFailures.contains(sourceValues.proposalID) {`
`31`		`- errors.append(ValidationIssue.discussionExtractionFailure)`
	`31`	`+ errors.append(.discussionExtractionFailure)`
`32`	`32`	`}`
`33`	`33`	`} else {`
`34`	`34`	`// VALIDATION ENHANCEMENT: Add field to proposals with missing field and remove special case logic.`
`@@ -37,7 +37,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {`
`37`	`37`	`// Once all of those issues are resolved, the legacy check can be removed.`
`38`	`38`	`// Note that some very early proposals may not have valid discussions be extracted.`
`39`	`39`	`if !Legacy.missingReviewFields.contains(sourceValues.proposalID) {`
`40`		`- errors.append(ValidationIssue.missingReviewField)`
	`40`	`+ errors.append(.missingReviewField)`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`@@ -60,7 +60,7 @@ struct DiscussionExtractor: MarkupWalker, ValueExtractor {`
`60`	`60`	`if let discussionURL = linkInfo.swiftForumsDestination {`
`61`	`61`	`discussions.append(Proposal.Discussion(name: linkInfo.text, link: discussionURL))`
`62`	`62`	`} else {`
`63`		`- warnings.append(ValidationIssue.invalidDiscussionLink)`
	`63`	`+ warnings.append(.invalidDiscussionLink)`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ struct ImplementationExtractor: MarkupWalker, ValueExtractor {`
`75`	`75`
`76`	`76`	`// VALIDATION ENHANCEMENT: The legacy tool lowercases the tested value. This is probably not necessary.`
`77`	`77`	`guard account == "apple" else {`
`78`		`- warnings.append(ValidationIssue.invalidImplementationLink)`
	`78`	`+ warnings.append(.invalidImplementationLink)`
`79`	`79`	`return`
`80`	`80`	`}`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -61,16 +61,16 @@ struct PersonExtractor: MarkupWalker {`
`61`	`61`	`}`
`62`	`62`	`// VALIDATION ENHANCEMENT: Add 'extra markup error' for review managers`
`63`	`63`	`if !linkInfo.containsTextElement && role == .author {`
`64`		`- errors.append(ValidationIssue.authorsHaveExtraMarkup)`
	`64`	`+ errors.append(.authorsHaveExtraMarkup)`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`let destination: String`
`68`	`68`	`if let validatedDestination = linkInfo.gitHubDestination {`
`69`	`69`	`destination = validatedDestination`
`70`	`70`	`} else {`
`71`	`71`	`switch role {`
`72`		`- case .author: warnings.append(ValidationIssue.invalidAuthorLink)`
`73`		`- case .reviewManager: warnings.append(ValidationIssue.invalidReviewManagerLink)`
	`72`	`+ case .author: warnings.append(.invalidAuthorLink)`
	`73`	`+ case .reviewManager: warnings.append(.invalidReviewManagerLink)`
`74`	`74`	`}`
`75`	`75`	`destination = ""`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ struct PreviousProposalExtractor: MarkupWalker, ValueExtractor {`
`27`	`27`
`28`	`28`	`// validate that if the header field is here at least one proposal ID was found`
`29`	`29`	`if _previousProposalIDs.isEmpty {`
`30`		`- errors.append(ValidationIssue.previousProposalIDsExtractionFailure)`
	`30`	`+ errors.append(.previousProposalIDsExtractionFailure)`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -20,24 +20,24 @@ struct ProposalLinkExtractor: MarkupWalker, ValueExtractor {`
`20`	`20`	`if let headerField = headerFieldsByLabel["Proposal"] {`
`21`	`21`	`visit(headerField)`
`22`	`22`	`} else {`
`23`		`- errors.append(ValidationIssue.missingProposalIDLink)`
	`23`	`+ errors.append(.missingProposalIDLink)`
`24`	`24`	`}`
`25`	`25`	`if let proposalLink {`
`26`	`26`
`27`	`27`	`if !proposalLink.containsTextElement {`
`28`		`- warnings.append(ValidationIssue.proposalIDHasExtraMarkup)`
	`28`	`+ warnings.append(.proposalIDHasExtraMarkup)`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`// VALIDATION ENHANCEMENT: To match legacy behavior, if ID has extra markup, the`
`32`	`32`	`// ID is an empty string. An enhancement would be to capture the ID if possible`
`33`	`33`	`if !proposalLink.text.isEmpty {`
`34`	`34`
`35`	`35`	`if proposalLink.text == "SE-0000" {`
`36`		`- errors.append(ValidationIssue.reservedProposalID)`
	`36`	`+ errors.append(.reservedProposalID)`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`if !proposalLink.text.contains(/^SE-\d\d\d\d$/) {`
`40`		`- errors.append(ValidationIssue.proposalIDWrongDigitCount)`
	`40`	`+ errors.append(.proposalIDWrongDigitCount)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`// VALIDATION ENHANCEMENT: Once we move from the legacy tool. Remove this.`
`@@ -58,14 +58,14 @@ struct ProposalLinkExtractor: MarkupWalker, ValueExtractor {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`} else {`
`61`		`- errors.append(ValidationIssue.missingProposalIDLink)`
	`61`	`+ errors.append(.missingProposalIDLink)`
`62`	`62`	`}`
`63`	`63`	`return ExtractionResult(value: proposalLink ?? LinkInfo(text: "", destination: ""), warnings: warnings, errors: errors)`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`mutating func visitLink(_ link: Link) -> () {`
`67`	`67`	`guard let value = LinkInfo(link: link) else {`
`68`		`- errors.append(ValidationIssue.missingProposalIDLink)`
	`68`	`+ errors.append(.missingProposalIDLink)`
`69`	`69`	`return`
`70`	`70`	`}`
`71`	`71`	`proposalLink = value`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {`
`30`	`30`
`31`	`31`	`// This checks both that the field is found and is successfully extracted`
`32`	`32`	`if status == nil {`
`33`		`- warnings.append(ValidationIssue.missingStatus)`
	`33`	`+ warnings.append(.missingStatus)`
`34`	`34`	`}`
`35`	`35`	`return ExtractionResult(value: status, warnings: warnings, errors: errors)`
`36`	`36`	`}`
`@@ -61,14 +61,14 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {`
`61`	`61`	`warnings.append(warning)`
`62`	`62`	`}`
`63`	`63`	`} else {`
`64`		`- warnings.append(ValidationIssue.missingOrInvalidReviewDates)`
	`64`	`+ warnings.append(.missingOrInvalidReviewDates)`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`if let rawStatus = Proposal.Status(name: statusString, version: version, start: start, end: end) {`
`69`	`69`	`status = rawStatus`
`70`	`70`	`} else {`
`71`		`- errors.append(ValidationIssue.missingOrInvalidStatus)`
	`71`	`+ errors.append(.missingOrInvalidStatus)`
`72`	`72`	`status = .statusExtractionFailed`
`73`	`73`	`}`
`74`	`74`	`}`
`@@ -184,7 +184,7 @@ struct StatusExtractor: MarkupWalker, ValueExtractor {`
`184`	`184`	`// VALIDATION ENHANCEMENT: Add (x) days before showing this.`
`185`	`185`	`var reviewEndedWarning: Proposal.Issue?`
`186`	`186`	`if processingDate > wrappedEndDate {`
`187`		`- reviewEndedWarning = ValidationIssue.reviewEnded(on: wrappedEndDate)`
	`187`	`+ reviewEndedWarning = .reviewEnded(on: wrappedEndDate)`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`// Specify explicit GMT time zone and 'en_US_POSIX' locale`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ struct TitleExtractor: ValueExtractor {`
`28`	`28`	`title = titleElement.plainText`
`29`	`29`
`30`	`30`	`} else {`
`31`		`- errors.append(ValidationIssue.proposalContainsNoContent)`
	`31`	`+ errors.append(.proposalContainsNoContent)`
`32`	`32`	`}`
`33`	`33`	`return ExtractionResult(value: title, warnings: warnings, errors: errors)`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -36,10 +36,10 @@ struct UpcomingFeatureFlagExtractor: MarkupWalker, ValueExtractor {`
`36`	`36`	`if let flag {`
`37`	`37`	`if flag.contains(/\s/) {`
`38`	`38`	`self.flag = nil`
`39`		`- errors.append(ValidationIssue.malformedUpcomingFeatureFlag)`
	`39`	`+ errors.append(.malformedUpcomingFeatureFlag)`
`40`	`40`	`}`
`41`	`41`	`} else {`
`42`		`- errors.append(ValidationIssue.upcomingFeatureFlagExtractionFailure)`
	`42`	`+ errors.append(.upcomingFeatureFlagExtractionFailure)`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`}`