bolt 0.24.0 → 0.25.0

data/vendored/puppet/lib/puppet/pops/loader/loader_paths.rb

@@ -1,377 +0,0 @@
-
-# LoaderPaths
-# ===
-# The central loader knowledge about paths, what they represent and how to instantiate from them.
-# Contains helpers (*smart paths*) to deal with lazy resolution of paths.
-#
-# TODO: Currently only supports loading of functions (2 kinds)
-#
-module Puppet::Pops
-module Loader
-module LoaderPaths
-
-  # Returns an array of SmartPath, each instantiated with a reference to the given loader (for root path resolution
-  # and existence checks). The smart paths in the array appear in precedence order. The returned array may be
-  # mutated.
-  #
-  def self.relative_paths_for_type(type, loader)
-    result = []
-    case type
-    when :function
-        # Only include support for the loadable items the loader states it can contain
-        if loader.loadables.include?(:func_4x)
-          result << FunctionPath4x.new(loader)
-        end
-        if loader.loadables.include?(:func_4xpp)
-          result << FunctionPathPP.new(loader)
-        end
-        if loader.loadables.include?(:func_3x)
-          result << FunctionPath3x.new(loader)
-        end
-    when :plan
-      result << PlanPathPP.new(loader)
-    when :task
-      result << TaskPath.new(loader) if Puppet[:tasks] && loader.loadables.include?(:task)
-    when :type
-      result << DataTypePath.new(loader) if loader.loadables.include?(:datatype)
-      result << TypePathPP.new(loader) if loader.loadables.include?(:type_pp)
-    when :resource_type_pp
-      result << ResourceTypeImplPP.new(loader) if loader.loadables.include?(:resource_type_pp)
-    else
-      # unknown types, simply produce an empty result; no paths to check, nothing to find... move along...
-      []
-    end
-    result
-  end
-
-#  # DO NOT REMOVE YET. needed later? when there is the need to decamel a classname
-#  def de_camel(fq_name)
-#    fq_name.to_s.gsub(/::/, '/').
-#    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-#    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-#    tr("-", "_").
-#    downcase
-#  end
-
-  class SmartPath
-    # Generic path, in the sense of "if there are any entities of this kind to load, where are they?"
-    attr_reader :generic_path
-
-    # Creates SmartPath for the given loader (loader knows how to check for existence etc.)
-    def initialize(loader)
-      @loader = loader
-    end
-
-    def generic_path
-      return @generic_path unless @generic_path.nil?
-
-      the_root_path = root_path # @loader.path
-      @generic_path = (the_root_path.nil? ? relative_path : File.join(the_root_path, relative_path))
-    end
-
-    def fuzzy_matching?
-      false
-    end
-
-    def root_path
-      @loader.path
-    end
-
-    def lib_root?
-      @loader.lib_root?
-    end
-
-    # Effective path is the generic path + the name part(s) + extension.
-    #
-    def effective_path(typed_name, start_index_in_name)
-      "#{File.join(generic_path, typed_name.name_parts)}#{extension}"
-    end
-
-    def typed_name(type, name_authority, relative_path, module_name)
-      # Module name is assumed to be included in the path and therefore not added here
-      n = ''
-      unless extension.empty?
-        # Remove extension
-        relative_path = relative_path[0..-(extension.length+1)]
-      end
-      relative_path.split('/').each do |segment|
-        n << '::' if n.size > 0
-        n << segment
-      end
-      TypedName.new(type, n, name_authority)
-    end
-
-    def valid_path?(path)
-      path.end_with?(extension) && path.start_with?(generic_path)
-    end
-
-    def valid_name?(typed_name)
-      true
-    end
-
-    def relative_path
-      raise NotImplementedError.new
-    end
-
-    def instantiator
-      raise NotImplementedError.new
-    end
-  end
-
-  class RubySmartPath < SmartPath
-    EXTENSION = '.rb'.freeze
-
-    def extension
-      EXTENSION
-    end
-
-    # Duplication of extension information, but avoids one call
-    def effective_path(typed_name, start_index_in_name)
-      "#{File.join(generic_path, typed_name.name_parts)}.rb"
-    end
-  end
-
-  # A PuppetSmartPath is rooted at the loader's directory one level up from what the loader specifies as it
-  # path (which is a reference to its 'lib' directory.
-  #
-  class PuppetSmartPath < SmartPath
-    EXTENSION = '.pp'.freeze
-
-    def extension
-      EXTENSION
-    end
-
-    # Duplication of extension information, but avoids one call
-    def effective_path(typed_name, start_index_in_name)
-      # Puppet name to path always skips the name-space as that is part of the generic path
-      # i.e. <module>/mymodule/functions/foo.pp is the function mymodule::foo
-      parts = typed_name.name_parts
-      if start_index_in_name > 0
-        return nil if start_index_in_name >= parts.size
-        parts = parts[start_index_in_name..-1]
-      end
-      "#{File.join(generic_path, parts)}#{extension}"
-    end
-
-    def typed_name(type, name_authority, relative_path, module_name)
-      n = ''
-      n << module_name unless module_name.nil?
-      unless extension.empty?
-        # Remove extension
-        relative_path = relative_path[0..-(extension.length+1)]
-      end
-      relative_path.split('/').each do |segment|
-        n << '::' if n.size > 0
-        n << segment
-      end
-      TypedName.new(type, n, name_authority)
-    end
-  end
-
-  class FunctionPath4x < RubySmartPath
-    SYSTEM_FUNCTION_PATH_4X = File.join('puppet', 'functions').freeze
-    FUNCTION_PATH_4X = File.join('lib', SYSTEM_FUNCTION_PATH_4X).freeze
-
-    def relative_path
-      lib_root? ? SYSTEM_FUNCTION_PATH_4X : FUNCTION_PATH_4X
-    end
-
-    def instantiator
-      RubyFunctionInstantiator
-    end
-  end
-
-  class FunctionPath3x < RubySmartPath
-    SYSTEM_FUNCTION_PATH_3X = File.join('puppet', 'parser', 'functions').freeze
-    FUNCTION_PATH_3X = File.join('lib', SYSTEM_FUNCTION_PATH_3X).freeze
-
-    def relative_path
-      lib_root? ? SYSTEM_FUNCTION_PATH_3X : FUNCTION_PATH_3X
-    end
-
-    def instantiator
-      RubyLegacyFunctionInstantiator
-    end
-  end
-
-  class FunctionPathPP < PuppetSmartPath
-    FUNCTION_PATH_PP = 'functions'.freeze
-
-    def relative_path
-      FUNCTION_PATH_PP
-    end
-
-    def instantiator
-      PuppetFunctionInstantiator
-    end
-  end
-
-  class DataTypePath < RubySmartPath
-    SYSTEM_TYPE_PATH = File.join('puppet', 'datatypes').freeze
-    TYPE_PATH = File.join('lib', SYSTEM_TYPE_PATH).freeze
-
-    def relative_path
-      lib_root? ? SYSTEM_TYPE_PATH : TYPE_PATH
-    end
-
-    def instantiator
-      RubyDataTypeInstantiator
-    end
-  end
-
-  class TypePathPP < PuppetSmartPath
-    TYPE_PATH_PP = 'types'.freeze
-
-    def relative_path
-      TYPE_PATH_PP
-    end
-
-    def instantiator
-      TypeDefinitionInstantiator
-    end
-  end
-
-  # TaskPath is like PuppetSmartPath but it does not use an extension and may
-  # match more than one path with one name
-  class TaskPath < PuppetSmartPath
-    TASKS_PATH = 'tasks'.freeze
-    FORBIDDEN_EXTENSIONS = %w{.conf .md}.freeze
-
-    def extension
-      EMPTY_STRING
-    end
-
-    def fuzzy_matching?
-      true
-    end
-
-    def relative_path
-      TASKS_PATH
-    end
-
-    def typed_name(type, name_authority, relative_path, module_name)
-      n = ''
-      n << module_name unless module_name.nil?
-
-      # Remove the file extension, defined as everything after the *last* dot.
-      relative_path = relative_path.sub(%r{\.[^/.]*\z}, '')
-
-      if relative_path == 'init' && !(module_name.nil? || module_name.empty?)
-        TypedName.new(type, module_name, name_authority)
-      else
-        relative_path.split('/').each do |segment|
-          n << '::' if n.size > 0
-          n << segment
-        end
-        TypedName.new(type, n, name_authority)
-      end
-    end
-
-    def instantiator
-      require_relative 'task_instantiator'
-      TaskInstantiator
-    end
-
-    def valid_name?(typed_name)
-      # TODO: Remove when PE has proper namespace handling
-      typed_name.name_parts.size <= 2
-    end
-
-    def valid_path?(path)
-      path.start_with?(generic_path) && is_task_name?(File.basename(path, '.*')) && !FORBIDDEN_EXTENSIONS.any? { |ext| path.end_with?(ext) }
-    end
-
-    def is_task_name?(name)
-      !!(name =~ /^[a-z][a-z0-9_]*$/)
-    end
-  end
-
-  class ResourceTypeImplPP < PuppetSmartPath
-    RESOURCE_TYPES_PATH_PP = '.resource_types'.freeze
-
-    def relative_path
-      RESOURCE_TYPES_PATH_PP
-    end
-
-    def root_path
-      @loader.path
-    end
-
-    def instantiator
-      PuppetResourceTypeImplInstantiator
-    end
-
-    # The effect paths for resource type impl is the full name
-    # since resource types are not name spaced.
-    # This overrides the default PuppetSmartPath.
-    #
-    def effective_path(typed_name, start_index_in_name)
-      # Resource type to name does not skip the name-space
-      # i.e. <module>/mymodule/resource_types/foo.pp is the resource type foo
-      "#{File.join(generic_path, typed_name.name_parts)}.pp"
-    end
-  end
-
-  class PlanPathPP < PuppetSmartPath
-    PLAN_PATH_PP = File.join('plans')
-
-    def relative_path
-      PLAN_PATH_PP
-    end
-
-    def instantiator()
-      Puppet::Pops::Loader::PuppetPlanInstantiator
-    end
-
-    def typed_name(type, name_authority, relative_path, module_name)
-      if relative_path == 'init.pp' && !(module_name.nil? || module_name.empty?)
-        TypedName.new(type, module_name, name_authority)
-      else
-        n = ''
-        n << module_name unless module_name.nil?
-        unless extension.empty?
-          # Remove extension
-          relative_path = relative_path[0..-(extension.length+1)]
-        end
-        relative_path.split('/').each do |segment|
-          n << '::' if n.size > 0
-          n << segment
-        end
-        TypedName.new(type, n, name_authority)
-      end
-    end
-  end
-
-  # SmartPaths
-  # ===
-  # Holds effective SmartPath instances per type
-  #
-  class SmartPaths
-    def initialize(path_based_loader)
-      @loader = path_based_loader
-      @smart_paths = {}
-    end
-
-    # Ensures that the paths for the type have been probed and pruned to what is existing relative to
-    # the given root.
-    #
-    # @param type [Symbol] the entity type to load
-    # @return [Array<SmartPath>] array of effective paths for type (may be empty)
-    #
-    def effective_paths(type)
-      smart_paths = @smart_paths
-      loader = @loader
-      unless effective_paths = smart_paths[type]
-        # type not yet processed, does the various directories for the type exist ?
-        # Get the relative dirs for the type
-        paths_for_type = LoaderPaths.relative_paths_for_type(type, loader)
-        # Check which directories exist in the loader's content/index
-        effective_paths = smart_paths[type] = paths_for_type.select { |sp| loader.meaningful_to_search?(sp) }
-      end
-      effective_paths
-    end
-  end
-end
-end
-end
-

