cliqr 1.1.0 → 1.2.0

data/spec/config/action_config_validator_spec.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'fixtures/test_command'
+
+describe Cliqr::CLI::Config do
+  it 'does not allow multiple actions with same name' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action 'my-action' do
+          handler TestCommand
+        end
+
+        action 'my-action' do
+          handler TestCommand
+        end
+      end
+    end
+    expect { define_interface }.to(
+      raise_error(Cliqr::Error::DuplicateActions, 'multiple actions named "my-action"'))
+  end
+
+  it 'does not allow empty name' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action '' do
+          handler TestCommand
+        end
+      end
+    end
+    expect { define_interface }.to(raise_error(Cliqr::Error::ValidationError,
+                                               "invalid Cliqr interface configuration - [actions[1] - 'name' cannot be empty]"))
+  end
+
+  it 'does not allow nil name' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action nil do
+          handler TestCommand
+        end
+      end
+    end
+    expect { define_interface }.to(raise_error(Cliqr::Error::ValidationError,
+                                               "invalid Cliqr interface configuration - [actions[1] - 'name' cannot be nil]"))
+  end
+
+  it 'does not allow invalid characters in name' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action 'invalid-char-!' do
+          handler TestCommand
+        end
+      end
+    end
+    expect { define_interface }.to(
+      raise_error(Cliqr::Error::ValidationError,
+                  "invalid Cliqr interface configuration - [action \"invalid-char-!\" - value for 'name' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-char-!\"]"))
+  end
+
+  it 'does not allow command handler to be null if help is disabled and action present' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action 'my-action' do
+          help :disable
+        end
+      end
+    end
+    expect { define_interface }.to(raise_error(Cliqr::Error::ValidationError,
+                                               'invalid Cliqr interface configuration - [' \
+                                                 "action \"my-action\" - invalid value for handler; fix one of - ['handler' cannot be nil]]"))
+  end
+
+  it 'only accepts command handler that extend from Cliqr::CLI::Command' do
+    def define_interface
+      Cliqr.interface do
+        name 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        action 'my-action' do
+          handler Object
+        end
+      end
+    end
+    expect { define_interface }.to(raise_error(Cliqr::Error::ValidationError,
+                                               'invalid Cliqr interface configuration - [' \
+                                                 "action \"my-action\" - invalid value for handler; fix one of - [" \
+                                                   "handler of type 'Object' does not extend from 'Cliqr::CLI::Command', " \
+                                                   "handler should be a 'Proc' not 'Object']]"))
+  end
+
+  it 'throws multiple errors if more than one issue exists in config' do
+    def define_interface
+      Cliqr.interface do
+        name 'invalid-name-!@#'
+        handler Object
+
+        action 'my-action' do
+          handler Object
+
+          action nil do
+            help :disable
+          end
+
+          action 'bla' do
+            help :disable
+          end
+        end
+      end
+    end
+    expect { define_interface }.to(
+      raise_error(Cliqr::Error::ValidationError,
+                  'invalid Cliqr interface configuration - [' \
+                    "value for 'name' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-name-!@#\", " \
+                    'invalid value for handler; fix one of - [' \
+                      "handler of type 'Object' does not extend from 'Cliqr::CLI::Command', " \
+                      "handler should be a 'Proc' not 'Object'], " \
+                    "action \"my-action\" - invalid value for handler; fix one of - [" \
+                      "handler of type 'Object' does not extend from 'Cliqr::CLI::Command', " \
+                      "handler should be a 'Proc' not 'Object'], " \
+                    "action \"my-action\" - actions[1] - 'name' cannot be nil, " \
+                    "action \"my-action\" - actions[1] - invalid value for handler; fix one of - ['handler' cannot be nil], " \
+                    "action \"my-action\" - action \"bla\" - invalid value for handler; fix one of - ['handler' cannot be nil]]"))
+  end
+end

data/spec/config/config_finalize_spec.rb

@@ -6,7 +6,7 @@ describe Cliqr::CLI::Config do
   it 'sets proper defaults for unset values' do
     config = Cliqr::CLI::Config.new
     config.finalize
-    expect(config.basename).to eq('')
+    expect(config.name).to eq('')
     expect(config.description).to eq('')
     expect(config.handler).to eq(nil)
     expect(config.options).to eq([])

