質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.51%

  • Ruby

    8954questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

  • Ruby on Rails

    8372questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

Railsのメソッド引数で、指定オプションの一覧表示は可能でしょうか。

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 82

TakashiAihara

score 15

お世話になります。

自分は元々、Javaソフトの保守をやっていました。
現在、Ruby on Rails を使って、開発に取り組んでおります。

メソッド引数において、ハッシュを用いた可変長的なオプションの指定が、Railsの特徴の1つと思っています。
この「オプション」のうち、指定できるもの(指定を想定されているもの)を、何らかの形で一覧表示するようなことは可能でしょうか。
リファレンスなどから読み解くか、ソースコードを追うしか無いでしょうか。

もし指定オプションの名前が間違っていても、エラーも出ず、原因調査に時間がかかってしまいます。
皆様の知識をお借りいただけますと幸いです。

補足(質問の経緯)

現状解決している悩みですが、上記の相談に至った経緯はざっくり以下のような感じです。

  • 現状動いているDBに、commentを含むカラム追加が必要になった。
  • 新たにmigrationファイルを出力した。
  • add_column というメソッドが生成されたが、commentの追加方法がわからない。
  • ネット上で検索をしてみたが、先人の知恵が見つからない。
  • ソースコードをざっくり見てみたところ、comment を含む定義が見つかった。
  • ただ、明確な指定方法がわからなかった。
  • 末尾に comment: "***" を単純に追加したところ、migrationで反映された。
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • gouf

    2019/03/14 17:33

    すべてに適用できるかはわかりませんが、今回の add_column であれば API ドキュメントを参照すると、どの引数を渡すべきなのか、任意のオプション引数としてどのようなキー値とその値が指定できるのかがわかります : https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_column

    (Top ページ: https://api.rubyonrails.org/ )

    キャンセル

  • TakashiAihara

    2019/03/14 23:42

    ありがとうございます。
    ご提示いただいたページで、:commentなど見れるようですね。
    誠に助かります。
    日本語のページだと見つからなくて、
    やっぱりRailsでは特に、英語嫌悪せず立ち向かう必要がある感じですね・・・

    キャンセル

回答 1

checkベストアンサー

+2

Rubyデフォルトの方法で定義された場合のキーワード付き引数ですと

def test hoge:, foo:
end

p method(:test).parameters
# => [[:keyreq, :hoge], [:keyreq, :foo]]

が取れるのですが

Railsの場合は厳密にはキーワード付き引数をもつメソッドではなく
「末尾の引数がハッシュの場合は{}が省略できる」というルールによってキーワード付き引数のように見えるメソッドなので
取得する事ができません。

ドキュメントを精査し、必要に応じてメソッド定義を読むしかありません。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/03/14 23:40

    誠にありがとうございます。
    長いこと悩んでいたので、スッキリしました。
    コードを追うようにします。

    キャンセル

同じタグがついた質問を見る

  • Ruby

    8954questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

  • Ruby on Rails

    8372questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。