command_kit 0.1.0.rc1 → 0.1.0

data/lib/command_kit/stdio.rb

@@ -34,6 +34,8 @@ module CommandKit
     # @param [IO] stderr
     #   The stderr error output stream. Defaults to `$stderr`.
     #
+    # @api public
+    #
     def initialize(stdin: nil, stdout: nil, stderr: nil, **kwargs)
       @stdin  = stdin
       @stdout = stdout
@@ -48,6 +50,8 @@ module CommandKit
     # @return [$stdin, IO]
     #   The initialized `@stdin` value or `$stdin`.
     #
+    # @api public
+    #
     def stdin
       @stdin || $stdin
     end
@@ -58,6 +62,8 @@ module CommandKit
     # @return [$stdout, IO]
     #   The initialized `@stdout` value or `$stdout`.
     #
+    # @api public
+    #
     def stdout
       @stdout || $stdout
     end
@@ -68,6 +74,8 @@ module CommandKit
     # @return [$stderr, IO]
     #   The initialized `@stderr` value or `$stderr`.
     #
+    # @api public
+    #
     def stderr
       @stderr || $stderr
     end
@@ -75,6 +83,8 @@ module CommandKit
     #
     # Calls `stdin.gets`.
     #
+    # @api public
+    #
     def gets(*arguments)
       stdin.gets(*arguments)
     end
@@ -82,6 +92,8 @@ module CommandKit
     #
     # Calls `stdin.readline`.
     #
+    # @api public
+    #
     def readline(*arguments)
       stdin.readline(*arguments)
     end
@@ -89,6 +101,8 @@ module CommandKit
     #
     # Calls `stdin.readlines`.
     #
+    # @api public
+    #
     def readlines(*arguments)
       stdin.readlines(*arguments)
     end
@@ -99,6 +113,8 @@ module CommandKit
     #
     # Calls `stdout.putc`.
     #
+    # @api public
+    #
     def putc(*arguments)
       stdout.putc(*arguments)
     end
@@ -106,6 +122,8 @@ module CommandKit
     #
     # Calls `stdout.puts`.
     #
+    # @api public
+    #
     def puts(*arguments)
       stdout.puts(*arguments)
     end
@@ -113,6 +131,8 @@ module CommandKit
     #
     # Calls `stdout.print`.
     #
+    # @api public
+    #
     def print(*arguments)
       stdout.print(*arguments)
     end
@@ -120,6 +140,8 @@ module CommandKit
     #
     # Calls `stdout.printf`.
     #
+    # @api public
+    #
     def printf(*arguments)
       stdout.printf(*arguments)
     end
@@ -130,6 +152,8 @@ module CommandKit
     # @param [String, nil] message
     #   The optional abort message.
     #
+    # @api public
+    #
     def abort(message=nil)
       stderr.puts(message) if message
       exit(1)

data/lib/command_kit/terminal.rb

@@ -41,6 +41,8 @@ module CommandKit
     #   If the `$COLUMNS` env variable is set, and is non-zero, it will be
     #   returned by {#terminal_width}.
     #
+    # @api public
+    #
     def initialize(**kwargs)
       super(**kwargs)
 
@@ -63,6 +65,8 @@ module CommandKit
     # @return [Boolean]
     #   Specifies whether {Stdio#stdout stdout} is connected to a terminal.
     #
+    # @api public
+    #
     def terminal?
       IO.respond_to?(:console) && stdout.tty?
     end
@@ -81,6 +85,8 @@ module CommandKit
     #
     # @see https://rubydoc.info/gems/io-console/IO
     #
+    # @api semipublic
+    #
     def terminal
       IO.console if terminal?
     end
@@ -95,6 +101,8 @@ module CommandKit
     #   terminal_height
     #   # => 22
     #
+    # @api public
+    #
     def terminal_height
       if (terminal = self.terminal)
         terminal.winsize[0]
@@ -113,6 +121,8 @@ module CommandKit
     #   terminal_width
     #   # => 91
     #
+    # @api public
+    #
     def terminal_width
       if (terminal = self.terminal)
         terminal.winsize[1]
