FreeCamp      

【Rails】Scaffoldを使ってみる

  1. Scaffoldとは
  2. 実装
  3. 最後に

1. Scaffoldとは

ScaffoldはRails元々に備わっている機能で、
コマンド一つでRESTfulに基づいたルーティング・コントローラ・モデル等を作成してくれる便利機能です。
一覧画面, 詳細画面, 新規投稿画面, 編集画面、
新規投稿機能, 編集機能, 削除機能がコマンド一つで作られるイメージです。

2. 実装

では早速Scaffoldを使用してみましょう。

$ rails new sample_app
$ cd sample_app
$ rails g scaffold post title:string content:text

これだけで、マイグレーションファイルやコントローラが作成されました。
postsコントローラを見てみましょう。

class PostsController < ApplicationController
  before_action :set_post, only: [:show, :edit, :update, :destroy]

  # GET /posts
  # GET /posts.json
  def index
    @posts = Post.all
  end

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

  # GET /posts/new
  def new
    @post = Post.new
  end

  # GET /posts/1/edit
  def edit
  end

  # POST /posts
  # POST /posts.json
  def create
    @post = Post.new(post_params)

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

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

  # DELETE /posts/1
  # DELETE /posts/1.json
  def destroy
    @post.destroy
    respond_to do |format|
      format.html { redirect_to posts_url, notice: 'Post was successfully destroyed.' }
      format.json { head :no_content }
    end
  end

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

    # Never trust parameters from the scary internet, only allow the white list through.
    def post_params
      params.require(:post).permit(:title, :content)
    end
end

便利ですね!
また、マイグレーションファイルも見てみましょう。

class CreatePosts < ActiveRecord::Migration[6.0]
  def change
    create_table :posts do |t|
      t.string :title
      t.text :content

      t.timestamps
    end
  end
end

では、モデルを作成しましょう。

$ rails db:migrate

次に、ルート設定し、アプリケーションを実行してみましょう。
config/routes.rbに以下を追加します。

...追記
root 'posts#index'
$ rails s

アプリケーションを試してみましょう。
新規投稿や編集、削除も行えます。

3. 最後に

コマンド一つで投稿アプリケーションを作成することができました。
Scaffoldはアプリケーションの基盤を作成するイメージです。
デザインは質素なものですが、これだけ機能が作れてしまえばカスタマイズも容易ですし、
何よりスピード感を持って開発が行えますね。
一つだけ注意点があるとすると、Scaffoldはブラックボックスという点です。
初めてRailsでアプリケーションを作成する人はScaffoldが何を行なっているのか、
コントローラの記載はどういう内容かわからないと思いますので、
まずは自力でこの機能を作れるようになりましょう。
仕組みを理解した上で利用するのは結構ですが、
仕組みや内容を理解していないのに利用すると、後戻りすることや理解するのに時間がかかるといったデメリットがたくさんあります。
便利なものを使うのは良いけど理解しましょう、ということです。