redis-messages 0.1

data/lib/generators/redis_messages/templates/redis.rb

@@ -0,0 +1 @@
+<%= redis_constant_name %> = Redis.new

data/lib/generators/redis_messages/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
+  render_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/redis_messages/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/redis_messages/templates/tests/rspec/users_controller.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe <%= user_plural_class_name %>Controller do
+  fixtures :all
+  render_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
+
+  it "edit action should redirect when not logged in" do
+    get :edit, :id => "ignored"
+    response.should redirect_to(login_url)
+  end
+
+  it "edit action should render edit template" do
+    @controller.stubs(:current_<%= user_singular_name %>).returns(<%= user_class_name %>.first)
+    get :edit, :id => "ignored"
+    response.should render_template(:edit)
+  end
+
+  it "update action should redirect when not logged in" do
+    put :update, :id => "ignored"
+    response.should redirect_to(login_url)
+  end
+
+  it "update action should render edit template when <%= user_singular_name %> is invalid" do
+    @controller.stubs(:current_<%= user_singular_name %>).returns(<%= user_class_name %>.first)
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(false)
+    put :update, :id => "ignored"
+    response.should render_template(:edit)
+  end
+
+  it "update action should redirect when <%= user_singular_name %> is valid" do
+    @controller.stubs(:current_<%= user_singular_name %>).returns(<%= user_class_name %>.first)
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(true)
+    put :update, :id => "ignored"
+    response.should redirect_to("/")
+  end
+end

data/lib/generators/redis_messages/templates/user.rb

@@ -0,0 +1,12 @@
+class <%= user_class_name %> < ActiveRecord::Base
+  has_many :<%= message_plural_name %>
+  
+  def inbox
+    <%= message_singular_name %>_ids = <%= redis_constant_name %>.smembers(<%= message_class_name %>.inbox_for(self.username))
+    <%= message_class_name %>.where(:visible => true, :id => <%= message_singular_name %>_ids).order("created_at DESC")
+  end
+  
+  def outbox
+    self.<%= message_plural_name %>(:visible => true)
+  end
+end

data/lib/generators/redis_messages/templates/user_injection_code.rb

@@ -0,0 +1,10 @@
+  has_many :<%= message_plural_name %>
+  
+  def inbox
+    <%= message_singular_name %>_ids = <%= redis_constant_name %>.smembers(<%= message_class_name %>.inbox_for(self.username))
+    <%= message_class_name %>.where(:visible => true, :id => <%= message_singular_name %>_ids).order("created_at DESC")
+  end
+  
+  def outbox
+    self.<%= message_plural_name %>(:visible => true)
+  end

data/lib/generators/redis_messages/templates/user_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.string :username
+      t.string :email
+      t.string :password_hash
+      t.string :password_salt
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= user_plural_name %>
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,119 @@
+require 'test/unit'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+require 'rubygems'
+gem 'rails', '2.0.2' # getting a Rails.configuration error with 2.1
+gem 'rubigen', '1.4'
+gem 'shoulda', '2.0.6'
+require 'rubigen' # gem install rubigen --version=1.4
+require 'rubigen/helpers/generator_test_helper'
+require 'rails_generator'
+require 'shoulda' # gem install shoulda --version=2.0.6
+require 'mocha'
+
+module RedisMessages
+  module TestHelper
+    include RubiGen::GeneratorTestHelper
+
+    def setup
+      bare_setup
+    end
+
+    def teardown
+      bare_teardown
+    end
+
+    protected
+
+    def run_rails_generator(generator, *args)
+      options = args.pop if args.last.kind_of? Hash
+      options ||= {}
+      run_generator(generator.to_s, args, generator_sources, options.reverse_merge(:quiet => true))
+    end
+
+    def generator_sources
+      [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "rails_generators"))]
+    end
+  end
+
+  module ShouldaAdditions
+    def rails_generator(*args)
+      setup do
+        run_rails_generator(*args)
+      end
+    end
+
+    def should_generate_file(file, &block)
+      should "generate file #{file}" do
+        yield("foo") if block_given?
+        assert_generated_file(file)
+      end
+    end
+
+    def should_not_generate_file(file)
+      should "not generate file #{file}" do
+        assert !File.exists?("#{APP_ROOT}/#{file}"),"The file '#{file}' should not exist"
+      end
+    end
+  end
+end
+
+class Thoughtbot::Shoulda::Context
+  include RedisMessages::ShouldaAdditions
+end
+
+# Mock out what we need from AR::Base.
+module ActiveRecord
+  class Base
+    class << self
+      attr_accessor :pluralize_table_names, :columns
+
+      def add_column(name, type = :string)
+        returning ActiveRecord::ConnectionAdapters::Column.new(name, nil) do |column|
+          column.type = type
+          @columns ||= []
+          @columns << column
+        end
+      end
+    end
+    self.pluralize_table_names = true
+  end
+
+  module ConnectionAdapters
+    class Column
+      attr_accessor :name, :default, :type, :limit, :null, :sql_type, :precision, :scale
+
+      def initialize(name, default, sql_type = nil)
+        @name = name
+        @default = default
+        @type = @sql_type = sql_type
+      end
+
+      def human_name
+        @name.humanize
+      end
+    end
+  end
+end
+
+# And what we need from ActionView
+module ActionView
+  module Helpers
+    module ActiveRecordHelper; end
+    class InstanceTag; end
+  end
+end

