Init

Author: muukii

.gitignore

@@ -0,0 +1,89 @@
+# Created by https://www.toptal.com/developers/gitignore/api/swift
+# Edit at https://www.toptal.com/developers/gitignore?templates=swift
+
+### Swift ###
+# Xcode
+#
+# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
+
+## User settings
+xcuserdata/
+
+## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
+*.xcscmblueprint
+*.xccheckout
+
+## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
+build/
+DerivedData/
+*.moved-aside
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+
+## Obj-C/Swift specific
+*.hmap
+
+## App packaging
+*.ipa
+*.dSYM.zip
+*.dSYM
+
+## Playgrounds
+timeline.xctimeline
+playground.xcworkspace
+
+# Swift Package Manager
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+# Packages/
+# Package.pins
+# Package.resolved
+# *.xcodeproj
+# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
+# hence it is not needed unless you have added a package configuration file to your project
+# .swiftpm
+
+.build/
+
+# CocoaPods
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# Pods/
+# Add this line if you want to avoid checking in source code from the Xcode workspace
+# *.xcworkspace
+
+# Carthage
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+
+Carthage/Build/
+
+# Accio dependency management
+Dependencies/
+.accio/
+
+# fastlane
+# It is recommended to not store the screenshots in the git repo.
+# Instead, use fastlane to re-generate the screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/#source-control
+
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots/**/*.png
+fastlane/test_output
+
+# Code Injection
+# After new code Injection tools there's a generated folder /iOSInjectionProject
+# https://github.com/johnno1962/injectionforxcode
+
+iOSInjectionProject/
+.DS_Store
+.swiftpm
+# End of https://www.toptal.com/developers/gitignore/api/swift

Package.resolved

@@ -0,0 +1,61 @@
+// swift-tools-version: 6.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import CompilerPluginSupport
+import PackageDescription
+
+let package = Package(
+  name: "Normalization",
+  platforms: [
+    .macOS(.v11),
+    .iOS(.v13),
+    .tvOS(.v13),
+    .watchOS(.v6),
+  ],
+  products: [
+    // Products define the executables and libraries a package produces, making them visible to other packages.
+    .library(
+      name: "Normalization",
+      targets: ["Normalization"])
+  ],
+  dependencies: [
+    .package(url: "https://github.com/apple/swift-collections", from: "1.1.0"),
+    .package(url: "https://github.com/VergeGroup/TypedComparator", from: "1.0.0"),
+    .package(url: "https://github.com/VergeGroup/TypedIdentifier", from: "2.0.2"),
+    .package(url: "https://github.com/apple/swift-syntax.git", from: "600.0.0"),
+    .package(url: "https://github.com/pointfreeco/swift-macro-testing.git", from: "0.2.1"),
+  ],
+  targets: [
+    .macro(
+      name: "NormalizationMacrosPlugin",
+      dependencies: [
+        .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
+        .product(name: "SwiftCompilerPlugin", package: "swift-syntax"),
+      ]
+    ),
+    .target(
+      name: "Normalization",
+      dependencies: [
+        "NormalizationMacrosPlugin",
+        .product(name: "TypedIdentifier", package: "TypedIdentifier"),
+        .product(name: "TypedComparator", package: "TypedComparator"),
+        .product(name: "HashTreeCollections", package: "swift-collections"),
+      ]
+    ),
+    .testTarget(
+      name: "NormalizationMacrosTests",
+      dependencies: [
+        "NormalizationMacrosPlugin",
+        .product(name: "SwiftSyntaxMacrosTestSupport", package: "swift-syntax"),
+        .product(name: "MacroTesting", package: "swift-macro-testing"),
+      ]
+    ),
+    .testTarget(
+      name: "NormalizationTests",
+      dependencies: [
+        "Normalization"
+      ]
+    ),
+  ],
+  swiftLanguageModes: [.v6]
+)

Package.swift

