command_kit 0.3.0 → 0.4.0

data/lib/command_kit/printing/tables.rb

@@ -0,0 +1,208 @@
+# 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'
+
+module CommandKit
+  module Printing
+    #
+    # Methods for printing tables.
+    #
+    # ## Examples
+    #
+    #     include CommandKit::Printing::Tables
+    #
+    #     def run
+    #       header = ['A', 'B', 'C']
+    #       table = [
+    #         ['AAAA', 'BBBB', 'CCCC'],
+    #         ['AAAA', 'BBBB', 'CCCC'],
+    #         ['AAAA', 'BBBB', 'CCCC']
+    #       ]
+    #
+    #       print_table table
+    #       # AAAA  BBBB  CCCC 
+    #       # AAAA  BBBB  CCCC 
+    #       # AAAA  BBBB  CCCC 
+    #
+    #       print_table table, header: header
+    #       #  A     B     C   
+    #       #
+    #       # AAAA  BBBB  CCCC 
+    #       # AAAA  BBBB  CCCC 
+    #       # AAAA  BBBB  CCCC 
+    #
+    #       print_table table, header: header,
+    #                          border: :ascii
+    #       # +------+------+------+
+    #       # |  A   |  B   |  C   |
+    #       # +------+------+------+
+    #       # | AAAA | BBBB | CCCC |
+    #       # | AAAA | BBBB | CCCC |
+    #       # | AAAA | BBBB | CCCC |
+    #       # +------+------+------+
+    #
+    #       print_table table, header: header,
+    #                          border: :ascii,
+    #                          separate_rows: true
+    #       # +------+------+------+
+    #       # |  A   |  B   |  C   |
+    #       # +------+------+------+
+    #       # | AAAA | BBBB | CCCC |
+    #       # +------+------+------+
+    #       # | AAAA | BBBB | CCCC |
+    #       # +------+------+------+
+    #       # | AAAA | BBBB | CCCC |
+    #       # +------+------+------+
+    #
+    #       print_table table, header: header,
+    #                          border: :line
+    #       # ┌──────┬──────┬──────┐
+    #       # │  A   │  B   │  C   │
+    #       # ├──────┼──────┼──────┤
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # └──────┴──────┴──────┘
+    #
+    #       print_table table, header: header,
+    #                          border: :double_line
+    #       # ╔══════╦══════╦══════╗
+    #       # ║  A   ║  B   ║  C   ║
+    #       # ╠══════╬══════╬══════╣
+    #       # ║ AAAA ║ BBBB ║ CCCC ║
+    #       # ║ AAAA ║ BBBB ║ CCCC ║
+    #       # ║ AAAA ║ BBBB ║ CCCC ║
+    #       # ╚══════╩══════╩══════╝
+    #
+    #       uneven_table = [
+    #         ['AAAAAA', 'B',       'CCCCCCC'],
+    #         ['AAA',    'BBBB',    'CCC'    ],
+    #         ['A',      'BBBBBBB', 'C'      ]
+    #       ]
+    #
+    #       print_table uneven_table, header: header,
+    #                                 justify: :left,
+    #                                 justify_header: :left,
+    #                                 border: :line
+    #       # ┌────────┬─────────┬─────────┐
+    #       # │ A      │ B       │ C       │
+    #       # ├────────┼─────────┼─────────┤
+    #       # │ AAAAAA │ B       │ CCCCCCC │
+    #       # │ AAA    │ BBBB    │ CCC     │
+    #       # │ A      │ BBBBBBB │ C       │
+    #       # └────────┴─────────┴─────────┘
+    #
+    #       print_table uneven_table, header: header,
+    #                                 justify: :right,
+    #                                 justify_header: :right,
+    #                                 border: :line
+    #       # ┌────────┬─────────┬─────────┐
+    #       # │      A │       B │       C │
+    #       # ├────────┼─────────┼─────────┤
+    #       # │ AAAAAA │       B │ CCCCCCC │
+    #       # │    AAA │    BBBB │     CCC │
+    #       # │      A │ BBBBBBB │       C │
+    #       # └────────┴─────────┴─────────┘
+    #
+    #       print_table uneven_table, header: header,
+    #                                 justify: :center,
+    #                                 justify_header: :center,
+    #                                 border: :line
+    #       # ┌────────┬─────────┬─────────┐
+    #       # │   A    │    B    │    C    │
+    #       # ├────────┼─────────┼─────────┤
+    #       # │ AAAAAA │    B    │ CCCCCCC │
+    #       # │  AAA   │  BBBB   │   CCC   │
+    #       # │   A    │ BBBBBBB │    C    │
+    #       # └────────┴─────────┴─────────┘
+    #
+    #       table_with_empty_cells = [
+    #         ['AAAA', 'BBBB', 'CCCC'],
+    #         ['AAAA', nil,    'CCCC'],
+    #         ['AAAA', 'BBBB']
+    #       ]
+    #
+    #       print_table table_with_empty_cells, header:  header,
+    #                                           justify: :left,
+    #                                           border:  :line
+    #       # ┌──────┬──────┬──────┐
+    #       # │  A   │  B   │  C   │
+    #       # ├──────┼──────┼──────┤
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │ AAAA │      │ CCCC │
+    #       # │ AAAA │ BBBB │      │
+    #       # └──────┴──────┴──────┘
+    #
+    #       multi_line_table = [
+    #         ['AAAA',        'BBBB',    "CCCC\nCC"],
+    #         ['AAAA',        "BBBB\nB", 'CCCC'],
+    #         ["AAAA\nAA\nA", "BBBB",    "CCCC"]
+    #       ]
+    #
+    #       print_table multi_line_table, header:  header,
+    #                                     justify: :left,
+    #                                     border:  :line
+    #       # ┌──────┬──────┬──────┐
+    #       # │  A   │  B   │  C   │
+    #       # ├──────┼──────┼──────┤
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │      │      │ CC   │
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │      │ B    │      │
+    #       # │ AAAA │ BBBB │ CCCC │
+    #       # │ AA   │      │      │
+    #       # │ A    │      │      │
+    #       # └──────┴──────┴──────┘
+    #     end
+    #
+    # @since 0.4.0
+    #
+    module Tables
+      include Indent
+
+      #
+      # Prints a table of rows.
+      #
+      # @param [Array<Array>] rows
+      #   The table rows.
+      #
+      # @param [Array, nil] header
+      #   The optional header row.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @option kwargs [:line, :double_line, nil, Hash{Symbol => String}, :ascii] :border
+      #   The border style or a custom Hash of border characters.
+      #
+      # @option [Integer] :padding (1)
+      #   The number of characters to pad table cell values with.
+      #
+      # @option [:left, :right, :center] :justify (:left)
+      #   Specifies how to justify the table cell values.
+      #
+      # @option [:left, :right, :center] :justify_header (:center)
+      #   Specifies how to justify the table header cell values.
+      #
+      # @option [Boolean] :separate_rows (false)
+      #   Specifies whether to add separator rows in between the rows.
+      #
+      # @api public
+      #
+      def print_table(rows, header: nil, **kwargs)
+        table     = TableBuilder.new(rows, header: header)
+        style     = Style.new(**kwargs)
+        formatter = TableFormatter.new(table,style)
+
+        formatter.format do |line|
+          puts line
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/lib/command_kit/stdio.rb

