Class: Connect::Includer

Inherits:
Object
  • Object
show all
Defined in:
lib/connect/includer.rb

Overview

The Includer class implements the functionality to include other connect config files

Constant Summary collapse

DEFAULT_PATH =

The default path where to find the config files

'/etc/puppet/config/'
DEFAULT_TYPE =

The default file type

'.config'

Instance Method Summary collapse

Constructor Details

#initialize(config_path = DEFAULT_PATH) ⇒ Includer

Returns a new instance of Includer.



11
12
13
14
 
# File 'lib/connect/includer.rb', line 11

def initialize(config_path = DEFAULT_PATH)
  @config_path  = Pathname.new(config_path)
  @included_files = []
end

Instance Method Details

#first_file? ⇒ Bool

Check if the includer has already included files or not

Returns:

  • (Bool) —

    true if we didn’t include any other files yet.



59
60
61
 
# File 'lib/connect/includer.rb', line 59

def first_file?
  @include_file == []
end

#include(name, &proc) {|name, content| ... } ⇒ Object

Check the the name of the inclusion and decide what to do. The result(s) will be yielded to the specfied closure. This routine can handle:

  • absolute file names without wildcards

  • absolute file names with a wildcard

  • relative file names without wildcards

  • relative file names with a wildcard

If a file extention is not givcen, it will use the default_type

Parameters:

  • name (String) —

    the file name.

  • proc (Proc) —

    the closure to be yielded.

Yield Parameters:

  • name (String) —

    The name of the file to be included

  • content (String) —

    The actual content of the file to be included



33
34
35
36
37
38
39
40
41
 
# File 'lib/connect/includer.rb', line 33

def include(name, &proc)
  path = Pathname.new(name)
  path = with_extension(path) if no_extension?(path)
  path = with_folder(path) unless path.absolute?
  files = Dir.glob(path).each do |file|
    include_file(file, &proc)
  end
  fail ArgumentError, "No files found for #{name}" if files.empty?
end

#included?(name) ⇒ Bool

Check if the specfied file is already included or not

Parameters:

  • name (String) —

    the file name to be checked

Returns:

  • (Bool) —

    true when the file is already included



49
50
51
52
 
# File 'lib/connect/includer.rb', line 49

def included?(name)
  full_name = Pathname.new(name).expand_path.to_s
  @included_files.include?(full_name)
end