command_kit 0.1.0 → 0.3.0

data/lib/command_kit/package_manager.rb

@@ -0,0 +1,200 @@
+require 'command_kit/os'
+require 'command_kit/os/linux'
+require 'command_kit/env/path'
+require 'command_kit/sudo'
+
+module CommandKit
+  #
+  # Allows installing packages using the system's package manager.
+  #
+  # Supports the following package managers:
+  #
+  # * Linux
+  #   * Debian / Ubuntu
+  #     * `apt`
+  #   * RedHat / Fedora
+  #     * `dnf`
+  #     * `yum`
+  #   * Arch
+  #     * `pacman`
+  #   * SUSE / OpenSUSE
+  #     * `zypper`
+  # * macOS
+  #   * `brew`
+  #   * `port`
+  # * FreeBSD
+  #   * `pkg`
+  # * OpenBSD
+  #   * `pkg_add`
+  #
+  # ## Examples
+  #
+  #     unless install_packages("nmap")
+  #       print_error "failed to install nmap"
+  #       exit -1
+  #     end
+  #
+  # ### Installing multiple packages
+  #
+  #     install_packages apt: ["libxml2-dev", ...],
+  #                      dnf: ["libxml2-devel", ...],
+  #                      brew: ["libxml2", ...],
+  #                      ...
+  #
+  # @since 0.2.0
+  #
+  module PackageManager
+    include OS
+    include OS::Linux
+    include Env::Path
+    include Sudo
+
+    # The detected package manager.
+    #
+    # @return [:apt, :dnf, :yum, :zypper, :pacman, :brew, :pkg, :pkg_add, nil]
+    attr_reader :package_manager
+
+    #
+    # Initializes the command and determines which open command to use.
+    #
+    # @param [:apt, :dnf, :yum, :zypper, :pacman, :brew, :pkg, :pkg_add, nil] package_manager
+    #   The explicit package manager to use. If `nil`, the package manager will
+    #   be detected.
+    #
+    def initialize(package_manager: nil, **kwargs)
+      super(**kwargs)
+
+      @package_manager = package_manager || begin
+        if macos?
+          if    command_installed?('brew') then :brew
+          elsif command_installed?('port') then :port
+          end
+        elsif linux?
+          if redhat_linux?
+            if    command_installed?('dnf') then :dnf
+            elsif command_installed?('yum') then :yum
+            end
+          elsif debian_linux?
+            :apt if command_installed?('apt')
+          elsif suse_linux?
+            :zypper if command_installed?('zypper')
+          elsif arch_linux?
+            :pacman if command_installed?('pacman')
+          end
+        elsif freebsd?
+          :pkg if command_installed?('pkg')
+        elsif openbsd?
+          :pkg_add if command_installed?('pkg_add')
+        end
+      end
+    end
+
+    #
+    # Installs the packages using the system's package manager.
+    #
+    # @param [Array<String>, String] packages
+    #   A list of package name(s) to install.
+    #
+    # @param [Boolean] yes
+    #   Assume yes for all user prompts.
+    #
+    # @param [Array<String>, String] apt
+    #   List of `apt` specific package names.
+    #
+    # @param [Array<String>, String] brew
+    #   List of `brew` specific package names.
+    #
+    # @param [Array<String>, String] dnf
+    #   List of `dnf` specific package names.
+    #
+    # @param [Array<String>, String] pacman
+    #   List of `pacman` specific package names.
+    #
+    # @param [Array<String>, String] pkg
+    #   List of `pkg` specific package names.
+    #
+    # @param [Array<String>, String] pkg_add
+    #   List of `pkg_add` specific package names.
+    #
+    # @param [Array<String>, String] port
+    #   List of `port` specific package names.
+    #
+    # @param [Array<String>, String] yum
+    #   List of `yum` specific package names.
+    #
+    # @param [Array<String>, String] zypper
+    #   List of `zypper` specific package names.
+    #
+    # @return [Boolean, nil]
+    #   Specifies whether the packages were successfully installed or not.
+    #   If the package manager command could not be determined, `nil` is
+    #   returned.
+    #
+    # @example Install a package
+    #   install_packages "nmap", ...
+    #
+    # @example Install a list of packages per package-manager
+    #   install_packages apt: ["libxml2-dev", ...],
+    #                    dnf: ["libxml2-devel", ...],
+    #                    brew: ["libxml2", ...],
+    #                    ...
+    #
+    def install_packages(*packages, yes: false,
+                                    apt: nil,
+                                    brew: nil,
+                                    dnf: nil,
+                                    pacman: nil,
+                                    pkg: nil,
+                                    pkg_add: nil,
+                                    port: nil,
+                                    yum: nil,
+                                    zypper: nil)
+      specific_package_names = case @package_manager
+                               when :apt     then apt
+                               when :brew    then brew
+                               when :dnf     then dnf
+                               when :pacman  then pacman
+                               when :pkg     then pkg
+                               when :pkg_add then pkg_add
+                               when :port    then port
+                               when :yum     then yum
+                               when :zypper  then zypper
+                               end
+      packages += Array(specific_package_names)
+
+      case @package_manager
+      when :apt
+        args = []
+        args << '-y' if yes
+
+        sudo('apt','install',*args,*packages)
+      when :brew
+        system('brew','install',*packages)
+      when :dnf, :yum
+        args = []
+        args << '-y' if yes
+
+        sudo(@package_manager.to_s,'install',*args,*packages)
+      when :pacman
+        missing_packages = `pacman -T #{Shellwords.shelljoin(packages)}`.split
+
+        if missing_packages.empty?
+          return true
+        end
+
+        sudo('pacman','-S',*missing_packages)
+      when :pkg
+        args = []
+        args << '-y' if yes
+
+        sudo('pkg','install',*args,*packages)
+      when :pkg_add
+        sudo('pkg_add',*packages)
+      when :port
+        sudo('port','install',*packages)
+      when :zypper
+        sudo('zypper','-n','in','-l',*packages)
+      end
+    end
+  end
+end

