Class: Rake::TaskArguments

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/rake/task_arguments.rb

Overview

TaskArguments manage the arguments passed to a task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(names, values, parent = nil) ⇒ TaskArguments

Create a TaskArgument object with a list of argument names and a set of associated values. parent is the parent argument object.



14
15
16
17
18
19
20
21
22
 
# File 'lib/rake/task_arguments.rb', line 14

def initialize(names, values, parent=nil)
  @names = names
  @parent = parent
  @hash = {}
  @values = values
  names.each_with_index { |name, i|
    @hash[name.to_sym] = values[i] unless values[i].nil?
  }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ Object

Returns the value of the given argument via method_missing



64
65
66
 
# File 'lib/rake/task_arguments.rb', line 64

def method_missing(sym, *args)
  lookup(sym.to_sym)
end

Instance Attribute Details

#names ⇒ Object (readonly)

Argument names



10
11
12
 
# File 'lib/rake/task_arguments.rb', line 10

def names
  @names
end

Instance Method Details

#[](index) ⇒ Object

Find an argument value by name or index.



42
43
44
 
# File 'lib/rake/task_arguments.rb', line 42

def [](index)
  lookup(index.to_sym)
end

#each(&block) ⇒ Object

Enumerates the arguments and their values



54
55
56
 
# File 'lib/rake/task_arguments.rb', line 54

def each(&block)
  @hash.each(&block)
end

#extras ⇒ Object

Retrieve the list of values not associated with named arguments



30
31
32
 
# File 'lib/rake/task_arguments.rb', line 30

def extras
  @values[@names.length..-1] || []
end

#has_key?(key) ⇒ Boolean

Returns true if key is one of the arguments

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/rake/task_arguments.rb', line 82

def has_key?(key)
  @hash.has_key?(key)
end

#inspect ⇒ Object

:nodoc:



77
78
79
 
# File 'lib/rake/task_arguments.rb', line 77

def inspect # :nodoc:
  to_s
end

#new_scope(names) ⇒ Object

Create a new argument scope using the prerequisite argument names.



36
37
38
39
 
# File 'lib/rake/task_arguments.rb', line 36

def new_scope(names)
  values = names.map { |n| self[n] }
  self.class.new(names, values + extras, self)
end

#to_a ⇒ Object

Retrieve the complete array of sequential values



25
26
27
 
# File 'lib/rake/task_arguments.rb', line 25

def to_a
  @values.dup
end

#to_hash ⇒ Object

Returns a Hash of arguments and their values



69
70
71
 
# File 'lib/rake/task_arguments.rb', line 69

def to_hash
  @hash
end

#to_s ⇒ Object

:nodoc:



73
74
75
 
# File 'lib/rake/task_arguments.rb', line 73

def to_s # :nodoc:
  @hash.inspect
end

#values_at(*keys) ⇒ Object

Extracts the argument values at keys



59
60
61
 
# File 'lib/rake/task_arguments.rb', line 59

def values_at(*keys)
  keys.map { |k| lookup(k) }
end

#with_defaults(defaults) ⇒ Object

Specify a hash of default values for task arguments. Use the defaults only if there is no specific value for the given argument.



49
50
51
 
# File 'lib/rake/task_arguments.rb', line 49

def with_defaults(defaults)
  @hash = defaults.merge(@hash)
end