Skip to content

Commit 65c6765

Browse files
lawrence-forooghianlawrence-forooghian
committed
Update internal types to have Object[s] prefix
Per [1]. Resolves #16. [1] ably/specification#328.
1 parent 831e62a commit 65c6765

3 files changed

Lines changed: 83 additions & 83 deletions

File tree

‎Sources/AblyLiveObjects/Protocol/ObjectMessage.swift‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ internal struct OutboundObjectMessage {
3232
internal struct ObjectOperation {
3333
internal var action: WireEnum<ObjectOperationAction> // OOP3a
3434
internal var objectId: String // OOP3b
35-
internal var mapOp: MapOp? // OOP3c
36-
internal var counterOp: WireCounterOp? // OOP3d
35+
internal var mapOp: ObjectsMapOp? // OOP3c
36+
internal var counterOp: WireObjectsCounterOp? // OOP3d
3737
internal var map: Map? // OOP3e
38-
internal var counter: WireCounter? // OOP3f
38+
internal var counter: WireObjectsCounter? // OOP3f
3939
internal var nonce: String? // OOP3g
4040
internal var initialValue: Data? // OOP3h
4141
internal var initialValueEncoding: String? // OOP3i
@@ -56,20 +56,20 @@ internal struct ObjectData {
5656
internal var string: StringPropertyContent? // OD2f
5757
}
5858

59-
internal struct MapOp {
60-
internal var key: String // MOP2a
61-
internal var data: ObjectData? // MOP2b
59+
internal struct ObjectsMapOp {
60+
internal var key: String // OMO2a
61+
internal var data: ObjectData? // OMO2b
6262
}
6363

64-
internal struct MapEntry {
65-
internal var tombstone: Bool? // ME2a
66-
internal var timeserial: String? // ME2b
67-
internal var data: ObjectData // ME2c
64+
internal struct ObjectsMapEntry {
65+
internal var tombstone: Bool? // OME2a
66+
internal var timeserial: String? // OME2b
67+
internal var data: ObjectData // OME2c
6868
}
6969

7070
internal struct Map {
71-
internal var semantics: WireEnum<MapSemantics> // MAP3a
72-
internal var entries: [String: MapEntry]? // MAP3b
71+
internal var semantics: WireEnum<ObjectsMapSemantics> // OMP3a
72+
internal var entries: [String: ObjectsMapEntry]? // OMP3b
7373
}
7474

7575
internal extension InboundObjectMessage {
@@ -128,8 +128,8 @@ internal extension ObjectOperation {
128128
) throws(InternalError) {
129129
action = wireObjectOperation.action
130130
objectId = wireObjectOperation.objectId
131-
mapOp = try wireObjectOperation.mapOp.map { wireMapOp throws(InternalError) in
132-
try .init(wireMapOp: wireMapOp, format: format)
131+
mapOp = try wireObjectOperation.mapOp.map { wireObjectsMapOp throws(InternalError) in
132+
try .init(wireObjectsMapOp: wireObjectsMapOp, format: format)
133133
}
134134
counterOp = wireObjectOperation.counterOp
135135
map = try wireObjectOperation.map.map { wireMap throws(InternalError) in
@@ -308,42 +308,42 @@ internal extension ObjectData {
308308
}
309309
}
310310

311-
internal extension MapOp {
312-
/// Initializes a `MapOp` from a `WireMapOp`, applying the data decoding rules of OD5.
311+
internal extension ObjectsMapOp {
312+
/// Initializes a `ObjectsMapOp` from a `WireObjectsMapOp`, applying the data decoding rules of OD5.
313313
///
314314
/// - Parameters:
315315
/// - format: The format to use when applying the decoding rules of OD5.
316316
/// - Throws: `InternalError` if JSON or Base64 decoding fails.
317317
init(
318-
wireMapOp: WireMapOp,
318+
wireObjectsMapOp: WireObjectsMapOp,
319319
format: AblyPlugin.EncodingFormat
320320
) throws(InternalError) {
321-
key = wireMapOp.key
322-
data = try wireMapOp.data.map { wireObjectData throws(InternalError) in
321+
key = wireObjectsMapOp.key
322+
data = try wireObjectsMapOp.data.map { wireObjectData throws(InternalError) in
323323
try .init(wireObjectData: wireObjectData, format: format)
324324
}
325325
}
326326

327-
/// Converts this `MapOp` to a `WireMapOp`, applying the data encoding rules of OD4.
327+
/// Converts this `ObjectsMapOp` to a `WireObjectsMapOp`, applying the data encoding rules of OD4.
328328
///
329329
/// - Parameters:
330330
/// - format: The format to use when applying the encoding rules of OD4.
331-
func toWire(format: AblyPlugin.EncodingFormat) -> WireMapOp {
331+
func toWire(format: AblyPlugin.EncodingFormat) -> WireObjectsMapOp {
332332
.init(
333333
key: key,
334334
data: data?.toWire(format: format),
335335
)
336336
}
337337
}
338338

339-
internal extension MapEntry {
339+
internal extension ObjectsMapEntry {
340340
/// Initializes a `MapEntry` from a `WireMapEntry`, applying the data decoding rules of OD5.
341341
///
342342
/// - Parameters:
343343
/// - format: The format to use when applying the decoding rules of OD5.
344344
/// - Throws: `InternalError` if JSON or Base64 decoding fails.
345345
init(
346-
wireMapEntry: WireMapEntry,
346+
wireMapEntry: WireObjectsMapEntry,
347347
format: AblyPlugin.EncodingFormat
348348
) throws(InternalError) {
349349
tombstone = wireMapEntry.tombstone
@@ -355,7 +355,7 @@ internal extension MapEntry {
355355
///
356356
/// - Parameters:
357357
/// - format: The format to use when applying the encoding rules of OD4.
358-
func toWire(format: AblyPlugin.EncodingFormat) -> WireMapEntry {
358+
func toWire(format: AblyPlugin.EncodingFormat) -> WireObjectsMapEntry {
359359
.init(
360360
tombstone: tombstone,
361361
timeserial: timeserial,
@@ -371,7 +371,7 @@ internal extension Map {
371371
/// - format: The format to use when applying the decoding rules of OD5.
372372
/// - Throws: `InternalError` if JSON or Base64 decoding fails.
373373
init(
374-
wireMap: WireMap,
374+
wireMap: WireObjectsMap,
375375
format: AblyPlugin.EncodingFormat
376376
) throws(InternalError) {
377377
semantics = wireMap.semantics
@@ -384,7 +384,7 @@ internal extension Map {
384384
///
385385
/// - Parameters:
386386
/// - format: The format to use when applying the encoding rules of OD4.
387-
func toWire(format: AblyPlugin.EncodingFormat) -> WireMap {
387+
func toWire(format: AblyPlugin.EncodingFormat) -> WireObjectsMap {
388388
.init(
389389
semantics: semantics,
390390
entries: entries?.mapValues { $0.toWire(format: format) },

‎Sources/AblyLiveObjects/Protocol/WireObjectMessage.swift‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -145,18 +145,18 @@ internal enum ObjectOperationAction: Int {
145145
case objectDelete = 5
146146
}
147147

148-
// MAP2
149-
internal enum MapSemantics: Int {
148+
// OMP2
149+
internal enum ObjectsMapSemantics: Int {
150150
case lww = 0
151151
}
152152

153153
internal struct WireObjectOperation {
154154
internal var action: WireEnum<ObjectOperationAction> // OOP3a
155155
internal var objectId: String // OOP3b
156-
internal var mapOp: WireMapOp? // OOP3c
157-
internal var counterOp: WireCounterOp? // OOP3d
158-
internal var map: WireMap? // OOP3e
159-
internal var counter: WireCounter? // OOP3f
156+
internal var mapOp: WireObjectsMapOp? // OOP3c
157+
internal var counterOp: WireObjectsCounterOp? // OOP3d
158+
internal var map: WireObjectsMap? // OOP3e
159+
internal var counter: WireObjectsCounter? // OOP3f
160160
internal var nonce: String? // OOP3g
161161
internal var initialValue: StringOrData? // OOP3h
162162
internal var initialValueEncoding: String? // OOP3i
@@ -228,8 +228,8 @@ internal struct WireObjectState {
228228
internal var siteTimeserials: [String: String] // OST2b
229229
internal var tombstone: Bool // OST2c
230230
internal var createOp: WireObjectOperation? // OST2d
231-
internal var map: WireMap? // OST2e
232-
internal var counter: WireCounter? // OST2f
231+
internal var map: WireObjectsMap? // OST2e
232+
internal var counter: WireObjectsCounter? // OST2f
233233
}
234234

235235
extension WireObjectState: WireObjectCodable {
@@ -277,12 +277,12 @@ extension WireObjectState: WireObjectCodable {
277277
}
278278
}
279279

280-
internal struct WireMapOp {
281-
internal var key: String // MOP2a
282-
internal var data: WireObjectData? // MOP2b
280+
internal struct WireObjectsMapOp {
281+
internal var key: String // OMO2a
282+
internal var data: WireObjectData? // OMO2b
283283
}
284284

285-
extension WireMapOp: WireObjectCodable {
285+
extension WireObjectsMapOp: WireObjectCodable {
286286
internal enum WireKey: String {
287287
case key
288288
case data
@@ -306,11 +306,11 @@ extension WireMapOp: WireObjectCodable {
306306
}
307307
}
308308

309-
internal struct WireCounterOp {
310-
internal var amount: NSNumber // COP2a
309+
internal struct WireObjectsCounterOp {
310+
internal var amount: NSNumber // OCO2a
311311
}
312312

313-
extension WireCounterOp: WireObjectCodable {
313+
extension WireObjectsCounterOp: WireObjectCodable {
314314
internal enum WireKey: String {
315315
case amount
316316
}
@@ -326,12 +326,12 @@ extension WireCounterOp: WireObjectCodable {
326326
}
327327
}
328328

329-
internal struct WireMap {
330-
internal var semantics: WireEnum<MapSemantics> // MAP3a
331-
internal var entries: [String: WireMapEntry]? // MAP3b
329+
internal struct WireObjectsMap {
330+
internal var semantics: WireEnum<ObjectsMapSemantics> // OMP3a
331+
internal var entries: [String: WireObjectsMapEntry]? // OMP3b
332332
}
333333

334-
extension WireMap: WireObjectCodable {
334+
extension WireObjectsMap: WireObjectCodable {
335335
internal enum WireKey: String {
336336
case semantics
337337
case entries
@@ -343,7 +343,7 @@ extension WireMap: WireObjectCodable {
343343
guard case let .object(object) = value else {
344344
throw WireValueDecodingError.wrongTypeForKey(WireKey.entries.rawValue, actualValue: value).toInternalError()
345345
}
346-
return try WireMapEntry(wireObject: object)
346+
return try WireObjectsMapEntry(wireObject: object)
347347
}
348348
}
349349

@@ -360,11 +360,11 @@ extension WireMap: WireObjectCodable {
360360
}
361361
}
362362

363-
internal struct WireCounter {
364-
internal var count: NSNumber? // CNT2a
363+
internal struct WireObjectsCounter {
364+
internal var count: NSNumber? // OCN2a
365365
}
366366

367-
extension WireCounter: WireObjectCodable {
367+
extension WireObjectsCounter: WireObjectCodable {
368368
internal enum WireKey: String {
369369
case count
370370
}
@@ -382,13 +382,13 @@ extension WireCounter: WireObjectCodable {
382382
}
383383
}
384384

385-
internal struct WireMapEntry {
386-
internal var tombstone: Bool? // ME2a
387-
internal var timeserial: String? // ME2b
388-
internal var data: WireObjectData // ME2c
385+
internal struct WireObjectsMapEntry {
386+
internal var tombstone: Bool? // OME2a
387+
internal var timeserial: String? // OME2b
388+
internal var data: WireObjectData // OME2c
389389
}
390390

391-
extension WireMapEntry: WireObjectCodable {
391+
extension WireObjectsMapEntry: WireObjectCodable {
392392
internal enum WireKey: String {
393393
case tombstone
394394
case timeserial

0 commit comments

Comments
 (0)