Parent

Methods

Files

Guard::Group

A group of Guard plugins. There are two reasons why you want to group your Guard plugins:

@example Group that aborts on failure

group :frontend, halt_on_fail: true do
  guard 'coffeescript', input: 'spec/coffeescripts', output: 'spec/javascripts'
  guard 'jasmine-headless-webkit' do
    watch(%r{^spec/javascripts/(.*)\..*}) { |m| newest_js_file("spec/javascripts/#{m[1]}_spec") }
  end
end

@see Guard::CLI

Attributes

name[RW]
options[RW]

Public Class Methods

new(name, options = {}) click to toggle source

Initializes a Group.

@param [String] name the name of the group @param [Hash] options the group options @option options [Boolean] halt_on_fail if a task execution

should be halted for all Guard plugins in this group if a Guard plugin throws `:task_has_failed`
# File lib/guard/group.rb, line 33
def initialize(name, options = {})
  @name    = name.to_sym
  @options = options
end

Public Instance Methods

title() click to toggle source

Returns the group title.

@example Title for a group named ‘backend’

> Guard::Group.new('backend').title
=> "Backend"

@return [String]

# File lib/guard/group.rb, line 46
def title
  @title ||= name.to_s.capitalize
end
to_s() click to toggle source

String representation of the group.

@example String representation of a group named ‘backend’

> Guard::Group.new('backend').to_s
=> "#<Guard::Group @name=backend @options={}>"

@return [String] the string representation

# File lib/guard/group.rb, line 58
def to_s
  "#<#{self.class} @name=#{name} @options=#{options}>"
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.