Merge pull request #1 from egeniq/feature/prepare

Feature/prepare

README.md

@@ -4,10 +4,6 @@ Configure apps remotely: A simple but effective way to manage apps remotely.
 
 Create a simple configuration file that is easy to maintain and host, yet provides important flexibility to specify settings based on your needs.
 
-## Schema
-
-The JSON/YAML schema is defined [here](https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json).
-
 ## CLI Utility
 
 Use the `care` CLI utility to initialize, verify, resolve and prepare configuration files.
@@ -16,75 +12,108 @@ To install use:
 
     brew install egeniq/app-utilities/care
 
-## Multiplatform
-
-### Swift
-
-Import the package in your `Package.swift` file:
-
-    .package(url: "https://github.com/egeniq/app-remote-config", from: "0.0.2"),
-
-Then a good approach is to create your own `AppRemoteConfigClient`.
-
-    // App Remote Config
-    .target(
-        name: "AppRemoteConfigClient",
-        dependencies: [
-            .product(name: "AppRemoteConfigMacros", package: "app-remote-config"),
-            .product(name: "AppRemoteConfigService", package: "app-remote-config"),
-            .product(name: "Dependencies", package: "swift-dependencies"),
-            .product(name: "DependenciesAdditions", package: "swift-dependencies-additions"),
-            .product(name: "DependenciesMacros", package: "swift-dependencies"),
-            .product(name: "Perception", package: "swift-perception")
-        ]
-    )
-        
-Using these dependencies:
-
-    .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.0.0"),
-    .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.0.0"),
-    .package(url: "https://github.com/tgrapperon/swift-dependencies-additions", from: "1.0.0")
-     
-Then your `AppRemoteConfigClient.swift` is something like this:
-
-    import AppRemoteConfigService
-    import AppRemoteConfigMacros
-    import Dependencies
-    import DependenciesMacros
-    import Foundation
-    import Perception
-
-    @AppRemoteConfigValues @Perceptible
-    public class Values {
-        public private(set) var updateRecommended: Bool = false
-        public private(set) var updateRequired: Bool = false
-    }
-
-    @DependencyClient
-    public struct AppRemoteConfigClient {
-        public var values: () -> Values = { Values() }
-    }
-
-    extension DependencyValues {
-        public var configClient: AppRemoteConfigClient {
-            get { self[AppRemoteConfigClient.self] }
-            set { self[AppRemoteConfigClient.self] = newValue }
-        }
-    }
-
-    extension AppRemoteConfigClient: TestDependencyKey {
-        public static let testValue = Self()
-    }
-
-    extension AppRemoteConfigClient: DependencyKey {
-        public static let liveValue = {
-            let url = URL(string: "https://www.example.com/config.json")!
-            let values = Values()
-            let service = AppRemoteConfigService(url: url, apply: values.apply(settings:))
-            return Self(values: { values })
-        }()
-    }
-
-### Android
-
-Support for Android can be found [here](https://github.com/egeniq/app-remote-config-android).
+## Schema
+
+The JSON/YAML schema is defined [here](https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json).
+
+## Usage
+
+The "care" command line utility has built-in help available.
+
+    care --help
+
+There are four subcommands to use: init, verify, resolve and prepare.
+
+### Init
+
+Create a new configuration file:
+
+    care init appconfig.yaml
+
+This will create a new file:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json
+$schema: https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json
+
+# Settings for the current app.
+settings:
+  foo: 42
+  coolFeature: false
+
+# Keep track of keys that are no longer in use.
+deprecatedKeys:
+- bar
+
+# Override settings
+overrides:
+- matching:
+  # If any of the following combinations match
+  - appVersion: <=0.9.0
+    platform: Android
+  - appVersion: <1.0.0
+    platform: iOS
+  - platformVersion: <15.0.0
+    platform: iOS.iPad
+  # These settings get overriden.
+  settings:
+    bar: low
+
+# Or release a new feature at a specific time
+- schedule:
+    from: '2024-12-31T00:00:00Z'
+  settings:
+    coolFeature: true
+
+# Store metadata here
+meta:
+  author: Your Name
+```
+
+Under the `settings` key you would put the current settings you want in your app. If any keys are deprecated, add them to the `deprecatedKeys` array so they can still be overriden.
+
+In `overrides` you can define settings that vary on a number of factors such as appVersion, platform, platformVersion. See help for the full list of options. If one of the combinations match, the settings are override the settings from the root `settings` key. Settings are applied from top to bottom.
+
+You can also schedule changes in settings. If you add a `schedule` with `from` and/or `until` ISO8601 dates settings will only be applied if the current time lies with the range. Omitting `from` means using the distant past, and omitting `to` means using the distant future.
+
+The keys under `meta` are not used, but only exist to keep track of metadata.
+
+### Verify
+
+If your editor supports it, the JSON schema helps you to properly format the config file. You can further verify correctness of a config file by running:
+
+    care verify appconfig.yaml
+
+### Resolve
+
+To check that settings and overrides you have setup are correct, you can ask `care` to show how the settings would resolve.
+
+    care resolve appconfig.yaml -p iOS --platform-version 16  -v 1.0.1
+
+That would show something like this:
+
+```    
+Resolving for:
+  platform            : iOS
+  platform version    : 16.0.0
+  app version         : 1.0.1
+  build variant       : release
+
+Settings on 2024-02-22 11:40:00 +0000:
+  coolFeature         : false
+  foo                 : 42
+
+Settings on 2024-12-31 00:00:00 +0000:
+  coolFeature         : false -> true
+  foo                 : 42
+
+No further overrides scheduled.
+```
+
+### Prepare
+
+The last step is convert the config file to compact json.
+
+    care prepare appconfig.yaml appconfig.json
+
+The file `appconfig.json` is now ready to made available to your app via a webserver.

Sources/care/Init.swift

@@ -24,6 +24,7 @@ extension Care {
             switch kind {
             case .yaml:
                 let yaml = """
+                # yaml-language-server: $schema=https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json
                 $schema: https://raw.githubusercontent.com/egeniq/app-remote-config/main/Schema/appremoteconfig.schema.json
                 
                 # Settings for the current app.

Sources/care/Prepare.swift

@@ -41,7 +41,7 @@ extension Care {
                 }
             }
 
-            let dataOut = try JSONSerialization.data(withJSONObject: object)
+            let dataOut = try JSONSerialization.data(withJSONObject: object, options: [.sortedKeys])
             let results = try Verify().verify(from: dataOut)
             if results.filter({ $0.level == .error }).isEmpty {
                 try dataOut.write(to: outputFile)

Sources/care/care.swift

@@ -10,6 +10,6 @@ struct Care: ParsableCommand {
         
         Create a simple configuration file that is easy to maintain and host, yet provides important flexibility to specify settings based on your needs.
         """,
-        version: "0.0.2",
+        version: "0.0.3",
         subcommands: [Init.self, Verify.self, Resolve.self, Prepare.self])
 }