command_kit 0.4.1 → 0.5.1

data/lib/command_kit/env/prefix.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+
+module CommandKit
+  module Env
+    #
+    # Methods related to the `PREFIX` environment variable.
+    #
+    # ## Environment Variables
+    #
+    # * `PREFIX` - The optional root prefix of the file-system.
+    #
+    # @since 0.5.0
+    #
+    module Prefix
+      include Env
+
+      # The root of the file-system.
+      #
+      # @return [String]
+      #   The `PREFIX` environment variable, or `/` if no `PREFIX` environment
+      #   variable is given.
+      attr_reader :root
+
+      #
+      # Initialize {#root} based on the `PREFIX` environment
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @api public
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @root = env.fetch('PREFIX','/')
+      end
+    end
+  end
+end

data/lib/command_kit/env/shell.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+
+module CommandKit
+  module Env
+    #
+    # Methods related to the `SHELL` environment variable.
+    #
+    # ## Environment Variables
+    #
+    # * `SHELL` - The current shell.
+    #
+    # @since 0.5.0
+    #
+    module Shell
+      include Env
+
+      # The current shell.
+      #
+      # @return [String, nil]
+      attr_reader :shell
+
+      # The current shell type.
+      #
+      # @return [:bash, :zsh, :fish, :dash, :mksh, :ksh, :tcsh, :csh, :sh, nil]
+      attr_reader :shell_type
+
+      #
+      # Initialize {#shell} and {#shell_type} based on the `SHELL` environment
+      # variable.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @api public
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @shell      = env['SHELL']
+        @shell_type = if @shell
+                        case File.basename(@shell)
+                        when /bash/ then :bash
+                        when /zsh/  then :zsh
+                        when /fish/ then :fish
+                        when /dash/ then :dash
+                        when /mksh/ then :mksh
+                        when /ksh/  then :ksh
+                        when /tcsh/ then :tcsh
+                        when /csh/  then :csh
+                        when /sh/   then :sh
+                        end
+                      end
+      end
+    end
+  end
+end

data/lib/command_kit/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Provides access to environment variables.

data/lib/command_kit/examples.rb

@@ -1,5 +1,7 @@
-require 'command_kit/help'
-require 'command_kit/command_name'
+# frozen_string_literal: true
+
+require_relative 'help'
+require_relative 'command_name'
 
 module CommandKit
   #

data/lib/command_kit/exception_handler.rb

@@ -1,5 +1,7 @@
-require 'command_kit/main'
-require 'command_kit/printing'
+# frozen_string_literal: true
+
+require_relative 'main'
+require_relative 'printing'
 
 module CommandKit
   #

data/lib/command_kit/file_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'erb'
 

data/lib/command_kit/help/man.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'command_kit/command_name'
-require 'command_kit/help'
-require 'command_kit/stdio'
-require 'command_kit/man'
+require_relative '../command_name'
+require_relative '../help'
+require_relative '../stdio'
+require_relative '../man'
 
 module CommandKit
   module Help

