pdk 1.13.0 → 1.14.0

data/lib/pdk/config/setting.rb

@@ -0,0 +1,132 @@
+module PDK
+  class Config
+    # A class for describing the setting of a {PDK::Config} setting.
+    #
+    # Generally, this is never instantiated manually, but is instead
+    # instantiated by passing a block to {PDK::Config::Namespace#setting}.
+    #
+    # @example
+    #
+    # PDK::Config::Namespace.new('analytics') do
+    #   setting :disabled do
+    #     validate PDK::Config::Validator.boolean
+    #     default_to { false }
+    #   end
+    # end
+    class Setting
+      attr_reader :namespace
+
+      # It is possible to have multiple setting definitions for the same setting; for example, defining a default value with a lambda, but the
+      # the validation is within a JSON schema document. These are expressed as two settings objects, and uses a single linked list to join them
+      # together:
+      #
+      # (PDK::Config::JSONSchemaSetting) --previous_setting--> (PDK::Config::Setting)
+      #
+      # So in the example above, calling `default` the on the first object in the list will:
+      # 1. Look at `default` on PDK::Config::JSONSchemaSetting
+      # 2. If a default could not be found then it calls `default` on previous_setting
+      # 3. If a default could not be found then it calls `default` on previous_setting.previous_setting
+      # 4. and so on down the linked list (chain) of settings
+      attr_writer :previous_setting
+
+      # Initialises an empty setting definition.
+      #
+      # @param name [String,Symbol] the name of the setting.
+      # @param namespace [PDK::Config::Namespace] The namespace this setting belongs to
+      def initialize(name, namespace, initial_value = nil)
+        @name = name.to_s
+        @validators = []
+        @namespace = namespace
+        @value = initial_value
+      end
+
+      def qualified_name
+        [namespace.name, @name].join('.')
+      end
+
+      def value # rubocop:disable Style/TrivialAccessors
+        @value
+      end
+
+      def value=(obj)
+        validate!(obj)
+        @value = obj
+      end
+
+      def to_s
+        @value.to_s
+      end
+
+      # Assign a validator to the setting. Subclasses should not override this method.
+      #
+      # @param validator [Hash{Symbol => [Proc,String]}]
+      # @option validator [Proc] :proc a lambda that takes the setting to be
+      #   validated as the argument and returns `true` if the setting is valid.
+      # @option validator [String] :message a description of what the validator
+      #   is testing for, that is displayed to the user as part of the error
+      #   message for invalid settings.
+      #
+      # @raise [ArgumentError] if not passed a Hash.
+      # @raise [ArgumentError] if the Hash doesn't have a `:proc` key that
+      #   contains a Proc.
+      # @raise [ArgumentError] if the Hash doesn't have a `:message` key that
+      #   contains a String.
+      #
+      # @return [nil]
+      def validate(validator)
+        raise ArgumentError, _('`validator` must be a Hash') unless validator.is_a?(Hash)
+        raise ArgumentError, _('the :proc key must contain a Proc') unless validator.key?(:proc) && validator[:proc].is_a?(Proc)
+        raise ArgumentError, _('the :message key must contain a String') unless validator.key?(:message) && validator[:message].is_a?(String)
+
+        @validators << validator
+      end
+
+      # Validate a setting against the assigned validators.
+      #
+      # @param setting [Object] the setting being validated.
+      #
+      # @raise [ArgumentError] if any of the assigned validators fail to
+      #   validate the setting.
+      #
+      # @return [nil]
+      def validate!(value)
+        @validators.each do |validator|
+          next if validator[:proc].call(value)
+
+          raise ArgumentError, _('%{key} %{message}') % {
+            key:     qualified_name,
+            message: validator[:message],
+          }
+        end
+      end
+
+      # Assign a default value proc for the setting. Subclasses should not override this method.
+      #
+      # @param block [Proc] a block that is lazy evaluated when necessary in
+      #   order to determine the default setting.
+      #
+      # @return [nil]
+      def default_to(&block)
+        raise ArgumentError, _('must be passed a block') unless block_given?
+        @default_to = block
+      end
+
+      # Evaluate the default setting.
+      #
+      # @return [Object,nil] the result of evaluating the block given to
+      #   {#default_to}, or `nil` if the setting has no default.
+      def default
+        return @default_to.call if default_block?
+        # If there is a previous setting in the chain, use its default
+        @previous_setting.nil? ? nil : @previous_setting.default
+      end
+
+      private
+
+      # @return [Boolean] true if the setting has a default setting block. Subclasses should not override this method.
+      def default_block?
+        !@default_to.nil?
+      end
+    end
+  end
+end

