Document everything with YARD and fix some bugs along the way.

[mailshears.git] / lib / mv / plugins / agendav.rb

diff --git a/lib/mv/plugins/agendav.rb b/lib/mv/plugins/agendav.rb
index ad1e9c2bfcf9f88b6fb67cf893a4c0ecb4d0348a..80ab1b6013c4096395ff0ec33a96a02dc023ddb0 100644 (file)
--- a/lib/mv/plugins/agendav.rb
+++ b/lib/mv/plugins/agendav.rb
@@ -3,18 +3,29 @@ require 'pg'
 require 'common/agendav_plugin'
 require 'mv/mv_plugin'
 
+
+# Handle moving (renaming) Agendav users in its database. Agendav has
+# no concept of domains.
+#
 class AgendavMv
 
   include AgendavPlugin
   include MvPlugin
 
+  # Move the user *src* to *dst* within the Agendav database. This
+  # should "rename" him in _every_ table where he is referenced.
+  #
+  # This can fail is *src* does not exist, or if *dst* already exists
+  # before the move. It should also be an error if the destination
+  # domain doesn't exist. But Agendav doesn't know about domains, so
+  # we let that slide.
+  #
+  # @param src [User] the source user to be moved.
+  #
+  # @param dst [User] the destination user being moved to.
+  #
   def mv_user(src, dst)
-    # It's obviously an error if the source user does not exist. It
-    # would also be an error if the destination domain didn't exist;
-    # however, Agendav doesn't know about domains, so we let that slide.
     raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
-
-    # And it's an error if the destination user exists already.
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
     sql_queries = ['UPDATE prefs SET username = $1 WHERE username = $2;']