cliqr 1.2.0 → 2.0.0

data/spec/executor/executor_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 require 'cliqr/error'
+require 'cliqr/executor/runner'
 
 require 'fixtures/test_command'
 require 'fixtures/always_error_command'
@@ -13,7 +14,7 @@ require 'fixtures/argument_reader_command'
 require 'fixtures/test_option_type_checker_command'
 require 'fixtures/csv_argument_operator'
 
-describe Cliqr::CLI::Executor do
+describe Cliqr::Executor::Runner do
   it 'returns code 0 for default command runner' do
     expect(Cliqr.command.new.execute(nil)).to eq(0)
   end
@@ -244,7 +245,7 @@ value = operator-inline
       handler do
         puts 'in my-command'
         puts options.map { |option| "#{option.name} => #{option.value}" }
-        puts action?
+        puts action_type?
         puts option?('option-1')
         puts option?('option-2')
         puts option?('option-3')
@@ -258,7 +259,7 @@ value = operator-inline
           puts 'in my-action'
           puts options.map { |option| "#{option.name} => #{option.value}" }
           puts option('option-3').value
-          puts action?
+          puts action_type?
           puts option?('option-1')
           puts option?('option-2')
           puts option?('option-3')
@@ -438,18 +439,55 @@ false
     EOS
   end
 
-  it 'can use version action on action command' do
+  it 'can not use version action on action command' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+
+        action :bla do
+          version '1234'
+        end
+      end
+    end
+    expect { define_interface }.to(raise_error(NoMethodError))
+  end
+
+  it 'can forward command to another action' do
     cli = Cliqr.interface do
-      name 'my-command'
+      name :my_command
+      description 'test command has no description'
 
-      action :bla do
-        version '1234'
+      action :action_1 do
+        description 'test action'
+        handler do
+          puts 'in action_1'
+          forward 'my_command action_2 sub-action' # starting with base command name
+          puts 'back in action_1'
+        end
+      end
+
+      action 'action_2' do
+        handler do
+          puts 'in action_2'
+        end
+
+        action 'sub-action' do
+          handler do
+            puts 'in sub-action'
+            forward 'action_2' # not starting with base command name
+            puts 'back in sub-action'
+          end
+        end
       end
     end
 
-    result = cli.execute_internal ['bla version'], output: :buffer
+    result = cli.execute_internal ['action_1'], output: :buffer
     expect(result[:stdout]).to eq <<-EOS
-1234
+in action_1
+in sub-action
+in action_2
+back in sub-action
+back in action_1
     EOS
   end
 
@@ -483,7 +521,7 @@ false
       old_stdout = $stdout
       $stdout = old_stdout.is_a?(StringIO) ? old_stdout : StringIO.new('', 'w')
       begin
-        expect(cli.execute(['abcd'])).to(eq(1))
+        expect(cli.execute(['abcd'])).to(eq(101))
         expect($stdout.string).to(eq("command 'my-command' failed\n\nCause: StandardError - I am not a happy handler!\n"))
       ensure
         $stdout = old_stdout
@@ -499,7 +537,7 @@ false
       old_stdout = $stdout
       $stdout = old_stdout.is_a?(StringIO) ? old_stdout : StringIO.new('', 'w')
       begin
-        expect(cli.execute(['abcd'])).to(eq(2))
+        expect(cli.execute(['abcd'])).to(eq(102))
         expect($stdout.string).to(eq("invalid command argument \"abcd\"\n"))
       ensure
         $stdout = old_stdout

data/spec/executor/help_executor_spec.rb

@@ -6,43 +6,18 @@ require 'cliqr/error'
 
 require 'fixtures/test_command'
 
-describe Cliqr::CLI::Executor do
+describe Cliqr::Executor do
   it 'can execute help action to get help for base command' do
     cli = Cliqr.interface do
       name 'my-command'
       description 'test command has no description'
-      handler TestCommand
+      color :disable
     end
 
     result = cli.execute_internal ['help'], output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 my-command -- test command has no description
 
