Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding ndjson format #218

Merged
merged 6 commits into from
Oct 9, 2023
+26 −5
Merged

adding ndjson format #218

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
455c053
adding ndjson format
jose-sherpa Sep 6, 2023
188e01d
changing to use command line switch
jose-sherpa Sep 11, 2023
8cfd180
cr comments
jose-sherpa Sep 20, 2023
c362e55
changing bool from ndjson to stream
jose-sherpa Oct 4, 2023
bcf00e7
no new line for empty json if streaming
jose-sherpa Oct 4, 2023
b26cb6d
changed help text
jose-sherpa Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions cli/cmd/transformCmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ func doTransform() error {
if err != nil {
return "", err
}

if schema.Header().ParserSettings.NDJSON {
return string(b), nil
}

return strings.Join(
strs.NoErrMapSlice(
strings.Split(jsons.BPJ(string(b)), "\n"),
Expand All @@ -95,13 +100,27 @@ func doTransform() error {

record, err := doOne()
if err == io.EOF {
fmt.Println("[]")
if schema.Header().ParserSettings.NDJSON {
fmt.Println("")
} else {
fmt.Println("[]")
}
return nil
}
if err != nil {
return err
}
fmt.Printf("[\n%s", record)

start := "[\n%s"
middle := ",\n%s"
end := "\n]"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be able to come up with better names or create a method on parser settings that returns a struct that encapsulates these variables

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably lparen and rparen, and delim might be a better naming option?

I'm fine with the current implementation you proposed. But do need to add unit tests - we tried very hard to keep coverage at 100%.

I'm thinking about adding a utility into https://github.com/jf-tech/go-corelib/tree/master/jsons which this omniparser uses extensively, that the utility is a json writer and encapsulates the functionalities you implement here. But that's a later optimization/refactoring. No need for this time. Just unittest coverage.

if schema.Header().ParserSettings.NDJSON {
start = "%s"
middle = "\n%s"
end = ""
}

fmt.Printf(start, record)
for {
record, err = doOne()
if err == io.EOF {
Expand All @@ -110,8 +129,8 @@ func doTransform() error {
if err != nil {
return err
}
fmt.Printf(",\n%s", record)
fmt.Printf(middle, record)
}
fmt.Println("\n]")
fmt.Println(end)
return nil
}
1 change: 1 addition & 0 deletions header/header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ type ParserSettings struct {
Version string `json:"version,omitempty"`
FileFormatType string `json:"file_format_type,omitempty"`
Encoding *string `json:"encoding,omitempty"`
NDJSON bool `json:"ndjson,omitempty"`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is the type of case preferred in this project

}

const (
Expand Down
3 changes: 2 additions & 1 deletion validation/parserSettings.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion validation/parserSettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"encoding": {
"type": "string",
"enum": [ "utf-8", "iso-8859-1", "windows-1252" ]
}
},
"ndjson": { "type": "boolean" }
},
"required": [ "version", "file_format_type" ],
"additionalProperties": false
Expand Down