@@ -131,6 +141,8 @@ module CommandKit
     #   terminal_size
     #   # => [23, 91]
     #
+    # @api public
+    #
     def terminal_size
       if (terminal = self.terminal)
         terminal.winsize

data/lib/command_kit/usage.rb

@@ -15,6 +15,9 @@ module CommandKit
     include CommandName
     include Help
 
+    #
+    # @api private
+    #
     module ModuleMethods
       #
       # Extends {ClassMethods} or {ModuleMethods}, depending on whether {Usage}
@@ -50,6 +53,11 @@ module CommandKit
       # @return [String, Array<String>]
       #   The class'es or superclass'es usage string(s).
       #
+      # @example
+      #   usage "[options] ARG1 ARG2 [ARG3 ...]"
+      #
+      # @api public
+      #
       def usage(new_usage=nil)
         if new_usage
           @usage = new_usage
@@ -65,6 +73,8 @@ module CommandKit
     #
     # @return [Array<String>, String, nil]
     #
+    # @api public
+    #
     def usage
       case (usage = self.class.usage)
       when Array
@@ -77,6 +87,8 @@ module CommandKit
     #
     # Prints the `usage: ...` output.
     #
+    # @api semipublic
+    #
     def help_usage
       case (usage = self.usage)
       when Array
@@ -95,6 +107,8 @@ module CommandKit
     #
     # @see #help_usage
     #
+    # @api public
+    #
     def help
       help_usage
     end

data/lib/command_kit/version.rb

@@ -1,4 +1,4 @@
 module CommandKit
   # command_kit version
-  VERSION = "0.1.0.rc1"
+  VERSION = "0.1.0"
 end

data/lib/command_kit/xdg.rb

@@ -24,6 +24,9 @@ module CommandKit
     include CommandName
     include Env::Home
 
+    #
+    # @api private
+    #
     module ModuleMethods
       #
       # Extends {ClassMethods} or {ModuleMethods}, depending on whether {XDG} is
@@ -61,6 +64,8 @@ module CommandKit
       #   {CommandName::ClassMethods#command_name} if no {#xdg_namespace} has
       #   been defined.
       #
+      # @api public
+      #
       def xdg_namespace(new_namespace=nil)
         if new_namespace
           @xdg_namespace = new_namespace.to_s
@@ -77,16 +82,22 @@ module CommandKit
     # The `~/.config/<xdg_namespace>` directory.
     #
     # @return [String]
+    #
+    # @api public
     attr_reader :config_dir
 
     # The `~/.local/share/<xdg_namespace>` directory.
     #
     # @return [String]
+    #
+    # @api public
     attr_reader :local_share_dir
 
     # The `~/.cache/<xdg_namespace>` directory.
     #
     # @return [String]
+    #
+    # @api public
     attr_reader :cache_dir
 
     #
@@ -138,6 +149,8 @@ module CommandKit
     #
     # @see ClassMethods#xdg_namespace
     #
+    # @api semipublic
+    #
     def xdg_namespace
       self.class.xdg_namespace
     end

data/spec/arguments/argument_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/arguments/argument'
 
-describe Arguments::Argument do
+describe CommandKit::Arguments::Argument do
   let(:name)     { :foo }
   let(:usage)    { 'FOO' }
   let(:required) { true }

data/spec/arguments_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/arguments'
 
-describe Arguments do
+describe CommandKit::Arguments do
   module TestArguments
     class ImplicitCmd
       include CommandKit::Arguments
@@ -13,8 +13,8 @@ describe Arguments do
   describe ".included" do
     subject { command_class }
 
-    it { expect(subject).to include(Main) }
-    it { expect(subject).to include(Help) }
+    it { expect(subject).to include(CommandKit::Main) }
+    it { expect(subject).to include(CommandKit::Help) }
   end
 
   describe ".arguments" do
@@ -192,29 +192,5 @@ describe Arguments do
 
       subject.help
     end
