cliqr 0.0.4 → 0.1.0

data/lib/cliqr/cli/config.rb

@@ -39,7 +39,9 @@ module Cliqr
         @basename = UNSET
         @description = UNSET
         @handler = UNSET
-        @options = UNSET
+
+        @options = []
+        @option_index = {}
       end
 
       # Finalize config by adding default values for unset values
@@ -49,7 +51,6 @@ module Cliqr
         @basename = '' if @basename == UNSET
         @description = '' if @description == UNSET
         @handler = nil if @handler == UNSET
-        @options = [] if @options == UNSET
 
         self
       end
@@ -60,10 +61,10 @@ module Cliqr
       #
       # @param [Object] value Value for the config parameter
       #
-      # @param [Funciton] block Function which populates configuration for a sub-attribute
+      # @param [Function] block Function which populates configuration for a sub-attribute
       #
-      # @return [Object] If setting a attribute's value
-      # @return [Cliqr::CLI::OptionConfig] If adding a new option
+      # @return [Object] if setting a attribute's value
+      # @return [Cliqr::CLI::OptionConfig] if adding a new option
       def set_config(name, value, &block)
         case name
         when :option
@@ -73,6 +74,31 @@ module Cliqr
         end
       end
 
+      # Check if options are set
+      #
+      # @return [Boolean] <tt>true</tt> if the CLI config's options have been set
+      def options?
+        @options != UNSET
+      end
+
+      # Check if particular option is set
+      #
+      # @param [String] name Name of the option to check
+      #
+      # @return [Boolean] <tt>true</tt> if the a CLI config's option is set
+      def option?(name)
+        @option_index.key?(name)
+      end
+
+      # Get value of a option
+      #
+      # @param [String] name Name of the option
+      #
+      # @return [String] value for the option
+      def option(name)
+        @option_index[name]
+      end
+
       private
 
       # Set value for config option without evaluating a block
@@ -96,8 +122,14 @@ module Cliqr
       def handle_option(name, &block)
         option_config = OptionConfig.build(&block)
         option_config.name = name
-        @options = [] if @options == UNSET
+
+        OptionConfigValidator.validate(option_config, self)
+
         @options.push option_config
+
+        @option_index[option_config.name] = option_config
+        @option_index[option_config.short] = option_config if option_config.short?
+
         option_config
       end
     end
@@ -123,6 +155,17 @@ module Cliqr
       # @return [String]
       attr_accessor :description
 
+      # Set value for command option's attribute
+      #
+      # @param [Symbol] name Name of the attribute
+      #
+      # @param [Object] value Value for the attribute
+      #
+      # @return [Object] Value that was set for the attribute
+      def set_config(name, value)
+        handle_option_config name, value
+      end
+
       # Initialize a new config instance for an option with UNSET attribute values
       def initialize
         @name = UNSET
@@ -134,22 +177,32 @@ module Cliqr
       #
       # @return [Cliqr::CLI::OptionConfig]
       def finalize
-        @name = '' if @name == UNSET
-        @short = '' if @short == UNSET
-        @description = '' if @description == UNSET
+        @name = nil if @name == UNSET
+        @short = nil if @short == UNSET
+        @description = nil if @description == UNSET
 
         self
       end
 
-      # Set value for command option's attribute
+      # Check if a option's name is defined
       #
-      # @param [Symbol] name Name of the attribute
+      # @return [Boolean] <tt>true</tt> if options' name is not null neither empty
+      def name?
+        !(@name.nil? || @name.empty?)
+      end
+
+      # Check if a option's short name is defined
       #
-      # @param [Object] value Value for the attribute
+      # @return [Boolean] <tt>true</tt> if options' short name is not null neither empty
+      def short?
+        !(@short.nil? || @short.empty?)
+      end
+
+      # Check if a option's description is defined
       #
-      # @return [Object] Value that was set for the attribute
-      def set_config(name, value)
-        handle_option_config name, value
+      # @return [Boolean] <tt>true</tt> if options' description is not null neither empty
+      def description?
+        !(@description.nil? || @description.empty?)
       end
 
       private

