ubiquitous_user 0.3.1 → 0.4.0

data/README.rdoc

@@ -6,8 +6,9 @@ accounts for many tasks, but you don't need those accounts to be any more than
 an id. No username, no password, no profile.
 
 This library is an implementation of that. You add the Usable mixin to your
-ApplicationController and after that call user to get a user, or user! to get a
-user that exists on the database (it'll be stored if needed).
+ApplicationController and after that call user to get a user. When a new user
+is saved, it'll automatically store the session[:user_id] in the controller to
+mark this new user as the logged in user.
 
 When a user log ins what you have to do is set the user, which is just doing
 user = userObject.
@@ -99,10 +100,12 @@ ApplicationController, like this:
     #...
   end
 
-After that you can use user and user! anywhere, for example:
+After that you can use user anywhere, for example:
+
+  @item.recommender = user
+
+or
 
-  @item.recommender = user!
-  
   <%=h user.name %>
 
 You can use user= and authorize in the controllers, for example:

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/generators/ubiquitous_user/ubiquitous_user_generator.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# Copyright 2010 J. Pablo Fernández
+
 class UbiquitousUserGenerator < Rails::Generator::Base
   def manifest
     record do |m|

data/lib/ubiquitous_user.rb

@@ -30,26 +30,30 @@ module UsableHelpers
   # Helper method to get the current user. It will always return a user but the
   # user may not be in the database. If options[:create] is true, then the user
   # will be in the database (although it may be a ghost user).
-  def user(options = {:save => false})
+  def user
     # Find the user in the database if session[:user_id] is defined and @ubiquitous_user is not.
     @ubiquitous_user = UsableConfig::user_model_class.find_by_id(session[:user_id]) if session[:user_id] != nil and @ubiquitous_user == nil
     
     # Create a new user object if @ubiquitous_user is not defined.
     @ubiquitous_user = UsableConfig::user_model_class.send(UsableConfig::user_model_new) if @ubiquitous_user == nil
     
-    # If the object is new and we are asked to save, do it.
-    if options[:save] and @ubiquitous_user.new_record?
-      # Save the user in the database and set the session user_id for latter.
-      @ubiquitous_user.send(UsableConfig::user_model_save)
-      session[:user_id] = @ubiquitous_user.id
+    # If the object is new, let's get ready to mark the user as logged in when saving.
+    if @ubiquitous_user.new_record? or @ubiquitous_user.id != session[:user_id]
+      @ubiquitous_user.instance_variable_set :@ubiquitous_user_controller, self
+      # TODO: save a previous after_save and call it.
+      def @ubiquitous_user.after_save
+        @ubiquitous_user_controller.session[:user_id] = self.id
+      end
     end
     
     return @ubiquitous_user
   end
   
-  # Helper method to get a user that for sure exists on the database.
+  # <b>DEPRECATED:</b> Please use <tt>user</tt> instead. Call
+  # <tt>user.save!</tt> if you really needed it saved.
   def user!
-    return user(:save => true)
+    warn "[DEPRECATION] use 'user' instead, call 'user.save!' if you really needed it saved"
+    return user
   end
   
   # Helper method to check whether a user is logged in or not

data/test/test_ubiquitous_user.rb

@@ -14,6 +14,7 @@ class TestUbiquitousUser < Test::Unit::TestCase
     end
     
     should "create a new user object on Controller#user" do
+      @user.expects(:new_record?).returns(true)
       User.expects(:new).returns(@user)
       
       user = @controller.user
@@ -23,6 +24,7 @@ class TestUbiquitousUser < Test::Unit::TestCase
     end
     
     should "should return previous user object on Controller#user" do
+      @user.expects(:new_record?).returns(true)
       @controller.ubiquitous_user = @user
       
       user = @controller.user
@@ -33,6 +35,7 @@ class TestUbiquitousUser < Test::Unit::TestCase
     should "find a user on Controller#user if there's a user_id on session" do
       user_id = 42
       @controller.session[:user_id] = user_id
+      @user.expects(:new_record?).returns(true)
       User.expects(:find_by_id).with(user_id).returns(@user)
       
       user = @controller.user
@@ -41,31 +44,35 @@ class TestUbiquitousUser < Test::Unit::TestCase
       assert_equal @user, @controller.ubiquitous_user
     end
     
-    should "save a new user when requested on Controller#user" do
+    should "set the session user_id when saving a user" do
       user_id = 43
       User.expects(:new).returns(@user)
       @user.expects(:new_record?).returns(true)
       @user.expects(:save!)
       @user.expects(:id).returns(user_id)
-      
-      user = @controller.user!
-      
+
+      user = @controller.user
+      user.save!
+      # save! should be calling after_save, but it isn't because it's a mock, so
+      # let's call it manually
+      user.after_save
+
       assert_equal @user, user
       assert_equal @user, @controller.ubiquitous_user
       assert_equal user_id, @controller.session[:user_id]
     end
-    
-    should "not save an existing user even when requested on Controller#user" do
-      user_id = 44
-      @controller.session[:user_id] = user_id
-      User.expects(:find_by_id).with(user_id).returns(@user)
-      @user.expects(:new_record?).returns(false)
-      
-      user = @controller.user!
-      
-      assert_equal @user, user
-      assert_equal @user, @controller.ubiquitous_user
-    end
+#
+#    should "not save an existing user even when requested on Controller#user" do
+#      user_id = 44
+#      @controller.session[:user_id] = user_id
+#      User.expects(:find_by_id).with(user_id).returns(@user)
+#      @user.expects(:new_record?).returns(false)
+#
+#      user = @controller.user!
+#
+#      assert_equal @user, user
+#      assert_equal @user, @controller.ubiquitous_user
+#    end
     
     should "set user on Controller#user=" do
       user_id = 45
@@ -171,21 +178,22 @@ class TestUbiquitousUser < Test::Unit::TestCase
       end
       
       should "create a new user object on #user" do
+        @user.expects(:new_record?).returns(true)
         Person.expects(:new_person).returns(@user)
         assert_equal @user, @controller.user
         assert_equal @user, @controller.ubiquitous_user
       end
       
-      should "save a new user when requested on #user" do
-        user_id = 43
-        Person.expects(:new_person).returns(@user)
-        @user.expects(:new_record?).returns(true)
-        @user.expects(:save_person!)
-        @user.expects(:id).returns(user_id)
-        assert_equal @user, @controller.user!
-        assert_equal @user, @controller.ubiquitous_user
-        assert_equal user_id, @controller.session[:user_id]
-      end
+#      should "save a new user when requested on #user" do
+#        user_id = 43
+#        Person.expects(:new_person).returns(@user)
+#        @user.expects(:new_record?).returns(true)
+#        @user.expects(:save_person!)
+#        @user.expects(:id).returns(user_id)
+#        assert_equal @user, @controller.user!
+#        assert_equal @user, @controller.ubiquitous_user
+#        assert_equal user_id, @controller.session[:user_id]
+#      end
       
       should "set user on Controller#user=" do
         user_id = 45

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "J. Pablo Fern\xC3\xA1ndez"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +01:00
+date: 2010-03-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency