X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=lib%2Frm%2Frm_dummy_runner.rb;h=2b1f14d66af40e91514aad00fb21a0f6d87596d2;hb=ef77e919fa61bb5ba7924d49a171dc3a05410a33;hp=62d9b628dd7db4b69c27a0804acae27e73325385;hpb=a731b98f97194b8882c42d3c2b27de75f60d6b05;p=mailshears.git
diff --git a/lib/rm/rm_dummy_runner.rb b/lib/rm/rm_dummy_runner.rb
index 62d9b62..2b1f14d 100644
--- a/lib/rm/rm_dummy_runner.rb
+++ b/lib/rm/rm_dummy_runner.rb
@@ -1,19 +1,34 @@
require 'common/runner'
+# Dummy implementation of a {RmRunner}. Its run() method will
+# tell you what would have been removed, but will not actually perform
+# the operation.
+#
class RmDummyRunner
include Runner
+
+ # Pretend to remove *targets*. Some "what if"
+ # information will be output to stdout.
+ #
+ # This dummy runner is not particularly useful on its own. About the
+ # only thing it does is let you know that the users/domains in
+ # *targets* do in fact exist (through their descriptions). It's used
+ # to good effect by {PruneDummyRunner}, though.
+ #
+ # @param cfg [Configuration] the configuration options to pass to
+ # the *plugin* we're runnning.
+ #
+ # @param plugin [RmPlugin] plugin that will perform the move.
+ #
+ # @param targets [Array] the users and domains to be
+ # removed.
+ #
def run(cfg, plugin, *targets)
targets.each do |target|
target_description = plugin.describe(target)
- msg = "Would remove #{target.class.to_s().downcase()} #{target}"
-
- # Only append the extra description if it's useful.
- if not target_description.nil? and
- not target_description.empty? and
- not target_description == target.to_s() then
- msg += " (#{target_description})"
- end
+ msg = "Would remove #{target.class.to_s().downcase()} "
+ msg += add_description(target, target_description)
msg += '.'
report(plugin, msg)