pdk 2.3.0 → 2.4.0

data/lib/pdk/cli/exec/interactive_command.rb

@@ -1,114 +1,114 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    module Exec
-      class InteractiveCommand < Command
-        def initialize(*argv)
-          @argv = argv
-
-          # Default to running things in the system context.
-          @context = :system
-
-          # Extra environment vars to add to base set.
-          @environment = {}
-        end
-
-        def register_spinner(_spinner, _opts = {})
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-
-        def add_spinner(_message, _opts = {})
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-
-        def timeout
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-
-        def timeout=(_val)
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-
-        def exec_group=(_val)
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-
-        def execute!
-          require 'pdk/util'
-
-          @resolved_env = resolved_env_for_command
-
-          if [:module, :pwd].include?(context)
-            mod_root = PDK::Util.module_root
-
-            unless mod_root
-              raise PDK::CLI::FatalError, _('Current working directory is not part of a module. (No metadata.json was found.)')
-            end
-
-            unless context == :pwd || Dir.pwd == mod_root
-              orig_workdir = Dir.pwd
-              Dir.chdir(mod_root)
-            end
-
-            result = run_process_in_clean_env!
-          else
-            result = run_process!
-          end
-
-          {
-            interactive: true,
-            stdout: nil,
-            stderr: nil,
-            exit_code: result[:exit_code],
-            duration: result[:duration],
-          }
-        ensure
-          Dir.chdir(orig_workdir) if orig_workdir
-        end
-
-        protected
-
-        # TODO: debug logging
-        def run_process!
-          command_string = argv.join(' ')
-          PDK.logger.debug(_("Executing '%{command}' interactively") % { command: command_string })
-
-          if context == :module
-            PDK.logger.debug(_('Command environment:'))
-            @resolved_env.each do |var, val|
-              PDK.logger.debug("  #{var}: #{val}")
-            end
-          end
-
-          start_time = Time.now
-
-          system(@resolved_env, *argv)
-
-          exit_code = child_status.exitstatus
-          duration = Time.now - start_time
-
-          PDK.logger.debug(_("Execution of '%{command}' complete (duration: \
-                              %{duration_in_seconds}s; exit code: %{exit_code})") %
-                              {
-                                command: command_string,
-                                exit_code: exit_code,
-                                duration_in_seconds: duration,
-                              })
-
-          { exit_code: exit_code, duration: duration }
-        end
-
-        def child_status
-          require 'English'
-
-          $CHILD_STATUS
-        end
-
-        def stop_spinner
-          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    module Exec
+      class InteractiveCommand < Command
+        def initialize(*argv)
+          @argv = argv
+
+          # Default to running things in the system context.
+          @context = :system
+
+          # Extra environment vars to add to base set.
+          @environment = {}
+        end
+
+        def register_spinner(_spinner, _opts = {})
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def add_spinner(_message, _opts = {})
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def timeout
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def timeout=(_val)
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def exec_group=(_val)
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def execute!
+          require 'pdk/util'
+
+          @resolved_env = resolved_env_for_command
+
+          if [:module, :pwd].include?(context)
+            mod_root = PDK::Util.module_root
+
+            unless mod_root
+              raise PDK::CLI::FatalError, _('Current working directory is not part of a module. (No metadata.json was found.)')
+            end
+
+            unless context == :pwd || Dir.pwd == mod_root
+              orig_workdir = Dir.pwd
+              Dir.chdir(mod_root)
+            end
+
+            result = run_process_in_clean_env!
+          else
+            result = run_process!
+          end
+
+          {
+            interactive: true,
+            stdout: nil,
+            stderr: nil,
+            exit_code: result[:exit_code],
+            duration: result[:duration],
+          }
+        ensure
+          Dir.chdir(orig_workdir) if orig_workdir
+        end
+
+        protected
+
+        # TODO: debug logging
+        def run_process!
+          command_string = argv.join(' ')
+          PDK.logger.debug(_("Executing '%{command}' interactively") % { command: command_string })
+
+          if context == :module
+            PDK.logger.debug(_('Command environment:'))
+            @resolved_env.each do |var, val|
+              PDK.logger.debug("  #{var}: #{val}")
+            end
+          end
+
+          start_time = Time.now
+
+          system(@resolved_env, *argv)
+
+          exit_code = child_status.exitstatus
+          duration = Time.now - start_time
+
+          PDK.logger.debug(_("Execution of '%{command}' complete (duration: \
+                              %{duration_in_seconds}s; exit code: %{exit_code})") %
+                              {
+                                command: command_string,
+                                exit_code: exit_code,
+                                duration_in_seconds: duration,
+                              })
+
+          { exit_code: exit_code, duration: duration }
+        end
+
+        def child_status
+          require 'English'
+
+          $CHILD_STATUS
+        end
+
+        def stop_spinner
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/exec.rb

