Add Claude Code configuration and update dependencies for Ruby 3.4 compatibility

jguz-pubnub · jguz-pubnub · commit 3b355928f33a · 2026-01-19T14:15:26.000+01:00
diff --git a/.claude/settings.json b/.claude/settings.json
@@ -0,0 +1,25 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(swift build:*)",
+      "Bash(swift package:*)",
+      "Bash(swift test:*)",
+      "Bash(xcodebuild:*)",
+      "Bash(xcrun simctl:*)",
+      "Bash(bundle exec fastlane:*)",
+      "Bash(bundle install)",
+      "Bash(bundle update:*)",
+      "Bash(gem list:*)",
+      "Bash(gem search:*)",
+      "Bash(swiftlint:*)",
+      "Bash(swiftformat:*)",
+      "Bash(git status:*)",
+      "Bash(git diff:*)",
+      "Bash(git log:*)",
+      "Bash(git branch:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git stash:*)"
+    ]
+  }
+}
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -0,0 +1,130 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Repository Overview
+
+PubNub Swift Chat SDK - A Swift wrapper providing idiomatic iOS/macOS/tvOS APIs for real-time chat functionality. The SDK wraps the Kotlin Multiplatform (KMP) Chat SDK core via the `PubNubChat` dependency.
+
+**Requirements:** iOS 14+, macOS 11+, tvOS 14+, Xcode 15+, Swift 5+
+
+## Build Commands
+
+```bash
+# Build with Swift Package Manager
+swift build
+
+# Build with Xcode
+xcodebuild -workspace PubNubSwiftChatSDK.xcworkspace -scheme PubNubSwiftChatSDK build
+
+# Resolve package dependencies
+swift package resolve
+```
+
+## Testing
+
+Tests are integration tests that require PubNub API keys.
+
+### Running Tests Locally
+
+1. Configure test credentials in `Tests/PubNubSwiftChatSDKTests.plist`:
+   ```xml
+   <key>publishKey</key>
+   <string>YOUR_PUBLISH_KEY</string>
+   <key>subscribeKey</key>
+   <string>YOUR_SUBSCRIBE_KEY</string>
+   ```
+
+2. Run tests:
+   ```bash
+   # Via Xcode (recommended)
+   xcodebuild test -workspace PubNubSwiftChatSDK.xcworkspace \
+     -scheme PubNubSwiftChatSDK \
+     -destination 'platform=iOS Simulator,name=iPhone 15'
+
+   # Via fastlane (requires Ruby/Bundler and env vars)
+   export SDK_PUB_KEY="your_key"
+   export SDK_SUB_KEY="your_key"
+   bundle exec fastlane test --env ios
+   ```
+
+### Test Schemes
+
+- `PubNubSwiftChatSDK` - Main SDK scheme
+- `PubNubSwiftChatSDKTests` - Closure-based integration tests
+- `PubNubSwiftChatSDKAsyncTests` - Async/await integration tests
+
+## Linting
+
+```bash
+swiftlint
+```
+
+Configuration in `.swiftlint.yml` - line length 150, includes Sources/ and Tests/.
+
+## Documentation Snippets
+
+`Snippets/` contains compilable code examples used in PubNub documentation. These are validated during CI/CD to ensure customer-facing docs remain accurate.
+
+**When modifying public APIs**, update corresponding snippets to prevent build failures.
+
+## Architecture
+
+### Dependency Chain
+
+```
+PubNubSwiftChatSDK (this repo)
+    └── PubNubChat (KMP compiled for Swift) - core implementation
+    └── PubNubSDK (Swift SDK) - low-level PubNub APIs
+```
+
+### Source Structure
+
+- **`Sources/Chat/`** - Main entry point
+  - `Chat.swift` - Protocol defining all chat operations
+  - `ChatImpl.swift` - Implementation wrapping KMP `PubNubChat.ChatImpl`
+  - `ChatConfiguration.swift` - SDK configuration options
+
+- **`Sources/Entities/`** - Domain objects (each has protocol + impl + async extension)
+  - `Channel`, `User`, `Message`, `Membership`, `ThreadChannel`, `ThreadMessage`, `ChannelGroup`
+  - Pattern: `Entity.swift` (protocol) + `EntityImpl.swift` (KMP wrapper) + `Entity+AsyncAwait.swift`
+
+- **`Sources/MessageDraft/`** - Message composition with mentions/references
+
+- **`Sources/Extensions/`** - Type conversions between Swift and KMP types
+
+- **`Sources/Models/`** - Data transfer objects (`Event`, `EventContent`, `File`, etc.)
+
+### Key Patterns
+
+1. **Protocol + Implementation**: Each entity has a public protocol (e.g., `Channel`) and internal implementation (e.g., `ChannelImpl`) that wraps the KMP type
+
+2. **Dual API Surface**: All async operations have both:
+   - Closure-based: `func getUser(userId:completion:)`
+   - Async/await: `func getUser(userId:) async throws -> User`
+
+3. **KMP Bridge**: `ChatImpl` creates the KMP core via `ChatImpl.createKMPChat()` and all entity implementations hold references to both the KMP object and the parent `ChatImpl`
+
+4. **Stream Handling**: Real-time updates return `AutoCloseable` - callers must retain strong reference to continue receiving updates
+
+### Entity Ownership
+
+All entities hold a strong reference to `Chat`:
+```swift
+// ChannelImpl.swift
+let chat: ChatImpl
+let channel: PubNubChat.Channel_  // KMP type
+```
+
+## Test Structure
+
+- `Tests/BaseIntegrationTestCase.swift` - Base class with `chat: ChatImpl` and helpers
+- `Tests/AsyncAwait/BaseAsyncIntegrationTestCase.swift` - Async test base class
+- `Tests/Common/IntegrationTestCaseConfiguration.swift` - Creates test `ChatImpl` instances
+- Entity-specific tests: `ChannelIntegrationTests.swift`, `MessageIntegrationTests.swift`, etc.
+
+## Dependencies
+
+Defined in `Package.swift`:
+- `PubNubChat` (kmp-chat) - KMP core, exact version pinned
+- `PubNubSDK` (swift) - Low-level SDK, exact version pinned
diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,10 @@
 source "https://rubygems.org"
 