@@ -7,7 +7,11 @@ module CommandKit
   #     class MyCmd
   #       include CommandKit::Stdio
   #
-  #       def main
+  #       def run
+  #         print 'Name: '
+  #         name = gets
+  #
+  #         puts "Hello #{name}!"
   #       end
   #     end
   #

data/lib/command_kit/version.rb

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

data/spec/bug_report_spec.rb

@@ -0,0 +1,266 @@
+require 'spec_helper'
+require 'command_kit/bug_report'
+
+describe CommandKit::BugReport do
+  module TestBugReport
+    class CommandWithoutBugReportURLSet
+      include CommandKit::BugReport
+    end
+
+    class CommandWithBugReportURLSet
+      include CommandKit::BugReport
+
+      bug_report_url 'https://github.com/org/repo/issues/new'
+    end
+
+    class CommandWithInheritedBugReportURL < CommandWithBugReportURLSet
+    end
+  end
+
+  let(:command_class) { TestBugReport::CommandWithBugReportURLSet }
+
+  describe ".included" do
+    it { expect(command_class).to include(CommandKit::ExceptionHandler) }
+    it { expect(command_class).to include(CommandKit::Printing) }
+  end
+
+  describe ".bug_report_url" do
+    subject { TestBugReport::CommandWithoutBugReportURLSet }
+
+    context "when no bug_report_url has been set" do
+      it "should default to nil" do
+        expect(subject.bug_report_url).to be_nil
+      end
+    end
+
+    context "when a bug_report_url is explicitly set" do
+      subject { TestBugReport::CommandWithBugReportURLSet }
+
+      it "must return the explicitly set bug_report_url" do
+        expect(subject.bug_report_url).to eq("https://github.com/org/repo/issues/new")
+      end
+    end
+
+    context "when the command class inherites from another class" do
+      context "but no bug_report_url is set" do
+        module TestBugReport
+          class BaseCmd
+            include CommandKit::BugReport
+          end
+
+          class InheritedCmd < BaseCmd
+          end
+        end
+
+        subject { TestBugReport::InheritedCmd }
+
+        it "must search each class then return nil "do
+          expect(subject.bug_report_url).to be_nil
+        end
+      end
+
+      module TestBugReport
+        class ExplicitBaseCmd
+          include CommandKit::BugReport
+          bug_report_url 'https://github.com/org/repo/issues/new'
+        end
+      end
+
+      context "when the superclass defines an explicit bug_report_url" do
+        module TestBugReport
+          class ImplicitInheritedCmd < ExplicitBaseCmd
+          end
+        end
+
+        let(:super_subject) { TestBugReport::ExplicitBaseCmd }
+        subject { TestBugReport::ImplicitInheritedCmd }
+
+        it "must inherit the superclass'es bug_report_url" do
+          expect(subject.bug_report_url).to eq(super_subject.bug_report_url)
+        end
+
+        it "must not change the superclass'es bug_report_url" do
+          expect(super_subject.bug_report_url).to eq('https://github.com/org/repo/issues/new')
+        end
+      end
+
+      context "when the subclass defines an explicit bug_report_url" do
+        module TestBugReport
+          class ImplicitBaseCmd
+            include CommandKit::BugReport
+          end
+
+          class ExplicitInheritedCmd < ImplicitBaseCmd
+            bug_report_url 'https://github.com/other_org/other_repo/issues/new'
+          end
+        end
+
+        let(:super_subject) { TestBugReport::ImplicitBaseCmd }
+        subject { TestBugReport::ExplicitInheritedCmd }
+
+        it "must return the subclass'es bug_report_url" do
+          expect(subject.bug_report_url).to eq('https://github.com/other_org/other_repo/issues/new')
+        end
+
+        it "must not change the superclass'es bug_report_url" do
+          expect(super_subject.bug_report_url).to be_nil
+        end
+      end
+
+      context "when both the subclass overrides the superclass's bug_report_urls" do
+        module TestBugReport
+          class ExplicitOverridingInheritedCmd < ExplicitBaseCmd
+            bug_report_url 'https://github.com/other_org/other_repo/issues/new'
+          end
+        end
+
+        let(:super_subject) { TestBugReport::ExplicitBaseCmd }
+        subject { TestBugReport::ExplicitOverridingInheritedCmd }
+
+        it "must return the subclass'es bug_report_url" do
+          expect(subject.bug_report_url).to eq("https://github.com/other_org/other_repo/issues/new")
+        end
+
+        it "must not change the superclass'es bug_report_url" do
+          expect(super_subject.bug_report_url).to eq("https://github.com/org/repo/issues/new")
+        end
+      end
+    end
+  end
+
+  subject { command_class.new }
+
+  describe "#bug_report_url" do
+    context "when the command has bug_report_url set" do
+      let(:command_class) { TestBugReport::CommandWithBugReportURLSet }
+
+      it "must return the bug_report_url" do
+        expect(subject.bug_report_url).to eq(command_class.bug_report_url)
+      end
+    end
+
+    context "when the command does not have bug_report_url set" do
+      let(:command_class) { TestBugReport::CommandWithoutBugReportURLSet }
+
+      it "must return nil" do
+        expect(subject.bug_report_url).to be(nil)
+      end
+    end
+  end
+
+  describe "#print_bug_report" do
+    let(:message) { "error!" }
+    let(:backtrace) do
+      [
+        "/path/to/test1.rb:1 in `test1'",
+        "/path/to/test2.rb:2 in `test2'",
+        "/path/to/test3.rb:3 in `test3'",
+        "/path/to/test4.rb:4 in `test4'"
+      ]
+    end
+    let(:exception) do
+      error = RuntimeError.new(message)
+      error.set_backtrace(backtrace)
+      error
+    end
+
+    subject { command_class.new(stderr: StringIO.new) }
+
+    context "when the command has bug_report_url set" do
+      let(:command_class) { TestBugReport::CommandWithBugReportURLSet }
+
+      context "when stderr is a TTY" do
+        before { expect(subject.stderr).to receive(:tty?).and_return(true) }
+
+        it "must print a message, bug_report_url, and a highlighted exception" do
+          subject.print_bug_report(exception)
+
+          expect(subject.stderr.string).to eq(
+            [
+              '',
+              'Oops! Looks like you have found a bug. Please report it!',
+              command_class.bug_report_url,
+              '',
+              '```',
+              exception.full_message(highlight: true).chomp,
+              '```',
+              ''
+            ].join($/)
+          )
+        end
+      end
+
+      context "when stderr is not a TTY" do
+        it "must print a message, bug_report_url, and print an unhighlighted exception" do
+          subject.print_bug_report(exception)
+
+          expect(subject.stderr.string).to eq(
+            [
+              '',
+              'Oops! Looks like you have found a bug. Please report it!',
+              command_class.bug_report_url,
+              '',
+              '```',
+              exception.full_message(highlight: false).chomp,
+              '```',
+              ''
+            ].join($/)
+          )
+        end
+      end
+    end
+
+    context "when the command does not have bug_report_url set" do
+      let(:command_class) { TestBugReport::CommandWithoutBugReportURLSet }
+
+      context "when stderr is a TTY" do
+        before { expect(subject.stderr).to receive(:tty?).and_return(true) }
+
+        it "must print a message and a highlighted exception" do
+          subject.print_bug_report(exception)
+
+          expect(subject.stderr.string).to eq(
+            [
+              '',
+              'Oops! Looks like you have found a bug. Please report it!',
+              '',
+              '```',
+              exception.full_message(highlight: true).chomp,
+              '```',
+              ''
+            ].join($/)
+          )
+        end
+      end
+
+      context "when stderr is not a TTY" do
+        it "must print a message and print an unhighlighted exception" do
+          subject.print_bug_report(exception)
+
+          expect(subject.stderr.string).to eq(
+            [
+              '',
+              'Oops! Looks like you have found a bug. Please report it!',
+              '',
+              '```',
+              exception.full_message(highlight: false).chomp,
+              '```',
+              ''
+            ].join($/)
+          )
+        end
+      end
+    end
+  end
+
+  describe "#on_exception" do
+    let(:exception) { RuntimeError.new('error!') }
+
+    it "must call print_bug_report with the exception and then exit(-1)" do
+      expect(subject).to receive(:print_bug_report).with(exception)
+      expect(subject).to receive(:exit).with(-1)
+
+      subject.on_exception(exception)
+    end
+  end
+end

