[Good First Issues]: implement function "capitalize_word" - 8 points

[MikeG]

Motivation

Vanus Functions are a series of pre-built functions worked within Vanus transformer. By choosing a function, users can specify the way that events will be changed.

It will be a good start if you decide to contribute to Vanus codes.

Details

This function is used to capitalize all words in a string of an existed json element.

Description

Function name: capitalize_word

Function args:

• path: the json path of the string which needs to be capitalized.

Function description: Capitalize all words in a string of an existed json element. The previous value of the json object will be replaced.

Example

For example, if users' original event looks like this:

{
    "specversion" : "1.0",
    "type" : "com.example.someevent",
    "source" : "/mycontext",
    "subject": null,
    "id" : "C234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "comexampleextension1" : "value",
    "comexampleothervalue" : 5,
    "datacontenttype" : "application/json",
    "data" : {
        "appinfoA" : "this is jay ding",
        "appinfoB" : 123,
        "appinfoC" : true
    }
}

After the function "capitalize_word":

"pipeline":[
    {"command":["capitalize_word","$.data.appinfoA"]}
]

The transformed event should look like:

{
    "specversion" : "1.0",
    "type" : "com.example.someevent",
    "source" : "/mycontext",
    "subject": null,
    "id" : "C234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "comexampleextension1" : "value",
    "comexampleothervalue" : 5,
    "datacontenttype" : "application/json",
    "data" : {
        "appinfoA" : "This Is Jay Ding",
        "appinfoB" : 123,
        "appinfoC" : true
    }
}

How to implement

1. Fork the vanus repository.
2. Create a branch function-capitalize-word
3. Create capitalize_word.go under internal/primitive/transform/action/strings, and then implement the function.
4. Create capitalize_word_test.go under internal/primitive/transform/action/strings for unit test.
5. Register your function in internal/primitive/transform/runtime/init.go.
6. Submit your PR

Contribution points

Each issue counts specific points based on its difficulty. Contributors earn the corresponding points if they solve that issue. Contribution points are used to describe the contributions contributors have made. They can also be used to get rewards when there are community events.

This issue counts 8 points.

How to claim to solve the issue

If you want to implement this function, please leave a comment in this issue like:

I'd like to implement this function, please assign this issue to me.

Vanus community will assign the issue to you on time.

[Allen S.]

I'd like to implement this function, please assign this issue to me.

[VedaGao]

I'd like to implement this function, please assign this issue to me.

Thanks for your interest. I will assign it to you, and please join our slack community for better communication.

[Allen S.]

Quick question: keep or remove extra spaces?

Say, the original string has extra spaces, e.g. leading, trailing or duplicate spaces between words. Do we keep those or remove from the resulting string?

[MikeG]

The result string should be the same as the Input but with capitalization.

[MikeG]

Hope this answers your question

[Allen S.]

Got it! Appreciate your quick response.