twilson63-nifty-generators 0.2.5

data/rails_generators/nifty_authentication/nifty_authentication_generator.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+class NiftyAuthenticationGenerator < Rails::Generator::Base
+  attr_accessor :user_name, :sessions_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @user_name = @args[0] || 'user'
+    @sessions_name = @args[1] || 'sessions'
+  end
+  
+  def manifest
+    record do |m|
+      m.directory "app/models"
+      m.directory "app/controllers"
+      m.directory "app/helpers"
+      m.directory "app/views"
+      m.directory "lib"
+      
+      m.directory "app/views/#{user_plural_name}"
+      m.template "user.rb", "app/models/#{user_singular_name}.rb"
+      m.template "users_controller.rb", "app/controllers/#{user_plural_name}_controller.rb"
+      m.template "users_helper.rb", "app/helpers/#{user_plural_name}_helper.rb"
+      m.template "views/#{view_language}/signup.html.#{view_language}", "app/views/#{user_plural_name}/new.html.#{view_language}"
+      
+      m.directory "app/views/#{sessions_underscore_name}"
+      m.template "sessions_controller.rb", "app/controllers/#{sessions_underscore_name}_controller.rb"
+      m.template "sessions_helper.rb", "app/helpers/#{sessions_underscore_name}_helper.rb"
+      m.template "views/#{view_language}/login.html.#{view_language}", "app/views/#{sessions_underscore_name}/new.html.#{view_language}"
+      
+      m.template "authentication.rb", "lib/authentication.rb"
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{user_plural_name}"
+      
+      m.route_resources user_plural_name
+      m.route_resources sessions_underscore_name
+      m.route_name :login, 'login', :controller => sessions_underscore_name, :action => 'new'
+      m.route_name :logout, 'logout', :controller => sessions_underscore_name, :action => 'destroy'
+      m.route_name :signup, 'signup', :controller => user_plural_name, :action => 'new'
+      
+      m.insert_into "app/controllers/#{application_controller_name}.rb", 'include Authentication'
+      
+      if test_framework == :rspec
+        m.directory "spec"
+        m.directory "spec/fixtures"
+        m.directory "spec/controllers"
+        m.directory "spec/models"
+        m.template "fixtures.yml", "spec/fixtures/#{user_plural_name}.yml"
+        m.template "tests/rspec/user.rb", "spec/models/#{user_singular_name}_spec.rb"
+        m.template "tests/rspec/users_controller.rb", "spec/controllers/#{user_plural_name}_controller_spec.rb"
+        m.template "tests/rspec/sessions_controller.rb", "spec/controllers/#{sessions_underscore_name}_controller_spec.rb"
+      else
+        m.directory "test"
+        m.directory "test/fixtures"
+        m.directory "test/functional"
+        m.directory "test/unit"
+        m.template "fixtures.yml", "test/fixtures/#{user_plural_name}.yml"
+        m.template "tests/#{test_framework}/user.rb", "test/unit/#{user_singular_name}_test.rb"
+        m.template "tests/#{test_framework}/users_controller.rb", "test/functional/#{user_plural_name}_controller_test.rb"
+        m.template "tests/#{test_framework}/sessions_controller.rb", "test/functional/#{sessions_underscore_name}_controller_test.rb"
+      end
+    end
+  end
+  
+  def user_singular_name
+    user_name.underscore
+  end
+  
+  def user_plural_name
+    user_singular_name.pluralize
+  end
+
+  def user_class_name
+    user_name.camelize
+  end
+  
+  def user_plural_class_name
+    user_plural_name.camelize
+  end
+
+  def sessions_underscore_name
+    sessions_name.underscore
+  end
+
+  def sessions_class_name
+    sessions_name.camelize
+  end
+  
+  def application_controller_name
+    Rails.version >= '2.3.0' ? 'application_controller' : 'application'
+  end
+
+protected
+  
+  def view_language
+    options[:haml] ? 'haml' : 'erb'
+  end
+  
+  def test_framework
+    options[:test_framework] ||= File.exist?(destination_path("spec")) ? :rspec : :testunit
+  end
+  
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--testunit", "Use test/unit for test files.") { options[:test_framework] = :testunit }
+    opt.on("--rspec", "Use RSpec for test files.") { options[:test_framework] = :rspec }
+    opt.on("--shoulda", "Use Shoulda for test files.") { options[:test_framework] = :shoulda }
+    opt.on("--haml", "Generate HAML views instead of ERB.") { |v| options[:haml] = true }
+  end
+  
+  def banner
+    <<-EOS
+Creates user model and controllers to handle registration and authentication.
+
+USAGE: #{$0} #{spec.name} [user_name] [sessions_controller_name]
+EOS
+  end
+end

