pdk 2.3.0 → 2.4.0

data/lib/pdk/cli/util/command_redirector.rb

@@ -1,27 +1,27 @@
-require 'pdk'
-require 'tty/prompt'
-
-module PDK
-  module CLI
-    module Util
-      class CommandRedirector < TTY::Prompt::AnswersCollector
-        attr_accessor :command
-
-        def pastel
-          @pastel ||= Pastel.new
-        end
-
-        def target_command(cmd)
-          @command = cmd
-        end
-
-        def run
-          @prompt.puts _('Did you mean \'%{command}\'?') % { command: pastel.bold(@command) }
-          @prompt.yes?('-->')
-        rescue PDK::CLI::Util::Interview::READER::InputInterrupt
-          nil
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+require 'tty/prompt'
+
+module PDK
+  module CLI
+    module Util
+      class CommandRedirector < TTY::Prompt::AnswersCollector
+        attr_accessor :command
+
+        def pastel
+          @pastel ||= Pastel.new
+        end
+
+        def target_command(cmd)
+          @command = cmd
+        end
+
+        def run
+          @prompt.puts _('Did you mean \'%{command}\'?') % { command: pastel.bold(@command) }
+          @prompt.yes?('-->')
+        rescue PDK::CLI::Util::Interview::READER::InputInterrupt
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/util/interview.rb

@@ -1,72 +1,72 @@
-require 'tty/prompt'
-require 'pdk'
-
-module PDK
-  module CLI
-    module Util
-      class Interview < TTY::Prompt::AnswersCollector
-        READER = defined?(TTY::Reader) ? TTY::Reader : TTY::Prompt::Reader
-
-        def pastel
-          @pastel ||= Pastel.new
-        end
-
-        def add_questions(questions)
-          questions.each do |question|
-            add_question(question)
-          end
-        end
-
-        def add_question(options = {})
-          (@questions ||= {})[options[:name]] = options
-        end
-
-        def num_questions
-          (@questions ||= {}).count
-        end
-
-        def run
-          i = 1
-          num_questions = @questions.count
-          @questions.each do |question_name, question|
-            @name = question_name
-            @prompt.print pastel.bold(_('[Q %{current_number}/%{questions_total}]') % { current_number: i, questions_total: num_questions }) + ' '
-            @prompt.puts pastel.bold(question[:question])
-            @prompt.puts question[:help] if question.key?(:help)
-
-            case question[:type]
-            when :yes
-              yes?(_('-->')) do |q|
-                q.default(question[:default]) if question.key?(:default)
-              end
-            when :multi_select
-              multi_select(_('-->'), per_page: question[:choices].count) do |q|
-                q.enum ')'
-                q.default(*question[:default]) if question.key?(:default)
-
-                question[:choices].each do |text, metadata|
-                  q.choice text, metadata
-                end
-              end
-            else
-              ask(_('-->')) do |q|
-                q.required(question.fetch(:required, false))
-
-                if question.key?(:validate_pattern)
-                  q.validate(question[:validate_pattern], question[:validate_message])
-                end
-
-                q.default(question[:default]) if question.key?(:default)
-              end
-            end
-            i += 1
-            @prompt.puts ''
-          end
-          @answers
-        rescue READER::InputInterrupt
-          nil
-        end
-      end
-    end
-  end
-end
+require 'tty/prompt'
+require 'pdk'
+
+module PDK
+  module CLI
+    module Util
+      class Interview < TTY::Prompt::AnswersCollector
+        READER = defined?(TTY::Reader) ? TTY::Reader : TTY::Prompt::Reader
+
+        def pastel
+          @pastel ||= Pastel.new
+        end
+
+        def add_questions(questions)
+          questions.each do |question|
+            add_question(question)
+          end
+        end
+
+        def add_question(options = {})
+          (@questions ||= {})[options[:name]] = options
+        end
+
+        def num_questions
+          (@questions ||= {}).count
+        end
+
+        def run
+          i = 1
+          num_questions = @questions.count
+          @questions.each do |question_name, question|
+            @name = question_name
+            @prompt.print pastel.bold(_('[Q %{current_number}/%{questions_total}]') % { current_number: i, questions_total: num_questions }) + ' '
+            @prompt.puts pastel.bold(question[:question])
+            @prompt.puts question[:help] if question.key?(:help)
+
+            case question[:type]
+            when :yes
+              yes?(_('-->')) do |q|
+                q.default(question[:default]) if question.key?(:default)
+              end
+            when :multi_select
+              multi_select(_('-->'), per_page: question[:choices].count) do |q|
+                q.enum ')'
+                q.default(*question[:default]) if question.key?(:default)
+
+                question[:choices].each do |text, metadata|
+                  q.choice text, metadata
+                end
+              end
+            else
+              ask(_('-->')) do |q|
+                q.required(question.fetch(:required, false))
+
+                if question.key?(:validate_pattern)
+                  q.validate(question[:validate_pattern], question[:validate_message])
+                end
+
+                q.default(question[:default]) if question.key?(:default)
+              end
+            end
+            i += 1
+            @prompt.puts ''
+          end
+          @answers
+        rescue READER::InputInterrupt
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/util/option_normalizer.rb

