cliqr 0.0.4 → 0.1.0

data/lib/cliqr/cli/parser/option_token.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+module Cliqr
+  module CLI
+    module Parser
+      # Token handler for parsing a option and its value
+      #
+      # @api private
+      class OptionToken < Token
+        # Name of the option token
+        #
+        # @return [String]
+        attr_accessor :name
+
+        # Argument that was used to parse the option name from
+        #
+        # @return [String]
+        attr_accessor :arg
+
+        # Create a new option token. Initial state will be <tt>active</tt>
+        #
+        # @param [String] name Long name of the option
+        # @param [String] arg Value of the option
+        #
+        # @return [Cliqr::CLI::Parser::OptionToken] A new Token instance
+        def initialize(name, arg)
+          @name = name
+          @arg = arg
+
+          @value = nil
+          @active = true
+          @type = :option
+        end
+
+        # Check if the token handler is active and needs more arguments
+        #
+        # @return [Boolean] <tt>true</tt> if the token handler is active
+        def active?
+          @active
+        end
+
+        # Append the next argument in the series and set token to inactive
+        #
+        # @param [String] arg Argument value of the next command line parameter
+        #
+        # @return [Boolean] Active state of the token handler
+        def append(arg)
+          @value = arg
+          @active = false
+        end
+
+        # Get the token representation
+        #
+        # @return [Hash] A hash of the token parameters and their values
+        def build
+          {
+              :name => @name.to_s,
+              :value => @value
+          }
+        end
+
+        # Called if this token handler was still active once the argument list ends
+        #
+        # @return [Cliqr::CLI::Parser::OptionToken] Current instance object
+        def finalize
+          # should not be called
+          fail Cliqr::Error::OptionValueMissing, "a value must be defined for option \"#{@arg}\""
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/cli/parser/parsed_argument_builder.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Cliqr
+  module CLI
+    module Parser
+      # Builder for collecting parsed command line arguments that can be used to
+      # build a command context
+      #
+      # @api private
+      class ParsedArgumentBuilder
+        # Initialize a new instance
+        #
+        # @param [Cliqr::CLI::Config] config Configuration settings for the command line interface
+        #
+        # @return [Cliqr::CLI::Parser::ParsedArgumentBuilder]
+        def initialize(config)
+          @config = config
+          @options = []
+          @option_names = Set.new
+        end
+
+        # Add a new parsed token from the list of arguments
+        #
+        # @param [Cliqr::CLI::Parser::Token] token A parsed token from command line arguments
+        #
+        # @return [Boolean] <tt>true</tt> if the token was added
+        def add_token(token)
+          case token.type
+          when :option
+            add_option_name(token)
+            @options.push(token.build)
+          else
+            return false
+          end
+          true
+        end
+
+        # Build the hash of parsed command line arguments
+        #
+        # @return [Hash] Parsed arguments
+        def build
+          {
+              :command => @config.basename,
+              :options => @options
+          }
+        end
+
+        private
+
+        # Add option's name to a list of already added options and fail if duplicate
+        #
+        # @param [Cliqr::CLI::Parser::Token] token A parsed token from command line arguments
+        #
+        # @return [Set<String>] Current list of option names
+        def add_option_name(token)
+          option_config = @config.option(token.name)
+          old_config = @option_names.add?(option_config.name)
+          fail Cliqr::Error::MultipleOptionValues,
+               "multiple values for option \"#{token.arg}\"" if old_config.nil?
+          @option_names.add(option_config.short) if option_config.short?
+          @option_names
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/cli/parser/token.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module Cliqr
+  module CLI
+    module Parser
+      # A NO-OP argument token
+      #
+      # @api private
+      class Token
+        # Type of the token handler (:option in this case)
+        #
+        # @return [Symbol]
+        attr_accessor :type
+
+        # Create a new NO OP token
+        #
+        # @return [Cliqr::CLI::Parser::Token]
+        def initialize
+          @type = :NO_OP
+        end
+
+        # This token is never active
+        #
+        # @return [Boolean] This will always return <tt>false</tt> in this case
+        def active?
+          false
+        end
+
+        # Called if this token was still active once the argument list ends
+        #
+        # @return [Cliqr::CLI::Parser::TokenHandler] Current instance object
+        def finalize
+          self
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/cli/parser/token_factory.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'cliqr/cli/parser/token'
+require 'cliqr/cli/parser/option_token'
+
+module Cliqr
+  module CLI
+    module Parser
+      # A factory class to get a instance of {Cliqr::CLI::Parser::Token}
+      # based on the argument
+      #
+      # @api private
+      class TokenFactory
+        # Create a new token factory instance
+        #
+        # @param [Cliqr::CLI::Config] config Command line interface configuration
+        #
+        # @return [Cliqr::CLI::Parser::TokenFactory]
+        def initialize(config)
+          @config = config
+        end
+
+        # Get a new instance of {Cliqr::CLI::Parser::Token} based on the argument
+        #
+        # @param [String] arg The argument used to get a token instance (default nil)
+        #
+        # @return [Cliqr::CLI::Parser::Token]
+        def get_token(arg = nil)
+          if arg.nil?
+            Token.new
+          else
+            case arg
+            when /^--([a-zA-Z][a-zA-Z0-9\-_]*)$/, /^-([a-zA-Z])$/
+              option_config = get_option_config(Regexp.last_match(1), arg)
+              OptionToken.new(option_config.name, arg)
+            else
+              fail Cliqr::Error::InvalidArgumentError, "invalid command argument \"#{arg}\""
+            end
+          end
+        end
+
+        private
+
+        # Check if a option is defined with the requested name then return it
+        #
+        # @param [String] name Long name of the option
+        # @param [String] arg THe argument that was parsed to get the option name
+        #
+        # @return [Cliqr::CLI::OptionConfig] Requested option configuration
+        def get_option_config(name, arg)
+          fail Cliqr::Error::UnknownCommandOption,
+               "unknown option \"#{arg}\"" unless @config.option?(name)
+          @config.option(name)
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/cli/router.rb

