Skip to content

Commit 32006bc

Browse files
committed
refactor: identifier for tokens (#521)
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
1 parent e34e6bf commit 32006bc

File tree

4 files changed

+28
-20
lines changed

4 files changed

+28
-20
lines changed

OUDS/Core/OUDS/Sources/OUDSTheme/ColoredSurface/OUDSColoredSurface.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ import SwiftUI
1818

1919
/// Used to define if a content is used on a colored surface.
2020
///
21-
/// It applies the `color` to the background and set the `oudsColoredSurface`
22-
/// environment variable to *true*. This variable is useful, for example, to change
23-
/// the style of a component according to its environment (example: monochrome mode on `OUDSButton`).
21+
/// It applies the `color` to the background and set the `oudsColoredSurface` environment variable to *true*.
22+
/// This variable is useful, for example, to change the style of a component according to its environment (e.g monochrome mode on `OUDSButton`).
2423
///
2524
/// ```swift
26-
/// OUDSColoredSurface(color: .brandPrimary) {
25+
/// OUDSColoredSurface(color: theme.colorModes.modeOnBrandPrimary) {
2726
/// OUDSButton(icon: Image("ic_heart"), hierarchy: .strong, state: .default) {}
2827
/// }
2928
/// ```
3029
///
3130
/// - Since: 0.13.0
3231
public struct OUDSColoredSurface<Content>: View where Content: View {
3332

33+
/// A type alias to use for clarity reasons ; a surface color is in the end a token
3434
public typealias SurfaceColor = MultipleColorModeSemanticTokens
3535

3636
// MARK: Stored Properties

OUDS/Core/Themes/Orange/Tests/Providers/SemanticTokens/OrangeThemeColorModeSemanticTokensProviderTests.swift

+16-8
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
3535
// Given
3636
let modeOnStatusNegativeEmphasizedLight = ColorModeRawTokens.monochromeDark
3737
let modeOnStatusNegativeEmphasizedDark = ColorModeRawTokens.monochromeLight
38-
let modeOnStatusNegativeEmphasized = MultipleColorModeSemanticTokens(light: modeOnStatusNegativeEmphasizedLight,
38+
let modeOnStatusNegativeEmphasized = MultipleColorModeSemanticTokens("Doll",
39+
light: modeOnStatusNegativeEmphasizedLight,
3940
dark: modeOnStatusNegativeEmphasizedDark)
4041

4142
// When
@@ -51,7 +52,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
5152
// Given
5253
let modeOnStatusInfoEmphasizedLight = ColorModeRawTokens.monochromeLight
5354
let modeOnStatusInfoEmphasizedDark = ColorModeRawTokens.monochromeLight
54-
let modeOnStatusInfoEmphasized = MultipleColorModeSemanticTokens(light: modeOnStatusInfoEmphasizedLight,
55+
let modeOnStatusInfoEmphasized = MultipleColorModeSemanticTokens("Dagga",
56+
light: modeOnStatusInfoEmphasizedLight,
5557
dark: modeOnStatusInfoEmphasizedDark)
5658

5759
// When
@@ -67,7 +69,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
6769
// Given
6870
let modeOnStatusInfoBazingaLight = ColorModeRawTokens.monochromeDark
6971
let modeOnStatusInfoBazingaDark = ColorModeRawTokens.monochromeDark
70-
let modeOnStatusInfoBazinga = MultipleColorModeSemanticTokens(light: modeOnStatusInfoBazingaLight,
72+
let modeOnStatusInfoBazinga = MultipleColorModeSemanticTokens("Buzz-Buzz",
73+
light: modeOnStatusInfoBazingaLight,
7174
dark: modeOnStatusInfoBazingaDark)
7275

7376
// When
@@ -83,7 +86,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
8386
// Given
8487
let modeOnStatusAccentMutedLight = ColorModeRawTokens.light
8588
let modeOnStatusAccentMutedDark = ColorModeRawTokens.dark
86-
let modeOnStatusAccentMuted = MultipleColorModeSemanticTokens(light: modeOnStatusAccentMutedLight,
89+
let modeOnStatusAccentMuted = MultipleColorModeSemanticTokens("Ziggety",
90+
light: modeOnStatusAccentMutedLight,
8791
dark: modeOnStatusAccentMutedDark)
8892

8993
// When
@@ -101,7 +105,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
101105
// Given
102106
let modeOnStatusAccentMutedLight = ColorModeRawTokens.light
103107
let modeOnStatusAccentMutedDark = ColorModeRawTokens.dark
104-
let modeOnStatusAccentMuted = MultipleColorModeSemanticTokens(light: modeOnStatusAccentMutedLight,
108+
let modeOnStatusAccentMuted = MultipleColorModeSemanticTokens("Zag",
109+
light: modeOnStatusAccentMutedLight,
105110
dark: modeOnStatusAccentMutedDark)
106111

107112
// When
@@ -115,7 +120,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
115120
// Given
116121
let modeSomeLight = ColorModeRawTokens.monochromeLight
117122
let modeSomeDark = ColorModeRawTokens.dark
118-
let modeSome = MultipleColorModeSemanticTokens(light: modeSomeLight,
123+
let modeSome = MultipleColorModeSemanticTokens("Buzz",
124+
light: modeSomeLight,
119125
dark: modeSomeDark)
120126

121127
// When
@@ -129,7 +135,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
129135
// Given
130136
let modeSomeLight = ColorModeRawTokens.light
131137
let modeSomeDark = ColorModeRawTokens.monochromeDark
132-
let modeSome = MultipleColorModeSemanticTokens(light: modeSomeLight,
138+
let modeSome = MultipleColorModeSemanticTokens("Buzz",
139+
light: modeSomeLight,
133140
dark: modeSomeDark)
134141

135142
// When
@@ -143,7 +150,8 @@ struct OrangeThemeColorModeSemanticTokensProviderTests {
143150
// Given
144151
let modeSomeLight = ColorModeRawTokens.monochromeLight
145152
let modeSomeDark = ColorModeRawTokens.monochromeDark
146-
let modeSome = MultipleColorModeSemanticTokens(light: modeSomeLight,
153+
let modeSome = MultipleColorModeSemanticTokens("Buzz",
154+
light: modeSomeLight,
147155
dark: modeSomeDark)
148156

149157
// When

OUDS/Core/Themes/Orange/Tests/Values/SemanticTokens/MockTheme/MockTheme+AllColorModeSemanticTokens.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import OUDSTokensSemantic
2424
open class MockThemeColorModeSemanticTokensProvider: OrangeThemeColorModeSemanticTokensProvider {
2525

2626
static let mockThemeColorModeSemanticToken: ColorModeSemanticToken = "dumb value"
27-
static let mockThemeMultipleColorModeSemanticTokens = MultipleColorModeSemanticTokens(mockThemeColorModeSemanticToken)
27+
static let mockThemeMultipleColorModeSemanticTokens = MultipleColorModeSemanticTokens("dumber value", mockThemeColorModeSemanticToken)
2828

2929
// MARK: - Multiple tokens
3030

OUDS/Core/Tokens/SemanticTokens/Tests/Multiples/MultipleColorModeSemanticTokensTests.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ struct MultipleColorModeSemanticTokensTests {
2121
/// Tests if the unique value is applied for light and dark modes
2222
@Test func initWithOneValue() {
2323
let unique: ColorModeRawToken = ColorModeRawTokens.light
24-
let token = MultipleColorModeSemanticTokens(unique)
24+
let token = MultipleColorModeSemanticTokens("Toktoktok", unique)
2525

2626
#expect(token.light == unique)
2727
#expect(token.dark == unique)
@@ -31,7 +31,7 @@ struct MultipleColorModeSemanticTokensTests {
3131
@Test func initTwoNonNilValues() {
3232
let light: ColorModeRawToken = ColorModeRawTokens.light
3333
let dark: ColorModeRawToken = ColorModeRawTokens.dark
34-
let token = MultipleColorModeSemanticTokens(light: light, dark: dark)
34+
let token = MultipleColorModeSemanticTokens("Toktoktok", light: light, dark: dark)
3535

3636
#expect(token.light == light)
3737
#expect(token.dark == dark)
@@ -40,11 +40,11 @@ struct MultipleColorModeSemanticTokensTests {
4040
/// Tests comparisons between two `MultipleColorModeSemanticTokens` to ensure tokens are considered as equal
4141
/// if an only if they have the same compact and regular values and have the same types.
4242
@Test func isEqual() {
43-
let first = MultipleColorModeSemanticTokens(light: ColorModeRawTokens.light, dark: ColorModeRawTokens.dark)
44-
let second = MultipleColorModeSemanticTokens(light: ColorModeRawTokens.monochromeLight, dark: ColorModeRawTokens.monochromeDark)
45-
let third = MultipleColorModeSemanticTokens(light: ColorModeRawTokens.light, dark: ColorModeRawTokens.monochromeDark)
46-
let fourth = MultipleColorModeSemanticTokens(light: ColorModeRawTokens.monochromeLight, dark: ColorModeRawTokens.dark)
47-
let fifth = MultipleColorModeSemanticTokens(light: ColorModeRawTokens.light, dark: ColorModeRawTokens.dark)
43+
let first = MultipleColorModeSemanticTokens("1", light: ColorModeRawTokens.light, dark: ColorModeRawTokens.dark)
44+
let second = MultipleColorModeSemanticTokens("2", light: ColorModeRawTokens.monochromeLight, dark: ColorModeRawTokens.monochromeDark)
45+
let third = MultipleColorModeSemanticTokens("3", light: ColorModeRawTokens.light, dark: ColorModeRawTokens.monochromeDark)
46+
let fourth = MultipleColorModeSemanticTokens("4", light: ColorModeRawTokens.monochromeLight, dark: ColorModeRawTokens.dark)
47+
let fifth = MultipleColorModeSemanticTokens("5", light: ColorModeRawTokens.light, dark: ColorModeRawTokens.dark)
4848

4949
#expect(first.isEqual(first))
5050
#expect(!first.isEqual(second))

0 commit comments

Comments
 (0)