niftier-generators 0.1.0

data/lib/generators/niftier/authentication/templates/sessions_controller.rb

@@ -0,0 +1,45 @@
+class <%= session_plural_class_name %>Controller < ApplicationController
+<%- if options[:authlogic] -%>
+  def new
+    @<%= session_singular_name %> = <%= session_class_name %>.new
+  end
+  
+  def create
+    @<%= session_singular_name %> = <%= session_class_name %>.new(params[:<%= session_singular_name %>])
+    if @<%= session_singular_name %>.save
+      flash[:notice] = "Logged in successfully."
+      redirect_to_target_or_default("/")
+    else
+      render :action => 'new'
+    end
+  end
+  
+  def destroy
+    @<%= session_singular_name %> = <%= session_class_name %>.find
+    @<%= session_singular_name %>.destroy
+    flash[:notice] = "You have been logged out."
+    redirect_to "/"
+  end
+<%- else -%>
+  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_target_or_default("/")
+    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 "/"
+  end
+<%- end -%>
+end

data/lib/generators/niftier/authentication/templates/sessions_helper.rb

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

data/lib/generators/niftier/authentication/templates/tests/rspec/sessions_controller.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe <%= session_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
+  
+<%- if options[:authlogic] -%>
+  it "create action should render new template when authentication is invalid" do
+    post :create, :<%= session_singular_name %> => { :username => "foo", :password => "badpassword" }
+    response.should render_template(:new)
+    <%= session_class_name %>.find.should be_nil
+  end
+  
+  it "create action should redirect when authentication is valid" do
+    post :create, :<%= session_singular_name %> => { :username => "foo", :password => "secret" }
+    response.should redirect_to("/")
+    <%= session_class_name %>.find.<%= user_singular_name %>.should == <%= user_plural_name %>(:foo)
+  end
+<%- else -%>
+  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("/")
+    session['<%= user_singular_name %>_id'].should == <%= user_class_name %>.first.id
+  end
+<%- end -%>
+end

data/lib/generators/niftier/authentication/templates/tests/rspec/user.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe <%= user_class_name %> do
+<%- unless options[:authlogic] -%>
+  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 -%>
+end

data/lib/generators/niftier/authentication/templates/tests/rspec/users_controller.rb

@@ -0,0 +1,26 @@
+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("/")
+  <%- unless options[:authlogic] -%>
+    session['<%= user_singular_name %>_id'].should == assigns['<%= user_singular_name %>'].id
+  <%- end -%>
+  end
+end

data/lib/generators/niftier/authentication/templates/tests/shoulda/sessions_controller.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class <%= session_plural_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
+  <%- if options[:authlogic] -%>
+    should "render new template when authentication is invalid" do
+      post :create, :<%= session_singular_name %> => { :username => "foo", :password => "badpassword" }
+      assert_template 'new'
+      assert_nil <%= session_class_name %>.find
+    end
+    
+    should "redirect when authentication is valid" do
+      post :create, :<%= session_singular_name %> => { :username => "foo", :password => "secret" }
+      assert_redirected_to "/"
+      assert_equal <%= user_plural_name %>(:foo), <%= session_class_name %>.find.<%= user_singular_name %>
+    end
+  <%- else -%>
+    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 "/"
+      assert_equal <%= user_class_name %>.first.id, session['<%= user_singular_name %>_id']
+    end
+  <%- end -%>
+  end
+end

