command_kit 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f815869f166ce21da0c32699e8dcd7cebdb17cdbcc74fba1be3572ebb2d15a0
-  data.tar.gz: 2e2db9a8f190308d473959274dad507095baba55e0e73f7fcd969a4f23267054
+  metadata.gz: 77d44bdde55ae89aeda2ce28446ae9916a2da06b4315e650c0d1cd76340df2c1
+  data.tar.gz: eaebe86478899a3da8574888c29596fc7e5bedd271afc5248fc9784ba424b2c3
 SHA512:
-  metadata.gz: b0055ba75d1dc4aef15bf280ed86f5d4a514e5e95c00bc1285c9f29327d5b03ab4415a6001bc4ee05be04bb5504b2d6a0a8de0d33f6048a1ea333adb93915f54
-  data.tar.gz: a198cc0fe966abb5f20f5025b52144bce290d06602e93afd13e2eca03d8aa87477511a598562f023ef921490084c200896c453e78b75d9061216dc8e548f923b
+  metadata.gz: 1eaf5bc70d5c16251e1016738616cccb5b8363763afe2ac9c1dfda4688f5e10792ea574d6d95edbc0793f21ee05ea003e27bb73bd59ae993222182ce6cff4345
+  data.tar.gz: 30fb59826cdf6c596a5f0f2895be7f1e1a64534d328c55bc985d20a3d29161a2ccb3453bfd65d4c2faec869256d70781b05b727bcb946e3f56ca519391f99a37

data/.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
           - 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/.rubocop.yml

@@ -79,7 +79,6 @@ Naming/RescuedExceptionsVariableName: { Enabled: false } # Offense count: 11
 Style/BlockDelimiters: { Enabled: false } # Offense count: 17
 Style/ClassCheck: { Enabled: false } # Offense count: 10
 Style/ClassEqualityComparison: { Enabled: false } # Offense count: 16
-Style/FrozenStringLiteralComment: { Enabled: false } # Offense count: 77
 Style/GlobalStdStream: { Enabled: false } # Offense count: 13
 Style/GuardClause: { Enabled: false } # Offense count: 10
 Style/IfUnlessModifier: { Enabled: false } # Offense count: 13
@@ -138,6 +137,13 @@ Style/RescueStandardError: { Enabled: false } # Offense count: 1
 Style/SoleNestedConditional: { Enabled: false } # Offense count: 1
 Style/TrailingCommaInHashLiteral: { Enabled: false } # Offense count: 2
 
+# enforce frozen_string_literal for lib/, but not examples/ or spec/.
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'examples/{**/,}*.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/{**/,}*_spec.rb'
+
 # rubocop cannot tell that rubygems_mfa_required is enabled in gemspec.yml
 Gemspec/RequireMFA: { Enabled: false }
 

data/ChangeLog.md

@@ -1,3 +1,15 @@
+### 0.5.2 / 2024-03-07
+
+#### CommandKit::Options
+
+* Fixed the `--help` output for options with multi-line descriptions
+  (ex: `desc: ['Line 1', 'Line 2', ...]`).
+
+### 0.5.1 / 2024-01-24
+
+* Switched to using `require_relative` to improve load-times.
+* Added `# frozen_string_literal: true` to all files.
+
 ### 0.5.0 / 2024-01-04
 
 * Added {CommandKit::Env::Shell}.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 
 begin

data/command_kit.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_kit/version'
+                  require_relative 'lib/command_kit/version'
                   CommandKit::VERSION
                 end
 

data/lib/command_kit/arguments/argument.rb

@@ -1,4 +1,6 @@
-require 'command_kit/arguments/argument_value'
+# frozen_string_literal: true
+
+require_relative 'argument_value'
 
 module CommandKit
   module Arguments

data/lib/command_kit/arguments/argument_value.rb

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

data/lib/command_kit/arguments.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'command_kit/arguments/argument'
-require 'command_kit/usage'
-require 'command_kit/main'
-require 'command_kit/help'
-require 'command_kit/printing'
+require_relative 'arguments/argument'
+require_relative 'usage'
+require_relative 'main'
+require_relative 'help'
+require_relative 'printing'
 
 module CommandKit
   #

