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
23
 
# 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|
    next if values[i].nil? || values[i] == ""
    @hash[name.to_sym] = values[i]
  }
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



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

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.



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

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

#each(&block) ⇒ Object

Enumerates the arguments and their values



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

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

#extras ⇒ Object

Retrieve the list of values not associated with named arguments



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

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

#fetch(*args, &block) ⇒ Object 



92
93
94
 
# File 'lib/rake/task_arguments.rb', line 92

def fetch(*args, &block)
  @hash.fetch(*args, &block)
end

#has_key?(key) ⇒ Boolean Also known as: key?

Returns true if key is one of the arguments

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/rake/task_arguments.rb', line 87

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

#inspect ⇒ Object

:nodoc:



78
79
80
81
82
83
84
 
# File 'lib/rake/task_arguments.rb', line 78

def inspect # :nodoc:
  inspection = @hash.map do |k,v|
    "#{k.to_s}: #{v.to_s}"
  end.join(", ")

  "#<#{self.class} #{inspection}>"
end

#new_scope(names) ⇒ Object

Create a new argument scope using the prerequisite argument names.



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

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



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

def to_a
  @values.dup
end

#to_hash ⇒ Object

Returns a Hash of arguments and their values



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

def to_hash
  @hash.dup
end

#to_s ⇒ Object

:nodoc:



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

def to_s # :nodoc:
  inspect
end

#values_at(*keys) ⇒ Object

Extracts the argument values at keys



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

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.



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

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