sixarm_ruby_current_user_id 1.3.8 → 1.4.2

data/CHANGELOG.txt

@@ -1,6 +1,7 @@
 CHANGELOG
 
-2011-04-25 1.3.8 Add memoize and :reload => true
+2011-04-25 1.4.2 Add better memoize and fix bug in current_user_id text
+2011-04-25 1.4.0 Add memoize and :reload => true
 2011-04-22 1.3.4 Add self to protect from local variable masking
 2011-04-19 1.3.2 Bump to match sixarm_ruby_current_user gem
 2011-04-18 1.3.0 Public release of version for Ruby 1.9.2 and Rails 3.0.5

data/README.rdoc

@@ -6,5 +6,62 @@ License:: See LICENSE.txt file
 
 Get and set the current user id in the Rails session array.
 
+When you set the current user id:
+ - this sets session[:current_user_id] to the id
+ - this sets @current_user_id to the id
+
+
+== Example code
+
+   self.current_user_id = 1
+   => @current_user_id = session[:current_user_id] = 1
+
+
+== Example controller
+
+  class MyController < ApplicationController
+
+    def sign_in(user)
+      self.current_user_id = user.id
+    end
+
+    def sign_out
+      self.current_user_id = nil
+    end
+
+    def is_anyone_using_this?
+      current_user_id?
+    end
+
+  end
+
+
+== Example of reloading
+
+For fast speed, we memoize the current_user_id: 
+we use the fast instance variable @current_user_id
+rather than the slower session[:current_user_id].
+
+To reload @current_user_id from session[:current_user_id], 
+we use the :reload parameter like this:
+
+   current_user_id(: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_id = 1
+
+Wrong:
+   current_user_id = 1
+
+
+
+
+
+
 
 

data/VERSION

@@ -1 +1 @@
-1.3.8
+1.4.2

data/lib/sixarm_ruby_current_user_id.rb

@@ -30,7 +30,7 @@ module CurrentUserId
   # Return the current user id, suitable for chaining.
   
   def current_user_id=(id)
-    session[:current_user_id]=id
+    @current_user_id=session[:current_user_id]=id
   end
 
 

data/test/sixarm_ruby_current_user_id_test.rb

@@ -16,14 +16,38 @@ class Testing < Test::Unit::TestCase
   ID=1234
 
   def test_current_user_id_default_is_nil
-    assert_nil(self.current_user_id, "current_user_id is not set, so current_user_id should be 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_round_trip
+  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

metadata

@@ -2,7 +2,7 @@
 name: sixarm_ruby_current_user_id
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.8
+  version: 1.4.2
 platform: ruby
 authors: 
 - SixArm
@@ -30,7 +30,7 @@ cert_chain:
   eabwpCbAopo=
   -----END CERTIFICATE-----
 
-date: 2011-04-25 00:00:00 -07:00
+date: 2011-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: []