command_kit 0.4.0 → 0.5.0

data/lib/command_kit/env/prefix.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'command_kit/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 'command_kit/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/inflector.rb

@@ -103,7 +103,7 @@ module CommandKit
           new_string << word
         elsif scanner.scan(/[_-]+/)
           # skip
-        elsif scanner.scan(/\//)
+        elsif scanner.scan(%r{/})
           new_string << '::'
         else
           raise(ArgumentError,"cannot convert string to CamelCase: #{scanner.string.inspect}")

data/lib/command_kit/options/parser.rb

@@ -50,7 +50,7 @@ module CommandKit
 
           if context.class == Module
             context.extend ModuleMethods
-          else
+          elsif context.usage.nil?
             context.usage '[options]'
           end
         end

data/lib/command_kit/os/linux.rb

@@ -36,7 +36,7 @@ module CommandKit
       module ModuleMethods
         #
         # Extends {ClassMethods} or {ModuleMethods}, depending on whether
-        # {OS} is being included into a class or a module..
+        # {OS} is being included into a class or a module.
         #
         # @param [Class, Module] context
         #   The class or module which is including {OS}.

data/lib/command_kit/os.rb

@@ -32,7 +32,7 @@ module CommandKit
     module ModuleMethods
       #
       # Extends {ClassMethods} or {ModuleMethods}, depending on whether
-      # {OS} is being included into a class or a module..
+      # {OS} is being included into a class or a module.
       #
       # @param [Class, Module] context
       #   The class or module which is including {OS}.

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

@@ -87,7 +87,7 @@ module CommandKit
                               column_border: ,
                               joined_border: ,
                               right_border: )
-          line = String.new
+          line = String.new(encoding: Encoding::UTF_8)
           line << left_border
 
           @table.max_columns.times do |column_index|
@@ -191,7 +191,7 @@ module CommandKit
         #   The formatted row line.
         #
         def format_row_line(row,line_index, justify: @style.justify)
-          line = String.new
+          line = String.new(encoding: Encoding::UTF_8)
           line << @style.border.left_border if @style.border
 
           @table.max_columns.times do |column_index|

data/lib/command_kit/version.rb

@@ -1,4 +1,4 @@
 module CommandKit
   # command_kit version
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/command_kit/xdg.rb

@@ -30,7 +30,7 @@ module CommandKit
     module ModuleMethods
       #
       # Extends {ClassMethods} or {ModuleMethods}, depending on whether {XDG} is
-      # being included into a class or a module..
+      # being included into a class or a module.
       #
       # @param [Class, Module] context
       #   The class or module which is including {XDG}.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,12 @@ files:
 - examples/command.rb
 - examples/pager.rb
 - examples/printing/tables.rb
+- examples/subcommands/cli.rb
+- examples/subcommands/cli/config.rb
+- examples/subcommands/cli/config/get.rb
+- examples/subcommands/cli/config/set.rb
+- examples/subcommands/cli/list.rb
+- examples/subcommands/cli/update.rb
 - gemspec.yml
 - lib/command_kit.rb
 - lib/command_kit/arguments.rb
@@ -67,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
@@ -111,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
@@ -198,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: An all-in-one modular Ruby CLI toolkit

data/spec/arguments/argument_spec.rb