data/lib/cliqr/cli/config_validator.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+require 'cliqr/error'
+
+module Cliqr
+  module CLI
+    # Validator for the command line interface configuration
+    #
+    # @api private
+    class ConfigValidator
+      # Validates the config to make sure all the options are correctly set
+      #
+      # @param [Cliqr::CLI::Config] config Settings for building command line interface
+      #
+      # @return [Cliqr::CLI::Config] Validated config object
+      def self.validate(config)
+        fail Cliqr::Error::ConfigNotFound, 'a valid config should be defined' if config.nil?
+        fail Cliqr::Error::BasenameNotDefined, 'basename not defined' if config.basename.empty?
+
+        fail Cliqr::Error::HandlerNotDefined,
+             "handler not defined for command \"#{config.basename}\"" if config.handler.nil?
+
+        fail Cliqr::Error::InvalidCommandHandler,
+             "handler for command \"#{config.basename}\" should extend from [Cliqr::CLI::Command]" \
+             unless config.handler < Command
+
+        check_options(config)
+
+        config
+      end
+
+      # Check if config's options list is not nil
+      #
+      # @param [Cliqr::CLI::Config] config Configuration settings for the command line interface
+      #
+      # @return [Cliqr::CLI::Config] Validated config
+      def self.check_options(config)
+        fail Cliqr::Error::OptionsNotDefinedException,
+             "option array is nil for command \"#{config.basename}\"" if config.options.nil?
+
+        config
+      end
+    end
+
+    # Validator for validating option configuration in a CLI interface config
+    #
+    # @api private
+    class OptionConfigValidator
+      # Validate a command line interface's config for an option
+      #
+      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
+      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
+      #
+      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
+      def self.validate(config, parent_config)
+        validate_option_name(config, parent_config)
+
+        fail Cliqr::Error::InvalidOptionDefinition,
+             "option \"#{config.name}\" has empty short name" \
+              if !config.short.nil? && config.short.empty?
+
+        validate_short_option(config, parent_config) if config.short?
+
+        config
+      end
+
+      # Validates name for an option
+      #
+      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
+      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
+      #
+      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
+      def self.validate_option_name(config, parent_config)
+        fail Cliqr::Error::DuplicateOptions,
+             "multiple options with long name \"#{config.name}\"" \
+             if parent_config.option?(config.name)
+
+        fail Cliqr::Error::InvalidOptionDefinition,
+             "option number #{parent_config.options.length + 1} does not have a name field" \
+              unless config.name?
+
+        config
+      end
+
+      # Validates short name for an option
+      #
+      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
+      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
+      #
+      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
+      def self.validate_short_option(config, parent_config)
+        fail Cliqr::Error::DuplicateOptions,
+             "multiple options with short name \"#{config.short}\"" \
+              if parent_config.option?(config.short)
+
+        fail Cliqr::Error::InvalidOptionDefinition,
+             "short option name can not have more than one characters in \"#{config.name}\"" \
+             if /^[a-z0-9A-Z]$/.match(config.short).nil?
+
+        config
+      end
+    end
+  end
+end

data/lib/cliqr/cli/executor.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'cliqr/cli/router'
+require 'cliqr/cli/command_context'
+require 'cliqr/cli/argument_validator'
+require 'cliqr/cli/parser/argument_parser'
+
+module Cliqr
+  module CLI
+    # Handles command execution with error handling
+    #
+    # @api private
+    class Executor
+      # Create a new command executor
+      def initialize(config)
+        @config = config
+        @router = Router.new(config)
+        @validator = ArgumentValidator.new
+      end
+
+      # Execute the command
+      #
+      # @param [Array<String>] args Arguments that will be used to execute the command
+      # @param [Hash] options Options for command execution
+      #
+      # @return [Integer] Exit status of the command execution
+      def execute(args, options)
+        command_context = CommandContext.build(parse(args))
+        @router.handle command_context, **options
+      rescue StandardError => e
+        raise Cliqr::Error::CommandRuntimeException.new("command '#{@config.basename}' failed", e)
+      end
+
+      private
+
+      # Invoke the command line argument parser
+      #
+      # @param [Array<String>] args List of arguments that needs to parsed
+      #
+      # @return [Hash] Parsed hash of command line arguments
+      def parse(args)
+        parsed_args = Parser.parse(@config, args)
+        @validator.validate(parsed_args)
+        parsed_args
+      end
+    end
+  end
+end

data/lib/cliqr/cli/interface.rb

@@ -2,20 +2,27 @@
 
 require 'cliqr/error'
 
-require 'cliqr/cli/router'
-require 'cliqr/cli/command_runner_factory'
+require 'cliqr/cli/executor'
+require 'cliqr/cli/config_validator'
 
 module Cliqr
