Fun Done Run

yazawa's tech blog

Rails でプログラミングする時に意識しておきたいこと

f:id:yazawa_tech:20190430175836p:plain

はじめに

今回はRails でWeb アプリケーションを作る時に、常に意識しておくと良い点をまとめておく。

scaffold で生成されたコードをなるべく維持したまま機能を実現する

コントローラーを経由して画面を表示する際に、 scaffold に近い形でコントローラーを保っておき、 モデルに処理を寄せながら機能を実現することで、よりRails のレールに乗った形で実装ができる。

例えばscaffold で生成した users_controllerソースコードは以下のようになっている。

class UsersController < ApplicationController
  before_action :set_user, only: [:show, :edit, :update, :destroy]

  # GET /users
  # GET /users.json
  def index
    @users = User.all
  end

  # GET /users/1
  # GET /users/1.json
  def show
  end

  # GET /users/new
  def new
    @user = User.new
  end

  # GET /users/1/edit
  def edit
  end

  # POST /users
  # POST /users.json
  def create
    @user = User.new(user_params)

    respond_to do |format|
      if @user.save
        format.html { redirect_to @user, notice: 'User was successfully created.' }
        format.json { render :show, status: :created, location: @user }
      else
        format.html { render :new }
        format.json { render json: @user.errors, status: :unprocessable_entity }
      end
    end
  end

  # PATCH/PUT /users/1
  # PATCH/PUT /users/1.json
  def update
    respond_to do |format|
      if @user.update(user_params)
        format.html { redirect_to @user, notice: 'User was successfully updated.' }
        format.json { render :show, status: :ok, location: @user }
      else
        format.html { render :edit }
        format.json { render json: @user.errors, status: :unprocessable_entity }
      end
    end
  end

  # DELETE /users/1
  # DELETE /users/1.json
  def destroy
    @user.destroy
    respond_to do |format|
      format.html { redirect_to users_url, notice: 'User was successfully destroyed.' }
      format.json { head :no_content }
    end
  end

  private
    # Use callbacks to share common setup or constraints between actions.
    def set_user
      @user = User.find(params[:id])
    end

    # Never trust parameters from the scary internet, only allow the white list through.
    def user_params
      params.fetch(:user, {})
    end
end

コントローラーの責務はあくまでパラメーターを使用してモデルを参照すること がメインの目的なので、「param を引数に伴わない処理やメソッド呼び出しなど」はなるべくモデルに寄せていく。

ビューで複雑な処理を書くような場合にはヘルパーメソッドを用意する

実装の際に気をつけるべきことの1つ目の方針は、Rails「Skinny Controller, Fat Model」という考え方に基づくものであり、「コントローラーをスッキリさせてビジネスロジックはなるべくモデルに実装する」というものである。これと同様にビューでRuby のコードを利用したビジネスロジックをゴリゴリ書くときは、ヘルパーメソッドに切り出すということも意識しておきたい。

ビジネスロジックをヘルパーメソッドに切り出す時に意識すべき点は、「3~4行以上になること」または「再利用性があること」を目安に切り出していくと良い。

ビューに表示するオブジェクトの情報は一つにするのがベター

ビューに情報を返したり、特にフォームであるオブジェクトのパラメータを送信したりする場合には、なるべく1つのビューに対して1つのオブジェクトのフォームを用意する方が、Rails の得意な形で実装できる。

ビジネス要件などでどうしても1つのビューに複数のオブジェクトに対するフォームを実装しなければならない場合などは、Ajax 化してしまうのが良い。その場合はJavaScript で処理をすることになるが、コードがよりスッキリ書ける。

まとめ

  • Rails で実装する際に何度でも意識しておきたいことをまとめた
  • Rails 初心者の人にとっては、これを意識するだけでもだいぶ変わってくると思う
  • まだまだ大事なことはあるが、とりあえず優先度の高いものをまとめて実装をする時の指針にしたい