data/lib/pdk/config/yaml.rb

@@ -1,14 +1,23 @@
 require 'pdk/config/namespace'
+require 'pdk/config/setting'
 
 module PDK
   class Config
+    # Parses a YAML document.
+    #
+    # @see PDK::Config::Namespace.parse_file
     class YAML < Namespace
-      def parse_data(data, filename)
-        return {} if data.nil? || data.empty?
+      def parse_file(filename)
+        raise unless block_given?
+        data = load_data(filename)
+        return if data.nil? || data.empty?
 
         require 'yaml'
 
-        ::YAML.safe_load(data, [Symbol], [], true)
+        data = ::YAML.safe_load(data, [Symbol], [], true)
+        return if data.nil?
+
+        data.each { |k, v| yield k, PDK::Config::Setting.new(k, self, v) }
       rescue Psych::SyntaxError => e
         raise PDK::Config::LoadError, _('Syntax error when loading %{file}: %{error}') % {
           file:  filename,
@@ -21,6 +30,9 @@ module PDK
         }
       end
 
+      # Serializes object data into a YAML string.
+      #
+      # @see PDK::Config::Namespace.serialize_data
       def serialize_data(data)
         require 'yaml'
 

data/lib/pdk/config/yaml_with_schema.rb

@@ -0,0 +1,59 @@
+require 'pdk/config/json_schema_namespace'
+
+module PDK
+  class Config
+    # Parses a YAML document with a JSON schema.
+    #
+    # @see PDK::Config::Namespace.parse_file
+    class YAMLWithSchema < JSONSchemaNamespace
+      def parse_file(filename)
+        raise unless block_given?
+        data = load_data(filename)
+        data = '' if data.nil?
+        require 'yaml'
+        require 'json-schema'
+
+        @raw_data = ::YAML.safe_load(data, [Symbol], [], true)
+        @raw_data = {} if @raw_data.nil?
+
+        begin
+          # Ensure the parsed document is actually valid
+          validate_document!(@raw_data)
+        rescue ::JSON::Schema::ValidationError => e
+          raise PDK::Config::LoadError, _('The configuration file %{filename} is not valid: %{message}') % {
+            filename: filename,
+            message:  e.message,
+          }
+        end
+
+        require 'pdk/config/json_schema_setting'
+
+        schema_property_names.each do |key|
+          yield key, PDK::Config::JSONSchemaSetting.new(key, self, @raw_data[key])
+        end
+
+        # Remove all of the "known" settings from the schema and
+        # we're left with the settings that we don't manage.
+        self.unmanaged_settings = @raw_data.reject { |k, _| schema_property_names.include?(k) }
+      rescue Psych::SyntaxError => e
+        raise PDK::Config::LoadError, _('Syntax error when loading %{file}: %{error}') % {
+          file:  filename,
+          error: "#{e.problem} #{e.context}",
+        }
+      rescue Psych::DisallowedClass => e
+        raise PDK::Config::LoadError, _('Unsupported class in %{file}: %{error}') % {
+          file:  filename,
+          error: e.message,
+        }
+      end
+
+      # Serializes object data into a YAML string.
+      #
+      # @see PDK::Config::Namespace.serialize_data
+      def serialize_data(data)
+        require 'yaml'
+        ::YAML.dump(data)
+      end
+    end
+  end
+end

data/lib/pdk/generate.rb