data/lib/generators/niftier/authentication/templates/tests/shoulda/user.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class <%= user_class_name %>Test < ActiveSupport::TestCase
+<%- unless options[:authlogic] -%>
+  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[:username]
+  end
+  
+  should "require password" do
+    assert new_<%= user_singular_name %>(:password => '').errors[:password]
+  end
+  
+  should "require well formed email" do
+    assert new_<%= user_singular_name %>(:email => 'foo@bar@example.com').errors[: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[:email]
+  end
+  
+  should "validate uniqueness of username" do
+    new_<%= user_singular_name %>(:username => 'uniquename').save!
+    assert new_<%= user_singular_name %>(:username => 'uniquename').errors[:username]
+  end
+  
+  should "not allow odd characters in username" do
+    assert new_<%= user_singular_name %>(:username => 'odd ^&(@)').errors[:username]
+  end
+  
+  should "validate password is longer than 3 characters" do
+    assert new_<%= user_singular_name %>(:password => 'bad').errors[:password]
+  end
+  
+  should "require matching password confirmation" do
+    assert new_<%= user_singular_name %>(:password_confirmation => 'nonmatching').errors[: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 -%>
+end

data/lib/generators/niftier/authentication/templates/tests/shoulda/users_controller.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class <%= user_plural_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 model is invalid" do
+      <%= user_class_name %>.any_instance.stubs(:valid?).returns(false)
+      post :create
+      assert_template 'new'
+    end
+  
+    should "redirect when model is valid" do
+      <%= user_class_name %>.any_instance.stubs(:valid?).returns(true)
+      post :create
+      assert_redirected_to "/"
+    <%- unless options[:authlogic] -%>
+      assert_equal assigns['<%= user_singular_name %>'].id, session['<%= user_singular_name %>_id']
+    <%- end -%>
+    end
+  end
+end

data/lib/generators/niftier/authentication/templates/tests/testunit/sessions_controller.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class <%= session_plural_class_name %>ControllerTest < ActionController::TestCase
+  def test_new
+    get :new
+    assert_template 'new'
+  end
+  
+<%- if options[:authlogic] -%>
+  def test_create_invalid
+    post :create, :<%= session_singular_name %> => { :username => "foo", :password => "badpassword" }
+    assert_template 'new'
+    assert_nil <%= session_class_name %>.find
+  end
+  
+  def test_create_valid
+    post :create, :<%= session_singular_name %> => { :username => "foo", :password => "secret" }
+    assert_redirected_to "/"
+    assert_equal <%= user_plural_name %>(:foo), <%= session_class_name %>.find.<%= user_singular_name %>
+  end
+<%- else -%>
+  def test_create_invalid
+    <%= user_class_name %>.stubs(:authenticate).returns(nil)
+    post :create
+    assert_template 'new'
+    assert_nil session['<%= user_singular_name %>_id']
+  end
+  
+  def test_create_valid
+    <%= user_class_name %>.stubs(:authenticate).returns(<%= user_class_name %>.first)
+    post :create
+    assert_redirected_to "/"
+    assert_equal <%= user_class_name %>.first.id, session['<%= user_singular_name %>_id']
+  end
+<%- end -%>
+end

data/lib/generators/niftier/authentication/templates/tests/testunit/user.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class <%= user_class_name %>Test < ActiveSupport::TestCase
+<%- unless options[:authlogic] -%>
+  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
+  
+  def test_valid
+    assert new_<%= user_singular_name %>.valid?
+  end
+  
+  def test_require_username
+    assert new_<%= user_singular_name %>(:username => '').errors[:username]
+  end
+  
+  def test_require_password
+    assert new_<%= user_singular_name %>(:password => '').errors[:password]
+  end
+  
+  def test_require_well_formed_email
+    assert new_<%= user_singular_name %>(:email => 'foo@bar@example.com').errors[:email]
+  end
+  
+  def test_validate_uniqueness_of_email
+    new_<%= user_singular_name %>(:email => 'bar@example.com').save!
+    assert new_<%= user_singular_name %>(:email => 'bar@example.com').errors[:email]
+  end
+  
+  def test_validate_uniqueness_of_username
+    new_<%= user_singular_name %>(:username => 'uniquename').save!
+    assert new_<%= user_singular_name %>(:username => 'uniquename').errors[:username]
+  end
+  
+  def test_validate_odd_characters_in_username
+    assert new_<%= user_singular_name %>(:username => 'odd ^&(@)').errors[:username]
+  end
+  
+  def test_validate_password_length
+    assert new_<%= user_singular_name %>(:password => 'bad').errors[:password]
+  end
+  
+  def test_require_matching_password_confirmation
+    assert new_<%= user_singular_name %>(:password_confirmation => 'nonmatching').errors[:password]
+  end
+  
+  def test_generate_password_hash_and_salt_on_create
+    <%= user_singular_name %> = new_<%= user_singular_name %>
+    <%= user_singular_name %>.save!
+    assert <%= user_singular_name %>.password_hash
+    assert <%= user_singular_name %>.password_salt
+  end
+  
+  def test_authenticate_by_username
+    <%= user_class_name %>.delete_all
+    <%= 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
+  
+  def test_authenticate_by_email
+    <%= user_class_name %>.delete_all
+    <%= 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
+  
+  def test_authenticate_bad_username
+    assert_nil <%= user_class_name %>.authenticate('nonexisting', 'secret')
+  end
+  
+  def test_authenticate_bad_password
+    <%= user_class_name %>.delete_all
+    new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret').save!
+    assert_nil <%= user_class_name %>.authenticate('foobar', 'badpassword')
+  end
+<%- end -%>
+end

data/lib/generators/niftier/authentication/templates/tests/testunit/users_controller.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class <%= user_plural_class_name %>ControllerTest < ActionController::TestCase
+  def test_new
+    get :new
+    assert_template 'new'
+  end
+  
+  def test_create_invalid
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    assert_template 'new'
+  end
+  
+  def test_create_valid
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    assert_redirected_to "/"
+  <%- unless options[:authlogic] -%>
+    assert_equal assigns['<%= user_singular_name %>'].id, session['<%= user_singular_name %>_id']
+  <%- end -%>
+  end
+end

data/lib/generators/niftier/authentication/templates/user.rb

@@ -0,0 +1,42 @@
+class <%= user_class_name %> < ActiveRecord::Base
+<%- if options[:authlogic] -%>
+  acts_as_authentic
+<%- else -%>
+  # new columns need to be added here to be writable through mass assignment
+  attr_accessible :username, :email, :password, :password_confirmation
+  
+  attr_accessor :password
+  before_save :prepare_password
+  
+  validates_presence_of :username
+  validates_uniqueness_of :username, :email, :allow_blank => true
+  validates_format_of :username, :with => /^[-\w\._@]+$/i, :allow_blank => true, :message => "should only contain letters, numbers, or .-_@"
+  validates_format_of :email, :with => /^[-a-z0-9_+\.]+\@([-a-z0-9]+\.)+[a-z0-9]{2,4}$/i
+  validates_presence_of :password, :on => :create
+  validates_confirmation_of :password
+  validates_length_of :password, :minimum => 4, :allow_blank => true
+  
+  # login can be either username or email address
+  def self.authenticate(login, pass)
+    <%= user_singular_name %> = find_by_username(login) || find_by_email(login)
+    return <%= user_singular_name %> if <%= user_singular_name %> && <%= user_singular_name %>.matching_password?(pass)
+  end
+  
+  def matching_password?(pass)
+    self.password_hash == encrypt_password(pass)
+  end
+  
+  private
+  
+  def prepare_password
+    unless password.blank?
+      self.password_salt = Digest::SHA1.hexdigest([Time.now, rand].join)
+      self.password_hash = encrypt_password(password)
+    end
+  end
+  
+  def encrypt_password(pass)
+    Digest::SHA1.hexdigest([pass, password_salt].join)
+  end
+<%- end -%>
+end

data/lib/generators/niftier/authentication/templates/users_controller.rb

@@ -0,0 +1,18 @@
+class <%= user_plural_class_name %>Controller < ApplicationController
+  def new
+    @<%= user_singular_name %> = <%= user_class_name %>.new
+  end
+  
+  def create
+    @<%= user_singular_name %> = <%= user_class_name %>.new(params[:<%= user_singular_name %>])
+    if @<%= user_singular_name %>.save
+    <%- unless options[:authlogic] -%>
+      session[:<%= user_singular_name %>_id] = @<%= user_singular_name %>.id
+    <%- end -%>
+      flash[:notice] = "Thank you for signing up! You are now logged in."
+      redirect_to "/"
+    else
+      render :action => 'new'
+    end
+  end
+end

data/lib/generators/niftier/authentication/templates/users_helper.rb

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

data/lib/generators/niftier/authentication/templates/views/erb/login.html.erb

@@ -0,0 +1,30 @@
+<%% title "Log in" %>
+
+<p>Don't have an account? <%%= link_to "Sign up!", signup_path %></p>
+
+<%- if options[:authlogic] -%>
+<%%= form_for @<%= session_singular_name %> do |f| %>
+  <%%= f.error_messages %>
+  <p>
+    <%%= f.label :username %><br />
+    <%%= f.text_field :username %>
+  </p>
+  <p>
+    <%%= f.label :password %><br />
+    <%%= f.password_field :password %>
+  </p>
+  <p><%%= f.submit "Log in" %></p>
+<%% end %>
+<%- else -%>
+<%%= form_tag <%= session_plural_name %>_path do %>
+  <p>
+    <%%= label_tag :login, "Username or Email Address" %><br />
+    <%%= text_field_tag :login, params[:login] %>
+  </p>
+  <p>
+    <%%= label_tag :password %><br />
+    <%%= password_field_tag :password %>
+  </p>
+  <p><%%= submit_tag "Log in" %></p>
+<%% end %>
+<%- end -%>

data/lib/generators/niftier/authentication/templates/views/erb/signup.html.erb

@@ -0,0 +1,24 @@
+<%% title "Sign up" %>
+
+<p>Already have an account? <%%= link_to "Log in", login_path %>.</p>
+
+<%%= form_for @<%= user_singular_name %> do |f| %>
+  <%%= f.error_messages %>
+  <p>
+    <%%= f.label :username %><br />
+    <%%= f.text_field :username %>
+  </p>
+  <p>
+    <%%= f.label :email, "Email Address" %><br />
+    <%%= f.text_field :email %>
+  </p>
+  <p>
+    <%%= f.label :password %><br />
+    <%%= f.password_field :password %>
+  </p>
+  <p>
+    <%%= f.label :password_confirmation, "Confirm Password" %><br />
+    <%%= f.password_field :password_confirmation %>
+  </p>
+  <p><%%= f.submit "Sign up" %></p>
+<%% end %>

data/lib/generators/niftier/authentication/templates/views/haml/login.html.haml

@@ -0,0 +1,30 @@
+- title "Log in"
+
+%p== Don't have an account? #{link_to "Sign up!", signup_path}
+
+<%- if options[:authlogic] -%>
+- form_for @<%= session_singular_name %> do |f|
+  = f.error_messages
+  %p
+    = f.label :username
+    %br
+    = f.text_field :username
+  %p
+    = f.label :password
+    %br
+    = f.password_field :password
+  %p
+    = f.submit "Log in"
+<%- else -%>
+- form_tag <%= session_plural_name %>_path do
+  %p
+    = label_tag :login, "Username or Email Address"
+    %br
+    = text_field_tag :login, params[:login]
+  %p
+    = label_tag :password
+    %br
+    = password_field_tag :password
+  %p
+    = submit_tag "Log in"
+<%- end -%>