X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=lib%2Fprune%2Fprune_dummy_runner.rb;h=f90c9d06c50f774eb61e41d3970770cc4b1893d9;hp=64c2606979aad0298cd94b3547d9703da78f21dd;hb=f52761d8c74b146415329f7a8ac004ced0ab4db8;hpb=f819b178c5c1cb8adda0182c610e5c52fad8bea7

diff --git a/lib/prune/prune_dummy_runner.rb b/lib/prune/prune_dummy_runner.rb
index 64c2606..f90c9d0 100644
--- a/lib/prune/prune_dummy_runner.rb
+++ b/lib/prune/prune_dummy_runner.rb
@@ -2,14 +2,33 @@ require 'common/runner'
 require 'prune/plugins/postfixadmin'
 require 'rm/rm_dummy_runner'
 
+# Dummy implementation of a {PruneRunner}. Its <tt>run()</tt> method will
+# tell you what would have been pruned, but will not actually perform
+# the operation.
+#
 class PruneDummyRunner
   include Runner
 
-  def run(plugin)
+
+  # Pretend to prune unused domains and users. Some "what if"
+  # information will be output to stdout.
+  #
+  # The prune mode is the main application of the "dummy" runners,
+  # since it performs some computation outside of the plugins
+  # themselves. This lets the user know which users and domains would
+  # be removed and can help prevent mistakes or even find bugs in the
+  # prune code, if it looks like something will be removed that
+  # shouldn't be!
+  #
+  # @param cfg [Configuration] the configuration options to pass to
+  #   the *plugin* we're runnning.
+  #
+  # @param plugin [Class] plugin class that will do 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()
@@ -19,7 +38,7 @@ class PruneDummyRunner
     leftovers += plugin.get_leftover_domains(db_domains)
 
     rm_dummy_runner = RmDummyRunner.new()
-    rm_dummy_runner.run(plugin, *leftovers)
+    rm_dummy_runner.run(cfg, plugin, *leftovers)
   end
 
 end