challah 0.5.2 → 0.5.3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Challah 0.5.3
+
+* Updated tests to conform with Factory Girl 3.0
+* Added `login_as` and `logout` test helper methods into `ActiveSupport::TestCase` by default. These methods can be used within functional tests to authenticate a user for a given test.
+* For each test run, all test sessions are cleared.
+* Removing support for Ruby 1.8.7, since Factory Girl does not support it anymore.
+
 ## Challah 0.5.2
 
 * Created `SimpleCookieStore` and use it as the default storage method for Session. This varies from `CookieStore` only because the user agent and remote IP address are not used in the cookie.
@@ -41,12 +48,12 @@
 
 ## Challah 0.3.1
 
-* Removed name spacing of controllers and default routes. 
+* Removed name spacing of controllers and default routes.
 * Added option to not include default routes
 
 ## Challah 0.3.0
 
-* Documentation clean up. 
+* Documentation clean up.
 * Added rake tasks for creating role, permission and user records.
 
 ## Challah 0.2.0

data/README.md

@@ -8,7 +8,7 @@ Challah doesn't provide any fancy controllers or views that clutter your app or
 
 ## Requirements
 
-* Ruby 1.8.7, 1.9.2 or 1.9.3
+* Ruby 1.9.2+
 * Bundler
 * Rails 3.1+
 
@@ -25,8 +25,8 @@ Or, in your `Gemfile`
 Once the gem has been set up and installed, run the following command to set up the database migrations:
 
     rake challah:setup
-    
-This will copy over the necessary migrations to your app, migrate the database and add some seed data. You will be prompted to add the first user as the last step in this process. 
+
+This will copy over the necessary migrations to your app, migrate the database and add some seed data. You will be prompted to add the first user as the last step in this process.
 
 ### Manual set up
 
@@ -36,7 +36,7 @@ If you would prefer to handle these steps manually, you can do so by using these
     rake db:migrate
     rake challah:setup:seeds
     rake challah:users:create
-    
+
 ### Creating users, permissions and roles
 
 Since Challah doesn't provide any controller and views for users, permissions and roles there are a few handy rake tasks you can use to create new records.
@@ -46,10 +46,10 @@ The following tasks will prompt for the various attributes in each model:
     rake challah:permissions:create     # => Create a new Permission record
     rake challah:roles:create           # => Create a new Role record
     rake challah:users:create           # => Creates a new User record
-    
+
 ## Models
 
-Challah provides three core models to your app: Permission, Role and User. By default, these models are hidden away in the Challah gem engine, but you can always copy the models into your app to make further modifications to the functionality. 
+Challah provides three core models to your app: Permission, Role and User. By default, these models are hidden away in the Challah gem engine, but you can always copy the models into your app to make further modifications to the functionality.
 
 ### User
 
@@ -71,9 +71,9 @@ The default Challah installation creates two permissions by default: `admin` and
 
 ### Role
 
-A role is used to group together various permissions and assign them to a user. Roles can also be thought of as user groups. Each role record requires a unique name. 
+A role is used to group together various permissions and assign them to a user. Roles can also be thought of as user groups. Each role record requires a unique name.
 
-Roles should only be used within your app to consolidate various permissions into logical groups. Roles are not intended to be used to restrict functionality, use permissions instead. 
+Roles should only be used within your app to consolidate various permissions into logical groups. Roles are not intended to be used to restrict functionality, use permissions instead.
 
 The default Challah installation creates two roles by default: 'Administrator' and 'Default'. Administrators have all permissions, now and in the future. Default users have no permissions other than being able to log in.
 
@@ -103,12 +103,12 @@ For example, restrict the second list item to only users that have logged in:
       <li><a href="/public-stuff">Not-so-secret Stuff</a></li>
     </ul>
 
-Controllers can also be restricted using `before_filter`: 
+Controllers can also be restricted using `before_filter`:
 
     class WidgetsController < ApplicationController
       before_filter :login_required
 
