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

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

ただいまの
回答率

87.77%

Rubyにおいてインデントが深くならないキレイな書き方を教えて下さい。

解決済

回答 4

投稿

  • 評価
  • クリップ 2
  • VIEW 560

score 211

いつもお世話になっております。

背景

ちょっとした単純作業を効率化すべき主にRubyでコードを書いています。
CSVやJSONを取り扱うことが多く、コードを書く際、if や for を多様します。
そうするとインデントが深くなってしまいコードがとても見にくくなってします。
エディターをブラウザと分割して表示しており、エディターの横幅に限界があります。

試したこと

そこで私がとっている対策は、長いコードを何分割かにして関数化しています。
動作1→動作2→動作3という感じに関数化し分割しています。
しかしこれでは分割し関数化にしたコードを再利用しませんし、使い方が間違っていると思い腑に落ちません。

質問

1) インデントが深くなることは、良くないことなのでしょうか?
私にはコードが見づらいので、インデントを多様することにメリットを感じません。

2) forやifを多様せず、効率よく書く方法はないのでしょうか?
JSONを扱っているとfor-if-forのように入れ子になるケースが多くと感じます。

3) ユーザースクリプトを主に書いております。長いコードは、文章のように上から下へコードの流れを書くのが可読性が高いと思っています。
ただ長くなってしまうとインデントが雪だるま式に増えてしまいます。何か対策はないのでしょうか?

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

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

  • nskydiving

    2019/05/29 12:57

    コードによってやり方が変わってくると思いますので、インデントが深いと感じていらっしゃる具体的なコードを提示していただけますでしょうか。

    キャンセル

  • stdio

    2019/05/29 18:08 編集

    C++などではどうしてもインデントが深くなってしまう事が多々あります。
    その上JSONのデータは多重リスト形式になっている事が多い為、インデントが深くなってしまう又は事は避けられないようなことも良くあります。この辺は再起処理で対応しても良いのですが、仕組みを理解していないと苦しい節があるのと、拡張性がなくなるのでおススメはしませんがインデント減らしには最適です。
    あと、80文字で改行してくれるようなエディタもありますので使ってみるのも手かと思います。

    キャンセル

回答 4

+3

しかしこれでは分割し関数化にしたコードを再利用しませんし、使い方が間違っていると思い腑に落ちません。 

メソッド化(関数化)の目的は再利用だけという訳では無いので、使い方は間違っていません。
メソッド化したときに、メソッドにわかりやすい名前を付けられるのであれば、そのメソッド化は有効で、コード全体の可読性を上げます。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2019/05/29 23:51

    そういえば、「1つのメソッドで制御構造(ループとか、条件判断)は1つまで」という細かくメソッド分けるコーディングルールもあるようです。
    これは、名前付けに苦しみそうですが。

    キャンセル

checkベストアンサー

+1

皆さんおっしゃってるように、インデントが深くなるのは読みにくいです。1画面に収まらないときなど、ここはどの階層??? と道に迷うことが多いです。
そのために再利用のないmethodに切り出すのも皆さんおっしゃるとおりです。

JSONてなんでもありなので、なんでもありな場合は使えませんが、質問のcodeをみると定義された構造を持ったJSONだと思われますのでその前提で。

わたしがよくやるのは以下のような方法です

def 第一階層の処理
  前処理
  第一階層の要素達.each
     case
     when ; 第二階層case1の処理
     when ; 第二階層case2の処理
     end
  end
  後処理
end
   :
   :
def 第123階層の処理
  前処理
  第123階層の要素達.each124階層の処理
  end
  後処理
end

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2019/06/24 17:46

    回答が遅くなってしまい申し訳ございません。
    非常に参考になりました。
    ありがとうございます!

    キャンセル

+1

コードが無いと具体的には説明しづらいのですが、
データ加工の処理はループだけで書くと下のようになりがちですね。
メソッド分割したところで、ループ処理があっちこっちに行ってしまうと、見通しが悪くなりがちです。

loop {
  Aの処理
  loop {
    Bの処理
    loop {
      Cの処理
    }
  }
}


(loopのとこはwhileだったりするかもしれませんが。)

こういうときは、Enumerableにあるメソッドで、一括して処理してあげると、ネストが深くならずに書くことができます。
処理が増えても、下へ下へ伸びるだけですし、メソッド化しても大きな流れを見失うことは無いかと思います。

https://docs.ruby-lang.org/ja/latest/class/Enumerable.html

対象のデータ.
  xxx { Aの処理 }.
  xxx { Bの処理 }.
  xxx { Cの処理 }

xxxの部分で呼び出すべきメソッドは処理の内容によっていろいろです。

単にループを回したいだけならeachだったり
値を変換する処理ならmap
if/unlessを置き換えるなら、selectやrejectなど。

処理内容が長くなりすぎてしまうと、読みづらいので、メソッド化するとよいです。
その際はぜひrubyの特徴であるブロックを使いましょう。
ブロック引数の使い方を学ぶといいです。
https://docs.ruby-lang.org/ja/latest/doc/spec=2fdef.html#method

Enumerableには、隣接する要素を加工する(each_slice)とか、二つの配列から値を組み合わせる(zip)とか、変わり種なメソッドもあります。
まずはリファレンスを眺めてみると良いのではないでしょうか。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

+1

コードを見せていただけないとコメントしづらいですが、rubocopなどを使って解析してみらいかがでしょうか?

どうしたらベストかは人それぞれだとおもいますが、良い解決策が見えてくるかもしれませんよ。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

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

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

関連した質問

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