class Guard::Reek
Guard::Reek
class, it implements an guard for reek task
Attributes
Public Class Methods
Initializes a Guard
plugin. Don't do any work here, especially as Guard
plugins get initialized even if they are not in an active group!
@param [Hash] options the custom Guard
plugin options @option options [Array<Guard::Watcher>] watchers the Guard
plugin file watchers @option options [Symbol] group the group this Guard
plugin belongs to @option options [Boolean] any_return allow any object to be returned from a watcher
# File lib/guard/reek.rb, line 17 def initialize(options = {}) super @options = { all_on_start: true, run_all: true }.merge(options) @runner = @options[:runner] || Runner.new(options) @ui = @options[:ui] || UI end
Public Instance Methods
Called when just `enter` is pressed This method should be principally used for long action like running all specs/tests/…
@raise [:task_has_failed] when run_all
has failed @return [Object] the task result
# File lib/guard/reek.rb, line 59 def run_all if options[:run_all] ui.info('Guard::Reek is running on all files') runner.run else ui.info('Guard::Reek is not allowed to run on all files') end rescue throw :task_has_failed end
Called on file(s) additions that the Guard
plugin watches.
@param [Array<String>] paths the changes files or paths @raise [:task_has_failed] when run_on_additions
has failed @return [Object] the task result
# File lib/guard/reek.rb, line 76 def run_on_additions(paths) runner.run paths rescue throw :task_has_failed end
Called on file(s) modifications that the Guard
plugin watches.
@param [Array<String>] paths the changes files or paths @raise [:task_has_failed] when run_on_modifications
has failed @return [Object] the task result
# File lib/guard/reek.rb, line 88 def run_on_modifications(paths) runner.run paths rescue throw :task_has_failed end
Called once when Guard
starts. Please override initialize method to init stuff.
@raise [:task_has_failed] when start has failed @return [Object] the task result
# File lib/guard/reek.rb, line 30 def start runner.run if options[:all_on_start] rescue throw :task_has_failed end