pdk 2.3.0 → 2.4.0

data/lib/pdk/template/renderer/v1/legacy_template_dir.rb

@@ -1,116 +1,116 @@
-require 'pdk'
-
-module PDK
-  module Template
-    module Renderer
-      module V1
-        # The old templating code in the PDK passed through a TemplateDir object. This class mimics the methods
-        # of that old class so that existing custom templates will still function with the newer refactor templating code.
-        # Methods which have no use in custom templates exist but do no nothing, for example `def render; end`
-        #
-        # @see https://raw.githubusercontent.com/puppetlabs/pdk/4ffd58062c77ad1e54d2fe16b16015f7207bcee8/lib/pdk/module/template_dir/base.rb
-        # :nocov: This class is tested in the packaging and acceptance testing suites
-        class LegacyTemplateDir
-          attr_accessor :module_metadata
-          attr_reader :uri
-
-          def initialize(context, uri, path, module_metadata = {})
-            @uri = uri
-            @module_metadata = module_metadata
-            @context = context
-            @path = path
-          end
-
-          def metadata; end
-
-          def render; end
-
-          def object_template_for; end
-
-          def object_config
-            config_for(nil)
-          end
-
-          # Generate a hash of data to be used when rendering the specified
-          # template.
-          #
-          # @param dest_path [String] The destination path of the file that the
-          # data is for, relative to the root of the module.
-          #
-          # @return [Hash] The data that will be available to the template via the
-          # `@configs` instance variable.
-          #
-          # @api private
-          def config_for(dest_path, sync_config_path = nil)
-            require 'pdk/util'
-            require 'pdk/analytics'
-
-            module_root = PDK::Util.module_root
-            sync_config_path ||= File.join(module_root, '.sync.yml') unless module_root.nil?
-            config_path = File.join(@path, 'config_defaults.yml')
-
-            if @config.nil?
-              require 'deep_merge'
-              conf_defaults = read_config(config_path)
-              @sync_config = read_config(sync_config_path) unless sync_config_path.nil?
-              @config = conf_defaults
-              @config.deep_merge!(@sync_config, knockout_prefix: '---') unless @sync_config.nil?
-            end
-            file_config = @config.fetch(:global, {})
-            file_config['module_metadata'] = @module_metadata
-            file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
-            file_config.merge!(@config).tap do |c|
-              if uri.default?
-                file_value = if c['unmanaged']
-                               'unmanaged'
-                             elsif c['delete']
-                               'deleted'
-                             elsif @sync_config && @sync_config.key?(dest_path)
-                               'customized'
-                             else
-                               'default'
-                             end
-
-                PDK.analytics.event('TemplateDir', 'file', label: dest_path, value: file_value)
-              end
-            end
-          end
-
-          # Generates a hash of data from a given yaml file location.
-          #
-          # @param loc [String] The path of the yaml config file.
-          #
-          # @warn If the specified path is not a valid yaml file. Returns an empty Hash
-          # if so.
-          #
-          # @return [Hash] The data that has been read in from the given yaml file.
-          #
-          # @api private
-          def read_config(loc)
-            if PDK::Util::Filesystem.file?(loc) && PDK::Util::Filesystem.readable?(loc)
-              require 'yaml'
-
-              begin
-                YAML.safe_load(PDK::Util::Filesystem.read_file(loc), [], [], true)
-              rescue Psych::SyntaxError => e
-                PDK.logger.warn _("'%{file}' is not a valid YAML file: %{problem} %{context} at line %{line} column %{column}") % {
-                  file:    loc,
-                  problem: e.problem,
-                  context: e.context,
-                  line:    e.line,
-                  column:  e.column,
-                }
-                {}
-              end
-            else
-              {}
-            end
-          end
-
-          def template_path(_uri); end
-        end
-        # :nocov:
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Template
+    module Renderer
+      module V1
+        # The old templating code in the PDK passed through a TemplateDir object. This class mimics the methods
+        # of that old class so that existing custom templates will still function with the newer refactor templating code.
+        # Methods which have no use in custom templates exist but do no nothing, for example `def render; end`
+        #
+        # @see https://raw.githubusercontent.com/puppetlabs/pdk/4ffd58062c77ad1e54d2fe16b16015f7207bcee8/lib/pdk/module/template_dir/base.rb
+        # :nocov: This class is tested in the packaging and acceptance testing suites
+        class LegacyTemplateDir
+          attr_accessor :module_metadata
+          attr_reader :uri
+
+          def initialize(context, uri, path, module_metadata = {})
+            @uri = uri
+            @module_metadata = module_metadata
+            @context = context
+            @path = path
+          end
+
+          def metadata; end
+
+          def render; end
+
+          def object_template_for; end
+
+          def object_config
+            config_for(nil)
+          end
+
+          # Generate a hash of data to be used when rendering the specified
+          # template.
+          #
+          # @param dest_path [String] The destination path of the file that the
+          # data is for, relative to the root of the module.
+          #
+          # @return [Hash] The data that will be available to the template via the
+          # `@configs` instance variable.
+          #
+          # @api private
+          def config_for(dest_path, sync_config_path = nil)
+            require 'pdk/util'
+            require 'pdk/analytics'
+
+            module_root = PDK::Util.module_root
+            sync_config_path ||= File.join(module_root, '.sync.yml') unless module_root.nil?
+            config_path = File.join(@path, 'config_defaults.yml')
+
+            if @config.nil?
+              require 'deep_merge'
+              conf_defaults = read_config(config_path)
+              @sync_config = read_config(sync_config_path) unless sync_config_path.nil?
+              @config = conf_defaults
+              @config.deep_merge!(@sync_config, knockout_prefix: '---') unless @sync_config.nil?
+            end
+            file_config = @config.fetch(:global, {})
+            file_config['module_metadata'] = @module_metadata
+            file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
+            file_config.merge!(@config).tap do |c|
+              if uri.default?
+                file_value = if c['unmanaged']
+                               'unmanaged'
+                             elsif c['delete']
+                               'deleted'
+                             elsif @sync_config && @sync_config.key?(dest_path)
+                               'customized'
+                             else
+                               'default'
+                             end
+
+                PDK.analytics.event('TemplateDir', 'file', label: dest_path, value: file_value)
+              end
+            end
+          end
+
+          # Generates a hash of data from a given yaml file location.
+          #
+          # @param loc [String] The path of the yaml config file.
+          #
+          # @warn If the specified path is not a valid yaml file. Returns an empty Hash
+          # if so.
+          #
+          # @return [Hash] The data that has been read in from the given yaml file.
+          #
+          # @api private
+          def read_config(loc)
+            if PDK::Util::Filesystem.file?(loc) && PDK::Util::Filesystem.readable?(loc)
+              require 'yaml'
+
+              begin
+                YAML.safe_load(PDK::Util::Filesystem.read_file(loc), [], [], true)
+              rescue Psych::SyntaxError => e
+                PDK.logger.warn _("'%{file}' is not a valid YAML file: %{problem} %{context} at line %{line} column %{column}") % {
+                  file:    loc,
+                  problem: e.problem,
+                  context: e.context,
+                  line:    e.line,
+                  column:  e.column,
+                }
+                {}
+              end
+            else
+              {}
+            end
+          end
+
+          def template_path(_uri); end
+        end
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/pdk/template/renderer/v1/renderer.rb

