Rye::Set

Methods

Public Class

Public Instance

[]
add_box
add_keys
boxes
cd
empty?
inspect
keys
method_missing
name
opts
parallel
remove_keys
root?
run
setenv
to_s
user

Public Instance Aliases

add_boxes	->	add_box
add_key	->	add_keys
remove_key	->	remove_keys
setenvironment_variable	->	setenv

Attributes

boxes	[R]
name	[R]
opts	[R]
parallel	[RW]	Run commands in parallel? A Boolean value. Default: false.

Public Class methods

new (name='default', opts={})

name The name of the set of machines
opts a hash of optional arguments

The opts hash is used as defaults for all for all Rye::Box objects. All args supported by Rye::Box are available here with the addition of:

:parallel => run the commands in parallel? true or false (default).

[show source]

# File lib/rye/set.rb, line 25
def initialize(name='default', opts={})
  @name = name
  @boxes = []

  # These opts are use by Rye::Box and also passed to Net::SSH
  @opts = {
    :parallel => false,
    :user => Rye.sysinfo.user,
    :safe => true,
    :port => 22,
    :keys => [],
    :password => nil,
    :proxy => nil,
    :debug => nil,
    :error => STDERR,
  }.merge(opts)

  @parallel = @opts.delete(:parallel) # Rye::Box doesn't have :parallel

  @safe = @opts[:safe]
  @debug = @opts[:debug]
  @error = @opts[:error]

  @opts[:keys] = [@opts[:keys]].flatten.compact

  add_keys(@opts[:keys])
end

Public Instance methods

[] (key=nil)

See Rye::Box.[]

[show source]

# File lib/rye/set.rb, line 120
def [](key=nil)
  run_command(:cd, key)
  self
end

add_box (*boxes)

boxes one or more boxes. Rye::Box objects will be added directly

to the set. Hostnames will be used to create new instances of Rye::Box and those will be added to the list.

[show source]

# File lib/rye/set.rb, line 60
def add_box(*boxes)
  boxes = boxes.flatten.compact
  @boxes += boxes.collect do |box|
    box = Rye::Box.new(box, @opts) if box.is_a?(String)
    box.add_keys(@keys)
    box
  end
  self
end

add_keys (*additional_keys)

Add one or more private keys to each box. Also stores key paths in the set so when new boxes are added they will get the same keys,

additional_keys is a list of file paths to private keys

Returns the instance of Rye::Set

[show source]

# File lib/rye/set.rb, line 75
def add_keys(*additional_keys)
  additional_keys = additional_keys.flatten.compact
  @opts[:keys] ||= []
  @opts[:keys] += additional_keys
  @opts[:keys].uniq!
  @boxes.each do |box|
    box.add_keys *additional_keys
  end
  self
end

cd (key=nil)

alias :cd :'[]' # fix for jruby

[show source]

# File lib/rye/set.rb, line 125
def cd(key=nil)
  run_command(:cd, key)
  self
end

empty? ()

Are there any boxes in this set?

[show source]

# File lib/rye/set.rb, line 131
def empty?
  @boxes.nil? || @boxes.empty?
end

inspect ()

[show source]

# File lib/rye/set.rb, line 114
def inspect
  a = [self.class.to_s, @name, @parallel, @opts.inspect, @boxes.inspect]
  %{#<%s:%s parallel=%s opts=%s boxes=%s>} % a
end

keys ()

See Rye.keys

[show source]

# File lib/rye/set.rb, line 106
def keys
  Rye.keys
end

method_missing (meth, *args, &block)

Catches calls to Rye::Box commands. If meth is the name of an instance method defined in Rye::Cmd then we call it against all the boxes in +@boxes+. Otherwise this method raises a Rye::CommandNotFound exception. It will also raise a Rye::NoBoxes exception if this set has no boxes defined.

Returns a Rye::Rap object containing the responses from each Rye::Box.

[show source]

# File lib/rye/set.rb, line 142
def method_missing(meth, *args, &block)
  # Ruby 1.8 populates Module.instance_methods with Strings. 1.9 uses Symbols.
  meth = (Rye.sysinfo.ruby[1] == 8) ? meth.to_s : meth.to_sym
  raise Rye::NoBoxes if @boxes.empty?
  if @safe
    raise Rye::CommandNotFound, meth.to_s unless Rye::Box.instance_methods.member?(meth)
  end
  run_command(meth, *args, &block)
end

remove_keys (*keys)

[show source]

# File lib/rye/set.rb, line 87
def remove_keys(*keys)
  @opts[:keys] ||= []
  @opts[:keys] -= keys.flatten.compact
  @boxes.each do |box|
    box.remove_keys keys.flatten.compact
  end
  self
end

root? ()

[show source]

# File lib/rye/set.rb, line 55
def root?; user.to_s == "root" end

run (cmd)

[show source]

# File lib/rye/dsl.rb, line 5
def run cmd
  instance_eval &@@command[cmd]
end

setenv (n, v)

Add an environment variable. n and v are the name and value. Returns the instance of Rye::Set

[show source]

# File lib/rye/set.rb, line 99
def setenv(n, v)
  run_command(:setenv, n, v)
  self
end

to_s ()

[show source]

# File lib/rye/set.rb, line 110
def to_s
  "%s:%s" % [self.class.to_s, @name]
end

user ()

[show source]

# File lib/rye/set.rb, line 54
def user; (@opts || {})[:user]; end