command_kit 0.1.0.pre1 → 0.2.0

data/spec/usage_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/usage'
 
-describe Usage do
+describe CommandKit::Usage do
   module TestUsage
     class ImplicitCmd
       include CommandKit::Usage
@@ -182,7 +182,7 @@ describe Usage do
           [
             "#{subject.command_name} #{command_class.usage[0]}",
             "#{subject.command_name} #{command_class.usage[1]}",
-            "#{subject.command_name} #{command_class.usage[2]}",
+            "#{subject.command_name} #{command_class.usage[2]}"
           ]
         )
       end

data/spec/xdg_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/xdg'
 
-describe XDG do
+describe CommandKit::XDG do
   module TestXDG
     class TestCommand
       include CommandKit::XDG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.2.0
 platform: ruby
 authors:
 - Postmodern
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: A Ruby toolkit for building clean, correct, and robust CLI commands as
-  Ruby classes.
+  plain-old Ruby classes.
 email: postmodern.mod3@gmail.com
 executables: []
 extensions: []
@@ -38,6 +38,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".yardopts"
 - ChangeLog.md
 - Gemfile
@@ -45,12 +46,14 @@ files:
 - README.md
 - Rakefile
 - command_kit.gemspec
+- examples/colors.rb
+- examples/command.rb
+- examples/pager.rb
 - gemspec.yml
 - lib/command_kit.rb
 - lib/command_kit/arguments.rb
 - lib/command_kit/arguments/argument.rb
 - lib/command_kit/arguments/argument_value.rb
-- lib/command_kit/arguments/usage.rb
 - lib/command_kit/colors.rb
 - lib/command_kit/command.rb
 - lib/command_kit/command_name.rb
@@ -62,7 +65,6 @@ files:
 - lib/command_kit/commands/help.rb
 - lib/command_kit/commands/parent_command.rb
 - lib/command_kit/commands/subcommand.rb
-- lib/command_kit/console.rb
 - lib/command_kit/description.rb
 - lib/command_kit/env.rb
 - lib/command_kit/env/home.rb
@@ -72,21 +74,27 @@ files:
 - lib/command_kit/help.rb
 - lib/command_kit/help/man.rb
 - lib/command_kit/inflector.rb
+- lib/command_kit/interactive.rb
 - lib/command_kit/main.rb
+- lib/command_kit/man.rb
+- lib/command_kit/open_app.rb
 - lib/command_kit/options.rb
 - lib/command_kit/options/option.rb
 - lib/command_kit/options/option_value.rb
 - lib/command_kit/options/parser.rb
 - lib/command_kit/options/quiet.rb
-- lib/command_kit/options/usage.rb
 - lib/command_kit/options/verbose.rb
 - lib/command_kit/options/version.rb
 - lib/command_kit/os.rb
+- lib/command_kit/os/linux.rb
+- lib/command_kit/package_manager.rb
 - lib/command_kit/pager.rb
 - lib/command_kit/printing.rb
 - lib/command_kit/printing/indent.rb
 - lib/command_kit/program_name.rb
 - lib/command_kit/stdio.rb
+- lib/command_kit/sudo.rb
+- lib/command_kit/terminal.rb
 - lib/command_kit/usage.rb
 - lib/command_kit/version.rb
 - lib/command_kit/xdg.rb
@@ -107,34 +115,45 @@ files:
 - spec/commands/parent_command_spec.rb
 - spec/commands/subcommand_spec.rb
 - spec/commands_spec.rb
-- spec/console_spec.rb
 - spec/description_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/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_spec.rb
+- spec/os/linux_spec.rb
 - spec/os_spec.rb
+- spec/package_manager_spec.rb
 - spec/pager_spec.rb
 - spec/printing/indent_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#readme
+homepage: https://github.com/postmodern/command_kit.rb#readme
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/command_kit
+  source_code_uri: https://github.com/postmodern/command_kit.rb
+  bug_tracker_uri: https://github.com/postmodern/command_kit.rb/issues
+  changelog_uri: https://github.com/postmodern/command_kit.rb/blob/main/ChangeLog.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A toolkit for building Ruby CLI commands
 test_files: []