+  # Definition and builder for command line interface
   module CLI
     # A CLI interface instance which is the entry point for all CLI commands.
     #
     # @api private
     class Interface
+      # Command line interface configuration
+      #
+      # @return [Cliqr::CLI::Config]
+      attr_accessor :config
+
       # Create a new interface instance with a config
       #
       # @param [Cliqr::CLI::Config] config Config used to create this interface
       def initialize(config)
         @config = config
+        @executor = Executor.new(config)
       end
 
       # Get usage information of this command line interface instance
@@ -32,19 +39,49 @@ module Cliqr
 
       # Execute a command
       #
-      # @param [Symbol] output Either :default or :buffer
+      # @param [Array<String>] args Arguments that will be used to execute the command
+      # @param [Hash] options Options for command execution
       #
       # @return [Integer] Exit code of the command execution
-      def execute(output: :default)
-        handler = @config.handler.new
-        begin
-          runner = CommandRunnerFactory.get(output: output)
-          runner.run do
-            handler.execute
-          end
-        rescue StandardError => e
-          raise Cliqr::Error::CommandRuntimeException.new "command '#{@config.basename}' failed", e
-        end
+      def execute(args = [], **options)
+        options = {
+            :output => :default
+        }.merge(options)
+        @executor.execute(args, options)
+      end
+
+      # Invoke the builder method for [Cliqr::CLI::Interface]
+      #
+      # @param [Cliqr::CLI::Config] config Instance of the command line config
+      #
+      # @return [Cliqr::CLI::Interface]
+      def self.build(config)
+        InterfaceBuilder.new(config).build
+      end
+    end
+
+    private
+
+    # Builder for [Cliqr::CLI::Interface]
+    #
+    # @api private
+    class InterfaceBuilder
+      # Start building a command line interface
+      #
+      # @param [Cliqr::CLI::Config] config the configuration options for the
+      # interface (validated using CLI::Validator)
+      #
+      # @return [Cliqr::CLI::ConfigBuilder]
+      def initialize(config)
+        @config = config
+      end
+
+      # Validate and build a cli interface based on the configuration options
+      #
+      # @return [Cliqr::CLI::Interface]
+      def build
+        ConfigValidator.validate @config
+        Interface.new(@config)
       end
     end
   end

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

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'cliqr/cli/parser/argument_tree_walker'
+
+module Cliqr
+  module CLI
+    # A set of utility methods and classes used to parse the command line arguments
+    #
+    # @api private
+    module Parser
+      # Parse command line arguments based on [Cliqr::CLI::Config]
+      #
+      # @param [Cliqr::CLI::Config] config Command line configuration
+      # @param [Array<String>] args An array of arguments from command line
+      #
+      # @return [Hash] Parsed hash of command linet arguments
+      def self.parse(config, args)
+        tree_walker = ArgumentTreeWalker.new(config)
+        tree_walker.walk(args)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'cliqr/cli/parser/parsed_argument_builder'
+require 'cliqr/cli/parser/token_factory'
+
+module Cliqr
+  module CLI
+    module Parser
+      # Walks the list of arguments and parses them one token at a time
+      #
+      # @api private
+      class ArgumentTreeWalker
+        # Create a new instance
+        #
+        # @param [Cliqr::CLI::Config] config Configuration settings for the command line interface
+        #
+        # @return [Cliqr::CLI::Parser::ArgumentTreeWalker]
+        def initialize(config)
+          @config = config
+        end
+
+        # Parse the arguments and generate tokens by iterating over command line arguments
+        #
+        # @param [Array<String>] args List of arguments that needs to parsed
+        #
+        # @return [Hash] Parsed hash of command line arguments
+        def walk(args)
+          argument_builder = ParsedArgumentBuilder.new(@config)
+          token_factory = TokenFactory.new(@config)
+          token = token_factory.get_token
+          args.each do |arg|
+            token = handle_argument(arg, token, argument_builder, token_factory)
+          end
+          token.finalize
+          argument_builder.build
+        end
+
+        # Handle the next argument in the context of the current token
+        #
+        # @return [Cliqr::CLI::Parser::Token] The new active token in case <tt>current_token</tt>
+        # becomes inactive
+        def handle_argument(arg, current_token, argument_builder, token_factory)
+          if current_token.active?
+            current_token.append(arg)
+            arg = nil
+          end
+          unless current_token.active?
+            argument_builder.add_token(current_token)
+            current_token = token_factory.get_token(arg)
+          end
+          current_token
+        end
+      end
+    end
+  end
+end