nifty-generators 0.3.1 → 0.3.2

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.3.2 (February 16th, 2010)
+
+* Including all files in gem, was missing files in rails_generator directory
+
+
 0.3.1 (February 16th, 2010)
 
 * improving documentation

data/Rakefile

@@ -1,2 +1,12 @@
-require 'rubygems'
-require 'rake'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/rails_generators/nifty_authentication/USAGE

@@ -0,0 +1,50 @@
+Description:
+    Generates a user model, users controller, and sessions controller. The 
+    users controller handles the registration and the sessions controller 
+    handles authentication. This is similar to restful_authentication, but 
+    simpler.
+    
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the nifty_layout generator. You may want to run that generator first.
+
+Usage:
+    If you do not pass any arguments, the model name will default to "user", and
+    the authentication controller will default to "session". You can override
+    each of these respectively by passing one or two arguments. Either name can
+    be CamelCased or under_scored.
+    
+    Make sure to setup the authlogic gem if you are using that option.
+    
+      config.gem "authlogic"
+
+Examples:
+    script/generate nifty_authentication
+        
+        Creates user model, users_controller, and sessions_controller.
+    
+    script/generate nifty_authentication account
+    
+        Creates account model, accounts_controller, and sessions_controller.
+    
+    script/generate nifty_authentication Account UserSession
+    
+        Creates account model, accounts_controller, and user_sessions_controller.
+
+Methods:
+    There are several methods generated which you can use in your application.
+    Here's a common example of what you might add to your layout.
+    
+      <% 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]
+    
+    See the generated file lib/authentication.rb for details.

data/rails_generators/nifty_authentication/lib/insert_commands.rb

@@ -0,0 +1,74 @@
+Rails::Generator::Commands::Create.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+      end
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend]
+      gsub_file file, /^(class|module) .+$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+  
+  def route_name(name, path, options = {})
+    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/rails_generators/nifty_authentication/nifty_authentication_generator.rb

@@ -0,0 +1,128 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+class NiftyAuthenticationGenerator < Rails::Generator::Base
+  attr_accessor :user_name, :session_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @user_name = @args[0] || 'user'
+    @session_name = @args[1] || (options[:authlogic] ? @user_name + '_session' : 'session')
+  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 "authlogic_session.rb", "app/models/#{session_singular_name}.rb" if options[:authlogic]
+      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/#{session_plural_name}"
+      m.template "sessions_controller.rb", "app/controllers/#{session_plural_name}_controller.rb"
+      m.template "sessions_helper.rb", "app/helpers/#{session_plural_name}_helper.rb"
+      m.template "views/#{view_language}/login.html.#{view_language}", "app/views/#{session_plural_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 session_plural_name
+      m.route_name :login, 'login', :controller => session_plural_name, :action => 'new'
+      m.route_name :logout, 'logout', :controller => session_plural_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/#{session_plural_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/#{session_plural_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 session_singular_name
+    session_name.underscore
+  end
+  
+  def session_plural_name
+    session_singular_name.pluralize
+  end
+
+  def session_class_name
+    session_name.camelize
+  end
+  
+  def session_plural_class_name
+    session_plural_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 }
+    opt.on("--authlogic", "Use Authlogic for authentication.") { |v| options[:authlogic] = 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,61 @@
+# 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 <%%=h current_<%= user_singular_name %>.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?, :redirect_to_target_or_default
+    controller.filter_parameter_logging :password
+  end
+  
+<%- if options[:authlogic] -%>
+  def current_<%= session_singular_name %>
+    return @current_<%= session_singular_name %> if defined?(@current_<%= session_singular_name %>)
+    @current_<%= session_singular_name %> = <%= session_class_name %>.find
+  end
+
+  def current_<%= user_singular_name %>
+    return @current_<%= user_singular_name %> if defined?(@current_<%= user_singular_name %>)
+    @current_<%= user_singular_name %> = current_<%= session_singular_name %> && current_<%= session_singular_name %>.record
+  end
+<%- else -%>
+  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
+<%- 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."
+      store_target_location
+      redirect_to login_url
+    end
+  end
+  
+  def redirect_to_target_or_default(default)
+    redirect_to(session[:return_to] || default)
+    session[:return_to] = nil
+  end
+  
+  private
+  
+  def store_target_location
+    session[:return_to] = request.request_uri
+  end
+end

data/rails_generators/nifty_authentication/templates/authlogic_session.rb

@@ -0,0 +1,2 @@
+class <%= session_class_name %> < Authlogic::Session::Base
+end

data/rails_generators/nifty_authentication/templates/fixtures.yml

@@ -0,0 +1,24 @@
+# password: "secret"
+foo:
+  username: foo
+  email: foo@example.com
+<%- if options[:authlogic] -%>
+  persistence_token: d5ddba13ed4408ea2b0a12ab18ed2d2eda086279736bdc121ca726a11f1e4b99217d9c534c2cc4ebb22729349c8c5fdbe1529e1f2c3c5859c62ef4dd9feea25c
+  crypted_password: 3d16c326648cccafe3d4b4cb024475c381dda92f430dfedf6f933e1f61203bacb6bae2437849bdb43b06be335e23790e4aa03902b3c28c3bbbbe27d501e521f3
+  password_salt: n6z_wtpWoIsHgQb5IcFd
+<%- else -%>
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0
+<%- end -%>
+
+bar:
+  username: bar
+  email: bar@example.com
+<%- if options[:authlogic] -%>
+  persistence_token: 19e074bd7cb506ab3e7e53e41f24f0ab3221c8cb68111f4c1aa43965114ad734233979a50a9463537487cdca18c279ac91c4bc83693d589625d446493322394c
+  crypted_password: 3bc9f4113ca645a186765df3d31a9352d0067bf2304ba0cdd6b08a7f3d58c6668ab1762fa3e76aef466ea2ff188399d8e6c40244fa59312bb4112292dac9f7f0
+  password_salt: UiAh9ejabnKRxqsiK0xO
+<%- else -%>
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0
+<%- end -%>

data/rails_generators/nifty_authentication/templates/migration.rb

@@ -0,0 +1,20 @@
+class Create<%= user_plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= user_plural_name %> do |t|
+      t.string :username
+      t.string :email
+    <%- if options[:authlogic] -%>
+      t.string :persistence_token
+      t.string :crypted_password
+    <%- else -%>
+      t.string :password_hash
+    <%- end -%>
+      t.string :password_salt
+      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,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(root_url)
+    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 root_url
+  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(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 -%>
+end

data/rails_generators/nifty_authentication/templates/sessions_helper.rb

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

data/rails_generators/nifty_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(root_url)
+    <%= 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(root_url)
+    session['<%= user_singular_name %>_id'].should == <%= user_class_name %>.first.id
+  end
+<%- end -%>
+end