@@ -1,84 +1,84 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    module Exec
-      autoload :Command, 'pdk/cli/exec/command'
-      autoload :InteractiveCommand, 'pdk/cli/exec/interactive_command'
-
-      def self.execute(*cmd)
-        require 'pdk/cli/exec/command'
-
-        Command.new(*cmd).execute!
-      end
-
-      def self.execute_with_env(env, *cmd)
-        require 'pdk/cli/exec/command'
-
-        Command.new(*cmd).tap { |c| c.environment = env }.execute!
-      end
-
-      def self.execute_interactive(*cmd)
-        require 'pdk/cli/exec/interactive_command'
-
-        InteractiveCommand.new(*cmd).execute!
-      end
-
-      def self.execute_interactive_with_env(env, *cmd)
-        require 'pdk/cli/exec/interactive_command'
-
-        InteractiveCommand.new(*cmd).tap { |c| c.environment = env }.execute!
-      end
-
-      def self.ensure_bin_present!(bin_path, bin_name)
-        require 'tty-which'
-
-        message = _('Unable to find `%{name}`. Check that it is installed and try again.') % {
-          name: bin_name,
-        }
-
-        raise PDK::CLI::FatalError, message unless TTY::Which.exist?(bin_path)
-      end
-
-      def self.bundle(*args)
-        ensure_bin_present!(bundle_bin, 'bundler')
-
-        execute(bundle_bin, *args)
-      end
-
-      def self.bundle_bin
-        require 'pdk/util/ruby_version'
-
-        bundle_bin = Gem.win_platform? ? 'bundle.bat' : 'bundle'
-        vendored_bin_path = File.join('private', 'ruby', PDK::Util::RubyVersion.active_ruby_version, 'bin', bundle_bin)
-
-        try_vendored_bin(vendored_bin_path, bundle_bin)
-      end
-
-      def self.try_vendored_bin(vendored_bin_path, fallback)
-        require 'pdk/util'
-
-        unless PDK::Util.package_install?
-          PDK.logger.debug(_("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.") % {
-            fallback: fallback,
-          })
-          return fallback
-        end
-
-        vendored_bin_full_path = File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
-
-        require 'pdk/util/filesystem'
-        unless PDK::Util::Filesystem.exist?(vendored_bin_full_path)
-          PDK.logger.debug(_("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % {
-            fallback: fallback,
-            vendored_bin: vendored_bin_full_path,
-          })
-          return fallback
-        end
-
-        PDK.logger.debug(_("Using '%{vendored_bin}' from PDK package.") % { vendored_bin: vendored_bin_full_path })
-        vendored_bin_full_path
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    module Exec
+      autoload :Command, 'pdk/cli/exec/command'
+      autoload :InteractiveCommand, 'pdk/cli/exec/interactive_command'
+
+      def self.execute(*cmd)
+        require 'pdk/cli/exec/command'
+
+        Command.new(*cmd).execute!
+      end
+
+      def self.execute_with_env(env, *cmd)
+        require 'pdk/cli/exec/command'
+
+        Command.new(*cmd).tap { |c| c.environment = env }.execute!
+      end
+
+      def self.execute_interactive(*cmd)
+        require 'pdk/cli/exec/interactive_command'
+
+        InteractiveCommand.new(*cmd).execute!
+      end
+
+      def self.execute_interactive_with_env(env, *cmd)
+        require 'pdk/cli/exec/interactive_command'
+
+        InteractiveCommand.new(*cmd).tap { |c| c.environment = env }.execute!
+      end
+
+      def self.ensure_bin_present!(bin_path, bin_name)
+        require 'tty-which'
+
+        message = _('Unable to find `%{name}`. Check that it is installed and try again.') % {
+          name: bin_name,
+        }
+
+        raise PDK::CLI::FatalError, message unless TTY::Which.exist?(bin_path)
+      end
+
+      def self.bundle(*args)
+        ensure_bin_present!(bundle_bin, 'bundler')
+
+        execute(bundle_bin, *args)
+      end
+
+      def self.bundle_bin
+        require 'pdk/util/ruby_version'
+
+        bundle_bin = Gem.win_platform? ? 'bundle.bat' : 'bundle'
+        vendored_bin_path = File.join('private', 'ruby', PDK::Util::RubyVersion.active_ruby_version, 'bin', bundle_bin)
+
+        try_vendored_bin(vendored_bin_path, bundle_bin)
+      end
+
+      def self.try_vendored_bin(vendored_bin_path, fallback)
+        require 'pdk/util'
+
+        unless PDK::Util.package_install?
+          PDK.logger.debug(_("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.") % {
+            fallback: fallback,
+          })
+          return fallback
+        end
+
+        vendored_bin_full_path = File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
+
+        require 'pdk/util/filesystem'
+        unless PDK::Util::Filesystem.exist?(vendored_bin_full_path)
+          PDK.logger.debug(_("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % {
+            fallback: fallback,
+            vendored_bin: vendored_bin_full_path,
+          })
+          return fallback
+        end
+
+        PDK.logger.debug(_("Using '%{vendored_bin}' from PDK package.") % { vendored_bin: vendored_bin_full_path })
+        vendored_bin_full_path
+      end
+    end
+  end
+end

