Should we deprecate encapsulation violation as an API?

[dagolden]

Right now, YAML::Tiny is a blessed arrayref and encourages users to access it directly to get at documents.

In the future, Ingy has indicated that YAML will have an OO API, not a functional one.

By encouraging encapsulation violation, we lock YAML::Tiny into one and only one OO model, which severely limits future options.

For version 2, should we deprecate direct access? (E.g. overload array deref to warn. This would prepare YAML::Tiny for a future OO model not tied to direct arrayref access.

[jkeenan]

On 10/28/13 9:15 AM, David Golden wrote:

Right now, YAML::Tiny is a blessed arrayref and encourages users to access it directly to get at documents.

Can you provide an example of where the codebase or the documentation
actually "encourages" users to do this? When I was studying the code
recently no light went off in my head concerning this.

Thank you very much.
Jim Keenan

[dagolden]

The whole SYNOPSIS is full of $yaml->[0]->{foo} examples.

[adamkennedy]

If we leave things the way they are, consumers of YAML:Tiny need to
migrate their code once. If we introduce a new API now, and it's
different in any way from the final form of YAML, consumers need to
migrate twice.

Also, the current approach was specifically taken to avoid the weight of an
API.
On Oct 28, 2013 6:15 AM, "David Golden" [email protected] wrote:

Right now, YAML::Tiny is a blessed arrayref and encourages users to access
it directly to get at documents.

In the future, Ingy has indicated that YAML will have an OO API, not a
functional one.

By encouraging encapsulation violation, we lock YAML::Tiny into one and
only one OO model, which severely limits future options.

For version 2, should we deprecate direct access? (E.g. overload array
deref to warn. This would prepare YAML::Tiny for a future OO model not tied
to direct arrayref access.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/18
.

[dagolden]

Fair enough. I'll move this off the 2.00 milestone list, but keep it as a reminder for later.