Support YARD notation #724
Conversation
lib/annotate/annotate_models.rb Outdated
| ([id] << rest_cols << timestamps << associations).flatten.compact | ||
| end | ||
| | ||
| def map_col_type_to_ruby_classes(col_type) |
There was a problem hiding this comment.
Just curious - can you elaborate why it should not be private and public instead?
There was a problem hiding this comment.
I don't know, my first idea was that it can be reused somewhere else but seems not yet so i'll add it in private
lib/annotate/annotate_models.rb Outdated
| when 'datetime', 'timestamp', 'time' then Time.to_s | ||
| when 'date' then Date.to_s | ||
| when 'text', 'string', 'binary', 'inet', 'uuid' then String.to_s | ||
| when 'json', 'jsonb' then Hash.to_s |
There was a problem hiding this comment.
When a model has a json/jsonb column, it's transformed in Hash class in ActiveRecord. That's the same logic i've followed here.
lib/annotate/annotate_models.rb Outdated
| when 'date' then Date.to_s | ||
| when 'text', 'string', 'binary', 'inet', 'uuid' then String.to_s | ||
| when 'json', 'jsonb' then Hash.to_s | ||
| when 'boolean' then 'Boolean' |
There was a problem hiding this comment.
Does this change any current behavior?
There was a problem hiding this comment.
Seems not. Boolean is a class that YARD understand quite well. It's better than TrueClass and FalseClass
There was a problem hiding this comment.
If you are referring to just the boolean case, Boolean is the string for what YARD expects a boolean type to be in the comments.
| @tvallois looks like it's good to go. If you can resolve merge conflicts I'm happy to merge this in next 🙂 |
done :) |
| 🎉 excited for this! |
The scope of this pull request is to allow annotate_models to generate models documentation using YARD. This is the first step, I'll add more features later.
3 participants
Hi,
The scope of this pull request is to allow annotate_models to generate models documentation using YARD. This is the first step, i'll add more features later.