X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=lib%2Frm%2Fplugins%2Fdavical.rb;h=852d9c4c66b1fa97467de79c2628a34fd6320338;hp=77b06b4777714a50a7ea18aa15e2116389128b2b;hb=df4e02ebf6a4e28a58abcb298a4442a245ad0b15;hpb=20b843bddcd73833d41f98ff79d92ef59bb4d81e

diff --git a/lib/rm/plugins/davical.rb b/lib/rm/plugins/davical.rb
index 77b06b4..852d9c4 100644
--- a/lib/rm/plugins/davical.rb
+++ b/lib/rm/plugins/davical.rb
@@ -3,19 +3,24 @@ require 'pg'
 require 'common/davical_plugin'
 require 'rm/rm_plugin'
 
+# Handle the removal of DAViCal users from its database. DAViCal has
+# no concept of domains.
+#
 class DavicalRm
-  #
-  # DAViCal only supports Postgres, so even if we ever are
-  # database-agnostic, this plugin can't be.
-  #
+
   include DavicalPlugin
   include RmPlugin
 
 
-  def delete_user(user)
-    # Delete the given username. DAViCal uses foreign keys properly
-    # and only supports postgres, so we let the ON DELETE CASCADE
-    # trigger handle most of the work.
+  # Remove *user* from the DAViCal database. This should remove him
+  # from _every_ table in which he is referenced. Fortunately, DAViCal
+  # uses foreign keys properly (and only supports postgres, where they
+  # work!), so we can let the ON DELETE CASCADE trigger handle most of
+  # the work.
+  #
+  # @param user [User] the user to remove.
+  #
+  def remove_user(user)
     raise NonexistentUserError.new(user.to_s()) if not user_exists(user)
 
     sql_queries = ['DELETE FROM usr WHERE username = $1']