itrabbit / sieve Goto Github PK

View Code? Open in Web Editor NEW

GoLang Package for filtering fields models during serialization

License: MIT License

Go 100.00%

sieve's Introduction

GoLang Package for filtering fields models during serialization

Support:

Scopes filtration fields structures
Exclude strategy (equal fieldValue, equal value)
Export values of higher level

Plans:

Add version for fields
Add code generation for fast serialization
Add support XML, YML serializers

Tag options

s, scopes - for the pane fields in structures;
ns, nextScopes - next scopes in the attachment;
k, exportKeys - exported field or value from the structure fields;
ef, eef, excludeEqualField - exclusion rule field (comparison with another field);
ev, eev, excludeEqualValue - exclusion rule field (comparison with value);
e.any - if you are using multiple conditions, exceptions, if specified, is triggered when any condition.

Example:

type A struct {
    Status string `sieve:"ev:unknown;ev:null;e.any"

    CreatedAt time.Time `sieve:"s:private"`
    UpdatedAt time.Time `sieve:"s:private,admin;ef:CreatedAt"`
}

Example

...

type Option struct {
    Name  string `json:"name"`
    Value string `json:"value"`
}

type Object struct {
    idx       uint64
    Name      string   `json:"name" sieve:"s:*"`
    FullName  string   `json:"full_name" sieve:"s:private"`
    CreatedAt uint64   `json:"created_at"`
    UpdatedAt uint64   `json:"updated_at" sieve:"ef:CreatedAt"`
    Options   []Option `json:"options" sieve:"k:Name"`
}

...

func main() {
    obj := Object{
        100,
        "One",
        "Full",
        100,
        100,
        []Option{
            Option{"1", "Cool"},
            Option{"2", "Great"},
            Option{"3", "Best"},
        },
    }
    if b, err := json.Marshal(Sieve(&obj, "public")); err == nil {
        fmt.Println(string(b))
        // -> {"created_at":100,"name":"One","options":["1","2","3"]}
    }
    if b, err := json.Marshal(Sieve(&obj, "private")); err == nil {
        fmt.Println(string(b))
        // -> {"created_at":100,"full_name":"Full","name":"One","options":["1","2","3"]}
    }
}