data/lib/pdk/cli/exec_group.rb

@@ -1,104 +1,104 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    class ExecGroup
-      # Execution Group (ExecGroup) factory.
-      #
-      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
-      #
-      # @param create_options [Hash] A hash options used during creation of the ExecGroup.  This are not passed to the new object
-      # @option create_options :parallel [Boolean] Whether the group should be executed in Parallel (True) or Serial (False)
-      #
-      # @param group_opts [Hash] A hash of options used to configure the execution group.  Provided for backwards compatibility during refactor
-      #
-      # @return [ExecGroup]
-      def self.create(message, create_options = {}, group_opts = {})
-        if create_options[:parallel]
-          ParallelExecGroup.new(message, group_opts)
-        else
-          SerialExecGroup.new(message, group_opts)
-        end
-      end
-
-      # Base class for an Exection Group
-      #
-      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
-      #
-      # @param opts [Hash] A hash of options used to configure the execution group. Provided for backwards compatibility during refactor
-      #
-      # @api private
-      def initialize(_message, opts = {})
-        @options = opts
-      end
-
-      # Register something to execute as a group
-      #
-      # @param block [Block] A block of ruby to execute
-      #
-      # @api private
-      def register(&_block)
-        raise PDK::CLI::FatalError, _('No block registered') unless block_given?
-      end
-
-      # The return code of running all registered blocks
-      #
-      # @return [int] The highest exit code from the blocks
-      #
-      # @abstract
-      def exit_code; end
-    end
-
-    # Executes registered blocks in serial
-    #
-    # @see PDK::CLI::ExecGroup
-    class SerialExecGroup < ExecGroup
-      def initialize(message, opts = {})
-        super(message, opts)
-        @procs = []
-      end
-
-      def register(&block)
-        super(&block)
-
-        @procs << block
-      end
-
-      def exit_code
-        exit_codes = @procs.map(&:call)
-        exit_codes.nil? ? 0 : exit_codes.max
-      end
-    end
-
-    # Executes registered blocks in parallel using Ruby threads
-    #
-    # @see PDK::CLI::ExecGroup
-    class ParallelExecGroup < ExecGroup
-      def initialize(message, opts = {})
-        super(message, opts)
-        @threads = []
-        @exit_codes = []
-      end
-
-      def register(&block)
-        super(&block)
-
-        # TODO: This executes the thread immediately, whereas the SerialExecGroup executes only when exit_code
-        # is called.  Need to change this so it uses a kind of ThreadPool to limit to number on concurrent jobs
-        # and only starts on the call to exit_code
-        # e.g. max_threads = No. of CPUs
-        @threads << Thread.new do
-          GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
-          GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
-          @exit_codes << yield
-        end
-      end
-
-      def exit_code
-        @threads.each(&:join)
-        return 0 if @exit_codes.empty?
-        @exit_codes.max
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    class ExecGroup
+      # Execution Group (ExecGroup) factory.
+      #
+      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
+      #
+      # @param create_options [Hash] A hash options used during creation of the ExecGroup.  This are not passed to the new object
+      # @option create_options :parallel [Boolean] Whether the group should be executed in Parallel (True) or Serial (False)
+      #
+      # @param group_opts [Hash] A hash of options used to configure the execution group.  Provided for backwards compatibility during refactor
+      #
+      # @return [ExecGroup]
+      def self.create(message, create_options = {}, group_opts = {})
+        if create_options[:parallel]
+          ParallelExecGroup.new(message, group_opts)
+        else
+          SerialExecGroup.new(message, group_opts)
+        end
+      end
+
+      # Base class for an Exection Group
+      #
+      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
+      #
+      # @param opts [Hash] A hash of options used to configure the execution group. Provided for backwards compatibility during refactor
+      #
+      # @api private
+      def initialize(_message, opts = {})
+        @options = opts
+      end
+
+      # Register something to execute as a group
+      #
+      # @param block [Block] A block of ruby to execute
+      #
+      # @api private
+      def register(&_block)
+        raise PDK::CLI::FatalError, _('No block registered') unless block_given?
+      end
+
+      # The return code of running all registered blocks
+      #
+      # @return [int] The highest exit code from the blocks
+      #
+      # @abstract
+      def exit_code; end
+    end
+
+    # Executes registered blocks in serial
+    #
+    # @see PDK::CLI::ExecGroup
+    class SerialExecGroup < ExecGroup
+      def initialize(message, opts = {})
+        super(message, opts)
+        @procs = []
+      end
+
+      def register(&block)
+        super(&block)
+
+        @procs << block
+      end
+
+      def exit_code
+        exit_codes = @procs.map(&:call)
+        exit_codes.nil? ? 0 : exit_codes.max
+      end
+    end
+
+    # Executes registered blocks in parallel using Ruby threads
+    #
+    # @see PDK::CLI::ExecGroup
+    class ParallelExecGroup < ExecGroup
+      def initialize(message, opts = {})
+        super(message, opts)
+        @threads = []
+        @exit_codes = []
+      end
+
+      def register(&block)
+        super(&block)
+
+        # TODO: This executes the thread immediately, whereas the SerialExecGroup executes only when exit_code
+        # is called.  Need to change this so it uses a kind of ThreadPool to limit to number on concurrent jobs
+        # and only starts on the call to exit_code
+        # e.g. max_threads = No. of CPUs
+        @threads << Thread.new do
+          GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
+          GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
+          @exit_codes << yield
+        end
+      end
+
+      def exit_code
+        @threads.each(&:join)
+        return 0 if @exit_codes.empty?
+        @exit_codes.max
+      end
+    end
+  end
+end