data/spec/colors_spec.rb

@@ -656,6 +656,12 @@ describe CommandKit::Colors do
       it { expect(subject.ansi?).to be(false) }
     end
 
+    context "when NO_COLOR is set" do
+      subject { command_class.new(env: {'NO_COLOR' => 'true'}) }
+
+      it { expect(subject.ansi?).to be(false) }
+    end
+
     context "when stdout is a TTY" do
       let(:stdout) { StringIO.new }
       subject { command_class.new(stdout: stdout) }

data/spec/command_name_spec.rb

@@ -19,7 +19,7 @@ describe CommandKit::CommandName do
       end
     end
 
-    context "when a command_name is explicitly set" do
+    context "when a command_name has been explicitly set" do
       module TestCommandName
         class ExplicitCmd
           include CommandKit::CommandName

data/spec/edit_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'command_kit/edit'
+
+describe CommandKit::Edit do
+  module TestEdit
+    class TestCommand
+      include CommandKit::Edit
+    end
+  end
+
+  let(:command_class) { TestEdit::TestCommand }
+
+  it "must also include CommandKit::Env" do
+    expect(command_class).to include(CommandKit::Env)
+  end
+
+  describe "#editor" do
+    subject { command_class.new(env: env) }
+
+    context "when env['EDITOR'] is set" do
+      let(:editor) { 'vim' }
+      let(:env) do
+        {'EDITOR' => editor}
+      end
+
+      it "must return env['EDITOR']" do
+        expect(subject.editor).to eq(env['EDITOR'])
+      end
+    end
+
+    context "when env['EDITOR'] is not set" do
+      let(:env) do
+        {}
+      end
+
+      it "must return 'nano'" do
+        expect(subject.editor).to eq('nano')
+      end
+    end
+  end
+
+  describe "#edit" do
+    subject { command_class.new(env: env) }
+
+    let(:arguments) { ['file.txt'] }
+
+    context "when env['EDITOR'] is set" do
+      let(:editor) { 'vim' }
+      let(:env) do
+        {'EDITOR' => editor}
+      end
+
+      it "must invoke system with #editor and the additional arguments" do
+        expect(subject).to receive(:system).with(subject.editor,*arguments)
+
+        subject.edit(*arguments)
+      end
+    end
+
+    context "when env['EDITOR'] is not set" do
+      let(:env) do
+        {}
+      end
+
+      it "must invoke system with 'nano' and the additional arguments" do
+        expect(subject).to receive(:system).with('nano',*arguments)
+
+        subject.edit(*arguments)
+      end
+    end
+  end
+end

