読者です 読者をやめる 読者になる 読者になる

ちーくんのブログ

プログラミング備忘録

Railsでdeviseをインストールする方法

こんにちは。本日はdeviseのインストール方法を説明したいと思います。

deviseとはwebサービスによくあるユーザーのログイン機能・新規登録機能などの機能を簡単に実装できる便利なGemです。
おそらくRailsのGemのなかでも最も有名なGemの一つで、よく使われているので覚えておいて損は無いでしょう。

バージョン

Ruby '2.2.1'
Rails '4.2.1'
Devise '3.5.1'


Userモデルの作成

まずはdeviseを使うために下準備をする必要があります。
deviseはユーザーのログイン機能などを実装するため、Userモデルが存在する必要があります。なので初めはUserモデルを作りましょう。
今回はscaffoldを使い作成します。

# ターミナル
rails g scaffold User name:string
# ターミナル
rake db:migrate

これでname属性を持ったUserモデルができました。


deviseのインストール

次にdeviseをインストールしましょう。
Gemfileにdeviseを記述。

# Gemfile
gem 'devise'

Gemをインストール

# ターミナル
bundle install

deviseを使用できるようにする

# ターミナル
rails g devise:install

以上でdeviseの準備が終わりました。


Userモデルに適用

Userモデルにdeviseの機能を適用させるために、以下のコマンドを打ちます。

# ターミナル
rails g devise User

これでdeviseの機能をUserモデルに適用できました。

またこのコマンドによって、user.rb・routes.rb・migrateファイルに変更が加えられています。

# models/user.rb
class User < ActiveRecord::Base
  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :timeoutable and :omniauthable
  devise :database_authenticatable, :registerable,
         :recoverable, :rememberable, :trackable, :validatable
end
# routes.rb
devise_for :users
# 日付_add_devise_to_users.rb
class AddDeviseToUsers < ActiveRecord::Migration
  def self.up
    change_table(:users) do |t|
      ## Database authenticatable
      t.string :email,              null: false, default: ""
      t.string :encrypted_password, null: false, default: ""

      ## Recoverable
      t.string   :reset_password_token
      t.datetime :reset_password_sent_at

      ## Rememberable
      t.datetime :remember_created_at

      ## Trackable
      t.integer  :sign_in_count, default: 0, null: false
      t.datetime :current_sign_in_at
      t.datetime :last_sign_in_at
      t.string   :current_sign_in_ip
      t.string   :last_sign_in_ip

      ## Confirmable
      # t.string   :confirmation_token
      # t.datetime :confirmed_at
      # t.datetime :confirmation_sent_at
      # t.string   :unconfirmed_email # Only if using reconfirmable

      ## Lockable
      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
      # t.string   :unlock_token # Only if unlock strategy is :email or :both
      # t.datetime :locked_at


      # Uncomment below if timestamps were not included in your original model.
      # t.timestamps null: false
    end

    add_index :users, :email,                unique: true
    add_index :users, :reset_password_token, unique: true
    # add_index :users, :confirmation_token,   unique: true
    # add_index :users, :unlock_token,         unique: true
  end

  def self.down
    # By default, we don't want to make any assumption about how to roll back a migration when your
    # model already existed. Please edit below which fields you would like to remove in this migration.
    raise ActiveRecord::IrreversibleMigration
  end
end

たくさんのdeviseの機能が使えるようになりましたが、今回はデフォルトの機能のみ使用します。

データベースに反映させるためにマイグレーション

# ターミナル
rake db:migrate

以上でdeviseのすべての下準備が終わりました。


deviseのルーティング

deviseはルーティングを自動で生成してくれます。

新規登録なら localhost:3000/users/sign_up
ログインなら localhost:3000/users/sign_in

それでは実際に見てみましょう。

まずは新規登録画面。(users/sign_up)
f:id:chi_kun:20160424193411p:plain

次にログイン画面。(users/sign_in)
f:id:chi_kun:20160424193341p:plain


はい。きちんと表示できていますね。

deviseは上記の新規登録・ログイン以外にもパスワードリセット機能やユーザー登録のバリデーションなどもデフォルトでサポートしています。

他の機能はまた改めて見ていきたいと思います。


※追記

便利な機能
chi-kun.hatenablog.com



本日は以上です。