data/lib/command_kit/pager.rb

@@ -5,6 +5,8 @@ require 'command_kit/env/path'
 require 'command_kit/stdio'
 require 'command_kit/terminal'
 
+require 'shellwords'
+
 module CommandKit
   #
   # Allows opening a pager, such as `less` or `more`.
@@ -50,7 +52,7 @@ module CommandKit
     #   Keyword arguments.
     #
     # @note
-    #   Respects the `PAGER` env variable, or attemps to find `less` or
+    #   Respects the `PAGER` env variable, or attempts to find `less` or
     #   `more` by searching the `PATH` env variable.
     #
     # @api public
@@ -58,7 +60,7 @@ module CommandKit
     def initialize(**kwargs)
       super(**kwargs)
 
-      @pager = env.fetch('PAGER') do
+      @pager_command = env.fetch('PAGER') do
         PAGERS.find do |command|
           bin = command.split(' ',2).first
 
@@ -94,14 +96,14 @@ module CommandKit
     # @api public
     #
     def pager
-      if !stdout.tty? || @pager.nil?
+      if !stdout.tty? || @pager_command.nil?
         # fallback to stdout if the process does not have a terminal or we could
         # not find a suitable pager command.
         yield stdout
         return
       end
 
-      io  = IO.popen(@pager,'w')
+      io  = IO.popen(@pager_command,'w')
       pid = io.pid
 
       begin
@@ -144,5 +146,45 @@ module CommandKit
         stdout.puts(data)
       end
     end
