refactor(review): rename wrapper to provider for tokens of colors (#79)

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

Author: pylapp

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ColorMultipleSemanticTokens.swift

@@ -22,11 +22,11 @@ import OUDSTokensSemantic
 // swiftlint:disable line_length
 
 /// Defines wrapper objects for `ColorSemanticTokens` so as to pack them as light and dark mode colors.
-/// These values can be overriden inside `OUDSColorSemanticTokensWrapper` subclasses (in extensions or not, in the same module or not) thanks to the `@objc open` combination.
+/// These values can be overriden inside `OUDSColorSemanticTokensProvider` subclasses (in extensions or not, in the same module or not) thanks to the `@objc open` combination.
 /// Some tokens do not have values assigned in the design system, and must be overriden.
 /// Some tokens must be overriden in `OrangeTheme` side because they rely on Orange brand colors.
 /// Helps to expose color semantic tokens with two values to use depending to the color scheme (*Figma* cannot manage such tokens and generate them).
-extension OUDSColorSemanticTokensWrapper: ColorMultipleSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorMultipleSemanticTokens {
 
     // MARK: - Color - Opacity - Invisible
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ColorSemanticTokens.swift

@@ -19,7 +19,7 @@ import OUDSTokensSemantic
 
 // swiftlint:disable identifier_name
 
-extension OUDSColorSemanticTokensWrapper: ColorSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorSemanticTokens {
     @objc open var colorOpacityInvisibleBlackLight: ColorSemanticToken { ColorRawTokens.colorOpacityBlack0 }
     @objc open var colorOpacityInvisibleWhiteLight: ColorSemanticToken { ColorRawTokens.colorOpacityWhite0 }
     @objc open var colorOpacityInvisibleBlackDark: ColorSemanticToken { ColorRawTokens.colorOpacityWhite0 }

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme.swift

@@ -63,15 +63,15 @@ open class OUDSTheme: @unchecked Sendable {
     /// Defines a basic kind of abstract theme to subclass then.
     /// No custom font family will be used.
     /// - Parameters:
-    ///    - colors: An object providing all the color semantic tokens, by default `OUDSColorSemanticTokensWrapper`
+    ///    - colors: An object providing all the color semantic tokens, by default `OUDSColorSemanticTokensProvider`
     ///    - borders: An object providing all the border semantic tokens, by default `OUDSBorderSemanticTokensProvider`
     ///    - elevations: An object providing all the elevation semantic tokens, by default `OUDSElevationSemanticTokensWrapper`
     ///    - fonts: An object providing all the font semantic tokens, by default `OUDSFontSemanticTokensWrapper`
     ///    - grids: An object providing all the grid semantic tokens, by default `OUDSGridSemanticTokensWrapper`
     ///    - opacities: An object providing all the opacity semantic tokens, by default `OUDSOpacitySemanticTokensWrapper`
     ///    - sizes: An object providing all the size semantic tokens, by default `OUDSSizeSemanticTokensWrapper`
     ///    - spaces: An object providing all the space semantic tokens, by default `OUDSSpaceSemanticTokensWrapper`
-    public init(colors: AllColorSemanticTokens = OUDSColorSemanticTokensWrapper(),
+    public init(colors: AllColorSemanticTokens = OUDSColorSemanticTokensProvider(),
                 borders: AllBorderSemanticTokens = OUDSBorderSemanticTokensProvider(),
                 elevations: AllElevationSemanticTokens = OUDSElevationSemanticTokensWrapper(),
                 fonts: AllFontSemanticTokens = OUDSFontSemanticTokensWrapper(),

OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md

@@ -53,7 +53,7 @@ protocol ColorSemanticTokens {
 }
 
 // Define the semantic tokens exposed through the theme
-extension OUDSColorSemanticTokensWrapper: ColorSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorSemanticTokens {
 
     // Color is available in the module of OUDSTheme
     @objc open var colorBgPrimary: ColorSemanticToken { ColorRawTokens.colorFunctionalWhite }
@@ -66,7 +66,7 @@ extension OUDSColorSemanticTokensWrapper: ColorSemanticTokens {
 }
 
 // Add missing values
-extension OrangeColorSemanticTokensWrapper: OUDSColorSemanticTokensWrapper {
+extension OrangeColorSemanticTokensWrapper: OUDSColorSemanticTokensProvider {
 
     // Define value value with the accessible token 
     @objc open var colorBgSecondary: ColorSemanticToken { OrangeBrandColorRawTokens.colorOrange200 }

OUDS/Core/OUDS/Tests/OUDSTheme/MockThemes/MockTheme+AllColorSemanticTokens.swift

@@ -19,10 +19,10 @@ import OUDSTokensSemantic
 // swiftlint:disable required_deinit
 // swiftlint:disable type_body_length
 
-/// Overrides **all** the color semantic tokens (from its super class, i.e. `OUDSColorSemanticTokensWrapper`) so as to test overriding of them (unit tests)
+/// Overrides **all** the color semantic tokens (from its super class, i.e. `OUDSColorSemanticTokensProvider`) so as to test overriding of them (unit tests)
 /// and to act like smoke tests with crashing tests if some tokens disappeared.
 /// This ``MockThemeColorSemanticTokensWrapper`` will be asigned in ``MockTheme`` as an ``AllColorSemanticTokens`` implementation.
-open class MockThemeColorSemanticTokensWrapper: OUDSColorSemanticTokensWrapper {
+open class MockThemeColorSemanticTokensWrapper: OUDSColorSemanticTokensProvider {
 
     static let mockThemeMultipleColorSemanticTokens = MultipleColorSemanticTokens("#68489D")
     static let mockThemeSemanticColorTokens: ColorSemanticToken = "#68489D"

OUDS/Core/Themes/Orange/Sources/OrangeTheme+SemanticColorTokens.swift

@@ -23,7 +23,7 @@ import OUDSTokensSemantic
 
 /// Overrides some color tokens using values available in ``OrangeBrandColorRawTokens``.
 /// In fact the *tokenator* is not able to do the magic needed using the JSON file produced by *Figma*.
-/// Some color tokens are not isolated by theme in *Figma*, thus the abstract `OUDSColorSemanticTokensWrapper` in `OUDS` module faces issues by defining tokens with raw tokens not defined in `ColorRawTokens` but in ``OrangeBrandColorRawTokens``. Thus when the `OUDSColorSemanticTokensWrapper` has its colors tokens updated, a manual update must be done to replace unknown tokens by `fatalError` (i.e. must be overriden somewhere somehow) in that file and in this ``OrangeTheme`` file tokens must be overriden and manualy updated with the expected values.
+/// Some color tokens are not isolated by theme in *Figma*, thus the abstract `OUDSColorSemanticTokensProvider` in `OUDS` module faces issues by defining tokens with raw tokens not defined in `ColorRawTokens` but in ``OrangeBrandColorRawTokens``. Thus when the `OUDSColorSemanticTokensProvider` has its colors tokens updated, a manual update must be done to replace unknown tokens by `fatalError` (i.e. must be overriden somewhere somehow) in that file and in this ``OrangeTheme`` file tokens must be overriden and manualy updated with the expected values.
 ///
 ///     // For example, in OUDSTheme colors:
 ///
@@ -50,7 +50,7 @@ import OUDSTokensSemantic
 ///
 /// In few words, we need to keep isolated tokens and brand colors, provide kind of abstract architecture with isolated and overridable themes, but face troubles with *Figma* design kit having conception issues and producing JSON not reflecting the reality making *tokenator* unable to build the expected Swift code.
 /// We get uncompilable code for color tokens update and need to make the merge manualy.
-open class OrangeThemeColorSemanticTokensWrapper: OUDSColorSemanticTokensWrapper {
+open class OrangeThemeColorSemanticTokensWrapper: OUDSColorSemanticTokensProvider {
 
     // MARK: - Init
 

OUDS/Core/Tokens/SemanticTokens/Sources/Wrappers/OUDSColorSemanticTokensWrapper.swift renamed to OUDS/Core/Tokens/SemanticTokens/Sources/Wrappers/OUDSColorSemanticTokensProvider.swift

@@ -19,7 +19,7 @@ import OUDSFoundations
 ///
 /// ```swift
 ///     // Define your own wrapper for color semantic tokens
-///     class CustomColorTokensWrapper: OUDSColorSemanticTokensWrapper {
+///     class CustomColorTokensWrapper: OUDSColorSemanticTokensProvider {
 ///
 ///         // Then override the color semantic tokens you want, using the color raw tokens available
 ///
@@ -49,11 +49,11 @@ import OUDSFoundations
 /// ```swift
 ///     OrangeTheme(colors: CustomColorTokensWrapper())
 /// ```
-open class OUDSColorSemanticTokensWrapper {
+open class OUDSColorSemanticTokensProvider {
 
     /// Intializes the wrapper
     public init() {
-        OUDSLogger.debug("Init of OUDSColorSemanticTokensWrapper")
+        OUDSLogger.debug("Init of OUDSColorSemanticTokensProvider")
     }
 
     deinit{ }
@@ -62,5 +62,5 @@ open class OUDSColorSemanticTokensWrapper {
     // Note: So as to help the integration of generated code produced by the tokenator
     // the implemention of ColorSemanticTokens and ColorMultipleSemanticTokens are not here but in OUDS/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ColorSemanticTokens.swift
     // and OUDS/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ColorMultipleSemanticTokens.swift
-    // This declaration of OUDSColorSemanticTokensWrapper is here to allow to write documentation.
+    // This declaration of OUDSColorSemanticTokensProvider is here to allow to write documentation.
 }

OUDS/Core/Tokens/SemanticTokens/Sources/Wrappers/SemanticTokensWrappers+TypeAliases.swift

@@ -28,7 +28,7 @@ public typealias AllGridSemanticTokens = GridSemanticTokens
 
 /// A type alias which merges  ``ColorSemanticTokens`` and ``ColorMultipleSemanticTokens``.
 /// It helps in the end to define a wrapper for all the semantic tokens of colors, multiple or not, generated or not.
-/// For example ``OUDSColorSemanticTokensWrapper`` matches this type alias.
+/// For example ``OUDSColorSemanticTokensProvider`` matches this type alias.
 public typealias AllColorSemanticTokens = ColorSemanticTokens & ColorMultipleSemanticTokens
 
 /// A type alias which merges  ``ElevationSemanticTokens``, ``ElevationCompositeSemanticTokens`` and ``ElevationMultipleSemanticTokens``.

OUDS/Core/Tokens/SemanticTokens/Sources/_OUDSTokensSemantic.docc/OUDSTokensSemantic.md

@@ -27,10 +27,10 @@ protocol ColorSemanticTokens {
 }
 
 // Ensure you have a wrapper
-open class OUDSColorSemanticTokensWrapper { }
+open class OUDSColorSemanticTokensProvider { }
 
 // Define the semantic tokens to expose through the theme thanks to the wrapper
-extension OUDSColorSemanticTokensWrapper: ColorSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorSemanticTokens {
 
     // Color is available in the module of OUDSTheme
     @objc open var colorBgPrimary: ColorSemanticToken { ColorRawTokens.colorFunctionalWhite }
@@ -76,14 +76,14 @@ public protocol ColorMultipleSemanticTokens { ... }
 public typealias AllColorSemanticTokens = ColorSemanticTokens & ColorMultipleSemanticTokens
 
 // For example, the wrapper for the colors basically is:
-open class OUDSColorSemanticTokensWrapper { ... }
+open class OUDSColorSemanticTokensProvider { ... }
 
 // The wrapper is composed by protocols containing tokens
-extension OUDSColorSemanticTokensWrapper: ColorSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorSemanticTokens {
     @objc open var colorOpacityInvisibleBlackLight: ColorSemanticToken { ColorRawTokens.colorOpacityBlack0 }
     @objc open var colorOpacityInvisibleWhiteLight: ColorSemanticToken { ColorRawTokens.colorOpacityWhite0 }
 }
-extension OUDSColorSemanticTokensWrapper: ColorMultipleSemanticTokens {
+extension OUDSColorSemanticTokensProvider: ColorMultipleSemanticTokens {
     @objc open var colorOpacityInvisibleBlack: MultipleColorSemanticTokens { MultipleColorSemanticTokens(light: colorOpacityInvisibleBlackLight, dark: colorOpacityInvisibleBlackDark) }
 }