@@ -1,55 +1,55 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    module Util
-      class OptionNormalizer
-        def self.comma_separated_list_to_array(list, _options = {})
-          raise _('Error: expected comma separated list') unless OptionValidator.comma_separated_list?(list)
-          list.split(',').compact
-        end
-
-        # Parse one or more format:target pairs into report format
-        # specifications.
-        #
-        # Each specification is a Hash with two values:
-        #   :method => The name of the method to call on the PDK::Report object
-        #              to render the report.
-        #   :target => The target to write the report to. This can be either an
-        #              IO object that implements #write, or a String filename
-        #              that will be opened for writing.
-        #
-        # If the target given is "stdout" or "stderr", this will convert those
-        # strings into the appropriate IO object.
-        #
-        # @return [Array<Hash{Symbol=>Object}>] An array of one or more report
-        #   format specifications
-        def self.report_formats(formats)
-          formats.map do |f|
-            format, target = f.split(':', 2)
-
-            begin
-              OptionValidator.enum(format, PDK::Report.formats)
-            rescue ArgumentError
-              raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid report format (%{valid})") % {
-                name:  format,
-                valid: PDK::Report.formats.join(', '),
-              }
-            end
-
-            case target
-            when 'stdout'
-              target = $stdout
-            when 'stderr'
-              target = $stderr
-            when nil
-              target = PDK::Report.default_target
-            end
-
-            { method: "write_#{format}".to_sym, target: target }
-          end
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    module Util
+      class OptionNormalizer
+        def self.comma_separated_list_to_array(list, _options = {})
+          raise _('Error: expected comma separated list') unless OptionValidator.comma_separated_list?(list)
+          list.split(',').compact
+        end
+
+        # Parse one or more format:target pairs into report format
+        # specifications.
+        #
+        # Each specification is a Hash with two values:
+        #   :method => The name of the method to call on the PDK::Report object
+        #              to render the report.
+        #   :target => The target to write the report to. This can be either an
+        #              IO object that implements #write, or a String filename
+        #              that will be opened for writing.
+        #
+        # If the target given is "stdout" or "stderr", this will convert those
+        # strings into the appropriate IO object.
+        #
+        # @return [Array<Hash{Symbol=>Object}>] An array of one or more report
+        #   format specifications
+        def self.report_formats(formats)
+          formats.map do |f|
+            format, target = f.split(':', 2)
+
+            begin
+              OptionValidator.enum(format, PDK::Report.formats)
+            rescue ArgumentError
+              raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid report format (%{valid})") % {
+                name:  format,
+                valid: PDK::Report.formats.join(', '),
+              }
+            end
+
+            case target
+            when 'stdout'
+              target = $stdout
+            when 'stderr'
+              target = $stderr
+            when nil
+              target = PDK::Report.default_target
+            end
+
+            { method: "write_#{format}".to_sym, target: target }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/util/option_validator.rb

