Parent

Included Modules

Class/Module Index [+]

Quicksearch

Facter::Util::Collection

Manage which facts exist and how we access them. Largely just a wrapper around a hash of facts.

@api private

Public Class Methods

new(internal_loader, external_loader) click to toggle source
# File lib/facter/util/collection.rb, line 11
def initialize(internal_loader, external_loader)
  @facts = Hash.new
  @internal_loader = internal_loader
  @external_loader = external_loader
end

Public Instance Methods

[](name) click to toggle source

Return a fact object by name.

# File lib/facter/util/collection.rb, line 18
def [](name)
  value(name)
end
add(name, options = {}, &block) click to toggle source

Add a resolution mechanism for a named fact. This does not distinguish between adding a new fact and adding a new way to resolve a fact.

@param name [Symbol] The name of the fact to define @param options [Hash] A hash of options to set on the fact and resolution

@return [Facter::Util::Fact] The fact that was defined

# File lib/facter/util/collection.rb, line 47
def add(name, options = {}, &block)
  fact = create_or_return_fact(name, options)

  fact.add(options, &block)

  return fact
end
define_fact(name, options = {}, &block) click to toggle source

Define a new fact or extend an existing fact.

@param name [Symbol] The name of the fact to define @param options [Hash] A hash of options to set on the fact

@return [Facter::Util::Fact] The fact that was defined

# File lib/facter/util/collection.rb, line 28
def define_fact(name, options = {}, &block)
  fact = create_or_return_fact(name, options)

  if block_given?
    fact.instance_eval(&block)
  end

  fact
rescue => e
  Facter.log_exception(e, "Unable to add fact #{name}: #{e}")
end
each() click to toggle source

Iterate across all of the facts.

# File lib/facter/util/collection.rb, line 58
def each
  load_all
  @facts.each do |name, fact|
    value = fact.value
    unless value.nil?
      yield name.to_s, value
    end
  end
end
external_loader() click to toggle source
# File lib/facter/util/collection.rb, line 112
def external_loader
  @external_loader
end
fact(name) click to toggle source

Return a fact by name.

# File lib/facter/util/collection.rb, line 69
def fact(name)
  name = canonicalize(name)

  # Try to load the fact if necessary
  load(name) unless @facts[name]

  # Try HARDER
  internal_loader.load_all unless @facts[name]

  if @facts.empty?
    Facter.warnonce("No facts loaded from #{internal_loader.search_path.join(File::PATH_SEPARATOR)}")
  end

  @facts[name]
end
flush() click to toggle source

Flush all cached values.

# File lib/facter/util/collection.rb, line 86
def flush
  @facts.each { |name, fact| fact.flush }
  @external_facts_loaded = nil
end
internal_loader() click to toggle source
# File lib/facter/util/collection.rb, line 108
def internal_loader
  @internal_loader
end
list() click to toggle source

Return a list of all of the facts.

# File lib/facter/util/collection.rb, line 92
def list
  load_all
  return @facts.keys
end
load(name) click to toggle source
# File lib/facter/util/collection.rb, line 97
def load(name)
  internal_loader.load(name)
  load_external_facts
end
load_all() click to toggle source

Load all known facts.

# File lib/facter/util/collection.rb, line 103
def load_all
  internal_loader.load_all
  load_external_facts
end
to_hash() click to toggle source

Return a hash of all of our facts.

# File lib/facter/util/collection.rb, line 117
def to_hash
  @facts.inject({}) do |h, ary|
    value = ary[1].value
    if ! value.nil?
      # For backwards compatibility, convert the fact name to a string.
      h[ary[0].to_s] = value
    end
    h
  end
end
value(name) click to toggle source
# File lib/facter/util/collection.rb, line 128
def value(name)
  if fact = fact(name)
    fact.value
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.