+# Methods inherited by the various runner classes ({PruneRunner},
+# {MvRunner}, {RmRunner}).
+#
module Runner
- def run(cfg, plugin, targets)
+
+ # The main thing a runner does is <tt>run()</tt>. Each runner will
+ # actually take a different number of arguments, so their
+ # <tt>run()</tt> signatures will differ. This stub is only here to
+ # let you know that it needs to be implemented.
+ #
+ # @param args [Array<Object>] whatever arguments the real implementation
+ # would take.
+ #
+ def run(*args)
raise NotImplementedError
end
+
+ # Report a message from the given *plugin*. All this does is prefix
+ # the message with the plugin name and then print it to stdout.
+ #
+ # @param plugin [Object] t plugin object that generated the message
+ # we're reporting.
+ #
+ # @param msg [String] the message to report.
+ #
def report(plugin, msg)
print "#{plugin.class.to_s()} - "
puts msg