@@ -1,68 +1,68 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    module Util
-      class OptionValidator
-        def self.comma_separated_list?(list, _options = {})
-          (list =~ %r{^[\w\-]+(?:,[\w\-]+)+$}) ? true : false
-        end
-
-        # @return [Boolean] true if the fact name is valid
-        def self.valid_fact_name?(name)
-          name.length > 1
-        end
-
-        def self.enum(val, valid_entries, _options = {})
-          vals = val.is_a?(Array) ? val : [val]
-          invalid_entries = vals.reject { |e| valid_entries.include?(e) }
-
-          unless invalid_entries.empty?
-            raise ArgumentError, _('Error: the following values are invalid: %{invalid_entries}') % { invalid_entries: invalid_entries }
-          end
-
-          val
-        end
-
-        # Validate the module name against the regular expression in the
-        # documentation: https://docs.puppet.com/puppet/4.10/modules_fundamentals.html#allowed-module-names
-        def self.valid_module_name?(string)
-          !(string =~ %r{\A[a-z][a-z0-9_]*\Z}).nil?
-        end
-        singleton_class.send(:alias_method, :valid_task_name?, :valid_module_name?)
-
-        # https://puppet.com/docs/puppet/5.3/custom_types.html#creating-a-type only says the name has to be a ruby symbol.
-        # Let's assume that only strings similar to module names can actually be resolved by the puppet language.
-        singleton_class.send(:alias_method, :valid_provider_name?, :valid_module_name?)
-
-        # The name has to be a ruby symbol.
-        # While overly strict, let's apply the provider and module name rules for consistency.
-        singleton_class.send(:alias_method, :valid_transport_name?, :valid_provider_name?)
-
-        # Validate a Puppet namespace against the regular expression in the
-        # documentation: https://docs.puppet.com/puppet/4.10/lang_reserved.html#classes-and-defined-resource-types
-        def self.valid_namespace?(string)
-          return false if (string || '').split('::').last == 'init'
-
-          !(string =~ %r{\A([a-z][a-z0-9_]*)(::[a-z][a-z0-9_]*)*\Z}).nil?
-        end
-        singleton_class.send(:alias_method, :valid_function_name?, :valid_namespace?)
-
-        singleton_class.send(:alias_method, :valid_class_name?, :valid_namespace?)
-        singleton_class.send(:alias_method, :valid_defined_type_name?, :valid_namespace?)
-
-        # Validate that a class/defined type parameter matches the regular
-        # expression in the documentation: https://docs.puppet.com/puppet/4.10/lang_reserved.html#parameters
-        # The parameter should also not be a reserved word or overload
-        # a metaparameter.
-        def self.valid_param_name?(string)
-          reserved_words = %w[trusted facts server_facts title name].freeze
-          metaparams = %w[alias audit before loglevel noop notify require schedule stage subscribe tag].freeze
-          return false if reserved_words.include?(string) || metaparams.include?(string)
-
-          !(string =~ %r{\A[a-z][a-zA-Z0-9_]*\Z}).nil?
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    module Util
+      class OptionValidator
+        def self.comma_separated_list?(list, _options = {})
+          (list =~ %r{^[\w\-]+(?:,[\w\-]+)+$}) ? true : false
+        end
+
+        # @return [Boolean] true if the fact name is valid
+        def self.valid_fact_name?(name)
+          name.length > 1
+        end
+
+        def self.enum(val, valid_entries, _options = {})
+          vals = val.is_a?(Array) ? val : [val]
+          invalid_entries = vals.reject { |e| valid_entries.include?(e) }
+
+          unless invalid_entries.empty?
+            raise ArgumentError, _('Error: the following values are invalid: %{invalid_entries}') % { invalid_entries: invalid_entries }
+          end
+
+          val
+        end
+
+        # Validate the module name against the regular expression in the
+        # documentation: https://docs.puppet.com/puppet/4.10/modules_fundamentals.html#allowed-module-names
+        def self.valid_module_name?(string)
+          !(string =~ %r{\A[a-z][a-z0-9_]*\Z}).nil?
+        end
+        singleton_class.send(:alias_method, :valid_task_name?, :valid_module_name?)
+
+        # https://puppet.com/docs/puppet/5.3/custom_types.html#creating-a-type only says the name has to be a ruby symbol.
+        # Let's assume that only strings similar to module names can actually be resolved by the puppet language.
+        singleton_class.send(:alias_method, :valid_provider_name?, :valid_module_name?)
+
+        # The name has to be a ruby symbol.
+        # While overly strict, let's apply the provider and module name rules for consistency.
+        singleton_class.send(:alias_method, :valid_transport_name?, :valid_provider_name?)
+
+        # Validate a Puppet namespace against the regular expression in the
+        # documentation: https://docs.puppet.com/puppet/4.10/lang_reserved.html#classes-and-defined-resource-types
+        def self.valid_namespace?(string)
+          return false if (string || '').split('::').last == 'init'
+
+          !(string =~ %r{\A([a-z][a-z0-9_]*)(::[a-z][a-z0-9_]*)*\Z}).nil?
+        end
+        singleton_class.send(:alias_method, :valid_function_name?, :valid_namespace?)
+
+        singleton_class.send(:alias_method, :valid_class_name?, :valid_namespace?)
+        singleton_class.send(:alias_method, :valid_defined_type_name?, :valid_namespace?)
+
+        # Validate that a class/defined type parameter matches the regular
+        # expression in the documentation: https://docs.puppet.com/puppet/4.10/lang_reserved.html#parameters
+        # The parameter should also not be a reserved word or overload
+        # a metaparameter.
+        def self.valid_param_name?(string)
+          reserved_words = %w[trusted facts server_facts title name].freeze
+          metaparams = %w[alias audit before loglevel noop notify require schedule stage subscribe tag].freeze
+          return false if reserved_words.include?(string) || metaparams.include?(string)
+
+          !(string =~ %r{\A[a-z][a-zA-Z0-9_]*\Z}).nil?
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/util/spinner.rb