data/spec/config/config_validator_spec.rb

@@ -5,57 +5,64 @@ require 'spec_helper'
 require 'fixtures/test_command'
 
 describe Cliqr::CLI::Config do
-  it 'does not allow empty basename' do
+  it 'does not allow empty name' do
     expect do
       Cliqr.interface do
-        basename ''
+        name ''
         handler TestCommand
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - ['basename' cannot be empty]"))
+                       "invalid Cliqr interface configuration - ['name' cannot be empty]"))
   end
 
-  it 'does not allow nil basename' do
+  it 'does not allow nil name' do
     expect do
       Cliqr.interface do
-        basename nil
+        name nil
         handler TestCommand
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - ['basename' cannot be nil]"))
+                       "invalid Cliqr interface configuration - ['name' cannot be nil]"))
   end
 
-  it 'does not allow invalid characters in basename' do
+  it 'does not allow invalid characters in name' do
     expect do
       Cliqr.interface do
-        basename 'invalid-char-!'
+        name 'invalid-char-!'
         handler TestCommand
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [value for 'basename' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-char-!\"]"))
+                       "invalid Cliqr interface configuration - [value for 'name' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-char-!\"]"))
   end
 
-  it 'does not allow command handler to be null' do
-    expect do
+  it 'does not allow command handler to be null if no action present' do
+    def define_interface
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
+        help :disable
       end
-    end.to(raise_error(Cliqr::Error::ValidationError, "invalid Cliqr interface configuration - ['handler' cannot be nil]"))
+    end
+    expect { define_interface }.to(raise_error(Cliqr::Error::ValidationError,
+                                               'invalid Cliqr interface configuration - [' \
+                                                 "invalid value for handler; fix one of - ['handler' cannot be nil]]"))
   end
 
   it 'only accepts command handler that extend from Cliqr::CLI::Command' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         handler Object
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [value 'Object' of type 'Class' for 'handler' does not extend from 'Cliqr::CLI::Command']"))
+                       'invalid Cliqr interface configuration - [' \
+                         'invalid value for handler; fix one of - [' \
+                           "handler of type 'Object' does not extend from 'Cliqr::CLI::Command', " \
+                           "handler should be a 'Proc' not 'Object']]"))
   end
 
   it 'expects that config options should not be nil' do
     config = Cliqr::CLI::Config.new
-    config.basename = 'my-command'
+    config.name = 'my-command'
     config.handler = TestCommand
     config.options = nil
     config.finalize
@@ -66,11 +73,14 @@ describe Cliqr::CLI::Config do
   it 'throws multiple errors if more than one issue exists in config' do
     expect do
       Cliqr.interface do
-        basename 'invalid-name-!@#'
+        name 'invalid-name-!@#'
         handler Object
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [value for 'basename' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-name-!@#\", " \
-                       "value 'Object' of type 'Class' for 'handler' does not extend from 'Cliqr::CLI::Command']"))
+                       'invalid Cliqr interface configuration - [' \
+                         "value for 'name' must match /^[a-zA-Z0-9_\\-]+$/; actual: \"invalid-name-!@#\", " \
+                         'invalid value for handler; fix one of - [' \
+                           "handler of type 'Object' does not extend from 'Cliqr::CLI::Command', " \
+                           "handler should be a 'Proc' not 'Object']]"))
   end
 end

data/spec/config/option_config_validator_spec.rb

@@ -6,7 +6,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow multiple options with same long name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -24,7 +24,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow multiple options with same short name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -42,7 +42,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow option with empty long name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -57,7 +57,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow option with empty short name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -66,13 +66,13 @@ describe Cliqr::CLI::OptionConfig do
         end
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [options[1] - 'short' cannot be empty]"))
+                       "invalid Cliqr interface configuration - [option \"option-1\" - 'short' cannot be empty]"))
   end
 
   it 'does not allow option with nil long name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -85,7 +85,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow option with nil long name for second option' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -99,7 +99,7 @@ describe Cliqr::CLI::OptionConfig do
   it 'does not allow multiple characters in short name' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -108,13 +108,13 @@ describe Cliqr::CLI::OptionConfig do
         end
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [options[1] - value for 'short' must match /^[a-z0-9A-Z]$/; actual: \"p1\"]"))
+                       "invalid Cliqr interface configuration - [option \"option-1\" - value for 'short' must match /^[a-z0-9A-Z]$/; actual: \"p1\"]"))
   end
 
   it 'does not allow invalid type values' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -123,13 +123,13 @@ describe Cliqr::CLI::OptionConfig do
         end
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [options[1] - invalid type 'random']"))
+                       "invalid Cliqr interface configuration - [option \"option-1\" - invalid type 'random']"))
   end
 
   it 'does not allow empty type values' do
     expect do
       Cliqr.interface do