data/rails_generators/nifty_authentication/templates/authentication.rb

@@ -0,0 +1,36 @@
+# This module is included in your application controller which makes
+# several methods available to all controllers and views. Here's a
+# common example you might add to your application layout file.
+# 
+#   <%% if logged_in? %>
+#     Welcome <%%= current_user.username %>! Not you?
+#     <%%= link_to "Log out", logout_path %>
+#   <%% else %>
+#     <%%= link_to "Sign up", signup_path %> or
+#     <%%= link_to "log in", login_path %>.
+#   <%% end %>
+# 
+# You can also restrict unregistered users from accessing a controller using
+# a before filter. For example.
+# 
+#   before_filter :login_required, :except => [:index, :show]
+module Authentication
+  def self.included(controller)
+    controller.send :helper_method, :current_<%= user_singular_name %>, :logged_in?
+  end
+  
+  def current_<%= user_singular_name %>
+    @current_<%= user_singular_name %> ||= <%= user_class_name %>.find(session[:<%= user_singular_name %>_id]) if session[:<%= user_singular_name %>_id]
+  end
+  
+  def logged_in?
+    current_<%= user_singular_name %>
+  end
+  
+  def login_required
+    unless logged_in?
+      flash[:error] = "You must first log in or sign up before accessing this page."
+      redirect_to login_url
+    end
+  end
+end

data/rails_generators/nifty_authentication/templates/fixtures.yml

@@ -0,0 +1,12 @@
+# password: "secret"
+one:
+  username: foo
+  email: foo@example.com
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0
+
+two:
+  username: bar
+  email: bar@example.com
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0

data/rails_generators/nifty_authentication/templates/migration.rb

@@ -0,0 +1,15 @@
+class Create<%= user_plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= user_plural_name %> do |t|
+      t.column :username,      :string
+      t.column :email,         :string
+      t.column :password_hash, :string
+      t.column :password_salt, :string
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :<%= user_plural_name %>
+  end
+end

data/rails_generators/nifty_authentication/templates/sessions_controller.rb

@@ -0,0 +1,22 @@
+class <%= sessions_class_name %>Controller < ApplicationController
+  def new
+  end
+  
+  def create
+    <%= user_singular_name %> = <%= user_class_name %>.authenticate(params[:login], params[:password])
+    if <%= user_singular_name %>
+      session[:<%= user_singular_name %>_id] = <%= user_singular_name %>.id
+      flash[:notice] = "Logged in successfully."
+      redirect_to root_url
+    else
+      flash.now[:error] = "Invalid login or password."
+      render :action => 'new'
+    end
+  end
+  
+  def destroy
+    session[:<%= user_singular_name %>_id] = nil
+    flash[:notice] = "You have been logged out."
+    redirect_to root_url
+  end
+end

data/rails_generators/nifty_authentication/templates/sessions_helper.rb

@@ -0,0 +1,2 @@
+module <%= sessions_class_name %>Helper
+end