-      # …	
+      # …
     end
 
 Or, you can call `restrict_to_authenticated` instead, which does the same thing:
@@ -116,7 +116,7 @@ Or, you can call `restrict_to_authenticated` instead, which does the same thing:
     class WidgetsController < ApplicationController
       restrict_to_authenticated
 
-      # ...	
+      # ...
     end
 
 All normal Rails `before_filter` options apply, so you can always limit this restriction to a specific action:
@@ -124,12 +124,12 @@ All normal Rails `before_filter` options apply, so you can always limit this res
     class WidgetsController < ApplicationController
       restrict_to_authenticated :only => [ :edit, :update, :destroy ]
 
-      # ...	
+      # ...
     end
 
 ### Checking for a permission
 
-Since Challah is a permissions-based system, all restricted access should be performed by testing a user for the given permission. 
+Since Challah is a permissions-based system, all restricted access should be performed by testing a user for the given permission.
 
 Anywhere you can access a user instance, you can use the `has` method and pass in a single permission key to test that user for access:
 
@@ -143,7 +143,7 @@ Anywhere you can access a user instance, you can use the `has` method and pass i
       <li><a href="/public-stuff">Not-so-secret Stuff</a></li>
     </ul>
 
-Notice that we checked for existance of the user before we checked to see if the user has a permission. If you used the `restrict_to_authenticated` method in your controller, you can likely skip this step. 
+Notice that we checked for existance of the user before we checked to see if the user has a permission. If you used the `restrict_to_authenticated` method in your controller, you can likely skip this step.
 
 Note: `current_user` will return `nil` if there is no user available, so checking for `current_user?` prevents you from calling `has` on `nil`.
 
@@ -152,7 +152,7 @@ For controller restrictions, use the `restrict_to_permission` method:
     class WidgetsController < ApplicationController
       restrict_to_permission :manage_widgets
 
-      # ...	
+      # ...
     end
 
 The `restrict_to_permission` method will also fail if there is no user currently authenticated.
@@ -162,7 +162,7 @@ And, just as before, we can use the Rails filter options to limit the restrictio
     class WidgetsController < ApplicationController
       restrict_to_permission :admin, :only => [ :destroy ]
 
-      # ...	
+      # ...
     end
 
 And of course, you can stack up multiple restrictions get very specific about what your users can do:
@@ -176,7 +176,7 @@ And of course, you can stack up multiple restrictions get very specific about wh
       restrict_to_permission :manage_widgets, :except => [ :index, :destroy ]
       restrict_to_permission :admin, :only => [ :destroy ]
 
-      # ...	
+      # ...
     end
 
 Whichever method you use will yield the same results. Just make sure you are checking for a permission key, and not checking for a role. Checking for roles (i.e.: `user.role_id == 1`) is shameful practice. Use permissions!
@@ -188,7 +188,7 @@ By default, there are a few routes included with the Challah engine. These route
     GET   /login        # => SessionsController#new
     POST  /login        # => SessionsController#create
     GET   /logout       # => SessionsController#new
-    
+
 Feel free to override the `SessionsController` with something more appropriate for your app.
 
 If you'd prefer to set up your own login/logout actions, you can skip the inclusion of the default routes by adding the following line to an initializer file in your app:

data/lib/challah/test.rb

@@ -4,23 +4,40 @@ class TestSessionStore
   def initialize(session = nil)
     @session = session
   end
-  
+
   def destroy
     $challah_test_session = nil
   end
-  
+
   def read
     if $challah_test_session
       return $challah_test_session.to_s.split(':')
     end
-    
+
     nil
   end
-  
+
   def save(token, user_id)
     $challah_test_session = "#{token}:#{user_id}"
     true
   end
 end
 
-Challah.options[:storage_class] = TestSessionStore
+Challah.options[:storage_class] = TestSessionStore
+
+class ActiveSupport::TestCase
+  # Log the given user instance in
+  def login_as(user)
+    Challah::Session.create!(user)
+  end
+
+  # Log the given user instance out
+  def logout
+    Challah::Session.destroy
+  end
+
+  setup do
+    # Reset any challah user sessions for each test.
+    $challah_test_session = nil
+  end
+end