-        basename 'my-command'
+        name 'my-command'
         description 'a command used to test cliqr'
         handler TestCommand
 
@@ -138,6 +138,6 @@ describe Cliqr::CLI::OptionConfig do
         end
       end
     end.to(raise_error(Cliqr::Error::ValidationError,
-                       "invalid Cliqr interface configuration - [options[1] - invalid type '']"))
+                       "invalid Cliqr interface configuration - [option \"option-1\" - invalid type '']"))
   end
 end

data/spec/dsl/interface_spec.rb

@@ -11,87 +11,9 @@ describe Cliqr::CLI::Interface do
     end.to(raise_error(Cliqr::Error::ConfigNotFound, 'a valid config should be defined'))
   end
 
-  it 'builds a base command with name' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      description 'a command used to test cliqr'
-      handler TestCommand
-      arguments :disable
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command -- a command used to test cliqr
-
-USAGE:
-    my-command
-EOS
-  end
-
-  it 'only makes basename and handler to be required' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      handler TestCommand
-      arguments :disable
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command
-
-USAGE:
-    my-command
-EOS
-  end
-
-  it 'allows options for a command' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      description 'a command used to test cliqr'
-      handler TestCommand
-      arguments :disable
-
-      option 'option-1' do
-        short 'p'
-        description 'a nice option to have'
-      end
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command -- a command used to test cliqr
-
-USAGE:
-    my-command [options]
-
-Available options:
-
-    --option-1, -p  :  a nice option to have
-EOS
-  end
-
-  it 'allows command options to optionally have description, type and short name' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      description 'a command used to test cliqr'
-      handler TestCommand
-      arguments :disable
-
-      option 'option-1'
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command -- a command used to test cliqr
-
-USAGE:
-    my-command [options]
-
-Available options:
-
-    --option-1
-    EOS
-  end
-
   it 'has options if added during build phase' do
     cli = Cliqr.interface do
-      basename 'my-command'
+      name 'my-command'
       description 'a command used to test cliqr'
       handler TestCommand
 
@@ -102,93 +24,4 @@ Available options:
     end
     expect(cli.config.options?).to be_truthy
   end
-
-  it 'allows command options to have a numeric value type' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      description 'a command used to test cliqr'
-      handler TestCommand
-      arguments :disable
-
-      option 'option-1' do
-        description 'a numeric option'
-        short 'p'
-        type :numeric
-      end
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command -- a command used to test cliqr
-
-USAGE:
-    my-command [options]
-
-Available options:
-
-    --option-1, -p  :  <numeric> a numeric option
-    EOS
-  end
-
-  it 'allows command options to have a boolean value type' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      description 'a command used to test cliqr'
-      handler TestCommand
-      arguments :disable
-
-      option 'option-1' do
-        description 'a boolean option'
-        short 'p'
-        type :boolean
-      end
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command -- a command used to test cliqr
-
-USAGE:
-    my-command [options]
-
-Available options:
-
-    --[no-]option-1, -p  :  <boolean> a boolean option
-    EOS
-  end
-
-  it 'allows interface to enable arbitrary argument list parsing without options' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      handler TestCommand
-      arguments :enable
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command
-
-USAGE:
-    my-command [arguments]
-    EOS
-  end
-
-  it 'allows interface to enable arbitrary argument list parsing' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      handler TestCommand
-      arguments :enable
-
-      option 'option-1'
-    end
-
-    expect(cli.usage).to eq <<-EOS
-my-command
-
-USAGE:
-    my-command [options] [arguments]
-
-Available options:
-
-    --option-1
-    EOS
-  end
-
 end