Expand CLAUDE.md with comprehensive inline documentation #995
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| #!/bin/bash | ||
|
|
||
| # This script is to be used by LLMs and AI agents to build the Iterable Swift SDK on macOS. | ||
| # It uses xcpretty to format the build output and only shows errors. | ||
| # It also checks if the build is successful and exits with the correct status. | ||
|
|
||
| # Check if running on macOS | ||
| if [[ "$(uname)" != "Darwin" ]]; then | ||
| echo "❌ This script requires macOS to run Xcode builds" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Make sure xcpretty is installed | ||
| if ! command -v xcpretty &> /dev/null; then | ||
| echo "xcpretty not found, installing via gem..." | ||
| sudo gem install xcpretty | ||
| fi | ||
|
|
||
| echo "Building Iterable Swift SDK..." | ||
|
|
||
| # Create a temporary file for the build output | ||
| TEMP_OUTPUT=$(mktemp) | ||
|
|
||
| # Run the build and capture all output | ||
| xcodebuild \ | ||
| -project swift-sdk.xcodeproj \ | ||
| -scheme "swift-sdk" \ | ||
| -configuration Debug \ | ||
| -sdk iphonesimulator \ | ||
| build > $TEMP_OUTPUT 2>&1 | ||
|
|
||
| # Check the exit status | ||
| BUILD_STATUS=$? | ||
|
|
||
| # Show errors and warnings if build failed | ||
| if [ $BUILD_STATUS -eq 0 ]; then | ||
| echo "✅ Iterable SDK build succeeded!" | ||
| else | ||
| echo "❌ Iterable SDK build failed with status $BUILD_STATUS" | ||
| echo "" | ||
| echo "🔍 Build errors:" | ||
| grep -E 'error:|fatal:' $TEMP_OUTPUT | head -10 | ||
| echo "" | ||
| echo "⚠️ Build warnings:" | ||
| grep -E 'warning:' $TEMP_OUTPUT | head -5 | ||
| fi | ||
|
|
||
| # Remove the temporary file | ||
| rm $TEMP_OUTPUT | ||
|
|
||
| exit $BUILD_STATUS |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Check if running on macOS | ||
| if [[ "$(uname)" != "Darwin" ]]; then | ||
| echo "❌ This script requires macOS to run Xcode tests" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Parse command line arguments | ||
| FILTER="" | ||
| LIST_TESTS=false | ||
|
|
||
| if [[ $# -eq 1 ]]; then | ||
| if [[ "$1" == "--list" ]]; then | ||
| LIST_TESTS=true | ||
| else | ||
| FILTER="$1" | ||
| echo "🎯 Running tests with filter: $FILTER" | ||
| fi | ||
| elif [[ $# -gt 1 ]]; then | ||
| echo "❌ Usage: $0 [filter|--list]" | ||
| echo " filter: Test suite name (e.g., 'IterableApiCriteriaFetchTests')" | ||
| echo " or specific test (e.g., 'IterableApiCriteriaFetchTests.testForegroundCriteriaFetchWhenConditionsMet')" | ||
| echo " or full path (e.g., 'unit-tests/IterableApiCriteriaFetchTests/testForegroundCriteriaFetchWhenConditionsMet')" | ||
| echo " --list: List all available test suites and tests" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Handle test listing | ||
| if [[ "$LIST_TESTS" == true ]]; then | ||
| echo "📋 Listing available test suites..." | ||
|
|
||
| # Use grep to extract test class names from source files | ||
| echo "📦 Available Test Suites:" | ||
| find tests/unit-tests -name "*.swift" -exec basename {} .swift \; | sort | while read test_file; do | ||
| # Count test methods in each file | ||
| test_count=$(grep -c "func test" "tests/unit-tests/$test_file.swift" 2>/dev/null || echo "0") | ||
| echo " • $test_file ($test_count tests)" | ||
| done | ||
|
|
||
| echo "" | ||
| echo "🔍 Example Usage:" | ||
| echo " ./agent_test.sh AuthTests" | ||
| echo " ./agent_test.sh \"AuthTests.testAsyncAuthTokenRetrieval\"" | ||
| echo "" | ||
| echo "💡 To see specific test methods in a suite, check the source file:" | ||
| echo " grep 'func test' tests/unit-tests/AuthTests.swift" | ||
|
|
||
| exit 0 | ||
| fi | ||
|
|
||
| # Make sure xcpretty is installed | ||
| if ! command -v xcpretty &> /dev/null; then | ||
| echo "xcpretty not found, installing via gem..." | ||
| sudo gem install xcpretty | ||
| fi | ||
|
|
||
| echo "Running Iterable Swift SDK unit tests..." | ||
|
|
||
| # Create a temporary file for the test output | ||
| TEMP_OUTPUT=$(mktemp) | ||
|
|
||
| # Build the xcodebuild command | ||
| XCODEBUILD_CMD="xcodebuild test \ | ||
| -project swift-sdk.xcodeproj \ | ||
| -scheme swift-sdk \ | ||
| -sdk iphonesimulator \ | ||
| -destination 'platform=iOS Simulator,name=iPhone 16 Pro,OS=18.2' \ | ||
| -enableCodeCoverage YES \ | ||
| -skipPackagePluginValidation \ | ||
| CODE_SIGNING_REQUIRED=NO" | ||
|
|
||
| # Add filter if specified | ||
| if [[ -n "$FILTER" ]]; then | ||
| # If filter contains a slash, use it as-is (already in unit-tests/TestSuite/testMethod format) | ||
| if [[ "$FILTER" == *"/"* ]]; then | ||
| XCODEBUILD_CMD="$XCODEBUILD_CMD -only-testing:$FILTER" | ||
| # If filter contains a dot, convert TestSuite.testMethod to unit-tests/TestSuite/testMethod | ||
| elif [[ "$FILTER" == *"."* ]]; then | ||
| TEST_SUITE=$(echo "$FILTER" | cut -d'.' -f1) | ||
| TEST_METHOD=$(echo "$FILTER" | cut -d'.' -f2) | ||
| XCODEBUILD_CMD="$XCODEBUILD_CMD -only-testing:unit-tests/$TEST_SUITE/$TEST_METHOD" | ||
| # Otherwise, assume it's just a test suite name and add the target | ||
| else | ||
| XCODEBUILD_CMD="$XCODEBUILD_CMD -only-testing:unit-tests/$FILTER" | ||
| fi | ||
| fi | ||
|
|
||
| # Run the tests with xcpretty for clean output (incremental - skips rebuild if possible) | ||
| eval $XCODEBUILD_CMD 2>&1 | tee $TEMP_OUTPUT | xcpretty | ||
|
|
||
| # Check the exit status | ||
| TEST_STATUS=$? | ||
|
|
||
| # Parse the "Executed X test(s), with Y failure(s)" line | ||
| EXECUTED_LINE=$(grep "Executed.*test.*with.*failure" $TEMP_OUTPUT | tail -1) | ||
| if [[ -n "$EXECUTED_LINE" ]]; then | ||
| TOTAL_TESTS=$(echo "$EXECUTED_LINE" | sed -n 's/.*Executed \([0-9][0-9]*\) test.*/\1/p') | ||
| FAILED_TESTS=$(echo "$EXECUTED_LINE" | sed -n 's/.*with \([0-9][0-9]*\) failure.*/\1/p') | ||
|
|
||
| # Ensure we have valid numbers | ||
| if [[ -z "$TOTAL_TESTS" ]]; then TOTAL_TESTS=0; fi | ||
| if [[ -z "$FAILED_TESTS" ]]; then FAILED_TESTS=0; fi | ||
|
|
||
| PASSED_TESTS=$(($TOTAL_TESTS - $FAILED_TESTS)) | ||
| else | ||
| TOTAL_TESTS=0 | ||
| FAILED_TESTS=0 | ||
| PASSED_TESTS=0 | ||
| fi | ||
|
|
||
| # Show test results | ||
| if [ "$FAILED_TESTS" -eq 0 ] && [ "$TOTAL_TESTS" -gt 0 ]; then | ||
| echo "✅ All tests passed! ($TOTAL_TESTS tests)" | ||
| FINAL_STATUS=0 | ||
| elif [ "$FAILED_TESTS" -gt 0 ]; then | ||
| echo "❌ Tests failed: $FAILED_TESTS failed, $PASSED_TESTS passed ($TOTAL_TESTS total)" | ||
| FINAL_STATUS=1 | ||
| else | ||
| echo "⚠️ No test results found" | ||
| FINAL_STATUS=$TEST_STATUS | ||
| fi | ||
|
|
||
| # Remove the temporary file | ||
| rm $TEMP_OUTPUT | ||
|
|
||
| exit $FINAL_STATUS |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably good to add Public facing methods go in IterableApi.swift class. Its implementation is in ApiClient.swift class.