data/spec/options/option_spec.rb

@@ -6,10 +6,12 @@ describe CommandKit::Options::Option do
   let(:short)  { nil     }
   let(:long)   { '--foo' }
   let(:equals) { false   }
+  let(:value_usage)    { 'FOO' }
+  let(:value_required) { true  }
   let(:value) do
     {
-      usage:    'FOO',
-      required: true
+      usage:    value_usage,
+      required: value_required
     }
   end
   let(:desc)  { 'Foo option' }
@@ -228,6 +230,14 @@ describe CommandKit::Options::Option do
         it "must return '--option=USAGE'" do
           expect(subject.usage.last).to eq("#{long}=#{subject.value.usage}")
         end
+
+        context "but the #value is also optional?" do
+          let(:value_required) { false }
+
+          it "must return '--option[=USAGE]'" do
+            expect(subject.usage.last).to eq("#{long}[=#{subject.value.usage}]")
+          end
+        end
       end
     end
 

data/spec/options/quiet_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'command_kit/options/quiet'
+
+describe CommandKit::Options::Quiet do
+  module TestOptionsQuiet
+    class TestCommand
+      include CommandKit::Options::Quiet
+    end
+  end
+
+  let(:command_class) { TestOptionsQuiet::TestCommand }
+
+  describe ".included" do
+    subject { command_class }
+
+    it "must include CommandKit::Options" do
+      expect(subject).to include(CommandKit::Options)
+    end
+
+    it "must define a quiet option" do
+      expect(subject.options[:quiet]).to_not be(nil)
+      expect(subject.options[:quiet].short).to eq('-q')
+      expect(subject.options[:quiet].long).to eq('--quiet')
+      expect(subject.options[:quiet].desc).to eq('Enables quiet output')
+    end
+  end
+
+  subject { command_class.new }
+
+  describe "#quiet?" do
+    context "when @quiet is true" do
+      before do
+        subject.instance_variable_set('@quiet',true)
+      end
+
+      it "must return true" do
+        expect(subject.quiet?).to be(true)
+      end
+    end
+
+    context "when @quiet is false" do
+      before do
+        subject.instance_variable_set('@quiet',false)
+      end
+
+      it "must return false" do
+        expect(subject.quiet?).to be(false)
+      end
+    end
+  end
+end