annotaterb v4.21.0 commit log 流し読み
annotaterb v4.21.0 commit logを流しで読みました 👀
読んだ範囲は、v4.21.0 の 変更点 から、以下の記事に掲載されている分を除いた差分です。
Bump actions/checkout from 5 to 6#299
actions/checkout を v6 にアップデートしています。
refs: Bump actions/checkout from 5 to 6
Include ignore_multi_database_name in generated config#304
ignore_multi_database_name オプション自体はすでに実装されていましたが、OTHER_OPTION_KEYS に追加されていませんでした。
そのため、annotate_rb:install を実行して生成される .annotaterb.yml に、このオプションが含まれない状態になっていました。
今回のコミットでは、ignore_multi_database_name を OTHER_OPTION_KEYS に追加することで、生成される設定ファイルにも正しく反映されるよう修正されています。
refs: Include ignore_multi_database_name in generated config
Add integration test for ignore_multi_database_name config option#305
ignore_multi_database_name は設定ファイルで指定できるものの、マルチDB環境で正しく動くことを確認する統合テストがありませんでした。
今回のコミットでは annotate_models_in_multi_db_spec.rb にテストを追加し、ignore_multi_database_name: true を設定した場合に primary / secondary 両方のモデルの annotation から DB 名が除外されることを検証しています。
refs: Add integration test for ignore_multi_database_name config option
Add to_yard and to_rdoc methods to Annotation classes#302
format_rdoc / format_yard オプションを有効にした際、各 annotation セクション（index ブロックや fk ブロックなど）のクラスに to_rdoc / to_yard メソッドが定義されていなかったため、NoMethodError が発生していました。
このコミットでは、該当クラスに to_rdoc と to_yard メソッドを追加しています。ただし、この時点では実際に RDoc / YARD 形式へ整形する具体的な処理までは実装されておらず、まずはエラーを解消するための土台を整えた形になっています。
refs: Add to_yard and to_rdoc methods to Annotation classes#
Update Rails generator command in README#296
README にて generate コマンドが generator と誤記があったため、修正されています。
refs: Update Rails generator command in README
Support customising config path#301
デフォルトでは .annotaterb.yml の探索対象パスは以下に固定されていますが、今回の変更で CLI に --config-path #{path} を指定することで、任意のパスに置いた設定ファイルを利用できるようになりました。
.annotaterb.ymlconfig/annotaterb.yml.config/.annotaterb.yml.config/annotaterb/config.yml
monorepo 構成の Rails アプリで、複数プロジェクトを横断して共通の設定ファイルを使いたい、というニーズに対応した変更のようです。