-
-    context "when the superclass defines it's own #help method" do
-      module TestDescription
-        class SuperclassHelpMethod
-          def help
-            puts 'superclass'
-          end
-        end
-
-        class InheritedHelpMethod < SuperclassHelpMethod
-          include CommandKit::Arguments
-        end
-      end
-
-      let(:super_command_class) { TestDescription::SuperclassHelpMethod }
-      let(:command_class) { TestDescription::InheritedHelpMethod }
-
-      it "must call the superclass'es #help method first" do
-        expect_any_instance_of(super_command_class).to receive(:help)
-        expect(subject).to receive(:help_arguments)
-
-        subject.help
-      end
-    end
   end
 end

data/spec/colors_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/colors'
 
-describe Colors do
+describe CommandKit::Colors do
   module TestColors
     class TestCommand
       include CommandKit::Colors
@@ -11,10 +11,10 @@ describe Colors do
   let(:command_class) { TestColors::TestCommand }
   subject { command_class.new }
 
-  it { expect(described_class).to include(Stdio) }
-  it { expect(described_class).to include(Env) }
+  it { expect(described_class).to include(CommandKit::Stdio) }
+  it { expect(described_class).to include(CommandKit::Env) }
 
-  describe Colors::ANSI do
+  describe CommandKit::Colors::ANSI do
     subject { described_class }
 
     describe "RESET" do
@@ -188,7 +188,7 @@ describe Colors do
     end
   end
 
-  describe Colors::PlainText do
+  describe CommandKit::Colors::PlainText do
     subject { described_class }
 
     let(:str) { 'foo' }
@@ -409,13 +409,15 @@ describe Colors do
 
       before { allow(stdout).to receive(:tty?).and_return(true) }
 
-      it { expect(subject.colors).to be(Colors::ANSI) }
+      it do
+        expect(subject.colors).to be(described_class::ANSI)
+      end
 
       context "when a block is given" do
         it do
           expect { |b|
             subject.colors(&b)
-          }.to yield_with_args(Colors::ANSI)
+          }.to yield_with_args(described_class::ANSI)
         end
       end
     end
@@ -424,13 +426,15 @@ describe Colors do
       let(:stdout) { StringIO.new }
       subject { command_class.new(stdout: stdout) }
 
-      it { expect(subject.colors).to be(Colors::PlainText) }
+      it do
+        expect(subject.colors).to be(described_class::PlainText)
+      end
 
       context "when a block is given" do
         it do
           expect { |b|
             subject.colors(&b)
-          }.to yield_with_args(Colors::PlainText)
+          }.to yield_with_args(described_class::PlainText)
         end
       end
     end
@@ -441,13 +445,15 @@ describe Colors do
 
         before { allow(stream).to receive(:tty?).and_return(true) }
 
-        it { expect(subject.colors(stream)).to be(Colors::ANSI) }
+        it do
+          expect(subject.colors(stream)).to be(described_class::ANSI)
+        end
 
         context "when a block is given" do
           it do
             expect { |b|
               subject.colors(stream,&b)
-            }.to yield_with_args(Colors::ANSI)
+            }.to yield_with_args(described_class::ANSI)
           end
         end
       end
@@ -455,13 +461,15 @@ describe Colors do
       context "but the alternate stream does not support ANSI" do
         let(:stream) { StringIO.new }
 
-        it { expect(subject.colors(stream)).to be(Colors::PlainText) }
+        it do
+          expect(subject.colors(stream)).to be(described_class::PlainText)
+        end
 
         context "when a block is given" do
           it do
             expect { |b|
               subject.colors(stream,&b)
-            }.to yield_with_args(Colors::PlainText)
+            }.to yield_with_args(described_class::PlainText)
           end
         end
       end

data/spec/command_name_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/command_name'
 
-describe CommandName do
+describe CommandKit::CommandName do
   module TestCommandName
     class ImplicitCmd
       include CommandKit::CommandName

data/spec/command_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/command'
 
-describe Command do
+describe CommandKit::Command do
   it "must include CommandKit::Main" do
     expect(described_class).to include(CommandKit::Main)
   end
@@ -46,4 +46,7 @@ describe Command do
     expect(described_class).to include(CommandKit::ExceptionHandler)
   end
 
+  it "must include FileUtils" do
+    expect(described_class).to include(FileUtils)
+  end
 end