Skip to content

Commit 20269e0

Browse files
authored
Standardise some naming (#2063)
Motivation: In v2 we've predominantly used 'max' instead of 'maximum' and 'config' instead of 'configuration'. We should apply these consistently. Modifications: - Replaces occurrences of 'maximum' with 'max', and 'configuration' with 'config'. Result: More consistent naming
1 parent 7789f1e commit 20269e0

File tree

61 files changed

+291
-288
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+291
-288
lines changed

Sources/GRPCCodeGen/CodeGenerationRequest.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public struct CodeGenerationRequest {
8787
public var item: Item?
8888

8989
/// The access level to be included in imports of this dependency.
90-
public var accessLevel: SourceGenerator.Configuration.AccessLevel
90+
public var accessLevel: SourceGenerator.Config.AccessLevel
9191

9292
/// The name of the imported module or of the module an item is imported from.
9393
public var module: String
@@ -106,7 +106,7 @@ public struct CodeGenerationRequest {
106106
module: String,
107107
spi: String? = nil,
108108
preconcurrency: PreconcurrencyRequirement = .notRequired,
109-
accessLevel: SourceGenerator.Configuration.AccessLevel
109+
accessLevel: SourceGenerator.Config.AccessLevel
110110
) {
111111
self.item = item
112112
self.module = module

Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@
7676
/// }
7777
///```
7878
struct ClientCodeTranslator: SpecializedTranslator {
79-
var accessLevel: SourceGenerator.Configuration.AccessLevel
79+
var accessLevel: SourceGenerator.Config.AccessLevel
8080

81-
init(accessLevel: SourceGenerator.Configuration.AccessLevel) {
81+
init(accessLevel: SourceGenerator.Config.AccessLevel) {
8282
self.accessLevel = accessLevel
8383
}
8484

Sources/GRPCCodeGen/Internal/Translator/IDLToStructuredSwiftTranslator.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
struct IDLToStructuredSwiftTranslator: Translator {
2121
func translate(
2222
codeGenerationRequest: CodeGenerationRequest,
23-
accessLevel: SourceGenerator.Configuration.AccessLevel,
23+
accessLevel: SourceGenerator.Config.AccessLevel,
2424
accessLevelOnImports: Bool,
2525
client: Bool,
2626
server: Bool
@@ -63,7 +63,7 @@ struct IDLToStructuredSwiftTranslator: Translator {
6363

6464
private func makeImports(
6565
dependencies: [CodeGenerationRequest.Dependency],
66-
accessLevel: SourceGenerator.Configuration.AccessLevel,
66+
accessLevel: SourceGenerator.Config.AccessLevel,
6767
accessLevelOnImports: Bool
6868
) throws -> [ImportDescription] {
6969
var imports: [ImportDescription] = []
@@ -87,7 +87,7 @@ struct IDLToStructuredSwiftTranslator: Translator {
8787
}
8888

8989
extension AccessModifier {
90-
fileprivate init(_ accessLevel: SourceGenerator.Configuration.AccessLevel) {
90+
fileprivate init(_ accessLevel: SourceGenerator.Config.AccessLevel) {
9191
switch accessLevel.level {
9292
case .internal: self = .internal
9393
case .package: self = .package

Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@
5858
/// }
5959
///```
6060
struct ServerCodeTranslator: SpecializedTranslator {
61-
var accessLevel: SourceGenerator.Configuration.AccessLevel
61+
var accessLevel: SourceGenerator.Config.AccessLevel
6262

63-
init(accessLevel: SourceGenerator.Configuration.AccessLevel) {
63+
init(accessLevel: SourceGenerator.Config.AccessLevel) {
6464
self.accessLevel = accessLevel
6565
}
6666

Sources/GRPCCodeGen/Internal/Translator/SpecializedTranslator.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
/// the server code translation or the client code translation.
1919
protocol SpecializedTranslator {
2020

21-
/// The ``SourceGenerator.Configuration.AccessLevel`` object used to represent the visibility level used in the generated code.
22-
var accessLevel: SourceGenerator.Configuration.AccessLevel { get }
21+
/// The ``SourceGenerator.Config.AccessLevel`` object used to represent the visibility level used in the generated code.
22+
var accessLevel: SourceGenerator.Config.AccessLevel { get }
2323

2424
/// Generates an array of ``CodeBlock`` elements that will be part of the ``StructuredSwiftRepresentation`` object
2525
/// created by the ``Translator``.

Sources/GRPCCodeGen/Internal/Translator/Translator.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ protocol Translator {
2929
/// - Throws: An error if there are issues translating the codeGenerationRequest.
3030
func translate(
3131
codeGenerationRequest: CodeGenerationRequest,
32-
accessLevel: SourceGenerator.Configuration.AccessLevel,
32+
accessLevel: SourceGenerator.Config.AccessLevel,
3333
accessLevelOnImports: Bool,
3434
client: Bool,
3535
server: Bool

Sources/GRPCCodeGen/Internal/Translator/TypealiasTranslator.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@
7171
struct TypealiasTranslator: SpecializedTranslator {
7272
let client: Bool
7373
let server: Bool
74-
let accessLevel: SourceGenerator.Configuration.AccessLevel
74+
let accessLevel: SourceGenerator.Config.AccessLevel
7575

76-
init(client: Bool, server: Bool, accessLevel: SourceGenerator.Configuration.AccessLevel) {
76+
init(client: Bool, server: Bool, accessLevel: SourceGenerator.Config.AccessLevel) {
7777
self.client = client
7878
self.server = server
7979
self.accessLevel = accessLevel

Sources/GRPCCodeGen/SourceGenerator.swift

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
public struct SourceGenerator: Sendable {
1919
/// The options regarding the access level, indentation for the generated code
2020
/// and whether to generate server and client code.
21-
public var configuration: Configuration
21+
public var config: Config
2222

23-
public init(configuration: Configuration) {
24-
self.configuration = configuration
23+
public init(config: Config) {
24+
self.config = config
2525
}
2626

2727
/// User options for the CodeGeneration.
28-
public struct Configuration: Sendable {
28+
public struct Config: Sendable {
2929
/// The access level the generated code will have.
3030
public var accessLevel: AccessLevel
3131
/// Whether imports have explicit access levels.
@@ -85,14 +85,14 @@ public struct SourceGenerator: Sendable {
8585
_ request: CodeGenerationRequest
8686
) throws -> SourceFile {
8787
let translator = IDLToStructuredSwiftTranslator()
88-
let textRenderer = TextBasedRenderer(indentation: self.configuration.indentation)
88+
let textRenderer = TextBasedRenderer(indentation: self.config.indentation)
8989

9090
let structuredSwiftRepresentation = try translator.translate(
9191
codeGenerationRequest: request,
92-
accessLevel: self.configuration.accessLevel,
93-
accessLevelOnImports: self.configuration.accessLevelOnImports,
94-
client: self.configuration.client,
95-
server: self.configuration.server
92+
accessLevel: self.config.accessLevel,
93+
accessLevelOnImports: self.config.accessLevelOnImports,
94+
client: self.config.client,
95+
server: self.config.server
9696
)
9797
let sourceFile = try textRenderer.render(structured: structuredSwiftRepresentation)
9898

Sources/GRPCCore/Call/Client/Internal/ClientRPCExecutor+HedgingExecutor.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -448,15 +448,15 @@ extension ClientRPCExecutor.HedgingExecutor {
448448
@usableFromInline
449449
struct State: Sendable {
450450
@usableFromInline
451-
let _maximumAttempts: Int
451+
let _maxAttempts: Int
452452
@usableFromInline
453453
private(set) var attempt: Int
454454
@usableFromInline
455455
private(set) var hasUsableResponse: Bool
456456

457457
@inlinable
458458
init(policy: HedgingPolicy) {
459-
self._maximumAttempts = policy.maximumAttempts
459+
self._maxAttempts = policy.maxAttempts
460460
self.attempt = 1
461461
self.hasUsableResponse = false
462462
}
@@ -487,14 +487,14 @@ extension ClientRPCExecutor.HedgingExecutor {
487487

488488
@inlinable
489489
mutating func nextAttemptNumber() -> NextAttemptResult? {
490-
if self.hasUsableResponse || self.attempt > self._maximumAttempts {
490+
if self.hasUsableResponse || self.attempt > self._maxAttempts {
491491
return nil
492492
} else {
493493
let attempt = self.attempt
494494
self.attempt += 1
495495
return NextAttemptResult(
496496
nextAttempt: attempt,
497-
scheduleNext: self.attempt <= self._maximumAttempts
497+
scheduleNext: self.attempt <= self._maxAttempts
498498
)
499499
}
500500
}

Sources/GRPCCore/Call/Client/Internal/ClientRPCExecutor+RetryExecutor.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ extension ClientRPCExecutor.RetryExecutor {
115115
let delaySequence = RetryDelaySequence(policy: self.policy)
116116
var delayIterator = delaySequence.makeIterator()
117117

118-
for attempt in 1 ... self.policy.maximumAttempts {
118+
for attempt in 1 ... self.policy.maxAttempts {
119119
do {
120120
let attemptResult = try await self.transport.withStream(
121121
descriptor: method,
@@ -253,15 +253,15 @@ extension ClientRPCExecutor.RetryExecutor {
253253
switch error.metadata.retryPushback {
254254
case .retryAfter(let delay):
255255
// Pushback: only retry if our config permits it.
256-
shouldRetry = (attempt < self.policy.maximumAttempts) && !throttled
256+
shouldRetry = (attempt < self.policy.maxAttempts) && !throttled
257257
retryDelayOverride = delay
258258
case .stopRetrying:
259259
// Server told us to stop trying.
260260
shouldRetry = false
261261
retryDelayOverride = nil
262262
case .none:
263263
// No pushback: only retry if our config permits it.
264-
shouldRetry = (attempt < self.policy.maximumAttempts) && !throttled
264+
shouldRetry = (attempt < self.policy.maxAttempts) && !throttled
265265
retryDelayOverride = nil
266266
break
267267
}

0 commit comments

Comments
 (0)