@@ -1,13 +1,13 @@
-require 'tty-spinner'
-
-# Replace the built-in tty check in tty-spinner with our own implementation
-# that allows us to mock the behaviour during acceptance tests.
-module TTY
-  class Spinner
-    def tty?
-      require 'pdk/cli/util'
-
-      PDK::CLI::Util.interactive?
-    end
-  end
-end
+require 'tty-spinner'
+
+# Replace the built-in tty check in tty-spinner with our own implementation
+# that allows us to mock the behaviour during acceptance tests.
+module TTY
+  class Spinner
+    def tty?
+      require 'pdk/cli/util'
+
+      PDK::CLI::Util.interactive?
+    end
+  end
+end

data/lib/pdk/cli/util/update_manager_printer.rb

@@ -1,82 +1,82 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    module Util
-      module UpdateManagerPrinter
-        # Prints the summary for a PDK::Module::UpdateManager Object
-        # @param update_manager [PDK::Module::UpdateManager] The object to print a summary of
-        # @param options [Hash{Object => Object}] A list of options when printing
-        # @option options [Boolean] :tense Whether to use future (:future) or past (:past) tense when printing the summary ("Files to be added" versus "Files added"). Default is :future
-        #
-        # @return [void]
-        def self.print_summary(update_manager, options = {})
-          require 'pdk/report'
-
-          options = {
-            tense: :future,
-          }.merge(options)
-
-          footer = false
-
-          summary(update_manager).each do |category, files|
-            next if files.empty?
-
-            PDK::Report.default_target.puts('')
-            PDK::Report.default_target.puts(generate_banner("Files #{(options[:tense] == :future) ? 'to be ' : ''}#{category}", 40))
-            PDK::Report.default_target.puts(files.map(&:to_s).join("\n"))
-            footer = true
-          end
-
-          if footer # rubocop:disable Style/GuardClause No.
-            PDK::Report.default_target.puts('')
-            PDK::Report.default_target.puts(generate_banner('', 40))
-          end
-        end
-
-        #:nocov: Tested as part of the public methods
-        # Returns a hash, summarizing the contents of the Update Manager object
-        # @param update_manager [PDK::Module::UpdateManager] The object to create a summary of
-        #
-        # @return [Hash{Symbol => Array[String]}] A hash of each category and the file paths in each category
-        def self.summary(update_manager)
-          summary = {}
-          update_manager.changes.each do |category, update_category|
-            if update_category.respond_to?(:keys)
-              updated_files = update_category.keys
-            else
-              begin
-                updated_files = update_category.map { |file| file[:path] }
-              rescue TypeError
-                updated_files = update_category.to_a
-              end
-            end
-
-            summary[category] = updated_files
-          end
-
-          summary
-        end
-        private_class_method :summary
-
-        # Creates a line of text, with `text` centered in the middle
-        # @param text [String] The text to put in the middle of the banner
-        # @param width [Integer] The width of the banner in characters. Default is 80
-        # @return [String] The generated banner
-        def self.generate_banner(text, width = 80)
-          padding = width - text.length
-          banner = ''
-          padding_char = '-'
-
-          (padding / 2.0).ceil.times { banner << padding_char }
-          banner << text
-          (padding / 2.0).floor.times { banner << padding_char }
-
-          banner
-        end
-        private_class_method :generate_banner
-        #:nocov:
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    module Util
+      module UpdateManagerPrinter
+        # Prints the summary for a PDK::Module::UpdateManager Object
+        # @param update_manager [PDK::Module::UpdateManager] The object to print a summary of
+        # @param options [Hash{Object => Object}] A list of options when printing
+        # @option options [Boolean] :tense Whether to use future (:future) or past (:past) tense when printing the summary ("Files to be added" versus "Files added"). Default is :future
+        #
+        # @return [void]
+        def self.print_summary(update_manager, options = {})
+          require 'pdk/report'
+
+          options = {
+            tense: :future,
+          }.merge(options)
+
+          footer = false
+
+          summary(update_manager).each do |category, files|
+            next if files.empty?
+
+            PDK::Report.default_target.puts('')
+            PDK::Report.default_target.puts(generate_banner("Files #{(options[:tense] == :future) ? 'to be ' : ''}#{category}", 40))
+            PDK::Report.default_target.puts(files.map(&:to_s).join("\n"))
+            footer = true
+          end
+
+          if footer # rubocop:disable Style/GuardClause No.
+            PDK::Report.default_target.puts('')
+            PDK::Report.default_target.puts(generate_banner('', 40))
+          end
+        end
+
+        #:nocov: Tested as part of the public methods
+        # Returns a hash, summarizing the contents of the Update Manager object
+        # @param update_manager [PDK::Module::UpdateManager] The object to create a summary of
+        #
+        # @return [Hash{Symbol => Array[String]}] A hash of each category and the file paths in each category
+        def self.summary(update_manager)
+          summary = {}
+          update_manager.changes.each do |category, update_category|
+            if update_category.respond_to?(:keys)
+              updated_files = update_category.keys
+            else
+              begin
+                updated_files = update_category.map { |file| file[:path] }
+              rescue TypeError
+                updated_files = update_category.to_a
+              end
+            end
+
+            summary[category] = updated_files
+          end
+
+          summary
+        end
+        private_class_method :summary
+
+        # Creates a line of text, with `text` centered in the middle
+        # @param text [String] The text to put in the middle of the banner
+        # @param width [Integer] The width of the banner in characters. Default is 80
+        # @return [String] The generated banner
+        def self.generate_banner(text, width = 80)
+          padding = width - text.length
+          banner = ''
+          padding_char = '-'
+
+          (padding / 2.0).ceil.times { banner << padding_char }
+          banner << text
+          (padding / 2.0).floor.times { banner << padding_char }
+
+          banner
+        end
+        private_class_method :generate_banner
+        #:nocov:
+      end
+    end
+  end
+end