data/test/test_nifty_authentication_generator.rb

@@ -0,0 +1,274 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+class TestSeivanAuthenticationGenerator < Test::Unit::TestCase
+  include RedisMessages::TestHelper
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  context "" do # empty context so we can use setup block
+    setup do
+      Rails.stubs(:version).returns("2.0.2")
+      Dir.mkdir("#{RAILS_ROOT}/config") unless File.exists?("#{RAILS_ROOT}/config")
+      File.open("#{RAILS_ROOT}/config/routes.rb", 'w') do |f|
+        f.puts "ActionController::Routing::Routes.draw do |map|\n\nend"
+      end
+      Dir.mkdir("#{RAILS_ROOT}/app") unless File.exists?("#{RAILS_ROOT}/app")
+      Dir.mkdir("#{RAILS_ROOT}/app/controllers") unless File.exists?("#{RAILS_ROOT}/app/controllers")
+      File.open("#{RAILS_ROOT}/app/controllers/application.rb", 'w') do |f|
+        f.puts "class Application < ActionController::Base\n\nend"
+      end
+    end
+
+    teardown do
+      FileUtils.rm_rf "#{RAILS_ROOT}/config"
+      FileUtils.rm_rf "#{RAILS_ROOT}/app"
+    end
+
+    context "generator without arguments" do
+      rails_generator :nifty_authentication
+      should_generate_file 'app/models/user.rb'
+      should_generate_file 'app/controllers/users_controller.rb'
+      should_generate_file 'app/helpers/users_helper.rb'
+      should_generate_file 'app/views/users/new.html.erb'
+      should_generate_file 'app/controllers/sessions_controller.rb'
+      should_generate_file 'app/helpers/sessions_helper.rb'
+      should_generate_file 'app/views/sessions/new.html.erb'
+      should_generate_file 'lib/authentication.rb'
+      should_generate_file 'test/fixtures/users.yml'
+      should_generate_file 'test/unit/user_test.rb'
+      should_generate_file 'test/functional/users_controller_test.rb'
+      should_generate_file 'test/functional/sessions_controller_test.rb'
+
+      should "generate migration file" do
+        assert !Dir.glob("#{RAILS_ROOT}/db/migrate/*.rb").empty?
+      end
+
+      should "generate routes" do
+        assert_generated_file "config/routes.rb" do |body|
+          assert_match "map.resources :sessions", body
+          assert_match "map.resources :users", body
+          assert_match "map.login 'login', :controller => 'sessions', :action => 'new'", body
+          assert_match "map.logout 'logout', :controller => 'sessions', :action => 'destroy'", body
+          assert_match "map.signup 'signup', :controller => 'users', :action => 'new'", body
+        end
+      end
+
+      should "include Authentication" do
+        application_controller_name = Rails.version >= '2.3.0' ? 'application_controller' : 'application'
+        assert_generated_file "app/controllers/#{application_controller_name}.rb" do |body|
+          assert_match "include Authentication", body
+        end
+      end
+    end
+
+    context "generator with user and session names" do
+      rails_generator :nifty_authentication, "Account", "CurrentSession"
+      should_generate_file 'app/models/account.rb'
+      should_generate_file 'app/controllers/accounts_controller.rb'
+      should_generate_file 'app/helpers/accounts_helper.rb'
+      should_generate_file 'app/views/accounts/new.html.erb'
+      should_generate_file 'app/controllers/current_sessions_controller.rb'
+      should_generate_file 'app/helpers/current_sessions_helper.rb'
+      should_generate_file 'app/views/current_sessions/new.html.erb'
+      should_generate_file 'test/fixtures/accounts.yml'
+      should_generate_file 'test/unit/account_test.rb'
+      should_generate_file 'test/functional/accounts_controller_test.rb'
+      should_generate_file 'test/functional/current_sessions_controller_test.rb'
+
+      should "generate routes" do
+        assert_generated_file "config/routes.rb" do |body|
+          assert_match "map.resources :current_sessions", body
+          assert_match "map.resources :accounts", body
+          assert_match "map.login 'login', :controller => 'current_sessions', :action => 'new'", body
+          assert_match "map.logout 'logout', :controller => 'current_sessions', :action => 'destroy'", body
+          assert_match "map.signup 'signup', :controller => 'accounts', :action => 'new'", body
+        end
+      end
+    end
+
+    context "generator with shoulda option" do
+      rails_generator :nifty_authentication, :test_framework => :shoulda
+
+      should "have controller and model tests using shoulda syntax" do
+        assert_generated_file "test/functional/users_controller_test.rb" do |body|
+          assert_match " should ", body
+        end
+        assert_generated_file "test/functional/sessions_controller_test.rb" do |body|
+          assert_match " should ", body
+        end
+
+        assert_generated_file "test/unit/user_test.rb" do |body|
+          assert_match " should ", body
+        end
+      end
+    end
+
+    context "generator with rspec option" do
+      rails_generator :nifty_authentication, :test_framework => :rspec
+      should_generate_file 'spec/fixtures/users.yml'
+    end
+
+    context "with spec dir" do
+      setup do
+        Dir.mkdir("#{RAILS_ROOT}/spec") unless File.exists?("#{RAILS_ROOT}/spec")
+      end
+
+      teardown do
+        FileUtils.rm_rf "#{RAILS_ROOT}/spec"
+      end
+
+      context "generator without arguments" do
+        rails_generator :nifty_authentication
+        should_generate_file 'spec/fixtures/users.yml'
+        should_generate_file 'spec/models/user_spec.rb'
+        should_generate_file 'spec/controllers/users_controller_spec.rb'
+        should_generate_file 'spec/controllers/sessions_controller_spec.rb'
+      end
+
+      context "generator with user and session names" do
+        rails_generator :nifty_authentication, "Account", "CurrentSessions"
+        should_generate_file 'spec/fixtures/accounts.yml'
+        should_generate_file 'spec/models/account_spec.rb'
+        should_generate_file 'spec/controllers/accounts_controller_spec.rb'
+        should_generate_file 'spec/controllers/current_sessions_controller_spec.rb'
+      end
+
+      context "generator with testunit option" do
+        rails_generator :nifty_authentication, :test_framework => :testunit
+        should_generate_file 'test/fixtures/users.yml'
+      end
+    end
+
+    context "generator with haml option" do
+      rails_generator :nifty_authentication, :haml => true
+
+      should_generate_file "app/views/users/new.html.haml"
+      should_generate_file "app/views/sessions/new.html.haml"
+    end
+
+    context "generator with authlogic option and custom account name" do
+      rails_generator :nifty_authentication, "Account", :authlogic => true
+      should_generate_file 'app/models/account.rb'
+      should_generate_file 'app/controllers/accounts_controller.rb'
+      should_generate_file 'app/helpers/accounts_helper.rb'
+      should_generate_file 'app/views/accounts/new.html.erb'
+      should_generate_file 'app/controllers/account_sessions_controller.rb'
+      should_generate_file 'app/helpers/account_sessions_helper.rb'
+      should_generate_file 'app/views/account_sessions/new.html.erb'
+      should_generate_file 'test/fixtures/accounts.yml'
+      should_generate_file 'test/unit/account_test.rb'
+      should_generate_file 'test/functional/accounts_controller_test.rb'
+      should_generate_file 'test/functional/account_sessions_controller_test.rb'
+      should_generate_file 'lib/authentication.rb'
+
+      should "only include acts_as_authentic in account model" do
+        assert_generated_file "app/models/account.rb" do |body|
+          assert_match "acts_as_authentic", body
+          assert_no_match(/validates/, body)
+          assert_no_match(/def/, body)
+        end
+      end
+
+      should "should generate authentication module with current_account_session method" do
+        assert_generated_file "lib/authentication.rb" do |body|
+          assert_match "def current_account_session", body
+        end
+      end
+
+      should "should generate AccountSession model" do
+        assert_generated_file "app/models/account_session.rb" do |body|
+          assert_match "class AccountSession < Authlogic::Session::Base", body
+        end
+      end
+
+      should "should generate restful style actions in sessions controller" do
+        assert_generated_file "app/controllers/account_sessions_controller.rb" do |body|
+          assert_match "AccountSession.new", body
+        end
+      end
+
+      should "should generate form for account session" do
+        assert_generated_file "app/views/account_sessions/new.html.erb" do |body|
+          assert_match "form_for @account_session", body
+        end
+      end
+
+      should "should not include tests in account since authlogic is already tested" do
+        assert_generated_file "test/unit/account_test.rb" do |body|
+          assert_no_match(/def test/, body)
+        end
+      end
+
+      should "should handle session controller tests differently" do
+        assert_generated_file "test/functional/account_sessions_controller_test.rb" do |body|
+          assert_match "AccountSession.find", body
+        end
+      end
+
+      should "generate migration with authlogic columns" do
+        file = Dir.glob("#{RAILS_ROOT}/db/migrate/*.rb").first
+        assert file, "migration file doesn't exist"
+        assert_match(/[0-9]+_create_accounts.rb$/, file)
+        assert_generated_file "db/migrate/#{File.basename(file)}" do |body|
+          assert_match "class CreateAccounts", body
+          assert_match "t.string :username", body
+          assert_match "t.string :email", body
+          assert_match "t.string :crypted_password", body
+          assert_match "t.string :password_salt", body
+          assert_match "t.string :persistence_token", body
+          assert_match "t.timestamps", body
+          assert_no_match(/password_hash/, body)
+        end
+      end
+    end
+
+    context "generator with authlogic option and custom account and session name" do
+      rails_generator :nifty_authentication, "Account", "UserSession", :authlogic => true
+      should_generate_file 'app/controllers/user_sessions_controller.rb'
+      should_generate_file 'app/helpers/user_sessions_helper.rb'
+      should_generate_file 'app/views/user_sessions/new.html.erb'
+      should_generate_file 'test/functional/user_sessions_controller_test.rb'
+
+      should "should generate authentication module with current_user_session method" do
+        assert_generated_file "lib/authentication.rb" do |body|
+          assert_match "def current_user_session", body
+        end
+      end
+
+      should "should generate UserSession model" do
+        assert_generated_file "app/models/user_session.rb" do |body|
+          assert_match "class UserSession < Authlogic::Session::Base", body
+        end
+      end
+
+      should "should generate restful style actions in sessions controller" do
+        assert_generated_file "app/controllers/user_sessions_controller.rb" do |body|
+          assert_match "UserSession.new", body
+        end
+      end
+
+      should "should generate form for user session" do
+        assert_generated_file "app/views/user_sessions/new.html.erb" do |body|
+          assert_match "form_for @user_session", body
+        end
+      end
+
+      should "should handle session controller tests differently" do
+        assert_generated_file "test/functional/user_sessions_controller_test.rb" do |body|
+          assert_match "UserSession.find", body
+        end
+      end
+    end
+  end
+end