master/lib/guard/dsl_describer.rb

61 lines
1.3 KiB
Ruby
Raw Normal View History

require 'guard/dsl'
module Guard
2011-09-20 09:49:05 +00:00
# The DslDescriber overrides methods to create an internal structure
# of the Guardfile that is used in some inspection utility methods
# like the CLI commands `show` and `list`.
#
# @see Guard::DSL
# @see Guard::CLI
#
class DslDescriber < Dsl
2011-09-20 09:49:05 +00:00
@@guardfile_structure = [ { :guards => [] } ]
class << self
2011-09-20 09:49:05 +00:00
# Get the Guardfile structure.
#
# @return [Array<Hash>] the structure
#
def guardfile_structure
@@guardfile_structure
end
end
private
2011-09-20 09:49:05 +00:00
# Declares a group of guards.
#
# @param [String] name the group's name called from the CLI
# @yield a block where you can declare several guards
#
# @see Guard::Dsl
#
def group(name)
@@guardfile_structure << { :group => name.to_sym, :guards => [] }
@group = true
2011-09-20 09:49:05 +00:00
yield if block_given?
@group = false
end
2011-09-20 09:49:05 +00:00
# Declare a guard.
#
# @param [String] name the Guard name
# @param [Hash] options the options accepted by the Guard
# @yield a block where you can declare several watch patterns and actions
#
# @see Guard::Dsl
#
def guard(name, options = {})
node = (@group ? @@guardfile_structure.last : @@guardfile_structure.first)
node[:guards] << { :name => name, :options => options }
end
2011-09-20 09:49:05 +00:00
end
end