@@ -1,11 +1,35 @@
 # encoding: utf-8
 
+require 'cliqr/cli/command_runner_factory'
+
 module Cliqr
   module CLI
     # Used for routing the command to the appropriate command handler based on the interface config
     #
     # @api private
     class Router
+      # Create a new Router instance
+      #
+      # @param [Cliqr::CLI::Config] config Command line configuration
+      #
+      # @return [Cliqr::CLI::Router]
+      def initialize(config)
+        @config = config
+      end
+
+      # Handle a command invocation by routing to appropriate command handler
+      #
+      # @param [Cliqr::CLI::CommandContext] context Context in which to execute the command
+      # @param [Hash] options Hash of options to configure the [Cliqr::CLI::CommandRunner]
+      #
+      # @return [Integer] Exit code of the command execution
+      def handle(context, **options)
+        handler = @config.handler.new
+        runner = CommandRunnerFactory.get(options)
+        runner.run do
+          handler.execute(context)
+        end
+      end
     end
   end
 end

data/lib/cliqr/error.rb

@@ -7,14 +7,37 @@ module Cliqr
     # @api private
     class CliqrError < StandardError
       # Set up the error to wrap another error's trace
-      def initialize(error_message, e = nil)
-        super e
+      #
+      # @param [String] error_message A short error description
+      # @param [Error] cause The cause of the error
+      def initialize(error_message, cause = nil)
+        super cause
+
+        @error_message = error_message
+        @cause = cause
 
         # Preserve the original exception's data if provided
-        return unless e && e.is_a?(Exception)
+        set_backtrace cause.backtrace if cause?
+      end
+
+      # Build a error message based on the cause of the error
+      #
+      # @return [String] Error message including the cause of the error
+      def message
+        if cause?
+          "#{@error_message}\n\nCause: #{@cause.class} - #{@cause.message}"
+        else
+          @error_message
+        end
+      end
+
+      private
 
-        set_backtrace e.backtrace
-        message.prepend "#{error_message}\n\nCause:\n#{e.class}: "
+      # Check if there was a nested cause for this error
+      #
+      # @return [Boolean] <tt>true</tt> if there was a valid cause for this error
+      def cause?
+        @cause && @cause.is_a?(Exception)
       end
     end
 
@@ -38,5 +61,26 @@ module Cliqr
 
     # Raised if config's option array is nil
     class OptionsNotDefinedException < CliqrError; end
