Controllerの特定の処理を別の箇所に切り出したい

Question

現在Railsアプリを作成しています。

現在1つのControllerのindexアクションの行数が多くなりすぎており、モデルに切り出そうと考えたのですが、
切り出したい処理が
・特定のクラスに属するインスタンスではない
ためモデルに処理を切り出せません。

以下のようなコードの場合はどこに、どのように処理を切り出せばよいでしょうか?
複数のレコード情報をもつインスタンスにメソッドを作成できればいいのですが、それに関する該当するような記事を見つけることができませんでした。

もしわかる方がいらっしゃればご教授いただきますようよろしくお願いいたします(m_ _m)

動作環境

Ruby: 2.5.7
Rails: 5.1.7

期待する動作

• Controllerから処理の部分を別の部分へ切り出せること
• 切り出す前と同じ動作ができること

処理の内容

todaysmenusが存在する場合
・@stocks,@todaysmenusをそれぞれrawmaterial_idごとに合算して、まとめる
・@stocksから@todaysmenusの内容を引き算した結果を@stocks_not_plan_to_consumeに格納する
todaysmenusが存在しないばあい場合
・@stocksのkey(rawmaterial_id)とvalue(quantity)を@stocks_not_plan_to_consumeに格納する

試したこと

• modelにget_remaining_stocksというメソッドを作成して切り出そうとしたが、`NoMethodError at /stocks

undefined method get_remaining_stocks'のエラーが発生する

該当しそうなコード

app/controllers/stocks_controllers.rb(1/4)

# app/controllers/stocks_controllers.rb
  def index
    @stocks = current_user.stocks.includes(:rawmaterial, { rawmaterial: :unit }).unused
    @todaysmenus = current_user.todaysmenus.includes(:cuisine, cuisine: :foodstuffs).search_in_today

    # begin 切り出したいコード
    # 残るstocksがある場合は@stocks_not_plan_to_consumeに値が格納されている
    @stocks_not_plan_to_consume = {}
    # @stocks_not_plan_to_consume = get_remaining_stocks(@stocks, @todaysmenus)
    if @todaysmenus.present?
      stocks = Hash[@stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key, Rational(val)] }]
      todaysmenus = @todaysmenus.create_hash_todaysmenus(@todaysmenus)
      stocks_results = @stocks.remaining_amount(stocks, todaysmenus)
      @stocks_not_plan_to_consume = stocks_results
    else
      @stocks_not_plan_to_consume = Hash[@stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key.to_s, Rational(val)] }]
    end
    # end 切り出したいコード

  end

app/models/stock.rb(2/4)

# app/models/stock.rb
  def self.remaining_amount(stocks, todaysmenus = nil)
    stocks_result = {}
    stocks.each do |st|
      todaysmenus.each do |tm|
        stocks_result.store(st[0].to_s, st[1] - tm[1]) if st[0] == tm[0]
      end
      stocks_result.store(st[0].to_s, st[1]) unless stocks_result.key?(st[0].to_s)
    end
    stocks_result.delete_if { |_key, value| value <= 0 }
  end

  # begin 追加した部分(NoMethodError at /stocks undefined method get_remaining_stocks が発生する)
  def get_remaining_stocks(stocks, todaysmenus)
    stocks_remainings = {}
    binding.pry
    if todaysmenus.present?
      stocks = Hash[stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key, Rational(val)] }]
      binding.pry
      todaysmenus = @todaysmenus.create_hash_todaysmenus(@todaysmenus)
      stocks_results = @stocks.remaining_amount(stocks, todaysmenus)
      binding.pry
      @stocks_not_plan_to_consume = stocks_results
    else
      @stocks_not_plan_to_consume = Hash[@stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key.to_s, Rational(val)] }]
    end
  end
  # end 追加した部分

app/models/todaysmenu.rb(3/4)

# app/models/todaysmenu.rb
  def self.create_hash_todaysmenus(todaysmenus)
    quantities = []
    todaysmenus.each do |tm|
      c = tm.cuisine
      # binding.pry
      c.foodstuffs.each do |fs|
        quantities.push([fs.rawmaterial_id, Rational(fs.quantity) * tm.serving_count])
      end
    end
    tmp_grouped_todaysmenus = quantities.group_by do |r|
      r.first
    end
    tmp_grouped_todaysmenus.each do |k, v|
      tmp_grouped_todaysmenus[k] = v.inject(0) do |sum, arr|
        sum += Rational(arr.last)
      end
    end
    grouped_todaysmenus = tmp_grouped_todaysmenus
  end

app/models/todaysmenu.rb(4/4)

# db/schema.rb

ActiveRecord::Schema.define(version: 2021_07_16_093528) do

  create_table "cuisines", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "name", null: false, comment: "料理名"
    t.bigint "genre_id"
    t.integer "difficulty", limit: 1, default: 0, null: false, comment: "料理の難易度(enumで、低・中・高)"
    t.string "calories", comment: "摂取カロリー"
    t.integer "cooking_time", null: false, comment: "調理時間"
    t.string "description"
    t.string "main_image", null: false, comment: "メイン画像"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["genre_id"], name: "index_cuisines_on_genre_id"
    t.index ["name"], name: "index_cuisines_on_name", unique: true
  end

  create_table "foodcategories", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "name", null: false, comment: "食材区分名(肉、野菜、魚、炭水化物など)"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["name"], name: "index_foodcategories_on_name", unique: true
  end

  create_table "foodstuffs", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "quantity", comment: "数量"
    t.bigint "cuisine_id", comment: "料理id"
    t.bigint "rawmaterial_id", comment: "原材料id"
    t.integer "row_order"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["cuisine_id"], name: "index_foodstuffs_on_cuisine_id"
    t.index ["rawmaterial_id"], name: "index_foodstuffs_on_rawmaterial_id"
  end

  create_table "genres", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "name", null: false
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.integer "cuisines_count", default: 0, null: false
  end

  create_table "rawmaterials", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "name", null: false, comment: "原材料名"
    t.string "hiragana"
    t.bigint "unit_id"
    t.bigint "foodcategory_id"
    t.integer "expiry_period", default: 1, null: false
    t.integer "foodstuffs_count", default: 0, null: false
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["foodcategory_id"], name: "index_rawmaterials_on_foodcategory_id"
    t.index ["name"], name: "index_rawmaterials_on_name", unique: true
    t.index ["unit_id"], name: "index_rawmaterials_on_unit_id"
  end

  create_table "stocks", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "quantity", null: false
    t.bigint "rawmaterial_id"
    t.bigint "user_id"
    t.date "rotted_at", default: "2021-07-16", null: false
    t.datetime "consumed_at"
    t.boolean "abandoned", null: false
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["rawmaterial_id"], name: "index_stocks_on_rawmaterial_id"
    t.index ["user_id"], name: "index_stocks_on_user_id"
  end

  create_table "todaysmenus", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.bigint "cuisine_id"
    t.bigint "user_id"
    t.integer "serving_count", default: 1, null: false
    t.integer "cooked_when"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["cuisine_id"], name: "index_todaysmenus_on_cuisine_id"
    t.index ["user_id"], name: "index_todaysmenus_on_user_id"
  end

  create_table "units", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
    t.string "name"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
  end

  add_foreign_key "cuisines", "genres"
  add_foreign_key "favorites", "cuisines"
  add_foreign_key "favorites", "users"
  add_foreign_key "rawmaterials", "units"
  add_foreign_key "stocks", "rawmaterials"
  add_foreign_key "stocks", "users"
  add_foreign_key "todaysmenus", "cuisines"
  add_foreign_key "todaysmenus", "users"
end

Answer 1

こういう時はPORO(Plain Old Ruby Object)で対応するのセオリーだと思います。
POROという大仰な呼ばれ方をしていますが、要するに何も継承していない普通のRubyクラスの事です。

class StocksNotPlanToConsume
 
  def initialize(stocks:, todaysmenus:)
    @stocks = stocks
    @todaymenus = todaysmenus
  end

  def run
    # begin 切り出したいコード
    # 残るstocksがある場合は@stocks_not_plan_to_consumeに値が格納されている
    @stocks_not_plan_to_consume = {}
    # @stocks_not_plan_to_consume = get_remaining_stocks(@stocks, @todaysmenus)
    if @todaysmenus.present?
      stocks = Hash[@stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key, Rational(val)] }]
      todaysmenus = @todaysmenus.create_hash_todaysmenus(@todaysmenus)
      stocks_results = @stocks.remaining_amount(stocks, todaysmenus)
      @stocks_not_plan_to_consume = stocks_results
    else
      @stocks_not_plan_to_consume = Hash[@stocks.pluck(:rawmaterial_id, :quantity).to_h.map { |key, val| [key.to_s, Rational(val)] }]
    end
    # end 切り出したいコード

    # 戻り値
    @stocks_not_plan_to_consume
  end

end

def index
  @stocks = current_user.stocks.includes(:rawmaterial, { rawmaterial: :unit }).unused
  @todaysmenus = current_user.todaysmenus.includes(:cuisine, cuisine: :foodstuffs).search_in_today

  @stocks_not_plan_to_consume = StocksNotPlanToConsume.new(
    stocks: @stocks, 
    todaysmenus: @todaysmenus
  ).run
end

このクラス「StocksNotPlanToConsume」の置き場所ですが、app/以下に任意のフォルダを作って配置すれば自動的に読み込まれるはずです。
※ただし、クラス名と同じファイル名でないと読み込まれないというRailsのルールがあるので注意です。
単語のつなぎでアンダースコアにするのを忘れずに。
私の例だと、StocksNotPlanToConsumeというクラス名なので、stocks_not_plan_to_consume.rbといファイル名でなければいけません。
app/任意のフォルダ/stocks_not_plan_to_consume.rb に配置するという事です。

app/modelsに置かないほうが良いと思います。
ActiveRecordとは別であるという事を分かりやすくするために。
フォルダ名は何でもいいんですが、logicsやservices, commandsあたりがよく使われるのではないでしょうか。

ちなみに自分はcommandsをよく使うのでコマンド実行という意味で実行するメソッド名をrunとしていますが、他の名前でもいいです。
コンストラクタで引数を受け取って、実行メソッドで処理をして戻り値を返してもらえればなんでも良いので。

Comments

[begenner]

回答いただきありがとうございます。
POROという概念を知らなかったので知ることができて嬉しく思います。
手法についても知ることができてよかったです。
ありがとうございます。