data/rails_generators/nifty_authentication/templates/tests/rspec/sessions_controller.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe <%= sessions_class_name %>Controller do
+  fixtures :all
+  integrate_views
+  
+  it "new action should render new template" do
+    get :new
+    response.should render_template(:new)
+  end
+  
+  it "create action should render new template when authentication is invalid" do
+    <%= user_class_name %>.stubs(:authenticate).returns(nil)
+    post :create
+    response.should render_template(:new)
+    session['<%= user_singular_name %>_id'].should be_nil
+  end
+  
+  it "create action should redirect when authentication is valid" do
+    <%= user_class_name %>.stubs(:authenticate).returns(<%= user_class_name %>.first)
+    post :create
+    response.should redirect_to(root_url)
+    session['<%= user_singular_name %>_id'].should == <%= user_class_name %>.first.id
+  end
+end

data/rails_generators/nifty_authentication/templates/tests/rspec/user.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe <%= user_class_name %> do
+  def new_<%= user_singular_name %>(attributes = {})
+    attributes[:username] ||= 'foo'
+    attributes[:email] ||= 'foo@example.com'
+    attributes[:password] ||= 'abc123'
+    attributes[:password_confirmation] ||= attributes[:password]
+    <%= user_class_name %>.new(attributes)
+  end
+  
+  before(:each) do
+    <%= user_class_name %>.delete_all
+  end
+  
+  it "should be valid" do
+    new_<%= user_singular_name %>.should be_valid
+  end
+  
+  it "should require username" do
+    new_<%= user_singular_name %>(:username => '').should have(1).error_on(:username)
+  end
+  
+  it "should require password" do
+    new_<%= user_singular_name %>(:password => '').should have(1).error_on(:password)
+  end
+  
+  it "should require well formed email" do
+    new_<%= user_singular_name %>(:email => 'foo@bar@example.com').should have(1).error_on(:email)
+  end
+  
+  it "should validate uniqueness of email" do
+    new_<%= user_singular_name %>(:email => 'bar@example.com').save!
+    new_<%= user_singular_name %>(:email => 'bar@example.com').should have(1).error_on(:email)
+  end
+  
+  it "should validate uniqueness of username" do
+    new_<%= user_singular_name %>(:username => 'uniquename').save!
+    new_<%= user_singular_name %>(:username => 'uniquename').should have(1).error_on(:username)
+  end
+  
+  it "should not allow odd characters in username" do
+    new_<%= user_singular_name %>(:username => 'odd ^&(@)').should have(1).error_on(:username)
+  end
+  
+  it "should validate password is longer than 3 characters" do
+    new_<%= user_singular_name %>(:password => 'bad').should have(1).error_on(:password)
+  end
+  
+  it "should require matching password confirmation" do
+    new_<%= user_singular_name %>(:password_confirmation => 'nonmatching').should have(1).error_on(:password)
+  end
+  
+  it "should generate password hash and salt on create" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>
+    <%= user_singular_name %>.save!
+    <%= user_singular_name %>.password_hash.should_not be_nil
+    <%= user_singular_name %>.password_salt.should_not be_nil
+  end
+  
+  it "should authenticate by username" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret')
+    <%= user_singular_name %>.save!
+    <%= user_class_name %>.authenticate('foobar', 'secret').should == <%= user_singular_name %>
+  end
+  
+  it "should authenticate by email" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:email => 'foo@bar.com', :password => 'secret')
+    <%= user_singular_name %>.save!
+    <%= user_class_name %>.authenticate('foo@bar.com', 'secret').should == <%= user_singular_name %>
+  end
+  
+  it "should not authenticate bad username" do
+    <%= user_class_name %>.authenticate('nonexisting', 'secret').should be_nil
+  end
+  
+  it "should not authenticate bad password" do
+    new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret').save!
+    <%= user_class_name %>.authenticate('foobar', 'badpassword').should be_nil
+  end
+end

data/rails_generators/nifty_authentication/templates/tests/rspec/users_controller.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe <%= user_plural_class_name %>Controller do
+  fixtures :all
+  integrate_views
+  
+  it "new action should render new template" do
+    get :new
+    response.should render_template(:new)
+  end
+  
+  it "create action should render new template when model is invalid" do
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    response.should render_template(:new)
+  end
+  
+  it "create action should redirect when model is valid" do
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    response.should redirect_to(root_url)
+    session['<%= user_singular_name %>_id'].should == assigns['<%= user_singular_name %>'].id
+  end
+end