data/lib/challah/version.rb

@@ -1,3 +1,3 @@
 module Challah
-  VERSION = "0.5.2" unless defined?(::Challah::VERSION)
+  VERSION = "0.5.3" unless defined?(::Challah::VERSION)
 end

data/test/audit_test.rb

@@ -4,104 +4,104 @@ class AuditTest < ActiveSupport::TestCase
   include ActiveModel::Lint::Tests
 
   # Use Widget as a fake model to test auditing.
-  class Widget    
+  class Widget
     include ActiveModel::Conversion
     include ActiveModel::Validations
     extend ActiveModel::Naming
     extend ActiveModel::Callbacks
-    
+
     define_model_callbacks :create, :update, :save
-    
+
     include Challah::Audit
 
     attr_accessor :name, :created_by, :created_at, :updated_by, :updated_at
-    
+
     def initialize(attributes = {})
       attributes.each do |name, value|
         send("#{name}=", value)
       end
-      
+
       @attributes = {}
     end
-    
+
     def persisted?
       false
     end
-    
+
     def new_record?
       !@saved
     end
-    
+
     def save
       # Saving doesn't do anything, just a stub
       run_callbacks :save do
         @saved = true
       end
-      
+
       true
     end
-    
+
     def column_for_attribute(attr_name)
       self.respond_to?("#{attr_name}=") ? attr_name : nil
     end
-    
+
     def write_attribute(attr_name, value)
       self.send("#{attr_name}=", value)
     end
-    
+
     # Stub for tests
     def changed_attributes
       {}
     end
-    
+
     # Stubs
     def attribute_changed?(attr_name)
       false
     end
   end
-  
-  # Runs the ActiveModel::Lint tests against a new Widget instance. 
+
+  # Runs the ActiveModel::Lint tests against a new Widget instance.
   def setup
     @model = Widget.new
   end
-  
+
   context "An audited model" do
     should "be able to receive a current user" do
-      user = Factory(:normal_user)
-      user_two = Factory(:user, :first_name => 'User', :last_name => 'Test 2')
-      
-      assert_equal 0, @model.current_user_id      
+      user = create(:normal_user)
+      user_two = create(:user, :first_name => 'User', :last_name => 'Test 2')
+
+      assert_equal 0, @model.current_user_id
       assert_equal true, @model.new_record?
-      
+
       # For a new record, setting current_user should update both attributes
-      @model.current_user = user      
+      @model.current_user = user
       assert_equal user.id, @model.current_user_id
-      
+
       @model.save
-            
+
       assert_equal user.id, @model.created_by
       assert_equal user.id, @model.updated_by
-      
+
       assert_equal false, @model.new_record?
-      
+
       # For an existing record, setting current_user (or current_user_id) should update only updated_by
       @model.current_user_id = user_two.id
       assert_equal user_two.id, @model.current_user_id
-      
+
       @model.save
-      
+
       assert_equal user.id, @model.created_by
       assert_equal user_two.id, @model.updated_by
     end
-    
+
     should "be able to clear audit attributes" do
       @model.created_by = 1
       @model.updated_by = 2
-      
+
       @model.initialize_dup(nil)
-      
+
       assert_equal nil, @model.created_by
       assert_equal nil, @model.updated_by
-    end 
+    end
   end
 end

data/test/controller_test.rb

@@ -2,31 +2,31 @@ require 'helper'
 
 class ControllerTest < ActiveSupport::TestCase
   include Challah
-  
+
   context "A controller" do
     setup do
-      @user = Factory(:user)
+      @user = create(:user)
       @controller = MockController.new
     end
-    
+
     should "be logged out by default" do
       assert_equal false, @controller.send(:current_user?)
     end
-    
-    should "have logged_in? and current_user methods" do      
+
+    should "have logged_in? and current_user methods" do
       session = Session.create(@user)
