Class: Puppet::Pops::Adapters::LoaderAdapter Private

Inherits:
Puppet::Pops::Adaptable::Adapter show all
Defined in:
lib/puppet/pops/adapters.rb

Overview

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

A LoaderAdapter adapts an object with a Loader. This is used to make further loading from the perspective of the adapted object take place in the perspective of this Loader.

It is typically enough to adapt the root of a model as a search is made towards the root of the model until a loader is found, but there is no harm in duplicating this information provided a contained object is adapted with the correct loader.

See Also:

  • Utils#find_adapter

Defined Under Namespace

Classes: PathsAndNameCacheAdapter

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Puppet::Pops::Adaptable::Adapter

adapt, adapt_new, associate_adapter, clear, create_adapter, get, instance_var_name, self_attr_name, type_name

Instance Attribute Details

#loader_name ⇒ Object

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. 



78
79
80
 
# File 'lib/puppet/pops/adapters.rb', line 78

def loader_name
  @loader_name
end

Class Method Details

.find_module_for_dir(environment, paths, dir) ⇒ Object

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. 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/puppet/pops/adapters.rb', line 139

def self.find_module_for_dir(environment, paths, dir)
  return nil if dir.nil?

  file_path = Pathname.new(dir)
  paths.each do |path|
    begin
      relative_path = file_path.relative_path_from(path).to_s.split(File::SEPARATOR)
    rescue ArgumentError
      # file_path was not relative to the module_path. That's OK.
      next
    end
    if relative_path.length > 1
      mod = environment.module(relative_path[0])
      return mod unless mod.nil?
    end
  end
  nil
end

.loader_for_model_object(model, file = nil, default_loader = nil) ⇒ Loader

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.

Finds the loader to use when loading originates from the source position of the given argument.

Parameters:

  • instance (Model::PopsObject) —

    The model object

  • file (String) (defaults to: nil) —

    the file from where the model was parsed

  • default_loader (Loader) (defaults to: nil) —

    the loader to return if no loader is found for the model

Returns:

  • (Loader) —

    the found loader or default_loader if it could not be found



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/puppet/pops/adapters.rb', line 87

def self.loader_for_model_object(model, file = nil, default_loader = nil)
  loaders = Puppet.lookup(:loaders) { nil }
  if loaders.nil?
    default_loader || Loaders.static_loader
  else
    loader_name = loader_name_by_source(loaders.environment, model, file)
    if loader_name.nil?
      default_loader || loaders[Loader::ENVIRONMENT_PRIVATE]
    else
      loaders[loader_name]
    end
  end
end

.loader_name_by_source(environment, instance, file) ⇒ String

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.

Attempts to find the module that ‘instance` originates from by looking at it’s SourcePosAdapter and compare the ‘locator.file` found there with the module paths given in the environment found in the given `scope`. If the file is found to be relative to a path, then the first segment of the relative path is interpreted as the name of a module. The object that the SourcePosAdapter is adapted to will then be adapted to the private loader for that module and that adapter is returned.

The method returns ‘nil` when no module could be found.

Parameters:

Returns:

  • (String) —

    the name of the loader associated with the source



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/puppet/pops/adapters.rb', line 125

def self.loader_name_by_source(environment, instance, file)
  file = instance.file if file.nil?
  return nil if file.nil? || EMPTY_STRING == file

  pn_adapter = PathsAndNameCacheAdapter.adapt(environment)
  dir = File.dirname(file)
  pn_adapter.cache.fetch(dir) do |key|
    mod = find_module_for_dir(environment, pn_adapter.paths, dir)
    loader_name = mod.nil? ? nil : "#{mod.name} private"
    pn_adapter.cache[key] = loader_name
  end
end