command_kit 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a35e836c936c91aa916f33e691260a591d2e363de6a0fd3d9259150b86add15
-  data.tar.gz: fe2e2cc87a8a0fe889cba23b5567b307bb088fdf3ee4eff7d681694a981b5143
+  metadata.gz: 2f84fffcb26bb3b32c2d87e9e881ce6a29d8632b62aba64d6b47c7aef45ee170
+  data.tar.gz: 2c0de71142b1f4f7c28986f5b1fcc5bc15939f438daeb00f726809378feb42f8
 SHA512:
-  metadata.gz: da2676ab635edc9898457b1c532af6ac4c478c6f3a0ab19dfc42f0abc4ddd73ef4f473fe7699f8bed3ac5abec3381a7a9ca9c50736c4cc3697612ef36f3d6fea
-  data.tar.gz: d30a04ab5274f489ef3e534950301669d47112ee56d43b59e51c5e816f7de21fba72197d43f3362331c40f3e75a70e0c316d53fe12bf8960daf79efec270a372
+  metadata.gz: 3db3a4eab3b425d5d516d39275b71ea552b75e5c41d17e070b8e252b9ecfafa606a0355c32a489ee56549a60f14a40a97ed47f0816e3d5a4581068aede96b44f
+  data.tar.gz: cc9b154d81e142f46be9452e8b8c98b435e582319e572b1ebb059c2ba03140486b6c8a1a33988f16725e6baabc3451f96d43cb5c9c006c298e275996eb73222e

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,14 @@
+### 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}.
+* Added {CommandKit::Env::Prefix}.
+* Added {CommandKit::Completion::Install}.
+
 ### 0.4.1 / 2024-01-03
 
 * Added more examples of how to define sub-commands and sub-sub-commands.

data/Gemfile

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

data/README.md