data/vendored/puppet/lib/puppet/pops/loader/module_loaders.rb

@@ -1,549 +0,0 @@
-module Puppet::Pops
-module Loader
-# =ModuleLoaders
-# A ModuleLoader loads items from a single module.
-# The ModuleLoaders (ruby) module contains various such loaders. There is currently one concrete
-# implementation, ModuleLoaders::FileBased that loads content from the file system.
-# Other implementations can be created - if they are based on name to path mapping where the path
-# is relative to a root path, they can derive the base behavior from the ModuleLoaders::AbstractPathBasedModuleLoader class.
-#
-# Examples of such extensions could be a zip/jar/compressed file base loader.
-#
-# Notably, a ModuleLoader does not configure itself - it is given the information it needs (the root, its name etc.)
-# Logic higher up in the loader hierarchy of things makes decisions based on the "shape of modules", and "available
-# modules" to determine which module loader to use for each individual module. (There could be differences in
-# internal layout etc.)
-#
-# A module loader is also not aware of the mapping of name to relative paths.
-#
-# @api private
-#
-module ModuleLoaders
-
-  # Wildcard module name for module loaders, makes loading possible from any namespace.
-  NAMESPACE_WILDCARD = '*'.freeze
-
-  # This is exactly the same as the #system_loader_from method, but the argument for path is changed to
-  # location where pluginsync stores functions. It also accepts definitions in any namespace since pluginsync
-  # places all of them in the same directory.
-  #
-  def self.cached_loader_from(parent_loader, loaders)
-    LibRootedFileBased.new(parent_loader,
-      loaders,
-      NAMESPACE_WILDCARD,
-      Puppet[:libdir],
-      'cached_puppet_lib',
-      [:func_4x, :datatype]
-    )
-  end
-
-  def self.system_loader_from(parent_loader, loaders)
-    # Puppet system may be installed in a fixed location via RPM, installed as a Gem, via source etc.
-    # The only way to find this across the different ways puppet can be installed is
-    # to search up the path from this source file's __FILE__ location until it finds the base of
-    # puppet.
-    #
-    puppet_lib = File.realpath(File.join(File.dirname(__FILE__), '../../..'))
-    LibRootedFileBased.new(parent_loader,
-                                                       loaders,
-                                                       nil,
-                                                       puppet_lib,   # may or may not have a 'lib' above 'puppet'
-                                                       'puppet_system',
-                                                        [:func_4x, :func_3x, :datatype]   # only load ruby functions and types from "puppet"
-                                                       )
-  end
-
-  def self.environment_loader_from(parent_loader, loaders, env_path)
-    if env_path.nil? || env_path.empty?
-      EmptyLoader.new(parent_loader, ENVIRONMENT)
-    else
-      FileBased.new(parent_loader,
-        loaders,
-        ENVIRONMENT,
-        env_path,
-        ENVIRONMENT
-      )
-    end
-  end
-
-  def self.module_loader_from(parent_loader, loaders, module_name, module_path)
-    ModuleLoaders::FileBased.new(parent_loader,
-                                                       loaders,
-                                                       module_name,
-                                                       module_path,
-                                                       module_name
-                                                       )
-  end
-
-  def self.pcore_resource_type_loader_from(parent_loader, loaders, environment_path)
-    ModuleLoaders::FileBased.new(parent_loader,
-      loaders,
-      nil,
-      environment_path,
-      'pcore_resource_types'
-    )
-  end
-
-  class EmptyLoader < BaseLoader
-    def find(typed_name)
-      return nil
-    end
-
-    def private_loader
-      @private_loader ||= self
-    end
-
-    def private_loader=(loader)
-      @private_loader = loader
-    end
-  end
-
-  class AbstractPathBasedModuleLoader < BaseLoader
-
-    # The name of the module, or nil, if this is a global "component", or "any module" if set to the `NAMESPACE_WILDCARD` (*)
-    attr_reader :module_name
-
-
-    # The path to the location of the module/component - semantics determined by subclass
-    attr_reader :path
-
-    # A map of type to smart-paths that help with minimizing the number of paths to scan
-    attr_reader :smart_paths
-
-    # A Module Loader has a private loader, it is lazily obtained on request to provide the visibility
-    # for entities contained in the module. Since a ModuleLoader also represents an environment and it is
-    # created a different way, this loader can be set explicitly by the loaders bootstrap logic.
-    #
-    # @api private
-    attr_accessor :private_loader
-
-    # Initialize a kind of ModuleLoader for one module
-    # @param parent_loader [Loader] loader with higher priority
-    # @param loaders [Loaders] the container for this loader
-    # @param module_name [String] the name of the module (non qualified name), may be nil for a global "component"
-    # @param path [String] the path to the root of the module (semantics defined by subclass)
-    # @param loader_name [String] a name that is used for human identification (useful when module_name is nil)
-    #
-    def initialize(parent_loader, loaders, module_name, path, loader_name, loadables)
-      super parent_loader, loader_name
-
-      raise ArgumentError, 'path based loader cannot be instantiated without a path' if path.nil? || path.empty?
-
-      @module_name = module_name
-      @path = path
-      @smart_paths = LoaderPaths::SmartPaths.new(self)
-      @loaders = loaders
-      @loadables = loadables
-      unless (loadables - LOADABLE_KINDS).empty?
-        #TRANSLATORS 'loadables' is a variable containing loadable modules and should not be translated
-        raise ArgumentError, _('given loadables are not of supported loadable kind')
-      end
-      loaders.add_loader_by_name(self)
-    end
-
-    def loadables
-      @loadables
-    end
-
-    def discover(type, error_collector = nil, name_authority = Pcore::RUNTIME_NAME_AUTHORITY, &block)
-      global = global?
-      if name_authority == Pcore::RUNTIME_NAME_AUTHORITY
-        smart_paths.effective_paths(type).each do |sp|
-          relative_paths(sp).each do |rp|
-            tp = sp.typed_name(type, name_authority, rp, global ? nil : @module_name)
-            next unless sp.valid_name?(tp)
-            begin
-              load_typed(tp) unless block_given? && !block.yield(tp)
-            rescue StandardError => e
-              if error_collector.nil?
-                Puppet.warn_once(:unloadable_entity, tp.to_s, e.message)
-              else
-                err = Puppet::DataTypes::Error.new(
-                  Issues::LOADER_FAILURE.format(:type => type),
-                  'PUPPET_LOADER_FAILURE',
-                  { 'original_error' => e.message },
-                  Issues::LOADER_FAILURE.issue_code)
-                error_collector << err unless error_collector.include?(err)
-              end
-            end
-          end
-        end
-      end
-      super
-    end
-
-    # Finds typed/named entity in this module
-    # @param typed_name [TypedName] the type/name to find
-    # @return [Loader::NamedEntry, nil found/created entry, or nil if not found
-    #
-    def find(typed_name)
-      # This loader is tailored to only find entries in the current runtime
-      return nil unless typed_name.name_authority == Pcore::RUNTIME_NAME_AUTHORITY
-
-      # Assume it is a global name, and that all parts of the name should be used when looking up
-      name_parts = typed_name.name_parts
-
-      # Certain types and names can be disqualified up front
-      if name_parts.size > 1
-        # The name is in a name space.
-
-        # Then entity cannot possible be in this module unless the name starts with the module name.
-        # Note:
-        # * If "module" represents a "global component", the module_name is nil and cannot match which is
-        #   ok since such a "module" cannot have namespaced content).
-        # * If this loader is allowed to have namespaced content, the module_name can be set to NAMESPACE_WILDCARD `*`
-        #
-        return nil unless name_parts[0] == module_name || module_name == NAMESPACE_WILDCARD
-      else
-        # The name is in the global name space.
-
-        case typed_name.type
-        when :function, :resource_type, :resource_type_pp
-          # Can be defined in module using a global name. No action required
-
-        when :plan
-          if !global?
-            # Global name must be the name of the module
-            return nil unless name_parts[0] == module_name
-
-            # Look for the special 'init' plan.
-            origin, smart_path = find_existing_path(init_plan_name)
-            return smart_path.nil? ? nil : instantiate(smart_path, typed_name, origin)
-          end
-
-        when :task
-          if !global?
-            # Global name must be the name of the module
-            return nil unless name_parts[0] == module_name
-
-            # Look for the special 'init' Task
-            origin, smart_path = find_existing_path(init_task_name)
-            return smart_path.nil? ? nil : instantiate(smart_path, typed_name, origin)
-          end
-
-        when :type
-          if !global?
-            # Global name must be the name of the module
-            unless name_parts[0] == module_name || module_name == NAMESPACE_WILDCARD
-              # Check for ruby defined data type in global namespace before giving up
-              origin, smart_path = find_existing_path(typed_name)
-              return smart_path.is_a?(LoaderPaths::DataTypePath) ? instantiate(smart_path, typed_name, origin) : nil
-            end
-
-            # Look for the special 'init_typeset' TypeSet
-            origin, smart_path = find_existing_path(init_typeset_name)
-            return nil if smart_path.nil?
-
-            value = smart_path.instantiator.create(self, typed_name, origin, get_contents(origin))
-            if value.is_a?(Types::PTypeSetType)
-              # cache the entry and return it
-              return set_entry(typed_name, value, origin)
-            end
-
-            # TRANSLATORS 'TypeSet' should not be translated
-            raise ArgumentError, _("The code loaded from %{origin} does not define the TypeSet '%{module_name}'") %
-                { origin: origin, module_name: name_parts[0].capitalize }
-          end
-        else
-          # anything else cannot possibly be in this module
-          # TODO: should not be allowed anyway... may have to revisit this decision
-          return nil
-        end
-      end
-
-      # Get the paths that actually exist in this module (they are lazily processed once and cached).
-      # The result is an array (that may be empty).
-      # Find the file to instantiate, and instantiate the entity if file is found
-      origin, smart_path = find_existing_path(typed_name)
-      return instantiate(smart_path, typed_name, origin) unless smart_path.nil?
-
-      return nil unless typed_name.type == :type && typed_name.qualified?
-
-      # Search for TypeSet using parent name
-      ts_name = typed_name.parent
-      while ts_name
-        # Do not traverse parents here. This search must be confined to this loader
-        tse = get_entry(ts_name)
-        tse = find(ts_name) if tse.nil? || tse.value.nil?
-        if tse && (ts = tse.value).is_a?(Types::PTypeSetType)
-          # The TypeSet might be unresolved at this point. If so, it must be resolved using
-          # this loader. That in turn, adds all contained types to this loader.
-          ts.resolve(self)
-          te = get_entry(typed_name)
-          return te unless te.nil?
-        end
-        ts_name = ts_name.parent
-      end
-      nil
-    end
-
-    def instantiate(smart_path, typed_name, origin)
-      if origin.is_a?(Array)
-        value = smart_path.instantiator.create(self, typed_name, origin)
-      else
-        value = smart_path.instantiator.create(self, typed_name, origin, get_contents(origin))
-      end
-      # cache the entry and return it
-      set_entry(typed_name, value, origin)
-    end
-
-    # Abstract method that subclasses override that checks if it is meaningful to search using a generic smart path.
-    # This optimization is performed to not be tricked into searching an empty directory over and over again.
-    # The implementation may perform a deep search for file content other than directories and cache this in
-    # and index. It is guaranteed that a call to meaningful_to_search? takes place before checking any other
-    # path with relative_path_exists?.
-    #
-    # This optimization exists because many modules have been created from a template and they have
-    # empty directories for functions, types, etc. (It is also the place to create a cached index of the content).
-    #
-    # @param smart_path [String] a path relative to the module's root
-    # @return [Boolean] true if there is content in the directory appointed by the relative path
-    #
-    def meaningful_to_search?(smart_path)
-      raise NotImplementedError.new
-    end
-
-    # Abstract method that subclasses override to answer if the given relative path exists, and if so returns that path
-    #
-    # @param resolved_path [String] a path resolved by a smart path against the loader's root (if it has one)
-    # @return [String, nil] the found path or nil if no such path was found
-    #
-    def existing_path(resolved_path)
-      raise NotImplementedError.new
-    end
-
-    # Abstract method that subclasses override to return an array of paths that may be associated with the resolved path.
-    #
-    # @param resolved_path [String] a path, without extension, resolved by a smart path against the loader's root (if it has one)
-    # @return [Array<String>]
-    #
-    def candidate_paths(resolved_path)
-      raise NotImplementedError.new
-    end
-
-    # Abstract method that subclasses override to produce the content of the effective path.
-    # It should either succeed and return a String or fail with an exception.
-    #
-    # @param effective_path [String] a path as resolved by a smart path
-    # @return [String] the content of the file
-    #
-    def get_contents(effective_path)
-      raise NotImplementedError.new
-    end
-
-    # Abstract method that subclasses override to produce a source reference String used to identify the
-    # system resource (resource in the URI sense).
-    #
-    # @param relative_path [String] a path relative to the module's root
-    # @return [String] a reference to the source file (in file system, zip file, or elsewhere).
-    #
-    def get_source_ref(relative_path)
-      raise NotImplementedError.new
-    end
-
-    # Answers the question if this loader represents a global component (true for resource type loader and environment loader)
-    #
-    # @return [Boolean] `true` if this loader represents a global component
-    #
-    def global?
-      module_name.nil? || module_name == NAMESPACE_WILDCARD || module_name == ENVIRONMENT
-    end
-
-    # Answers `true` if the loader used by this instance is rooted beneath 'lib'. This is
-    # typically true for the the system_loader. It will have a path relative to the parent
-    # of 'puppet' instead of the parent of 'lib/puppet' since the 'lib' directory of puppet
-    # is renamed during install. This is significant for loaders that load ruby code.
-    #
-    # @return [Boolean] a boolean answering if the loader is rooted beneath 'lib'.
-    def lib_root?
-      false
-    end
-
-    # Produces the private loader for the module. If this module is not already resolved, this will trigger resolution
-    #
-    def private_loader
-      # The system loader has a nil module_name and it does not have a private_loader as there are no functions
-      # that can only by called by puppet runtime - if so, it acts as the private loader directly.
-      @private_loader ||= (global? ? self : @loaders.private_loader_for_module(module_name))
-    end
-
-    # Return all paths that matches the given smart path. The returned paths are
-    # relative to the `#generic_path` of the given smart path.
-    #
-    # @param smart_path [SmartPath] the path to find relative paths for
-    # @return [Array<String>] found paths
-    def relative_paths(smart_path)
-      raise NotImplementedError.new
-    end
-
-    private
-
-    # @return [TypedName] the fake typed name that maps to the init_typeset path for this module
-    def init_typeset_name
-      @init_typeset_name ||= TypedName.new(:type, "#{module_name}::init_typeset")
-    end
-
-    # @return [TypedName] the fake typed name that maps to the path of an init[arbitrary extension]
-    #   file that represents a task named after the module
-    def init_task_name
-      @init_task_name ||= TypedName.new(:task, "#{module_name}::init")
-    end
-
-    # @return [TypedName] the fake typed name that maps to the path of an init.pp file that represents
-    #   a plan named after the module
-    def init_plan_name
-      @init_plan_name ||= TypedName.new(:plan, "#{module_name}::init")
-    end
-
-    # Find an existing path or paths for the given `typed_name`. Return `nil` if no path is found
-    # @param typed_name [TypedName] the `typed_name` to find a path for
-    # @return [Array,nil] `nil`or a two element array where the first element is an effective path or array of paths
-    #   (depending on the `SmartPath`) and the second element is the `SmartPath` that produced the effective path or
-    #   paths. A path is a String
-    def find_existing_path(typed_name)
-      is_global = global?
-      smart_paths.effective_paths(typed_name.type).each do |sp|
-        next unless sp.valid_name?(typed_name)
-        origin = sp.effective_path(typed_name, is_global ? 0 : 1)
-        unless origin.nil?
-          if sp.fuzzy_matching?
-            # Find all paths that might be related to origin
-            origins = candidate_paths(origin)
-            return [origins, sp] unless origins.empty?
-          else
-            existing = existing_path(origin)
-            return [origin, sp] unless existing.nil?
-          end
-        end
-      end
-      nil
-    end
-  end
-
-  # @api private
-  #
-  class FileBased < AbstractPathBasedModuleLoader
-
-    attr_reader :smart_paths
-    attr_reader :path_index
-
-    # Create a kind of ModuleLoader for one module (Puppet Module, or module like)
-    #
-    # @param parent_loader [Loader] typically the loader for the environment or root
-    # @param module_name [String] the name of the module (non qualified name), may be nil for "modules" only containing globals
-    # @param path [String] the path to the root of the module (semantics defined by subclass)
-    # @param loader_name [String] a name that identifies the loader
-    #
-    def initialize(parent_loader, loaders, module_name, path, loader_name, loadables = LOADABLE_KINDS)
-      super
-      @path_index = Set.new
-    end
-
-    def existing_path(effective_path)
-      # Optimized, checks index instead of visiting file system
-      @path_index.include?(effective_path) ? effective_path : nil
-    end
-
-    def candidate_paths(effective_path)
-      basename = File.basename(effective_path, '.*')
-      dirname = File.dirname(effective_path)
-
-      files = @path_index.select do |path|
-        File.dirname(path) == dirname
-      end
-
-      # At least one file has to match what we're loading, or it certainly doesn't exist
-      if files.any? { |file| File.basename(file, '.*') == basename }
-        files
-      else
-        []
-      end
-    end
-
-    def meaningful_to_search?(smart_path)
-      ! add_to_index(smart_path).empty?
-    end
-
-    def to_s()
-      "(ModuleLoader::FileBased '#{loader_name}' '#{module_name}')"
-    end
-
-    def add_to_index(smart_path)
-      found = Dir.glob(File.join(smart_path.generic_path, '**', "*#{smart_path.extension}"))
-
-      # The reason for not always rejecting directories here is performance (avoid extra stat calls). The
-      # false positives (directories with a matching extension) is an error in any case and will be caught
-      # later.
-      found = found.reject { |file_name| File.directory?(file_name) } if smart_path.extension.empty?
-
-      @path_index.merge(found)
-      found
-    end
-
-    def get_contents(effective_path)
-      Puppet::FileSystem.read(effective_path, :encoding => 'utf-8')
-    end
-
-    # Return all paths that matches the given smart path. The returned paths are
-    # relative to the `#generic_path` of the given smart path.
-    #
-    # This method relies on the cache and does not perform any file system access
-    #
-    # @param smart_path [SmartPath] the path to find relative paths for
-    # @return [Array<String>] found paths
-    def relative_paths(smart_path)
-      root = smart_path.generic_path
-      found = []
-      @path_index.each do |path|
-        found << Pathname(path).relative_path_from(Pathname(root)).to_s if smart_path.valid_path?(path)
-      end
-      found
-    end
-  end
-
-  # Specialization used by the system_loader which is limited to see what's beneath 'lib' and hence
-  # cannot be rooted in its parent. The 'lib' directory is renamed during install so any attempt
-  # to traverse into it from above would fail.
-  #
-  # @api private
-  #
-  class LibRootedFileBased < FileBased
-    def lib_root?
-      true
-    end
-  end
-
-  # Loads from a gem specified as a URI, gem://gemname/optional/path/in/gem, or just a String gemname.
-  # The source reference (shown in errors etc.) is the expanded path of the gem as this is believed to be more
-  # helpful - given the location it should be quite obvious which gem it is, without the location, the user would
-  # need to go on a hunt for where the file actually is located.
-  #
-  # TODO: How does this get instantiated? Does the gemname refelect the name of the module (the namespace)
-  #   or is that specified a different way? Can a gem be the container of multiple modules?
-  #
-  # @api private
-  #
-  class GemBased < FileBased
-    include GemSupport
-
-    attr_reader :gem_ref
-
-    # Create a kind of ModuleLoader for one module
-    # The parameters are:
-    # * parent_loader - typically the loader for the root
-    # * module_name - the name of the module (non qualified name)
-    # * gem_ref - [URI, String] gem reference to the root of the module (URI, gem://gemname/optional/path/in/gem), or
-    #     just the gem's name as a String.
-    #
-    def initialize(parent_loader, loaders, module_name, gem_ref, loader_name, loadables = LOADABLE_KINDS)
-      @gem_ref = gem_ref
-      super parent_loader, loaders, module_name, gem_dir(gem_ref), loader_name, loadables
-    end
-
-    def to_s()
-      "(ModuleLoader::GemBased '#{loader_name}' '#{@gem_ref}' [#{module_name}])"
-    end
-  end
-end
-end
-end