@@ -1,132 +1,132 @@
-require 'pdk'
-require 'pdk/template/renderer'
-
-module PDK
-  module Template
-    module Renderer
-      module V1
-        class Renderer < PDK::Template::Renderer::AbstractRenderer
-          # @see PDK::Template::Renderer::AbstractRenderer.render
-          def render(template_type, _name, options = {})
-            render_module(options) { |*args| yield(*args) } if template_type == PDK::Template::MODULE_TEMPLATE_TYPE
-          end
-
-          # @see PDK::Template::Renderer::AbstractRenderer.has_single_item?
-          def has_single_item?(item_path) # rubocop:disable Naming/PredicateName
-            PDK::Util::Filesystem.exist?(single_item_path(item_path))
-          end
-
-          # @see PDK::Template::Renderer::AbstractRenderer.render_single_item
-          def render_single_item(relative_file_path, template_data_hash)
-            template_file = single_item_path(relative_file_path)
-            return nil unless PDK::Util::Filesystem.file?(template_file) && PDK::Util::Filesystem.readable?(template_file)
-
-            PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
-            new_template_file(template_file, template_data_hash).render
-          end
-
-          # Returns the full path for a single item
-          #
-          # @param item_path [String] The path of the single item to render
-          # @return [String]
-          # @api private
-          #:nocov:
-          def single_item_path(item_path)
-            File.join(template_root, 'object_templates', item_path)
-          end
-          #:nocov:
-
-          # Helper method used during testing
-          #:nocov:
-          # @api private
-          def new_template_file(template_file, template_data_hash)
-            TemplateFile.new(template_file, template_data_hash)
-          end
-          #:nocov:
-
-          # Helper method used during testing
-          #:nocov:
-          # @api private
-          def new_legacy_template_dir(context, uri, path, module_metadata = {})
-            LegacyTemplateDir.new(context, uri, path, module_metadata)
-          end
-          #:nocov:
-
-          # Renders a new module
-          #
-          # @param options [Hash{Object => Object}] A list of options to pass through to the renderer. See PDK::Template::TemplateDir helper methods for other options
-          # @see #render
-          # @api private
-          #:nocov: This is tested in acceptance and packaging tests
-          def render_module(options = {})
-            require 'pdk/template/renderer/v1/template_file'
-
-            moduleroot_dir = File.join(template_root, 'moduleroot')
-            moduleroot_init = File.join(template_root, 'moduleroot_init')
-
-            dirs = [moduleroot_dir]
-            dirs << moduleroot_init if options[:include_first_time]
-
-            legacy_template_dir = new_legacy_template_dir(context, template_uri, template_root, options[:module_metadata] || {})
-
-            files_in_template(dirs).each do |template_file, template_loc|
-              template_file = template_file.to_s
-              PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
-              dest_path = template_file.sub(%r{\.erb\Z}, '')
-              config = legacy_template_dir.config_for(dest_path)
-
-              dest_status = if template_loc.start_with?(moduleroot_init)
-                              :init
-                            else
-                              :manage
-                            end
-
-              if config['unmanaged']
-                dest_status = :unmanage
-              elsif config['delete']
-                dest_status = :delete
-              else
-                begin
-                  dest_content = new_template_file(File.join(template_loc, template_file), configs: config, template_dir: legacy_template_dir).render
-                rescue => error
-                  error_msg = _(
-                    "Failed to render template '%{template}'\n" \
-                    '%{exception}: %{message}',
-                  ) % { template: template_file, exception: error.class, message: error.message }
-                  raise PDK::CLI::FatalError, error_msg
-                end
-              end
-
-              yield dest_path, dest_content, dest_status
-            end
-          end
-          #:nocov:
-
-          # Returns all files in the given template directories
-          #
-          # @param dirs [Array[String]] Directories to search in
-          # @param glob_suffix [Array[String]] File glob to use when searching for files. Defaults to ['**', '*']
-          #
-          # @return [Hash{String => String}] Key is the template file relative path and the value is the absolute path to the template directory
-          # @api private
-          def files_in_template(dirs, glob_suffix = ['**', '*'])
-            temp_paths = []
-            dirlocs = []
-            dirs.each do |dir|
-              raise ArgumentError, _("The directory '%{dir}' doesn't exist") % { dir: dir } unless PDK::Util::Filesystem.directory?(dir)
-              temp_paths += PDK::Util::Filesystem.glob(File.join(dir, *glob_suffix), File::FNM_DOTMATCH).select do |template_path|
-                if PDK::Util::Filesystem.file?(template_path) && !PDK::Util::Filesystem.symlink?(template_path)
-                  dirlocs << dir
-                end
-              end
-              temp_paths.map do |template_path|
-                template_path.sub!(%r{\A#{Regexp.escape(dir)}#{Regexp.escape(File::SEPARATOR)}}, '')
-              end
-            end
-            Hash[temp_paths.zip dirlocs]
-          end
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+require 'pdk/template/renderer'
+
+module PDK
+  module Template
+    module Renderer
+      module V1
+        class Renderer < PDK::Template::Renderer::AbstractRenderer
+          # @see PDK::Template::Renderer::AbstractRenderer.render
+          def render(template_type, _name, options = {})
+            render_module(options) { |*args| yield(*args) } if template_type == PDK::Template::MODULE_TEMPLATE_TYPE
+          end
+
+          # @see PDK::Template::Renderer::AbstractRenderer.has_single_item?
+          def has_single_item?(item_path) # rubocop:disable Naming/PredicateName
+            PDK::Util::Filesystem.exist?(single_item_path(item_path))
+          end
+
+          # @see PDK::Template::Renderer::AbstractRenderer.render_single_item
+          def render_single_item(relative_file_path, template_data_hash)
+            template_file = single_item_path(relative_file_path)
+            return nil unless PDK::Util::Filesystem.file?(template_file) && PDK::Util::Filesystem.readable?(template_file)
+
+            PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
+            new_template_file(template_file, template_data_hash).render
+          end
+
+          # Returns the full path for a single item
+          #
+          # @param item_path [String] The path of the single item to render
+          # @return [String]
+          # @api private
+          #:nocov:
+          def single_item_path(item_path)
+            File.join(template_root, 'object_templates', item_path)
+          end
+          #:nocov:
+
+          # Helper method used during testing
+          #:nocov:
+          # @api private
+          def new_template_file(template_file, template_data_hash)
+            TemplateFile.new(template_file, template_data_hash)
+          end
+          #:nocov:
+
+          # Helper method used during testing
+          #:nocov:
+          # @api private
+          def new_legacy_template_dir(context, uri, path, module_metadata = {})
+            LegacyTemplateDir.new(context, uri, path, module_metadata)
+          end
+          #:nocov:
+
+          # Renders a new module
+          #
+          # @param options [Hash{Object => Object}] A list of options to pass through to the renderer. See PDK::Template::TemplateDir helper methods for other options
+          # @see #render
+          # @api private
+          #:nocov: This is tested in acceptance and packaging tests
+          def render_module(options = {})
+            require 'pdk/template/renderer/v1/template_file'
+
+            moduleroot_dir = File.join(template_root, 'moduleroot')
+            moduleroot_init = File.join(template_root, 'moduleroot_init')
+
+            dirs = [moduleroot_dir]
+            dirs << moduleroot_init if options[:include_first_time]
+
+            legacy_template_dir = new_legacy_template_dir(context, template_uri, template_root, options[:module_metadata] || {})
+
+            files_in_template(dirs).each do |template_file, template_loc|
+              template_file = template_file.to_s
+              PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
+              dest_path = template_file.sub(%r{\.erb\Z}, '')
+              config = legacy_template_dir.config_for(dest_path)
+
+              dest_status = if template_loc.start_with?(moduleroot_init)
+                              :init
+                            else
+                              :manage
+                            end
+
+              if config['unmanaged']
+                dest_status = :unmanage
+              elsif config['delete']
+                dest_status = :delete
+              else
+                begin
+                  dest_content = new_template_file(File.join(template_loc, template_file), configs: config, template_dir: legacy_template_dir).render
+                rescue => error
+                  error_msg = _(
+                    "Failed to render template '%{template}'\n" \
+                    '%{exception}: %{message}',
+                  ) % { template: template_file, exception: error.class, message: error.message }
+                  raise PDK::CLI::FatalError, error_msg
+                end
+              end
+
+              yield dest_path, dest_content, dest_status
+            end
+          end
+          #:nocov:
+
+          # Returns all files in the given template directories
+          #
+          # @param dirs [Array[String]] Directories to search in
+          # @param glob_suffix [Array[String]] File glob to use when searching for files. Defaults to ['**', '*']
+          #
+          # @return [Hash{String => String}] Key is the template file relative path and the value is the absolute path to the template directory
+          # @api private
+          def files_in_template(dirs, glob_suffix = ['**', '*'])
+            temp_paths = []
+            dirlocs = []
+            dirs.each do |dir|
+              raise ArgumentError, _("The directory '%{dir}' doesn't exist") % { dir: dir } unless PDK::Util::Filesystem.directory?(dir)
+              temp_paths += PDK::Util::Filesystem.glob(File.join(dir, *glob_suffix), File::FNM_DOTMATCH).select do |template_path|
+                if PDK::Util::Filesystem.file?(template_path) && !PDK::Util::Filesystem.symlink?(template_path)
+                  dirlocs << dir
+                end
+              end
+              temp_paths.map do |template_path|
+                template_path.sub!(%r{\A#{Regexp.escape(dir)}#{Regexp.escape(File::SEPARATOR)}}, '')
+              end
+            end
+            Hash[temp_paths.zip dirlocs]
+          end
+        end
+      end
+    end
+  end
+end