Feature request: deprecations

[tigris]

It'd be super cool if I could just set deprecated: true on an attribute/component.

Or alternatively set it to a "deprecation_message" rather than just a boolean.

But it'd be nice if you could do this at a component level, as well as individual attributes.

One would have to ask for these deprecations manually, after the config was loaded. E.g. config.deprecations.each{|key, message| logger.warn("DEPRECATED: #{key} - #{message}") }

Since the config struct itself has no concept of a logger, or what might happen with deprecations, it simply needs the ability to mark a particular thing as deprecated, and a means to access all that info.

Let me know if you'd be interested in something like this at the global layer, otherwise I'll hack something for our specific needs.

[mdub]

Hmm, interesting. It's almost like config_errors, yeah, but more config_warnings. I wonder if there's a way to integrate them?

[tigris]

config_warnings was my first idea too, then realised i wanted it just for deprecations in this instance

but yeah, if a component had a way of defining config_warnings method, it could introspect itself to see if any of the deprecated attributes are set, as well as deprecate itself if need be.

not quite as nice as a simple deprecated: "message here" on the element definition, but a fair bit more flexible and way easier to implement

[mdub]

Could do both; surface config_warnings, and implement deprecated sugar that ends up generating warnings.

I reckon one could generate warnings on use of the deprecated setter/getter method, rather than based on what attributes ended up populated.

I imagine renaming of attributes is a common case, so perhaps explicit support for deprecating older names would be handy, e.g.

attribute :orientation, :formerly_known_as => :facing

component :position, :formerly_known_as => :pos do ...

[tigris]

Ok, i got a start master...tigris:config_warnings

However, I can't make components deprecate easily. They're always set to an empty class.

[mdub]

Ever get anywhere with this, @tigris?

[tigris]

Sorry @mdub - no further than in that branch.

Unless I can make kubernetes know about ConfigMapper, I can't see myself extending on it much further :/

When will :k8s: get include support! Happy to close this issue if you wish.

[mdub]

Yep, closing for now.