data/lib/command_kit/arguments/usage.rb

@@ -1,6 +0,0 @@
-module CommandKit
-  module Arguments
-    module Usage
-    end
-  end
-end

data/lib/command_kit/console.rb

@@ -1,141 +0,0 @@
-require 'command_kit/stdio'
-require 'command_kit/env'
-
-begin
-  require 'io/console'
-rescue LoadError
-end
-
-module CommandKit
-  #
-  # Provides access to [IO.console] and [IO.console_size].
-  #
-  # ## Environment Variables
-  #
-  # * `LINES` - The explicit number of lines or rows the console should have.
-  # * `COLUMNS` - The explicit number of columns the console should have.
-  #
-  # [IO.console]: https://rubydoc.info/gems/io-console/IO#console-class_method
-  # [IO#winsize]: https://rubydoc.info/gems/io-console/IO#winsize-instance_method
-  #
-  module Console
-    include Stdio
-    include Env
-
-    # The default console height to fallback to.
-    DEFAULT_HEIGHT = 25
-
-    # The default console width to fallback to.
-    DEFAULT_WIDTH = 80
-
-    #
-    # Initializes any console settings.
-    #
-    # @param [Hash{Symbol => Object}] kwargs
-    #   Additional keyword arguments.
-    #
-    # @note
-    #   If the `$LINES` env variable is set, and is non-zero, it will be
-    #   returned by {#console_height}.
-    #
-    # @note
-    #   If the `$COLUMNS` env variable is set, and is non-zero, it will be
-    #   returned by {#console_width}.
-    #
-    def initialize(**kwargs)
-      super(**kwargs)
-
-      @default_console_height = if (lines = env['LINES'])
-                                  lines.to_i
-                                else
-                                  DEFAULT_HEIGHT
-                                end
-
-      @default_console_width  = if (columns = env['COLUMNS'])
-                                  columns.to_i
-                                else
-                                  DEFAULT_WIDTH
-                                end
-    end
-
-    #
-    # Determines if there is a console present.
-    #
-    # @return [Boolean]
-    #   Specifies whether {Stdio#stdout stdout} is connected to a console.
-    #
-    def console?
-      IO.respond_to?(:console) && stdout.tty?
-    end
-
-    #
-    # Returns the console object, if {Stdio#stdout stdout} is connected to a
-    # console.
-    #
-    # @return [IO, nil]
-    #   The IO objects or `nil` if {Stdio#stdout stdout} is not connected to a
-    #   console.
-    #
-    # @example
-    #   console
-    #   # => #<File:/dev/tty>
-    #
-    def console
-      IO.console if console?
-    end
-
-    #
-    # Returns the console's height in number of lines.
-    #
-    # @return [Integer]
-    #   The console's height in number of lines.
-    #
-    # @example
-    #   console_height
-    #   # => 22
-    #
-    def console_height
-      if (console = self.console)
-        console.winsize[0]
-      else
-        @default_console_height
-      end
-    end
-
-    #
-    # Returns the console's width in number of lines.
-    #
-    # @return [Integer]
-    #   The console's width in number of columns.
-    #
-    # @example
-    #   console_width
-    #   # => 91
-    #
-    def console_width
-      if (console = self.console)
-        console.winsize[1]
-      else
-        @default_console_width
-      end
-    end
-
-    #
-    # The console height (lines) and width (columns).
-    #
-    # @return [(Integer, Integer)]
-    #   Returns the height and width of the console.
-    #
-    # @example
-    #   console_size
-    #   # => [23, 91]
-    #
-    def console_size
-      if (console = self.console)
-        console.winsize
-      else
-        [@default_console_height, @default_console_width]
-      end
-    end
-  end
-end

data/lib/command_kit/options/usage.rb

@@ -1,6 +0,0 @@
-module CommandKit
-  module Options
-    module Usage
-    end
-  end
-end