-      session.save    
-      
+      session.save
+
       assert_equal true, @controller.send(:current_user?)
       assert_equal @user, @controller.send(:current_user)
     end
-    
+
     should "redirect to login page if user is not logged in" do
       @controller.request.url = 'http://example.com/protected-page'
       @controller.stubs(:logged_in?).returns(false)
       @controller.expects(:redirect_to)
       @controller.send(:login_required)
-      
+
       assert_equal @controller.session[:return_to], 'http://example.com/protected-page'
     end
   end

data/test/cookie_store_test.rb

@@ -2,93 +2,93 @@ require 'helper'
 
 class CookieStoreTest < ActiveSupport::TestCase
   include Challah
-  
+
   context "The CookieStore class" do
     setup do
-      @user = Factory(:user)
+      @user = create(:user)
       @request = MockRequest.new
     end
-    
+
     should "save session in a request cookie store" do
       assert_equal [], @request.cookies.keys
-      
+
       session = Session.new(@request)
       session.store = CookieStore.new(session)
       session.persist = true
       session.user = @user
       session.save
-            
+
       assert_equal %w( challah-s challah-v ), @request.cookies.keys.sort
       assert_equal "#{@user.persistence_token}@#{@user.id}", @request.cookies['challah-s'][:value]
       assert_equal "test.dev", @request.cookies['challah-s'][:domain]
-      
+
       assert_equal Encrypter.md5("#{@user.persistence_token}@#{@user.id}", @request.user_agent, @request.remote_ip), @request.cookies['challah-v'][:value]
       assert_equal "test.dev", @request.cookies['challah-v'][:domain]
     end
-    
+
     should "be able to inspect the store" do
       session = Session.new(@request)
       session.store = CookieStore.new(session)
       session.persist = true
       session.user = @user
       session.save
-      
+
       assert session.store.inspect =~ /<CookieStore:(.*?)>/, 'Does not match'
-    end 
-    
+    end
+
     should "read cookies and detect tampered verification cookies" do
       assert_equal [], @request.cookies.keys
-      
+
       session = Session.new(@request)
       session.store = CookieStore.new(session)
       session.persist = true
       session.user = @user
       session.save
-      
+
       validation_cookie_val = Encrypter.md5("#{@user.persistence_token}@#{@user.id}", @request.user_agent, @request.remote_ip)
       session_cookie_val = "#{@user.persistence_token}@#{@user.id}"
-      
+
       assert_equal session_cookie_val, @request.cookies['challah-s'][:value]
       assert_equal session_cookie_val, session.store.send(:session_cookie)[:value]
       assert_equal validation_cookie_val, @request.cookies['challah-v'][:value]
       assert_equal validation_cookie_val, session.store.send(:validation_cookie)[:value]
-      
+
       session.store.stubs(:validation_cookie).returns(validation_cookie_val)
       session.store.stubs(:session_cookie).returns(session_cookie_val)
-      
+
       session2 = Session.new(@request)
       session2.persist = true
-      session2.store = session.store      
+      session2.store = session.store
       session2.read
-      
+
       assert_equal true, session2.store.send(:existing?)
       assert_equal true, session2.valid?
       assert_equal @user.id, session2.user_id
-      
+
       session.store.stubs(:validation_cookie).returns('bad-value')
-      
+
       session3 = Session.new(@request)
       session3.store = session.store
       session3.read
-      
+
       assert_equal false, session3.store.send(:existing?)
       assert_equal false, session3.valid?
     end
-    
+
     should "delete sessions from cookies" do
       session = Session.new(@request)
       session.store = CookieStore.new(session)
       session.user = @user
       session.persist = true
-      
+
       session.save
-      
+
       assert_equal true, session.valid?
       assert_equal @user, session.user
       assert_equal %w( challah-s challah-v ), @request.cookies.keys.sort
-      
+
       session.destroy
-      
+
       assert_equal false, session.valid?
       assert_equal nil, session.user
       assert_equal [], @request.cookies.keys.sort