command_mapper 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84f3d9440979699163ef84f4fbc703cae8813a15e3fda52a7f7cb41fff1e2a0
-  data.tar.gz: 5bd3028c74eb09a4de384a9e09a9d43405883ae1cf3c1b8f74af0ba665d45c04
+  metadata.gz: 64e0cd16f2f829aa5175d24e251b13b0324459f9afedc5949177a877ac73bfee
+  data.tar.gz: 41f4d3aa749a5844797e6e7745eef6fda781ff4cc301b561913b48d3b3dfd25e
 SHA512:
-  metadata.gz: 0df6ae96d0550ca1ce3ab8e046538deefd6d5f2ecdd58bf8f99979c6f831c3a97acb1eff327a0c5595dfad6e7f1b88633a80175e8cdabd48bffca3c2e2be182b
-  data.tar.gz: 68c4bbc6a908940737e1f7d6cdb1467220f621fdbc60db72eb9acb261ad9bd9118afdb184bb040b4fb6951eedc009098224f3d8908a0989e0ddeafd1a94fe116
+  metadata.gz: f218287281e48ae82fb3feb4120279d5a7c28455213c160adde7d7aefd67874c542227cfd3584d60150711652679f7cc8b49d6b9b3d1fc4ab7630a6486cc8432
+  data.tar.gz: ec718ea345aede03c9720afc88aa9fbdec4c348a6771e60de2ae41e48a4f3780fa290f93886f7091416d60cfa35b74946111bc780552de4c69f3cf6ceca0b864

data/.github/workflows/ruby.yml

@@ -9,16 +9,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '2.6'
-          - '2.7'
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.yardopts