data/lib/command_kit/bug_report.rb

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

data/lib/command_kit/colors.rb

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

data/lib/command_kit/command.rb

@@ -1,14 +1,16 @@
-require 'command_kit/main'
-require 'command_kit/env'
-require 'command_kit/stdio'
-require 'command_kit/printing'
-require 'command_kit/usage'
-require 'command_kit/arguments'
-require 'command_kit/options'
-require 'command_kit/examples'
-require 'command_kit/description'
-require 'command_kit/exception_handler'
-require 'command_kit/file_utils'
+# frozen_string_literal: true
+
+require_relative 'main'
+require_relative 'env'
+require_relative 'stdio'
+require_relative 'printing'
+require_relative 'usage'
+require_relative 'arguments'
+require_relative 'options'
+require_relative 'examples'
+require_relative 'description'
+require_relative 'exception_handler'
+require_relative 'file_utils'
 
 module CommandKit
   #

data/lib/command_kit/command_name.rb

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

data/lib/command_kit/commands/auto_load/subcommand.rb

@@ -1,4 +1,6 @@
-require 'command_kit/commands/subcommand'
+# frozen_string_literal: true
+
+require_relative '../subcommand'
 
 module CommandKit
   module Commands

data/lib/command_kit/commands/auto_load.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'command_kit/commands'
-require 'command_kit/commands/auto_load/subcommand'
-require 'command_kit/inflector'
+require_relative '../commands'
+require_relative 'auto_load/subcommand'
+require_relative '../inflector'
 
 module CommandKit
   module Commands

data/lib/command_kit/commands/auto_require.rb

@@ -1,6 +1,8 @@
-require 'command_kit/commands'
-require 'command_kit/commands/subcommand'
-require 'command_kit/inflector'
+# frozen_string_literal: true
+
+require_relative '../commands'
+require_relative 'subcommand'
+require_relative '../inflector'
 
 module CommandKit
   module Commands

data/lib/command_kit/commands/command.rb

@@ -1,5 +1,7 @@
-require 'command_kit/command'
-require 'command_kit/commands/parent_command'
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative 'parent_command'
 
 module CommandKit
   module Commands

data/lib/command_kit/commands/help.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'command_kit/command'
-require 'command_kit/commands/parent_command'
+require_relative '../command'
+require_relative 'parent_command'
 
 module CommandKit
   module Commands

data/lib/command_kit/commands/parent_command.rb

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

data/lib/command_kit/commands/subcommand.rb

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

data/lib/command_kit/commands.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'command_kit/commands/subcommand'
-require 'command_kit/commands/parent_command'
-require 'command_kit/commands/help'
-require 'command_kit/command_name'
-require 'command_kit/usage'
-require 'command_kit/options'
-require 'command_kit/stdio'
-require 'command_kit/env'
+require_relative 'commands/subcommand'
+require_relative 'commands/parent_command'
+require_relative 'commands/help'
+require_relative 'command_name'
+require_relative 'usage'
+require_relative 'options'
+require_relative 'stdio'
+require_relative 'env'
 
 module CommandKit
   #

data/lib/command_kit/completion/install.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'command_kit/printing'
-require 'command_kit/env/home'
-require 'command_kit/env/shell'
-require 'command_kit/env/prefix'
+require_relative '../printing'
+require_relative '../env/home'
+require_relative '../env/shell'
+require_relative '../env/prefix'
+
 require 'fileutils'
 
 module CommandKit

data/lib/command_kit/description.rb

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

data/lib/command_kit/edit.rb

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

data/lib/command_kit/env/home.rb

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

data/lib/command_kit/env/path.rb

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

data/lib/command_kit/env/prefix.rb

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

data/lib/command_kit/env/shell.rb

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

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
   #
@@ -304,7 +306,7 @@ module CommandKit
 
       @options[option.name] = default_value unless default_value.nil?
 
-      option_parser.on(*option.usage,option.type,option.desc) do |arg,*captures|
+      option_parser.on(*option.usage,option.type,*option.desc) do |arg,*captures|
         @options[option.name] = arg
 
         if option.block

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.5.0"
+  VERSION = "0.5.2"
 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.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler