Update the version in mailshears.gemspec.

[mailshears.git] / lib / prune / prune_runner.rb

diff --git a/lib/prune/prune_runner.rb b/lib/prune/prune_runner.rb
index 8ae8ad218bcbc402e167509dca190ab62cbec5fb..a9e2282857fc3be027a14d0410ae75436c25f934 100644 (file)
--- a/lib/prune/prune_runner.rb
+++ b/lib/prune/prune_runner.rb
@@ -2,14 +2,22 @@ require 'common/runner'
 require 'prune/plugins/postfixadmin'
 require 'rm/rm_runner'
 
+# Perform the pruning of users/domains using {PrunePlugin}s.
+#
 class PruneRunner
   include Runner
 
-  def run(plugin)
+  # Run *plugin* to prune leftover users and directories.
+  #
+  # @param cfg [Configuration] configuration options passed to
+  # {PostfixadminPrune}.
+  #
+  # @param plugin [Class] plugin class that will perform the pruning.
+  #
+  def run(cfg, plugin)
     # We don't want to check the PostfixAdmin database against itself.
     return if plugin.class == PostfixadminPrune
 
-    cfg = Configuration.new()
     pfa = PostfixadminPrune.new(cfg)
 
     db_users = pfa.list_users()
@@ -18,8 +26,9 @@ class PruneRunner
     leftovers  = plugin.get_leftover_users(db_users)
     leftovers += plugin.get_leftover_domains(db_domains)
 
+    # We're counting on our PrunePlugin also being an RmPlugin here.
     rm_runner = RmRunner.new()
-    rm_runner.run(plugin, *leftovers)
+    rm_runner.run(cfg, plugin, *leftovers)
   end
 
 end