Hanami::Annotate

This gem can add annotation to entities and repositories of hanami.

This gem support for postgres only now.

Installation

Add this line to your application's Gemfile:

group :plugins do
  gem 'hanami-annotate'
end

And then execute:

$ bundle install

Usage

After the bundle exec hanami db prepare

$ bundle exec hanami annotate

and already annotations has added. Just like a below

#                                      Table "public.users"
#    Column   |            Type             |                     Modifiers
# ------------+-----------------------------+----------------------------------------------------
#  id         | integer                     | not null default nextval('users_id_seq'::regclass)
#  name       | text                        | not null
#  email      | text                        | not null
#  created_at | timestamp without time zone | not null
#  updated_at | timestamp without time zone | not null
# Indexes:
#     "users_pkey" PRIMARY KEY, btree (id)
#
class UserRepository < Hanami::Repository
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hanami-annotate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Hanami::Annotate project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.