cliqr 0.1.0 → 1.0.0

data/lib/cliqr/validation_errors.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'set'
+
+module Cliqr
+  # A wrapper of validation errors which provides helpful methods for accessing it
+  #
+  # @api private
+  class ValidationErrors
+    # List of all error messages
+    #
+    # @return [Array<String]
+    attr_accessor :errors
+
+    # Create a new instance of the validation error wrapper
+    def initialize
+      @errors = Set.new []
+    end
+
+    # Add a new error message
+    #
+    # @param [String] error_message
+    #
+    # @return [Array] A collection of all error messages
+    def add(error_message)
+      @errors.add(error_message)
+    end
+
+    # Check if there are error or not
+    #
+    # @return [Boolean] <tt>false</tt> if there are no errors
+    def empty?
+      @errors.empty?
+    end
+
+    # Convert list of errors to a string representation
+    #
+    # @return [String] A comma separated list of all errors
+    def to_s
+      @errors.to_a.join(', ')
+    end
+
+    # Merge the list of errors from another
+    #
+    # @param [Cliqr::Validation::Errors] other Errors that need to be merged
+    #
+    # @return [Cliqr::Validation::Errors] Updated errors list
+    def merge(other)
+      @errors = @errors.union(other.errors)
+    end
+
+    # Iterate over each error message
+    #
+    # @param [Function] block The iterating function
+    #
+    # @return [Set<String>] A set of all error messages
+    def each(&block)
+      @errors.each(&block)
+    end
+  end
+end

data/lib/cliqr/version.rb

@@ -2,5 +2,5 @@
 
 # Versioned gem
 module Cliqr
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/spec/config/config_validator_spec.rb

@@ -2,44 +2,55 @@
 
 require 'spec_helper'
 
-require 'cliqr/cli/config_validator'
-
 require 'fixtures/test_command'
 
-describe Cliqr::CLI::ConfigValidator do
-  it 'does not allow empty config' do
-    expect { Cliqr::CLI::Interface.build(nil) }.to(
-      raise_error(Cliqr::Error::ConfigNotFound, 'a valid config should be defined')
-    )
+describe Cliqr::CLI::Config do
+  it 'does not allow empty basename' do
+    expect do
+      Cliqr.interface do
+        basename ''
+        handler TestCommand
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - ['basename' cannot be empty]"))
   end
 
-  it 'does not allow empty basename' do
-    config = Cliqr::CLI::Config.new
-    config.basename = ''
-    config.finalize
-    expect { Cliqr::CLI::Interface.build(config) }.to(
-      raise_error(Cliqr::Error::BasenameNotDefined, 'basename not defined')
-    )
+  it 'does not allow nil basename' do
+    expect do
+      Cliqr.interface do
+        basename nil
+        handler TestCommand
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - ['basename' cannot be nil]"))
+  end
+
+  it 'does not allow invalid characters in basename' do
+    expect do
+      Cliqr.interface do
+        basename '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-!\"]"))
   end
 
   it 'does not allow command handler to be null' do
-    config = Cliqr::CLI::Config.new
-    config.basename = 'my-command'
-    config.finalize
-    expect { Cliqr::CLI::Interface.build(config) }.to(
-      raise_error(Cliqr::Error::HandlerNotDefined, 'handler not defined for command "my-command"')
-    )
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError, "invalid Cliqr interface configuration - ['handler' cannot be nil]"))
   end
 
   it 'only accepts command handler that extend from Cliqr::CLI::Command' do
-    config = Cliqr::CLI::Config.new
-    config.basename = 'my-command'
-    config.handler = Object
-    config.finalize
-    expect { Cliqr::CLI::Interface.build(config) }.to(
-      raise_error(Cliqr::Error::InvalidCommandHandler,
-                  'handler for command "my-command" should extend from [Cliqr::CLI::Command]')
-    )
+    expect do
+      Cliqr.interface do
+        basename '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']"))
   end
 
   it 'expects that config options should not be nil' do
@@ -49,7 +60,17 @@ describe Cliqr::CLI::ConfigValidator do
     config.options = nil
     config.finalize
     expect { Cliqr::CLI::Interface.build(config) }.to(
-      raise_error(Cliqr::Error::OptionsNotDefinedException, 'option array is nil for command "my-command"')
-    )
+      raise_error(Cliqr::Error::ValidationError, "invalid Cliqr interface configuration - ['options' cannot be nil]"))
+  end
+
+  it 'throws multiple errors if more than one issue exists in config' do
+    expect do
+      Cliqr.interface do
+        basename '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']"))
   end
 end

