Class: Escort::Setup::Dsl::Global

Inherits:
Object
  • Object
show all
Defined in:
lib/escort/setup/dsl/global.rb

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ Global

Returns a new instance of Global.



5
6
7
8
9
10
 
# File 'lib/escort/setup/dsl/global.rb', line 5

def initialize(&block)
  reset
  block.call(self)
rescue => e
  raise Escort::ClientError.new("Problem with syntax of global configuration", e)
end

Instance Method Details

#action(&block) ⇒ Object 



16
17
18
 
# File 'lib/escort/setup/dsl/global.rb', line 16

def action(&block)
  Action.action(:global, @action, &block)
end

#command(name, options = {}, &block) ⇒ Object 



20
21
22
23
24
25
26
27
 
# File 'lib/escort/setup/dsl/global.rb', line 20

def command(name, options = {}, &block)
  options[:requires_arguments] = @requires_arguments
  command = Command.new(name.to_sym, options, &block)
  aliases = [options[:aliases] || []].flatten + [name]
  aliases.each do |name|
    @commands[name.to_sym] = command
  end
end

#config_file(name, options = {}) ⇒ Object 



37
38
39
 
# File 'lib/escort/setup/dsl/global.rb', line 37

def config_file(name, options = {})
  @config_file = ConfigFile.new(name, options)
end

#conflicting_options(*command_names) ⇒ Object

Raises:



53
54
55
 
# File 'lib/escort/setup/dsl/global.rb', line 53

def conflicting_options(*command_names)
  raise Escort::ClientError.new("This interface for specifying conflicting options is no longer supported, please use 'opts.conflict' in the options block")
end

#description(description) ⇒ Object 



49
50
51
 
# File 'lib/escort/setup/dsl/global.rb', line 49

def description(description)
  @description = description
end

#options(&block) ⇒ Object 



12
13
14
 
# File 'lib/escort/setup/dsl/global.rb', line 12

def options(&block)
  Options.options(:global, @options, &block)
end

#requires_arguments(boolean = true) ⇒ Object

Raises:



29
30
31
32
33
34
35
 
# File 'lib/escort/setup/dsl/global.rb', line 29

def requires_arguments(boolean = true)
  raise Escort::ClientError.new("Parameter to 'requires_arguments' must be a boolean") unless [true, false].include?(boolean)
  @requires_arguments = boolean
  @commands.each do |command|
    command.requires_arguments(boolean)
  end
end

#summary(summary) ⇒ Object 



45
46
47
 
# File 'lib/escort/setup/dsl/global.rb', line 45

def summary(summary)
  @summary = summary
end

#version(version) ⇒ Object 



41
42
43
 
# File 'lib/escort/setup/dsl/global.rb', line 41

def version(version)
  @version = version
end