+
+    # Indicates to the user that the command line option is invalid
+    class InvalidCommandOption < CliqrError; end
+
+    # Indicates to the user that the command line option is invalid
+    class UnknownCommandOption < CliqrError; end
+
+    # Raised to signal missing value for a option
+    class OptionValueMissing < CliqrError; end
+
+    # Indicates that a option has multiple values in the command line
+    class MultipleOptionValues < CliqrError; end
+
+    # Raised if two options are defined with same long or short name
+    class DuplicateOptions < CliqrError; end
+
+    # Raised if an option is not defined properly
+    class InvalidOptionDefinition < CliqrError; end
+
+    # Raised if an option is not defined properly
+    class InvalidArgumentError < CliqrError; end
   end
 end

data/lib/cliqr/version.rb

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

data/spec/config/config_validator_spec.rb

@@ -2,23 +2,33 @@
 
 require 'spec_helper'
 
-describe Cliqr::CLI::Validator do
+require 'cliqr/cli/config_validator'
+
+require 'fixtures/test_command'
+
+describe Cliqr::CLI::ConfigValidator do
   it 'does not allow empty config' do
-    expect { Cliqr::CLI::Builder.new(nil).build }.to raise_error(Cliqr::Error::ConfigNotFound)
+    expect { Cliqr::CLI::Interface.build(nil) }.to(
+      raise_error(Cliqr::Error::ConfigNotFound, 'a valid config should be defined')
+    )
   end
 
   it 'does not allow empty basename' do
     config = Cliqr::CLI::Config.new
     config.basename = ''
     config.finalize
-    expect { Cliqr::CLI::Builder.new(config).build }.to raise_error(Cliqr::Error::BasenameNotDefined)
+    expect { Cliqr::CLI::Interface.build(config) }.to(
+      raise_error(Cliqr::Error::BasenameNotDefined, 'basename not defined')
+    )
   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::Builder.new(config).build }.to raise_error(Cliqr::Error::HandlerNotDefined)
+    expect { Cliqr::CLI::Interface.build(config) }.to(
+      raise_error(Cliqr::Error::HandlerNotDefined, 'handler not defined for command "my-command"')
+    )
   end
 
   it 'only accepts command handler that extend from Cliqr::CLI::Command' do
@@ -26,7 +36,10 @@ describe Cliqr::CLI::Validator do
     config.basename = 'my-command'
     config.handler = Object
     config.finalize
-    expect { Cliqr::CLI::Builder.new(config).build }.to raise_error(Cliqr::Error::InvalidCommandHandler)
+    expect { Cliqr::CLI::Interface.build(config) }.to(
+      raise_error(Cliqr::Error::InvalidCommandHandler,
+                  'handler for command "my-command" should extend from [Cliqr::CLI::Command]')
+    )
   end
 
   it 'expects that config options should not be nil' do
@@ -35,6 +48,8 @@ describe Cliqr::CLI::Validator do
     config.handler = TestCommand
     config.options = nil
     config.finalize
-    expect { Cliqr::CLI::Builder.new(config).build }.to raise_error(Cliqr::Error::OptionsNotDefinedException)
+    expect { Cliqr::CLI::Interface.build(config) }.to(
+      raise_error(Cliqr::Error::OptionsNotDefinedException, 'option array is nil for command "my-command"')
+    )
   end
 end

data/spec/dsl/interface_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-require 'executor/fixtures/test_command'
+require 'fixtures/test_command'
 
 describe Cliqr::CLI::Interface do
   it 'builds a base command with name' do
@@ -78,4 +78,140 @@ Available options:
     --option-1
     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 '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::InvalidOptionDefinition, 'option number 1 does not have a name field'))
+  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::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
+
+        option nil
+      end
+    end.to(raise_error(Cliqr::Error::InvalidOptionDefinition, 'option number 1 does not have a name field'))
+  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::InvalidOptionDefinition, 'option number 2 does not have a name field'))
+  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::InvalidOptionDefinition,
+                       'short option name can not have more than one characters in "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
+
+      option 'option-1' do
+        short 'p'
+        description 'a nice option to have'
+      end
+    end
+    expect(cli.config.options?).to be_truthy
+  end
 end