123456789_123456789_123456789_123456789_123456789_

Class: Rake::TaskArguments

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Enumerable
Inherits: Object
Defined in: lib/rake/task_arguments.rb

Overview

TaskArguments manage the arguments passed to a task.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(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.

[ GitHub ] 

  


# File 'lib/rake/task_arguments.rb', line 15



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)  
  



  

    

Returns the value of the given argument via method_missing


  



  [ GitHub ]


  

  


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



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


  







Instance Attribute Details



  

    #names   (readonly)
  



  

    

Argument names


  



  [ GitHub ]


  

  


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



attr_reader :names


  







Instance Method Details



  

    #[](index)  
  



  

    

Find an argument value by name or index.


  



  [ GitHub ]


  

  


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



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


  








  

    #each(&block)  
  



  

    

Enumerates the arguments and their values


  



  [ GitHub ]


  

  


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



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


  








  

    #extras  
  



  

    

Retrieve the list of values not associated with named arguments


  



  [ GitHub ]


  

  


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



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


  








  

    #fetch(*args, &block)  
  

  [ GitHub ]


  

  


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



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


  





  


  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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

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


  








  

    #key?(key)  
  



  

    

Alias for #has_key?.


  



  [ GitHub ]


  

  


# File 'lib/rake/task_arguments.rb', line 91



alias key? has_key?


  








  

    #lookup(name)   (protected)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rake/task_arguments.rb', line 99



def lookup(name) # :nodoc:
  if @hash.has_key?(name)
    @hash[name]
  elsif @parent
    @parent.lookup(name)
  end
end


  








  

    #new_scope(names)  
  



  

    

Create a new argument scope using the prerequisite argument names.


  



  [ GitHub ]


  

  


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



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


  








  

    #to_a  
  



  

    

Retrieve the complete array of sequential values


  



  [ GitHub ]


  

  


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



def to_a
  @values.dup
end


  








  

    #to_hash  
  



  

    

Returns a Hash of arguments and their values


  



  [ GitHub ]


  

  


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



def to_hash
  @hash.dup
end


  








  

    #to_s  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def to_s # :nodoc:
  inspect
end


  








  

    #values_at(*keys)  
  



  

    

Extracts the argument values at keys


  



  [ GitHub ]


  

  


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



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


  








  

    #with_defaults(defaults)  
  



  

    

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


  



  [ GitHub ]


  

  


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



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