arolek / ase Goto Github PK

At the moment, the example code showcasing the ASE decoder writes the output to stdout.

What constitutes "better logging" in this context: file output options, output formatting, or something else? @ARolek

Implement the Encode functionality such that we can convert the struct to an encoded ASE file. We can use the logic from existing code libraries and port it over to Go.

Resources

• ASE Encoder in ActionScript
• ASE Encoder in PHP
• ASE File Spec
• ASE Encoder Rough Draft by @ARolek

Problem

Throughout the code base, there are several unused public methods that could better serve as private methods.

Let's take block.go as an example.

The block struct has three methods exposed: block.Read, block.ReadType, and block.ReadLength. Outside of block.go, block.Read is the only public method used by ase.go. The other two functions should thus be converted to private methods (submitting a PR with lowercased methods could do).

Proposed Solution

Identify the unused public methods in each respective ase component in this issue, open a discussion for what could be made private, and submit a PR with the appropriate changes.

Allowing this project's build to be checked against the Travis CI service would be a great enhancement to prove its stability and reliability.

Would just need the travis.yml file pushed up.

Write unit tests for each ase component. There are currently four files that could use testing and will be asserting that each of their respective public methods work as promised.

The official ase godoc could benefit from a succinct annotation of each public method as well as an accompanying code example.

While working on the refactor for this library, I have collected a handful of observations that helped me understand the ASE specification as detailed by Selapa's ASE Specification.

I think the README could benefit users by explaining what that specification is in clearer terms, how the ase.Decode function works at a high-level, and the meaning of each key-value pair in the output struct.

"Make it as open as possible" @ARolek

MIT License it is.