Module: LegacyFacter

Includes:
Comparable, Enumerable
Defined in:
lib/facter/custom_facts/util/config.rb,
lib/facter/custom_facts/util/loader.rb,
lib/facter/custom_facts/util/parser.rb,
lib/facter/custom_facts/util/values.rb,
lib/facter/custom_facts/util/confine.rb,
lib/facter/custom_facts/core/suitable.rb,
lib/facter/custom_facts/util/unix_root.rb,
lib/facter/custom_facts/core/resolvable.rb,
lib/facter/custom_facts/util/collection.rb,
lib/facter/custom_facts/util/windows_root.rb,
lib/facter/custom_facts/core/legacy_facter.rb,
lib/facter/custom_facts/util/normalization.rb,
lib/facter/custom_facts/core/directed_graph.rb,
lib/facter/custom_facts/util/nothing_loader.rb,
lib/facter/custom_facts/util/composite_loader.rb,
lib/facter/custom_facts/util/directory_loader.rb

Overview

A composite loader that allows for more than one default directory loader

Defined Under Namespace

Modules: Core, Util

Class Method Summary collapse

Class Method Details

.[](name) ⇒ Facter::Util::Fact?

Returns a fact object by name. If you use this, you still have to call ‘value` on it to retrieve the actual value.

Parameters:

  • name (String) —

    the name of the fact

Returns:



77
78
79
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 77

def self.[](name)
  collection.fact(name)
end

.add(name, options = {}, { || ... }) ⇒ Facter::Util::Fact

Adds 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.

Parameters:

  • name (String) —

    the fact name

  • options (Hash) (defaults to: {}) —

    optional parameters for the fact - attributes of Facter::Util::Fact and Facter::Util::Resolution can be supplied here

  • block (Proc) —

    a block defining a fact resolution

Options Hash (options):

  • :timeout (Integer) —

    set the timeout for this resolution

Returns:

  • (Facter::Util::Fact) —

    the fact object, which includes any previously defined resolutions



156
157
158
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 156

def self.add(name, options = {}, &block)
  collection.add(name, options, &block)
end

.clear ⇒ void

This method returns an undefined value.

Clears all cached values and removes all facts from memory.



182
183
184
185
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 182

def self.clear
  LegacyFacter.flush
  LegacyFacter.reset
end

.collection ⇒ LegacyFacter::Util::Collection

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Accessor for the collection object which holds all the facts

Returns:



47
48
49
50
51
52
53
54
55
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 47

def self.collection
  unless defined?(@collection) && @collection
    @collection = LegacyFacter::Util::Collection.new(
      LegacyFacter::Util::Loader.new,
      LegacyFacter::Util::Config.ext_fact_loader
    )
  end
  @collection
end

.define_fact(name, options = {}, &block) ⇒ Facter::Util::Fact

Define a new fact or extend an existing fact.

Parameters:

  • name (Symbol) —

    The name of the fact to define

  • options (Hash) (defaults to: {}) —

    A hash of options to set on the fact

Returns:

See Also:

  • {Facter{Facter::Util{Facter::Util::Collection{Facter::Util::Collection#define_fact}


135
136
137
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 135

def self.define_fact(name, options = {}, &block)
  collection.define_fact(name, options, &block)
end

.each {|name, value| ... } ⇒ void

This method returns an undefined value.

Iterates over fact names and values

Yield Parameters:

  • name (String) —

    the fact name

  • value (String) —

    the current value of the fact



168
169
170
171
172
173
174
175
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 168

def self.each
  # Make sure all facts are loaded.
  collection.load_all

  collection.each do |*args|
    yield(*args)
  end
end

.fact(name) ⇒ Facter::Util::Fact?

Returns a fact object by name. If you use this, you still have to call ‘value` on it to retrieve the actual value.

Parameters:

  • name (String) —

    the name of the fact

Returns:



82
83
84
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 82

def self.fact(name)
  collection.fact(name)
end

.flush ⇒ void

This method returns an undefined value.

Flushes cached values for all facts. This does not cause code to be reloaded; it only clears the cached results.



92
93
94
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 92

def self.flush
  collection.flush
end

.json? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns whether the JSON “feature” is available.

Returns:

  • (Boolean) 


60
61
62
63
64
65
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 60

def self.json?
  require 'json'
  true
rescue LoadError
  false
end

.list ⇒ Array<String>

Lists all fact names

Returns:

  • (Array<String>) —

    array of fact names



101
102
103
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 101

def self.list
  collection.list
end

.loadfacts ⇒ void

This method returns an undefined value.

Loads all facts.



202
203
204
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 202

def self.loadfacts
  collection.load_all
end

.reset ⇒ void

This method returns an undefined value.

Removes all facts from memory. Use this when the fact code has changed on disk and needs to be reloaded.



193
194
195
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 193

def self.reset
  @collection = nil
end

.to_hash ⇒ Hash{String => Object}

Gets a hash mapping fact names to their values

Returns:

  • (Hash{String => Object}) —

    the hash of fact names and values



121
122
123
124
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 121

def self.to_hash
  collection.load_all
  collection.to_hash
end

.value(name) ⇒ Object?

Gets the value for a fact. Returns ‘nil` if no such fact exists.

Parameters:

  • name (String) —

    the fact name

Returns:

  • (Object, nil) —

    the value of the fact, or nil if no fact is found



112
113
114
 
# File 'lib/facter/custom_facts/core/legacy_facter.rb', line 112

def self.value(name)
  collection.value(name)
end