Remove docs, guides, and readmes relocated to old_files
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Trey t
@@ -1,158 +0,0 @@
|
||||
# Accessibility Identifiers - Duplicate Fix
|
||||
|
||||
## Issue
|
||||
The original `AccessibilityIdentifiers.swift` file had duplicate `cancelButton` declarations within the same struct, causing a compiler error:
|
||||
```
|
||||
Invalid redeclaration of 'cancelButton'
|
||||
```
|
||||
|
||||
## Root Cause
|
||||
Multiple forms within the same feature area (e.g., Task) had cancel buttons, and they were all named `cancelButton`:
|
||||
- `Task.cancelButton` (line 103) - for TaskForm
|
||||
- `Task.cancelButton` (line 111) - for TaskDetail
|
||||
|
||||
This occurred in multiple structs:
|
||||
- `Authentication.cancelButton` (Register)
|
||||
- `Residence.cancelButton` (Form)
|
||||
- `Task.cancelButton` (Form) ❌ Duplicate
|
||||
- `Task.cancelButton` (Detail) ❌ Duplicate
|
||||
- `Contractor.cancelButton` (Form)
|
||||
- `Document.cancelButton` (Form)
|
||||
- `Alert.cancelButton` (Generic alerts)
|
||||
|
||||
## Solution
|
||||
Renamed context-specific cancel buttons to be more descriptive:
|
||||
|
||||
### Authentication Struct
|
||||
```swift
|
||||
// Before
|
||||
static let cancelButton = "Register.CancelButton"
|
||||
|
||||
// After
|
||||
static let registerCancelButton = "Register.CancelButton"
|
||||
```
|
||||
|
||||
### Residence Struct
|
||||
```swift
|
||||
// Before
|
||||
static let cancelButton = "ResidenceForm.CancelButton"
|
||||
|
||||
// After
|
||||
static let formCancelButton = "ResidenceForm.CancelButton"
|
||||
```
|
||||
|
||||
### Task Struct
|
||||
```swift
|
||||
// Before (DUPLICATE ERROR)
|
||||
static let cancelButton = "TaskForm.CancelButton" // Line 103
|
||||
static let cancelButton = "TaskDetail.CancelButton" // Line 111 ❌
|
||||
|
||||
// After (FIXED)
|
||||
static let formCancelButton = "TaskForm.CancelButton"
|
||||
static let detailCancelButton = "TaskDetail.CancelButton"
|
||||
```
|
||||
|
||||
### Contractor Struct
|
||||
```swift
|
||||
// Before
|
||||
static let cancelButton = "ContractorForm.CancelButton"
|
||||
|
||||
// After
|
||||
static let formCancelButton = "ContractorForm.CancelButton"
|
||||
```
|
||||
|
||||
### Document Struct
|
||||
```swift
|
||||
// Before
|
||||
static let cancelButton = "DocumentForm.CancelButton"
|
||||
|
||||
// After
|
||||
static let formCancelButton = "DocumentForm.CancelButton"
|
||||
```
|
||||
|
||||
### Alert Struct (Unchanged)
|
||||
```swift
|
||||
// Generic cancel button for alerts - no conflict
|
||||
static let cancelButton = "Alert.CancelButton"
|
||||
```
|
||||
|
||||
## Files Modified
|
||||
|
||||
1. **`iosApp/Helpers/AccessibilityIdentifiers.swift`**
|
||||
- Renamed 6 cancel button identifiers to be context-specific
|
||||
|
||||
2. **`iosApp/HoneyDueTests/ComprehensiveResidenceTests.swift`**
|
||||
- Updated reference from `Residence.cancelButton` → `Residence.formCancelButton`
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Before (Would cause conflicts)
|
||||
```swift
|
||||
// Task Form
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.cancelButton) // ❌ Which one?
|
||||
|
||||
// Task Detail
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.cancelButton) // ❌ Duplicate!
|
||||
```
|
||||
|
||||
### After (Clear and unambiguous)
|
||||
```swift
|
||||
// Task Form
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.formCancelButton) // ✅ Clear
|
||||
|
||||
// Task Detail
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.detailCancelButton) // ✅ Clear
|
||||
```
|
||||
|
||||
## Naming Convention
|
||||
|
||||
For cancel buttons in different contexts:
|
||||
- **Forms**: `formCancelButton`
|
||||
- **Detail/View screens**: `detailCancelButton`
|
||||
- **Registration**: `registerCancelButton`
|
||||
- **Generic alerts**: `cancelButton` (in Alert struct)
|
||||
|
||||
## Test Updates Required
|
||||
|
||||
When adding identifiers to views, use the updated names:
|
||||
|
||||
```swift
|
||||
// Residence Form
|
||||
Button("Cancel") { dismiss() }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.formCancelButton)
|
||||
|
||||
// Task Form
|
||||
Button("Cancel") { dismiss() }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.formCancelButton)
|
||||
|
||||
// Task Detail
|
||||
Button("Cancel Task") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.detailCancelButton)
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
The file should now compile without errors. To verify:
|
||||
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
xcodebuild -project iosApp.xcodeproj -scheme iosApp -destination 'generic/platform=iOS Simulator' clean build
|
||||
```
|
||||
|
||||
Or simply build in Xcode (⌘+B).
|
||||
|
||||
## Status
|
||||
|
||||
✅ **Fixed** - All duplicate identifiers resolved
|
||||
✅ **Test files updated** - ComprehensiveResidenceTests uses new names
|
||||
✅ **No breaking changes** - Only internal identifier names changed, not the actual string values
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** November 18, 2025
|
||||
**Issue:** Duplicate cancelButton declarations
|
||||
**Resolution:** Renamed to context-specific names (formCancelButton, detailCancelButton, etc.)
|
||||
@@ -1,205 +0,0 @@
|
||||
# HoneyDue iOS Design System
|
||||
|
||||
## Overview
|
||||
This document outlines the modern, sleek design system implemented for the HoneyDue iOS app.
|
||||
|
||||
## Design Philosophy
|
||||
- **Modern & Clean**: Minimalist approach with ample white space
|
||||
- **Consistent**: Reusable components with unified styling
|
||||
- **Accessible**: High contrast ratios and readable typography
|
||||
- **Delightful**: Subtle animations and gradient accents
|
||||
|
||||
## Color Palette
|
||||
|
||||
### Primary Colors
|
||||
- **Primary**: `#2563EB` - Modern blue for primary actions
|
||||
- **Primary Light**: `#3B82F6` - Lighter variant for gradients
|
||||
- **Primary Dark**: `#1E40AF` - Darker variant for pressed states
|
||||
|
||||
### Accent Colors
|
||||
- **Accent**: `#8B5CF6` - Purple for special highlights
|
||||
- **Accent Light**: `#A78BFA` - Lighter purple for gradients
|
||||
|
||||
### Semantic Colors
|
||||
- **Success**: `#10B981` - Green for completed/success states
|
||||
- **Warning**: `#F59E0B` - Orange for in-progress/warning states
|
||||
- **Error**: `#EF4444` - Red for errors and destructive actions
|
||||
- **Info**: `#3B82F6` - Blue for informational content
|
||||
|
||||
### Neutral Colors
|
||||
- **Background**: `#F9FAFB` - Light gray for app background
|
||||
- **Surface**: `#FFFFFF` - White for cards and surfaces
|
||||
- **Surface Secondary**: `#F3F4F6` - Light gray for secondary surfaces
|
||||
- **Text Primary**: `#111827` - Near black for primary text
|
||||
- **Text Secondary**: `#6B7280` - Medium gray for secondary text
|
||||
- **Text Tertiary**: `#9CA3AF` - Light gray for tertiary text
|
||||
- **Border**: `#E5E7EB` - Light gray for borders
|
||||
- **Border Light**: `#F3F4F6` - Very light gray for subtle borders
|
||||
|
||||
## Typography
|
||||
|
||||
### Display (Hero Sections)
|
||||
- **Display Large**: 57pt, Bold, Rounded
|
||||
- **Display Medium**: 45pt, Bold, Rounded
|
||||
- **Display Small**: 36pt, Bold, Rounded
|
||||
|
||||
### Headline (Section Headers)
|
||||
- **Headline Large**: 32pt, Bold, Rounded
|
||||
- **Headline Medium**: 28pt, Semibold, Rounded
|
||||
- **Headline Small**: 24pt, Semibold, Rounded
|
||||
|
||||
### Title (Card Titles)
|
||||
- **Title Large**: 22pt, Semibold
|
||||
- **Title Medium**: 18pt, Semibold
|
||||
- **Title Small**: 16pt, Semibold
|
||||
|
||||
### Body (Main Content)
|
||||
- **Body Large**: 17pt, Regular
|
||||
- **Body Medium**: 15pt, Regular
|
||||
- **Body Small**: 13pt, Regular
|
||||
|
||||
### Label (Labels & Captions)
|
||||
- **Label Large**: 14pt, Medium
|
||||
- **Label Medium**: 12pt, Medium
|
||||
- **Label Small**: 11pt, Medium
|
||||
|
||||
### Caption
|
||||
- **Caption**: 12pt, Regular
|
||||
|
||||
## Spacing Scale
|
||||
- **XXS**: 4pt
|
||||
- **XS**: 8pt
|
||||
- **SM**: 12pt
|
||||
- **MD**: 16pt
|
||||
- **LG**: 24pt
|
||||
- **XL**: 32pt
|
||||
- **XXL**: 48pt
|
||||
- **XXXL**: 64pt
|
||||
|
||||
## Border Radius
|
||||
- **XS**: 4pt
|
||||
- **SM**: 8pt
|
||||
- **MD**: 12pt
|
||||
- **LG**: 16pt
|
||||
- **XL**: 20pt
|
||||
- **XXL**: 24pt
|
||||
- **Full**: 9999pt (Circular)
|
||||
|
||||
## Shadows
|
||||
- **SM**: rgba(0,0,0,0.05), radius: 2, y: 1
|
||||
- **MD**: rgba(0,0,0,0.1), radius: 4, y: 2
|
||||
- **LG**: rgba(0,0,0,0.1), radius: 8, y: 4
|
||||
- **XL**: rgba(0,0,0,0.15), radius: 16, y: 8
|
||||
|
||||
## Component Patterns
|
||||
|
||||
### Cards
|
||||
- White background (`AppColors.surface`)
|
||||
- Rounded corners (16pt or 20pt)
|
||||
- Subtle shadow (`AppShadow.md` or `AppShadow.lg`)
|
||||
- Padding: 16-32pt depending on content
|
||||
|
||||
### Buttons
|
||||
- **Primary**: Gradient background, white text, 56pt height
|
||||
- **Secondary**: Light gray background, primary color text, 56pt height
|
||||
- Rounded corners: 12pt
|
||||
- Pressed state: Scale to 0.98
|
||||
|
||||
### Text Fields
|
||||
- Light gray background (`AppColors.surfaceSecondary`)
|
||||
- 16pt padding
|
||||
- 12pt rounded corners
|
||||
- Focused state: Primary color border + subtle shadow
|
||||
- Icon prefix for visual context
|
||||
|
||||
### Navigation Cards
|
||||
- Gradient icon background in rounded rectangle
|
||||
- Clear hierarchy: Title (semibold) + Subtitle (secondary color)
|
||||
- Chevron indicator
|
||||
- Hover/tap feedback
|
||||
|
||||
## Modernization Highlights
|
||||
|
||||
### Login Screen
|
||||
- Circular gradient app icon with shadow
|
||||
- Card-based form layout
|
||||
- Animated focus states on input fields
|
||||
- Gradient button with disabled states
|
||||
- Clean error messaging
|
||||
|
||||
### Home Screen
|
||||
- Personalized greeting header
|
||||
- Stats overview card with icon badges
|
||||
- Modern navigation cards with gradient icons
|
||||
- Smooth scroll experience
|
||||
|
||||
### Components
|
||||
- **OverviewCard**: Stats grid with dividers and icon badges
|
||||
- **StatView**: Circular icon backgrounds with modern typography
|
||||
- **HomeNavigationCard**: Gradient icons with clean layout
|
||||
- **Design System**: Centralized colors, typography, and spacing
|
||||
|
||||
## Usage
|
||||
|
||||
### Importing the Design System
|
||||
```swift
|
||||
import SwiftUI
|
||||
|
||||
// Colors
|
||||
.foregroundColor(AppColors.primary)
|
||||
.background(AppColors.surface)
|
||||
|
||||
// Typography
|
||||
.font(AppTypography.headlineSmall)
|
||||
|
||||
// Spacing
|
||||
.padding(AppSpacing.md)
|
||||
|
||||
// Radius
|
||||
.cornerRadius(AppRadius.lg)
|
||||
|
||||
// Shadows
|
||||
.shadow(color: AppShadow.lg.color, radius: AppShadow.lg.radius, y: AppShadow.lg.y)
|
||||
|
||||
// Gradients
|
||||
.fill(AppColors.primaryGradient)
|
||||
```
|
||||
|
||||
### Button Styles
|
||||
```swift
|
||||
Button("Action") {
|
||||
// action
|
||||
}
|
||||
.buttonStyle(PrimaryButtonStyle())
|
||||
|
||||
Button("Cancel") {
|
||||
// action
|
||||
}
|
||||
.buttonStyle(SecondaryButtonStyle())
|
||||
```
|
||||
|
||||
### Card Style
|
||||
```swift
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.cardStyle() // Applies background, corners, and shadow
|
||||
```
|
||||
|
||||
## Future Enhancements
|
||||
- Dark mode support with adaptive colors
|
||||
- Additional component styles (chips, badges, alerts)
|
||||
- Animation utilities for transitions
|
||||
- Accessibility utilities (dynamic type, VoiceOver)
|
||||
- Custom SF Symbols integration
|
||||
|
||||
## Migration Guide
|
||||
When updating existing views:
|
||||
|
||||
1. Replace hardcoded colors with `AppColors.*`
|
||||
2. Replace hardcoded fonts with `AppTypography.*`
|
||||
3. Replace hardcoded spacing with `AppSpacing.*`
|
||||
4. Use `cardStyle()` modifier for cards
|
||||
5. Apply button styles for consistency
|
||||
6. Add gradients to prominent UI elements
|
||||
7. Ensure proper spacing hierarchy
|
||||
@@ -1,183 +0,0 @@
|
||||
# Fix: Test Target Configuration
|
||||
|
||||
## Problem
|
||||
|
||||
When compiling tests, you're seeing:
|
||||
```
|
||||
@testable import iosApp
|
||||
No such module 'iosApp'
|
||||
```
|
||||
|
||||
This means the test target (`HoneyDueTests`) is not properly configured to access the main app target (`iosApp`).
|
||||
|
||||
## Solution: Configure Test Target in Xcode
|
||||
|
||||
### Step 1: Open Xcode Project
|
||||
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
```
|
||||
|
||||
### Step 2: Add Target Dependency
|
||||
|
||||
1. **Select the project** in the Project Navigator (top item, blue icon)
|
||||
2. **Select `HoneyDueTests` target** in the targets list (middle column)
|
||||
3. **Go to "Build Phases" tab** (top of editor)
|
||||
4. **Expand "Dependencies" section**
|
||||
5. **Click the "+" button** under Dependencies
|
||||
6. **Select `iosApp`** from the list
|
||||
7. **Click "Add"**
|
||||
|
||||
### Step 3: Configure Test Host
|
||||
|
||||
1. Still in **`HoneyDueTests` target** → **Build Settings** tab
|
||||
2. **Search for "Test Host"**
|
||||
3. Set **Test Host** to:
|
||||
```
|
||||
$(BUILT_PRODUCTS_DIR)/iosApp.app/iosApp
|
||||
```
|
||||
4. **Search for "Bundle Loader"**
|
||||
5. Set **Bundle Loader** to:
|
||||
```
|
||||
$(TEST_HOST)
|
||||
```
|
||||
|
||||
### Step 4: Enable Testability
|
||||
|
||||
1. **Select `iosApp` target** (main app)
|
||||
2. Go to **Build Settings** tab
|
||||
3. **Search for "Enable Testability"**
|
||||
4. Set **Enable Testability** to **YES** for **Debug** configuration
|
||||
- (Leave it NO for Release)
|
||||
|
||||
### Step 5: Verify Module Name
|
||||
|
||||
1. **Select `iosApp` target**
|
||||
2. Go to **Build Settings** tab
|
||||
3. **Search for "Product Module Name"**
|
||||
4. Verify it says **`iosApp`**
|
||||
- If it's different (e.g., "HoneyDue"), you need to update your imports
|
||||
|
||||
### Step 6: Clean and Build
|
||||
|
||||
1. **Product** → **Clean Build Folder** (or press `⌘ + Shift + K`)
|
||||
2. **Product** → **Build For** → **Testing** (or press `⌘ + Shift + U`)
|
||||
|
||||
### Step 7: Verify Fix
|
||||
|
||||
Open any test file (e.g., `ContractorViewModelTests.swift`) and verify the import works:
|
||||
|
||||
```swift
|
||||
@testable import iosApp // Should no longer show error
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Alternative: Command Line Fix (Advanced)
|
||||
|
||||
If you prefer command-line configuration, you can use `xcodebuild` with PlistBuddy, but the Xcode GUI method above is safer and recommended.
|
||||
|
||||
---
|
||||
|
||||
## Visual Guide
|
||||
|
||||
### What It Should Look Like:
|
||||
|
||||
**HoneyDueTests Target → Build Phases → Dependencies:**
|
||||
```
|
||||
✅ iosApp (target)
|
||||
```
|
||||
|
||||
**HoneyDueTests Target → Build Settings:**
|
||||
```
|
||||
Test Host: $(BUILT_PRODUCTS_DIR)/iosApp.app/iosApp
|
||||
Bundle Loader: $(TEST_HOST)
|
||||
```
|
||||
|
||||
**iosApp Target → Build Settings:**
|
||||
```
|
||||
Enable Testability: Yes (Debug only)
|
||||
Product Module Name: iosApp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Issues & Solutions
|
||||
|
||||
### Issue 1: Still getting "No such module"
|
||||
**Solution:**
|
||||
- Clean build folder (`⌘ + Shift + K`)
|
||||
- Delete derived data:
|
||||
```bash
|
||||
rm -rf ~/Library/Developer/Xcode/DerivedData/iosApp-*
|
||||
```
|
||||
- Restart Xcode
|
||||
- Build again
|
||||
|
||||
### Issue 2: Module name is different
|
||||
**Solution:**
|
||||
- Check what the actual module name is:
|
||||
- Select `iosApp` target → Build Settings → Product Module Name
|
||||
- Update all test imports to match:
|
||||
```swift
|
||||
@testable import <ActualModuleName>
|
||||
```
|
||||
|
||||
### Issue 3: "Target is not an application"
|
||||
**Solution:**
|
||||
- Make sure you selected the **main app target** (`iosApp`), not the extension target
|
||||
- The Test Host should point to the `.app` bundle
|
||||
|
||||
### Issue 4: Xcode can't find the app
|
||||
**Solution:**
|
||||
- Build the main app first: `⌘ + B`
|
||||
- Then build tests: `⌘ + Shift + U`
|
||||
|
||||
---
|
||||
|
||||
## Quick Verification Checklist
|
||||
|
||||
After making changes, verify:
|
||||
|
||||
- [ ] `HoneyDueTests` target has `iosApp` in Dependencies
|
||||
- [ ] Test Host is set to `$(BUILT_PRODUCTS_DIR)/iosApp.app/iosApp`
|
||||
- [ ] Bundle Loader is set to `$(TEST_HOST)`
|
||||
- [ ] `iosApp` target has "Enable Testability" = YES (Debug)
|
||||
- [ ] Product Module Name matches your import statement
|
||||
- [ ] Project builds successfully (`⌘ + B`)
|
||||
- [ ] Tests build successfully (`⌘ + Shift + U`)
|
||||
- [ ] No import errors in test files
|
||||
|
||||
---
|
||||
|
||||
## Why This Happens
|
||||
|
||||
The test target needs explicit configuration to:
|
||||
1. **Know which app to test** (Target Dependency)
|
||||
2. **Where to find the app binary** (Test Host)
|
||||
3. **Access internal/private code** (Enable Testability + @testable import)
|
||||
|
||||
Without these settings, the compiler doesn't know that `iosApp` module exists.
|
||||
|
||||
---
|
||||
|
||||
## After Fixing
|
||||
|
||||
Once configured, your tests will:
|
||||
- ✅ Import the main app module successfully
|
||||
- ✅ Access internal classes and methods with `@testable import`
|
||||
- ✅ Run against the actual app binary
|
||||
- ✅ Have access to all app code for testing
|
||||
|
||||
---
|
||||
|
||||
**Estimated Time:** 2-3 minutes
|
||||
**Difficulty:** Easy (GUI-based)
|
||||
**Risk:** Low (non-destructive changes)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** November 18, 2025
|
||||
**Issue:** Test target not configured for app module access
|
||||
**Resolution:** Add target dependency and configure test host in Xcode
|
||||
@@ -1,78 +0,0 @@
|
||||
# Fix HoneyDueTests Target Configuration
|
||||
|
||||
## The Problem
|
||||
|
||||
The tests are failing with "No target application path specified" because the test target's `TEST_HOST` setting is hardcoded to a wrong path:
|
||||
|
||||
```
|
||||
TEST_HOST = /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/build/Release-iphoneos/HoneyDue.app//HoneyDue
|
||||
```
|
||||
|
||||
This path doesn't exist when running tests in Debug mode on the simulator.
|
||||
|
||||
## The Fix (Manual - Do This in Xcode)
|
||||
|
||||
1. **Open the project in Xcode:**
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
```
|
||||
|
||||
2. **Select the HoneyDueTests target:**
|
||||
- Click on the project in the Project Navigator (blue icon at top)
|
||||
- Select **HoneyDueTests** from the TARGETS list
|
||||
|
||||
3. **Go to Build Settings:**
|
||||
- Click the **Build Settings** tab
|
||||
- Make sure "All" and "Combined" are selected (not "Basic" or "Customized")
|
||||
|
||||
4. **Search for "TEST_HOST":**
|
||||
- Use the search box at top right
|
||||
- Type "TEST_HOST"
|
||||
|
||||
5. **Set TEST_HOST value:**
|
||||
- Double-click the value field
|
||||
- Change from:
|
||||
```
|
||||
/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/build/Release-iphoneos/HoneyDue.app//HoneyDue
|
||||
```
|
||||
- To:
|
||||
```
|
||||
$(BUILT_PRODUCTS_DIR)/HoneyDue.app/HoneyDue
|
||||
```
|
||||
- Press Enter
|
||||
|
||||
6. **Verify BUNDLE_LOADER:**
|
||||
- Clear the search, search for "BUNDLE_LOADER"
|
||||
- It should be set to:
|
||||
```
|
||||
$(TEST_HOST)
|
||||
```
|
||||
- If not, set it to that value
|
||||
|
||||
7. **Clean and rebuild:**
|
||||
- Product → Clean Build Folder (Cmd+Shift+K)
|
||||
- Product → Build (Cmd+B)
|
||||
|
||||
8. **Run tests:**
|
||||
- Product → Test (Cmd+U)
|
||||
- Or click the diamond icon next to any test method
|
||||
|
||||
## Verification
|
||||
|
||||
After making these changes, run:
|
||||
|
||||
```bash
|
||||
xcodebuild -project iosApp.xcodeproj -target HoneyDueTests -showBuildSettings | grep TEST_HOST
|
||||
```
|
||||
|
||||
Should output:
|
||||
```
|
||||
TEST_HOST = $(BUILT_PRODUCTS_DIR)/HoneyDue.app/HoneyDue
|
||||
```
|
||||
|
||||
NOT a hardcoded absolute path.
|
||||
|
||||
## Why This Happened
|
||||
|
||||
The test target was likely created manually or the project was moved, causing Xcode to lose the proper build settings reference.
|
||||
@@ -1,164 +0,0 @@
|
||||
# Failing Suites 0-3: Coverage + Rebuild Plan
|
||||
|
||||
## Baseline (from observed runs)
|
||||
- `Suite0_OnboardingTests`: 1 test, 1 failure
|
||||
- `Suite1_RegistrationTests`: 11 tests, 5 failures
|
||||
- `Suite2_AuthenticationTests`: 6 tests, 2 failures
|
||||
- `Suite3_ResidenceTests`: 6 tests, 6 failures
|
||||
|
||||
Primary failure logs used:
|
||||
- `/tmp/ui_suite0.log`
|
||||
- `/tmp/ui_suites_1_3.log`
|
||||
|
||||
---
|
||||
|
||||
## Suite0
|
||||
|
||||
### Failing test
|
||||
- `Suite0_OnboardingTests.test_onboarding`
|
||||
|
||||
### What it is testing
|
||||
- End-to-end onboarding progression from welcome/login entry into account creation and onward.
|
||||
- UI interaction stability during onboarding form entry.
|
||||
|
||||
### Observed failure point
|
||||
- Assertion failure: `Email field must become focused for typing`.
|
||||
|
||||
### Rebuild in new arch
|
||||
Create a new test case focused on deterministic onboarding field interaction:
|
||||
- `Onboarding_EmailRegistration_FocusAndInputFlow`
|
||||
|
||||
Coverage to preserve:
|
||||
- Email field reliably focusable and typeable.
|
||||
- Continue action only enabled after valid required inputs.
|
||||
- Onboarding progresses to next state after valid submission.
|
||||
|
||||
Required infra:
|
||||
- `OnboardingScreen` page object with `tapEmailField()`, `typeEmail()`, `assertEmailFieldFocused()`.
|
||||
- Keyboard/overlay helper centralized (not inline in tests).
|
||||
|
||||
---
|
||||
|
||||
## Suite1
|
||||
Detailed plan already captured in:
|
||||
- `/Users/treyt/Desktop/code/HoneyDueKMM/iosApp/HoneyDueUITests/Docs/Suite1_Failing_Test_Rebuild_Plan.md`
|
||||
|
||||
### Failing tests
|
||||
- `test07_successfulRegistrationAndVerification`
|
||||
- `test09_registrationWithInvalidVerificationCode`
|
||||
- `test10_verificationCodeFieldValidation`
|
||||
- `test11_appRelaunchWithUnverifiedUser`
|
||||
- `test12_logoutFromVerificationScreen`
|
||||
|
||||
### Rebuild targets
|
||||
- `Registration_HappyPath_CompletesVerification_ThenCanLogout`
|
||||
- `Registration_InvalidVerifyCode_ShowsError_StaysUnverified`
|
||||
- `Registration_IncompleteVerifyCode_DoesNotVerify`
|
||||
- `Registration_UnverifiedUser_RelaunchStillBlockedFromMain`
|
||||
- `Registration_VerificationScreenLogout_ReturnsToLogin`
|
||||
|
||||
---
|
||||
|
||||
## Suite2
|
||||
|
||||
### Failing tests
|
||||
- `Suite2_AuthenticationTests.test02_loginWithValidCredentials`
|
||||
- `Suite2_AuthenticationTests.test06_logout`
|
||||
|
||||
### What they are testing
|
||||
|
||||
#### `test02_loginWithValidCredentials`
|
||||
- Valid login path transitions from login screen to main app.
|
||||
- Authenticated state exposes main navigation (tab bar/app root).
|
||||
|
||||
#### `test06_logout`
|
||||
- Logged-in user can logout.
|
||||
- Session is cleared and app returns to login state.
|
||||
|
||||
### Observed failure points
|
||||
- `test02`: `Should navigate to main app after successful login`
|
||||
- `test06`: `Should be logged in` (precondition for logout flow failed)
|
||||
|
||||
### Rebuild in new arch
|
||||
Create explicit state-driven auth tests:
|
||||
- `Auth_ValidLogin_TransitionsToMainApp`
|
||||
- `Auth_Logout_FromMainApp_ReturnsToLogin`
|
||||
|
||||
Coverage to preserve:
|
||||
- Login success sets authenticated UI state.
|
||||
- Logout always clears authenticated state.
|
||||
- No false-positive “logged in” assumptions.
|
||||
|
||||
Required infra:
|
||||
- `LoginScreen`, `MainTabScreen`, `ProfileScreen` page objects.
|
||||
- `AuthAssertions.assertAtLoginRoot()`, `assertAtMainRoot()`.
|
||||
- Test user fixture policy for valid credentials.
|
||||
|
||||
---
|
||||
|
||||
## Suite3
|
||||
|
||||
### Failing tests
|
||||
- `Suite3_ResidenceTests.test01_viewResidencesList`
|
||||
- `Suite3_ResidenceTests.test02_navigateToAddResidence`
|
||||
- `Suite3_ResidenceTests.test03_navigationBetweenTabs`
|
||||
- `Suite3_ResidenceTests.test04_cancelResidenceCreation`
|
||||
- `Suite3_ResidenceTests.test05_createResidenceWithMinimalData`
|
||||
- `Suite3_ResidenceTests.test06_viewResidenceDetails`
|
||||
|
||||
### What they are testing
|
||||
- Residence tab/list visibility.
|
||||
- Navigation to add-residence form.
|
||||
- Cross-tab navigation sanity.
|
||||
- Canceling residence creation.
|
||||
- Creating residence with minimal fields.
|
||||
- Opening residence details.
|
||||
|
||||
### Observed failure pattern
|
||||
All 6 fail at the same gateway:
|
||||
- No `Residences` tab bar button match found.
|
||||
- This indicates tests are not reaching authenticated main-app state before residence assertions.
|
||||
|
||||
### Rebuild in new arch
|
||||
Split auth precondition from residence behavior:
|
||||
- `Residence_Precondition_AuthenticatedAndAtResidencesTab`
|
||||
- `Residence_OpenCreateForm`
|
||||
- `Residence_CancelCreate_ReturnsToList`
|
||||
- `Residence_CreateMinimal_ShowsInList`
|
||||
- `Residence_OpenDetails_FromList`
|
||||
- `Residence_TabNavigation_MainSections`
|
||||
|
||||
Coverage to preserve:
|
||||
- Residence flows validated only after explicit `main app ready` assertion.
|
||||
- Failures clearly classify as auth-gate vs residence-feature regression.
|
||||
|
||||
Required infra:
|
||||
- `MainTabScreen.goToResidences()` with ID-first selectors.
|
||||
- `ResidenceListScreen`, `ResidenceFormScreen`, `ResidenceDetailScreen` page objects.
|
||||
- Shared precondition helper: `ensureAuthenticatedMainApp()`.
|
||||
|
||||
---
|
||||
|
||||
## Blueprint-aligned migration notes
|
||||
- Keep old-to-new mapping explicit in PR description.
|
||||
- Replace brittle text-based selectors with accessibility IDs first.
|
||||
- Use one state assertion per transition boundary:
|
||||
- `login -> verification -> main app -> login`.
|
||||
- Move keyboard/strong-password overlay handling into one helper.
|
||||
- Do not mark legacy tests removed until replacement coverage is green.
|
||||
|
||||
## Proposed replacement matrix
|
||||
- `Suite0.test_onboarding` -> `Onboarding_EmailRegistration_FocusAndInputFlow`
|
||||
- `Suite1.test07` -> `Registration_HappyPath_CompletesVerification_ThenCanLogout`
|
||||
- `Suite1.test09` -> `Registration_InvalidVerifyCode_ShowsError_StaysUnverified`
|
||||
- `Suite1.test10` -> `Registration_IncompleteVerifyCode_DoesNotVerify`
|
||||
- `Suite1.test11` -> `Registration_UnverifiedUser_RelaunchStillBlockedFromMain`
|
||||
- `Suite1.test12` -> `Registration_VerificationScreenLogout_ReturnsToLogin`
|
||||
- `Suite2.test02` -> `Auth_ValidLogin_TransitionsToMainApp`
|
||||
- `Suite2.test06` -> `Auth_Logout_FromMainApp_ReturnsToLogin`
|
||||
- `Suite3.test01` -> `Residence_Precondition_AuthenticatedAndAtResidencesTab`
|
||||
- `Suite3.test02` -> `Residence_OpenCreateForm`
|
||||
- `Suite3.test03` -> `Residence_TabNavigation_MainSections`
|
||||
- `Suite3.test04` -> `Residence_CancelCreate_ReturnsToList`
|
||||
- `Suite3.test05` -> `Residence_CreateMinimal_ShowsInList`
|
||||
- `Suite3.test06` -> `Residence_OpenDetails_FromList`
|
||||
@@ -1,174 +0,0 @@
|
||||
# Suite1 Registration Failing Tests: Coverage + Rebuild Plan
|
||||
|
||||
## Scope
|
||||
This document captures what the currently failing registration-flow tests are trying to validate and how to recreate that coverage using the new UI test architecture.
|
||||
|
||||
Source tests:
|
||||
- `Suite1_RegistrationTests.test07_successfulRegistrationAndVerification`
|
||||
- `Suite1_RegistrationTests.test09_registrationWithInvalidVerificationCode`
|
||||
- `Suite1_RegistrationTests.test10_verificationCodeFieldValidation`
|
||||
- `Suite1_RegistrationTests.test11_appRelaunchWithUnverifiedUser`
|
||||
- `Suite1_RegistrationTests.test12_logoutFromVerificationScreen`
|
||||
|
||||
## Current Failure Context (Observed)
|
||||
- Registration submit does not transition to a verification screen in automation runs.
|
||||
- UI-level registration error shown during failures: `Password must be at least 8 characters`.
|
||||
- Because registration transition fails, downstream verification assertions fail.
|
||||
|
||||
## What Each Failing Test Is Actually Testing
|
||||
|
||||
### 1) `test07_successfulRegistrationAndVerification`
|
||||
Behavior intent:
|
||||
- User can register with valid credentials.
|
||||
- App transitions to verification state.
|
||||
- Entering valid verification code completes verification.
|
||||
- User lands in main app (tab bar available).
|
||||
- Logout returns user to login.
|
||||
|
||||
Core business coverage:
|
||||
- Happy-path onboarding/auth state progression.
|
||||
- Verified user session gains app access.
|
||||
- Logout clears authenticated session.
|
||||
|
||||
### 2) `test09_registrationWithInvalidVerificationCode`
|
||||
Behavior intent:
|
||||
- Registration reaches verification state.
|
||||
- Entering wrong code shows verification error.
|
||||
- User remains blocked from main app.
|
||||
|
||||
Core business coverage:
|
||||
- Backend validation for invalid verification code.
|
||||
- No false positive promotion to verified state.
|
||||
|
||||
### 3) `test10_verificationCodeFieldValidation`
|
||||
Behavior intent:
|
||||
- Verification screen enforces code format/length.
|
||||
- Incomplete code does not complete verification.
|
||||
- User remains on verification state.
|
||||
|
||||
Core business coverage:
|
||||
- Client-side verification input guardrails.
|
||||
- No bypass with partial code.
|
||||
|
||||
### 4) `test11_appRelaunchWithUnverifiedUser`
|
||||
Behavior intent:
|
||||
- User reaches unverified verification state.
|
||||
- App terminate/relaunch preserves unverified gating.
|
||||
- Relaunch must not allow direct main-app access.
|
||||
|
||||
Core business coverage:
|
||||
- Session restore + auth gate correctness for unverified users.
|
||||
|
||||
### 5) `test12_logoutFromVerificationScreen`
|
||||
Behavior intent:
|
||||
- Unverified user can explicitly logout from verification screen.
|
||||
- Verification UI dismisses.
|
||||
- App returns to interactive login screen.
|
||||
|
||||
Core business coverage:
|
||||
- Logout works from gated verification state.
|
||||
- Session cleanup from pre-verified auth state.
|
||||
|
||||
## Rebuild These in New Architecture
|
||||
|
||||
## Shared Test Architecture Requirements
|
||||
Create/ensure these reusable pieces:
|
||||
- `AuthFlowHarness` (launch + auth preconditions + cleanup)
|
||||
- `RegistrationScreen` page object
|
||||
- `VerificationScreen` page object
|
||||
- `MainTabScreen` page object
|
||||
- `SessionStateAsserts` helpers for `login`, `verification`, `mainApp`
|
||||
- `TestUserFactory` with deterministic unique users
|
||||
|
||||
Use stable selectors first:
|
||||
- Accessibility IDs over title text.
|
||||
- Support both auth/onboarding verification IDs only if product can route to either screen.
|
||||
|
||||
## Suggested New-Arch Test Cases (One-to-One Replacement)
|
||||
|
||||
### A. `Registration_HappyPath_CompletesVerification_ThenCanLogout`
|
||||
Covers legacy test07.
|
||||
|
||||
Given:
|
||||
- Fresh launch, logged out.
|
||||
|
||||
When:
|
||||
- Register with valid user.
|
||||
- Verify with valid code.
|
||||
- Logout from profile/main app.
|
||||
|
||||
Then:
|
||||
- Verification gate appears after register.
|
||||
- Main app appears only after successful verify.
|
||||
- Logout returns to login root.
|
||||
|
||||
### B. `Registration_InvalidVerifyCode_ShowsError_StaysUnverified`
|
||||
Covers legacy test09.
|
||||
|
||||
Given:
|
||||
- User registered and on verification screen.
|
||||
|
||||
When:
|
||||
- Submit invalid verification code.
|
||||
|
||||
Then:
|
||||
- Error banner/message visible.
|
||||
- Verification screen remains active.
|
||||
- Main app root not accessible.
|
||||
|
||||
### C. `Registration_IncompleteVerifyCode_DoesNotVerify`
|
||||
Covers legacy test10.
|
||||
|
||||
Given:
|
||||
- User on verification screen.
|
||||
|
||||
When:
|
||||
- Enter fewer than required digits.
|
||||
- Attempt verify (or assert button disabled).
|
||||
|
||||
Then:
|
||||
- Verification completion does not occur.
|
||||
- User remains blocked from main app.
|
||||
|
||||
### D. `Registration_UnverifiedUser_RelaunchStillBlockedFromMain`
|
||||
Covers legacy test11.
|
||||
|
||||
Given:
|
||||
- User registered but not verified.
|
||||
|
||||
When:
|
||||
- Terminate and relaunch app.
|
||||
|
||||
Then:
|
||||
- User is on verification gate (or login if session invalidated).
|
||||
- User is never placed directly in main app state.
|
||||
|
||||
### E. `Registration_VerificationScreenLogout_ReturnsToLogin`
|
||||
Covers legacy test12.
|
||||
|
||||
Given:
|
||||
- User at verification gate.
|
||||
|
||||
When:
|
||||
- Tap logout on verification screen.
|
||||
|
||||
Then:
|
||||
- Verification state exits.
|
||||
- Login root becomes active and interactive.
|
||||
|
||||
## Data + Environment Strategy for Rebuild
|
||||
- Use API mode/environment that is stable for registration + verification in CI and local runs.
|
||||
- Seed/fixture verification code contract must be explicit (example: fixed debug code).
|
||||
- Generate unique username/email per test to avoid collisions.
|
||||
- If keyboard autofill overlays are flaky, centralize handling in input helper (not per-test).
|
||||
|
||||
## Migration Notes
|
||||
- Keep legacy tests disabled/removed only after each replacement test is green.
|
||||
- Track replacement mapping in PR description:
|
||||
- `old test -> new test`
|
||||
- Preserve negative assertions ("must NOT access main app before verify").
|
||||
|
||||
## Open Risks To Resolve During Rebuild
|
||||
- Registration password entry flakiness from iOS strong-password UI overlays.
|
||||
- Potential mismatch between onboarding verification screen IDs and auth verification screen IDs.
|
||||
- Environment-dependent backend behavior (local/dev) affecting registration transition.
|
||||
@@ -1,83 +0,0 @@
|
||||
# honeyDue iOS UI Testing Architecture
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
HoneyDueUITests/
|
||||
├── PageObjects/ # Screen abstractions (Page Object pattern)
|
||||
│ ├── BaseScreen.swift # Common wait/assert utilities
|
||||
│ ├── LoginScreen.swift # Login screen elements and actions
|
||||
│ ├── RegisterScreen.swift # Registration screen
|
||||
│ └── MainTabScreen.swift # Main tab navigation + settings + logout
|
||||
├── TestConfiguration/ # Launch config, environment setup
|
||||
│ └── TestLaunchConfig.swift
|
||||
├── Fixtures/ # Test data builders
|
||||
│ └── TestFixtures.swift
|
||||
├── CriticalPath/ # Must-pass tests for CI gating
|
||||
│ ├── SmokeTests.swift # Fast smoke suite (<2 min)
|
||||
│ ├── AuthCriticalPathTests.swift # Auth flow validation
|
||||
│ └── NavigationCriticalPathTests.swift # Tab + navigation validation
|
||||
├── UITestHelpers.swift # Shared login/logout/navigation helpers
|
||||
├── AccessibilityIdentifiers.swift # UI element IDs (synced with app-side copy)
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Test Suites
|
||||
|
||||
| Suite | Purpose | CI Gate | Target Time |
|
||||
|-------|---------|---------|-------------|
|
||||
| SmokeTests | App launches, basic auth, tab existence | Every PR | <2 min |
|
||||
| AuthCriticalPathTests | Login, logout, registration entry, forgot password | Every PR | <3 min |
|
||||
| NavigationCriticalPathTests | Tab navigation, settings, add buttons | Every PR | <3 min |
|
||||
|
||||
## Patterns
|
||||
|
||||
### Page Object Pattern
|
||||
Every screen has a corresponding PageObject in `PageObjects/`. Use these instead of raw XCUIElement queries in tests. Page objects encapsulate element lookups and common actions, making tests more readable and easier to maintain when the UI changes.
|
||||
|
||||
### Wait Helpers
|
||||
NEVER use `sleep()` or `Thread.sleep()`. Use `waitForElement()`, `waitForElementToDisappear()`, `waitForHittable()`, or `waitForCondition()` from BaseScreen. These are condition-based waits that return as soon as the condition is met, making tests both faster and more reliable.
|
||||
|
||||
### Test Data
|
||||
Use `TestFixtures` builders for consistent, unique test data. Random numbers and UUIDs ensure test isolation so tests can run in any order without interfering with each other.
|
||||
|
||||
### Launch Configuration
|
||||
Use `TestLaunchConfig.launchApp()` for standard launches. Use `launchAuthenticated()` to skip login when the app supports test authentication bypass. The standard configuration disables animations and forces English locale.
|
||||
|
||||
### Accessibility Identifiers
|
||||
All interactive elements must have identifiers defined in `AccessibilityIdentifiers.swift`. Use `.accessibilityIdentifier()` in SwiftUI views. Page objects reference these identifiers for element lookup. The test-side copy must stay in sync with the app-side copy at `iosApp/Helpers/AccessibilityIdentifiers.swift`.
|
||||
|
||||
## CI Configuration
|
||||
|
||||
### Critical Path (every PR)
|
||||
```bash
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests/SmokeTests \
|
||||
-only-testing:HoneyDueUITests/AuthCriticalPathTests \
|
||||
-only-testing:HoneyDueUITests/NavigationCriticalPathTests
|
||||
```
|
||||
|
||||
### Full Regression (nightly)
|
||||
```bash
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests
|
||||
```
|
||||
|
||||
## Flake Reduction
|
||||
|
||||
- Target: <2% flake rate on critical-path suite
|
||||
- All waits use condition-based predicates (zero fixed sleeps)
|
||||
- Test data uses unique identifiers to prevent cross-test interference
|
||||
- UI animations disabled via launch arguments
|
||||
- Element lookups use accessibility identifiers exclusively
|
||||
|
||||
## Adding New Tests
|
||||
|
||||
1. If the screen does not have a page object yet, create one in `PageObjects/` that extends `BaseScreen`.
|
||||
2. Define accessibility identifiers in `AccessibilityIdentifiers.swift` for any new UI elements.
|
||||
3. Sync the app-side copy of `AccessibilityIdentifiers.swift` with matching identifiers.
|
||||
4. Add test data builders to `TestFixtures.swift` if needed.
|
||||
5. Write the test in `CriticalPath/` for must-pass CI tests.
|
||||
6. Verify zero `sleep()` calls before merging.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,254 +0,0 @@
|
||||
# Task Summary Card - iOS Usage Guide
|
||||
|
||||
## Overview
|
||||
|
||||
The `TaskSummaryCard` SwiftUI component displays task statistics dynamically based on backend data. All metadata (icons, colors, display names) comes from the API.
|
||||
|
||||
## Files Created
|
||||
|
||||
1. **`Components/TaskSummaryCard.swift`** - Main component
|
||||
|
||||
**Note:** The component uses the existing `Color(hex:)` initializer from `Design/DesignSystem.swift`, so no additional files are needed.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Example 1: Show All Categories
|
||||
|
||||
In `ResidenceDetailView.swift` or `ResidencesListView.swift`:
|
||||
|
||||
```swift
|
||||
import SwiftUI
|
||||
import Shared
|
||||
|
||||
struct ResidenceDetailView: View {
|
||||
let residence: ResidenceSummary
|
||||
|
||||
var body: some View {
|
||||
ScrollView {
|
||||
VStack(spacing: 16) {
|
||||
// Residence info...
|
||||
|
||||
// Task summary with all categories
|
||||
TaskSummaryCard(taskSummary: residence.taskSummary)
|
||||
.padding(.horizontal)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example 2: Show Only Specific Categories
|
||||
|
||||
For the main residence list, show only key categories:
|
||||
|
||||
```swift
|
||||
struct ResidenceCard: View {
|
||||
let residence: ResidenceSummary
|
||||
|
||||
var body: some View {
|
||||
VStack(alignment: .leading, spacing: 12) {
|
||||
Text(residence.name)
|
||||
.font(.title2)
|
||||
.fontWeight(.bold)
|
||||
|
||||
Text(residence.streetAddress)
|
||||
.font(.subheadline)
|
||||
.foregroundColor(.secondary)
|
||||
|
||||
// Only show overdue, current, and in progress
|
||||
TaskSummaryCard(
|
||||
taskSummary: residence.taskSummary,
|
||||
visibleCategories: [
|
||||
"overdue_tasks",
|
||||
"current_tasks",
|
||||
"in_progress_tasks"
|
||||
]
|
||||
)
|
||||
}
|
||||
.padding()
|
||||
.background(Color(.systemBackground))
|
||||
.cornerRadius(12)
|
||||
.shadow(radius: 2)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example 3: In Home Screen
|
||||
|
||||
```swift
|
||||
struct HomeScreenView: View {
|
||||
@StateObject private var viewModel = ResidenceViewModel()
|
||||
|
||||
var body: some View {
|
||||
ScrollView {
|
||||
VStack(spacing: 20) {
|
||||
ForEach(viewModel.residences, id: \.id) { residence in
|
||||
VStack(alignment: .leading, spacing: 12) {
|
||||
NavigationLink(destination: ResidenceDetailView(residence: residence)) {
|
||||
VStack(alignment: .leading) {
|
||||
Text(residence.name)
|
||||
.font(.headline)
|
||||
|
||||
// Show task summary for quick overview
|
||||
TaskSummaryCard(
|
||||
taskSummary: residence.taskSummary,
|
||||
visibleCategories: ["overdue_tasks", "current_tasks"]
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
.padding()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Available Categories
|
||||
|
||||
The backend provides these categories (can filter with `visibleCategories`):
|
||||
|
||||
1. **overdue_tasks** - Red (#FF3B30) - `exclamationmark.triangle`
|
||||
2. **current_tasks** - Blue (#007AFF) - `calendar`
|
||||
3. **in_progress_tasks** - Orange (#FF9500) - `play.circle`
|
||||
4. **backlog_tasks** - Purple (#5856D6) - `tray`
|
||||
5. **done_tasks** - Green (#34C759) - `checkmark.circle`
|
||||
6. **archived_tasks** - Gray (#8E8E93) - `archivebox`
|
||||
|
||||
## Customization
|
||||
|
||||
### Custom Styling
|
||||
|
||||
```swift
|
||||
TaskSummaryCard(taskSummary: taskSummary)
|
||||
.padding()
|
||||
.background(Color(.secondarySystemBackground))
|
||||
.cornerRadius(16)
|
||||
.shadow(color: Color.black.opacity(0.2), radius: 8, x: 0, y: 4)
|
||||
```
|
||||
|
||||
### Filter Specific Categories
|
||||
|
||||
```swift
|
||||
// Show only active tasks
|
||||
TaskSummaryCard(
|
||||
taskSummary: taskSummary,
|
||||
visibleCategories: [
|
||||
"overdue_tasks",
|
||||
"current_tasks",
|
||||
"in_progress_tasks",
|
||||
"backlog_tasks"
|
||||
]
|
||||
)
|
||||
```
|
||||
|
||||
### Access Individual Category Counts
|
||||
|
||||
If you need to access counts programmatically:
|
||||
|
||||
```swift
|
||||
extension TaskSummary {
|
||||
func categoryCount(for name: String) -> Int {
|
||||
categories.first { $0.name == name }?.count ?? 0
|
||||
}
|
||||
}
|
||||
|
||||
// Usage:
|
||||
let overdueCount = taskSummary.categoryCount(for: "overdue_tasks")
|
||||
```
|
||||
|
||||
## Component Features
|
||||
|
||||
✅ **Dynamic Icons** - Uses SF Symbols from backend (e.g., `calendar`, `exclamationmark.triangle`)
|
||||
✅ **Dynamic Colors** - Parses hex colors from backend
|
||||
✅ **Flexible Filtering** - Show only categories you need
|
||||
✅ **Live Preview** - Includes SwiftUI preview with mock data
|
||||
✅ **Responsive** - Adapts to different screen sizes
|
||||
✅ **Native Look** - Uses iOS design patterns and typography
|
||||
|
||||
## Preview
|
||||
|
||||
The component includes a preview for development. In Xcode:
|
||||
|
||||
1. Open `Components/TaskSummaryCard.swift`
|
||||
2. Click "Resume" in the preview canvas
|
||||
3. See both "all categories" and "filtered" versions
|
||||
|
||||
## Integration Example
|
||||
|
||||
Here's a complete example for ResidenceDetailView:
|
||||
|
||||
```swift
|
||||
import SwiftUI
|
||||
import Shared
|
||||
|
||||
struct ResidenceDetailView: View {
|
||||
let residence: ResidenceSummary
|
||||
@State private var showingManageUsers = false
|
||||
@State private var showingTasks = false
|
||||
|
||||
var body: some View {
|
||||
ScrollView {
|
||||
VStack(alignment: .leading, spacing: 20) {
|
||||
// Header
|
||||
VStack(alignment: .leading, spacing: 8) {
|
||||
Text(residence.name)
|
||||
.font(.title)
|
||||
.fontWeight(.bold)
|
||||
|
||||
Text(residence.streetAddress)
|
||||
.font(.subheadline)
|
||||
.foregroundColor(.secondary)
|
||||
}
|
||||
.padding(.horizontal)
|
||||
|
||||
// Task Summary Card
|
||||
TaskSummaryCard(
|
||||
taskSummary: residence.taskSummary,
|
||||
visibleCategories: [
|
||||
"overdue_tasks",
|
||||
"current_tasks",
|
||||
"in_progress_tasks"
|
||||
]
|
||||
)
|
||||
.padding(.horizontal)
|
||||
.onTapGesture {
|
||||
showingTasks = true
|
||||
}
|
||||
|
||||
// Other residence details...
|
||||
}
|
||||
.padding(.vertical)
|
||||
}
|
||||
.navigationTitle("Residence Details")
|
||||
.navigationBarTitleDisplayMode(.inline)
|
||||
.sheet(isPresented: $showingTasks) {
|
||||
TasksView(residenceId: residence.id)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
✅ **Backend-Driven** - All icons, colors, names from API
|
||||
✅ **Single Source of Truth** - Change in `task/constants.py` updates everywhere
|
||||
✅ **Type-Safe** - Full Swift type safety with Shared models
|
||||
✅ **Reusable** - Use in any view that has TaskSummary
|
||||
✅ **Consistent** - Matches Android implementation
|
||||
✅ **Maintainable** - No hardcoded values
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Colors not showing correctly
|
||||
Make sure `Extensions/Color+Hex.swift` is included in your target.
|
||||
|
||||
### Icons not appearing
|
||||
The component uses SF Symbols. Ensure the icon names from backend are valid SF Symbol names.
|
||||
|
||||
### Type errors
|
||||
Make sure you're importing `Shared` module which contains the TaskSummary models.
|
||||
|
||||
### Preview not working
|
||||
The preview uses mock data. If you get compiler errors, make sure all model types are properly imported.
|
||||
@@ -1,316 +0,0 @@
|
||||
# UI Test Failures Analysis
|
||||
|
||||
## Status: Tests are failing as expected ✅
|
||||
|
||||
The UI tests you're seeing fail are **failing for the right reason** - they cannot find the UI elements because **accessibility identifiers haven't been added to the views yet**.
|
||||
|
||||
## What We've Completed
|
||||
|
||||
1. ✅ **Created comprehensive test suite** (34 tests)
|
||||
- ComprehensiveAuthenticationTests.swift (11 tests)
|
||||
- ComprehensiveResidenceTests.swift (10 tests)
|
||||
- ComprehensiveTaskTests.swift (13 tests)
|
||||
|
||||
2. ✅ **Created centralized AccessibilityIdentifiers.swift**
|
||||
- All identifiers defined and organized by feature
|
||||
- Fixed duplicate identifier issues
|
||||
- Ready to be used in views
|
||||
|
||||
3. ✅ **Fixed test compilation issues**
|
||||
- Added `@testable import HoneyDue` to all test files
|
||||
- Fixed ambiguous type references
|
||||
- Tests compile successfully
|
||||
|
||||
4. ✅ **Created comprehensive documentation**
|
||||
- XCUITEST_IMPLEMENTATION_GUIDE.md
|
||||
- XCUITEST_IMPLEMENTATION_SUMMARY.md
|
||||
- ACCESSIBILITY_IDENTIFIERS_FIX.md
|
||||
- FIX_TEST_TARGET.md
|
||||
|
||||
## What Still Needs to Be Done
|
||||
|
||||
### Critical: Add Accessibility Identifiers to Views
|
||||
|
||||
The tests are **correctly written** but will fail until you add the accessibility identifiers to the actual SwiftUI views. Here's what needs to be done:
|
||||
|
||||
### High Priority Views (Required for tests to pass)
|
||||
|
||||
#### 1. Authentication Views
|
||||
**File**: `iosApp/Login/LoginView.swift`
|
||||
```swift
|
||||
TextField("Enter your email", text: $viewModel.username)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
|
||||
SecureField("Password", text: $viewModel.password)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.passwordField)
|
||||
|
||||
Button("Login") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.loginButton)
|
||||
|
||||
Button("Sign Up") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.signUpButton)
|
||||
```
|
||||
|
||||
**File**: `iosApp/Register/RegisterView.swift`
|
||||
```swift
|
||||
TextField("Username", text: $username)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerUsernameField)
|
||||
|
||||
TextField("Email", text: $email)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerEmailField)
|
||||
|
||||
SecureField("Password", text: $password)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerPasswordField)
|
||||
|
||||
SecureField("Confirm Password", text: $confirmPassword)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerConfirmPasswordField)
|
||||
|
||||
Button("Register") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerButton)
|
||||
```
|
||||
|
||||
#### 2. Navigation (Tab Bar)
|
||||
**File**: `iosApp/MainTabView.swift`
|
||||
```swift
|
||||
.tabItem {
|
||||
Label("Residences", systemImage: "house.fill")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.residencesTab)
|
||||
|
||||
.tabItem {
|
||||
Label("Tasks", systemImage: "checklist")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.tasksTab)
|
||||
|
||||
.tabItem {
|
||||
Label("Contractors", systemImage: "person.2.fill")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.contractorsTab)
|
||||
|
||||
.tabItem {
|
||||
Label("Documents", systemImage: "doc.fill")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.documentsTab)
|
||||
|
||||
.tabItem {
|
||||
Label("Profile", systemImage: "person.fill")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.profileTab)
|
||||
```
|
||||
|
||||
#### 3. Residence Views
|
||||
**File**: `iosApp/Residence/ResidencesView.swift`
|
||||
```swift
|
||||
Button { showingAddForm = true } label: {
|
||||
Label("Add Property", systemImage: "plus")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.addButton)
|
||||
```
|
||||
|
||||
**File**: `iosApp/Residence/ResidenceFormView.swift`
|
||||
```swift
|
||||
TextField("Property Name", text: $name)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.nameField)
|
||||
|
||||
Picker("Property Type", selection: $propertyType) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.propertyTypePicker)
|
||||
|
||||
TextField("Street Address", text: $streetAddress)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.streetAddressField)
|
||||
|
||||
TextField("City", text: $city)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.cityField)
|
||||
|
||||
TextField("State/Province", text: $stateProvince)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.stateProvinceField)
|
||||
|
||||
TextField("Postal Code", text: $postalCode)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.postalCodeField)
|
||||
|
||||
TextField("Country", text: $country)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.countryField)
|
||||
|
||||
TextField("Bedrooms", text: $bedrooms)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.bedroomsField)
|
||||
|
||||
TextField("Bathrooms", text: $bathrooms)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.bathroomsField)
|
||||
|
||||
Button("Save") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.saveButton)
|
||||
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.formCancelButton)
|
||||
```
|
||||
|
||||
**File**: `iosApp/Residence/ResidenceDetailView.swift`
|
||||
```swift
|
||||
Button("Edit") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.editButton)
|
||||
|
||||
Button("Delete") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.deleteButton)
|
||||
```
|
||||
|
||||
#### 4. Task Views
|
||||
**File**: `iosApp/Task/TasksView.swift`
|
||||
```swift
|
||||
Button { showingAddForm = true } label: {
|
||||
Label("Add Task", systemImage: "plus")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.addButton)
|
||||
```
|
||||
|
||||
**File**: `iosApp/Task/TaskFormView.swift`
|
||||
```swift
|
||||
TextField("Task Title", text: $title)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.titleField)
|
||||
|
||||
TextEditor(text: $description)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.descriptionField)
|
||||
|
||||
Picker("Category", selection: $category) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.categoryPicker)
|
||||
|
||||
Picker("Priority", selection: $priority) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.priorityPicker)
|
||||
|
||||
Picker("Status", selection: $status) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.statusPicker)
|
||||
|
||||
DatePicker("Due Date", selection: $dueDate)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.dueDatePicker)
|
||||
|
||||
Button("Save") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.saveButton)
|
||||
|
||||
Button("Cancel") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.formCancelButton)
|
||||
```
|
||||
|
||||
#### 5. Profile/Logout
|
||||
**File**: `iosApp/Profile/ProfileView.swift`
|
||||
```swift
|
||||
Button("Logout") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Profile.logoutButton)
|
||||
```
|
||||
|
||||
#### 6. Alert Buttons
|
||||
In any confirmation dialogs:
|
||||
```swift
|
||||
.alert("Delete Residence?", isPresented: $showingDeleteAlert) {
|
||||
Button("Delete", role: .destructive) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Alert.deleteButton)
|
||||
|
||||
Button("Cancel", role: .cancel) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Alert.cancelButton)
|
||||
}
|
||||
```
|
||||
|
||||
## Quick Start: Add Identifiers to Critical Paths
|
||||
|
||||
To get the tests passing, start with these files **in order**:
|
||||
|
||||
1. **LoginView.swift** - username, password, login button
|
||||
2. **RegisterView.swift** - all registration fields
|
||||
3. **MainTabView.swift** - tab bar items
|
||||
4. **ResidencesView.swift** - add button
|
||||
5. **ResidenceFormView.swift** - all form fields
|
||||
6. **TaskFormView.swift** - all form fields
|
||||
7. **ProfileView.swift** - logout button
|
||||
|
||||
## How to Add Identifiers (Quick Reference)
|
||||
|
||||
For any UI element in SwiftUI, add:
|
||||
```swift
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.FeatureArea.elementName)
|
||||
```
|
||||
|
||||
**Examples:**
|
||||
```swift
|
||||
// Text field
|
||||
TextField("Email", text: $email)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
|
||||
// Button
|
||||
Button("Save") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.saveButton)
|
||||
|
||||
// Picker
|
||||
Picker("Type", selection: $type) { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.propertyTypePicker)
|
||||
|
||||
// Tab item
|
||||
.tabItem { Label("Tasks", systemImage: "checklist") }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.tasksTab)
|
||||
```
|
||||
|
||||
## Verifying Identifiers Are Working
|
||||
|
||||
After adding identifiers to a view, you can verify they're accessible:
|
||||
|
||||
1. **Run the app in Simulator**
|
||||
2. **Open Accessibility Inspector** (Xcode → Open Developer Tool → Accessibility Inspector)
|
||||
3. **Select the Simulator** in the Accessibility Inspector
|
||||
4. **Hover over elements** to see if the identifier appears
|
||||
|
||||
Or just run the specific test:
|
||||
```bash
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueTests/ComprehensiveAuthenticationTests/testLoginWithValidCredentials
|
||||
```
|
||||
|
||||
## Why Tests Are Failing Now
|
||||
|
||||
The tests look for elements like this:
|
||||
```swift
|
||||
let usernameField = app.textFields[AccessibilityIdentifiers.Authentication.usernameField]
|
||||
XCTAssertTrue(usernameField.exists) // ❌ FAILS - element not found
|
||||
```
|
||||
|
||||
This fails because the actual `TextField` in `LoginView.swift` doesn't have:
|
||||
```swift
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
```
|
||||
|
||||
Once you add the identifier, the test will find it:
|
||||
```swift
|
||||
let usernameField = app.textFields[AccessibilityIdentifiers.Authentication.usernameField]
|
||||
XCTAssertTrue(usernameField.exists) // ✅ PASSES - element found!
|
||||
```
|
||||
|
||||
## Expected Timeline
|
||||
|
||||
- **Adding identifiers to 1 view file**: 2-5 minutes
|
||||
- **Getting first test passing** (login): 10-15 minutes
|
||||
- **Getting auth tests passing**: 30-45 minutes
|
||||
- **Getting all critical tests passing**: 2-3 hours
|
||||
- **Complete implementation** (all 30+ files): 6-8 hours
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Start with LoginView.swift** - add the 4 critical identifiers (username, password, login, signUp)
|
||||
2. **Run testLoginWithValidCredentials** - verify it finds the elements
|
||||
3. **Add RegisterView.swift identifiers** - all registration fields
|
||||
4. **Run testUserRegistrationComplete** - verify registration flow
|
||||
5. **Continue systematically** through the view files
|
||||
|
||||
## Files That Need Identifiers (Complete List)
|
||||
|
||||
See `XCUITEST_IMPLEMENTATION_GUIDE.md` section "Views That Need Accessibility Identifiers" for the complete checklist of 30+ view files.
|
||||
|
||||
## Getting Help
|
||||
|
||||
If tests still fail after adding identifiers:
|
||||
|
||||
1. **Check spelling** - identifier names must match exactly
|
||||
2. **Check scope** - make sure you're using the right struct (e.g., `Authentication.loginButton` not `Login.loginButton`)
|
||||
3. **Check element type** - textFields vs secureTextFields vs buttons
|
||||
4. **Run Accessibility Inspector** - verify the identifier is actually set
|
||||
|
||||
---
|
||||
|
||||
**Bottom Line**: The test infrastructure is complete and working correctly. Tests fail because views need accessibility identifiers. Once you add identifiers to views, tests will pass. Start with LoginView.swift and work through the critical path.
|
||||
@@ -1,236 +0,0 @@
|
||||
# HoneyDue iOS UI Tests
|
||||
|
||||
## ✅ Status: WORKING
|
||||
|
||||
All UI tests have been rewritten using a working, verified pattern. Tests are organized by feature and use flexible selectors for stability.
|
||||
|
||||
## 📁 Test Files
|
||||
|
||||
### SimpleLoginTest.swift (2 tests)
|
||||
Foundation tests that verify basic app functionality:
|
||||
- `testAppLaunchesAndShowsLoginScreen()` - App launches and login UI appears
|
||||
- `testCanTypeInLoginFields()` - User can interact with login form
|
||||
|
||||
### AuthenticationTests.swift (6 tests)
|
||||
Authentication and user session management:
|
||||
- `testLoginWithValidCredentials()` - Successful login flow
|
||||
- `testLoginWithInvalidCredentials()` - Error handling for bad credentials
|
||||
- `testPasswordVisibilityToggle()` - Password show/hide functionality
|
||||
- `testNavigationToSignUp()` - Navigate to registration screen
|
||||
- `testForgotPasswordNavigation()` - Navigate to password reset
|
||||
- `testLogout()` - Complete logout flow
|
||||
|
||||
### ResidenceTests.swift (6 tests)
|
||||
Property/residence management:
|
||||
- `testViewResidencesList()` - View residences or empty state
|
||||
- `testNavigateToAddResidence()` - Open add residence form and verify all required fields
|
||||
- `testCreateResidenceWithMinimalData()` - Create new property with required fields (includes property type selection)
|
||||
- `testCancelResidenceCreation()` - Cancel form without saving
|
||||
- `testViewResidenceDetails()` - View property details
|
||||
- `testNavigationBetweenTabs()` - Tab navigation works
|
||||
|
||||
### TaskTests.swift (7 tests)
|
||||
Task management functionality:
|
||||
- `testViewTasksList()` - View tasks or empty state
|
||||
- `testNavigateToAddTask()` - Open add task form
|
||||
- `testCreateBasicTask()` - Create new task
|
||||
- `testCancelTaskCreation()` - Cancel form without saving
|
||||
- `testViewTaskDetails()` - View task details
|
||||
- `testNavigateToContractors()` - Navigate to contractors tab
|
||||
- `testNavigateToDocuments()` - Navigate to documents tab
|
||||
|
||||
## 🎯 Test Design Principles
|
||||
|
||||
### 1. Logout/Login Before Tests
|
||||
- **SimpleLoginTest** and **AuthenticationTests**: Start logged out (call `ensureLoggedOut()`)
|
||||
- **ResidenceTests** and **TaskTests**: Start logged in (call `ensureLoggedIn()`)
|
||||
|
||||
### 2. Flexible Selectors
|
||||
Tests use `NSPredicate` with `CONTAINS[c]` for case-insensitive partial matches:
|
||||
```swift
|
||||
// ❌ Fragile (breaks if text changes)
|
||||
app.buttons["Sign In"]
|
||||
|
||||
// ✅ Robust (works with variations)
|
||||
app.buttons.containing(NSPredicate(format: "label CONTAINS[c] 'Sign In'")).firstMatch
|
||||
```
|
||||
|
||||
### 3. Proper Waits
|
||||
Uses `waitForExistence(timeout:)` instead of `sleep()` where possible:
|
||||
```swift
|
||||
XCTAssertTrue(element.waitForExistence(timeout: 10), "Element should appear")
|
||||
```
|
||||
|
||||
### 4. Test Independence
|
||||
- Each test creates unique data using timestamps
|
||||
- Tests don't depend on execution order
|
||||
- Cleanup happens automatically via `tearDown()`
|
||||
|
||||
### 5. No Graceful Passes - Tests Must Fail When They Should
|
||||
Tests are designed to FAIL when prerequisites aren't met, not pass gracefully:
|
||||
```swift
|
||||
// ❌ WRONG - Graceful pass (always passes)
|
||||
if !addButton.exists {
|
||||
XCTAssertTrue(true, "Skipping - requires residence")
|
||||
return
|
||||
}
|
||||
|
||||
// ✅ CORRECT - Meaningful failure
|
||||
let addButton = app.buttons["Task.AddButton"]
|
||||
XCTAssertTrue(addButton.waitForExistence(timeout: 5),
|
||||
"Add task button must exist - create a residence first via ResidenceTests.testCreateResidenceWithMinimalData")
|
||||
```
|
||||
|
||||
## 🚀 Running Tests
|
||||
|
||||
### In Xcode (Recommended)
|
||||
1. Open `iosApp.xcodeproj`
|
||||
2. Select **HoneyDueUITests** scheme
|
||||
3. Press `Cmd+U` to run all tests
|
||||
4. Or click diamond icon next to individual test to run just that one
|
||||
|
||||
### Command Line
|
||||
```bash
|
||||
# Run all UI tests
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme HoneyDueUITests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17'
|
||||
|
||||
# Run specific test file
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme HoneyDueUITests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests/AuthenticationTests
|
||||
|
||||
# Run specific test
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme HoneyDueUITests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests/AuthenticationTests/testLoginWithValidCredentials
|
||||
```
|
||||
|
||||
## 📝 Test Credentials
|
||||
|
||||
Tests use these credentials (must exist in your test environment):
|
||||
- **Username**: `testuser`
|
||||
- **Password**: `TestPass123!`
|
||||
|
||||
Make sure this user exists in your backend before running tests.
|
||||
|
||||
## ✍️ Writing New Tests
|
||||
|
||||
### Pattern to Follow
|
||||
|
||||
```swift
|
||||
import XCTest
|
||||
|
||||
final class YourTests: XCTestCase {
|
||||
var app: XCUIApplication!
|
||||
|
||||
override func setUpWithError() throws {
|
||||
continueAfterFailure = false
|
||||
app = XCUIApplication()
|
||||
app.launch()
|
||||
|
||||
// Choose one:
|
||||
ensureLoggedOut() // For login/auth tests
|
||||
ensureLoggedIn() // For feature tests
|
||||
}
|
||||
|
||||
override func tearDownWithError() throws {
|
||||
app = nil
|
||||
}
|
||||
|
||||
// Copy helper methods from existing tests
|
||||
|
||||
func testYourFeature() {
|
||||
// Given: Setup state
|
||||
|
||||
// When: User action
|
||||
|
||||
// Then: Verify result
|
||||
XCTAssertTrue(condition, "Descriptive error message")
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Finding Elements
|
||||
|
||||
```swift
|
||||
// Text fields
|
||||
app.textFields.containing(NSPredicate(format: "placeholderValue CONTAINS[c] 'keyword'")).firstMatch
|
||||
|
||||
// Buttons
|
||||
app.buttons.containing(NSPredicate(format: "label CONTAINS[c] 'keyword'")).firstMatch
|
||||
|
||||
// Static text
|
||||
app.staticTexts.containing(NSPredicate(format: "label CONTAINS[c] 'keyword'")).firstMatch
|
||||
|
||||
// Tab bar buttons
|
||||
app.tabBars.buttons.containing(NSPredicate(format: "label CONTAINS[c] 'keyword'")).firstMatch
|
||||
```
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Test Fails: "Element not found"
|
||||
- Add `sleep(2)` before checking for element
|
||||
- Increase timeout: `element.waitForExistence(timeout: 10)`
|
||||
- Check if element actually exists in that state
|
||||
- Use `app.debugDescription` to see all visible elements
|
||||
|
||||
### Test Fails: "Already logged in/out"
|
||||
- Ensure `setUp()` calls correct helper (`ensureLoggedIn()` or `ensureLoggedOut()`)
|
||||
- Check that logout/login logic is working
|
||||
|
||||
### Test Fails: "Residence/Task required"
|
||||
- Some tests need data to exist first (e.g., testViewResidenceDetails requires testCreateResidenceWithMinimalData to run first)
|
||||
- Tests will FAIL with meaningful error messages if prerequisites aren't met
|
||||
- Error messages indicate which test needs to run first or what data is required
|
||||
- Run tests in order or run the prerequisite test first
|
||||
|
||||
## 📊 Test Summary
|
||||
|
||||
| Test File | Tests | Focus |
|
||||
|-----------|-------|-------|
|
||||
| SimpleLoginTest | 2 | Foundation |
|
||||
| AuthenticationTests | 6 | Login/Logout |
|
||||
| ResidenceTests | 6 | Property Management |
|
||||
| TaskTests | 7 | Task Management |
|
||||
| **Total** | **21** | **Core Flows** |
|
||||
|
||||
## 🎉 Success!
|
||||
|
||||
These tests are:
|
||||
- ✅ Actually working (verified)
|
||||
- ✅ Based on SimpleLoginTest pattern that passed
|
||||
- ✅ Using flexible selectors
|
||||
- ✅ Following best practices
|
||||
- ✅ Well-documented
|
||||
- ✅ Independent and repeatable
|
||||
- ✅ **NO GRACEFUL PASSES** - Tests fail meaningfully when they should
|
||||
|
||||
## 📋 Recent Changes (2025-11-19)
|
||||
|
||||
**Removed All Graceful Passes:**
|
||||
- ✅ ResidenceTests: Removed graceful passes from `testViewResidencesList`, `testViewResidenceDetails`
|
||||
- ✅ TaskTests: Removed graceful passes from `testNavigateToAddTask`, `testCreateBasicTask`, `testCancelTaskCreation`, `testViewTaskDetails`
|
||||
- ✅ AuthenticationTests: Removed graceful pass from `testPasswordVisibilityToggle`
|
||||
|
||||
**Philosophy Change:**
|
||||
- Tests now FAIL with meaningful error messages when prerequisites aren't met
|
||||
- No more `XCTAssertTrue(true, "Skipping...")` patterns
|
||||
- Error messages indicate exactly what's needed (e.g., "create a residence first via ResidenceTests.testCreateResidenceWithMinimalData")
|
||||
|
||||
**App Architecture Fix:**
|
||||
- ✅ Created `RootView.swift` with `AuthenticationManager` singleton
|
||||
- ✅ App now checks for token on launch and routes accordingly (MainTabView if authenticated, LoginView if not)
|
||||
- ✅ No more flash of login screen when user is already authenticated
|
||||
- ✅ Tests now start from correct state (logged in or logged out)
|
||||
- ✅ Fixed `ensureLoggedOut()` to properly assert logout succeeded
|
||||
- ✅ Fixed logout flow: `LoginViewModel.logout()` now calls `AuthenticationManager.shared.logout()`
|
||||
- ✅ Removed `showMainTab` state variable - navigation now handled by `AuthenticationManager.isAuthenticated`
|
||||
- ✅ LoginView accepts `onLoginSuccess` callback that notifies AuthenticationManager
|
||||
- ✅ Logout properly returns to login screen without crashes
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-11-19
|
||||
**Author**: Claude Code
|
||||
**Status**: ✅ All tests working and fail meaningfully
|
||||
@@ -1,300 +0,0 @@
|
||||
# HoneyDue iOS UI Tests - Complete Rewrite Summary
|
||||
|
||||
## ✅ Status: BUILD SUCCEEDED
|
||||
|
||||
All UI tests have been completely rewritten from scratch with comprehensive edge case coverage as requested.
|
||||
|
||||
## 📊 Test Files Created/Updated
|
||||
|
||||
### 1. **ComprehensiveAuthenticationTests.swift** (558 lines)
|
||||
**Tests: 20**
|
||||
- ✅ testUserRegistrationComplete
|
||||
- ✅ testRegistrationWithExistingUsername
|
||||
- ✅ testRegistrationWithInvalidEmail
|
||||
- ✅ testRegistrationWithMismatchedPasswords
|
||||
- ✅ testRegistrationWithEmptyFields
|
||||
- ✅ testRegistrationWithWeakPassword
|
||||
- ✅ testLoginWithValidCredentials
|
||||
- ✅ testLoginWithInvalidCredentials
|
||||
- ✅ testLoginWithEmptyUsername
|
||||
- ✅ testLoginWithEmptyPassword
|
||||
- ✅ testLoginWithEmptyFields
|
||||
- ✅ testPasswordVisibilityToggle
|
||||
- ✅ testLogout
|
||||
- ✅ testLogoutClearsSession
|
||||
- ✅ testForgotPasswordFlow
|
||||
- ✅ testForgotPasswordWithValidEmail
|
||||
- ✅ testNavigationBetweenLoginAndRegister
|
||||
- ✅ testSessionPersistsAcrossAppRelaunch
|
||||
|
||||
**Edge Cases Covered:**
|
||||
- Empty field validation
|
||||
- Invalid email formats
|
||||
- Password mismatch scenarios
|
||||
- Weak password validation
|
||||
- Invalid credentials handling
|
||||
- Session persistence
|
||||
- Navigation flows
|
||||
|
||||
### 2. **ComprehensiveResidenceTests.swift** (721 lines)
|
||||
**Tests: 15**
|
||||
- ✅ testCreateResidenceComplete
|
||||
- ✅ testCreateResidenceWithMinimalData
|
||||
- ✅ testCreateResidenceWithAllOptionalFields
|
||||
- ✅ testCreateResidenceValidationRequired
|
||||
- ✅ testCreateResidenceValidationMissingAddress
|
||||
- ✅ testCreateResidenceCancellation
|
||||
- ✅ testViewResidenceDetails
|
||||
- ✅ testResidenceDetailShowsAllInfo
|
||||
- ✅ testResidenceDetailShowsTasksSection
|
||||
- ✅ testEditResidence
|
||||
- ✅ testEditResidenceCancel
|
||||
- ✅ testEditResidenceChangeAddress
|
||||
- ✅ testDeleteResidence
|
||||
- ✅ testDeleteResidenceCancellation
|
||||
- ✅ testEmptyStateDisplayIfNoResidences
|
||||
|
||||
**Edge Cases Covered:**
|
||||
- Complete vs minimal data entry
|
||||
- All optional fields populated
|
||||
- Required field validation
|
||||
- Missing address validation
|
||||
- Form cancellation
|
||||
- Edit cancellation
|
||||
- Delete confirmation/cancellation
|
||||
- Empty state handling
|
||||
- Unique timestamped data
|
||||
|
||||
### 3. **ComprehensiveTaskTests.swift** (708 lines)
|
||||
**Tests: 16**
|
||||
- ✅ testCreateOneTimeTaskComplete
|
||||
- ✅ testCreateTaskWithMinimalData
|
||||
- ✅ testCreateRecurringTask
|
||||
- ✅ testCreateTaskWithAllFields
|
||||
- ✅ testCreateTaskValidation
|
||||
- ✅ testCreateTaskCancellation
|
||||
- ✅ testMarkTaskInProgress
|
||||
- ✅ testCompleteTask
|
||||
- ✅ testCompleteTaskWithMinimalInfo
|
||||
- ✅ testEditTask
|
||||
- ✅ testEditTaskCancel
|
||||
- ✅ testDeleteTask
|
||||
- ✅ testDeleteTaskCancellation
|
||||
- ✅ testKanbanViewDisplaysColumns
|
||||
- ✅ testNavigateToTaskFromKanban
|
||||
- ✅ testFilterTasksByResidence
|
||||
|
||||
**Edge Cases Covered:**
|
||||
- One-time vs recurring tasks
|
||||
- Minimal vs complete data
|
||||
- Task status transitions
|
||||
- Completion with/without details
|
||||
- Edit cancellation
|
||||
- Delete confirmation/cancellation
|
||||
- Kanban column display
|
||||
- Residence filtering
|
||||
|
||||
### 4. **TestHelpers.swift** (452 lines)
|
||||
**Comprehensive Helper Methods:**
|
||||
|
||||
#### Authentication Helpers
|
||||
- `login(username:password:)` - Performs login with validation
|
||||
- `logout()` - Performs logout with screen verification
|
||||
|
||||
#### Navigation Helpers
|
||||
- `navigateToTab(_:)` - Smart tab navigation with flexible naming
|
||||
- `navigateBack()` - Back button navigation
|
||||
|
||||
#### Assertion Helpers
|
||||
- `assertElementExists(_:timeout:message:)`
|
||||
- `assertElementDoesNotExist(_:timeout:message:)`
|
||||
- `assertNavigatedTo(title:timeout:)`
|
||||
- `assertTextExists(_:timeout:)`
|
||||
- `assertTextDoesNotExist(_:timeout:)`
|
||||
|
||||
#### Wait Helpers (Robust XCTest Expectations)
|
||||
- `wait(seconds:)` - Simple delay
|
||||
- `waitForElementToAppear(_:timeout:)` - Predicate-based wait
|
||||
- `waitForElementToDisappear(_:timeout:)` - Predicate-based wait
|
||||
- `waitForElementToBeHittable(_:timeout:)` - Hittable predicate
|
||||
- `waitForElementValue(_:value:timeout:)` - Value predicate
|
||||
- `waitForAnyElement(_:timeout:)` - First match from array
|
||||
- `waitForLoadingToComplete(timeout:)` - Loading indicator wait
|
||||
|
||||
#### Interaction Helpers
|
||||
- `scrollToElement(_:maxAttempts:)` - Auto-scroll to make hittable
|
||||
- `scrollDownToFind(_:maxAttempts:)` - Scroll down search
|
||||
- `scrollUpToFind(_:maxAttempts:)` - Scroll up search
|
||||
- `clearTextField(_:)` - Robust text clearing
|
||||
- `typeTextSlowly(_:into:delay:)` - Slow typing for problematic fields
|
||||
- `tapWithRetry(_:maxAttempts:)` - Retry tapping
|
||||
- `dismissKeyboard()` - Return key dismiss
|
||||
- `dismissKeyboardByTappingOutside()` - Tap outside dismiss
|
||||
|
||||
#### Picker Helpers
|
||||
- `selectPickerValue(_:value:)` - Wheel or menu picker
|
||||
- `selectDate(_:year:month:day:)` - Date picker
|
||||
|
||||
#### Alert Helpers
|
||||
- `dismissAlert(timeout:)` - OK button
|
||||
- `confirmAlert(timeout:)` - Confirm button
|
||||
- `cancelAlert(timeout:)` - Cancel button
|
||||
|
||||
#### Query Helpers
|
||||
- `findElementByPartialText(_:elementType:)` - Flexible text search
|
||||
- `findElements(matching:elementType:)` - Predicate search
|
||||
- `hasErrorMessage()` - Error detection
|
||||
- `isLoading()` - Loading indicator check
|
||||
|
||||
#### Debugging Helpers
|
||||
- `printVisibleElements()` - Debug element dump
|
||||
- `printElementHierarchy()` - Debug hierarchy
|
||||
- `takeScreenshot(named:)` - Named screenshots
|
||||
|
||||
### 5. **AccessibilityIdentifiers.swift** (213 lines)
|
||||
Copied to HoneyDueUITests folder for UI test access without `@testable import`.
|
||||
|
||||
### 6. **HoneyDueUITests.swift & HoneyDueUITestsLaunchTests.swift**
|
||||
Updated to remove `@testable import HoneyDue` (UI tests run in separate process).
|
||||
|
||||
## 🗑️ Removed Files
|
||||
- AuthenticationUITests.swift (old, had @testable import)
|
||||
- TaskUITests.swift (old, had @testable import)
|
||||
- ResidenceUITests.swift (old, had @testable import)
|
||||
- MultiUserUITests.swift (old, had @testable import)
|
||||
- DebugLoginTest.swift (old, had @testable import)
|
||||
|
||||
## ✨ Key Improvements
|
||||
|
||||
### 1. No `@testable import` Required
|
||||
All tests run in their own process without accessing app internals, following proper UI testing practices.
|
||||
|
||||
### 2. Comprehensive Edge Case Coverage
|
||||
Every test includes:
|
||||
- ✅ Positive scenarios (happy path)
|
||||
- ✅ Negative scenarios (error cases)
|
||||
- ✅ Validation scenarios (empty fields, invalid data)
|
||||
- ✅ Cancellation scenarios (user changes mind)
|
||||
- ✅ Boundary scenarios (minimal vs maximal data)
|
||||
|
||||
### 3. Robust Wait Functions
|
||||
- Uses XCTest NSPredicate expectations instead of simple sleeps
|
||||
- Configurable timeouts
|
||||
- Proper element state verification (exists, hittable, value)
|
||||
|
||||
### 4. Better Error Messages
|
||||
All assertions include descriptive failure messages for easier debugging.
|
||||
|
||||
### 5. Reusable Helper Methods
|
||||
Common operations extracted into TestHelpers base class to avoid duplication.
|
||||
|
||||
### 6. Flexible Element Finding
|
||||
Tests use NSPredicate with case-insensitive contains to handle text variations.
|
||||
|
||||
### 7. Proper Test Isolation
|
||||
Each test:
|
||||
- Creates its own unique test data (using timestamps)
|
||||
- Manages its own setup/teardown
|
||||
- Doesn't depend on other tests
|
||||
- Cleans up after itself
|
||||
|
||||
### 8. Given-When-Then Pattern
|
||||
All tests follow clear structure:
|
||||
```swift
|
||||
// Given: Initial state setup
|
||||
// When: User action
|
||||
// Then: Expected outcome verification
|
||||
// And: Additional verifications
|
||||
```
|
||||
|
||||
## 📈 Test Coverage Summary
|
||||
|
||||
| Category | Tests | Edge Cases |
|
||||
|----------|-------|------------|
|
||||
| Authentication | 20 | Registration errors, login errors, session management |
|
||||
| Residence Management | 15 | CRUD operations, validation, empty states |
|
||||
| Task Management | 16 | Task types, status transitions, kanban views |
|
||||
| **Total** | **51** | **Comprehensive coverage** |
|
||||
|
||||
## 🚀 Build Status
|
||||
|
||||
```
|
||||
** BUILD SUCCEEDED **
|
||||
```
|
||||
|
||||
All tests compile successfully with no errors. Only warnings are from the main app code, not test code.
|
||||
|
||||
## 📝 Next Steps for User
|
||||
|
||||
### In Xcode GUI (One-Time Setup Required):
|
||||
|
||||
1. **Fix AccessibilityIdentifiers Target Membership:**
|
||||
- Open `iosApp.xcodeproj` in Xcode
|
||||
- Select `iosApp/Helpers/AccessibilityIdentifiers.swift` in Project Navigator
|
||||
- In File Inspector (right panel), **uncheck** "HoneyDueUITests" from Target Membership
|
||||
- Only `iosApp` should be checked
|
||||
- The copy in `HoneyDueUITests/AccessibilityIdentifiers.swift` should have "HoneyDueUITests" checked
|
||||
|
||||
2. **Run Tests:**
|
||||
```bash
|
||||
# Run all UI tests
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests
|
||||
|
||||
# Run specific test class
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests/ComprehensiveAuthenticationTests
|
||||
|
||||
# Run specific test
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17' \
|
||||
-only-testing:HoneyDueUITests/ComprehensiveAuthenticationTests/testLoginWithValidCredentials
|
||||
```
|
||||
|
||||
## 🎯 Test Philosophy
|
||||
|
||||
These tests follow Apple's UI Testing best practices:
|
||||
|
||||
1. **Black Box Testing**: Tests interact with the app as a user would
|
||||
2. **No Internal Access**: No `@testable import`, ensuring tests verify actual user experience
|
||||
3. **Robust Selectors**: Uses accessibility identifiers for stable element location
|
||||
4. **Proper Waits**: Uses XCTest expectations instead of arbitrary sleeps
|
||||
5. **Comprehensive Coverage**: Tests both success and failure paths
|
||||
6. **Maintainable**: Clear naming, helper methods, and well-structured code
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
All test files include:
|
||||
- Header comments describing purpose
|
||||
- MARK comments organizing test sections
|
||||
- Inline comments explaining complex logic
|
||||
- Descriptive test names (no need to read code to understand what's tested)
|
||||
|
||||
## 🔍 Troubleshooting
|
||||
|
||||
If tests fail:
|
||||
|
||||
1. **Check app is testable**: Ensure accessibility identifiers are present in SwiftUI views
|
||||
2. **Check test data**: Tests use unique timestamps to avoid conflicts
|
||||
3. **Check timeouts**: Increase timeouts if app is slow (edit in TestHelpers.swift)
|
||||
4. **Check simulator**: Ensure correct simulator is running and app is installed
|
||||
5. **Use debug helpers**: Call `printVisibleElements()` or `takeScreenshot()` in tests
|
||||
|
||||
## ✅ Success Criteria Met
|
||||
|
||||
- ✅ All tests compile without errors
|
||||
- ✅ Comprehensive edge case coverage for every flow
|
||||
- ✅ No `@testable import` usage
|
||||
- ✅ Robust wait functions implemented
|
||||
- ✅ Reusable helper methods created
|
||||
- ✅ Clear, maintainable test code
|
||||
- ✅ Proper test isolation and cleanup
|
||||
- ✅ 51 comprehensive UI tests covering authentication, residence, and task management
|
||||
|
||||
---
|
||||
|
||||
**Generated:** 2025-11-19
|
||||
**Author:** Claude Code (Anthropic)
|
||||
**Build Status:** ✅ BUILD SUCCEEDED
|
||||
@@ -1,73 +0,0 @@
|
||||
# HoneyDue iOS UI Test Strategy
|
||||
|
||||
## Current Status: REBUILDING FROM SCRATCH
|
||||
|
||||
The previous comprehensive tests (50+ tests) were written without proper verification and are failing. We're now taking a methodical approach.
|
||||
|
||||
## Phase 1: Foundation Test (IN PROGRESS)
|
||||
|
||||
### SimpleLoginTest.swift
|
||||
- ✅ Created with logout-first logic
|
||||
- 🔄 Testing in progress
|
||||
- Contains 2 basic tests:
|
||||
1. `testAppLaunchesAndShowsLoginScreen()` - Verifies app launches and shows login UI
|
||||
2. `testCanTypeInLoginFields()` - Verifies we can interact with username/password fields
|
||||
|
||||
**Key Feature**: `ensureLoggedOut()` helper automatically logs out before each test
|
||||
|
||||
## Phase 2: Build Working Tests Incrementally
|
||||
|
||||
Once SimpleLoginTest works, we'll build:
|
||||
|
||||
### Authentication Tests (Priority 1)
|
||||
- Login with valid credentials
|
||||
- Login with invalid credentials
|
||||
- Logout flow
|
||||
- Registration flow
|
||||
- Password reset flow
|
||||
|
||||
### Residence Tests (Priority 2)
|
||||
- View residences list
|
||||
- Create residence
|
||||
- Edit residence
|
||||
- Delete residence
|
||||
|
||||
### Task Tests (Priority 3)
|
||||
- View tasks
|
||||
- Create task
|
||||
- Mark task in progress
|
||||
- Complete task
|
||||
|
||||
## Test Principles
|
||||
|
||||
1. **Always logout first** - Each test starts from login screen
|
||||
2. **Use flexible selectors** - NSPredicate with CONTAINS instead of exact matches
|
||||
3. **Wait for elements** - Use `waitForExistence(timeout:)` instead of `sleep()`
|
||||
4. **Test one thing** - Each test focuses on a single user flow
|
||||
5. **Clean up** - Tests should be independent and repeatable
|
||||
|
||||
## How to Run Tests
|
||||
|
||||
### In Xcode (Recommended)
|
||||
1. Open `iosApp.xcodeproj`
|
||||
2. Select HoneyDueUITests scheme
|
||||
3. Press Cmd+U or click diamond icon next to test
|
||||
|
||||
### Command Line
|
||||
```bash
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme HoneyDueUITests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17'
|
||||
```
|
||||
|
||||
## Known Issues
|
||||
|
||||
- Previous comprehensive tests (Comprehensive*Tests.swift) are NOT working
|
||||
- AccessibilityIdentifiers may not all be properly set in views
|
||||
- Need to verify actual UI structure before writing complex tests
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Get SimpleLoginTest passing
|
||||
2. Add more login/auth tests based on what works
|
||||
3. Gradually add residence and task tests
|
||||
4. Delete old failing comprehensive tests once new ones work
|
||||
@@ -1,198 +0,0 @@
|
||||
# XCUITest Debugging Guide
|
||||
|
||||
## Current Status
|
||||
|
||||
✅ **Completed:**
|
||||
- Created comprehensive XCUITest infrastructure (34 tests)
|
||||
- Added `AccessibilityIdentifiers.swift` with centralized identifiers
|
||||
- Added accessibility identifiers to critical views (LoginView, RegisterView, MainTabView, Residence views, ProfileView)
|
||||
- Updated `TestHelpers.swift` to use accessibility identifiers
|
||||
- Project builds successfully for testing
|
||||
|
||||
❌ **Issue:**
|
||||
- ALL tests are failing within ~0.5 seconds
|
||||
- Tests fail during `setUp()` when trying to login
|
||||
- The login helper cannot find UI elements by their accessibility identifiers
|
||||
|
||||
## Root Cause Analysis
|
||||
|
||||
The tests fail at this line in `TestHelpers.swift:44`:
|
||||
```swift
|
||||
let usernameField = app.textFields[AccessibilityIdentifiers.Authentication.usernameField]
|
||||
XCTAssertTrue(usernameField.waitForExistence(timeout: 5), "Username field should exist")
|
||||
// ❌ This assertion fails - field not found
|
||||
```
|
||||
|
||||
**Possible Causes:**
|
||||
1. **Accessibility identifiers not set at runtime** - The `.accessibilityIdentifier()` modifiers might not be working
|
||||
2. **App not rendering properly in test mode** - The app might be crashing or showing a different screen
|
||||
3. **Timing issue** - The login screen might not be fully loaded when the test runs
|
||||
4. **Kotlin initialization blocking** - The TokenStorage/Kotlin framework might be blocking UI rendering
|
||||
|
||||
## Recommended Next Steps
|
||||
|
||||
### Option 1: Debug in Xcode (RECOMMENDED)
|
||||
|
||||
This is the fastest way to diagnose the issue:
|
||||
|
||||
1. **Open the project in Xcode:**
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
```
|
||||
|
||||
2. **Select the Test target and a simulator:**
|
||||
- Select "iPhone 17 Pro" simulator from the device dropdown
|
||||
- Select the `HoneyDueTests` scheme
|
||||
|
||||
3. **Use UI Recording to see what elements exist:**
|
||||
- Open `DebugLoginTest.swift`
|
||||
- Place your cursor in `testAppLaunches()` method
|
||||
- Click the **red record button** at the bottom of the editor
|
||||
- The app will launch in the simulator
|
||||
- **Tap on UI elements** - Xcode will generate code showing the actual identifiers
|
||||
- Stop recording and examine the generated code
|
||||
|
||||
4. **Check console output:**
|
||||
- Run `testAppLaunches()` test (Cmd+U or click diamond icon in gutter)
|
||||
- View console output (Cmd+Shift+Y) to see the `XCTContext` activity logs
|
||||
- This will show actual counts of UI elements found
|
||||
|
||||
5. **Use Accessibility Inspector:**
|
||||
- Open Accessibility Inspector (Xcode → Open Developer Tool → Accessibility Inspector)
|
||||
- Run the app normally (not in test mode)
|
||||
- Inspect the login fields to verify accessibility identifiers are set
|
||||
|
||||
### Option 2: Add Debug Output to App
|
||||
|
||||
Modify `LoginView.swift` to print when it renders:
|
||||
|
||||
```swift
|
||||
var body: some View {
|
||||
// ... existing code ...
|
||||
.onAppear {
|
||||
print("🟢 LoginView appeared")
|
||||
print("🔍 Username field identifier: \(AccessibilityIdentifiers.Authentication.usernameField)")
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then run tests and check if "LoginView appeared" prints in console.
|
||||
|
||||
### Option 3: Simplify the Test
|
||||
|
||||
The `DebugLoginTest.swift` is already simplified. Try running it:
|
||||
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17 Pro' \
|
||||
-only-testing:HoneyDueTests/DebugLoginTest/testAppLaunches
|
||||
```
|
||||
|
||||
Check if it passes (meaning the app launches and has SOME UI elements).
|
||||
|
||||
## Known Issues to Check
|
||||
|
||||
### 1. AccessibilityIdentifiers Not in Test Target
|
||||
|
||||
Verify that `AccessibilityIdentifiers.swift` is included in the **iosApp target** (not HoneyDueTests):
|
||||
- In Xcode, select `Helpers/AccessibilityIdentifiers.swift`
|
||||
- In File Inspector (right panel), check "Target Membership"
|
||||
- ✅ `iosApp` should be checked
|
||||
- ❌ `HoneyDueTests` should NOT be checked
|
||||
|
||||
### 2. LoginView Not Using Correct Identifiers
|
||||
|
||||
Double-check `Login/LoginView.swift`:
|
||||
```bash
|
||||
grep "accessibilityIdentifier" /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Login/LoginView.swift
|
||||
```
|
||||
|
||||
Should output:
|
||||
```
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.passwordField)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.loginButton)
|
||||
```
|
||||
|
||||
### 3. App Showing Different Screen in Test Mode
|
||||
|
||||
The app might be checking for existing auth token and bypassing login. Check if `TokenStorage` has a stored token from previous runs:
|
||||
|
||||
```swift
|
||||
// In iOSApp.swift init(), add for testing:
|
||||
#if DEBUG
|
||||
if ProcessInfo.processInfo.arguments.contains("--uitesting") {
|
||||
TokenStorage.shared.clearToken() // Force logout for tests
|
||||
}
|
||||
#endif
|
||||
```
|
||||
|
||||
### 4. Kotlin Framework Initialization Blocking
|
||||
|
||||
The app initializes `TokenStorage` in `iOSApp.init()`. This might be blocking:
|
||||
|
||||
```swift
|
||||
init() {
|
||||
// This could be blocking UI rendering:
|
||||
TokenStorage.shared.initialize(manager: TokenManager())
|
||||
}
|
||||
```
|
||||
|
||||
Try moving initialization to background thread or making it async.
|
||||
|
||||
## Quick Verification Commands
|
||||
|
||||
```bash
|
||||
# Check if identifiers are in LoginView
|
||||
grep -c "accessibilityIdentifier" /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Login/LoginView.swift
|
||||
# Should output: 6
|
||||
|
||||
# Check if AccessibilityIdentifiers exists
|
||||
ls -la /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Helpers/AccessibilityIdentifiers.swift
|
||||
# Should show the file
|
||||
|
||||
# Run simplified debug test
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
xcodebuild test -project iosApp.xcodeproj -scheme iosApp \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 17 Pro' \
|
||||
-only-testing:HoneyDueTests/DebugLoginTest/testAppLaunches 2>&1 | grep "Test Case"
|
||||
```
|
||||
|
||||
## Expected Output When Working
|
||||
|
||||
When tests work properly, you should see:
|
||||
```
|
||||
Test Case '-[HoneyDueTests.DebugLoginTest testAppLaunches]' started.
|
||||
Activity 'Found 1 text fields' started
|
||||
Activity 'Found 1 secure fields' started
|
||||
Activity 'Found 5 buttons' started
|
||||
Activity 'Email field exists: true' started
|
||||
Activity 'Password field exists: true' started
|
||||
Test Case '-[HoneyDueTests.DebugLoginTest testAppLaunches]' passed (5.234 seconds).
|
||||
```
|
||||
|
||||
Currently seeing:
|
||||
```
|
||||
Test Case '-[HoneyDueTests.DebugLoginTest testAppLaunches]' failed (0.540 seconds)
|
||||
```
|
||||
|
||||
The ~0.5 second failure suggests the app isn't even launching or is crashing immediately.
|
||||
|
||||
## Files Modified
|
||||
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Helpers/AccessibilityIdentifiers.swift` - Created
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Login/LoginView.swift` - Added 6 identifiers
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Login/RegisterView.swift` - Added 6 identifiers
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/MainTabView.swift` - Added 5 tab identifiers
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Residence/*` - Added 15+ identifiers
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Profile/ProfileTabView.swift` - Added logout identifier
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/HoneyDueTests/TestHelpers.swift` - Updated to use identifiers
|
||||
- ✅ `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/HoneyDueTests/DebugLoginTest.swift` - Simplified debug test
|
||||
|
||||
## Next Action
|
||||
|
||||
**Open the project in Xcode** and use the UI Recording feature. This will immediately show you what identifiers are actually available and why the tests can't find them.
|
||||
@@ -1,599 +0,0 @@
|
||||
# XCUITest Implementation Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide provides step-by-step instructions for implementing comprehensive UI testing for the HoneyDue iOS app using XCUITest.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Project Setup](#project-setup)
|
||||
2. [Adding Accessibility Identifiers](#adding-accessibility-identifiers)
|
||||
3. [Running the Tests](#running-the-tests)
|
||||
4. [Continuous Integration](#continuous-integration)
|
||||
|
||||
---
|
||||
|
||||
## Project Setup
|
||||
|
||||
### Current Status
|
||||
|
||||
✅ **Already Done:**
|
||||
- UI Test target exists: `HoneyDueTests`
|
||||
- Base test infrastructure in place (`TestHelpers.swift`, `BaseUITest`)
|
||||
- Initial test files created
|
||||
|
||||
### What's New:
|
||||
|
||||
1. **Centralized Accessibility Identifiers**: `iosApp/Helpers/AccessibilityIdentifiers.swift`
|
||||
2. **Comprehensive Test Suite**: Based on `AUTOMATED_TEST_EXECUTION_PLAN.md`
|
||||
3. **Enhanced Test Utilities**: Improved helpers for common operations
|
||||
|
||||
---
|
||||
|
||||
## Adding Accessibility Identifiers
|
||||
|
||||
### Step 1: Import the Identifiers File
|
||||
|
||||
Ensure all view files import the identifiers:
|
||||
|
||||
```swift
|
||||
import SwiftUI
|
||||
// No import needed - same module
|
||||
```
|
||||
|
||||
### Step 2: Add Identifiers to Views
|
||||
|
||||
For each interactive element in your views, add the `.accessibilityIdentifier()` modifier.
|
||||
|
||||
#### Example: LoginView.swift
|
||||
|
||||
```swift
|
||||
// Username Field
|
||||
TextField("Enter your email", text: $viewModel.username)
|
||||
.textInputAutocapitalization(.never)
|
||||
.autocorrectionDisabled()
|
||||
.keyboardType(.emailAddress)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
|
||||
// Password Field
|
||||
SecureField("Enter your password", text: $viewModel.password)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.passwordField)
|
||||
|
||||
// Login Button
|
||||
Button(action: viewModel.login) {
|
||||
Text("Sign In")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.loginButton)
|
||||
|
||||
// Sign Up Button
|
||||
Button("Sign Up") {
|
||||
showingRegister = true
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.signUpButton)
|
||||
```
|
||||
|
||||
#### Example: RegisterView.swift
|
||||
|
||||
```swift
|
||||
TextField("Username", text: $viewModel.username)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerUsernameField)
|
||||
|
||||
TextField("Email", text: $viewModel.email)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerEmailField)
|
||||
|
||||
SecureField("Password", text: $viewModel.password)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerPasswordField)
|
||||
|
||||
SecureField("Confirm Password", text: $viewModel.confirmPassword)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerConfirmPasswordField)
|
||||
|
||||
Button("Register") {
|
||||
viewModel.register()
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerButton)
|
||||
```
|
||||
|
||||
#### Example: MainTabView.swift
|
||||
|
||||
```swift
|
||||
TabView(selection: $selectedTab) {
|
||||
NavigationView {
|
||||
ResidencesListView()
|
||||
}
|
||||
.tabItem {
|
||||
Label("Residences", systemImage: "house.fill")
|
||||
}
|
||||
.tag(0)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Navigation.residencesTab)
|
||||
|
||||
// Repeat for other tabs...
|
||||
}
|
||||
```
|
||||
|
||||
#### Example: ResidenceFormView.swift
|
||||
|
||||
```swift
|
||||
TextField("Property Name", text: $name)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.nameField)
|
||||
|
||||
Picker("Property Type", selection: $selectedPropertyType) {
|
||||
// ...
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.propertyTypePicker)
|
||||
|
||||
TextField("Street Address", text: $streetAddress)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.streetAddressField)
|
||||
|
||||
TextField("City", text: $city)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.cityField)
|
||||
|
||||
TextField("State/Province", text: $stateProvince)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.stateProvinceField)
|
||||
|
||||
TextField("Postal Code", text: $postalCode)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.postalCodeField)
|
||||
|
||||
TextField("Country", text: $country)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.countryField)
|
||||
|
||||
TextField("Bedrooms", text: $bedrooms)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.bedroomsField)
|
||||
|
||||
TextField("Bathrooms", text: $bathrooms)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.bathroomsField)
|
||||
|
||||
Toggle("Primary Residence", isOn: $isPrimary)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.isPrimaryToggle)
|
||||
|
||||
Button("Save") {
|
||||
saveResidence()
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.saveButton)
|
||||
```
|
||||
|
||||
#### Example: TaskFormView.swift
|
||||
|
||||
```swift
|
||||
TextField("Title", text: $title)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.titleField)
|
||||
|
||||
TextField("Description", text: $description)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.descriptionField)
|
||||
|
||||
Picker("Category", selection: $selectedCategory) {
|
||||
// ...
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.categoryPicker)
|
||||
|
||||
Picker("Frequency", selection: $selectedFrequency) {
|
||||
// ...
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.frequencyPicker)
|
||||
|
||||
Picker("Priority", selection: $selectedPriority) {
|
||||
// ...
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.priorityPicker)
|
||||
|
||||
DatePicker("Due Date", selection: $dueDate)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.dueDatePicker)
|
||||
|
||||
TextField("Estimated Cost", text: $estimatedCost)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.estimatedCostField)
|
||||
|
||||
Button("Save") {
|
||||
saveTask()
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Task.saveButton)
|
||||
```
|
||||
|
||||
#### Example: ResidenceDetailView.swift
|
||||
|
||||
```swift
|
||||
// Add Task Button (FAB or toolbar button)
|
||||
Button(action: { showingAddTask = true }) {
|
||||
Image(systemName: "plus")
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.addTaskButton)
|
||||
|
||||
// Edit Button
|
||||
Button("Edit") {
|
||||
showingEditForm = true
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.editButton)
|
||||
|
||||
// Delete Button
|
||||
Button("Delete", role: .destructive) {
|
||||
showingDeleteConfirmation = true
|
||||
}
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Residence.deleteButton)
|
||||
```
|
||||
|
||||
### Step 3: Dynamic Identifiers for List Items
|
||||
|
||||
For list items (residence cards, task cards, etc.), use dynamic identifiers:
|
||||
|
||||
```swift
|
||||
ForEach(residences, id: \.id) { residence in
|
||||
ResidenceCard(residence: residence)
|
||||
.accessibilityIdentifier("\(AccessibilityIdentifiers.Residence.residenceCard).\(residence.id)")
|
||||
.onTapGesture {
|
||||
selectedResidence = residence
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Quick Reference: Files to Update
|
||||
|
||||
Here's a checklist of all views that need accessibility identifiers:
|
||||
|
||||
**Authentication (Priority: High)**
|
||||
- ✅ `/iosApp/Login/LoginView.swift` - Partially done
|
||||
- ⬜ `/iosApp/Register/RegisterView.swift`
|
||||
- ⬜ `/iosApp/VerifyEmail/VerifyEmailView.swift`
|
||||
- ⬜ `/iosApp/PasswordReset/ForgotPasswordView.swift`
|
||||
|
||||
**Navigation (Priority: High)**
|
||||
- ⬜ `/iosApp/MainTabView.swift`
|
||||
- ⬜ `/iosApp/ContentView.swift`
|
||||
|
||||
**Residence (Priority: High)**
|
||||
- ⬜ `/iosApp/ResidenceFormView.swift`
|
||||
- ⬜ `/iosApp/Residence/ResidencesListView.swift`
|
||||
- ⬜ `/iosApp/Residence/ResidenceDetailView.swift`
|
||||
- ⬜ `/iosApp/AddResidenceView.swift`
|
||||
- ⬜ `/iosApp/EditResidenceView.swift`
|
||||
|
||||
**Task (Priority: High)**
|
||||
- ⬜ `/iosApp/Task/TaskFormView.swift`
|
||||
- ⬜ `/iosApp/Task/AddTaskView.swift`
|
||||
- ⬜ `/iosApp/Task/EditTaskView.swift`
|
||||
- ⬜ `/iosApp/Task/AllTasksView.swift`
|
||||
- ⬜ `/iosApp/Task/CompleteTaskView.swift`
|
||||
|
||||
**Contractor (Priority: Medium)**
|
||||
- ⬜ `/iosApp/Contractor/ContractorsListView.swift`
|
||||
- ⬜ `/iosApp/Contractor/ContractorDetailView.swift`
|
||||
|
||||
**Document (Priority: Medium)**
|
||||
- ⬜ `/iosApp/Documents/DocumentsWarrantiesView.swift`
|
||||
- ⬜ `/iosApp/Documents/AddDocumentView.swift`
|
||||
- ⬜ `/iosApp/Documents/DocumentDetailView.swift`
|
||||
|
||||
**Profile (Priority: Medium)**
|
||||
- ⬜ `/iosApp/Profile/ProfileView.swift`
|
||||
- ⬜ `/iosApp/Profile/ProfileTabView.swift`
|
||||
|
||||
---
|
||||
|
||||
## Running the Tests
|
||||
|
||||
### In Xcode
|
||||
|
||||
1. **Open the project:**
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
```
|
||||
|
||||
2. **Select the test target:**
|
||||
- Product → Scheme → HoneyDueTests
|
||||
|
||||
3. **Choose a simulator:**
|
||||
- iPhone 15 Pro (recommended)
|
||||
- iOS 17.0+
|
||||
|
||||
4. **Run all tests:**
|
||||
- Press `⌘ + U` (Command + U)
|
||||
- Or: Product → Test
|
||||
|
||||
5. **Run specific test:**
|
||||
- Open test file (e.g., `AuthenticationUITests.swift`)
|
||||
- Click the diamond icon next to the test method
|
||||
- Or: Right-click → Run Test
|
||||
|
||||
### From Command Line
|
||||
|
||||
```bash
|
||||
# Navigate to iOS app directory
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
|
||||
# Run all tests
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme HoneyDueTests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 15 Pro,OS=17.0'
|
||||
|
||||
# Run specific test class
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme HoneyDueTests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 15 Pro,OS=17.0' \
|
||||
-only-testing:HoneyDueTests/AuthenticationUITests
|
||||
|
||||
# Run specific test method
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme HoneyDueTests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 15 Pro,OS=17.0' \
|
||||
-only-testing:HoneyDueTests/AuthenticationUITests/testLoginWithValidCredentials
|
||||
```
|
||||
|
||||
### Test Results
|
||||
|
||||
Test results are saved to:
|
||||
```
|
||||
~/Library/Developer/Xcode/DerivedData/iosApp-*/Logs/Test/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
### GitHub Actions Example
|
||||
|
||||
Create `.github/workflows/ios-tests.yml`:
|
||||
|
||||
```yaml
|
||||
name: iOS UI Tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, develop ]
|
||||
pull_request:
|
||||
branches: [ main, develop ]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: macos-14 # macOS Sonoma with Xcode 15+
|
||||
timeout-minutes: 30
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Xcode
|
||||
uses: maxim-lobanov/setup-xcode@v1
|
||||
with:
|
||||
xcode-version: '15.2'
|
||||
|
||||
- name: Start Django Backend
|
||||
run: |
|
||||
cd honeyDueAPI
|
||||
docker-compose up -d
|
||||
sleep 10 # Wait for backend to start
|
||||
|
||||
- name: Check Backend Health
|
||||
run: |
|
||||
curl --retry 5 --retry-delay 3 http://localhost:8000/api/
|
||||
|
||||
- name: Run iOS UI Tests
|
||||
run: |
|
||||
cd HoneyDueKMM/iosApp
|
||||
xcodebuild test \
|
||||
-project iosApp.xcodeproj \
|
||||
-scheme HoneyDueTests \
|
||||
-destination 'platform=iOS Simulator,name=iPhone 15 Pro,OS=17.2' \
|
||||
-resultBundlePath TestResults.xcresult \
|
||||
-enableCodeCoverage YES
|
||||
|
||||
- name: Upload Test Results
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: test-results
|
||||
path: HoneyDueKMM/iosApp/TestResults.xcresult
|
||||
|
||||
- name: Upload Screenshots
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: screenshots
|
||||
path: ~/Library/Developer/CoreSimulator/Devices/*/data/tmp/
|
||||
if-no-files-found: ignore
|
||||
|
||||
- name: Stop Docker Containers
|
||||
if: always()
|
||||
run: |
|
||||
cd honeyDueAPI
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
##Test Configuration
|
||||
|
||||
### Test Plan (Optional)
|
||||
|
||||
Create a `.xctestplan` file for better organization:
|
||||
|
||||
1. In Xcode: File → New → Test Plan
|
||||
2. Name it: `HoneyDueTestPlan.xctestplan`
|
||||
3. Configure:
|
||||
- **Configurations**: Debug, Release
|
||||
- **Test Targets**: HoneyDueTests
|
||||
- **Code Coverage**: Enable
|
||||
- **Screenshots**: Automatically on failure
|
||||
|
||||
### Launch Arguments
|
||||
|
||||
Configure launch arguments for testing:
|
||||
|
||||
```swift
|
||||
// In test setUp()
|
||||
app.launchArguments = [
|
||||
"--uitesting", // Flag for UI testing mode
|
||||
"--disable-animations", // Speed up tests
|
||||
"--reset-user-defaults", // Clean state
|
||||
"--use-test-api" // Point to test backend
|
||||
]
|
||||
app.launch()
|
||||
```
|
||||
|
||||
Handle in your app:
|
||||
|
||||
```swift
|
||||
// In AppDelegate or App init
|
||||
if ProcessInfo.processInfo.arguments.contains("--uitesting") {
|
||||
// Disable animations
|
||||
UIView.setAnimationsEnabled(false)
|
||||
|
||||
// Clear user defaults
|
||||
if ProcessInfo.processInfo.arguments.contains("--reset-user-defaults") {
|
||||
let domain = Bundle.main.bundleIdentifier!
|
||||
UserDefaults.standard.removePersistentDomain(forName: domain)
|
||||
}
|
||||
|
||||
// Use test API
|
||||
if ProcessInfo.processInfo.arguments.contains("--use-test-api") {
|
||||
ApiConfig.CURRENT_ENV = .LOCAL
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Write Maintainable Tests
|
||||
|
||||
```swift
|
||||
// ✅ Good: Descriptive test names
|
||||
func testUserCanLoginWithValidCredentials() { }
|
||||
|
||||
// ❌ Bad: Vague test names
|
||||
func testLogin() { }
|
||||
```
|
||||
|
||||
### 2. Use Page Object Pattern
|
||||
|
||||
```swift
|
||||
// Create a LoginPage helper
|
||||
struct LoginPage {
|
||||
let app: XCUIApplication
|
||||
|
||||
var usernameField: XCUIElement {
|
||||
app.textFields[AccessibilityIdentifiers.Authentication.usernameField]
|
||||
}
|
||||
|
||||
var passwordField: XCUIElement {
|
||||
app.secureTextFields[AccessibilityIdentifiers.Authentication.passwordField]
|
||||
}
|
||||
|
||||
var loginButton: XCUIElement {
|
||||
app.buttons[AccessibilityIdentifiers.Authentication.loginButton]
|
||||
}
|
||||
|
||||
func login(username: String, password: String) {
|
||||
usernameField.tap()
|
||||
usernameField.typeText(username)
|
||||
|
||||
passwordField.tap()
|
||||
passwordField.typeText(password)
|
||||
|
||||
loginButton.tap()
|
||||
}
|
||||
}
|
||||
|
||||
// Use in tests
|
||||
func testLogin() {
|
||||
let loginPage = LoginPage(app: app)
|
||||
loginPage.login(username: "testuser", password: "password")
|
||||
// Assert...
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Wait for Elements
|
||||
|
||||
```swift
|
||||
// ✅ Good: Wait with timeout
|
||||
let loginButton = app.buttons["Login"]
|
||||
XCTAssertTrue(loginButton.waitForExistence(timeout: 5))
|
||||
|
||||
// ❌ Bad: Assume immediate availability
|
||||
XCTAssertTrue(app.buttons["Login"].exists)
|
||||
```
|
||||
|
||||
### 4. Clean State Between Tests
|
||||
|
||||
```swift
|
||||
override func tearDown() {
|
||||
// Logout if logged in
|
||||
if app.tabBars.exists {
|
||||
logout()
|
||||
}
|
||||
|
||||
super.tearDown()
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Use Meaningful Assertions
|
||||
|
||||
```swift
|
||||
// ✅ Good: Clear assertion messages
|
||||
XCTAssertTrue(
|
||||
app.tabBars.exists,
|
||||
"Should navigate to main tab view after login"
|
||||
)
|
||||
|
||||
// ❌ Bad: No context
|
||||
XCTAssertTrue(app.tabBars.exists)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Issue: Elements not found**
|
||||
- **Solution**: Verify accessibility identifier is added to the view
|
||||
- **Debug**: Use `app.debugDescription` to see all elements
|
||||
|
||||
**Issue: Tests are flaky**
|
||||
- **Solution**: Add waits (`waitForExistence`) before interactions
|
||||
- **Solution**: Disable animations
|
||||
|
||||
**Issue: Tests run slow**
|
||||
- **Solution**: Use `--disable-animations` launch argument
|
||||
- **Solution**: Run tests in parallel (Xcode 13+)
|
||||
|
||||
**Issue: Backend not ready**
|
||||
- **Solution**: Add health check before tests
|
||||
- **Solution**: Increase wait time in pre-flight checks
|
||||
|
||||
### Debugging Tips
|
||||
|
||||
```swift
|
||||
// Print all elements
|
||||
print(app.debugDescription)
|
||||
|
||||
// Take screenshot manually
|
||||
let screenshot = XCUIScreen.main.screenshot()
|
||||
let attachment = XCTAttachment(screenshot: screenshot)
|
||||
attachment.lifetime = .keepAlways
|
||||
add(attachment)
|
||||
|
||||
// Breakpoint in test
|
||||
// Use Xcode's test navigator to pause at failures
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Add accessibility identifiers to all views (see checklist above)
|
||||
2. ✅ Run existing tests to verify setup
|
||||
3. ✅ Review and expand test coverage using the new comprehensive test suite
|
||||
4. ⬜ Set up CI/CD pipeline
|
||||
5. ⬜ Configure test reporting/dashboards
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
- [XCUITest Documentation](https://developer.apple.com/documentation/xctest/user_interface_tests)
|
||||
- [WWDC: UI Testing in Xcode](https://developer.apple.com/videos/play/wwdc2019/413/)
|
||||
- [Test Plan Configuration](https://developer.apple.com/documentation/xcode/organizing-tests-to-improve-feedback)
|
||||
- [Accessibility for UIKit](https://developer.apple.com/documentation/uikit/accessibility)
|
||||
|
||||
@@ -1,510 +0,0 @@
|
||||
# XCUITest Implementation - Summary of Deliverables
|
||||
|
||||
## Overview
|
||||
|
||||
This document summarizes the comprehensive XCUITest implementation created for the HoneyDue iOS app. All deliverables are based on the `AUTOMATED_TEST_EXECUTION_PLAN.md` and follow iOS best practices for UI testing.
|
||||
|
||||
---
|
||||
|
||||
## What Was Delivered
|
||||
|
||||
### 1. ✅ Centralized Accessibility Identifiers
|
||||
|
||||
**File:** `iosApp/Helpers/AccessibilityIdentifiers.swift`
|
||||
|
||||
A comprehensive, centralized file containing all accessibility identifiers organized by feature:
|
||||
|
||||
- **Authentication**: Login, Registration, Verification, Password Reset
|
||||
- **Navigation**: Tab bar items
|
||||
- **Residence**: Forms, Lists, Details, Actions
|
||||
- **Task**: Forms, Lists, Kanban, Completion
|
||||
- **Contractor**: Forms, Lists, Details
|
||||
- **Document**: Forms, Lists, Details
|
||||
- **Profile**: Settings, Logout
|
||||
- **Common**: Loading, Errors, Search, Filters
|
||||
|
||||
**Benefits:**
|
||||
- Single source of truth for all identifiers
|
||||
- Easy to maintain and update
|
||||
- Compile-time safety (typo prevention)
|
||||
- Consistent naming convention
|
||||
|
||||
**Usage Example:**
|
||||
```swift
|
||||
TextField("Email", text: $email)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.usernameField)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. ✅ Comprehensive Test Suite
|
||||
|
||||
Three complete test files covering all major flows from the automated test plan:
|
||||
|
||||
####ComprehensiveAuthenticationTests.swift`
|
||||
|
||||
**Location:** `iosApp/HoneyDueTests/ComprehensiveAuthenticationTests.swift`
|
||||
|
||||
**Tests Included:**
|
||||
- `testUserRegistrationComplete()` - Test 1.1: Full registration flow
|
||||
- `testRegistrationWithExistingUsername()` - Validation test
|
||||
- `testRegistrationWithInvalidEmail()` - Validation test
|
||||
- `testRegistrationWithMismatchedPasswords()` - Validation test
|
||||
- `testLoginWithValidCredentials()` - Test 1.3: Successful login
|
||||
- `testLoginWithInvalidCredentials()` - Error handling
|
||||
- `testLoginWithEmptyFields()` - Validation test
|
||||
- `testPasswordVisibilityToggle()` - UI interaction test
|
||||
- `testLogout()` - Test 1.2: Logout flow
|
||||
- `testLogoutClearsSession()` - Session management test
|
||||
- `testForgotPasswordFlow()` - Password reset navigation
|
||||
|
||||
**Coverage:**
|
||||
- ✅ User registration with email verification
|
||||
- ✅ Login with valid/invalid credentials
|
||||
- ✅ Logout and session clearing
|
||||
- ✅ Form validation
|
||||
- ✅ Error message display
|
||||
- ✅ UI interactions (password visibility)
|
||||
|
||||
---
|
||||
|
||||
#### `ComprehensiveResidenceTests.swift`
|
||||
|
||||
**Location:** `iosApp/HoneyDueTests/ComprehensiveResidenceTests.swift`
|
||||
|
||||
**Tests Included:**
|
||||
- `testCreateResidenceComplete()` - Test 2.1: Create property
|
||||
- `testCreateResidenceWithMinimalData()` - Minimal field test
|
||||
- `testCreateResidenceValidation()` - Required field validation
|
||||
- `testViewResidenceDetails()` - Test 2.2: View details
|
||||
- `testResidenceDetailShowsAllInfo()` - Data display verification
|
||||
- `testEditResidence()` - Test 2.3: Edit property
|
||||
- `testEditResidenceCancel()` - Cancel edit test
|
||||
- `testDeleteResidence()` - Delete confirmation flow
|
||||
- `testDeleteResidenceCancellation()` - Cancel delete test
|
||||
- `testEmptyStateDisplay()` - Empty state UI
|
||||
|
||||
**Coverage:**
|
||||
- ✅ Create residence with full/minimal data
|
||||
- ✅ View residence details
|
||||
- ✅ Edit residence information
|
||||
- ✅ Delete residence with confirmation
|
||||
- ✅ Form validation
|
||||
- ✅ Empty state handling
|
||||
|
||||
**Helper Methods:**
|
||||
- `fillResidenceForm()` - Reusable form filling
|
||||
- `ensureResidenceExists()` - Test data setup
|
||||
- `countResidenceCards()` - List verification
|
||||
- `scrollToFind()` - Dynamic element location
|
||||
|
||||
---
|
||||
|
||||
#### `ComprehensiveTaskTests.swift`
|
||||
|
||||
**Location:** `iosApp/HoneyDueTests/ComprehensiveTaskTests.swift`
|
||||
|
||||
**Tests Included:**
|
||||
- `testCreateOneTimeTaskComplete()` - Test 3.1: Create one-time task
|
||||
- `testCreateRecurringTask()` - Recurring task creation
|
||||
- `testCreateTaskWithAllFields()` - Complete form test
|
||||
- `testCreateTaskValidation()` - Required field validation
|
||||
- `testMarkTaskInProgress()` - Test 3.2: Status change
|
||||
- `testMarkTaskInProgressFromKanban()` - Kanban interaction
|
||||
- `testCompleteTask()` - Test 3.3: Task completion
|
||||
- `testCompleteTaskWithPhotos()` - Photo upload test
|
||||
- `testCompleteTaskMinimal()` - Minimal completion test
|
||||
- `testKanbanViewColumns()` - Kanban UI verification
|
||||
- `testTaskFilteringByResidence()` - Filtering test
|
||||
- `testEditTask()` - Edit task flow
|
||||
- `testDeleteTask()` - Delete task flow
|
||||
|
||||
**Coverage:**
|
||||
- ✅ Create one-time and recurring tasks
|
||||
- ✅ Mark tasks as in progress
|
||||
- ✅ Complete tasks with full/minimal data
|
||||
- ✅ Kanban board navigation
|
||||
- ✅ Task filtering
|
||||
- ✅ Edit and delete tasks
|
||||
|
||||
**Helper Methods:**
|
||||
- `fillTaskForm()` - Reusable task creation
|
||||
- `fillCompletionForm()` - Completion form filling
|
||||
- `ensureTaskExists()` - Test data setup
|
||||
- `navigateToTaskDetail()` - Navigation helper
|
||||
- `selectPicker()` - Picker interaction
|
||||
|
||||
---
|
||||
|
||||
### 3. ✅ Implementation Guide
|
||||
|
||||
**File:** `iosApp/XCUITEST_IMPLEMENTATION_GUIDE.md`
|
||||
|
||||
A comprehensive 400+ line guide covering:
|
||||
|
||||
**Section 1: Project Setup**
|
||||
- Current infrastructure status
|
||||
- What's already done vs. what's new
|
||||
|
||||
**Section 2: Adding Accessibility Identifiers**
|
||||
- Step-by-step instructions with code examples
|
||||
- Examples for all view types (LoginView, RegisterView, Forms, Lists, etc.)
|
||||
- Dynamic identifier patterns for list items
|
||||
- Complete checklist of 30+ files to update
|
||||
|
||||
**Section 3: Running the Tests**
|
||||
- Running in Xcode (GUI)
|
||||
- Running from command line
|
||||
- Test result locations
|
||||
- Filtering and targeting specific tests
|
||||
|
||||
**Section 4: Continuous Integration**
|
||||
- Complete GitHub Actions workflow example
|
||||
- Backend startup integration
|
||||
- Test result artifact upload
|
||||
- Screenshot capture on failure
|
||||
|
||||
**Section 5: Test Configuration**
|
||||
- Test plan creation
|
||||
- Launch arguments for testing mode
|
||||
- Disabling animations for faster tests
|
||||
- Using test API endpoints
|
||||
|
||||
**Section 6: Best Practices**
|
||||
- Descriptive test names
|
||||
- Page Object Pattern examples
|
||||
- Waiting for elements properly
|
||||
- Clean state between tests
|
||||
- Meaningful assertions
|
||||
|
||||
**Section 7: Troubleshooting**
|
||||
- Common issues and solutions
|
||||
- Debugging tips
|
||||
- Element not found scenarios
|
||||
- Flaky test fixes
|
||||
|
||||
**Section 8: Resources**
|
||||
- Apple documentation links
|
||||
- WWDC session references
|
||||
- Best practice guides
|
||||
|
||||
---
|
||||
|
||||
### 4. ✅ Enhanced Test Helpers (Already Existing)
|
||||
|
||||
**File:** `iosApp/HoneyDueTests/TestHelpers.swift` (Already in project)
|
||||
|
||||
The existing test infrastructure includes:
|
||||
|
||||
- `BaseUITest` class with setup/teardown
|
||||
- Authentication helpers (`login()`, `logout()`, `register()`)
|
||||
- Navigation helpers (`navigateToTab()`, `navigateBack()`)
|
||||
- Assertion helpers (`assertElementExists()`, `assertNavigatedTo()`)
|
||||
- Wait helpers (`wait()`, `waitForElementToAppear()`)
|
||||
- Identifiers struct (now superseded by centralized file)
|
||||
|
||||
**New additions recommended:**
|
||||
- `scrollToElement()` - Scroll to make element visible
|
||||
- `clearTextField()` - Clear text field content
|
||||
- `fillForm()` - Generic form filling helper
|
||||
- `takeScreenshot()` - Manual screenshot capture
|
||||
- `verifyBackendState()` - Django shell verification
|
||||
|
||||
---
|
||||
|
||||
## Implementation Roadmap
|
||||
|
||||
###Phase 1: Add Accessibility Identifiers (Highest Priority)
|
||||
|
||||
**Estimated Time:** 2-4 hours
|
||||
|
||||
Follow the checklist in `XCUITEST_IMPLEMENTATION_GUIDE.md`:
|
||||
|
||||
1. **Authentication Views** (30 min)
|
||||
- ✅ `LoginView.swift` - Partially complete
|
||||
- ⬜ `RegisterView.swift`
|
||||
- ⬜ `VerifyEmailView.swift`
|
||||
- ⬜ `ForgotPasswordView.swift`
|
||||
|
||||
2. **Navigation Views** (15 min)
|
||||
- ⬜ `MainTabView.swift`
|
||||
- ⬜ `ContentView.swift`
|
||||
|
||||
3. **Residence Views** (45 min)
|
||||
- ⬜ `ResidenceFormView.swift`
|
||||
- ⬜ `ResidencesListView.swift`
|
||||
- ⬜ `ResidenceDetailView.swift`
|
||||
- ⬜ `AddResidenceView.swift`
|
||||
- ⬜ `EditResidenceView.swift`
|
||||
|
||||
4. **Task Views** (45 min)
|
||||
- ⬜ `TaskFormView.swift`
|
||||
- ⬜ `AddTaskView.swift`
|
||||
- ⬜ `EditTaskView.swift`
|
||||
- ⬜ `AllTasksView.swift`
|
||||
- ⬜ `CompleteTaskView.swift`
|
||||
|
||||
5. **Other Views** (1 hour)
|
||||
- ⬜ Contractor views
|
||||
- ⬜ Document views
|
||||
- ⬜ Profile views
|
||||
|
||||
**How to Add:**
|
||||
|
||||
For each view file, add `.accessibilityIdentifier()` to interactive elements:
|
||||
|
||||
```swift
|
||||
// Before
|
||||
TextField("Email", text: $email)
|
||||
|
||||
// After
|
||||
TextField("Email", text: $email)
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.Authentication.registerEmailField)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Phase 2: Run and Verify Tests (30 min)
|
||||
|
||||
1. **Open Xcode**
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
```
|
||||
|
||||
2. **Select Test Target**
|
||||
- Product → Scheme → HoneyDueTests
|
||||
|
||||
3. **Run Individual Test**
|
||||
- Open `ComprehensiveAuthenticationTests.swift`
|
||||
- Click diamond next to `testLoginWithValidCredentials()`
|
||||
- Verify it passes
|
||||
|
||||
4. **Run Full Suite**
|
||||
- Press `⌘ + U` to run all tests
|
||||
- Review results in Test Navigator
|
||||
|
||||
5. **Fix Failing Tests**
|
||||
- Update identifiers if elements not found
|
||||
- Adjust waits if timing issues
|
||||
- Check backend is running
|
||||
|
||||
---
|
||||
|
||||
### Phase 3: Integrate with CI/CD (Optional, 1 hour)
|
||||
|
||||
1. **Create GitHub Actions workflow**
|
||||
- Copy example from implementation guide
|
||||
- Save as `.github/workflows/ios-tests.yml`
|
||||
|
||||
2. **Configure secrets**
|
||||
- Add any required API keys
|
||||
- Configure backend URL
|
||||
|
||||
3. **Test locally**
|
||||
- Run workflow locally with `act` tool
|
||||
- Verify all steps work
|
||||
|
||||
4. **Push and monitor**
|
||||
- Commit workflow file
|
||||
- Monitor first run
|
||||
- Configure notifications
|
||||
|
||||
---
|
||||
|
||||
## Test Coverage Summary
|
||||
|
||||
### Current Coverage (After Implementation)
|
||||
|
||||
| Feature Area | Test Count | Status |
|
||||
|-------------|-----------|--------|
|
||||
| Authentication | 11 tests | ✅ Complete |
|
||||
| Residence Management | 10 tests | ✅ Complete |
|
||||
| Task Management | 13 tests | ✅ Complete |
|
||||
| **Total** | **34 tests** | **Ready to Run** |
|
||||
|
||||
### Areas Not Yet Covered (Future Work)
|
||||
|
||||
- Contractor management (5-7 tests)
|
||||
- Document/Warranty management (5-7 tests)
|
||||
- Multi-user/sharing features (4-6 tests)
|
||||
- Profile settings (3-5 tests)
|
||||
- Pull-to-refresh (1 test)
|
||||
- Search/filtering (2-3 tests)
|
||||
- Performance tests (3-5 tests)
|
||||
|
||||
**Estimated Total Possible Coverage:** 60-70 comprehensive tests
|
||||
|
||||
---
|
||||
|
||||
## Key Benefits
|
||||
|
||||
### 1. **Regression Prevention**
|
||||
- Catch breaking changes before production
|
||||
- Verify critical flows work after updates
|
||||
- Confident refactoring
|
||||
|
||||
### 2. **Documentation**
|
||||
- Tests serve as living documentation
|
||||
- Show how features should work
|
||||
- Onboard new developers faster
|
||||
|
||||
### 3. **Faster Development**
|
||||
- No manual testing for every change
|
||||
- Quick feedback on bugs
|
||||
- Automated smoke testing
|
||||
|
||||
### 4. **Quality Assurance**
|
||||
- Consistent test execution
|
||||
- No human error in testing
|
||||
- Comprehensive coverage
|
||||
|
||||
### 5. **CI/CD Integration**
|
||||
- Automated testing on every PR
|
||||
- Block merges if tests fail
|
||||
- Continuous quality monitoring
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
### Immediate (This Week)
|
||||
1. ✅ Add accessibility identifiers to authentication views
|
||||
2. ✅ Run authentication tests to verify setup
|
||||
3. ✅ Add identifiers to residence views
|
||||
4. ✅ Run residence tests
|
||||
|
||||
### Short Term (This Month)
|
||||
1. ⬜ Add identifiers to all remaining views
|
||||
2. ⬜ Run full test suite
|
||||
3. ⬜ Fix any failing tests
|
||||
4. ⬜ Add contractor and document tests
|
||||
5. ⬜ Set up CI/CD pipeline
|
||||
|
||||
### Long Term (Next Quarter)
|
||||
1. ⬜ Achieve 80%+ UI coverage
|
||||
2. ⬜ Add performance benchmarks
|
||||
3. ⬜ Implement visual regression tests
|
||||
4. ⬜ Create test data factories
|
||||
5. ⬜ Add accessibility audit tests
|
||||
|
||||
---
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
### New Files Created
|
||||
|
||||
1. **`iosApp/Helpers/AccessibilityIdentifiers.swift`** (253 lines)
|
||||
- Centralized accessibility identifiers
|
||||
|
||||
2. **`iosApp/HoneyDueTests/ComprehensiveAuthenticationTests.swift`** (232 lines)
|
||||
- 11 authentication tests
|
||||
|
||||
3. **`iosApp/HoneyDueTests/ComprehensiveResidenceTests.swift`** (387 lines)
|
||||
- 10 residence management tests
|
||||
|
||||
4. **`iosApp/HoneyDueTests/ComprehensiveTaskTests.swift`** (437 lines)
|
||||
- 13 task management tests
|
||||
|
||||
5. **`iosApp/XCUITEST_IMPLEMENTATION_GUIDE.md`** (451 lines)
|
||||
- Complete implementation guide
|
||||
|
||||
6. **`iosApp/XCUITEST_IMPLEMENTATION_SUMMARY.md`** (This file)
|
||||
- Summary and roadmap
|
||||
|
||||
**Total New Code:** ~1,760 lines of production-ready code and documentation
|
||||
|
||||
### Files To Be Modified
|
||||
|
||||
1. **LoginView.swift** - Add 6 more identifiers
|
||||
2. **RegisterView.swift** - Add 6 identifiers
|
||||
3. **MainTabView.swift** - Add 5 identifiers
|
||||
4. **ResidenceFormView.swift** - Add 15 identifiers
|
||||
5. **TaskFormView.swift** - Add 12 identifiers
|
||||
6. **~25 more view files** - Add identifiers as needed
|
||||
|
||||
---
|
||||
|
||||
## Maintenance Guide
|
||||
|
||||
### When Adding New Features
|
||||
|
||||
1. **Add accessibility identifier constants**
|
||||
```swift
|
||||
// In AccessibilityIdentifiers.swift
|
||||
struct NewFeature {
|
||||
static let actionButton = "NewFeature.ActionButton"
|
||||
static let inputField = "NewFeature.InputField"
|
||||
}
|
||||
```
|
||||
|
||||
2. **Add identifier to view**
|
||||
```swift
|
||||
Button("Action") { }
|
||||
.accessibilityIdentifier(AccessibilityIdentifiers.NewFeature.actionButton)
|
||||
```
|
||||
|
||||
3. **Write test**
|
||||
```swift
|
||||
func testNewFeature() {
|
||||
let button = app.buttons[AccessibilityIdentifiers.NewFeature.actionButton]
|
||||
button.tap()
|
||||
// Assert...
|
||||
}
|
||||
```
|
||||
|
||||
### When Modifying UI
|
||||
|
||||
1. **Check if identifier exists**
|
||||
- Search `AccessibilityIdentifiers.swift`
|
||||
|
||||
2. **Update if needed**
|
||||
- Rename identifier if element purpose changed
|
||||
- Update all test references
|
||||
|
||||
3. **Run affected tests**
|
||||
- Ensure tests still pass
|
||||
- Update assertions if behavior changed
|
||||
|
||||
---
|
||||
|
||||
## Support and Resources
|
||||
|
||||
### Documentation
|
||||
- `XCUITEST_IMPLEMENTATION_GUIDE.md` - Complete how-to guide
|
||||
- `AUTOMATED_TEST_EXECUTION_PLAN.md` - Original test plan
|
||||
- `TestHelpers.swift` - Existing helper methods
|
||||
|
||||
### Apple Resources
|
||||
- [XCUITest Documentation](https://developer.apple.com/documentation/xctest/user_interface_tests)
|
||||
- [Accessibility for UIKit](https://developer.apple.com/documentation/uikit/accessibility)
|
||||
- [Writing Testable Code](https://developer.apple.com/documentation/xctest/defining_test_cases_and_test_methods)
|
||||
|
||||
### Contact
|
||||
For questions about this implementation, refer to the guide or check:
|
||||
- Test file comments
|
||||
- Inline code documentation
|
||||
- Apple's official XCUITest documentation
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This implementation provides a **complete, production-ready XCUITest infrastructure** for the HoneyDue iOS app:
|
||||
|
||||
✅ **34 comprehensive tests** covering authentication, residences, and tasks
|
||||
✅ **Centralized accessibility identifiers** for maintainability
|
||||
✅ **Complete implementation guide** with examples and best practices
|
||||
✅ **CI/CD integration examples** for automation
|
||||
✅ **Helper methods** for test data setup and navigation
|
||||
✅ **Clear roadmap** for completing implementation
|
||||
|
||||
**Estimated time to complete:** 3-5 hours to add all accessibility identifiers and run full suite.
|
||||
|
||||
**Ready to run:** Yes! Once accessibility identifiers are added to views, tests can be executed immediately.
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** November 18, 2025
|
||||
**Version:** 1.0
|
||||
**Author:** Claude Code
|
||||
@@ -1,24 +0,0 @@
|
||||
# XCUITest Authoring
|
||||
|
||||
## Required Architecture
|
||||
- Put shared test infrastructure in `/Users/treyt/Desktop/code/HoneyDueKMM/iosApp/HoneyDueUITests/Framework`.
|
||||
- Put feature suites in `/Users/treyt/Desktop/code/HoneyDueKMM/iosApp/HoneyDueUITests/Tests`.
|
||||
- Every test suite inherits `BaseUITestCase`.
|
||||
- Reusable multi-step setup belongs in `TestFlows`.
|
||||
- UI interactions should go through screen objects in `ScreenObjects.swift`.
|
||||
|
||||
## Runtime Contract
|
||||
- Launch args are standardized in `BaseUITestCase`:
|
||||
- `--ui-testing`
|
||||
- `--disable-animations`
|
||||
- `--reset-state`
|
||||
- App-side behavior for UI test mode is implemented in `/Users/treyt/Desktop/code/HoneyDueKMM/iosApp/iosApp/Helpers/UITestRuntime.swift`.
|
||||
|
||||
## Naming
|
||||
- Test method naming format: `test<CaseID>_<BehaviorDescription>()`.
|
||||
- Case IDs should stay stable once committed.
|
||||
|
||||
## Waiting and Flake Rules
|
||||
- Use helper waits from `BaseUITestCase` extensions.
|
||||
- Do not add blind `sleep()`.
|
||||
- Prefer stable accessibility identifiers over visible text selectors.
|
||||
@@ -1,383 +0,0 @@
|
||||
# iOS Shared Utilities Migration Summary
|
||||
|
||||
## Overview
|
||||
Successfully migrated the iOS codebase at `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/` to use shared utilities from `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/Shared/`.
|
||||
|
||||
## Migration Date
|
||||
December 17, 2025
|
||||
|
||||
## Key Changes Made
|
||||
|
||||
### 1. Form Styling Standardization
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
.listStyle(.plain)
|
||||
.scrollContentBackground(.hidden)
|
||||
.background(Color.appBackground)
|
||||
// or
|
||||
.background(Color.clear)
|
||||
|
||||
// NEW
|
||||
.standardFormStyle()
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- TaskFormView.swift
|
||||
- CompleteTaskView.swift
|
||||
- ThemeSelectionView.swift
|
||||
- TaskTemplatesBrowserView.swift
|
||||
- ContractorFormSheet.swift
|
||||
- ProfileView.swift
|
||||
- NotificationPreferencesView.swift
|
||||
- DocumentFormView.swift
|
||||
|
||||
### 2. Section Background Standardization
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
|
||||
// NEW
|
||||
.sectionBackground()
|
||||
```
|
||||
|
||||
**Files Updated:** All form-based views (20+ files)
|
||||
|
||||
### 3. Date Formatting
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
let formatter = DateFormatter()
|
||||
formatter.dateFormat = "yyyy-MM-dd"
|
||||
let dateString = formatter.string(from: date)
|
||||
|
||||
// Or
|
||||
DateUtils.formatDate(effectiveDate)
|
||||
|
||||
// NEW
|
||||
date.formattedAPI()
|
||||
effectiveDate.toFormattedDate()
|
||||
```
|
||||
|
||||
**Extensions Used:**
|
||||
- `.formatted()` - "MMM d, yyyy"
|
||||
- `.formattedAPI()` - "yyyy-MM-dd"
|
||||
- `.toFormattedDate()` - String to formatted date
|
||||
- `.isOverdue()` - Check if date is overdue
|
||||
|
||||
**Files Updated:**
|
||||
- TaskFormView.swift (date parsing and formatting)
|
||||
- TaskCard.swift (date display)
|
||||
- DynamicTaskCard.swift (date display)
|
||||
- CompletionCardView.swift (date display)
|
||||
|
||||
### 4. Currency Formatting
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
Text("Cost: $\(cost)")
|
||||
|
||||
// NEW
|
||||
Text("Cost: \(cost.toCurrency())")
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- CompletionCardView.swift
|
||||
|
||||
### 5. Form Component Standardization
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD - Manual field with icon
|
||||
VStack(alignment: .leading, spacing: 8) {
|
||||
Text(label)
|
||||
.font(.system(size: 14, weight: .medium, design: .rounded))
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
|
||||
HStack(spacing: 12) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(Color.appPrimary.opacity(0.1))
|
||||
.frame(width: 32, height: 32)
|
||||
Image(systemName: icon)
|
||||
.font(.system(size: 14, weight: .medium))
|
||||
.foregroundColor(Color.appPrimary)
|
||||
}
|
||||
|
||||
TextField(placeholder, text: $text)
|
||||
// ... many lines of styling
|
||||
}
|
||||
.padding(16)
|
||||
.background(Color.appBackgroundPrimary.opacity(0.5))
|
||||
// ... more styling
|
||||
}
|
||||
|
||||
// NEW
|
||||
VStack(alignment: .leading, spacing: 8) {
|
||||
FieldLabel(text: label)
|
||||
|
||||
IconTextField(
|
||||
icon: icon,
|
||||
placeholder: placeholder,
|
||||
text: $text,
|
||||
keyboardType: .emailAddress,
|
||||
onSubmit: { /* action */ }
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- LoginView.swift (username and password fields)
|
||||
|
||||
### 6. Button Standardization
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD - Manual button with loading state
|
||||
Button(action: action) {
|
||||
HStack(spacing: AppSpacing.sm) {
|
||||
if isLoading {
|
||||
ProgressView()
|
||||
.progressViewStyle(CircularProgressViewStyle(tint: .white))
|
||||
}
|
||||
Text(isLoading ? "Loading..." : "Submit")
|
||||
.font(.headline)
|
||||
.fontWeight(.semibold)
|
||||
}
|
||||
.frame(maxWidth: .infinity)
|
||||
.frame(height: 56)
|
||||
.foregroundColor(Color.appTextOnPrimary)
|
||||
.background(buttonBackground)
|
||||
.cornerRadius(AppRadius.md)
|
||||
.shadow(color: shouldShowShadow ? Color.appPrimary.opacity(0.3) : .clear, radius: 10, y: 5)
|
||||
}
|
||||
|
||||
// NEW
|
||||
OrganicPrimaryButton(
|
||||
title: "Submit",
|
||||
isLoading: isLoading,
|
||||
isDisabled: !isValid,
|
||||
action: action
|
||||
)
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- LoginView.swift (login button)
|
||||
|
||||
### 7. Error Field Display
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
if !error.isEmpty {
|
||||
Text(error)
|
||||
.font(.caption)
|
||||
.foregroundColor(Color.appError)
|
||||
}
|
||||
|
||||
// NEW
|
||||
if !error.isEmpty {
|
||||
FieldError(message: error)
|
||||
}
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- TaskFormView.swift (title and residence errors)
|
||||
|
||||
### 8. Loading Overlay
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
.disabled(isLoading)
|
||||
.blur(radius: isLoading ? 3 : 0)
|
||||
|
||||
if isLoading {
|
||||
VStack(spacing: OrganicSpacing.comfortable) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(Color.appPrimary.opacity(0.1))
|
||||
.frame(width: 64, height: 64)
|
||||
ProgressView()
|
||||
.scaleEffect(1.2)
|
||||
.tint(Color.appPrimary)
|
||||
}
|
||||
Text("Loading...")
|
||||
.font(.system(size: 15, weight: .medium, design: .rounded))
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
}
|
||||
// ... 20+ more lines of styling
|
||||
}
|
||||
|
||||
// NEW
|
||||
.loadingOverlay(isLoading: isLoading, message: "Loading...")
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- TaskFormView.swift
|
||||
|
||||
### 9. Empty State Views
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD - Manual empty state
|
||||
VStack(spacing: 16) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(
|
||||
RadialGradient(
|
||||
colors: [
|
||||
Color.appPrimary.opacity(0.12),
|
||||
Color.appPrimary.opacity(0.04)
|
||||
],
|
||||
center: .center,
|
||||
startRadius: 0,
|
||||
endRadius: 50
|
||||
)
|
||||
)
|
||||
.frame(width: 80, height: 80)
|
||||
|
||||
Image(systemName: icon)
|
||||
.font(.system(size: 32, weight: .medium))
|
||||
.foregroundColor(Color.appPrimary.opacity(0.6))
|
||||
}
|
||||
|
||||
VStack(spacing: 8) {
|
||||
Text(title)
|
||||
.font(.system(size: 17, weight: .semibold, design: .rounded))
|
||||
.foregroundColor(Color.appTextPrimary)
|
||||
|
||||
Text(subtitle)
|
||||
.font(.system(size: 14, weight: .medium))
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
.multilineTextAlignment(.center)
|
||||
}
|
||||
}
|
||||
.frame(maxWidth: .infinity)
|
||||
.padding(OrganicSpacing.spacious)
|
||||
.background(OrganicCardBackground(showBlob: true, blobVariation: 1))
|
||||
.clipShape(RoundedRectangle(cornerRadius: 28, style: .continuous))
|
||||
.naturalShadow(.subtle)
|
||||
|
||||
// NEW
|
||||
OrganicEmptyState(
|
||||
icon: icon,
|
||||
title: title,
|
||||
subtitle: subtitle,
|
||||
blobVariation: 1
|
||||
)
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- ResidenceDetailView.swift (contractors empty state)
|
||||
|
||||
### 10. Standard Loading View
|
||||
|
||||
**Pattern Replaced:**
|
||||
```swift
|
||||
// OLD
|
||||
VStack(spacing: 16) {
|
||||
ProgressView()
|
||||
Text("Loading...")
|
||||
.font(.subheadline)
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
}
|
||||
|
||||
// NEW
|
||||
StandardLoadingView(message: "Loading...")
|
||||
```
|
||||
|
||||
**Files Updated:**
|
||||
- ResidenceDetailView.swift
|
||||
|
||||
## Benefits of Migration
|
||||
|
||||
### 1. Code Reduction
|
||||
- **Estimated lines removed**: 500+ lines of duplicate code
|
||||
- **Average reduction per file**: 20-50 lines
|
||||
|
||||
### 2. Consistency
|
||||
- All forms now use consistent styling
|
||||
- All date formatting follows the same pattern
|
||||
- All empty states have consistent design
|
||||
- All loading states look the same
|
||||
|
||||
### 3. Maintainability
|
||||
- Changes to styling can be made in one place
|
||||
- Easier to update design system
|
||||
- Less duplication means fewer bugs
|
||||
- Clearer intent in code
|
||||
|
||||
### 4. Performance
|
||||
- Centralized DateFormatters are reused (better performance)
|
||||
- Single source of truth for styling
|
||||
|
||||
## Files Modified (Summary)
|
||||
|
||||
### Core Views
|
||||
- LoginView.swift
|
||||
- TaskFormView.swift
|
||||
- TaskCard.swift
|
||||
- ResidenceDetailView.swift
|
||||
- CompleteTaskView.swift
|
||||
|
||||
### Profile Views
|
||||
- ProfileView.swift
|
||||
- ProfileTabView.swift
|
||||
- ThemeSelectionView.swift
|
||||
- NotificationPreferencesView.swift
|
||||
|
||||
### Task Views
|
||||
- TaskTemplatesBrowserView.swift
|
||||
- DynamicTaskCard.swift
|
||||
- CompletionCardView.swift
|
||||
|
||||
### Document & Contractor Views
|
||||
- DocumentFormView.swift
|
||||
- ContractorFormSheet.swift
|
||||
|
||||
### Total Files Modified: 15+
|
||||
|
||||
## Shared Utilities Used
|
||||
|
||||
### Extensions
|
||||
- `ViewExtensions.swift` - Form styling, loading overlays, modifiers
|
||||
- `DateExtensions.swift` - Date formatting and parsing
|
||||
- `StringExtensions.swift` - String validation and utilities
|
||||
- `DoubleExtensions.swift` - Currency formatting
|
||||
|
||||
### Components
|
||||
- `FormComponents.swift` - IconTextField, FieldLabel, FieldError
|
||||
- `SharedEmptyStateView.swift` - OrganicEmptyState, StandardLoadingView
|
||||
- `ButtonStyles.swift` - OrganicPrimaryButton, SecondaryButton
|
||||
|
||||
### Utilities
|
||||
- `ValidationHelpers.swift` - Form validation (available but not yet fully utilized)
|
||||
- `SharedErrorMessageParser.swift` - Error parsing (already in use)
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ All major views have been migrated
|
||||
2. Consider migrating validation logic to use `ValidationHelpers`
|
||||
3. Consider replacing more manual buttons with shared button components
|
||||
4. Update any new code to follow these patterns
|
||||
|
||||
## Testing Recommendations
|
||||
|
||||
1. Test all forms to ensure styling is correct
|
||||
2. Verify date formatting in all views
|
||||
3. Test loading states and empty states
|
||||
4. Ensure all buttons work as expected
|
||||
5. Check that error messages display correctly
|
||||
|
||||
## Notes
|
||||
|
||||
- The migration maintains all existing functionality
|
||||
- No behavior changes, only code organization improvements
|
||||
- All changes are backwards compatible
|
||||
- Original organic design aesthetic is preserved
|
||||
@@ -1,841 +0,0 @@
|
||||
# iOS Code Refactoring Analysis - DRY Principles
|
||||
|
||||
## Executive Summary
|
||||
|
||||
This document summarizes the comprehensive analysis of the iOS codebase at `/Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM/iosApp/iosApp/` and provides a complete set of shared utilities to eliminate code duplication.
|
||||
|
||||
## Status
|
||||
|
||||
**NEW SHARED UTILITIES CREATED** (All files compiled successfully):
|
||||
|
||||
All shared utilities have been created in the `/Shared` directory and are ready for use. The existing codebase has NOT been modified to avoid breaking changes.
|
||||
|
||||
## Files Created
|
||||
|
||||
### Extensions
|
||||
- `/Shared/Extensions/ViewExtensions.swift` - Form styling, loading overlays, conditional modifiers
|
||||
- `/Shared/Extensions/DateExtensions.swift` - Date formatting, conversions, and utilities
|
||||
- `/Shared/Extensions/StringExtensions.swift` - String validation and utilities
|
||||
- `/Shared/Extensions/DoubleExtensions.swift` - Number/currency formatting
|
||||
|
||||
### Components
|
||||
- `/Shared/Components/FormComponents.swift` - Reusable form components
|
||||
- `/Shared/Components/SharedEmptyStateView.swift` - Empty state components
|
||||
- `/Shared/Components/ButtonStyles.swift` - Standardized button components
|
||||
|
||||
### Modifiers
|
||||
- `/Shared/Modifiers/CardModifiers.swift` - Card styling modifiers
|
||||
|
||||
### Utilities
|
||||
- `/Shared/Utilities/ValidationHelpers.swift` - Form validation utilities
|
||||
- `/Shared/Utilities/SharedErrorMessageParser.swift` - Error message parsing
|
||||
|
||||
### Documentation
|
||||
- `/Shared/SHARED_UTILITIES.md` - Complete usage guide
|
||||
- `/Shared/REFACTORING_SUMMARY.md` - This file
|
||||
|
||||
## Identified Repeated Patterns
|
||||
|
||||
### 1. Form Styling Pattern (43 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
Form {
|
||||
// content
|
||||
}
|
||||
.listStyle(.plain)
|
||||
.scrollContentBackground(.hidden)
|
||||
.background(Color.appBackgroundPrimary)
|
||||
|
||||
Section {
|
||||
// fields
|
||||
}
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
Form {
|
||||
Section {
|
||||
// fields
|
||||
}
|
||||
.sectionBackground()
|
||||
}
|
||||
.standardFormStyle()
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskFormView.swift
|
||||
- ProfileView.swift
|
||||
- LoginView.swift
|
||||
- AddResidenceView.swift
|
||||
- EditResidenceView.swift
|
||||
- AddDocumentView.swift
|
||||
- EditDocumentView.swift
|
||||
- NotificationPreferencesView.swift
|
||||
- ThemeSelectionView.swift
|
||||
|
||||
**Savings:** ~86 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 2. Date Formatting Pattern (27 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
let formatter = DateFormatter()
|
||||
formatter.dateFormat = "MMM d, yyyy"
|
||||
let dateString = formatter.string(from: date)
|
||||
|
||||
// or
|
||||
let formatter = DateFormatter()
|
||||
formatter.dateFormat = "yyyy-MM-dd"
|
||||
let date = formatter.date(from: string)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
let dateString = date.formatted() // "Jan 15, 2024"
|
||||
let apiDate = date.formattedAPI() // "2024-01-15"
|
||||
let date = "2024-01-15".toDate()
|
||||
let formatted = "2024-01-15".toFormattedDate()
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskFormView.swift (lines 502-504)
|
||||
- TaskCard.swift (line 58)
|
||||
- CompletionHistorySheet.swift
|
||||
- DocumentHelpers.swift
|
||||
- Multiple ViewModels
|
||||
|
||||
**Savings:** ~81 lines of code eliminated, centralized formatters improve performance
|
||||
|
||||
---
|
||||
|
||||
### 3. Loading State Pattern (18 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
ZStack {
|
||||
content
|
||||
.disabled(isLoading)
|
||||
.blur(radius: isLoading ? 3 : 0)
|
||||
|
||||
if isLoading {
|
||||
VStack(spacing: OrganicSpacing.comfortable) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(Color.appPrimary.opacity(0.1))
|
||||
.frame(width: 64, height: 64)
|
||||
ProgressView()
|
||||
.scaleEffect(1.2)
|
||||
.tint(Color.appPrimary)
|
||||
}
|
||||
Text("Loading...")
|
||||
.font(.system(size: 15, weight: .medium, design: .rounded))
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
}
|
||||
// ... 15 more lines
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.loadingOverlay(isLoading: viewModel.isLoading, message: "Loading...")
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskFormView.swift (lines 305-331)
|
||||
- ProfileView.swift (lines 18-31)
|
||||
- ResidenceDetailView.swift (lines 199-206)
|
||||
- DocumentFormView.swift
|
||||
|
||||
**Savings:** ~252 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 4. Number/Currency Formatting Pattern (15 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
// Converting Double to String
|
||||
let costString = estimatedCost != nil ? String(estimatedCost!.doubleValue) : ""
|
||||
|
||||
// Converting String to Double
|
||||
let cost = estimatedCost.isEmpty ? nil : Double(estimatedCost) ?? 0.0
|
||||
|
||||
// Format as currency
|
||||
let formatter = NumberFormatter()
|
||||
formatter.numberStyle = .currency
|
||||
return formatter.string(from: NSNumber(value: cost)) ?? "$\(cost)"
|
||||
|
||||
// Format file size
|
||||
var size = Double(bytes)
|
||||
let units = ["B", "KB", "MB", "GB"]
|
||||
var unitIndex = 0
|
||||
while size >= 1024 && unitIndex < units.count - 1 {
|
||||
size /= 1024
|
||||
unitIndex += 1
|
||||
}
|
||||
return String(format: "%.1f %@", size, units[unitIndex])
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
// Currency formatting
|
||||
let formatted = price.toCurrency() // "$1,234.56"
|
||||
|
||||
// File size formatting
|
||||
let size = bytes.toFileSize() // "1.2 MB"
|
||||
|
||||
// Decimal formatting
|
||||
let formatted = value.toDecimalString(fractionDigits: 2) // "1,234.56"
|
||||
|
||||
// Percentage
|
||||
let formatted = value.toPercentage() // "45.5%"
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- DocumentCard.swift (lines 91-102)
|
||||
- TaskFormView.swift (line 524, 561)
|
||||
- ContractorFormView.swift
|
||||
- ResidenceFormView.swift
|
||||
|
||||
**Savings:** ~60 lines of code eliminated, consistent formatting app-wide
|
||||
|
||||
---
|
||||
|
||||
### 5. Validation Pattern (22 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
if title.isEmpty {
|
||||
titleError = "Title is required"
|
||||
isValid = false
|
||||
} else {
|
||||
titleError = ""
|
||||
}
|
||||
|
||||
if email.isEmpty {
|
||||
return "Email is required"
|
||||
} else if !email.contains("@") {
|
||||
return "Invalid email"
|
||||
}
|
||||
|
||||
if password.count < 8 {
|
||||
return "Password must be at least 8 characters"
|
||||
}
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
// Single field validation
|
||||
let result = ValidationHelpers.validateEmail(email)
|
||||
if case .invalid(let message) = result {
|
||||
errorMessage = message
|
||||
}
|
||||
|
||||
// Form validation
|
||||
let validator = FormValidator()
|
||||
validator.add(fieldName: "email") {
|
||||
ValidationHelpers.validateEmail(email)
|
||||
}
|
||||
validator.add(fieldName: "password") {
|
||||
ValidationHelpers.validatePassword(password)
|
||||
}
|
||||
|
||||
let result = validator.validate()
|
||||
if !result.isValid {
|
||||
errorMessage = result.errors.values.first
|
||||
}
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskFormView.swift (lines 457-490)
|
||||
- LoginViewModel.swift
|
||||
- RegisterViewModel.swift
|
||||
- ProfileViewModel.swift
|
||||
- ContractorFormState.swift
|
||||
- ResidenceFormState.swift
|
||||
|
||||
**Savings:** ~132 lines of code eliminated, consistent error messages
|
||||
|
||||
---
|
||||
|
||||
### 6. Card Styling Pattern (35 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.padding(AppSpacing.md)
|
||||
.background(Color.appBackgroundSecondary)
|
||||
.cornerRadius(AppRadius.md)
|
||||
.shadow(color: Color.black.opacity(0.05), radius: 2, x: 0, y: 1)
|
||||
|
||||
// or organic variant
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.padding(OrganicSpacing.cozy)
|
||||
.background(OrganicCardBackground(showBlob: true, blobVariation: 1))
|
||||
.clipShape(RoundedRectangle(cornerRadius: 24, style: .continuous))
|
||||
.naturalShadow(.medium)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.standardCard()
|
||||
|
||||
// or organic variant
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.organicCardStyle()
|
||||
|
||||
// or list row
|
||||
HStack {
|
||||
// content
|
||||
}
|
||||
.listRowCard()
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskCard.swift (lines 198-202)
|
||||
- DocumentCard.swift (lines 81-84)
|
||||
- ContractorCard.swift (lines 85-88)
|
||||
- PropertyHeaderCard.swift
|
||||
- TaskSummaryCard.swift
|
||||
- ShareCodeCard.swift
|
||||
|
||||
**Savings:** ~140 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 7. Empty State Pattern (12 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
if items.isEmpty {
|
||||
VStack(spacing: 16) {
|
||||
Image(systemName: "tray")
|
||||
.font(.system(size: 60))
|
||||
.foregroundColor(Color.appTextSecondary.opacity(0.5))
|
||||
|
||||
Text("No Items")
|
||||
.font(.headline)
|
||||
.foregroundColor(Color.appTextPrimary)
|
||||
|
||||
Text("Get started by adding your first item")
|
||||
.font(.subheadline)
|
||||
.foregroundColor(Color.appTextSecondary)
|
||||
.multilineTextAlignment(.center)
|
||||
}
|
||||
.frame(maxWidth: .infinity, maxHeight: .infinity)
|
||||
.padding()
|
||||
}
|
||||
|
||||
// or organic variant
|
||||
VStack(spacing: 16) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(RadialGradient(...))
|
||||
.frame(width: 80, height: 80)
|
||||
Image(systemName: icon)
|
||||
.font(.system(size: 32, weight: .medium))
|
||||
.foregroundColor(accentColor.opacity(0.6))
|
||||
}
|
||||
// ... 25 more lines
|
||||
}
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
// Standard empty state
|
||||
if items.isEmpty {
|
||||
EmptyStateView(
|
||||
icon: "tray",
|
||||
title: "No Items",
|
||||
subtitle: "Get started by adding your first item",
|
||||
actionLabel: "Add Item",
|
||||
action: { showAddForm = true }
|
||||
)
|
||||
}
|
||||
|
||||
// Organic empty state
|
||||
OrganicEmptyState(
|
||||
icon: "checkmark.circle",
|
||||
title: "All Done!",
|
||||
subtitle: "You have no pending tasks"
|
||||
)
|
||||
|
||||
// List empty state
|
||||
ListEmptyState(
|
||||
icon: "tray",
|
||||
message: "No items to display"
|
||||
)
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- ResidenceDetailView.swift (lines 284-321)
|
||||
- DocumentsTabContent.swift
|
||||
- WarrantiesTabContent.swift
|
||||
- TasksSection.swift
|
||||
|
||||
**Savings:** ~180 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 8. Button Styling Pattern (28 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
Button(action: viewModel.login) {
|
||||
HStack(spacing: 8) {
|
||||
if viewModel.isLoading {
|
||||
ProgressView()
|
||||
.progressViewStyle(CircularProgressViewStyle(tint: .white))
|
||||
}
|
||||
Text(viewModel.isLoading ? "Signing In..." : "Log In")
|
||||
.font(.headline)
|
||||
.fontWeight(.semibold)
|
||||
}
|
||||
.frame(maxWidth: .infinity)
|
||||
.frame(height: 56)
|
||||
.foregroundColor(Color.appTextOnPrimary)
|
||||
.background(
|
||||
viewModel.isLoading || !isFormValid
|
||||
? Color.appTextSecondary
|
||||
: LinearGradient(...)
|
||||
)
|
||||
.cornerRadius(AppRadius.md)
|
||||
.shadow(...)
|
||||
}
|
||||
.disabled(!isFormValid || viewModel.isLoading)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
PrimaryButton(
|
||||
title: "Log In",
|
||||
icon: "arrow.right",
|
||||
isLoading: viewModel.isLoading,
|
||||
isDisabled: !isFormValid,
|
||||
action: { viewModel.login() }
|
||||
)
|
||||
|
||||
SecondaryButton(
|
||||
title: "Cancel",
|
||||
action: { dismiss() }
|
||||
)
|
||||
|
||||
DestructiveButton(
|
||||
title: "Delete",
|
||||
icon: "trash",
|
||||
action: { showConfirmation = true }
|
||||
)
|
||||
|
||||
CompactButton(
|
||||
title: "Edit",
|
||||
icon: "pencil",
|
||||
color: .appPrimary,
|
||||
action: { onEdit() }
|
||||
)
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- LoginView.swift (lines 222-226, 381-401)
|
||||
- TaskCard.swift (lines 122-144, 151-195)
|
||||
- ProfileView.swift (lines 133-145)
|
||||
- ResidenceDetailView.swift
|
||||
- DocumentFormView.swift
|
||||
|
||||
**Savings:** ~224 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 9. Error Handling Pattern (16 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
@State private var errorAlert: ErrorAlertInfo? = nil
|
||||
|
||||
.onChange(of: viewModel.errorMessage) { errorMessage in
|
||||
if let errorMessage = errorMessage, !errorMessage.isEmpty {
|
||||
errorAlert = ErrorAlertInfo(message: errorMessage)
|
||||
}
|
||||
}
|
||||
.errorAlert(
|
||||
error: errorAlert,
|
||||
onRetry: {
|
||||
errorAlert = nil
|
||||
submitForm()
|
||||
},
|
||||
onDismiss: {
|
||||
errorAlert = nil
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
Form {
|
||||
// content
|
||||
}
|
||||
.handleErrors(
|
||||
error: viewModel.errorMessage,
|
||||
onRetry: { viewModel.submitForm() }
|
||||
)
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- TaskFormView.swift (lines 368-387)
|
||||
- ProfileView.swift (lines 173-176)
|
||||
- ResidenceDetailView.swift (lines 180-183)
|
||||
- All ViewModels
|
||||
|
||||
**Savings:** ~128 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
### 10. Form Header Pattern (14 occurrences)
|
||||
|
||||
**Current Pattern:**
|
||||
```swift
|
||||
Section {
|
||||
VStack(spacing: OrganicSpacing.cozy) {
|
||||
ZStack {
|
||||
Circle()
|
||||
.fill(
|
||||
RadialGradient(
|
||||
colors: [
|
||||
Color.appPrimary.opacity(0.15),
|
||||
Color.appPrimary.opacity(0.05),
|
||||
Color.clear
|
||||
],
|
||||
center: .center,
|
||||
startRadius: 0,
|
||||
endRadius: 50
|
||||
)
|
||||
)
|
||||
.frame(width: 100, height: 100)
|
||||
|
||||
Image(systemName: "person.circle.fill")
|
||||
.font(.system(size: 56))
|
||||
.foregroundStyle(Color.appPrimary.gradient)
|
||||
}
|
||||
|
||||
Text("Profile Settings")
|
||||
.font(.system(size: 22, weight: .bold, design: .rounded))
|
||||
.foregroundColor(Color.appTextPrimary)
|
||||
}
|
||||
.frame(maxWidth: .infinity)
|
||||
.padding(.vertical)
|
||||
}
|
||||
.listRowBackground(Color.clear)
|
||||
```
|
||||
|
||||
**New Shared Pattern:**
|
||||
```swift
|
||||
FormHeaderSection {
|
||||
OrganicFormHeader(
|
||||
icon: "person.circle.fill",
|
||||
title: "Profile Settings",
|
||||
subtitle: "Manage your account information"
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Files to Refactor:**
|
||||
- ProfileView.swift (lines 34-64)
|
||||
- LoginView.swift (lines 52-85)
|
||||
- TaskFormView.swift
|
||||
- ResidenceFormView.swift
|
||||
|
||||
**Savings:** ~196 lines of code eliminated
|
||||
|
||||
---
|
||||
|
||||
## Total Impact
|
||||
|
||||
### Code Reduction
|
||||
- **Total lines eliminated:** ~1,479 lines
|
||||
- **Files affected:** 47 files
|
||||
- **Patterns replaced:** 10 major patterns
|
||||
|
||||
### Benefits
|
||||
1. **Maintainability:** Changes to UI patterns now require updating only ONE location
|
||||
2. **Consistency:** All screens use identical styling and behavior
|
||||
3. **Performance:** Centralized formatters are reused instead of recreated
|
||||
4. **Type Safety:** Validation helpers provide compile-time safety
|
||||
5. **Testing:** Shared utilities can be unit tested once
|
||||
6. **Onboarding:** New developers reference shared utilities documentation
|
||||
|
||||
## Naming Conflicts Discovered
|
||||
|
||||
The following files already exist and would conflict with shared utilities:
|
||||
|
||||
1. `/Helpers/DateUtils.swift` - Keep existing, use new `Date` extension methods or `DateFormatters.shared`
|
||||
2. `/Helpers/ErrorMessageParser.swift` - Keep existing enum, new struct is `SharedErrorMessageParser`
|
||||
3. `/Subviews/Common/ErrorMessageView.swift` - Keep existing, use `ErrorSection` for forms
|
||||
4. `/Documents/Components/EmptyStateView.swift` - Keep existing, new components have different APIs
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
### Phase 1: Non-Breaking Additions (Completed)
|
||||
- ✅ Create all shared utilities in `/Shared` directory
|
||||
- ✅ Document usage in `/Shared/SHARED_UTILITIES.md`
|
||||
- ✅ Verify build compiles successfully
|
||||
|
||||
### Phase 2: Gradual Adoption (Recommended)
|
||||
1. Start with new features - use shared utilities for all new code
|
||||
2. Refactor files during bug fixes - when touching a file, update it to use shared utilities
|
||||
3. Dedicated refactor sprints - allocate time to systematically update existing files
|
||||
|
||||
### Phase 3: Legacy Cleanup (Future)
|
||||
1. Once all files use shared utilities, remove duplicate code
|
||||
2. Delete legacy helper files that are no longer needed
|
||||
3. Update code review guidelines to require shared utilities
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Example 1: Refactoring a Form
|
||||
|
||||
**Before:**
|
||||
```swift
|
||||
Form {
|
||||
Section {
|
||||
TextField("Name", text: $name)
|
||||
}
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
|
||||
if let error = errorMessage {
|
||||
Section {
|
||||
HStack {
|
||||
Image(systemName: "exclamationmark.triangle.fill")
|
||||
.foregroundColor(Color.appError)
|
||||
Text(error)
|
||||
.foregroundColor(Color.appError)
|
||||
.font(.subheadline)
|
||||
}
|
||||
}
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
}
|
||||
|
||||
Section {
|
||||
Button(action: submit) {
|
||||
HStack {
|
||||
Spacer()
|
||||
if isLoading {
|
||||
ProgressView()
|
||||
} else {
|
||||
Text("Save")
|
||||
.fontWeight(.semibold)
|
||||
}
|
||||
Spacer()
|
||||
}
|
||||
}
|
||||
.disabled(isLoading)
|
||||
}
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
}
|
||||
.listStyle(.plain)
|
||||
.scrollContentBackground(.hidden)
|
||||
.background(Color.appBackgroundPrimary)
|
||||
```
|
||||
|
||||
**After:**
|
||||
```swift
|
||||
Form {
|
||||
Section {
|
||||
TextField("Name", text: $name)
|
||||
}
|
||||
.sectionBackground()
|
||||
|
||||
if let error = errorMessage {
|
||||
ErrorSection(message: error)
|
||||
}
|
||||
|
||||
FormActionButton(
|
||||
title: "Save",
|
||||
isLoading: isLoading,
|
||||
action: submit
|
||||
)
|
||||
}
|
||||
.standardFormStyle()
|
||||
```
|
||||
|
||||
**Savings:** 26 lines → 15 lines (42% reduction)
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Refactoring Date Handling
|
||||
|
||||
**Before:**
|
||||
```swift
|
||||
let dateFormatter = DateFormatter()
|
||||
dateFormatter.dateFormat = "yyyy-MM-dd"
|
||||
let dueDateString = dateFormatter.string(from: dueDate)
|
||||
|
||||
// Later...
|
||||
let formatter = DateFormatter()
|
||||
formatter.dateFormat = "MMM d, yyyy"
|
||||
let displayString = formatter.string(from: date)
|
||||
|
||||
// Later...
|
||||
if let date = formatter.date(from: apiString) {
|
||||
let isOverdue = date < Date()
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
```swift
|
||||
let dueDateString = dueDate.formattedAPI()
|
||||
|
||||
// Later...
|
||||
let displayString = date.formatted()
|
||||
|
||||
// Later...
|
||||
let isOverdue = apiString.isOverdue()
|
||||
```
|
||||
|
||||
**Savings:** 11 lines → 3 lines (73% reduction)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Refactoring Validation
|
||||
|
||||
**Before:**
|
||||
```swift
|
||||
func validateForm() -> Bool {
|
||||
var isValid = true
|
||||
|
||||
if title.isEmpty {
|
||||
titleError = "Title is required"
|
||||
isValid = false
|
||||
} else {
|
||||
titleError = ""
|
||||
}
|
||||
|
||||
if selectedCategory == nil {
|
||||
viewModel.errorMessage = "Please select a category"
|
||||
isValid = false
|
||||
}
|
||||
|
||||
if selectedFrequency == nil {
|
||||
viewModel.errorMessage = "Please select a frequency"
|
||||
isValid = false
|
||||
}
|
||||
|
||||
if selectedPriority == nil {
|
||||
viewModel.errorMessage = "Please select a priority"
|
||||
isValid = false
|
||||
}
|
||||
|
||||
return isValid
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
```swift
|
||||
func validateForm() -> Bool {
|
||||
let validator = FormValidator()
|
||||
|
||||
validator.add(fieldName: "title") {
|
||||
ValidationHelpers.validateRequired(title, fieldName: "Title")
|
||||
}
|
||||
|
||||
validator.add(fieldName: "category") {
|
||||
selectedCategory != nil ? .valid : .invalid("Please select a category")
|
||||
}
|
||||
|
||||
validator.add(fieldName: "frequency") {
|
||||
selectedFrequency != nil ? .valid : .invalid("Please select a frequency")
|
||||
}
|
||||
|
||||
validator.add(fieldName: "priority") {
|
||||
selectedPriority != nil ? .valid : .invalid("Please select a priority")
|
||||
}
|
||||
|
||||
let result = validator.validate()
|
||||
if !result.isValid {
|
||||
viewModel.errorMessage = result.errors.values.first
|
||||
}
|
||||
|
||||
return result.isValid
|
||||
}
|
||||
```
|
||||
|
||||
**Benefits:** While line count is similar, validation is now centralized, testable, and provides consistent error messages.
|
||||
|
||||
---
|
||||
|
||||
## Code Review Checklist
|
||||
|
||||
When reviewing new code, ensure:
|
||||
|
||||
- [ ] Uses `.standardFormStyle()` instead of manual form styling
|
||||
- [ ] Uses date extension methods instead of creating DateFormatter instances
|
||||
- [ ] Uses number extensions for currency/decimal formatting
|
||||
- [ ] Uses `ValidationHelpers` instead of inline validation
|
||||
- [ ] Uses shared button components instead of custom styled buttons
|
||||
- [ ] Uses shared empty state components instead of custom implementations
|
||||
- [ ] Uses `.loadingOverlay()` instead of manual loading state UI
|
||||
- [ ] Uses `.handleErrors()` instead of manual error alert handling
|
||||
- [ ] Uses card modifiers instead of manual card styling
|
||||
- [ ] References `/Shared/SHARED_UTILITIES.md` for examples
|
||||
|
||||
## Testing the Shared Utilities
|
||||
|
||||
All shared utilities compile successfully. To use them:
|
||||
|
||||
1. Import the file(s) you need (Swift automatically imports all files in the target)
|
||||
2. Use the extensions and components as documented in `/Shared/SHARED_UTILITIES.md`
|
||||
3. No breaking changes - existing code continues to work
|
||||
|
||||
Example test:
|
||||
```swift
|
||||
import SwiftUI
|
||||
|
||||
struct TestView: View {
|
||||
@State private var date = Date()
|
||||
|
||||
var body: some View {
|
||||
VStack {
|
||||
Text(date.formatted()) // Uses new extension
|
||||
Text(date.formattedLong())
|
||||
Text(date.relativeDescription)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Review this document** - Understand the patterns and shared utilities
|
||||
2. **Reference the usage guide** - Read `/Shared/SHARED_UTILITIES.md` for complete API documentation
|
||||
3. **Start using in new code** - Use shared utilities for all new features
|
||||
4. **Plan refactoring** - Schedule time to systematically update existing files
|
||||
5. **Update guidelines** - Add shared utilities to code review and onboarding checklists
|
||||
|
||||
## Questions or Issues?
|
||||
|
||||
If you encounter issues or have questions about the shared utilities:
|
||||
1. Check `/Shared/SHARED_UTILITIES.md` for usage examples
|
||||
2. Look at the implementation in the `/Shared` files
|
||||
3. The utilities are designed to be drop-in replacements for existing patterns
|
||||
|
||||
---
|
||||
|
||||
*Analysis completed: December 17, 2025*
|
||||
*Files analyzed: 86 Swift files*
|
||||
*Patterns identified: 10 major patterns, 266 total occurrences*
|
||||
@@ -1,578 +0,0 @@
|
||||
# Shared Utilities and Components
|
||||
|
||||
This directory contains DRY (Don't Repeat Yourself) utilities, extensions, and reusable components to eliminate code duplication across the iOS app.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
Shared/
|
||||
├── Extensions/ # Swift extensions for common types
|
||||
├── Components/ # Reusable UI components
|
||||
├── Modifiers/ # Custom view modifiers
|
||||
├── Utilities/ # Helper classes and utilities
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Extensions
|
||||
|
||||
### ViewExtensions.swift
|
||||
|
||||
**Form Styling:**
|
||||
- `.standardFormStyle()` - Applies consistent form styling (`.listStyle(.plain)`, `.scrollContentBackground(.hidden)`, `.background(Color.clear)`)
|
||||
- `.sectionBackground()` - Applies standard section background (`.listRowBackground(Color.appBackgroundSecondary)`)
|
||||
- `.headerSectionBackground()` - Applies clear background for header sections
|
||||
|
||||
**Loading States:**
|
||||
- `.loadingOverlay(isLoading: Bool, message: String)` - Shows loading overlay with optional message
|
||||
|
||||
**Conditional Modifiers:**
|
||||
- `.if(condition: Bool, transform:)` - Conditionally applies a modifier
|
||||
- `.if(condition: Bool, if:, else:)` - Applies one of two modifiers based on condition
|
||||
|
||||
**Utilities:**
|
||||
- `.ignoresSafeAreaAll()` - Ignores safe area for all edges
|
||||
- `.dismissKeyboardOnTap()` - Dismisses keyboard when tapped
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Form styling
|
||||
Form {
|
||||
// sections
|
||||
}
|
||||
.standardFormStyle()
|
||||
|
||||
Section {
|
||||
TextField("Name", text: $name)
|
||||
}
|
||||
.sectionBackground()
|
||||
|
||||
// Loading overlay
|
||||
VStack {
|
||||
// content
|
||||
}
|
||||
.loadingOverlay(isLoading: viewModel.isLoading)
|
||||
|
||||
// Conditional styling
|
||||
Text("Hello")
|
||||
.if(isHighlighted) { view in
|
||||
view.foregroundColor(.red)
|
||||
}
|
||||
```
|
||||
|
||||
### DateExtensions.swift
|
||||
|
||||
**Date Formatting:**
|
||||
- `.formatted()` - "MMM d, yyyy" (e.g., "Jan 15, 2024")
|
||||
- `.formattedLong()` - "MMMM d, yyyy" (e.g., "January 15, 2024")
|
||||
- `.formattedShort()` - "MM/dd/yyyy" (e.g., "01/15/2024")
|
||||
- `.formattedAPI()` - "yyyy-MM-dd" (API format)
|
||||
|
||||
**Date Properties:**
|
||||
- `.isPast` - Checks if date is in the past
|
||||
- `.isToday` - Checks if date is today
|
||||
- `.isTomorrow` - Checks if date is tomorrow
|
||||
- `.daysFromToday` - Returns number of days from today
|
||||
- `.relativeDescription` - Returns "Today", "Tomorrow", "In 3 days", etc.
|
||||
|
||||
**String to Date:**
|
||||
- `String.toDate()` - Converts API date string to Date
|
||||
- `String.toFormattedDate()` - Converts API date string to formatted display string
|
||||
- `String.isOverdue()` - Checks if date string represents an overdue date
|
||||
|
||||
**Centralized Formatters:**
|
||||
- `DateFormatters.shared.mediumDate`
|
||||
- `DateFormatters.shared.longDate`
|
||||
- `DateFormatters.shared.shortDate`
|
||||
- `DateFormatters.shared.apiDate`
|
||||
- `DateFormatters.shared.time`
|
||||
- `DateFormatters.shared.dateTime`
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Format dates
|
||||
let date = Date()
|
||||
let formatted = date.formatted() // "Jan 15, 2024"
|
||||
let long = date.formattedLong() // "January 15, 2024"
|
||||
let api = date.formattedAPI() // "2024-01-15"
|
||||
|
||||
// Check date properties
|
||||
if date.isPast {
|
||||
print("Date is in the past")
|
||||
}
|
||||
|
||||
let description = date.relativeDescription // "Today", "Tomorrow", etc.
|
||||
|
||||
// Convert string to date
|
||||
let dateString = "2024-01-15"
|
||||
let date = dateString.toDate()
|
||||
let formatted = dateString.toFormattedDate()
|
||||
```
|
||||
|
||||
### StringExtensions.swift
|
||||
|
||||
**String Utilities:**
|
||||
- `.isBlank` - Checks if string is empty or whitespace
|
||||
- `.nilIfBlank` - Returns nil if blank, otherwise trimmed string
|
||||
- `.capitalizedFirst` - Capitalizes first letter only
|
||||
- `.truncated(to: length)` - Truncates string with ellipsis
|
||||
|
||||
**Validation:**
|
||||
- `.isValidEmail` - Validates email format
|
||||
- `.isValidPhone` - Validates phone number (basic)
|
||||
|
||||
**Optional String:**
|
||||
- `Optional<String>.isNilOrBlank` - Checks if nil or blank
|
||||
- `Optional<String>.nilIfBlank` - Returns nil if blank
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
let email = " john@example.com "
|
||||
if !email.isBlank {
|
||||
let trimmed = email.nilIfBlank // "john@example.com"
|
||||
}
|
||||
|
||||
if email.isValidEmail {
|
||||
print("Valid email")
|
||||
}
|
||||
|
||||
let text = "This is a very long text"
|
||||
let short = text.truncated(to: 10) // "This is a..."
|
||||
|
||||
// Optional strings
|
||||
let optional: String? = " "
|
||||
if optional.isNilOrBlank {
|
||||
print("String is nil or blank")
|
||||
}
|
||||
```
|
||||
|
||||
### DoubleExtensions.swift
|
||||
|
||||
**Number Formatting:**
|
||||
- `.toCurrency()` - "$1,234.56"
|
||||
- `.toCurrencyString(currencyCode:)` - Currency with custom code
|
||||
- `.toDecimalString(fractionDigits:)` - "1,234.56"
|
||||
- `.toPercentage(fractionDigits:)` - "45.5%"
|
||||
- `.toFileSize()` - "1.2 MB"
|
||||
- `.rounded(to: places)` - Rounds to decimal places
|
||||
|
||||
**Int Extensions:**
|
||||
- `.toFormattedString()` - "1,234"
|
||||
- `.toFileSize()` - "1.2 MB"
|
||||
- `.pluralSuffix(singular, plural)` - Returns plural suffix
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
let price = 1234.56
|
||||
let formatted = price.toCurrency() // "$1,234.56"
|
||||
|
||||
let percent = 45.5
|
||||
let formatted = percent.toPercentage() // "45.5%"
|
||||
|
||||
let bytes = 1024000.0
|
||||
let size = bytes.toFileSize() // "1.0 MB"
|
||||
|
||||
let count = 5
|
||||
let text = "\(count) item\(count.pluralSuffix())" // "5 items"
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### FormComponents.swift
|
||||
|
||||
**Form Header:**
|
||||
- `FormHeaderSection` - Standard header with clear background
|
||||
- `FormHeader` - Header with icon, title, subtitle
|
||||
- `OrganicFormHeader` - Organic styled header with gradient
|
||||
|
||||
**Form Sections:**
|
||||
- `IconFormSection` - Section with icon header
|
||||
- `ErrorSection` - Displays error messages
|
||||
- `SuccessSection` - Displays success messages
|
||||
- `FormActionButton` - Action button section
|
||||
|
||||
**Form Fields:**
|
||||
- `IconTextField` - Text field with icon
|
||||
- `FieldLabel` - Standard field label with optional required indicator
|
||||
- `FieldError` - Error message display
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
Form {
|
||||
// Header
|
||||
FormHeaderSection {
|
||||
FormHeader(
|
||||
icon: "house.fill",
|
||||
title: "Add Property",
|
||||
subtitle: "Enter property details"
|
||||
)
|
||||
}
|
||||
|
||||
// Field section
|
||||
IconFormSection(icon: "envelope.fill", title: "Contact") {
|
||||
TextField("Email", text: $email)
|
||||
}
|
||||
|
||||
// Error display
|
||||
if let error = viewModel.errorMessage {
|
||||
ErrorSection(message: error)
|
||||
}
|
||||
|
||||
// Action button
|
||||
FormActionButton(
|
||||
title: "Save",
|
||||
isLoading: viewModel.isLoading,
|
||||
action: { viewModel.save() }
|
||||
)
|
||||
}
|
||||
.standardFormStyle()
|
||||
```
|
||||
|
||||
### EmptyStateView.swift
|
||||
|
||||
**Empty State Components:**
|
||||
- `EmptyStateView` - Standard empty state with icon, title, subtitle, optional action
|
||||
- `OrganicEmptyState` - Organic styled empty state with blob background
|
||||
- `ListEmptyState` - Compact empty state for lists
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Standard empty state
|
||||
if items.isEmpty {
|
||||
EmptyStateView(
|
||||
icon: "house",
|
||||
title: "No Properties",
|
||||
subtitle: "Add your first property to get started",
|
||||
actionLabel: "Add Property",
|
||||
action: { showAddProperty = true }
|
||||
)
|
||||
}
|
||||
|
||||
// Organic empty state
|
||||
OrganicEmptyState(
|
||||
icon: "checkmark.circle",
|
||||
title: "All Done!",
|
||||
subtitle: "You have no pending tasks"
|
||||
)
|
||||
|
||||
// List empty state
|
||||
ListEmptyState(
|
||||
icon: "tray",
|
||||
message: "No items to display"
|
||||
)
|
||||
```
|
||||
|
||||
### ButtonStyles.swift
|
||||
|
||||
**Button Components:**
|
||||
- `PrimaryButton` - Filled primary button
|
||||
- `SecondaryButton` - Outlined secondary button
|
||||
- `DestructiveButton` - Red destructive button
|
||||
- `TextButton` - Text-only button
|
||||
- `CompactButton` - Compact button for cards/rows
|
||||
- `OrganicPrimaryButton` - Primary button with gradient and shadow
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Primary button
|
||||
PrimaryButton(
|
||||
title: "Save Changes",
|
||||
icon: "checkmark",
|
||||
isLoading: viewModel.isLoading,
|
||||
isDisabled: !isValid,
|
||||
action: { viewModel.save() }
|
||||
)
|
||||
|
||||
// Secondary button
|
||||
SecondaryButton(
|
||||
title: "Cancel",
|
||||
action: { dismiss() }
|
||||
)
|
||||
|
||||
// Destructive button
|
||||
DestructiveButton(
|
||||
title: "Delete",
|
||||
icon: "trash",
|
||||
action: { showConfirmation = true }
|
||||
)
|
||||
|
||||
// Compact button (for cards)
|
||||
HStack {
|
||||
CompactButton(
|
||||
title: "Edit",
|
||||
icon: "pencil",
|
||||
color: .appPrimary,
|
||||
action: { onEdit() }
|
||||
)
|
||||
|
||||
CompactButton(
|
||||
title: "Delete",
|
||||
icon: "trash",
|
||||
color: .appError,
|
||||
isDestructive: true,
|
||||
action: { onDelete() }
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
## Modifiers
|
||||
|
||||
### CardModifiers.swift
|
||||
|
||||
**Card Styling:**
|
||||
- `.standardCard()` - Standard card with background, radius, padding, shadow
|
||||
- `.compactCard()` - Compact card with smaller padding
|
||||
- `.organicCardStyle()` - Organic card with blob background
|
||||
- `.listRowCard()` - Card styling for list rows
|
||||
- `.metadataPill()` - Pill styling for tags/badges
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Standard card
|
||||
VStack {
|
||||
Text("Content")
|
||||
}
|
||||
.standardCard()
|
||||
|
||||
// Compact card
|
||||
HStack {
|
||||
Text("Row")
|
||||
}
|
||||
.compactCard()
|
||||
|
||||
// Organic card
|
||||
VStack {
|
||||
Text("Feature")
|
||||
}
|
||||
.organicCardStyle(
|
||||
accentColor: .appPrimary,
|
||||
showBlob: true,
|
||||
shadowIntensity: .medium
|
||||
)
|
||||
|
||||
// Metadata pill
|
||||
Text("High Priority")
|
||||
.metadataPill(
|
||||
backgroundColor: .appError,
|
||||
foregroundColor: .white,
|
||||
borderColor: .appError
|
||||
)
|
||||
```
|
||||
|
||||
## Utilities
|
||||
|
||||
### ValidationHelpers.swift
|
||||
|
||||
**Validation Methods:**
|
||||
- `validateEmail(_:)` - Email validation
|
||||
- `validatePassword(_:minLength:)` - Password validation
|
||||
- `validatePasswordConfirmation(_:confirmation:)` - Password match
|
||||
- `validateName(_:fieldName:)` - Name validation
|
||||
- `validatePhone(_:)` - Phone validation
|
||||
- `validateRequired(_:fieldName:)` - Required field
|
||||
- `validateNumber(_:fieldName:min:max:)` - Number validation
|
||||
- `validateInteger(_:fieldName:min:max:)` - Integer validation
|
||||
- `validateURL(_:)` - URL validation
|
||||
- `validateCustom(_:fieldName:validator:errorMessage:)` - Custom validation
|
||||
|
||||
**FormValidator Class:**
|
||||
```swift
|
||||
let validator = FormValidator()
|
||||
|
||||
validator.add(fieldName: "email") {
|
||||
ValidationHelpers.validateEmail(email)
|
||||
}
|
||||
|
||||
validator.add(fieldName: "password") {
|
||||
ValidationHelpers.validatePassword(password, minLength: 8)
|
||||
}
|
||||
|
||||
let result = validator.validate()
|
||||
if result.isValid {
|
||||
// Submit form
|
||||
} else {
|
||||
// Display errors
|
||||
for (field, error) in result.errors {
|
||||
print("\(field): \(error)")
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Single field validation
|
||||
let emailResult = ValidationHelpers.validateEmail(email)
|
||||
if case .invalid(let message) = emailResult {
|
||||
errorMessage = message
|
||||
}
|
||||
|
||||
// Form validation
|
||||
func validateForm() -> Bool {
|
||||
let validator = FormValidator()
|
||||
|
||||
validator.add(fieldName: "email") {
|
||||
ValidationHelpers.validateEmail(email)
|
||||
}
|
||||
|
||||
validator.add(fieldName: "password") {
|
||||
ValidationHelpers.validatePassword(password)
|
||||
}
|
||||
|
||||
let result = validator.validate()
|
||||
if !result.isValid {
|
||||
// Display first error
|
||||
errorMessage = result.errors.values.first
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
```
|
||||
|
||||
### ErrorMessageParser.swift
|
||||
|
||||
**Error Parsing:**
|
||||
- `ErrorMessageParser.parse(_: String)` - Parses error messages to user-friendly format
|
||||
- `ErrorMessageParser.parse(_: Error)` - Parses Error objects
|
||||
- `ErrorMessageParser.isNetworkError(_:)` - Checks if network error
|
||||
- `ErrorMessageParser.isAuthError(_:)` - Checks if authentication error
|
||||
|
||||
**Common Error Messages:**
|
||||
- `ErrorMessages.networkError`
|
||||
- `ErrorMessages.unknownError`
|
||||
- `ErrorMessages.timeoutError`
|
||||
- `ErrorMessages.serverError`
|
||||
- `ErrorMessages.unauthorizedError`
|
||||
- `ErrorMessages.required(_:)` - Required field message
|
||||
- `ErrorMessages.invalid(_:)` - Invalid field message
|
||||
- `ErrorMessages.tooShort(_:minLength:)` - Too short message
|
||||
- `ErrorMessages.tooLong(_:maxLength:)` - Too long message
|
||||
|
||||
**Usage Examples:**
|
||||
|
||||
```swift
|
||||
// Parse API error
|
||||
let apiError = "401 Unauthorized: Invalid token"
|
||||
let userFriendly = ErrorMessageParser.parse(apiError)
|
||||
// Returns: "Your session has expired. Please log in again."
|
||||
|
||||
// Parse Error object
|
||||
do {
|
||||
try await someAPICall()
|
||||
} catch {
|
||||
let message = ErrorMessageParser.parse(error)
|
||||
showError(message)
|
||||
}
|
||||
|
||||
// Check error type
|
||||
if ErrorMessageParser.isNetworkError(errorMessage) {
|
||||
// Show retry button
|
||||
}
|
||||
|
||||
// Use common messages
|
||||
errorMessage = ErrorMessages.required("Email")
|
||||
// Returns: "Email is required"
|
||||
```
|
||||
|
||||
## Migration Guide
|
||||
|
||||
### Before (Old Pattern)
|
||||
|
||||
```swift
|
||||
// Old form styling
|
||||
Form {
|
||||
Section {
|
||||
TextField("Name", text: $name)
|
||||
}
|
||||
.listRowBackground(Color.appBackgroundSecondary)
|
||||
}
|
||||
.listStyle(.plain)
|
||||
.scrollContentBackground(.hidden)
|
||||
.background(Color.appBackgroundPrimary)
|
||||
|
||||
// Old date formatting
|
||||
let formatter = DateFormatter()
|
||||
formatter.dateFormat = "MMM d, yyyy"
|
||||
let dateString = formatter.string(from: date)
|
||||
|
||||
// Old validation
|
||||
if email.isEmpty {
|
||||
errorMessage = "Email is required"
|
||||
} else if !email.contains("@") {
|
||||
errorMessage = "Invalid email"
|
||||
}
|
||||
|
||||
// Old card styling
|
||||
VStack {
|
||||
Text("Content")
|
||||
}
|
||||
.padding(16)
|
||||
.background(Color.appBackgroundSecondary)
|
||||
.cornerRadius(12)
|
||||
.shadow(color: .black.opacity(0.1), radius: 4, y: 2)
|
||||
```
|
||||
|
||||
### After (New Pattern)
|
||||
|
||||
```swift
|
||||
// New form styling
|
||||
Form {
|
||||
Section {
|
||||
TextField("Name", text: $name)
|
||||
}
|
||||
.sectionBackground()
|
||||
}
|
||||
.standardFormStyle()
|
||||
|
||||
// New date formatting
|
||||
let dateString = date.formatted()
|
||||
|
||||
// New validation
|
||||
let result = ValidationHelpers.validateEmail(email)
|
||||
if case .invalid(let message) = result {
|
||||
errorMessage = message
|
||||
}
|
||||
|
||||
// New card styling
|
||||
VStack {
|
||||
Text("Content")
|
||||
}
|
||||
.standardCard()
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Always use shared extensions** instead of creating local formatters
|
||||
2. **Use validation helpers** for consistent error messages
|
||||
3. **Apply view modifiers** instead of manual styling
|
||||
4. **Use shared components** for common UI patterns
|
||||
5. **Parse error messages** for user-friendly display
|
||||
6. **Reference this README** when creating new UI components
|
||||
|
||||
## Testing
|
||||
|
||||
All shared utilities should be tested before using in production. Run the iOS app build to verify:
|
||||
|
||||
```bash
|
||||
cd /Users/treyt/Desktop/code/HoneyDue/HoneyDueKMM
|
||||
open iosApp/iosApp.xcodeproj
|
||||
# Build and run (Cmd+R)
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
When adding new shared utilities:
|
||||
|
||||
1. Place in appropriate directory (Extensions, Components, Modifiers, or Utilities)
|
||||
2. Add comprehensive documentation with usage examples
|
||||
3. Update this README
|
||||
4. Test thoroughly before committing
|
||||
5. Refactor existing code to use the new utility
|
||||
@@ -1,97 +0,0 @@
|
||||
# iOS Subviews
|
||||
|
||||
This folder contains all reusable SwiftUI view components, organized by feature area. Each file contains **exactly one view** with its own preview.
|
||||
|
||||
## 📁 Folder Structure
|
||||
|
||||
```
|
||||
Subviews/
|
||||
├── Common/ (Shared UI components)
|
||||
├── Auth/ (Login/Register components)
|
||||
├── Residence/ (Property-related components)
|
||||
└── Task/ (Task-related components)
|
||||
```
|
||||
|
||||
## 📋 Component List
|
||||
|
||||
### Common (2 components)
|
||||
- **ErrorView.swift** - Full-screen error display with retry button
|
||||
- **ErrorMessageView.swift** - Inline error message with dismiss button
|
||||
|
||||
### Auth (2 components)
|
||||
- **LoginHeader.swift** - App logo and title for login screen
|
||||
- **RegisterHeader.swift** - Icon and welcome text for registration
|
||||
|
||||
### Residence (7 components)
|
||||
- **SummaryCard.swift** - Overview card with property/task statistics
|
||||
- **SummaryStatView.swift** - Individual stat display (icon, value, label)
|
||||
- **ResidenceCard.swift** - Property card with address and task summary
|
||||
- **TaskStatChip.swift** - Small chip showing task count by status
|
||||
- **EmptyResidencesView.swift** - Empty state for no properties
|
||||
- **PropertyHeaderCard.swift** - Detailed property header with address
|
||||
- **PropertyDetailItem.swift** - Small property detail (beds, baths, sqft)
|
||||
|
||||
### Task (6 components)
|
||||
- **TaskPill.swift** - Small colored pill showing task counts
|
||||
- **StatusBadge.swift** - Task status badge (pending, in progress, etc.)
|
||||
- **PriorityBadge.swift** - Task priority badge (high, medium, low)
|
||||
- **EmptyTasksView.swift** - Empty state for no tasks
|
||||
- **TaskCard.swift** - Full task card with all details and actions
|
||||
- **TasksSection.swift** - Complete tasks section with cancelled tasks
|
||||
|
||||
## 🎨 Preview Support
|
||||
|
||||
Every component includes a `#Preview` for easy testing in Xcode Canvas.
|
||||
|
||||
## ✅ Adding to Xcode Project
|
||||
|
||||
**IMPORTANT**: These files need to be added to the Xcode project to compile.
|
||||
|
||||
### Steps:
|
||||
1. Open `iosApp.xcodeproj` in Xcode
|
||||
2. Right-click the `iosApp` folder in Project Navigator
|
||||
3. Select **"Add Files to 'iosApp'..."**
|
||||
4. Navigate to and select the entire **`Subviews`** folder
|
||||
5. Make sure:
|
||||
- ✅ "Create groups" is selected (NOT "Create folder references")
|
||||
- ✅ "Add to targets: iosApp" is checked
|
||||
- ❌ "Copy items if needed" is UNchecked
|
||||
6. Click **"Add"**
|
||||
|
||||
### Verify
|
||||
Build the project (⌘+B). All 17 subview files should compile successfully.
|
||||
|
||||
## 🗑️ Old Files to Delete
|
||||
|
||||
Delete these consolidated files from the root `iosApp` directory:
|
||||
- ❌ `AuthSubviews.swift`
|
||||
- ❌ `CommonSubviews.swift`
|
||||
- ❌ `ResidenceSubviews.swift`
|
||||
- ❌ `TaskSubviews.swift`
|
||||
- ❌ `DELETE_THESE_FILES.txt`
|
||||
|
||||
These were temporary files and have been replaced by the individual files in this `Subviews` folder.
|
||||
|
||||
## 📝 Usage
|
||||
|
||||
All main views (LoginView, ResidencesListView, ResidenceDetailView, etc.) have already been updated to use these subviews. The components are automatically available once added to the Xcode project.
|
||||
|
||||
Example:
|
||||
```swift
|
||||
import SwiftUI
|
||||
|
||||
struct MyView: View {
|
||||
var body: some View {
|
||||
VStack {
|
||||
LoginHeader() // Automatically available
|
||||
ErrorMessageView(message: "Error", onDismiss: {})
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Total Components**: 17 individual view files
|
||||
**Total Previews**: 17 (one per file)
|
||||
**Organization**: Feature-based folder structure
|
||||
Reference in New Issue
Block a user