@@ -214,11 +214,14 @@ end
 * [CommandKit::Commands](https://rubydoc.info/gems/command_kit/CommandKit/Commands)
   * [CommandKit::Commands::AutoLoad](https://rubydoc.info/gems/command_kit/CommandKit/Commands/AutoLoad)
   * [CommandKit::Commands::AutoRequire](https://rubydoc.info/gems/command_kit/CommandKit/Commands/AutoRequire)
+* [CommandKit::Completion::Install](https://rubydoc.info/gems/command_kit/CommandKit/Completion/Install)
 * [CommandKit::Description](https://rubydoc.info/gems/command_kit/CommandKit/Description)
 * [CommandKit::Edit](https://rubydoc.info/gems/command_kit/CommandKit/Edit)
 * [CommandKit::Env](https://rubydoc.info/gems/command_kit/CommandKit/Env)
   * [CommandKit::Env::Home](https://rubydoc.info/gems/command_kit/CommandKit/Env/Home)
   * [CommandKit::Env::Path](https://rubydoc.info/gems/command_kit/CommandKit/Env/Path)
+  * [CommandKit::Env::Prefix](https://rubydoc.info/gems/command_kit/CommandKit/Env/Prefix)
+  * [CommandKit::Env::Shell](https://rubydoc.info/gems/command_kit/CommandKit/Env/Shell)
 * [CommandKit::Examples](https://rubydoc.info/gems/command_kit/CommandKit/Examples)
 * [CommandKit::ExceptionHandler](https://rubydoc.info/gems/command_kit/CommandKit/ExceptionHandler)
 * [CommandKit::FileUtils](https://rubydoc.info/gems/command_kit/CommandKit/FileUtils)

data/Rakefile

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

data/command_kit.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 Gem::Specification.new do |gem|
@@ -5,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
 
@@ -20,12 +19,15 @@ Gem::Specification.new do |gem|
   gem.homepage    = gemspec['homepage']
   gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
-  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+  glob = ->(patterns) { gem.files & Dir[*patterns] }
 
   gem.files = if gemspec['files'] then glob[gemspec['files']]
               else                     `git ls-files`.split($/)
               end
 
+  # exclude test files from the packages gem
+  gem.files -= glob[gemspec['test_files'] || 'spec/{**/}*']
+
   gem.executables = gemspec.fetch('executables') do
     glob['bin/*'].map { |path| File.basename(path) }
   end
@@ -43,7 +45,7 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = gemspec['required_rubygems_version']
   gem.post_install_message      = gemspec['post_install_message']
 
-  split = lambda { |string| string.split(/,\s*/) }
+  split = ->(string) { string.split(/,\s*/) }
 
   if gemspec['dependencies']
     gemspec['dependencies'].each do |name,versions|

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

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+require_relative '../printing'
+require_relative '../env/home'
+require_relative '../env/shell'
+require_relative '../env/prefix'
+
+require 'fileutils'
+
+module CommandKit
+  module Completion
+    #
+    # Mixins that adds methods for installing shell completion files.
+    #
+    # ## Environment Variables
+    #
+    # * `SHELL` - The current shell.
+    # * `PREFIX` - The optional root prefix of the file-system.
+    #
+    # @api public
+    #
+    # @since 0.5.0
+    #
+    module Install
+      include Printing
+      include Env::Home
+      include Env::Shell
+      include Env::Prefix
+
+      # The installation directory for completion files for the current shell.
+      #
+      # @return [String, nil]
+      #   * Bash
+      #     * Regular users: `~/.local/share/bash-completion/completions`
+      #     * Root users:`$PREFIX/usr/local/share/bash-completion/completions`
+      #   * Zsh: `$PREFIX/usr/local/share/zsh/site-functions`
+      #   * Fish:
+      #     * Regular users: `~/.config/fish/completions`
+      #     * Root users: `$PREFIX/usr/local/share/fish/completions`
+      #
+      # @api private
+      attr_reader :completions_dir
+
+      #
+      # Initialize {#completions_dir} based on the `SHELL` environment variable
+      # and the UID of the process.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @api public
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @completions_dir = case shell_type
+                           when :bash
+                             if Process.uid == 0
+                               File.join(root,'usr','local','share','bash-completion','completions')
+                             else
+                               xdg_data_home = env.fetch('XDG_DATA_HOME') do
+                                 File.join(home_dir,'.local','share')
+                               end
+
+                               File.join(xdg_data_home,'bash-completion','completions')
+                             end
+                           when :zsh
+                             File.join(root,'usr','local','share','zsh','site-functions')
+                           when :fish
+                             if Process.uid == 0
+                               File.join(root,'usr','local','share','fish','completions')
+                             else
+                               xdg_config_home = env.fetch('XDG_CONFIG_HOME') do
+                                 File.join(home_dir,'.config')
+                               end
+
+                               File.join(xdg_config_home,'fish','completions')
+                             end
+                           end
+      end
+
+      #
+      # Prints the shell completion file to stdout.
+      #
+      # @param [String] path
+      #   The path to the shell completion file.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @option kwargs [:bash, :zsh, :fish] :type (:bash)
+      #   The type of the completion file.
+      #
+      # @example Prints a Bash completion file:
+      #   print_completion_file 'path/to/completions/foo'
+      #
+      # @example Prints a Zsh completion file:
+      #   print_completion_file 'path/to/completions/foo', type: :zsh
+      #
+      # @example Prints a Fish completion file:
+      #   print_completion_file 'path/to/completions/foo', type: :fish
+      #
+      # @api public
+      #
+      def print_completion_file(path,**kwargs)
+        write_completion_file(path,stdout,**kwargs)
+      end
+
+      #
+      # Installs the shell completion file into {#completions_dir}.
+      #
+      # @param [String] path
+      #   The path to the shell completion file.
+      #
+      # @param [:bash, :zsh, :fish] type
+      #   The type of the shell completion file.
+      #
+      # @example Install a Bash completion file:
+      #   install_completion_file 'path/to/completions/foo'
+      #
+      # @example Install a Zsh completion file:
+      #   install_completion_file 'path/to/completions/foo', type: :zsh
+      #
+      # @example Install a Fish completion file:
+      #   install_completion_file 'path/to/completions/foo', type: :fish
+      #
+      # @api public
+      #
+      def install_completion_file(path, type: :bash)
+        completion_file = normalize_completion_file(path, type: type)
+        completion_path = File.join(@completions_dir,completion_file)
+
+        begin
+          ::FileUtils.mkdir_p(@completions_dir)
+        rescue Errno::EACCES
+          print_error "cannot write to #{shell_type} completions directory: #{@completions_dir}"
+          exit(-1)
+        end
+
+        begin
+          File.open(completion_path,'w') do |output|
+            write_completion_file(path,output, type: type)
+          end
+        rescue Errno::EACCES
+          print_error "cannot write to #{shell_type} completion file: #{completion_path}"
+          exit(-1)
+        end
+      end
+
+      #
+      # Uninstalls a shell completion file for the specified command.
+      #
+      # @param [String] command
+      #   The command to uninstall the completions for.
+      #
+      # @example Removes the completion file for the command 'foo':
+      #   uninstall_completion_file_for 'foo'
+      #
+      # @api public
+      #
+      def uninstall_completion_file_for(command)
+        completion_file = completion_file_for_command(command)
+        completion_path = File.join(@completions_dir,completion_file)
+
+        begin
+          ::FileUtils.rm_f(completion_path)
+        rescue Errno::EACCES
+          print_error "cannot remove #{shell_type} completion file: #{completion_path}"
+          exit(-1)
+        end
+      end
+
+      private
+
+      #
+      # Calculates the installed completion file for the given command.
+      #
+      # @param [String] command
+      #   The command name.
+      #
+      # @return [String]
+      #   The path to the completion file for the command.
+      #
+      # @api private
+      #
+      def completion_file_for_command(command)
+        case shell_type
+        when :bash then command
+        when :zsh  then "_#{command}"
+        when :fish then "#{command}.fish"
+        when nil
+          if shell then print_error("cannot identify shell: #{shell}")
+          else          print_error("cannot identify shell")
+          end
+
+          exit(-1)
+        else
+          print_error("completions not support for the #{shell_type} shell: #{shell}")
+          exit(-1)
+        end
+      end
+
+      #
+      # Calculates the installation path for the given completion file.
+      #
+      # @param [String] path
+      #   The path to the completion file that will be installed.
+      #
+      # @param [:bash, :zsh, :fish] type
+      #   The type of the shell completion file.
+      #
+      # @return [String]
+      #   The installation path for the completion file.
+      #
+      # @api private
+      #
+      def normalize_completion_file(path, type: :bash)
+        ext  = File.extname(path)
+        file = File.basename(path,ext)
+
+        case [shell_type, type]
+        when [:bash, :bash] # no-op
+        when [:zsh, :zsh],
+             [:zsh, :bash]
+          unless file.start_with?('_')
+            file = "_#{file}"
+          end
+        when [:fish, :fish]
+          file = "#{file}.fish"
+        else
+          if shell_type
+            print_error("cannot install #{type} completion file into the #{shell_type} shell: #{path}")
+          elsif shell
+            print_error("cannot identify shell: #{shell}")
+          else
+            print_error("cannot identify shell")
+          end
+
+          exit(-1)
+        end
+
+        return file
+      end
+
+      #
+      # Writes the shell completion file to the output
+      #
+      # @param [String] path
+      #   The path to the shell completion file.
+      #
+      # @param [IO] output
+      #   The output stream to write to.
+      #
+      # @param [:bash, :zsh, :fish] type
+      #   The type of the shell completion file.
+      #
+      # @api private
+      #
+      def write_completion_file(path,output, type: :bash)
+        if shell_type == :zsh && type == :bash
+          file_name = File.basename(path,File.extname(path))
+          command   = file_name.sub(/\A_/,'')
+
+          # add the #compdef magic comments for zsh
+          output.puts "#compdef #{command}"
+          output.puts
+        end
+
+        File.open(path) do |file|
+          file.each_line do |line|
+            output.write(line)
+          end
+        end
+      end
+    end
+  end
+end

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