data/spec/config/option_config_validator_spec.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+
+require 'fixtures/test_command'
+
+describe Cliqr::CLI::OptionConfig do
+  it 'does not allow multiple options with same long name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          short 'p'
+        end
+
+        option 'option-1' do
+          short 't'
+        end
+      end
+    end.to(raise_error(Cliqr::Error::DuplicateOptions, 'multiple options with long name "option-1"'))
+  end
+
+  it 'does not allow multiple options with same short name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          short 'p'
+        end
+
+        option 'option-2' do
+          short 'p'
+        end
+      end
+    end.to(raise_error(Cliqr::Error::DuplicateOptions, 'multiple options with short name "p"'))
+  end
+
+  it 'does not allow option with empty long name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option '' do
+          short 'p'
+        end
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[1] - 'name' cannot be empty]"))
+  end
+
+  it 'does not allow option with empty short name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          short ''
+        end
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[1] - 'short' cannot be empty]"))
+  end
+
+  it 'does not allow option with nil long name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option nil
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[1] - 'name' cannot be nil]"))
+  end
+
+  it 'does not allow option with nil long name for second option' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1'
+        option ''
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[2] - 'name' cannot be empty]"))
+  end
+
+  it 'does not allow multiple characters in short name' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          short 'p1'
+        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\"]"))
+  end
+
+  it 'does not allow invalid type values' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          type :random
+        end
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[1] - invalid type 'random']"))
+  end
+
+  it 'does not allow empty type values' do
+    expect do
+      Cliqr.interface do
+        basename 'my-command'
+        description 'a command used to test cliqr'
+        handler TestCommand
+
+        option 'option-1' do
+          type ''
+        end
+      end
+    end.to(raise_error(Cliqr::Error::ValidationError,
+                       "invalid Cliqr interface configuration - [options[1] - invalid type '']"))
+  end
+end

data/spec/dsl/interface_spec.rb

@@ -5,6 +5,12 @@ require 'spec_helper'
 require 'fixtures/test_command'
 
 describe Cliqr::CLI::Interface do
+  it 'does not allow empty config' do
+    expect do
+      Cliqr::CLI::Interface.build(nil)
+    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'
@@ -58,7 +64,7 @@ Available options:
 EOS
   end
 
-  it 'allows command options to optionally have description and short name' do
+  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'
@@ -79,139 +85,67 @@ Available options:
     EOS
   end
 
-  it 'does not allow multiple options with same long name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option 'option-1' do
-          short 'p'
-        end
-
-        option 'option-1' do
-          short 't'
-        end
-      end
-    end.to(raise_error(Cliqr::Error::DuplicateOptions, 'multiple options with long name "option-1"'))
-  end
-
-  it 'does not allow multiple options with same short name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option 'option-1' do
-          short 'p'
-        end
-
-        option 'option-1' do
-          short 't'
-        end
-      end
-    end.to(raise_error(Cliqr::Error::DuplicateOptions, 'multiple options with long name "option-1"'))
-  end
+  it 'has options if added during build phase' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      description 'a command used to test cliqr'
+      handler TestCommand
 
-  it 'does not allow multiple options with same short name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option 'option-1' do
-          short 'p'
-        end
-
-        option 'option-2' do
-          short 'p'
-        end
+      option 'option-1' do
+        short 'p'
+        description 'a nice option to have'
       end
-    end.to(raise_error(Cliqr::Error::DuplicateOptions, 'multiple options with short name "p"'))
+    end
+    expect(cli.config.options?).to be_truthy
   end
 
-  it 'does not allow option with empty long name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option '' do
-          short 'p'
-        end
-      end
-    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition, 'option number 1 does not have a name field'))
-  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
 
-  it 'does not allow option with empty short name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option 'option-1' do
-          short ''
-        end
+      option 'option-1' do
+        description 'a numeric option'
+        short 'p'
+        type :numeric
       end
-    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition, "option \"option-1\" has empty short name"))
-  end
-
-  it 'does not allow option with nil long name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
+    end
 
-        option nil
-      end
-    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition, 'option number 1 does not have a name field'))
-  end
+    expect(cli.usage).to eq <<-EOS
+my-command -- a command used to test cliqr
 
-  it 'does not allow option with nil long name for second option' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
+USAGE:
+    my-command [options]
 
-        option 'option-1'
-        option ''
-      end
-    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition, 'option number 2 does not have a name field'))
-  end
+Available options:
 
-  it 'does not allow multiple characters in short name' do
-    expect do
-      Cliqr.interface do
-        basename 'my-command'
-        description 'a command used to test cliqr'
-        handler TestCommand
-
-        option 'option-1' do
-          short 'p1'
-        end
-      end
-    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition,
-                       'short option name can not have more than one characters in "option-1"'))
+    --option-1, -p  :  <numeric> a numeric option
+    EOS
   end
 
-  it 'has options if added during build phase' do
+  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
 
       option 'option-1' do
+        description 'a boolean option'
         short 'p'
-        description 'a nice option to have'
+        type :boolean
       end
     end
-    expect(cli.config.options?).to be_truthy
+
+    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
 end