Class: Guard::Rubycritic

Inherits:
Plugin
  • Object
show all
Defined in:
lib/guard/rubycritic.rb

Instance Method Summary collapse

Instance Method Details

#critique(paths) ⇒ Object 



30
31
32
33
 
# File 'lib/guard/rubycritic.rb', line 30

def critique(paths)
  @rubycritic.paths = paths
  @rubycritic.critique
end

#report(analysed_modules) ⇒ Object 



35
36
37
 
# File 'lib/guard/rubycritic.rb', line 35

def report(analysed_modules)
  ::Rubycritic::Generator::HtmlGuardReport.new(analysed_modules).generate_report
end

#run_on_changes(paths) ⇒ Object

Default behaviour on file(s) changes that the Guard plugin watches.

Parameters:

  • paths (Array<String>) —

    the changes files or paths

Returns:

  • (Object) —

    the task result

Raises:

  • (:task_has_failed) —

    when run_on_change has failed



25
26
27
28
 
# File 'lib/guard/rubycritic.rb', line 25

def run_on_changes(paths)
  report_location = report(critique(paths))
  UI.info "New critique at #{report_location}"
end

#start ⇒ Object

Called once when Guard starts. Please override initialize method to init stuff.

Returns:

  • (Object) —

    the task result

Raises:

  • (:task_has_failed) —

    when start has failed



14
15
16
17
18
 
# File 'lib/guard/rubycritic.rb', line 14

def start
  @rubycritic = ::Rubycritic.create
  @rubycritic.extend(AdditionalMethodsForGuard)
  UI.info "Guard::Rubycritic is critiquing"
end