liquidsoul / sourcery-autojsonserializable Goto Github PK

Given that people could use Sourcery annotations for multiple things and that they could be used by various templates all processing the type, better avoid names that are too generic 😉

The need to add AutoJSON* protocols to the user's code should not be needed because we can use an annotation to achieve the same goal and it would involve less stuff to do from the user.

This would result in this:

// sourcery: AutoJSONSerialization
struct Contact {
...
}

Instead of:

protocol AutoJSONSerialization {}

struct Contact: AutoJSONSerialization {
...
}

For the moment the protocols use [String: Any] as their source of data.
This prevent the creation of custom types not only described by a JSON object.
For example, we could imagine deserialize Base64 encoded string into a nice looking structure.
We cannot do that if the input type of the protocol is [String: Any].

Look into supporting this kind of scenario:

class Base {
    let id: String
}

class Child: Base {
    let name: String
}

where Child can be deserialized from (and serialised to) this JSON data:

{
  "id": "Some Identifier",
  "name": "Some name"
}

Once #12 is implemented, the need of a specific support for Dates object within the tool will not be necessary anymore because the user will be able to implement his own custom serialisation of dates.

We could still offer a custom serialiser for Dates as an option though.

The SPM integration is not satisfactory and should be change for several reasons:

1. It adds the whole Sourcery tree as a dependency to the project and Xcode does not appreciate it very well
2. it adds the overhead of compiling Sourcery or at least checking it was compiled

The steps I see:

• add a basic script to download a specified version of Sourcery in its binary portable binary form
• add it to the repository
• update the source code to use the binary version instead of building a Sourcery binary
• (optional) add Makefile rule to fetch the binary if necessary instead of storing it in the repository