Class: Guard::Rackup

Inherits:
Guard
  • Object
show all
Defined in:
lib/guard/rackup.rb,
lib/guard/rackup/runner.rb,
lib/guard/rackup/version.rb

Defined Under Namespace

Classes: Runner

Constant Summary collapse

VERSION =
"0.0.1"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(watchers = [], options = {}) ⇒ Rackup

Returns a new instance of Rackup.



11
12
13
14
# File 'lib/guard/rackup.rb', line 11

def initialize(watchers = [], options = {})
  super(watchers, options)
  @runner = Runner.new(options)
end

Instance Attribute Details

#runnerObject (readonly)

Returns the value of attribute runner.



9
10
11
# File 'lib/guard/rackup.rb', line 9

def runner
  @runner
end

Instance Method Details

#reloadObject

Called when ‘reload|r|z + enter` is pressed. This method should be mainly used for “reload” (really!) actions like reloading passenger/spork/bundler/…

Returns:

  • (Object)

    the task result

Raises:

  • (:task_has_failed)

    when reload has failed



40
41
42
# File 'lib/guard/rackup.rb', line 40

def reload
  @runner.reload
end

#run_allObject

Called when just ‘enter` is pressed This method should be principally used for long action like running all specs/tests/…

Returns:

  • (Object)

    the task result

Raises:

  • (:task_has_failed)

    when run_all has failed



50
51
52
# File 'lib/guard/rackup.rb', line 50

def run_all
  run_on_changes
end

#run_on_changes(paths = []) ⇒ Object

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

Parameters:

  • paths (Array<String>) (defaults to: [])

    the changes files or paths

Returns:

  • (Object)

    the task result

Raises:

  • (:task_has_failed)

    when run_on_change has failed



60
61
62
# File 'lib/guard/rackup.rb', line 60

def run_on_changes(paths = [])
  @runner.reload
end

#startObject

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

Returns:

  • (Object)

    the task result

Raises:

  • (:task_has_failed)

    when start has failed



21
22
23
# File 'lib/guard/rackup.rb', line 21

def start
  run_all if options[:all_on_start]
end

#stopObject

Called when ‘stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).

Returns:

  • (Object)

    the task result

Raises:

  • (:task_has_failed)

    when stop has failed



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

def stop
  @runner.stop
end