rotten-rotten-generators 0.7.12

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Peter Coulton
+
+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,10 @@
+= Rotten Generators
+
+Rotten Scaffold is 
+
+== Copyright
+
+Copyright (c) 2009 Peter Coulton. See LICENSE for details.
+
+rotten_scaffold is copied from nifty_scaffold http://github.com/ryanb/nifty-generators/tree/master
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rotten-generators"
+    gem.summary = "Collection of rails generators"
+    gem.email = "peter@petercoulton.com"
+    gem.homepage = "http://github.com/PeterCoulton/rotten-generators"
+    gem.authors = ["Peter Coulton"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rotten-generators #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.7.12

data/cucumber.yml

@@ -0,0 +1 @@
+autotest: --format pretty features

data/features/rotten.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rotten_generators'
+
+require 'spec/expectations'

data/lib/rotten_generators.rb

@@ -0,0 +1,3 @@
+module RottenGenerators
+  # nothing to see here, the real action is under rails_generators
+end

data/rails_generators/rotten_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/rotten_authentication/rotten_authentication_generator.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+
+class RottenAuthenticationGenerator < 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'
+
+      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"
+    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
+    'haml'
+  end
+  
+  def test_framework
+    :rspec
+  end
+  
+  def add_options!(opt)
+  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/rotten_authentication/templates/authentication.rb

@@ -0,0 +1,37 @@
+# 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?
+    controller.filter_parameter_logging :password
+  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/rotten_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/rotten_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/rotten_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/rotten_authentication/templates/sessions_helper.rb

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

data/rails_generators/rotten_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/rotten_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