読みやすいコード

 読みやすいコード

Ecad9d801d79f6c6e5df93094690685e?s=128

Takumi Shotoku

December 05, 2019
Tweet

Transcript

  1. 読みやすいコード 表参道.rb #53 2019/12/05(Thu) 1

  2. 自己紹介 名前: 神速 会社: メドピア株式会社 GitHub: @sinsoku (アイコン右上) Twitter: @sinsoku_listy

    (アイコン右下) 2
  3. コードを読みやすく書きたい 3

  4. 読みやすいコードとは何か 4

  5. 考えてみた • 短いコード • 条件分岐の少ないコード • 適切な命名の変数、クラス、メソッド...etc • メソッド呼び出しのネストが浅い 5

  6. メソッド呼び出しのネストが深い例 def index set_user end private def set_user user_name =

    get_user_name_from_api @user = User.find_or_initialize(user_name: user_name) end def get_user_name_from_api api = Sugoi::API.new(token: ENV['SUGOI_TOKEN']) user_name = api.get_user_name convert(user_name) end def convert(user_name) user_name.gsub('-', '_') end 6
  7. 浅くした例 def index user_name = api.get_user_name converted_user_name = user_name.gsub('-', '_')

    @user = User.find_or_initialize(user_name: converted_user_name) end private def api @api ||= Sugoi::API.new(token: ENV['SUGOI_TOKEN']) end 7
  8. 話を戻して... 8

  9. 読みやすいコードの条件(主観) • 短いコード • 条件分岐の少ないコード • 適切な命名の変数、クラス、メソッド...etc • メソッド呼び出しのネストが浅い 9

  10. RuboCopでだいたい検出できる • Metrics/AbcSize • Metrics/ClassLength: • Metrics/MethodLength 10

  11. これで読みやすいコードになる! 11

  12. しかし、現実は... # rubocop:disable Metrics/AbcSize Metrics/MethodLength def index # rubocop:enable Metrics/AbcSize

    Metrics/MethodLength set_user set_blogs if params[:new] @users = User.where(foo: params[:foo]) .foo .bar .buz elsif params[:create] @users = User.where(foo: params[:foo]).piyo else # ർΕͨͷͰུ end end 12
  13. Metrics/AbcSize を下げるテクニック 1. 変数を定義しない 2. Array(Enumerable)のメソッドを駆使する 3. クラスを抽出する 13

  14. 1. 変数を定義しない # bad def count_blogs(users) result = {} users.each

    do |user| next unless user.active? result[user.id] = uesr.blogs.size end result end 14
  15. 1. 変数を定義しない # good def count_blogs(users) {}.tap do |result| users.each

    do |user| next unless user.active? result[user.id] = uesr.blogs.size end end end 15
  16. 2. Array(Enumerable)のメソッドを駆使する • if/unlessよりselect/reject # good def count_blogs(users) # active_users

    = users.select { |user| user.active? } ͱಉ͡ active_users = users.select(&:active?) {}.tap do |result| active_users.each do |user| result[user.id] = uesr.blogs.size end end end 16
  17. 2. Array(Enumerable)のメソッドを駆使する • このケースは to_h で良い # good def count_blogs(users)

    users.select(&:active).to_h { |user| [user.id, user.blogs.size] } # ruby 2.5 ͩͱ͜Ε # users.select(&:active).map { |user| [user.id, user.blogs.size] }.to_h end 17
  18. 2. Array(Enumerable)のメソッドを駆使する • eachで範囲を-1/+1する必要はない (1..10).to_a #=> [1, 2, 3, 4,

    5, 6, 7, 8, 9, 10] (1...10).to_a #=> [1, 2, 3, 4, 5, 6, 7, 8, 9] [:a, :b, :c].each.with_index(1).to_a #=> [[:a, 1], [:b, 2], [:c, 3]] 18
  19. 2. Array(Enumerable)のメソッドを駆使する • group_by と transform_values users_per_status = User.find_each.group_by(&:status) #=>

    { "pending" => [<User>, ...], "active" => [<User>, ... } users_per_status.transform_values { |users| users.map(&:user_name) } #=> { "pending" => ["sinsoku", ...], "active" => ["yuki3738", ... } 19
  20. 3. クラスを抽出する # app/models/user/ranking.rb class User class Ranking def initialize(user)

    @user = user end end def rank score = calculate_score # ུ end private def calculate_score # ུ end end 20
  21. モジュールにするのは # app/models/concerns/rankingable.rb module Rankingable def rank # ུ end

    private def calculate_score # ུ end end class User include Rankingable end User.new.private_methods.include?(:calculate_score) #=> true 21
  22. ここから追記 発表に間に合ったのはここまでだった... 22

  23. Class vs Module • Classのprivateメソッドのスコープは狭い • リファクタリングしやすい • Moduleだと影響範囲の調査が少し面倒 •

    Moduleは少ないメソッドに依存させるべき • Enumerableは each のみに依存してる • Moduleを上手く使うのは難しい 23
  24. まとめ • RuboCopの指摘はリファクタリングの目安 • 安易に rubocop:disable しない • Arrayのメソッド一覧を読むのがおすすめ •

    https://docs.ruby-lang.org/ja/latest/class/Array.html • ModuleよりClassの方がおすすめ 24