-gem "fastlane", '2.225.0'
+gem "fastlane", '2.231.0'
+gem 'xcpretty', '0.4.1'
 gem 'rexml', '3.3.9'
+
+# Ruby 3.4+ compatibility - these gems were removed from stdlib
+gem 'abbrev'
+gem 'mutex_m'
+gem 'logger'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,39 +1,42 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.7)
-      base64
-      nkf
-      rexml
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    CFPropertyList (3.0.8)
+    abbrev (0.1.2)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     artifactory (3.0.17)
     atomos (0.1.3)
-    aws-eventstream (1.3.0)
-    aws-partitions (1.993.0)
-    aws-sdk-core (3.211.0)
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1206.0)
+    aws-sdk-core (3.241.4)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
+      base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.95.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+      logger
+    aws-sdk-kms (1.121.0)
+      aws-sdk-core (~> 3, >= 3.241.4)
       aws-sigv4 (~> 1.5)
-    aws-sdk-s3 (1.169.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+    aws-sdk-s3 (1.212.0)
+      aws-sdk-core (~> 3, >= 3.241.4)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.5)
-    aws-sigv4 (1.10.1)
+    aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     base64 (0.2.0)
+    bigdecimal (4.0.1)
     claide (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
     commander (4.6.0)
       highline (~> 2.0.0)
+    csv (3.3.5)
     declarative (0.0.20)
-    digest-crc (0.6.5)
+    digest-crc (0.7.0)
       rake (>= 12.0.0, < 14.0.0)
     domain_name (0.6.20240107)
     dotenv (2.8.1)
@@ -51,32 +54,35 @@ GEM
       faraday-rack (~> 1.0)
       faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-cookie_jar (0.0.7)
+    faraday-cookie_jar (0.0.8)
       faraday (>= 0.8.0)
-      http-cookie (~> 1.0.0)
+      http-cookie (>= 1.0.0)
     faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
+    faraday-em_synchrony (1.0.1)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
+    faraday-multipart (1.2.0)
+      multipart-post (~> 2.0)
     faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
     faraday_middleware (1.2.1)
       faraday (~> 1.0)
-    fastimage (2.3.1)
-    fastlane (2.225.0)
+    fastimage (2.4.0)
+    fastlane (2.231.0)
       CFPropertyList (>= 2.3, < 4.0.0)
+      abbrev (~> 0.1.2)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
       aws-sdk-s3 (~> 1.0)
       babosa (>= 1.0.3, < 2.0.0)
-      bundler (>= 1.12.0, < 3.0.0)
+      base64 (~> 0.2.0)
+      bundler (>= 1.17.3, < 5.0.0)
       colored (~> 1.2)
       commander (~> 4.6)
+      csv (~> 3.3)
       dotenv (>= 2.1.1, < 3.0.0)
       emoji_regex (>= 0.1, < 4.0)
       excon (>= 0.71.0, < 1.0.0)
@@ -94,9 +100,12 @@ GEM
       http-cookie (~> 1.0.5)
       json (< 3.0.0)
       jwt (>= 2.1.0, < 3)
+      logger (>= 1.6, < 2.0)
       mini_magick (>= 4.9.4, < 5.0.0)
       multipart-post (>= 2.0.0, < 3.0.0)
+      mutex_m (~> 0.3.0)
       naturally (~> 2.2)
+      nkf (~> 0.2.0)
       optparse (>= 0.1.1, < 1.0.0)
       plist (>= 3.1.0, < 4.0.0)
       rubyzip (>= 2.0.0, < 3.0.0)
@@ -108,7 +117,7 @@ GEM
       tty-spinner (>= 0.8.0, < 1.0.0)
       word_wrap (~> 1.0.0)
       xcodeproj (>= 1.13.0, < 2.0.0)
-      xcpretty (~> 0.3.0)
+      xcpretty (~> 0.4.1)
       xcpretty-travis-formatter (>= 0.0.3, < 2.0.0)
     fastlane-sirp (1.0.0)
       sysrandom (~> 1.0)
@@ -129,12 +138,12 @@ GEM
       google-apis-core (>= 0.11.0, < 2.a)
     google-apis-storage_v1 (0.31.0)
       google-apis-core (>= 0.11.0, < 2.a)
-    google-cloud-core (1.7.1)
+    google-cloud-core (1.8.0)
       google-cloud-env (>= 1.0, < 3.a)
       google-cloud-errors (~> 1.0)
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
-    google-cloud-errors (1.4.0)
+    google-cloud-errors (1.5.0)
     google-cloud-storage (1.47.0)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
@@ -150,39 +159,42 @@ GEM
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
     highline (2.0.3)
-    http-cookie (1.0.7)
+    http-cookie (1.0.8)
       domain_name (~> 0.5)
-    httpclient (2.8.3)
+    httpclient (2.9.0)
+      mutex_m
     jmespath (1.6.2)
-    json (2.7.2)
-    jwt (2.9.3)
+    json (2.18.0)
+    jwt (2.10.2)
       base64
+    logger (1.7.0)
     mini_magick (4.13.2)
     mini_mime (1.1.5)
-    multi_json (1.15.0)
+    multi_json (1.19.1)
     multipart-post (2.4.1)
-    nanaimo (0.3.0)
-    naturally (2.2.1)
+    mutex_m (0.3.0)
+    nanaimo (0.4.0)
+    naturally (2.3.0)
     nkf (0.2.0)
-    optparse (0.5.0)
+    optparse (0.8.1)
     os (1.1.4)
-    plist (3.7.1)
-    public_suffix (6.0.1)
-    rake (13.2.1)
+    plist (3.7.2)
+    public_suffix (7.0.2)
+    rake (13.3.1)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
     retriable (3.1.2)
     rexml (3.3.9)
-    rouge (2.0.7)
+    rouge (3.28.0)
     ruby2_keywords (0.0.5)
-    rubyzip (2.3.2)
+    rubyzip (2.4.1)
     security (0.1.5)
-    signet (0.19.0)
+    signet (0.21.0)
       addressable (~> 2.8)
       faraday (>= 0.17.5, < 3.a)
-      jwt (>= 1.5, < 3.0)
+      jwt (>= 1.5, < 4.0)
       multi_json (~> 1.10)
     simctl (1.6.10)
       CFPropertyList
@@ -199,15 +211,15 @@ GEM
     uber (0.1.0)
     unicode-display_width (2.6.0)
     word_wrap (1.0.0)
-    xcodeproj (1.25.1)
+    xcodeproj (1.27.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.3.0)
+      nanaimo (~> 0.4.0)
       rexml (>= 3.3.6, < 4.0)
-    xcpretty (0.3.0)
-      rouge (~> 2.0.7)
+    xcpretty (0.4.1)
+      rouge (~> 3.28.0)
     xcpretty-travis-formatter (1.0.1)
       xcpretty (~> 0.2, >= 0.0.7)
 
@@ -216,7 +228,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  fastlane (= 2.225.0)
+  abbrev
+  fastlane (= 2.231.0)
+  logger
+  mutex_m
   rexml (= 3.3.9)
 
 BUNDLED WITH
