vexy / fridge Goto Github PK

Rework and better expose FridgeErrors model.

This might be useful during

• development - want to clean up my mess :)
• when migrating data - get existing structures and convert them to new ones.
• data structure validation - when data is important

README link leading to Playground is broken.

Implement Fridge[storage_id] as a "shortcut" for unfreezing.

What happens when a model gets updated?

It seems that Fridge fails to unfreeze existing data into a new structure. I see two cases here:

1. extended model (e.g., new field added): I expected this to work when a new field has a default value.
2. modified model (e.g., existing fields changes type etc): this is ok to fail.

One idea is to catch errors on load and then try to import data by first loading them into a generic dictionary/map (whatever is available on swift) and then manually importing data into the new, extended structure. This process could also give a mapping callback that could be used in case of modified fields (e.g. (fieldName, oldValue) -> newValue)

Add a method that async returns raw data from a given endpoint.

Follow this workflow to get more details:

https://github.com/vexy/Fridge/runs/5401079443?check_suite_focus=true

Provide a method for saving/retreiving hashed transformation of given struct.

Merge or combine the tests.

There's no real difference in functional testing.

Close the classes for public use

Create simple Playground file demonstrating basic usage example.

Add method that pushes an object using provided URLRequest

Got this warnings while building:

'NIOAtomic' is deprecated: please use ManagedAtomic from https://github.com/apple/swift-atomics instead

Implement separate operation queue for background I/O operations.

Add new or update existing code examples.

Demonstrate few Xcode example projects and the way how Fridge can be used:

• Github repos simple app
• Link Clmn app as usage example

Make sure async operations are performed on proper thread.

Adjust workflow files not to fail on tests

Remove Xcode files/folder and keep using only Package.swift.

Bump package dependencies to their latest versions.

Make sure that inline code documentation matches desired functionality.

Add another method that allows the users to get (an array perhaps) of [String] identifiers.

• Freezer

• BSONConverter

Provide better support for Array types.

Update documentation before each public release.

Add a method that can push (send) given object to a certain URL.

Object must confirm to Codable.

If the passed object fails to be parsed to JSON the method will throw.

Add a public method that allows changing field value of an already frozen struct without the need for unfreezing.

New value should be present at next unfreeze attempt.

eg:

try Fridge.adjust(FrozenStruct.Self, field: \.field1, value: 10)

• Update architecture diagram
• Update README
• Update code documentation

Expand freezing to system Cache folder as an additional option.

Instead of providing String based key, allow freezing and grabbing structs that conform to Identifiable.