data/rails_generators/nifty_authentication/templates/tests/shoulda/sessions_controller.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class <%= sessions_class_name %>ControllerTest < ActionController::TestCase
+  context "new action" do
+    should "render new template" do
+      get :new
+      assert_template 'new'
+    end
+  end
+  
+  context "create action" do
+    should "render new template when authentication is invalid" do
+      <%= user_class_name %>.stubs(:authenticate).returns(nil)
+      post :create
+      assert_template 'new'
+      assert_nil session['<%= user_singular_name %>_id']
+    end
+    
+    should "redirect when authentication is valid" do
+      <%= user_class_name %>.stubs(:authenticate).returns(<%= user_class_name %>.first)
+      post :create
+      assert_redirected_to root_url
+      assert_equal <%= user_class_name %>.first.id, session['<%= user_singular_name %>_id']
+    end
+  end
+end

data/rails_generators/nifty_authentication/templates/tests/shoulda/user.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class <%= user_class_name %>Test < ActiveSupport::TestCase
+  def new_<%= user_singular_name %>(attributes = {})
+    attributes[:username] ||= 'foo'
+    attributes[:email] ||= 'foo@example.com'
+    attributes[:password] ||= 'abc123'
+    attributes[:password_confirmation] ||= attributes[:password]
+    <%= user_singular_name %> = <%= user_class_name %>.new(attributes)
+    <%= user_singular_name %>.valid? # run validations
+    <%= user_singular_name %>
+  end
+  
+  def setup
+    <%= user_class_name %>.delete_all
+  end
+  
+  should "be valid" do
+    assert new_<%= user_singular_name %>.valid?
+  end
+  
+  should "require username" do
+    assert new_<%= user_singular_name %>(:username => '').errors.on(:username)
+  end
+  
+  should "require password" do
+    assert new_<%= user_singular_name %>(:password => '').errors.on(:password)
+  end
+  
+  should "require well formed email" do
+    assert new_<%= user_singular_name %>(:email => 'foo@bar@example.com').errors.on(:email)
+  end
+  
+  should "validate uniqueness of email" do
+    new_<%= user_singular_name %>(:email => 'bar@example.com').save!
+    assert new_<%= user_singular_name %>(:email => 'bar@example.com').errors.on(:email)
+  end
+  
+  should "validate uniqueness of username" do
+    new_<%= user_singular_name %>(:username => 'uniquename').save!
+    assert new_<%= user_singular_name %>(:username => 'uniquename').errors.on(:username)
+  end
+  
+  should "not allow odd characters in username" do
+    assert new_<%= user_singular_name %>(:username => 'odd ^&(@)').errors.on(:username)
+  end
+  
+  should "validate password is longer than 3 characters" do
+    assert new_<%= user_singular_name %>(:password => 'bad').errors.on(:password)
+  end
+  
+  should "require matching password confirmation" do
+    assert new_<%= user_singular_name %>(:password_confirmation => 'nonmatching').errors.on(:password)
+  end
+  
+  should "generate password hash and salt on create" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>
+    <%= user_singular_name %>.save!
+    assert <%= user_singular_name %>.password_hash
+    assert <%= user_singular_name %>.password_salt
+  end
+  
+  should "authenticate by username" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret')
+    <%= user_singular_name %>.save!
+    assert_equal <%= user_singular_name %>, <%= user_class_name %>.authenticate('foobar', 'secret')
+  end
+  
+  should "authenticate by email" do
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:email => 'foo@bar.com', :password => 'secret')
+    <%= user_singular_name %>.save!
+    assert_equal <%= user_singular_name %>, <%= user_class_name %>.authenticate('foo@bar.com', 'secret')
+  end
+  
+  should "not authenticate bad username" do
+    assert_nil <%= user_class_name %>.authenticate('nonexisting', 'secret')
+  end
+  
+  should "not authenticate bad password" do
+    new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret').save!
+    assert_nil <%= user_class_name %>.authenticate('foobar', 'badpassword')
+  end
+end