RFC: shards version to obtain current version defined in shard.yml

[luislavena]

For some libraries I define VERSION constant to help me obtain version information at runtime of the components used by other tools.

The issue I found is that on every release, I have to update version.cr, shard.yml and match with the tag used in Git.

Was thinking that could be possible to introduce a way to read shard.yml (provided by shards itself) so a macro can be used to generate the VERSION constant.

Not sure about the name of the command, but if approved I can send a pull request to introduce it.

Thank you. ❤️ ❤️ ❤️

[Sija]

Sth like this? :)

module Foo
  VERSION = begin
    YAML.parse(File.read(File.join(__DIR__, "../..", "shard.yml")))["version"].as_s
  end
end

[luislavena]

That needs to be read at compile time, if not it will depend on shard.yml being present when executed, which is why suggested something that can be used with macros. Sorry for top posting, sent from mobile.

…

On Jan 21, 2017 14:43, "Sijawusz Pur Rahnama" ***@***.***> wrote: Sth like this? :) module Foo VERSION = begin YAML.parse(File.read(File.join(__DIR__, "../..", "shard.yml")))["version"].as_s endend — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#147 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAQVtFmF0MjwSsoOpd09_ICNmKELmQLks5rUkPMgaJpZM4Lp4gl> .

[mverzilli]

I think it's a valuable addition. @ysbaddaden, would you be against adding this?

[ysbaddaden]

No strong opinion. That would allow something like:

module Wonderful
  VERSION = {{ `shards version` }}
end

Thought, how to be sure that the folder the command is run in, is the one with the expected shard.yml? Won't it usually be the main project's folder? This is fine for the project, but that will fail for libraries installed under lib. This is the only issue I foresee.

Or maybe the following would work, granted that the command would search the parent folders recursively for a shard.yml file:

module Wonderful
  VERSION = {{ `shards version __DIR__` }}
end

[luislavena]

Thank you @ysbaddaden for taking the time to look into this.

Really didn't put a lot of thought into the idea, which got exposed by the issue you described for libs (and what could be a problem).

I think that shards version __DIR__ is a nice a nice solution!

Will you accept such contribution? Will try to find some time to hack on this during the weekend.

Thank you.

❤️ ❤️ ❤️

[ysbaddaden]

Please do ❤️

[luislavena]

Done!, submitted #148.

Cheers! 😸