s6x_auth_scaffold_generator 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Kouji Takao <kouji.takao@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,93 @@
+== S6x(Six) Auth Scaffold Generator
+
+Sorry, Japanese only.
+
+「S6x(Six) Auth Scaffold Generator」(以下、s6x_auth_scaffold)はRails
+3.0向けのシンプルな認証機能をフルスクラッチで記述するためのgeneratorで
+す。s6x_auth_scaffoldの目的はこれからRuby on Railsで開発する方がRailsに
+おける認証の概要をソースコードレベルで理解することを手助けすることです。
+
+s6x_auth_scaffoldは以下の機能を実現するソースコードを自動生成します。
+
+* ログイン画面(/login)でログインIDとパスワードで認証。
+* ユーザのモデル名はUserやEmployeeなど自由にしてできる。
+* ログイン後はWelcome画面(root_url)を表示。
+  * Welcome画面をURLできる。
+* /logoutにアクセスするとログアウトできる。
+* ログアウトするとログイン画面を表示。このときログアウトした旨を表示。
+
+ただし、ソースコードを簡単にすることを優先しているため以下のことはでき
+ません。
+
+* ユーザの作成はWeb上ではできない。
+
+s6x_auth_scaffoldで基本を学んだ後はRailsが提供しているscaffoldのように
+自分で認証機能をカスタマイズしてもよいですが、ぜひDeviseなどの認証ライ
+ブラリの導入を検討してみてください。
+
+== ライセンス
+
+MITライセンス
+
+== 必要なソフトウェア
+
+* Ruby 1.9.2-p290以降
+* Ruby on Rails 3.0.10 (3.1以降では動作確認をしていない)
+
+== インストール方法
+
+  gem install s6x_auth_scaffold_generator
+
+== 使用方法
+
+新しいRailsプロジェクトを作成してデータベースの設定などを行います。
+
+  $ rails new auth_demo
+  $ cd auth_demo
+  $ bundle install
+  (DBの設定など)
+  $ rake db:create:all
+
+s6x_auth_scaffoldで認証まわりのソースコードを自動生成します。
+
+  $ rails generate s6x_auth_scaffold User
+
+rake db:migrateを実行してusersテーブルを作成します。
+
+  $ rake db:migrate
+
+ついでに単体テストも実行します。
+
+  $ rake
+
+動作確認をするためにユーザを作成します。ここではログインIDがadmin、パス
+ワードがadminのユーザを作成しています。
+
+  $ rails console
+  > User.create!(login: "admin", password: "admin")
+  > quit
+
+サーバを起動して動作を確認します。/loginにアクセスしてログインします。
+「Welcome aboard」が表示されればs6x_auth_scaffoldがただしく動作していま
+す。
+
+  $ rails server
+  (Webブラウザでlocalhost:3000/loginにアクセスする)
+
+サーバを停止させます。
+
+== これから
+
+自動再生されたファイルや変更されたファイルを確認してください。認証に最
+低限必要な機能が実装されているはずです。コード量は少ないので安心してく
+ださい。また、単体テストも記述してあるため、今後の開発の参考になるはず
+です。
+
+一通り確認できたらWelcome画面(Welcome#index)を作成してみてください。
+Welcome画面にはログアウトのボタンやログインIDを表示してみてください。
+
+  <p><%= current_user.login %> <%= link_to "ログアウト", logout_path %></p>
+
+最後に氏名(name)、ふりがな(furigana)、メールアドレス(email)などのユーザ
+の情報をUserモデルに追加してアプリケーションの要件を満たすように改良し
+てみてください。

data/lib/USAGE

@@ -0,0 +1,10 @@
+説明:
+    認証まわりのソースコードを自動生成する。
+    Rubyは1.9.2-p290、Railsは3.0.10を対象とする。
+    メインのplatformはWindows。
+    言語は日本語のみ。
+
+使用例:
+    rails generate s6x_auth_scaffold User
+
+    「User」には認証に必要なログインIDとパスワードを格納するモデル名を指定する。

data/lib/s6x_auth_scaffold_generator.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+# 認証まわりのソースコードを自動生成するscaffoldの+s6x_auth_scaffold+。
+# 現状、Rubyは1.9.2-p290、Railsは3.0.10を対象とする。
+# また、メインのplatformはWindows。
+
+require 'rails/generators'
+require 'rails/generators/named_base'
+require 'rails/generators/active_record/migration'
+
+class S6xAuthScaffoldGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  class_option :root_to, default: "welcome#index", desc: "「root :to =>」に指定する文字列", aliases: "r"
+
+  def parse_options
+    @user_model_name = file_name.camelize
+    @user_model_file_name = file_name.underscore
+    @user_instance_name = file_name.underscore
+    @users_table_name = file_name.underscore.pluralize
+  end
+
+  def create_users_migration
+    migration_template "db/migrate/create_users.rb", "db/migrate/create_#{@users_table_name}.rb"
+  rescue Rails::Generators::Error => e
+    if options[:skip]
+      puts e.message
+    else
+      raise
+    end
+  end
+  
+  def create_user_model
+    template "app/models/user.rb", "app/models/#{@user_model_file_name}.rb"
+    template "test/unit/user_test.rb", "test/unit/#{@user_model_file_name}_test.rb"
+    template "test/fixtures/users.yml", "test/fixtures/#{@users_table_name}.yml"
+  end
+
+  def create_sessions_controller
+    template "app/controllers/sessions_controller.rb"
+    template "test/functional/sessions_controller_test.rb"
+    copy_file "app/views/sessions/login.html.erb"
+    template "app/helpers/sessions_helper.rb"
+  end
+
+  def add_routes
+    route('match "login" => "sessions#login"')
+    route('match "logout" => "sessions#logout"')
+    route(%Q'root :to => "#{options[:root_to]}"')
+  end
+
+  def edit_application_controller
+    method_name = "current_#{@user_instance_name}"
+    dest_path = "app/controllers/application_controller.rb"
+    if ApplicationController.public_method_defined?(method_name.to_sym)
+      msg = "ApplicationController is already defined #{method_name} method: #{dest_path}"
+      if options[:skip]
+        puts msg
+      else
+        raise Rails::Generators::Error, msg
+      end
+    else
+      inject_into_class(dest_path, ApplicationController, "
+  # ログイン中のユーザを返す。
+  def #{method_name}
+    if session[:#{@user_instance_name}_id]
+      @current_#{@user_instance_name} ||= #{@user_model_name}.find(session[:#{@user_instance_name}_id])
+    end
+    return @current_#{@user_instance_name}
+  end
+    
+  helper_method :current_#{@user_instance_name}
+
+".force_encoding("ASCII-8BIT")) # NOTE: force_encoding("ASCII-8BIT")はThorのバグを回避するため。
+    end
+  end
+end

data/lib/templates/app/controllers/sessions_controller.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+# セッションを管理するコントローラ。
+class SessionsController < ApplicationController
+  # ログイン。
+  def login
+    if session[:<%= @user_instance_name %>_id]
+      redirect_to(root_url, notice: "すでにログインしています。")
+    end
+    if params[:login] && params[:password]
+      <%= @user_instance_name %> = <%= @user_model_name %>.find_by_login(params[:login])
+      if <%= @user_instance_name %> && <%= @user_instance_name %>.authenticate(params[:password])
+        session[:<%= @user_instance_name %>_id] = <%= @user_instance_name %>.id  
+        redirect_to(root_url, notice: "ログインしました。")
+      else  
+        flash.now.alert = "ログインID、パスワードが間違っています。"
+      end
+    end
+  end
+  
+  # ログアウト。
+  def logout
+    reset_session
+    redirect_to(login_path, notice: "ログアウトしました。")
+  end
+end

data/lib/templates/app/helpers/sessions_helper.rb

@@ -0,0 +1,2 @@
+module SessionsHelper
+end

data/lib/templates/app/models/user.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+require 'securerandom'
+require 'digest/sha1'
+
+# ユーザを表現する。
+class <%= @user_model_name %> < ActiveRecord::Base
+  attr_accessor :password
+
+  attr_accessible :login, :password
+  
+  validates_presence_of :login
+  validates_uniqueness_of :login
+  # validates_length_of :login, within: 3..40
+
+  validates_presence_of :password, on: :create
+  # validates_length_of :password, within: 5..40
+  
+  # パスワードの確認を行う場合は以下のコメントをはずす。
+  # attr_accessor :password_confirmation
+  # validates_confirmation_of :password
+  # validates_presence_of :password_confirmation, on: :create
+
+  before_save do
+    if @password
+      if !self.salt?
+        self.salt = random_string(10)
+      end
+      self.password_digest = digest(@password, self.salt)
+    end
+  end
+  
+  # パスワード+password+で認証する。認証に成功した場合trueを返す。失敗した場合はfalseを返す。
+  # 使用例)
+  #   <%= @user_instance_name %> = <%= @user_model_name %>.find_by_login(params[:login])
+  #   if <%= @user_instance_name %>.authenticate(params[:password])
+  #     # 認証に成功した場合の処理。
+  #   else
+  #     # 認証に失敗した場合の処理。
+  #   end
+  def authenticate(password)
+    return digest(password, salt) == password_digest
+  end
+
+  private
+  
+  # ランダムな文字列を生成します。
+  # Deviseライブラリのdevise/lib/devise.rbのDevise.friendly_tokenメソッドの実装を使っています。
+  # http://blog.plataformatec.com.br/tag/devise/
+  def random_string(length)
+    return SecureRandom.base64(15).tr('+/=lIO0', 'pqrsxyz')[0, length]
+  end
+  
+  # パスワード+password+とランダムな文字列+salt+から、パスワード認証のためのハッシュ値を求める。
+  def digest(password, salt)
+    return Digest::SHA1.hexdigest(password + salt)
+  end
+end

data/lib/templates/app/views/sessions/login.html.erb

@@ -0,0 +1,15 @@
+<h1>ログイン</h1>
+
+<%= form_tag login_path do %>
+  <div class="field">
+    <%= label_tag "ログインID" %>
+    <%= text_field_tag :login, params[:login] %>
+  </div>
+  <div class="field">
+    <%= label_tag "パスワード" %>
+    <%= password_field_tag :password %>
+  </div>
+  <div class="actions">
+    <%= submit_tag "ログイン" %>
+  </div>
+<% end %>

data/lib/templates/db/migrate/create_users.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+# <%= @users_table_name %>テーブルを作成する。
+# loginカラムはログインに使用するIDを格納する。
+# password_digestカラムはパスワードとsaltカラムを元に生成したハッシュ値を格納する。
+# saltカラムはパスワードからハッシュ値を求めるときに使うランダムな値を格納する。
+class Create<%= @users_table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= @users_table_name %> do |t|
+      t.string :login, limit: 40
+      t.string :password_digest
+      t.string :salt
+
+      # ここに名前(name)、ふりがな(furigana)、メールアドレス(email)などを追加します。
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= @users_table_name %>
+  end
+end

data/lib/templates/test/fixtures/users.yml

@@ -0,0 +1,13 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+admin:
+  id: 1
+  login: admin
+  password_digest: "30a389673b7ee019c7fc8201e4a5e83a0f0c9d62" # admin
+  salt: "4NsTR61PRi"
+
+<% login = "#{@user_instance_name}001" %><%= login %>:
+  id: 2
+  login: <%= login %>
+  password_digest: "<%= Digest::SHA1.hexdigest(login + "r8i1tsR1jn") %>" # <%= login %>
+  salt: "r8i1tsR1jn"

data/lib/templates/test/functional/sessions_controller_test.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+require 'test_helper'
+
+class SessionsControllerTest < ActionController::TestCase
+  fixtures :<%= @users_table_name %>
+
+  def setup
+    @request.session = ActionController::TestSession.new      
+  end
+  
+  test "ログイン画面を表示" do
+    get :login
+    assert_response :success
+  end
+  
+  test "ログイン中にログイン画面を表示しようとするとWelcome画面にリダイレクト" do
+    @request.session[:<%= @user_instance_name %>_id] = <%= @users_table_name %>(:admin).id
+    get :login
+    assert_redirected_to root_url
+  end
+
+  test "ログインに成功するとWelcome画面にリダイレクト" do
+    post :login, login: "admin", password: "admin"
+    assert_redirected_to root_url
+  end
+
+  test "ログインに失敗するとログイン画面を表示" do
+    post :login, login: "admin", password: "<%= @user_instance_name %>001"
+    assert_response :success
+  end
+
+  test "ログアウト後はログイン画面にリダイレクト" do
+    @request.session[:<%= @user_instance_name %>_id] = <%= @users_table_name %>(:admin).id
+    get :logout
+    assert_redirected_to login_url
+    assert_equal({}, @request.session)
+  end
+end

data/lib/templates/test/unit/user_test.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+require 'test_helper'
+
+class <%= @user_model_name %>Test < ActiveSupport::TestCase
+  fixtures :<%= @users_table_name %>
+  
+  test "同じログインIDは指定できない" do
+    # 新規作成
+    assert_raise(ActiveRecord::RecordInvalid) do
+      <%= @user_model_name %>.create!(login: "<%= @user_instance_name %>001", password: "password")
+    end
+
+    # 更新
+    assert_raise(ActiveRecord::RecordInvalid) do
+      <%= @user_instance_name %> = <%= @users_table_name %>(:<%= @user_instance_name %>001)
+      <%= @user_instance_name %>.login = "admin"
+      <%= @user_instance_name %>.save!
+    end
+  end
+  
+  test "authenticateを使った認証" do
+    assert_equal(true, <%= @users_table_name %>(:admin).authenticate("admin"))
+    assert_equal(false, <%= @users_table_name %>(:admin).authenticate("<%= @user_instance_name %>001"))
+
+    assert_equal(true, <%= @users_table_name %>(:<%= @user_instance_name %>001).authenticate("<%= @user_instance_name %>001"))
+    assert_equal(false, <%= @users_table_name %>(:<%= @user_instance_name %>001).authenticate("admin"))
+  end
+end

data/s6x_auth_scaffold_generator.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = "s6x_auth_scaffold_generator"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY  
+  s.required_ruby_version = '>= 1.9.2'
+  s.summary     = "Really simple authentication scaffold generator for Rails"
+  s.email       = "kouji.takao@gmail.com"
+  s.homepage    = "http://github.com/takaokouji/s6x_auth_scaffold"
+  s.description = "Really simple authentication scaffold generator for Rails"
+  s.authors     = ["Kouji Takao (Kody)"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_dependency("rails", "~> 3.0.0")
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: s6x_auth_scaffold_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kouji Takao (Kody)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2152014740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152014740
+description: Really simple authentication scaffold generator for Rails
+email: kouji.takao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- lib/USAGE
+- lib/s6x_auth_scaffold_generator.rb
+- lib/templates/app/controllers/sessions_controller.rb
+- lib/templates/app/helpers/sessions_helper.rb
+- lib/templates/app/models/user.rb
+- lib/templates/app/views/sessions/login.html.erb
+- lib/templates/db/migrate/create_users.rb
+- lib/templates/test/fixtures/users.yml
+- lib/templates/test/functional/sessions_controller_test.rb
+- lib/templates/test/unit/user_test.rb
+- s6x_auth_scaffold_generator.gemspec
+homepage: http://github.com/takaokouji/s6x_auth_scaffold
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Really simple authentication scaffold generator for Rails
+test_files: []