annotaterb

AnnotateRb

forked from the Annotate aka AnnotateModels gem

A Ruby Gem that adds annotations to your Rails models and route files.

---

Adds comments summarizing the model schema or routes in your:

• ActiveRecord models
• Fixture files
• Tests and Specs
• FactoryBot factories
• routes.rb file (for Rails projects)

The schema comment looks like this:

# == Schema Information
#
# Table name: users
#
#  id            :integer          not null, primary key
#  name          :string
#  email         :string
#  sign_in_count :integer          default(0), not null
#  admin         :boolean          default(FALSE), not null
#  created_at    :datetime         not null
#  updated_at    :datetime         not null
#
class User < ApplicationRecord
  ...

---

Installation

$ gem install annotaterb

Or install it into your Rails project through the Gemfile:

group :development do
  ...

  gem "annotaterb"

  ...

Automatically annotate models

For Rails projects, model files can get automatically annotated after migration tasks. To do this, run the following command:

$ bin/rails g annotate_rb:install

This will copy a rake task into your Rails project's lib/tasks directory that will hook into the Rails project rake tasks, automatically running AnnotateRb after database migration rake tasks.

$ bin/rails db:migrate
# ...
# Annotating models
# Annotated (1): app/models/user.rb

To skip the automatic annotation that happens after a db task, pass the environment variable ANNOTATERB_SKIP_ON_DB_TASKS=1 before your command.

$ ANNOTATERB_SKIP_ON_DB_TASKS=1 bin/rails db:migrate

Added Rails generators

The following Rails generator commands get added.

$ bin/rails generate --help

...

AnnotateRb:
  annotate_rb:config
  annotate_rb:hook
  annotate_rb:install
  annotate_rb:update_config
...

bin/rails g annotate_rb:config

• Generates a new configuration file, .annotaterb.yml, using defaults from the gem.

bin/rails g annotate_rb:hook

• Installs the Rake file to automatically annotate Rails models on a database task (e.g. AnnotateRb will automatically run after running bin/rails db:migrate).

bin/rails g annotate_rb:install

• Runs the config and hook generator commands

bin/rails g annotate_rb:update_config

• Appends to .annotaterb.yml any configuration key-value pairs that are used by the Gem. This is useful when there's a drift between the config file values and the gem defaults (i.e. when new features get added).

Migrating from the annotate gem

Refer to the migration guide.

Usage

AnnotateRb has a CLI that you can use to add or remove annotations.

여기까지가 README 앞부분입니다. 나머지는 원문에서 읽을 수 있습니다. README 전문 보기 ↗