-USAGE:
-    my-command [actions] [options] [arguments]
-
-Available options:
-
-    --help, -h  :  Get helpful information for action "my-command" along with its usage information.
-
-Available actions:
-[ Type "my-command 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.
-    EOS
-  end
-
-  it 'can execute help option to get help for base command' do
-    cli = Cliqr.interface do
-      name 'my-command'
-      description 'test command has no description'
-      handler TestCommand
-    end
-
-    result = cli.execute_internal ['--help'], output: :buffer
-    expect(result[:stdout]).to eq <<-EOS
-my-command -- test command has no description
-
 USAGE:
     my-command [actions] [options] [arguments]
 
@@ -61,16 +36,13 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
-        shell :disable
 
         action :sub_action do
           description 'This is a sub action.'
-          handler TestCommand
         end
 
         option :temp do
@@ -80,7 +52,6 @@ Available actions:
 
       action :action_2 do
         description 'another cool action for the base command'
-        handler TestCommand
       end
     end
 
@@ -100,7 +71,6 @@ Available actions:
 [ Type "my_command action_1 help [action-name]" to get more information about that action ]
 
     sub_action -- This is a sub action.
-
     help -- The help action for command "my_command action_1" which provides details and usage information on how to use the command.
     EOS
   end
@@ -109,15 +79,13 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
 
         action :sub_action do
           description 'This is a sub action.'
-          handler TestCommand
         end
 
         option :temp do
@@ -127,7 +95,6 @@ Available actions:
 
       action :action_2 do
         description 'another cool action for the base command'
-        handler TestCommand
       end
     end
 
@@ -153,16 +120,14 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
       shell :disable
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
 
         action :sub_action do
           description 'This is a sub action.'
-          handler TestCommand
         end
 
         option :temp do
@@ -172,7 +137,6 @@ Available actions:
 
       action :action_2 do
         description 'another cool action for the base command'
-        handler TestCommand
       end
     end
 
@@ -191,9 +155,7 @@ Available actions:
 [ Type "my_command help [action-name]" to get more information about that action ]
 
     action_1 -- test action
-
     action_2 -- another cool action for the base command
-
     help -- The help action for command "my_command" which provides details and usage information on how to use the command.
     EOS
   end
@@ -202,7 +164,7 @@ Available actions:
     cli = Cliqr.interface do
       name 'my-command'
       description 'test command has no description'
-      handler TestCommand
+      color :disable
     end
 
     result = cli.execute_internal ['--help'], output: :buffer
@@ -227,11 +189,9 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
+      color :disable
 
-      action :action_1 do
-        handler TestCommand
-      end
+      action :action_1
     end
 
     result = cli.execute_internal %w(--help action_1), output: :buffer
@@ -256,11 +216,10 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
       end
     end
 
@@ -286,11 +245,10 @@ Available actions:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
       end
     end
 
@@ -307,11 +265,9 @@ USAGE:
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
-      handler TestCommand
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
       end
     end
 
@@ -321,63 +277,19 @@ USAGE:
                   "Cause: Cliqr::Error::IllegalArgumentError - too many arguments for \"my_command help\" command\n"))
   end
 
-  it 'can forward command to another action' do
-    cli = Cliqr.interface do
-      name :my_command
-      description 'test command has no description'
-      handler TestCommand
-
-      action :action_1 do
-        description 'test action'
-        handler do
-          puts 'in action_1'
-          forward 'my_command action_2 sub-action' # starting with base command name
-          puts 'back in action_1'
-        end
-      end
-
-      action 'action_2' do
-        handler do
-          puts 'in action_2'
-        end
-
-        action 'sub-action' do
-          handler do
-            puts 'in sub-action'
-            forward 'action_2' # not starting with base command name
-            puts 'back in sub-action'
-          end
-        end
-      end
-    end
-
-    result = cli.execute_internal ['action_1'], output: :buffer
-    expect(result[:stdout]).to eq <<-EOS
-in action_1
-in sub-action
-in action_2
-back in sub-action
-back in action_1
-    EOS
-  end
-
   it 'executes help for action without handler' do
     cli = Cliqr.interface do
       name :my_command
       description 'test command has no description'
       shell :disable
+      color :disable
 
       action :action_1 do
         description 'test action'
-        handler TestCommand
       end
 
       action 'action_2' do
-        shell :disable
-
-        action 'sub-action' do
-          handler TestCommand
-        end
+        action 'sub-action'
       end
     end
 
@@ -396,9 +308,7 @@ Available actions:
 [ Type "my_command help [action-name]" to get more information about that action ]
 
     action_1 -- test action
-
     action_2
-
     help -- The help action for command "my_command" which provides details and usage information on how to use the command.
     EOS
 
@@ -417,8 +327,102 @@ Available actions:
 [ Type "my_command action_2 help [action-name]" to get more information about that action ]
 
     sub-action
-
     help -- The help action for command "my_command action_2" which provides details and usage information on how to use the command.
     EOS
   end
+
+  it 'can display help in color' do
+    cli = Cliqr.interface do
+      name :my_command
+      description 'test command has no description'
+
+      action :foo do
+        description 'test action'
+
+        action :bar do
+          description 'this is a bar'
+
+          option :opt1 do
+            type :numeric
+            default 123
+            description 'a temporary option'
+          end
+        end
+      end
+    end
+
+    result = cli.execute_internal %w(foo help bar), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+my_command foo bar -- this is a bar
+
+USAGE:
+    my_command foo bar [actions] [options] [arguments]
+
+Available options:
+
+    --opt1  :  <numeric> a temporary option (default => 123)
+    --help, -h  :  Get helpful information for action "my_command foo bar" along with its usage information.
+
+Available actions:
+[ Type "my_command foo bar 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.
+    EOS
+  end
+
+  it 'can use options in shell config' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      handler TestCommand
+      color :disable
+
+      shell do
+        name 'b00m'
+        description 'this is a custom shell implementation'
+
+        option :foo
+
+        option :bar do
+          type :boolean
+          default true
+          description 'some bar'
+        end
+
+        option :baz do
+          type :numeric
+          default 10
+        end
+      end
+    end
+
+    result = cli.execute_internal %w(help b00m), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+my-command b00m -- this is a custom shell implementation
+
+USAGE:
+    my-command b00m [options]
+
+Available options:
+
+    --foo
+    --[no-]bar  :  <boolean> some bar (default => true)
+    --baz  :  <numeric> (default => 10)
+    EOS
+  end
+
+  it 'does not allow version command to have arguments' do
+    cli = Cliqr.interface do
+      name 'my-command'
+      color :disable
+      version '1.2.3.4'
+    end
+
+    result = cli.execute_internal %w(help version), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+my-command version -- Get version information for command "my-command".
+
+USAGE:
+    my-command version
+    EOS
+  end
 end