|
| 1 | +/** |
| 2 | + * FlowForge Core Module - Validation Patterns |
| 3 | + * |
| 4 | + * File: modules/core/src/main/scala/com/flowforge/core/patterns/CommonValidations.scala Package: |
| 5 | + * com.flowforge.core.patterns |
| 6 | + * |
| 7 | + * This file provides comprehensive validation patterns and combinators for the FlowForge ecosystem. |
| 8 | + * It enables composable, functional validation with rich error accumulation and recovery strategies |
| 9 | + * using cats ValidatedNel. |
| 10 | + * |
| 11 | + * Design Patterns Applied: |
| 12 | + * - Combinator Pattern: Small, composable validation functions |
| 13 | + * - Strategy Pattern: Different validation strategies per data type |
| 14 | + * - Chain of Responsibility: Validation pipeline with ordered checks |
| 15 | + * - Template Method Pattern: Abstract validation framework with concrete rules |
| 16 | + * - Composite Pattern: Complex validations from simple components |
| 17 | + * |
| 18 | + * Scala Features Showcased: |
| 19 | + * - ValidatedNel: Error accumulation without short-circuiting |
| 20 | + * - Applicative Functor: Parallel validation with mapN |
| 21 | + * - Type Classes: Polymorphic validation across data types |
| 22 | + * - Higher-Order Functions: Validation combinators and builders |
| 23 | + * - Pattern Matching: Sophisticated error handling and routing |
| 24 | + * - Implicit Classes: Fluent validation syntax |
| 25 | + * - Generic Programming: Reusable validation patterns |
| 26 | + * |
| 27 | + * Innovation Highlights: |
| 28 | + * - Compositional validation with error accumulation |
| 29 | + * - Data quality validation with business rule integration |
| 30 | + * - Schema validation with evolution compatibility checking |
| 31 | + * - Configuration validation with environment-specific rules |
| 32 | + * - Performance-optimized validation for large datasets |
| 33 | + * - Conditional validation with context-aware rules |
| 34 | + * |
| 35 | + * Usage Examples: |
| 36 | + * ```scala |
| 37 | + * // Compositional validation with error accumulation |
| 38 | + * case class User(name: String, email: String, age: Int) |
| 39 | + * |
| 40 | + * val validateUser: User => ValidationResult[User] = { user => |
| 41 | + * ( |
| 42 | + * validateNonEmpty("name", user.name), |
| 43 | + * validateEmail("email", user.email), |
| 44 | + * validateRange("age", user.age, 0, 150) |
| 45 | + * ).mapN((_, _, _) => user) |
| 46 | + * } |
| 47 | + * |
| 48 | + * // Data quality validation with business rules |
| 49 | + * val dataQualityRules = ValidationRules |
| 50 | + * .builder[Dataset] |
| 51 | + * .notNull("customer_id") |
| 52 | + * .unique("transaction_id") |
| 53 | + * .range("amount", min = 0, max = 1_000_000) |
| 54 | + * .pattern("email", EmailPattern) |
| 55 | + * .freshness(maxAge = 24.hours) |
| 56 | + * .build |
| 57 | + * |
| 58 | + * // Conditional validation based on context |
| 59 | + * val environmentRules = ValidationRules.conditional[Config] { config => |
| 60 | + * if (config.environment.isProduction) { |
| 61 | + * strictValidation |
| 62 | + * } else { |
| 63 | + * lenientValidation |
| 64 | + * } |
| 65 | + * } |
| 66 | + * ``` |
| 67 | + * |
| 68 | + * @author |
| 69 | + * FlowForge Team |
| 70 | + * @version 1.0.0 |
| 71 | + * @since 2024 |
| 72 | + */ |
| 73 | +package com.flowforge.core.patterns |
| 74 | + |
| 75 | +import cats.syntax.all._ |
| 76 | +import com.flowforge.core.types.RefinedTypes._ |
| 77 | +import com.flowforge.core.types._ |
| 78 | +import com.flowforge.core.patterns.ValidationTypes._ |
| 79 | + |
| 80 | +/** |
| 81 | + * Pre-built validation patterns for common use cases. |
| 82 | + */ |
| 83 | +object CommonValidations { |
| 84 | + |
| 85 | + import ValidationCombinators._ |
| 86 | + |
| 87 | + /** |
| 88 | + * Standard user validation pattern. |
| 89 | + */ |
| 90 | + case class UserValidation( |
| 91 | + name: String, |
| 92 | + email: String, |
| 93 | + age: Int |
| 94 | + ) |
| 95 | + |
| 96 | + val validateUser: UserValidation => ConfigValidationResult[UserValidation] = { user => |
| 97 | + ( |
| 98 | + nonEmpty("name", user.name), |
| 99 | + email("email", user.email), |
| 100 | + intInRange("age", user.age, 0, 150) |
| 101 | + ).mapN((_, _, _) => user) |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Configuration validation pattern. |
| 106 | + */ |
| 107 | + def validatePipelineConfig(config: PipelineConfig): ConfigValidationResult[PipelineConfig] = { |
| 108 | + val nameValidation = nonEmpty("name", config.name.value) |
| 109 | + val environmentValidation = config.environment.validNel // Always valid |
| 110 | + val sourceValidation = config.source.validNel // Assume valid for now |
| 111 | + val sinkValidation = config.sink.validNel // Assume valid for now |
| 112 | + |
| 113 | + (nameValidation, environmentValidation, sourceValidation, sinkValidation) |
| 114 | + .mapN((_, _, _, _) => config) |
| 115 | + } |
| 116 | + |
| 117 | + /** |
| 118 | + * Data quality validation pattern. |
| 119 | + */ |
| 120 | + def validateDataQuality[A]( |
| 121 | + data: List[A], |
| 122 | + rules: QualityRules |
| 123 | + ): QualityValidationResult[List[A]] = |
| 124 | + // Simplified quality validation - in practice would be much more sophisticated |
| 125 | + if (data.nonEmpty) { |
| 126 | + valid(data) |
| 127 | + } else { |
| 128 | + val violation = QualityConstraint.NotNull( |
| 129 | + FieldName.unsafeFrom("data") |
| 130 | + ) |
| 131 | + invalid(violation).asInstanceOf[QualityValidationResult[List[A]]] |
| 132 | + } |
| 133 | + |
| 134 | + /** |
| 135 | + * Schema compatibility validation pattern. |
| 136 | + */ |
| 137 | + def validateSchemaCompatibility( |
| 138 | + source: DataSchema, |
| 139 | + target: DataSchema |
| 140 | + ): SchemaValidationResult = |
| 141 | + SchemaValidation.compatible(source, target) |
| 142 | +} |
0 commit comments