data/lib/command_kit/help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Defines a place-holder {Help#help help} method.

data/lib/command_kit/interactive.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'command_kit/stdio'
+require_relative 'stdio'
 
 module CommandKit
   #

data/lib/command_kit/main.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Defines a `main` method.

data/lib/command_kit/open_app.rb

@@ -1,5 +1,7 @@
-require 'command_kit/os'
-require 'command_kit/env/path'
+# frozen_string_literal: true
+
+require_relative 'os'
+require_relative 'env/path'
 
 module CommandKit
   #

data/lib/command_kit/options/option.rb

@@ -1,4 +1,6 @@
-require 'command_kit/options/option_value'
+# frozen_string_literal: true
+
+require_relative 'option_value'
 
 require 'optparse'
 require 'date'

data/lib/command_kit/options/option_value.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'command_kit/arguments/argument_value'
-require 'command_kit/inflector'
+require_relative '../arguments/argument_value'
+require_relative '../inflector'
 
 require 'optparse'
 require 'date'

data/lib/command_kit/options/parser.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'command_kit/main'
-require 'command_kit/usage'
-require 'command_kit/printing'
+require_relative '../main'
+require_relative '../usage'
+require_relative '../printing'
 
 require 'optparse'
 

data/lib/command_kit/options/quiet.rb

@@ -1,4 +1,6 @@
-require 'command_kit/options'
+# frozen_string_literal: true
+
+require_relative '../options'
 
 module CommandKit
   module Options

data/lib/command_kit/options/verbose.rb

@@ -1,4 +1,6 @@
-require 'command_kit/options'
+# frozen_string_literal: true
+
+require_relative '../options'
 
 module CommandKit
   module Options

data/lib/command_kit/options/version.rb

@@ -1,4 +1,6 @@
-require 'command_kit/options'
+# frozen_string_literal: true
+
+require_relative '../options'
 
 module CommandKit
   module Options

data/lib/command_kit/options.rb

@@ -1,6 +1,8 @@
-require 'command_kit/arguments'
-require 'command_kit/options/option'
-require 'command_kit/options/parser'
+# frozen_string_literal: true
+
+require_relative 'arguments'
+require_relative 'options/option'
+require_relative 'options/parser'
 
 module CommandKit
   #

data/lib/command_kit/os/linux.rb

@@ -1,4 +1,6 @@
-require 'command_kit/os'
+# frozen_string_literal: true
+
+require_relative '../os'
 
 module CommandKit
   module OS

data/lib/command_kit/os.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Provides methods for determining the current OS.

data/lib/command_kit/package_manager.rb

@@ -1,7 +1,9 @@
-require 'command_kit/os'
-require 'command_kit/os/linux'
-require 'command_kit/env/path'
-require 'command_kit/sudo'
+# frozen_string_literal: true
+
+require_relative 'os'
+require_relative 'os/linux'
+require_relative 'env/path'
+require_relative 'sudo'
 
 module CommandKit
   #

data/lib/command_kit/pager.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'command_kit/env'
-require 'command_kit/env/path'
-require 'command_kit/stdio'
-require 'command_kit/terminal'
+require_relative 'env'
+require_relative 'env/path'
+require_relative 'stdio'
+require_relative 'terminal'
 
 require 'shellwords'
 

data/lib/command_kit/printing/fields.rb

@@ -1,4 +1,6 @@
-require 'command_kit/printing/indent'
+# frozen_string_literal: true
+
+require_relative 'indent'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing/indent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   module Printing
     #

data/lib/command_kit/printing/lists.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'command_kit/printing/indent'
+require_relative 'indent'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing/tables/border_style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   module Printing
     module Tables

data/lib/command_kit/printing/tables/row_builder.rb

@@ -1,4 +1,6 @@
-require 'command_kit/printing/tables/cell_builder'
+# frozen_string_literal: true
+
+require_relative 'cell_builder'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing/tables/style.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'command_kit/printing/tables/border_style'
+require_relative 'border_style'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing/tables/table_builder.rb

@@ -1,4 +1,6 @@
-require 'command_kit/printing/tables/row_builder'
+# frozen_string_literal: true
+
+require_relative 'row_builder'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing/tables.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'command_kit/printing/indent'
-require 'command_kit/printing/tables/table_builder'
-require 'command_kit/printing/tables/style'
-require 'command_kit/printing/tables/table_formatter'
+require_relative 'indent'
+require_relative 'tables/table_builder'
+require_relative 'tables/style'
+require_relative 'tables/table_formatter'
 
 module CommandKit
   module Printing

data/lib/command_kit/printing.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'command_kit/stdio'
+require_relative 'stdio'
 
 module CommandKit
   #

data/lib/command_kit/program_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Retrieves the current program name (`$PROGRAM_NAME`).

data/lib/command_kit/stdio.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandKit
   #
   # Provides access to stdin, stdout, and stderr streams.

data/lib/command_kit/sudo.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'command_kit/os'
+require_relative 'os'
 
 module CommandKit
   #

data/lib/command_kit/terminal.rb

@@ -1,5 +1,7 @@
-require 'command_kit/stdio'
-require 'command_kit/env'
+# frozen_string_literal: true
+
+require_relative 'stdio'
+require_relative 'env'
 
 begin
   require 'io/console'

data/lib/command_kit/usage.rb

@@ -1,5 +1,7 @@
-require 'command_kit/command_name'
-require 'command_kit/help'
+# frozen_string_literal: true
+
+require_relative 'command_name'
+require_relative 'help'
 
 module CommandKit
   #

data/lib/command_kit/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module CommandKit
   # command_kit version
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

data/lib/command_kit/xdg.rb

@@ -1,5 +1,7 @@
-require 'command_kit/command_name'
-require 'command_kit/env/home'
+# frozen_string_literal: true
+
+require_relative 'command_name'
+require_relative 'env/home'
 
 module CommandKit
   #

data/lib/command_kit.rb

@@ -1,2 +1,4 @@
-require 'command_kit/command'
-require 'command_kit/version'
+# frozen_string_literal: true
+
+require_relative 'command_kit/command'
+require_relative 'command_kit/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,11 +73,14 @@ files:
 - lib/command_kit/commands/help.rb
 - lib/command_kit/commands/parent_command.rb
 - lib/command_kit/commands/subcommand.rb
+- lib/command_kit/completion/install.rb
 - lib/command_kit/description.rb
 - lib/command_kit/edit.rb
 - lib/command_kit/env.rb
 - lib/command_kit/env/home.rb
 - lib/command_kit/env/path.rb
+- lib/command_kit/env/prefix.rb
+- lib/command_kit/env/shell.rb
 - lib/command_kit/examples.rb
 - lib/command_kit/exception_handler.rb
 - lib/command_kit/file_utils.rb
@@ -117,69 +120,6 @@ files:
 - lib/command_kit/usage.rb
 - lib/command_kit/version.rb
 - lib/command_kit/xdg.rb
-- spec/arguments/argument_spec.rb
-- spec/arguments/argument_value_spec.rb
-- spec/arguments_spec.rb
-- spec/bug_report_spec.rb
-- spec/colors_spec.rb
-- spec/command_kit_spec.rb
-- spec/command_name_spec.rb
-- spec/command_spec.rb
-- spec/commands/auto_load/subcommand_spec.rb
-- spec/commands/auto_load_spec.rb
-- spec/commands/auto_require_spec.rb
-- spec/commands/fixtures/test_auto_load/cli/commands/test1.rb
-- spec/commands/fixtures/test_auto_load/cli/commands/test2.rb
-- spec/commands/fixtures/test_auto_require/lib/test_auto_require/cli/commands/test1.rb
-- spec/commands/help_spec.rb
-- spec/commands/parent_command_spec.rb
-- spec/commands/subcommand_spec.rb
-- spec/commands_spec.rb
-- spec/description_spec.rb
-- spec/edit_spec.rb
-- spec/env/home_spec.rb
-- spec/env/path_spec.rb
-- spec/env_spec.rb
-- spec/examples_spec.rb
-- spec/exception_handler_spec.rb
-- spec/file_utils_spec.rb
-- spec/fixtures/template.erb
-- spec/help/man_spec.rb
-- spec/help_spec.rb
-- spec/inflector_spec.rb
-- spec/interactive_spec.rb
-- spec/main_spec.rb
-- spec/man_spec.rb
-- spec/open_app_spec.rb
-- spec/options/option_spec.rb
-- spec/options/option_value_spec.rb
-- spec/options/parser_spec.rb
-- spec/options/quiet_spec.rb
-- spec/options/verbose_spec.rb
-- spec/options/version_spec.rb
-- spec/options_spec.rb
-- spec/os/linux_spec.rb
-- spec/os_spec.rb
-- spec/package_manager_spec.rb
-- spec/pager_spec.rb
-- spec/printing/fields_spec.rb
-- spec/printing/indent_spec.rb
-- spec/printing/lists_spec.rb
-- spec/printing/tables/border_style.rb
-- spec/printing/tables/cell_builer_spec.rb
-- spec/printing/tables/row_builder_spec.rb
-- spec/printing/tables/style_spec.rb
-- spec/printing/tables/table_builder_spec.rb
-- spec/printing/tables/table_formatter_spec.rb
-- spec/printing/tables_spec.rb
-- spec/printing_spec.rb
-- spec/program_name_spec.rb
-- spec/spec_helper.rb
-- spec/stdio_spec.rb
-- spec/sudo_spec.rb
-- spec/terminal_spec.rb
-- spec/usage_spec.rb
-- spec/xdg_spec.rb
 homepage: https://github.com/postmodern/command_kit.rb#readme
 licenses:
 - MIT