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

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

diff --git a/lib/mv/plugins/davical.rb b/lib/mv/plugins/davical.rb
index 20c8a32af50d668fe8ccba1f690091cbddcafe9a..58287b3b69937eaa32b2823d3ffd62f13de83566 100644 (file)
--- a/lib/mv/plugins/davical.rb
+++ b/lib/mv/plugins/davical.rb
@@ -3,26 +3,30 @@ require 'pg'
 require 'common/davical_plugin'
 require 'rm/rm_plugin'
 
+# Handle moving (renaming) DAViCal users in its database. DAViCal has
+# no concept of domains.
+#
 class DavicalMv
-  #
-  # DAViCal only supports Postgres, so even if we ever are
-  # database-agnostic, this plugin can't be.
-  #
   include DavicalPlugin
   include MvPlugin
 
 
+  # Move the user *src* to *dst* within the DAViCal database. This
+  # should "rename" him in _every_ table where he is referenced.
+  # DAViCal uses foreign keys properly, so we let the ON UPDATE
+  # CASCADE trigger handle most of the work.
+  #
+  # 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 DAViCal 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)
-    # Switch the given usernames. DAViCal uses foreign keys properly
-    # and only supports postgres, so we let the ON UPDATE CASCADE
-    # trigger handle most of the work.
-
-    # 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, DAViCal 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 usr SET username = $1 WHERE username = $2']