sixarm_ruby_current_user 1.4.0 → 1.4.4

data/CHANGELOG.txt

@@ -1,5 +1,6 @@
 CHANGELOG
 
+2011-04-26 1.4.4 Add current_user_id methods
 2011-04-25 1.4.0 Add memoize and :reload => true
 2011-04-19 1.3.4 Add self and more tests
 2011-04-18 1.3.2 Update for Ruby 1.9.2 and Rails 3.0.5

data/README.rdoc

@@ -4,10 +4,69 @@ Author:: Joel Parker Henderson, joel@joelparkerhenderson.com
 Copyright:: Copyright (c) 2005-2011 Joel Parker Henderson
 License:: See LICENSE.txt file
 
-Simple gem to get and set the current user,
-using the related gem for current_user_id.
+Get and set the current user in the Rails session array.
+
+When you set the current user, this does:
+ - @current_user = user
+ - @current_user_id = user.id
+ - session[:current_user_id] = user.id
+
+
+== Example code
+
+   joe = User.find(123)
+   self.current_user = joe
+   => 
+   @current_user == joe
+   @current_user_id == 123
+   session[:current_user_id] == 123
+
+
+== Example controller
+
+  class MyController < ApplicationController
+
+    def sign_in(user)
+      self.current_user = user
+    end
+
+    def sign_out
+      self.current_user = nil
+    end
+
+    def is_anyone_using_this?
+      current_user?
+    end
+
+  end
+
+
+== Example of reloading
+
+For fast speed, we memoize current_user and current_user_id: 
+we use fast instance variables @current_user and @current_user_id
+rather than reading the slower session[:current_user_id] each time.
+
+To reload @current_user and @current_user_id from session[:current_user_id], 
+we use the :reload parameter like this:
+
+   current_user(:reload => true)
+
+
+== Why use the self prefix?
+
+When we set variables, we must use the "self" prefix because Ruby uses this to do method dispatch.
+
+Right:
+   self.current_user = joe
+
+Wrong:
+   current_user = joe
+
+
+
+
+
 
-For speed, we memoize the current_user.
 
-The current_user_find method also includes the user's roles.
 

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.4

data/lib/sixarm_ruby_current_user.rb

@@ -3,10 +3,17 @@
 Please see README.rdoc
 =end
 
-require 'sixarm_ruby_current_user_id'
 
 module CurrentUser
 
+
+  ###
+  #
+  # Methods for the User model
+  #
+  ###
+
+
   # Get the current user.
   # 
   # This calls User.find with the current_user_id
@@ -20,7 +27,7 @@ module CurrentUser
   
   def current_user(ops={})
     if ops[:reload] then @current_user=nil end
-    @current_user ||= (current_user_id ? User.find(current_user_id) : nil)
+    @current_user ||= (current_user_id(ops) ? User.find(current_user_id) : nil)
   end
   
 
@@ -39,4 +46,44 @@ module CurrentUser
     @current_user = user
   end
 
+
+  ###
+  #
+  #  Methods for the User id
+  #
+  ###
+
+
+  # Get the current user id in the Rails session array.
+  #
+  # The current user id is memoized as @current_user_id.
+  # To reload, pass :reload => true
+  #
+  # Return the session's current user id.
+
+  def current_user_id(ops={})
+    if ops[:reload] then @current_user_id=nil end
+    @current_user_id ||= session[:current_user_id]
+  end
+
+
+  # Is there a current user id in the Rails session array?
+
+  def current_user_id?
+    return session[:current_user_id] ? true : false
+  end
+
+
+  # Set the current user id in the Rails session array.
+  # Return the current user id, suitable for chaining.
+  
+  def current_user_id=(id)
+    @current_user_id=session[:current_user_id]=id
+  end
+
+
 end
+
+
+
+

data/test/sixarm_ruby_current_user_test.rb

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 require 'test/unit'
 require 'sixarm_ruby_current_user'
-require 'sixarm_ruby_current_user_id'
 require 'sixarm_ruby_active_record_mock'
 require 'simplecov'
 SimpleCov.start
@@ -17,13 +16,18 @@ class Testing < Test::Unit::TestCase
   end
 
   include CurrentUser
-  include CurrentUserId
+
+
+  ###
+  #
+  # Methods for the User model
+  #
+  ###
 
   ANNE = User.new(:id => 1, :name => 'Anne')
   BETH = User.new(:id => 2, :name => 'Beth')
   CATE = User.new(:id => 3, :name => 'Cate')
 
-
   def test_blank_slate
     assert_nil(current_user, "current_user")
     assert_nil(current_user_id, "current_user_id")
@@ -74,9 +78,58 @@ class Testing < Test::Unit::TestCase
     assert_equal(nil, actual, "current_user")
   end
 
-end
 
 
+  ###
+  #
+  # Methods for the User id
+  #
+  ###
+
+  ID=1234
+
+  def test_current_user_id_default_is_nil
+    assert_nil(current_user_id, "current_user_id is not set, so current_user_id should be nil")
+  end
+
+  def test_current_user_id_equals
+    self.current_user_id=ID
+    assert_equal(ID, @current_user_id, "current_user_id is set, so @current_user_id should be an id")
+    assert_equal(ID, session[:current_user_id], "current_user_id is set, so session[:current_user_id] should be an id")
+  end
+
+  def test_current_user_id_equals_with_round_trip
+    self.current_user_id=ID
+    assert_equal(ID, current_user_id, "current_user_id is set, so current_user_id should be an id")
+  end
 
 
+  def test_current_user_id_with_memoize
+    self.current_user_id=ID
+    session[:current_user_id]=ID+1
+    assert_equal(ID, current_user_id, "current_user_id is memoized, so current_user_id should be an id")
+  end
 
+  def test_current_user_id_reload_false
+    self.current_user_id=ID
+    session[:current_user_id]=ID+1
+    assert_equal(ID, current_user_id(:reload=>false), "current_user_id reload => false, so current_user_id should be an id")
+  end
+
+  def test_current_user_id_reload_true
+    self.current_user_id=ID
+    session[:current_user_id]=ID+1
+    assert_equal(ID+1, current_user_id(:reload=>true), "current_user_id reload => true, so current_user_id should be an id")
+  end
+    
+  def test_current_user_id_question_is_false
+    assert_equal(false, current_user_id?, "current_user_id is not set, so current_user_id? should be false")
+  end
+
+  def test_current_user_id_question_is_true
+    self.current_user_id=ID
+    assert_equal(true, current_user_id?, "current_user_id is set, so current_user_id? should be true")
+  end
+
+
+end

metadata

@@ -2,7 +2,7 @@
 name: sixarm_ruby_current_user
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.4.0
+  version: 1.4.4
 platform: ruby
 authors: 
 - SixArm
@@ -33,28 +33,17 @@ cert_chain:
 date: 2011-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: sixarm_ruby_current_user_id
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 1.4.0
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: sixarm_ruby_active_record_mock
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 1.4.4
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 description: 
 email: sixarm@sixarm.com
 executables: []