Class: Warg::HostCollection

Inherits:

Object

• Object
• Warg::HostCollection

Includes:

Enumerable, Interaction

Defined in:

lib/warg.rb

Defined Under Namespace

Modules: Interaction

Class Method Summary

• .from(value) ⇒ Object

Instance Method Summary

• #==(other) ⇒ Object (also: #eql?)
• #add(host_data) ⇒ Object
• #each ⇒ Object
• #initialize ⇒ HostCollection constructor

  A new instance of HostCollection.

• #lazy ⇒ Object
• #length ⇒ Object
• #one ⇒ Object
• #to_a ⇒ Object
• #with(**filters) ⇒ Object

Methods included from Interaction

#create_file_from, #download, #run, #run_command, #run_script, #upload

Constructor Details

#initialize ⇒ HostCollection

Returns a new instance of HostCollection.

# File 'lib/warg.rb', line 1126

def initialize
  @hosts = []
end

Class Method Details

.from(value) ⇒ Object

# File 'lib/warg.rb', line 1085

def self.from(value)
  case value
  when String, Host
    new.add(value)
  when HostCollection
    value
  when Array
    is_array_host_specification = value.any? do |item|
      # Check key=value items by looking for `=` missing `?`.  If it has `?`, then we
      # assume it is in the form `host?key=value`
      String === item and item.index("=") and not item.index("?")
    end

    if is_array_host_specification
      new.add(value)
    else
      value.inject(new) { |collection, host_data| collection.add(host_data) }
    end
  when Hash
    value.inject(new) do |collection, (property, hosts_data)|
      name, value = property.to_s.split(":", 2)

      if value.nil?
        value = name
        name = "stage"
      end

      from(hosts_data).each do |host|
        host[name] = value
        collection.add(host)
      end

      collection
    end
  when nil
    new
  else
    raise InvalidHostDataError.new(value)
  end
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

# File 'lib/warg.rb', line 1148

def ==(other)
  self.class == other.class &&
    length == other.length &&
    # both are the same length and their intersection is the same length (all the same
    # elements in common)
    length == @hosts.&(other.hosts).length
end

#add(host_data) ⇒ Object

# File 'lib/warg.rb', line 1138

def add(host_data)
  @hosts << Host.from(host_data)

  self
end

#each ⇒ Object

# File 'lib/warg.rb', line 1166

def each
  if block_given?
    @hosts.each { |host| yield host }
  else
    enum_for(:each)
  end

  self
end

#lazy ⇒ Object

# File 'lib/warg.rb', line 1162

def lazy
  LazilyFilteredHostCollection.new(self)
end

#length ⇒ Object

# File 'lib/warg.rb', line 1158

def length
  @hosts.length
end

#one ⇒ Object

# File 'lib/warg.rb', line 1130

def one
  if @hosts.empty?
    raise "cannot pick a host from `#{inspect}'; collection is empty"
  end

  HostCollection.from @hosts.sample
end

#to_a ⇒ Object

# File 'lib/warg.rb', line 1216

def to_a
  @hosts.dup
end

#with(**filters) ⇒ Object

# File 'lib/warg.rb', line 1144

def with(**filters)
  HostCollection.from(select { |host| host.matches?(**filters) })
end