cliqr 1.2.0 → 2.0.0

data/spec/fixtures/action_reader_command.rb

@@ -4,7 +4,7 @@
 class ActionReaderCommand < Cliqr.command
   def execute(context)
     puts "command = #{context.command}\n\n"
-    puts "executing action = #{context.action_name}" if context.action?
+    puts "executing action = #{context.action_name}" if context.action_type?
     context.options.each do |option|
       puts "[option] #{option.name} => #{option.value}"
     end

data/spec/fixtures/test_arg_printer_event_handler.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# Event handler that prints arguments
+class TestArgPrinterEventHandler < Cliqr.event_handler
+  def handle(event, ch, num)
+    puts event.name
+    puts "#{ch} => #{num}"
+  end
+end

data/spec/fixtures/test_color_shell_prompt.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+# A custom colored test command prompt
+class TestColorShellPrompt < Cliqr.shell_prompt
+  def initialize
+    @count = 0
+  end
+
+  def build(_context)
+    @count += 1
+    red("test-prompt [#{@count}] > ")
+  end
+end

data/spec/fixtures/test_empty_event_handler.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+# Empty event handler
+class TestEmptyEventHandler < Cliqr.event_handler
+end

data/spec/fixtures/test_invoker_event_handler.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# Event handler that invokes another event
+class TestInvokerEventHandler < Cliqr.event_handler
+  def handle(event, ch, num)
+    puts "invoked #{event.name} : #{event.command} : #{ch} : #{num}"
+    invoke :foo, 'b', 2, :t => 1
+  end
+end

data/spec/fixtures/test_shell_banner.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+# A custom test command banner
+class TestShellBanner < Cliqr.shell_banner
+  def build(context)
+    "welcome to the command #{context.command}"
+  end
+end

data/spec/fixtures/test_shell_prompt.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+# A custom test command prompt
+class TestShellPrompt < Cliqr.shell_prompt
+  def initialize
+    @count = 0
+  end
+
+  def build(_context)
+    @count += 1
+    "test-prompt [#{@count}] > "
+  end
+end

data/spec/shell/shell_executor_spec.rb

