Module: RightConf::ProgressReporter
- Included in:
- Command, Configurator
- Defined in:
- lib/rconf/progress_reporter.rb
Overview
Provide progress report methods used by configurators
Class Method Summary collapse
-
.included(base) ⇒ Object
Create list of reporters upon inclusion Also setup forwarders.
-
.report_to_file(path) ⇒ Object
Save progress reports to given file.
-
.report_to_stdout ⇒ Object
Print progress reports to stdout, default behavior.
Class Method Details
.included(base) ⇒ Object
Create list of reporters upon inclusion Also setup forwarders
Parameters
- base(Object)
-
Object including this module
22 23 24 25 26 27 28 |
# File 'lib/rconf/progress_reporter.rb', line 22 def self.included(base) @@reporters ||= [] [ :report_section, :report, :report_check, :report_success, :report_failure, :report_fatal, :report_result ].each do |meth| (meth) { |*args| @@reporters.each { |r| r.__send__(meth, *args) } } end end |
.report_to_file(path) ⇒ Object
Save progress reports to given file
Parameters
- path(String)
-
Path to file where progress reports should be saved
Return
- true
-
Always return true
47 48 49 50 51 |
# File 'lib/rconf/progress_reporter.rb', line 47 def self.report_to_file(path) @@reporters ||= [] @@reporters << FileReporter.new(path) true end |
.report_to_stdout ⇒ Object
Print progress reports to stdout, default behavior
Return
- true
-
Always return true
34 35 36 37 38 |
# File 'lib/rconf/progress_reporter.rb', line 34 def self.report_to_stdout @@reporters ||= [] @@reporters << StdoutReporter.new true end |