class Net::SSH::Multi::ServerList

  1. lib/net/ssh/multi/server_list.rb
Parent: Multi

Encapsulates a list of server objects, both dynamic (Net::SSH::Multi::DynamicServer) and static (Net::SSH::Multi::Server). It attempts to make it transparent whether a dynamic server set has been evaluated or not. Note that a ServerList is NOT an Array, though it is Enumerable.

Methods

Public Class

  1. new

Public Instance

  1. add
  2. concat
  3. each
  4. flatten
  5. select

Included modules

  1. Enumerable

Public Instance Aliases

to_ary -> flatten

Public Class methods

new (list=[])

Create a new ServerList that wraps the given server list. Duplicate entries will be discarded.

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 15
def initialize(list=[])
  @list = list.uniq
end

Public Instance methods

add (server)

Adds the given server to the list, and returns the argument. If an identical server definition already exists in the collection, the argument is not added, and the existing server record is returned instead.

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 23
def add(server)
  index = @list.index(server)
  if index
    server = @list[index]
  else
    @list.push(server)
  end
  server
end
concat (servers)

Adds an array (or otherwise Enumerable list) of servers to this list, by calling add for each argument. Returns self.

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 35
def concat(servers)
  servers.each { |server| add(server) }
  self
end
each ()

Iterates over each distinct server record in the collection. This will correctly iterate over server records instantiated by a DynamicServer as well, but only if the dynamic server has been "evaluated" (see Net::SSH::Multi::DynamicServer#evaluate!).

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 44
def each
  @list.each do |server|
    case server
    when Server then yield server
    when DynamicServer then server.each { |item| yield item }
    else raise ArgumentError, "server list contains non-server: #{server.class}"
    end
  end
  self
end
flatten ()

Returns an array of all servers in the list, with dynamic server records expanded. The result is an array of distinct server records (duplicates are removed from the result).

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 65
def flatten
  result = @list.inject([]) do |aggregator, server|
    case server
    when Server then aggregator.push(server)
    when DynamicServer then aggregator.concat(server)
    else raise ArgumentError, "server list contains non-server: #{server.class}"
    end
  end

  result.uniq
end
select ()

Works exactly as Enumerable#select, but returns the result as a new ServerList instance.

[show source] 
# File lib/net/ssh/multi/server_list.rb, line 57
def select
  subset = @list.select { |i| yield i }
  ServerList.new(subset)
end