data/lib/pdk/cli/get/config.rb

@@ -1,24 +1,24 @@
-module PDK::CLI
-  @get_config_cmd = @get_cmd.define_command do
-    name 'config'
-    usage _('config [name]')
-    summary _('Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
-
-    run do |_opts, args, _cmd|
-      item_name = args[0]
-      resolved_config = PDK.config.resolve(item_name)
-      # If the user wanted to know a setting but it doesn't exist, raise an error
-      if resolved_config.empty? && !item_name.nil?
-        PDK.logger.error(_("Configuration item '%{name}' does not exist") % { name: item_name })
-        exit 1
-      end
-      # If the user requested a setting and it's the only one resolved, then just output the value
-      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
-        puts _('%{value}') % { value: resolved_config.values[0] }
-        exit 0
-      end
-      # Otherwise just output everything
-      resolved_config.keys.sort.each { |key| puts _('%{name}=%{value}') % { name: key, value: resolved_config[key] } }
-    end
-  end
-end
+module PDK::CLI
+  @get_config_cmd = @get_cmd.define_command do
+    name 'config'
+    usage _('config [name]')
+    summary _('Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
+
+    run do |_opts, args, _cmd|
+      item_name = args[0]
+      resolved_config = PDK.config.resolve(item_name)
+      # If the user wanted to know a setting but it doesn't exist, raise an error
+      if resolved_config.empty? && !item_name.nil?
+        PDK.logger.error(_("Configuration item '%{name}' does not exist") % { name: item_name })
+        exit 1
+      end
+      # If the user requested a setting and it's the only one resolved, then just output the value
+      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
+        puts _('%{value}') % { value: resolved_config.values[0] }
+        exit 0
+      end
+      # Otherwise just output everything
+      resolved_config.keys.sort.each { |key| puts _('%{name}=%{value}') % { name: key, value: resolved_config[key] } }
+    end
+  end
+end