+
+    #
+    # Pipes a command into the pager.
+    #
+    # @param [#to_s] command
+    #   The program or command to run.
+    #
+    # @param [Array<#to_s>] arguments
+    #   Additional arguments for the program.
+    #
+    # @return [Boolean]
+    #   Indicates whether the command exited successfully or not.
+    #
+    # @note
+    #   If multiple arguments are given, they will be shell-escaped and executed
+    #   as a single command.
+    #   If a single command is given, it will not be shell-escaped to allow
+    #   executing compound shell commands.
+    #
+    # @example Pipe a single command into the pager:
+    #   run_in_pager 'find', '.', '-name', '*.md'
+    # 
+    # @example Pipe a compound command into the pager:
+    #   run_in_pager "wc -l /path/to/wordlists/*.txt | sort -n"
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    #
+    def pipe_to_pager(command,*arguments)
+      if @pager_command
+        unless arguments.empty?
+          command = Shellwords.shelljoin([command, *arguments])
+        end
+
+        system("#{command} | #{@pager_command}")
+      else
+        system(command.to_s,*arguments.map(&:to_s))
+      end
+    end
   end
 end

data/lib/command_kit/printing/indent.rb

@@ -20,7 +20,7 @@ module CommandKit
     #
     module Indent
       #
-      # Initializes the indententation level to zero.
+      # Initializes the indentation level to zero.
       #
       def initialize(**kwargs)
         @indent = 0
@@ -40,7 +40,7 @@ module CommandKit
       #   increased.
       #
       # @return [Integer]
-      #   If no block is given, the indententation level will be returned.
+      #   If no block is given, the indentation level will be returned.
       #
       # @example
       #   puts "values:"
@@ -65,10 +65,10 @@ module CommandKit
       #
       def indent(n=2)
         if block_given?
+          original_indent = @indent
+
           begin
-            original_indent = @indent
             @indent += n
-
             yield
           ensure
             @indent = original_indent

data/lib/command_kit/printing.rb

@@ -9,7 +9,7 @@ module CommandKit
   module Printing
     include Stdio
 
-    # Platform independency new-line constant
+    # Platform independent new-line constant
     #
     # @return [String]
     #
@@ -23,12 +23,23 @@ module CommandKit
     #   The error message.
     #
     # @example
-    #   print_error "Error: invalid input"
+    #   print_error "error: invalid input"
+    #   # error: invalid input
+    #
+    # @example When CommandKit::CommandName is included:
+    #   print_error "invalid input"
+    #   # foo: invalid input
     #
     # @api public
     #
     def print_error(message)
-      stderr.puts message
+      if respond_to?(:command_name)
+        # if #command_name is available, prefix all error messages with it
+        stderr.puts "#{command_name}: #{message}"
+      else
+        # if #command_name is not available, just print the error message as-is
+        stderr.puts message
+      end
     end
 
     #

data/lib/command_kit/program_name.rb

@@ -60,5 +60,14 @@ module CommandKit
     def program_name
       self.class.program_name
     end
+
+    #
+    # @see #program_name
+    #
+    # @since 0.3.0
+    #
+    def command_name
+      program_name
+    end
   end
 end

data/lib/command_kit/sudo.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'command_kit/os'
+
+module CommandKit
+  #
+  # Allows running commands with `sudo`.
+  #
+  # @since 0.2.0
+  #
+  module Sudo
+    include OS
+
+    #
+    # Runs the command under sudo, if the user isn't already root.
+    #
+    # @param [String] command
+    #   The command to execute.
+    #
+    # @param [Array<String>] arguments
+    #   Additional arguments for the command.
+    #
+    # @return [Boolean, nil]
+    #   Specifies whether the command was successfully ran or not.
+    #
+    # @api public
+    #
+    def sudo(command,*arguments)
+      if windows?
+        system('runas','/user:administrator',command,*arguments)
+      else
+        if Process.uid == 0
+          system(command,*arguments)
+        else
+          system('sudo',command,*arguments)
+        end
+      end
+    end
+  end
+end

data/lib/command_kit/terminal.rb