@@ -1,133 +0,0 @@
-require 'spec_helper'
-require 'command_kit/arguments/argument'
-
-describe CommandKit::Arguments::Argument do
-  let(:name)     { :foo }
-  let(:usage)    { 'FOO' }
-  let(:required) { true }
-  let(:repeats)  { false }
-  let(:desc)     { 'Foo argument' }
-
-  subject do
-    described_class.new name, usage:    usage,
-                              required: required,
-                              repeats:  repeats,
-                              desc:     desc
-  end
-
-  describe "#initialize" do
-    context "when the usage: keyword is given" do
-      subject { described_class.new(name, usage: usage, desc: desc) }
-
-      it "must include usage: in #usage" do
-        expect(subject.usage).to include(usage)
-      end
-    end
-
-    context "when the usage: keyword is not given" do
-      subject { described_class.new(name, desc: desc) }
-
-      it "should use uppercased argument name in #usage" do
-        expect(subject.usage).to include(name.to_s.upcase)
-      end
-    end
-
-    context "when the required: keyword is given" do
-      subject { described_class.new(name, required: required, desc: desc) }
-
-      it "must set #required" do
-        expect(subject.required).to eq(required)
-      end
-    end
-
-    context "when the required: keyword is not given" do
-      subject { described_class.new(name, desc: desc) }
-
-      it "default #required to String" do
-        expect(subject.required).to eq(true)
-      end
-    end
-
-    context "when the repeats: keyword is given" do
-      subject { described_class.new(name, repeats: repeats, desc: desc) }
-
-      it "must set #repeats" do
-        expect(subject.repeats?).to eq(repeats)
-      end
-    end
-
-    context "when the repeats: keyword is not given" do
-      subject { described_class.new(name, desc: desc) }
-
-      it "default #repeats to String" do
-        expect(subject.repeats?).to eq(false)
-      end
-    end
-
-    context "when the desc: keyword is given" do
-      subject { described_class.new(name, desc: desc) }
-
-      it "must set #desc" do
-        expect(subject.desc).to eq(desc)
-      end
-    end
-
-    context "when the desc: keyword is not given" do
-      it do
-        expect {
-          described_class.new(name)
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#repeats?" do
-    context "when initialized with repeats: true" do
-      let(:repeats) { true }
-
-      it { expect(subject.repeats?).to be(true) }
-    end
-
-    context "when initialized with repeats: false" do
-      let(:repeats) { false }
-
-      it { expect(subject.repeats?).to be(false) }
-    end
-  end
-
-  describe "#usage" do
-    let(:usage) { 'FOO' }
-
-    context "initialized with required: true" do
-      let(:required) { true }
-
-      it "must return the usage unchanged" do
-        expect(subject.usage).to eq(usage)
-      end
-    end
-
-    context "initialized with required: false" do
-      let(:required) { false }
-
-      it "must wrap the usage in [ ] brackets" do
-        expect(subject.usage).to eq("[#{usage}]")
-      end
-    end
-
-    context "initialized with repeats: true" do
-      let(:repeats) { true }
-
-      it "must append the ... ellipses" do
-        expect(subject.usage).to eq("#{usage} ...")
-      end
-    end
-
-    context "initialized with repeats: false" do
-      let(:repeats) { false }
-
-      it "must return the usage name unchanged" do
-        expect(subject.usage).to eq(usage)
-      end
-    end
-  end
-end

data/spec/arguments/argument_value_spec.rb

@@ -1,66 +0,0 @@
-require 'spec_helper'
-require 'command_kit/arguments/argument_value'
-
-describe CommandKit::Arguments::ArgumentValue do
-  let(:required) { false  }
-  let(:usage)    { 'FOO'  }
-
-  subject do
-    described_class.new(
-      required: required,
-      usage:    usage
-    )
-  end
-
-  describe "#initialize" do
-    it "must require a usage: keyword"do
-      expect {
-        described_class.new(required: required)
-      }.to raise_error(ArgumentError)
-    end
-
-    context "when required: is given" do
-      subject { described_class.new(required: required, usage: usage) }
-
-      it "must set #required" do
-        expect(subject.required).to eq(required)
-      end
-    end
-
-    context "when required: is not given" do
-      subject { described_class.new(usage: usage) }
-
-      it "must default to true" do
-        expect(subject.required).to be(true)
-      end
-    end
-  end
-
-  describe "#required?" do
-    context "when required: is initialized with true" do
-      let(:required) { true }
-
-      it { expect(subject.required?).to be(true) }
-    end
-
-    context "when required: is initialized with false" do
-      let(:required) { false }
-
-      it { expect(subject.required?).to be(false) }
-    end
-  end
-
-  describe "#optional?" do
-    context "when required: is initialized with true" do
-      let(:required) { true }
-
-      it { expect(subject.optional?).to be(false) }
-    end
-
-    context "when required: is initialized with false" do
-      let(:required) { false }
-
-      it { expect(subject.optional?).to be(true) }
-    end
-  end
-end