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

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

ただいまの
回答率

91.01%

  • Ruby

    6379questions

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

  • コーディング規約

    44questions

    コーディング規約とは、コードの書き方についての決め事のことです。 文法のことではなく、そのチームなどの中の約束事としてどのような書き方で行うかを定めるもの。 項目の例として、関数や変数の命名規則、コーディングのスタイル、括弧やインデントの書き方などが挙げられます。

  • 命名規則

    31questions

    命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

Rubocopのルールにある、otherの意味(と対策)

解決済

回答 1

投稿

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

maisumakun

ユーザーランキング総合1位

Rubocopを使ってRubyプロジェクトのスタイル管理などを行っているのですが、そのルールの中にNaming/BinaryOperatorParameterNameというものがあります。

これは、こちらのスタイルガイドにもあるように、「([]<<を除く)2項演算子を実装するときには、仮引数名をotherにする」というものです。

もちろん、普通の数値演算などであればotherで特に問題ないのですが、時刻や(Rubyにはないですが)ポインタに対する加算のように、「別の種類の値しか足し算できない」ようなものについては、otherを使うことで逆にわかりにくくもなるように思えます。

ここで質問なのですが、

  1. 「このような状況でもotherを使うべき」なのでしょうか、それとも「別種の値であれば名前を変えるべき」なのでしょうか。
  2. 名前を変える場合に、Rubocopのエラー対策としては「Naming/BinaryOperatorParameterName自体を止める」「演算子実装のところで#rubocopコメントを入れる」など、どのような方法が適切でしょうか。

なお、「プロジェクト内に確立したコーディング規約はない」という条件で考えていただければ幸いです。

  • 気になる質問をクリップする

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 1

checkベストアンサー

0

こんにちは。

「このような状況でもotherを使うべき」なのでしょうか、それとも「別種の値であれば名前を変えるべき」なのでしょうか。

「名前を変えるべき」でしょう。
残念ながら、このような別種の値を受け取るようなケースと、同種の値を受け取るようなケースをRuboCopは区別することができません。
そのため、このようなナンセンスな警告がRuboCopでは発生してしまいます。
RuboCopを盲信するあまりナンセンスなコードになってしまっては意味がないので、このような場合は適宜警告を無視するのが適切でしょう。

名前を変える場合に、Rubocopのエラー対策としては「Naming/BinaryOperatorParameterName自体を止める」「演算子実装のところで#rubocopコメントを入れる」など、どのような方法が適切でしょうか。

これについてはケースバイケースになると思います。

「Naming/BinaryOperatorParameterName自体を止める」場合はには、「誤った警告に煩わされることがない」「# rubocop:disable ... コメントがコード内に入らない」などのメリットがあります。
ですが、本当に警告を出してほしい場合にも警告が出なくなってしまうため、プロジェクトとして「この項目は検査するほどでもないだろう」という共有が出来た場合に無効にすべきだと思っています。

「演算子実装のところで#rubocopコメントを入れる」場合には上記の例とは真逆の効果となります。
disable用のコメントはコード中に入ってしまいますが、コードの他の箇所に関しては問題なく検査を続けることが可能です。

また、第3の選択肢として、RuboCopと連携するツールを使う、というものがあります。
例えばreviewdogというツールを使うと、CIでRuboCopを動かし、その警告をGitHub上にコメントとしてつけることが出来ます。これにより警告をGitHub上のコメントとしてみることが出来るため、警告が出るようなコードが存在していても気にならなくなります。

また、(私が開発に関わっているサービスなので宣伝になってしまい申し訳ないのですが)SideCIというサービスを使うと、SideCI上でRuboCopを実行し、今回の例のような誤った指摘はSideCIのUI上から無視することが出来るため、コード中にdisable用のコメントを埋め込むことなく誤った指摘を無視することが可能です。

エラー対策としては、プロジェクトの方針や検査の種類によって最善の方法は変わってくるので、適宜よさそうな方法を選択するしかないかなーと思っています。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2017/11/15 14:46

    ありがとうございます。「ツールが万能でない」のは重々承知なのですが、もっと深い意味があるのかなと気にしてしまいました。

    キャンセル

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

  • ただいまの回答率 91.01%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

  • 解決済

    rubyのサーバー起動について

    rubyにwebrickというサーバー起動ツールが、標準添付されているということで、コマンドプロンプトに、rails serverと打ち込んだのですが、いろいろ文字が出てきて、おそ

  • 解決済

    rubocop_todo.ymlが使えない

    rubocop(v0.34.1)を使っているのですが、rubocop_todo.ymlが使えなくて困っています。 rubocop.ymlにはinherit_from: .rub

  • 解決済

    ToFormattedString メソッドとは?

    ToFormattedString メソッドをどんな時に、何の為に使うのかが理解できません。 検索してみると下記のような説明文がヒットしましたが理解が出来ません・・。 もう少し簡単

  • 受付中

    Railsでのgitignore

    Railsをgitで管理しているのですが、tmp/cache内のファイルがアプリケーションサーバを起動するたび、変更されます。 変更されるので、addまちとなってしまいます。 普

  • 解決済

    pdfimagesをpopplerライブラリから実行したい

    popplerライブラリを使ってpdfに含まれている画像を取り出し、それをrmagickライブラリに渡して処理をしようとしてます。現状、rubyのスクリプト中で %(pdfi

  • 解決済

    rubyでレガシーブラウザを判定するには?

    IE10以下, Safari 5以下, Chrome 5以下, Firefox 4以下, Opera 11.5以下のレガシーブラウザからのアクセスをサーバサイドで判定し、アプリケー

  • 解決済

    rubyのsplit関数のソースについて

    おはようございます rubyのsplitやchomp関数のソースがみたくて、rubyのgitをcloneしたのですが、それらしい部分がどこにもありませんでした。 かかれ

  • 解決済

    ゲームソフトのサーバーのAPIを叩こうとしたら

    

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

  • Ruby

    6379questions

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

  • コーディング規約

    44questions

    コーディング規約とは、コードの書き方についての決め事のことです。 文法のことではなく、そのチームなどの中の約束事としてどのような書き方で行うかを定めるもの。 項目の例として、関数や変数の命名規則、コーディングのスタイル、括弧やインデントの書き方などが挙げられます。

  • 命名規則

    31questions

    命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。