@@ -0,0 +1,700 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'fixtures/test_command'
+require 'fixtures/test_shell_prompt'
+require 'fixtures/test_color_shell_prompt'
+require 'fixtures/test_shell_banner'
+
+describe Cliqr::Command::ShellCommand do
+  it 'can execute help in command shell' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      description 'this is a test command'
+      color :disable
+
+      action :foo do
+        description 'the foo action'
+      end
+
+      action :bar do
+        description 'bar command'
+
+        action :baz
+      end
+    end
+
+    with_input(%w(help -h)) do
+      result = cli.execute_internal %w(my-command shell), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ help.
+my-command -- this is a test command
+
+Available actions:
+[ Type "help [action-name]" to get more information about that action ]
+
+    foo -- the foo action
+    bar -- bar command
+    help -- The help action for command "my-command" which provides details and usage information on how to use the command.
+[my-command][2] $ -h.
+unknown action "-h"
+[my-command][3] $ exit.
+shell exited with code 0
+      EOS
+    end
+
+    with_input(['help bar']) do
+      result = cli.execute_internal %w(my-command shell), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][4] $ help bar.
+my-command bar -- bar command
+
+Available actions:
+[ Type "help [action-name]" to get more information about that action ]
+
+    baz
+    help -- The help action for command "my-command bar" which provides details and usage information on how to use the command.
+[my-command][5] $ exit.
+shell exited with code 0
+      EOS
+    end
+  end
+
+  it 'can execute help in shell with a different name' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      description 'this is a test command'
+      color :disable
+
+      shell do
+        name 'custom-shell'
+        description 'this is a custom shell'
+      end
+    end
+
+    with_input(%w(help)) do
+      result = cli.execute_internal %w(my-command custom-shell), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ help.
+my-command -- this is a test command
+
+Available actions:
+[ Type "help [action-name]" to get more information about that action ]
+
+    help -- The help action for command "my-command" which provides details and usage information on how to use the command.
+    custom-shell -- this is a custom shell
+[my-command][2] $ exit.
+shell exited with code 0
+      EOS
+    end
+  end
+
+  it 'can execute a sub action from shell' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      color :disable
+
+      handler do
+        puts 'base command executed'
+      end
+
+      action :foo do
+        handler do
+          puts 'foo executed'
+        end
+
+        action :bar do
+          handler do
+            puts 'bar executed'
+            puts "option: #{opt}" if opt?
+          end
+
+          option :opt
+        end
+      end
+    end
+
+    with_input(['', 'my-command', 'foo', 'foo bar', 'foo bar --opt yes', 'foo bar help']) do
+      result = cli.execute_internal %w(my-command shell), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ .
+[my-command][2] $ my-command.
+unknown action "my-command"
+[my-command][3] $ foo.
+foo executed
+[my-command][4] $ foo bar.
+bar executed
+[my-command][5] $ foo bar --opt yes.
+bar executed
+option: yes
+[my-command][6] $ foo bar help.
+my-command foo bar
+
+Available actions:
+[ Type "help [action-name]" to get more information about that action ]
+
+    help -- The help action for command "my-command foo bar" which provides details and usage information on how to use the command.
+[my-command][7] $ exit.
+shell exited with code 0
+      EOS
+    end
+  end
+
+  it 'does not allow shell action if shell config is disabled' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      shell :disable
+      arguments :disable
+    end
+    expect { cli.execute_internal %w(my-command shell) }.to(
+      raise_error(Cliqr::Error::IllegalArgumentError, 'invalid command argument "shell"'))
+  end
+
+  it 'can handle errors in shell' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      arguments :disable
+      color :disable
+
+      action :foo do
+        handler do
+          fail StandardError, 'I failed!'
+        end
+
+        action :bar
+      end
+    end
+
+    with_input(['unknown', '--opt-1 val', 'foo']) do
+      result = cli.execute_internal %w(my-command shell), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ unknown.
+unknown action "unknown"
+[my-command][2] $ --opt-1 val.
+unknown action "--opt-1"
+[my-command][3] $ foo.
+command 'my-command foo' failed
+
+Cause: StandardError - I failed!
+[my-command][4] $ exit.
+shell exited with code 0
+      EOS
+    end
+  end
+
+  it 'can pass options to shell command' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      color :disable
+
+      on :shell_start do
+        puts 'base: shell started'
+        puts foo?
+        puts foo
+        puts bar?
+        puts bar
+        puts baz?
+        puts baz
+      end
+
+      on :shell_stop do
+        puts 'base: shell stopped'
+        puts foo?
+        puts foo
+        puts bar?
+        puts bar
+        puts baz?
+        puts baz
+      end
+
+      shell :enable do
+        on :shell_start do
+          puts 'shell started'
+          puts foo?
+          puts foo
+          puts bar?
+          puts bar
+          puts baz?
+          puts baz
+        end
+
+        on :shell_stop do
+          puts 'shell stopped'
+          puts foo?
+          puts foo
+          puts bar?
+          puts bar
+          puts baz?
+          puts baz
+        end
+
+        option :foo do
+          short 'f'
+        end
+
+        option :bar do
+          type :boolean
+        end
+
+        option :baz do
+          type :numeric
+          default 10
+        end
+      end
+    end
+
+    with_input(['']) do
+      result = cli.execute_internal %w(my-command shell -f qwerty --no-bar), output: :buffer
+      expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+shell started
+true
+qwerty
+true
+false
+false
+10
+base: shell started
+true
+qwerty
+true
+false
+false
+10
+[my-command][1] $ .
+[my-command][2] $ exit.
+shell stopped
+true
+qwerty
+true
+false
+false
+10
+base: shell stopped
+true
+qwerty
+true
+false
+false
+10
+shell exited with code 0
+      EOS
+    end
+  end
+
+  describe 'illegal shell operations' do
+    it 'does not allow shell action if there are no sub-actions' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        help :disable
+        handler TestCommand
+        arguments :disable
+      end
+      expect { cli.execute_internal %w(my-command shell) }.to(
+        raise_error(Cliqr::Error::IllegalArgumentError, 'invalid command argument "shell"'))
+    end
+
+    it 'does not allow shell in shell for base command' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+
+        action :foo do
+          action :bar
+        end
+      end
+
+      with_input(['shell']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ shell.
+command 'my-command shell' failed
+
+Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell
+[my-command][2] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'does not allow shell in shell for sub action' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+
+        action :foo do
+          action :bar
+        end
+      end
+
+      expect { cli.execute_internal %w(my-command foo shell) }.to(
+        raise_error(Cliqr::Error::CommandRuntimeError,
+                    "command 'my-command foo' failed\n\nCause: Cliqr::Error::IllegalArgumentError - no arguments allowed for default help action\n"))
+
+      with_input(['foo shell']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ foo shell.
+command 'my-command foo' failed
+
+Cause: Cliqr::Error::IllegalArgumentError - no arguments allowed for default help action
+[my-command][2] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+  end
+
+  describe Cliqr::Command::ShellPromptBuilder do
+    it 'allows a custom prompt string for shell prompt' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          prompt 'test-prompt $ '
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+test-prompt $ .
+test-prompt $ .
+test-prompt $ foo.
+foo executed
+test-prompt $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'allows a custom prompt function for shell prompt' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          count = 0
+          prompt do
+            count += 1
+            "my-command [#{count}]$ "
+          end
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo', '']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+my-command [1]$ .
+my-command [2]$ .
+my-command [3]$ foo.
+foo executed
+my-command [4]$ .
+my-command [5]$ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'allows a custom prompt class for shell prompt' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          prompt TestShellPrompt
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo', '']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+test-prompt [1] > .
+test-prompt [2] > .
+test-prompt [3] > foo.
+foo executed
+test-prompt [4] > .
+test-prompt [5] > exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'allows a default prompt' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo', '']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ .
+[my-command][2] $ .
+[my-command][3] $ foo.
+foo executed
+[my-command][4] $ .
+[my-command][5] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    describe 'prompt colors' do
+      it 'can show colors using default prompt builder' do
+        cli = Cliqr.interface do
+          name 'my-command'
+          arguments :disable
+
+          action :foo do
+            handler do
+              fail StandardError, 'I failed!'
+            end
+
+            action :bar
+          end
+        end
+
+        with_input(['unknown', '--opt-1 val', 'foo']) do
+          result = cli.execute_internal %w(my-command shell), output: :buffer
+          expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+[my-command][1] $ unknown.
+unknown action "unknown"
+[my-command][2] $ --opt-1 val.
+unknown action "--opt-1"
+[my-command][3] $ foo.
+command 'my-command foo' failed
+
+Cause: StandardError - I failed!
+[my-command][4] $ exit.
+shell exited with code 0
+          EOS
+        end
+      end
+
+      it 'can show colors using custom prompt builder' do
+        cli = Cliqr.interface do
+          name 'my-command'
+          arguments :disable
+
+          shell do
+            prompt TestColorShellPrompt
+          end
+
+          action :foo do
+            handler do
+              fail StandardError, 'I failed!'
+            end
+
+            action :bar
+          end
+        end
+
+        with_input(['unknown', '--opt-1 val', 'foo']) do
+          result = cli.execute_internal %w(my-command shell), output: :buffer
+          expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+test-prompt [1] > unknown.
+unknown action "unknown"
+test-prompt [2] > --opt-1 val.
+unknown action "--opt-1"
+test-prompt [3] > foo.
+command 'my-command foo' failed
+
+Cause: StandardError - I failed!
+test-prompt [4] > exit.
+shell exited with code 0
+          EOS
+        end
+      end
+
+      it 'can show colors using custom prompt builder' do
+        cli = Cliqr.interface do
+          name 'my-command'
+          arguments :disable
+
+          shell do
+            prompt do
+              green('green prompt > ')
+            end
+          end
+
+          action :foo do
+            handler do
+              fail StandardError, 'I failed!'
+            end
+
+            action :bar
+          end
+        end
+
+        with_input(['unknown', '--opt-1 val', 'foo']) do
+          result = cli.execute_internal %w(my-command shell), output: :buffer
+          expect(result[:stdout]).to eq <<-EOS
+Starting shell for command "my-command"
+green prompt > unknown.
+unknown action "unknown"
+green prompt > --opt-1 val.
+unknown action "--opt-1"
+green prompt > foo.
+command 'my-command foo' failed
+
+Cause: StandardError - I failed!
+green prompt > exit.
+shell exited with code 0
+          EOS
+        end
+      end
+    end
+  end
+
+  describe Cliqr::Command::ShellBannerBuilder do
+    it 'allows a custom prompt string for shell banner' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          banner 'Welcome to my-command!!!'
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+Welcome to my-command!!!
+[my-command][1] $ .
+[my-command][2] $ .
+[my-command][3] $ foo.
+foo executed
+[my-command][4] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'allows a custom prompt function for shell banner' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          banner do
+            "welcome to #{command}"
+          end
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo', '']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+welcome to my-command
+[my-command][1] $ .
+[my-command][2] $ .
+[my-command][3] $ foo.
+foo executed
+[my-command][4] $ .
+[my-command][5] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+
+    it 'allows a custom prompt class for shell banner' do
+      cli = Cliqr.interface do
+        name 'my-command'
+        color :disable
+        shell :enable do
+          banner TestShellBanner
+        end
+
+        action :foo do
+          handler do
+            puts 'foo executed'
+          end
+        end
+      end
+
+      with_input(['', '', 'foo', '']) do
+        result = cli.execute_internal %w(my-command shell), output: :buffer
+        expect(result[:stdout]).to eq <<-EOS
+welcome to the command my-command
+[my-command][1] $ .
+[my-command][2] $ .
+[my-command][3] $ foo.
+foo executed
+[my-command][4] $ .
+[my-command][5] $ exit.
+shell exited with code 0
+        EOS
+      end
+    end
+  end
+end
+
+def with_input(lines, &block)
+  old_stdin = $stdin
+  $stdin = TestIO.new(lines)
+  block.call
+ensure
+  $stdin = old_stdin
+end
+
+# A test class for wrapping stdin
+class TestIO
+  def initialize(lines)
+    @lines = lines.reverse
+  end
+
+  def gets
+    input = "#{@lines.length > 0 ? @lines.pop : 'exit'}"
+    puts "#{input}."
+    "#{input}\n"
+  end
+end