@@ -71,6 +71,11 @@ module CommandKit
       IO.respond_to?(:console) && stdout.tty?
     end
 
+    #
+    # @since 0.2.0
+    #
+    alias tty? terminal?
+
     #
     # Returns the terminal object, if {Stdio#stdout stdout} is connected to a
     # terminal.

data/lib/command_kit/version.rb

@@ -1,4 +1,4 @@
 module CommandKit
   # command_kit version
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/spec/arguments/argument_spec.rb

@@ -126,7 +126,7 @@ describe CommandKit::Arguments::Argument do
       let(:repeats) { false }
 
       it "must return the usage name unchanged" do
-        expect(subject.usage).to eq("#{usage}")
+        expect(subject.usage).to eq(usage)
       end
     end
   end

data/spec/arguments_spec.rb

@@ -137,6 +137,56 @@ describe CommandKit::Arguments do
 
   subject { command_class.new }
 
+  describe "#main" do
+    module TestArguments
+      class TestCommand
+
+        include CommandKit::Arguments
+
+        argument :argument1, required: true,
+                             usage:    'ARG1',
+                             desc:     "Argument 1"
+
+        argument :argument2, required: false,
+                             usage:    'ARG2',
+                             desc:     "Argument 2"
+
+      end
+    end
+
+    let(:command_class) { TestArguments::TestCommand }
+
+    context "when given the correct number of arguments" do
+      let(:argv) { %w[arg1 arg2] }
+
+      it "must parse options before validating the number of arguments" do
+        expect {
+          expect(subject.main(argv)).to eq(0)
+        }.to_not output.to_stderr
+      end
+    end
+
+    context "when given fewer than the required number of arguments" do
+      let(:argv) { %w[] }
+
+      it "must print an error message and return 1" do
+        expect {
+          expect(subject.main(argv)).to eq(1)
+        }.to output("#{subject.command_name}: insufficient number of arguments.#{$/}").to_stderr
+      end
+    end
+
+    context "when given more than the total number of arguments" do
+      let(:argv) { %w[foo bar baz] }
+
+      it "must print an error message and return 1" do
+        expect {
+          expect(subject.main(argv)).to eq(1)
+        }.to output("#{subject.command_name}: too many arguments given.#{$/}").to_stderr
+      end
+    end
+  end
+
   describe "#help_arguments" do
     context "when #arguments returns {}" do
       module TestArguments
@@ -153,7 +203,7 @@ describe CommandKit::Arguments do
       end
     end
 
-    context "when #arguments returns an Array" do
+    context "when #arguments returns a Hash" do
       module TestArguments
         class MultipleArguments
           include CommandKit::Arguments
@@ -183,6 +233,39 @@ describe CommandKit::Arguments do
           ].join($/)
         ).to_stdout
       end
+
+      context "when one the argument has an Array for a description" do
+        module TestArguments
+          class MultiLineArgumentDescription
+            include CommandKit::Arguments
+
+            argument :foo, desc: "Foo option"
+            argument :bar, desc: [
+                                   "Bar option", 
+                                   "Line 2",
+                                   "Line 3"
+                                 ]
+            argument :baz, desc: "Baz option"
+          end
+        end
+
+        let(:command_class) { TestArguments::MultiLineArgumentDescription }
+
+        it "must print out each line of a multi-line argument description" do
+          expect { subject.help_arguments }.to output(
+            [
+              '',
+              "Arguments:",
+              "    #{foo_argument.usage.ljust(33)}#{foo_argument.desc}",
+              "    #{bar_argument.usage.ljust(33)}#{bar_argument.desc[0]}",
+              "    #{' '.ljust(33)}#{bar_argument.desc[1]}",
+              "    #{' '.ljust(33)}#{bar_argument.desc[2]}",
+              "    #{baz_argument.usage.ljust(33)}#{baz_argument.desc}",
+              ''
+            ].join($/)
+          ).to_stdout
+        end
+      end
     end
   end