@@ -4,8 +4,6 @@ require 'pdk/generate/provider'
 require 'pdk/generate/puppet_class'
 require 'pdk/generate/task'
 require 'pdk/generate/transport'
-require 'pdk/module/metadata'
-require 'pdk/module/templatedir'
 
 module PDK
   module Generate

data/lib/pdk/generate/module.rb

@@ -1,18 +1,4 @@
-require 'etc'
-require 'pathname'
-require 'fileutils'
-require 'tty-prompt'
-
-require 'pdk'
-require 'pdk/logger'
-require 'pdk/module/metadata'
-require 'pdk/module/templatedir'
-require 'pdk/cli/exec'
-require 'pdk/cli/util'
-require 'pdk/cli/util/interview'
-require 'pdk/cli/util/option_validator'
-require 'pdk/util'
-require 'pdk/util/version'
+require 'pdk/util/filesystem'
 
 module PDK
   module Generate
@@ -20,6 +6,8 @@ module PDK
       extend PDK::Util::Filesystem
 
       def self.validate_options(opts)
+        require 'pdk/cli/util/option_validator'
+
         unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[:module_name])
           error_msg = _(
             "'%{module_name}' is not a valid module name.\n" \
@@ -33,6 +21,12 @@ module PDK
       end
 
       def self.invoke(opts = {})
+        require 'pdk/module/templatedir'
+        require 'pdk/util'
+        require 'pdk/util/template_uri'
+        require 'fileutils'
+        require 'pathname'
+
         validate_options(opts) unless opts[:module_name].nil?
 
         metadata = prepare_metadata(opts)
@@ -76,6 +70,7 @@ module PDK
         end
 
         # Only update the answers files after metadata has been written.
+        require 'pdk/answer_file'
         if template_uri.default?
           # If the user specifies our default template url via the command
           # line, remove the saved template-url answer so that the template_uri
@@ -89,7 +84,12 @@ module PDK
 
         begin
           if FileUtils.mv(temp_target_dir, target_dir)
-            Dir.chdir(target_dir) { PDK::Util::Bundler.ensure_bundle! } unless opts[:'skip-bundle-install']
+            unless opts[:'skip-bundle-install']
+              Dir.chdir(target_dir) do
+                require 'pdk/util/bundler'
+                PDK::Util::Bundler.ensure_bundle!
+              end
+            end
 
             PDK.logger.info _('Module \'%{name}\' generated at path \'%{path}\', from template \'%{url}\'.') % { name: opts[:module_name], path: target_dir, url: template_uri.git_remote }
             PDK.logger.info(_('In your module directory, add classes with the \'pdk new class\' command.'))
@@ -104,6 +104,8 @@ module PDK
       end
 
       def self.username_from_login
+        require 'etc'
+
         login = Etc.getlogin || ''
         login_clean = login.downcase.gsub(%r{[^0-9a-z]}i, '')
         login_clean = 'username' if login_clean.empty?
@@ -118,6 +120,9 @@ module PDK
       end
 
       def self.prepare_metadata(opts = {})
+        require 'pdk/answer_file'
+        require 'pdk/module/metadata'
+
         opts[:username] = (opts[:username] || PDK.answers['forge_username'] || username_from_login).downcase
 
         defaults = PDK::Module::Metadata::DEFAULTS.dup
@@ -134,6 +139,8 @@ module PDK
       end
 
       def self.prepare_module_directory(target_dir)
+        require 'fileutils'
+
         [
           File.join(target_dir, 'examples'),
           File.join(target_dir, 'files'),
@@ -153,6 +160,9 @@ module PDK
       end
 
       def self.module_interview(metadata, opts = {})
+        require 'pdk/module/metadata'
+        require 'pdk/cli/util/interview'
+
         questions = [
           {
             name:             'module_name',
@@ -307,6 +317,8 @@ module PDK
         metadata.update!(answers)
 
         if opts[:prompt].nil? || opts[:prompt]
+          require 'pdk/cli/util'
+
           continue = PDK::CLI::Util.prompt_for_yes(
             _('Metadata will be generated based on this information, continue?'),
             prompt:         prompt,
@@ -319,6 +331,7 @@ module PDK
           end
         end
 
+        require 'pdk/answer_file'
         PDK.answers.update!(
           {
             'forge_username' => opts[:username],

data/lib/pdk/generate/puppet_object.rb

@@ -1,12 +1,3 @@
-require 'fileutils'
-
-require 'pdk'
-require 'pdk/logger'
-require 'pdk/module/metadata'
-require 'pdk/module/templatedir'
-require 'pdk/template_file'
-require 'pdk/util/filesystem'
-
 module PDK
   module Generate
     class PuppetObject
@@ -141,8 +132,10 @@ module PDK
       #
       # @api public
       def check_preconditions
+        require 'pdk/util/filesystem'
+
         targets.each do |target_file|
-          next unless File.exist?(target_file)
+          next unless PDK::Util::Filesystem.exist?(target_file)
 
           raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
             file:        target_file,
@@ -151,6 +144,18 @@ module PDK
         end
       end
 
+      # Check the preconditions of this template group, behaving as a
+      # predicate rather than raising an exception.
+      #
+      # @return [Boolean] true if the generator is safe to run, otherwise
+      #   false.
+      def can_run?
+        check_preconditions
+        true
+      rescue PDK::CLI::ExitWithError
+        false
+      end
+
       # Check that the templates can be rendered. Find an appropriate template
       # and create the target files from the template. This is the main entry
       # point for the class.
@@ -191,6 +196,8 @@ module PDK
       #
       # @api private
       def render_file(dest_path, template_path, data)
+        require 'pdk/template_file'
+
         write_file(dest_path) do
           PDK::TemplateFile.new(template_path, data).render
         end
@@ -211,12 +218,15 @@ module PDK
       #
       # @api private
       def write_file(dest_path)
+        require 'pdk/logger'
+        require 'pdk/util/filesystem'
+
         PDK.logger.info(_("Creating '%{file}' from template.") % { file: dest_path })
 
         file_content = yield
 
         begin
-          FileUtils.mkdir_p(File.dirname(dest_path))
+          PDK::Util::Filesystem.mkdir_p(File.dirname(dest_path))
         rescue SystemCallError => e
           raise PDK::CLI::FatalError, _("Unable to create directory '%{path}': %{message}") % {
             path:    File.dirname(dest_path),
@@ -247,6 +257,10 @@ module PDK
       #
       # @api private
       def with_templates
+        require 'pdk/logger'
+        require 'pdk/module/templatedir'
+        require 'pdk/util/template_uri'
+
         templates.each do |template|
           if template[:uri].nil?
             PDK.logger.debug(_('No %{dir_type} template found; trying next template directory.') % { dir_type: template[:type] })
@@ -293,34 +307,23 @@ module PDK
       #
       # @api private
       def templates
+        require 'pdk/util/template_uri'
+
         @templates ||= PDK::Util::TemplateURI.templates(@options)
       end
 
       # Retrieves the name of the module (without the forge username) from the
       # module metadata.
       #
-      # @raise (see #module_metadata)
       # @return [String] The name of the module.
       #
       # @api private
       def module_name
-        @module_name ||= module_metadata.data['name'].rpartition('-').last
-      end
+        require 'pdk/util'
 
-      # Parses the metadata.json file for the module.
-      #
-      # @raise [PDK::CLI::FatalError] if the metadata.json file does not exist,
-      #   can not be read, or contains invalid metadata.
-      #
-      # @return [PDK::Module::Metadata] the parsed module metadata.
-      #
-      # @api private
-      def module_metadata
-        @module_metadata ||= begin
-          PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json'))
-        rescue ArgumentError => e
-          raise PDK::CLI::FatalError, _("'%{dir}' does not contain valid Puppet module metadata: %{msg}") % { dir: module_dir, msg: e.message }
-        end
+        @module_name ||= PDK::Util.module_metadata['name'].rpartition('-').last
+      rescue ArgumentError => e
+        raise PDK::CLI::FatalError, e
       end
 
       # transform a object name into a ruby class name