@@ -1 +1 @@
---markup markdown --title "CommandMapper Documentation" --protected --quiet
+--markup markdown --title "CommandMapper Documentation" --protected

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.3.2 / 2024-01-23
+
+* Switch to use `require_relative` to improve load-times.
+* Allow passing `sudo` specific keyword arguments in
+  {CommandMapper::Command#sudo_command} to {CommandMapper::Sudo.run}.
+* Allow {CommandMapper::Sudo}'s `preserve_env` attribute to accept an optional
+  value.
+
 ### 0.3.1 / 2022-12-25
 
 * Use `File.exist?` in {CommandMapper::Types::InputPath#validate} for Ruby

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021-2022 Hal Brodigan
+Copyright (c) 2021-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -353,6 +353,41 @@ Grep.sudo(patterns: "Error", file: "/var/log/syslog")
 # ...
 ```
 
+### Defining sub-commands
+
+```ruby
+module Git
+  class Command < CommandMapper::Command
+
+    command 'git' do
+      option "--version"
+      option "--help"
+      option "-C", name: :dir, value: {type: InputDir.new}
+      # ...
+
+      subcommand :clone do
+        option "--bare"
+        option "--mirror"
+        option "--depth", value: {type: Num.new}
+        # ...
+
+        argument :repository
+        argument :directory, required: false
+      end
+
+      # ...
+    end
+
+  end
+end
+```
+
+### Invoking sub-commands
+
+```ruby
+Git::Command.run(clone: {repository: 'https://github.com/user/repo.git'})
+```
+
 ### Code Gen
 
 [command_mapper-gen] can automatically generate command classes from a command's
@@ -390,6 +425,18 @@ class Cat < CommandMapper::Command
 end
 ```
 
+### Real-World Examples
+
+* [ruby-nmap](https://github.com/postmodern/ruby-nmap#readme)
+* [ruby-masscan](https://github.com/postmodern/ruby-masscan#readme)
+* [ruby-amass](https://github.com/postmodern/ruby-amass#readme)
+* [ruby-yasm](https://github.com/postmodern/ruby-yasm#readme)
+* [ruby-ncrack](https://github.com/postmodern/ruby-ncrack#readme)
+* [ruby-nikto](https://github.com/postmodern/ruby-nikto#readme)
+* [ruby-gobuster](https://github.com/postmodern/ruby-gobuster#readme)
+* [ruby-feroxbuster](https://github.com/postmodern/ruby-feroxbuster#readme)
+* [ruby-rustscan](https://github.com/postmodern/ruby-rustscan#readme)
+
 ## Requirements
 
 * [ruby] >= 2.0.0
@@ -412,6 +459,10 @@ gem 'command_mapper', '~> 0.2'
 gemspec.add_dependency 'command_mapper', '~> 0.2'
 ```
 
+## Alternatives
+
+* [terrapin](https://github.com/thoughtbot/terrapin#readme)
+
 ## License
 
 Copyright (c) 2021-2022 Hal Brodigan

data/command_mapper.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'command_mapper/version'
+                  require_relative 'lib/command_mapper/version'
                   CommandMapper::VERSION
                 end
 

data/gemspec.yml

@@ -14,7 +14,7 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/command_mapper
   source_code_uri:   https://github.com/postmodern/command_mapper.rb
   bug_tracker_uri:   https://github.com/postmodern/command_mapper.rb/issues
-  changelog_uri:     https://github.com/postmodern/command_mapper.rb/blob/master/ChangeLog.md
+  changelog_uri:     https://github.com/postmodern/command_mapper.rb/blob/main/ChangeLog.md
   rubygems_mfa_required: 'true'
 
 required_ruby_version: ">= 2.0.0"

data/lib/command_mapper/arg.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/types/type'
-require 'command_mapper/types/str'
+require_relative 'types/type'
+require_relative 'types/str'
 
 module CommandMapper
   #

data/lib/command_mapper/argument.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/exceptions'
-require 'command_mapper/arg'
+require_relative 'exceptions'
+require_relative 'arg'
 
 module CommandMapper
   #

data/lib/command_mapper/command.rb

@@ -1,6 +1,6 @@
-require 'command_mapper/types'
-require 'command_mapper/argument'
-require 'command_mapper/option'
+require_relative 'types'
+require_relative 'argument'
+require_relative 'option'
 
 require 'shellwords'
 
@@ -50,8 +50,8 @@ module CommandMapper
     #   Custom environment variables to pass to the command.
     #
     # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keywords arguments. These will be used to populate
-    #   {#options} and {#arguments}, along with `params`.
+    #   Additional keywords arguments. These will be used to populate the
+    #   command's `params`.
     #
     # @yield [self]
     #   The newly initialized command.
@@ -92,8 +92,8 @@ module CommandMapper
     #   The option and argument values.
     #
     # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keywords arguments. These will be used to populate
-    #   {#options} and {#arguments}, along with `params`.
+    #   Additional keywords arguments. These will be used to populate the
+    #   command's `params`.
     #
     # @yield [command]
     #   The newly initialized command.
@@ -115,8 +115,8 @@ module CommandMapper
     #   The option and argument values.
     #
     # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keywords arguments. These will be used to populate
-    #   {#options} and {#arguments}, along with `params`.
+    #   Additional keywords arguments. These will be used to populate the
+    #   command's `params`.
     #
     # @yield [command]
     #   The newly initialized command.
@@ -144,8 +144,8 @@ module CommandMapper
     #   The option and argument values.
     #
     # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keywords arguments. These will be used to populate
-    #   {#options} and {#arguments}, along with `params`.
+    #   Additional keywords arguments. These will be used to populate the
+    #   command's `params`.
     #
     # @yield [command]
     #   The newly initialized command.
@@ -170,8 +170,8 @@ module CommandMapper
     #   The IO "mode" to open the IO pipe in.
     #
     # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keywords arguments. These will be used to populate
-    #   {#options} and {#arguments}, along with `params`.
+    #   Additional keywords arguments. These will be used to populate the
+    #   command's `params`.
     #
     # @yield [command]
     #   The newly initialized command.
@@ -191,6 +191,78 @@ module CommandMapper
     # @param [Hash{Symbol => Object}] params
     #   The option and argument values.
     #
+    # @param [Hash{Symbol => Object}] sudo
+    #   Additional `sudo` options.
+    #
+    # @option sudo [Boolean] :askpass
+    #   Enables the `--askpass` `sudo` option.
+    #
+    # @option sudo [Boolean] :background
+    #   Enables the `--background` `sudo` option
+    #
+    # @option sudo [Boolean] :bell
+    #   Enables the `--bell` `sudo` option
+    #
+    # @option sudo [Integer] :close_from
+    #   Enables the `--close-from=...` `sudo` option
+    #
+    # @option sudo [String] :chdir
+    #   Enables the `--chdir=...` `sudo` option
+    #
+    # @option sudo [String] :preserve_env
+    #   Enables the `--preseve-env=...` `sudo` option
+    #
+    # @option sudo [String, Boolean] :group
+    #   Enables the `--preseve-env=...` `sudo` option
+    #
+    # @option sudo [Boolean] :set_home
+    #   Enables the `--set-home` `sudo` option
+    #
+    # @option sudo [String] :host
+    #   Enables the `--host=...` `sudo` option
+    #
+    # @option sudo [Boolean] :login
+    #   Enables the `--login` `sudo` option
+    #
+    # @option sudo [Boolean] :remove_timestamp
+    #   Enables the `--remove-timestamp` `sudo` option
+    #
+    # @option sudo [Boolean] :reset_timestamp
+    #   Enables the `--reset-timestamp` `sudo` option
+    #
+    # @option sudo [Boolean] :non_interactive
+    #   Enables the `--non-interactive` `sudo` option
+    #
+    # @option sudo [Boolean] :preserve_groups
+    #   Enables the `--preserve-groups` `sudo` option
+    #
+    # @option sudo [String] :prompt
+    #   Enables the `--prompt=...` `sudo` option
+    #
+    # @option sudo [String] :chroot
+    #   Enables the `--chroot=...` `sudo` option
+    #
+    # @option sudo [String] :role
+    #   Enables the `--role=...` `sudo` option
+    #
+    # @option sudo [Boolean] :stdin
+    #   Enables the `--stdin` `sudo` option
+    #
+    # @option sudo [Boolean] :shell
+    #   Enables the `--shell` `sudo` option
+    #
+    # @option sudo [String] :type
+    #   Enables the `--type=...` `sudo` option
+    #
+    # @option sudo [Integer] :command_timeout
+    #   Enables the `--command-timeout=...` `sudo` option
+    #
+    # @option sudo [String] :other_user
+    #   Enables the `--other-user=...` `sudo` option
+    #
+    # @option sudo [String] :user
+    #   Enables the `--user=...` `sudo` option
+    #
     # @param [Hash{Symbol => Object}] kwargs
     #   Additional keyword arguments for {#initialize}.
     #
@@ -209,9 +281,6 @@ module CommandMapper
     #
     # Gets or sets the command name.
     #
-    # @param [#to_s] new_name
-    #   The optional new command name.
-    #
     # @return [String]
     #   The command name.
     #
@@ -711,15 +780,127 @@ module CommandMapper
     #
     # Runs the command through `sudo`.
     #
-    # @param [Hash{Symbol => Object}] sudo_params
-    #   Additional keyword arguments for {Sudo#initialize}.
+    # @param [Boolean] askpass
+    #   Enables the `--askpass` `sudo` option.
+    #
+    # @param [Boolean] background
+    #   Enables the `--background` `sudo` option
+    #
+    # @param [Boolean] bell
+    #   Enables the `--bell` `sudo` option
+    #
+    # @param [Integer] close_from
+    #   Enables the `--close-from=...` `sudo` option
+    #
+    # @param [String] chdir
+    #   Enables the `--chdir=...` `sudo` option
+    #
+    # @param [String] preserve_env
+    #   Enables the `--preseve-env=...` `sudo` option
+    #
+    # @param [String, Boolean] group
+    #   Enables the `--preseve-env=...` `sudo` option
+    #
+    # @param [Boolean] set_home
+    #   Enables the `--set-home` `sudo` option
+    #
+    # @param [String] host
+    #   Enables the `--host=...` `sudo` option
+    #
+    # @param [Boolean] login
+    #   Enables the `--login` `sudo` option
+    #
+    # @param [Boolean] remove_timestamp
+    #   Enables the `--remove-timestamp` `sudo` option
+    #
+    # @param [Boolean] reset_timestamp
+    #   Enables the `--reset-timestamp` `sudo` option
+    #
+    # @param [Boolean] non_interactive
+    #   Enables the `--non-interactive` `sudo` option
+    #
+    # @param [Boolean] preserve_groups
+    #   Enables the `--preserve-groups` `sudo` option
+    #
+    # @param [String] prompt
+    #   Enables the `--prompt=...` `sudo` option
+    #
+    # @param [String] chroot
+    #   Enables the `--chroot=...` `sudo` option
+    #
+    # @param [String] role
+    #   Enables the `--role=...` `sudo` option
+    #
+    # @param [Boolean] stdin
+    #   Enables the `--stdin` `sudo` option
+    #
+    # @param [Boolean] shell
+    #   Enables the `--shell` `sudo` option
+    #
+    # @param [String] type
+    #   Enables the `--type=...` `sudo` option
+    #
+    # @param [Integer] command_timeout
+    #   Enables the `--command-timeout=...` `sudo` option
+    #
+    # @param [String] other_user
+    #   Enables the `--other-user=...` `sudo` option
+    #
+    # @param [String] user
+    #   Enables the `--user=...` `sudo` option
     #
     # @return [Boolean, nil]
     #   Indicates whether the command exited successfully or not.
     #   `nil` indicates the command could not be found.
     #
-    def sudo_command(**sudo_kwargs,&block)
-      sudo_params = sudo_kwargs.merge(command: command_argv)
+    def sudo_command(askpass: nil,
+                     background: nil,
+                     bell: nil,
+                     close_from: nil,
+                     chdir: nil,
+                     preserve_env: nil,
+                     group: nil,
+                     set_home: nil,
+                     host: nil,
+                     login: nil,
+                     remove_timestamp: nil,
+                     reset_timestamp: nil,
+                     non_interactive: nil,
+                     preserve_groups: nil,
+                     prompt: nil,
+                     chroot: nil,
+                     role: nil,
+                     stdin: nil,
+                     shell: nil,
+                     type: nil,
+                     command_timeout: nil,
+                     other_user: nil,
+                     user: nil, &block)
+      sudo_params = {command: command_argv}
+
+      sudo_params[:askpass]          = askpass          unless askpass.nil?
+      sudo_params[:background]       = background       unless background.nil?
+      sudo_params[:bell]             = bell             unless bell.nil?
+      sudo_params[:close_from]       = close_from       unless close_from.nil?
+      sudo_params[:chdir]            = chdir            unless chdir.nil?
+      sudo_params[:preserve_env]     = preserve_env     unless preserve_env.nil?
+      sudo_params[:group]            = group            unless group.nil?
+      sudo_params[:set_home]         = set_home         unless set_home.nil?
+      sudo_params[:host]             = host             unless host.nil?
+      sudo_params[:login]            = login            unless login.nil?
+      sudo_params[:remove_timestamp] = remove_timestamp unless remove_timestamp.nil?
+      sudo_params[:reset_timestamp]  = reset_timestamp  unless reset_timestamp.nil?
+      sudo_params[:non_interactive]  = non_interactive  unless non_interactive.nil?
+      sudo_params[:preserve_groups]  = preserve_groups  unless preserve_groups.nil?
+      sudo_params[:prompt]           = prompt           unless prompt.nil?
+      sudo_params[:chroot]           = chroot           unless chroot.nil?
+      sudo_params[:role]             = role             unless role.nil?
+      sudo_params[:stdin]            = stdin            unless stdin.nil?
+      sudo_params[:shell]            = shell            unless shell.nil?
+      sudo_params[:type]             = type             unless type.nil?
+      sudo_params[:command_timeout]  = command_timeout  unless command_timeout.nil?
+      sudo_params[:other_user]       = other_user       unless other_user.nil?
+      sudo_params[:user]             = user             unless user.nil?
 
       Sudo.run(sudo_params, command_env: @command_env, &block)
     end

data/lib/command_mapper/option.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/exceptions'
-require 'command_mapper/option_value'
+require_relative 'exceptions'
+require_relative 'option_value'
 
 module CommandMapper
   #

data/lib/command_mapper/option_value.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/arg'
+require_relative 'arg'
 
 module CommandMapper
   #

data/lib/command_mapper/sudo.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/command'
-require 'command_mapper/types/key_value_list'
+require_relative 'command'
+require_relative 'types/key_value_list'
 
 module CommandMapper
   #
@@ -7,7 +7,7 @@ module CommandMapper
   #
   # ## Sudo options:
   #
-  # * `-A` - `sudo.ask_password`
+  # * `-A` - `sudo.askpass`
   # * `-b` - `sudo.background`
   # * `-C` - `sudo.close_from`
   # * `-E` - `sudo.preserve_env`
@@ -40,9 +40,9 @@ module CommandMapper
       option "--askpass"
       option "--background"
       option "--bell"
-      option "--close-from", equals: true, value: true
-      option "--chdir", equals: true, value: true
-      option "--preserve-env", equals: true, value: true
+      option "--close-from", equals: true, value: {type: Num.new}
+      option "--chdir", equals: true, value: {type: InputDir.new}
+      option "--preserve-env", equals: true, value: {type: List.new, required: false}
       option "--edit"
       option "--group", equals: true, value: true
       option "--set-home"
@@ -55,12 +55,12 @@ module CommandMapper
       option "--non-interactive"
       option "--preserve-groups"
       option "--prompt", equals: true, value: true
-      option "--chroot", equals: true, value: true
+      option "--chroot", equals: true, value: {type: InputDir.new}
       option "--role", equals: true, value: true
       option "--stdin"
       option "--shell"
       option "--type", equals: true, value: true
-      option "--command-timeout", equals: true, value: true
+      option "--command-timeout", equals: true, value: {type: Num.new}
       option "--other-user", equals: true, value: true
       option "--user", equals: true, value: true
       option "--version"

data/lib/command_mapper/types/dec.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/type'
+require_relative 'type'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/enum.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/map'
+require_relative 'map'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/hex.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/num'
+require_relative 'num'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/input_dir.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/input_path'
+require_relative 'input_path'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/input_file.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/input_path'
+require_relative 'input_path'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/input_path.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/type'
+require_relative 'type'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/key_value.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/types/type'
-require 'command_mapper/types/str'
+require_relative 'type'
+require_relative 'str'
 
 module CommandMapper
   module Types
@@ -41,9 +41,6 @@ module CommandMapper
       # @param [Type, Hash] value
       #   The value's value type.
       #
-      # @param [Hash{Symbol => Object}]
-      #   Additional keyword arguments for {Type#initialize}.
-      #
       def initialize(separator: '=', key: Str.new, value: Str.new)
         @separator = separator
 

data/lib/command_mapper/types/key_value_list.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/types/list'
-require 'command_mapper/types/key_value'
+require_relative 'list'
+require_relative 'key_value'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/list.rb

@@ -1,5 +1,5 @@
-require 'command_mapper/types/type'
-require 'command_mapper/types/str'
+require_relative 'type'
+require_relative 'str'
 
 module CommandMapper
   module Types
@@ -28,17 +28,19 @@ module CommandMapper
       # @param [String] separator
       #   The list separator character.
       #
-      # @param [Type, Hash] value
+      # @param [Type, Hash] type 
       #   The list's value type.
       #
+      # @param [Boolean] allow_empty
+      #   Specifies whether the list type will accept empty values.
+      #
       def initialize(separator: ',', type: Str.new, allow_empty: false)
         if type.nil?
           raise(ArgumentError,"type: keyword cannot be nil")
         end
 
-        @separator = separator
-        @type      = Types::Type(type)
-
+        @separator   = separator
+        @type        = Types::Type(type)
         @allow_empty = allow_empty
       end
 

data/lib/command_mapper/types/map.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/type'
+require_relative 'type'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/num.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/type'
+require_relative 'type'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/str.rb

@@ -1,4 +1,4 @@
-require 'command_mapper/types/type'
+require_relative 'type'
 
 module CommandMapper
   module Types

data/lib/command_mapper/types/type.rb

@@ -57,7 +57,7 @@ module CommandMapper
       #
       # The default `validate` method for all types.
       #
-      # @param [Object]
+      # @param [Object] value
       #   The given value to validate.
       #
       # @return [true, (false, String)]

data/lib/command_mapper/types.rb

@@ -1,13 +1,13 @@
-require 'command_mapper/types/type'
-require 'command_mapper/types/str'
-require 'command_mapper/types/num'
-require 'command_mapper/types/dec'
-require 'command_mapper/types/hex'
-require 'command_mapper/types/map'
-require 'command_mapper/types/enum'
-require 'command_mapper/types/list'
-require 'command_mapper/types/key_value'
-require 'command_mapper/types/key_value_list'
-require 'command_mapper/types/input_path'
-require 'command_mapper/types/input_file'
-require 'command_mapper/types/input_dir'
+require_relative 'types/type'
+require_relative 'types/str'
+require_relative 'types/num'
+require_relative 'types/dec'
+require_relative 'types/hex'
+require_relative 'types/map'
+require_relative 'types/enum'
+require_relative 'types/list'
+require_relative 'types/key_value'
+require_relative 'types/key_value_list'
+require_relative 'types/input_path'
+require_relative 'types/input_file'
+require_relative 'types/input_dir'

data/lib/command_mapper/version.rb

@@ -1,4 +1,4 @@
 module CommandMapper
   # Version of command_mapper
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/command_mapper.rb

@@ -1,2 +1,2 @@
-require 'command_mapper/command'
-require 'command_mapper/version'
+require_relative 'command_mapper/command'
+require_relative 'command_mapper/version'

data/spec/commnad_spec.rb

@@ -1416,7 +1416,7 @@ describe CommandMapper::Command do
     end
   end
 
-  describe "#sudo!" do
+  describe "#sudo_command" do
     subject { command_class.new({opt1: opt1, arg1: arg1}, command_env: env) }
 
     let(:expected_argv) { [command_class.command, "--opt1", opt1, arg1] }
@@ -1426,6 +1426,43 @@ describe CommandMapper::Command do
 
       subject.sudo_command
     end
+
+    [
+      :askpass,
+      :background,
+      :bell,
+      :close_from,
+      :chdir,
+      :preserve_env,
+      :group,
+      :set_home,
+      :host,
+      :login,
+      :remove_timestamp,
+      :reset_timestamp,
+      :non_interactive,
+      :preserve_groups,
+      :prompt,
+      :chroot,
+      :role,
+      :stdin,
+      :shell,
+      :type,
+      :command_timeout,
+      :other_user,
+      :user,
+    ].each do |option|
+      context "when given the #{option}: keyword argument" do
+        let(:option) { option }
+        let(:value)  { true   }
+
+        it "must pass the #{option}: keyword argument to CommandMapper::Sudo" do
+          expect(Sudo).to receive(:run).with({option => value, :command => subject.command_argv}, :command_env => env)
+
+          subject.sudo_command(option => value)
+        end
+      end
+    end
   end
 
   describe "#to_s" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_mapper
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,7 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/command_mapper
   source_code_uri: https://github.com/postmodern/command_mapper.rb
   bug_tracker_uri: https://github.com/postmodern/command_mapper.rb/issues
-  changelog_uri: https://github.com/postmodern/command_mapper.rb/blob/master/ChangeLog.md
+  changelog_uri: https://github.com/postmodern/command_mapper.rb/blob/main/ChangeLog.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Safe and secure execution of commands.