@@ -0,0 +1,151 @@
+# ``VergeNormalization``
+
+## Overview
+
+State management plays a crucial role in building efficient and maintainable applications. One of the essential aspects of state management is organizing the data in a way that simplifies its manipulation and usage. This is where normalization becomes vital.
+
+Normalization is the process of structuring data in a way that eliminates redundancy and ensures data consistency. It is essential in state-management libraries because it significantly reduces the computational complexity of operations and makes it easier to manage the state.
+
+Docs:
+  - [VergeNormalization](https://swiftpackageindex.com/VergeGroup/swift-Verge/main/documentation/vergenormalization)
+  - [VergeNormalizationDerived](https://swiftpackageindex.com/VergeGroup/swift-Verge/main/documentation/vergenormalizationderived)
+
+Let's take a look at an example to illustrate the difference between normalized and denormalized data structures.
+
+**Denormalized data structure:**
+
+
+```yaml
+posts:
+  - id: 1
+    title: "Post 1"
+    author:
+      id: 1
+      name: "Alice"
+  - id: 2
+    title: "Post 2"
+    author:
+      id: 1
+      name: "Alice"
+  - id: 3
+    title: "Post 3"
+    author:
+      id: 2
+      name: "Bob"
+```
+
+In the denormalized structure, author data is duplicated in each post, which can lead to inconsistencies and make it harder to manage the state.
+
+**Normalized data structure:**
+
+
+```yaml
+entities:
+  authors:
+    1:
+      id: 1
+      name: "Alice"
+    2:
+      id: 2
+      name: "Bob"
+  posts:
+    1:
+      id: 1
+      title: "Post 1"
+      authorId: 1
+    2:
+      id: 2
+      title: "Post 2"
+      authorId: 1
+    3:
+      id: 3
+      title: "Post 3"
+      authorId: 2
+```
+
+In the normalized structure, author data is stored separately from posts, eliminating data redundancy and ensuring data consistency. The relationship between posts and authors is represented by the `authorId` field in the posts.
+
+VergeORM is designed to handle normalization in state-management libraries effectively. By leveraging VergeORM, you can simplify your state management, reduce the computational complexity of operations, and improve the overall performance and maintainability of your application.
+
+**Defining Entities**
+
+Here's an example of how to define the `Book` and `Author` entities:
+
+```swift
+struct Book: EntityType {
+  
+  typealias TypedIdentifierRawValue = String
+  
+  var typedID: TypedID {
+    .init(rawID)
+  }
+  
+  let rawID: String
+  var name: String = "initial"
+  let authorID: Author.EntityID
+}
+
+struct Author: EntityType {
+  
+  typealias TypedIdentifierRawValue = String
+  
+  var typedID: TypedID {
+    .init(rawID)
+  }
+    
+  let rawID: String
+  var name: String = ""
+}
+```
+
+**Defining Database Schema**
+
+To store the entities in the state, you need to define the database schema:
+
+```swift
+@NormalizedStorage
+struct Database {
+
+  @Table
+  var books: Tables.Hash<Book> = .init()
+
+  @Table
+  var authors: Tables.Hash<Book> = .init()
+}
+```
+
+**Embedding the Database in State**
+
+Embed the `Database` in your application's state:
+
+```swift
+struct RootState: StateType {
+  var database: Database = .init()
+}
+```
+
+**Storing and Querying Entities**
+
+Here's an example of how to store and query entities using a `store` property
+
+```swift
+// Storing entities
+store.commit {
+  $0.database.performBatchUpdates { context in
+    let authors = (0..<10).map { i in
+      Author(rawID: "\(i)")
+    }
+    let result = context.modifying.author.insert(authors)
+  }
+}
+
+// Querying entities
+let book = store.state.database.db.book.find(by: .init("1"))
+let author = store.state.database.db.author.find(by: .init("1"))
+```
+
+In this example, we use `store.commit` to perform batch updates on the database. We insert a new set of authors into the `author` entity table. Then, we use `store.state.database.db` to query the `book` and `author` entities by their identifiers.
+
+By using VergeNormalization, you can efficiently manage your application state with a normalized data structure, which simplifies your state management, reduces the computational complexity of operations, and improves the overall performance and maintainability of your application.
+
+

Sources/Normalization/Documentation.docc/Documentation.md

@@ -0,0 +1,10 @@
+@_exported import TypedIdentifier
+
+public protocol EntityType: TypedIdentifiable, Equatable, Sendable {
+}
+
+extension EntityType {
+  public var entityID: TypedID { 
+    return typedID
+  }
+}