🎨 Improving API structure for readability

[cHaLkdusT]

Updating API signature when using SVGParser to avoid confusion. Should be resource instead of path

[ystrot]

Hey Julius!

Thank you for your work. We already had similar discussion regarding this method: #269 (comment)

So let's me briefly go through my points:

• Macaw doesn't break API in minor versions. So the first step would be to deprecate existing parse methods.
• Let's add the new method compatible with Bundle.path/Bundle.url:

open class func parse(resource: String, ofType: String = "svg", inDirectory: String? = nil, fromBundle: Bundle = Bundle.main) throws -> Node

Note that Swift using forResource name, because it's correct to say "path for resource", but will be wrong to say "parse for resource". So in our case it should be resource. Also it would be better to make fromBundle the last attribute to use main by default.

• Finally we need another method:

open class func parse(fullPath: String) throws -> Node

which will be used in other methods.

I would be happy to apply your PR if you'll update it as I suggested. Also feel free to comment if you don't agree 😊

[cHaLkdusT]

Hi Yuri,

I have now made the changes as per your comment.

✨ Implemented open class func parse(resource: String, ofType: String = "svg", inDirectory: String? = nil, fromBundle: Bundle = Bundle.main) throws -> Node
✨ Implemented open class func parse(fullPath: String) throws -> Node
✅ Added unit test for the new API

Cheers,
Julius

[ystrot]

Thank you!