cliqr 0.1.0 → 1.0.0

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

@@ -1,23 +0,0 @@
-# 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

@@ -1,56 +0,0 @@
-# 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

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

@@ -1,72 +0,0 @@
-# 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

@@ -1,66 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# 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

@@ -1,58 +0,0 @@
-# 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