consoler 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 317d28b9a15f0ea07c01410191cac9d0d59a41dd
-  data.tar.gz: f9a363ba2b596a02df673c1600441f2f6d7b7010
+SHA256:
+  metadata.gz: 49ca5e9011acc8b6817962ab10c90bae3b91b8f2e0fe351001bdd55b84d0338d
+  data.tar.gz: f8ced34f84e72074986fad4b16fcfd1ae0725ffaaade46b69d876b028f327ffd
 SHA512:
-  metadata.gz: b42c0a91ed2df03ef7d76796f1da5e986782d2d0415a14167159f34b10b76eb939e97f378109328bdd768c7f234607907871bcd03e2e5ad097180c7edaf385c6
-  data.tar.gz: df6627a850424d6053c4525bea35014c1c8ec42bbe9cbe43f981119b535a747af53c4130dec92242309d36891c9e7368450c49838c37c55ea2662a682582fb26
+  metadata.gz: 3ab6c3d9629accdc064f3b74cb0458f65a14615e89a81e892e07e9498a7fd28607efcd439fc53278ad4e8be86c54b5031b891b0b9d67c5e6496c456e2f049b74
+  data.tar.gz: 14c391a50764df0359e0483fd5e59fcd2d765c982e69ea3d15e4b0ff6c5a00270b5f31df397cc2b5275f20d7d9c4e6e56e3000479f78d5e416f5c6287445bc5c

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+  Exclude:
+    - 'test/**/*'
+
+# 80 is not enough these days
+Metrics/LineLength:
+  Max: 100
+
+# Not ready for 100 yet
+Metrics/ClassLength:
+  Max: 250
+
+# Not ready for 20 yet
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/AbcSize:
+  Enabled: false
+
+# not ready for 10 just yet
+Metrics/CyclomaticComplexity:
+  Max: 30
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# I prefer regular if statements in some cases
+Style/IfUnlessModifier:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+
+# `super` makes no sense in this case
+# `#respond_to_missing?` is implemented
+Style/MethodMissingSuper:
+  Enabled: false
+
+# I like the comma
+Style/TrailingCommaInArguments:
+  Enabled: false

data/.travis.yml

@@ -1,10 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
 cache:
   - bundler
 script:

data/README.md

@@ -9,17 +9,19 @@
 app = Consoler::Application.new description: 'A simple app'
 
 # define a command
-app.build '[--clean] output_dir' do |clean, output_dir|
+app.build '[--clean] <output_dir>' do |clean, output_dir|
   # clean contains a boolean
   clean_up if clean
 
   # output_dir contains a string
   build_project output_dir
 end
-app.run(['build', 'production', '--clean'])
+
+# run with own args
+app.run ['build', 'production', '--clean']
 
 # this does not match, nothing is executed and the usage message is printed
-app.run(['deploy', 'production'])
+app.run ['deploy', 'production']
 
 # defaults to ARGV
 app.run
@@ -30,6 +32,7 @@ app.run
 - No fiddling with `ARGV` and friends
 - Arguments filled based on their name, for easy access
 - Grouped optionals
+- Easy option aliasing
 
 ## Requirements
 
@@ -39,6 +42,7 @@ Tests are run against multiple ruby versions (latest supported):
 - `2.3.x`
 - `2.4.x`
 - `2.5.x`
+- `2.6.x`
 
 No other requirements exist.
 
@@ -51,20 +55,20 @@ gem install consoler
 or add to your `Gemfile` for applications
 
 ```ruby
-gem 'consoler', '~> 1.0.3'
+gem 'consoler', '~> 1.1.0'
 ```
 
 or to your `.gemspec` file for gems
 
 ```ruby
 Gem::Specification.new do |spec|
-  spec.add_dependency 'consoler', '~> 1.0.3'
+  spec.add_dependency 'consoler', '~> 1.1.0'
 end
 ```
 
 ## Docs
 
-Full API documentation can the found here: http://www.rubydoc.info/github/justim/consoler-rb/
+Full API documentation can the found here: https://www.rubydoc.info/github/justim/consoler-rb/
 
 ### API
 
@@ -93,11 +97,11 @@ app.build do
 end
 
 # to add options to your command, provide a options definition as an argument
-app.build '[--clean] [--env=] [-v] output_dir' do |clean, env, v, output_dir|
+app.build '[--clean] [--env=] [-v|--verbose] <output_dir>' do |clean, env, verbose, output_dir|
   # parameters are matched based on name
   # `clean` contains a boolean
   # `env` contains a string or nil if not provided
-  # `v` contains a number, counting the times it occurred in the arguments
+  # `verbose` contains a number, counting the times it occurred in the arguments
   # `output_dir` contains a string, if needed to match this command
 end
 ```
@@ -111,23 +115,23 @@ end
 app = Consoler::Application.new
 
 # a build command
-app.build '[--clean] [--env=] [-v] output_dir' do |clean, env, v, output_dir|
-  puts 'Starting build...' if v > 0
+app.build '[--clean] [--env=] [-v|--verbose] <output_dir>' do |clean, env, verbose, output_dir|
+  puts 'Starting build...' if verbose > 0
 
   do_clean_up if clean
 
   do_build env || 'development', output_dir
 
-  puts 'Build complete' if v > 0
+  puts 'Build complete' if verbose > 0
 end
 
 # a deploy command
-app.build '[-v] [--env=]' do |env|
-  puts 'Starting deploy...' if v > 0
+app.build '[-v|--verbose] [--env=]' do |env|
+  puts 'Starting deploy...' if verbose > 0
 
   do_deploy env || 'development'
 
-  puts 'Deploy complete' if v > 0
+  puts 'Deploy complete' if verbose > 0
 end
 ```
 
@@ -137,29 +141,34 @@ _Shell commands:_
 ruby app.rb build --env production dist
 
 # deploy
-ruby app.rb deploy
+ruby app.rb deploy --verbose
 ```
 
 #### Options definition
 
-| Option       | Meaning                         | Example                                |
-| ------------ | ------------------------------- | -------------------------------------- |
-| `-f`         | Short option with name `f`      | `ruby app.rb build -f`                 |
-| `--clean`    | Long option with name `clean`   | `ruby app.rb build --clean`            |
-| `output_dir` | Argument with name `output_dir` | `ruby app.rb build dist/`              |
-| `--env=`     | Long option with value          | `ruby app.rb build --env production`   |
-| `-e=`        | Short option with value         | `ruby app.rb build -e production`      |
-| `[ .. ]`     | Optional options/arguments      | `ruby app.rb build` would match `[-v]` |
+| Option         | Meaning                         | Example                                |
+| -------------- | ------------------------------- | -------------------------------------- |
+| `-f`           | Short option with name `f`      | `ruby app.rb build -f`                 |
+| `--clean`      | Long option with name `clean`   | `ruby app.rb build --clean`            |
+| `-v|--verbose` | Alias option for `v`            | `ruby app.rb build --verbose`          |
+| `<output_dir>` | Argument with name `output_dir` | `ruby app.rb build dist/`              |
+| `--env=`       | Long option with value          | `ruby app.rb build --env production`   |
+| `-e=`          | Short option with value         | `ruby app.rb build -e production`      |
+| `[ .. ]`       | Optional options/arguments      | `ruby app.rb build` would match `[-v]` |
 
-Optional-tokens can occur anywhere in the options, as long as they are not nested and properly closed. You can group optional parts, meaning that both options/arguments should be available or both not.
+Some notes about these options:
 
-Options and/or arguments are mandatory unless specified otherwise.
+- The `<`, `>` around the argument name a optional, but are always shown in de usage message for better legibility
+- Optional-tokens can occur anywhere in the options, as long as they are not nested and properly closed. You can group optional parts, meaning that both options/arguments should be available or both not.
+- Options and/or arguments are mandatory unless specified otherwise.
+- Aliases should be the same "type", meaning that if the original option expands an value, the alias must do as well
+- Aliases are only allowed for short and long options, with or without value and can be optional, just like regular options
 
 Grouping of optionals allows you do things like this:
 
 ```ruby
 app = Consoler::Application.new
-app.shout '[first_name last_name] [name]' do |first_name, last_name, name|
+app.shout '[<first_name> <last_name>] [<name>]' do |first_name, last_name, name|
   # by definition, `last_name` is also filled
   unless first_name.nil? then
     puts "Hello #{first_name} #{last_name}!"
@@ -172,11 +181,11 @@ end
 
 # calling with two arguments can fill the first group
 # prints "Hello John Doe!"
-app.run(['shout', 'John', 'Doe'])
+app.run ['shout', 'John', 'Doe']
 
 # calling with one argument it is not possible to fill the first group
 # prints "Hello Mr. White!"
-app.run(['shout', 'Mr. White!'])
+app.run ['shout', 'Mr. White!']
 ```
 
 #### Return types in action block
@@ -188,6 +197,8 @@ app.run(['shout', 'Mr. White!'])
 | Value       | `String` (`production`) | `nil`                 |
 | Argument    | `String` (`dist/`)      | `nil`                 |
 
+Aliased keep the properties as the original options; with a definition of `-v|--verbose` and providing `--verbose` as an argument, both `v` and `verbose` contain a number (`1` in this case). Same goes the other way around; with a definition of `--force|-f` and providing `-f` as an argument, both `force` and `f` contain a boolean (`true` in this case).
+
 #### Subapplications
 
 To make application nesting possible you can provide a complete application to a command, instead of an action block.
@@ -200,7 +211,7 @@ android = Consoler::Application.new
 android.build do; end
 
 # options are supported just like regular apps
-android.clean '--force' do; end
+android.clean '--force|-f' do; end
 
 # create an application
 app = Consoler::Application.new
@@ -245,7 +256,7 @@ app = Consoler::Application.new
 app.db db
 app.cache cache
 
-app.build '[--clean] [--env=] [-v] output_dir -- build the project' do |clean, env, v, output_dir|
+app.build '[--clean] [--env=] [-v] <output_dir> -- build the project' do |clean, env, v, output_dir|
   puts 'Starting build...' if v > 0
 
   if clean
@@ -274,10 +285,6 @@ Make the file executable with `chmod a+x app.rb`, you can now call it with `./ap
 ./app.rb
 ```
 
-### Current wish-list
-
-- Aliases, mostly to "document" short options, `-v|--verbose`
-
 ## Final notes
 
 If you like what you see, feel free to use it anyway you like. Also, don't hold back if you have suggestions/question and create an issue to let me know, and we can talk about it. And if you don't like what you see, PRs are welcome. You should probably file an issue first to make sure it's something worth doing, and the right way to do it.

data/consoler.gemspec

@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   # build docs on install
   spec.metadata['yard.run'] = 'yri'
 
+  spec.required_ruby_version = '>= 2.2'
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 12.3.0'
   spec.add_development_dependency 'minitest', '~> 5.11.3'
-  spec.add_development_dependency 'yard', '~> 0.9.12'
+  spec.add_development_dependency 'rake', '~> 12.3.0'
   spec.add_development_dependency 'simplecov', '~> 0.15.1'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
 end

data/lib/consoler/application.rb

@@ -4,7 +4,6 @@ require_relative 'options'
 require_relative 'arguments'
 
 module Consoler
-
   # Consoler application
   #
   # @example A simple application
@@ -24,16 +23,25 @@ module Consoler
   #   # this does not match, nothing is executed and the usage message is printed
   #   app.run(['deploy', 'production'])
   class Application
-
     # Create a consoler application
     #
     # @param options [Hash] Options for the application
     # @option options [String] :description The description for the application (optional)
-    def initialize(options={})
+    def initialize(options = {})
       @description = options[:description]
       @commands = []
     end
 
+    # Accept all method_missing call
+    #
+    # We use the name as a command name, thus we accept all names
+    #
+    # @param _method_name [String] Name of the method
+    # @param _include_private [bool] Name of the method
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+
     # Register a command for this app
     #
     # @param command_name [Symbol] Name of the command
@@ -44,21 +52,21 @@ module Consoler
       action = nil
       options_def = ''
 
-      unless block.nil? then
+      unless block.nil?
         action = block
         options_def = input
 
-        if not options_def.nil? and not options_def.instance_of? String then
+        if !options_def.nil? && !options_def.instance_of?(String)
           raise 'Invalid options'
         end
       end
 
-      if input.instance_of? Consoler::Application then
+      if input.instance_of? Consoler::Application
         action = input
         options_def = ''
       end
 
-      if action.nil? then
+      if action.nil?
         raise 'Invalid subapp/block'
       end
 
@@ -66,7 +74,7 @@ module Consoler
 
       _add_command(command, options_def, action)
 
-      return nil
+      nil
     end
 
     # Run the application with a list of arguments
@@ -75,15 +83,15 @@ module Consoler
     # @param disable_usage_message [Boolean] Disable the usage message when nothing it matched
     # @return [mixed] Result of your matched command, <tt>nil</tt> otherwise
     def run(args = ARGV, disable_usage_message = false)
-      # TODO signal handling of some kind?
+      # TODO: signal handling of some kind?
 
       result, matched = _run(args.dup)
 
-      if not matched and not disable_usage_message
+      if !matched && !disable_usage_message
         usage
       end
 
-      return result
+      result
     end
 
     # Show the usage message
@@ -93,7 +101,7 @@ module Consoler
       puts "#{@description}\n\n" unless @description.nil?
       puts 'Usage:'
 
-      _commands_usage $0
+      _commands_usage $PROGRAM_NAME
     end
 
     protected
@@ -107,13 +115,13 @@ module Consoler
       arguments = Consoler::Arguments.new args
 
       @commands.each do |command|
-        if command.command == arg then
+        if command.command == arg
           # the matched command contains a subapp, run subapp with the same
           # arguments (excluding the arg that matched this command)
-          if command.action.instance_of? Consoler::Application then
+          if command.action.instance_of?(Consoler::Application)
             result, matched = command.action._run(args)
 
-            if matched then
+            if matched
               return result, true
             end
           else
@@ -126,26 +134,26 @@ module Consoler
         end
       end
 
-      return nil, false
+      [nil, false]
     end
 
     # Print the usage message for this command
     #
     # @param [String] prefix A prefix for the command from a parent app
     # @return [Consoler::Application]
-    def _commands_usage(prefix='')
+    def _commands_usage(prefix = '')
       @commands.each do |command|
         # print the usage message of a subapp with a prefix from the current command
-        if command.action.instance_of? Consoler::Application then
+        if command.action.instance_of?(Consoler::Application)
           command.action._commands_usage "#{prefix} #{command.command}"
         else
           print "  #{prefix} #{command.command}"
 
-          if command.options.size then
+          if command.options.size
             print " #{command.options.to_definition}"
           end
 
-          unless command.options.description.nil? then
+          unless command.options.description.nil?
             print "  -- #{command.options.description}"
           end
 
@@ -165,11 +173,13 @@ module Consoler
     # @param [Proc, Consoler::Application] action Action or subapp
     # @return [Consoler::Application]
     def _add_command(command, options_def, action)
-      @commands.push(Consoler::Command.new(
-        command: command,
-        options: Consoler::Options.new(options_def),
-        action: action,
-      ))
+      @commands.push(
+        Consoler::Command.new(
+          command: command,
+          options: Consoler::Options.new(options_def),
+          action: action,
+        )
+      )
 
       self
     end
@@ -183,7 +193,7 @@ module Consoler
       arguments = action.parameters.map do |parameter|
         parameter_name = parameter[1].to_s
 
-        if match.has_key? parameter_name then
+        if match.key? parameter_name
           match[parameter_name]
         else
           # check for the normalized name of every match to see
@@ -191,7 +201,7 @@ module Consoler
           match.each do |name, value|
             normalized_name = _normalize name
 
-            if parameter_name == normalized_name then
+            if parameter_name == normalized_name
               return value
             end
           end
@@ -212,7 +222,7 @@ module Consoler
       # also be an syntax error, like starting with a number.
       # this normalization is more of a comvenience than anything
       # else
-      name.gsub('-', '_')
+      name.tr('-', '_')
     end
   end
 end

data/lib/consoler/arguments.rb

@@ -3,7 +3,6 @@
 require_relative 'matcher'
 
 module Consoler
-
   # Arguments
   #
   # @attr_reader [Array<String>] args Raw arguments

data/lib/consoler/command.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Consoler
-
   # Consoler command
   #
   # Basically a named hash

data/lib/consoler/matcher.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 module Consoler
-
   # Argument/Options matcher
   #
   # Given a list of arguments and a list option try to match them
   class Matcher
-
     # Create a matcher
     #
     # @param [Consoler::Arguments] arguments List of arguments
@@ -27,14 +25,14 @@ module Consoler
       parse_options = true
 
       _loop_args do |arg|
-        unless parse_options then
+        unless parse_options
           @argument_values.push arg
           next
         end
 
         # when "argument" is --, then stop parsing the rest of the arguments
         # and treat the rest as regular arguments
-        if arg == '--' then
+        if arg == '--'
           parse_options = false
           next
         end
@@ -49,12 +47,20 @@ module Consoler
       remaining = _match_arguments
       _fill_defaults
 
-      if @matched_options.size == @options.size then
+      if @matched_options.size == @options.size
         @matched_options['remaining'] = remaining
+
+        # make sure all aliases are also filled
+        @options.each do |option|
+          option.aliases.each do |alias_|
+            @matched_options[alias_.name] = @matched_options[option.name]
+          end
+        end
+
         return @matched_options
       end
 
-      return nil
+      nil
     end
 
     private
@@ -68,59 +74,58 @@ module Consoler
       is_short = false
       name = nil
 
-      if arg[0..1] == '--' then
+      if arg[0..1] == '--'
         is_long = true
         name = arg[2..-1]
-      elsif arg[0] == '-' then
+      elsif arg[0] == '-'
         is_short = true
         name = arg[1..-1]
       end
 
       # arg is not a long/short option, add to arguments values
-      unless is_long or is_short then
+      unless is_long || is_short
         @argument_values.push arg
         return true
       end
 
-      unless name.nil? then
+      unless name.nil?
         # get the name of the option, short options use the first character
-        option_name = if is_short then
+        option_name = if is_short
                         name[0]
                       else
                         name
                       end
 
-        option = @options.get option_name
+        option, matched = @options.get_with_alias option_name
 
         # no option by this name in options
         return nil if option.nil?
 
-        needs_short = option.is_short
-        needs_long = option.is_long
-
         # see if the type if right, short or long
-        if needs_long and not is_long then
+        if matched.is_long && !is_long
           return nil
-        elsif needs_short and not is_short then
+        elsif matched.is_short && !is_short
           return nil
         end
 
-        if is_long then
-          if option.is_value then
+        if is_long
+          if option.is_value
             # is_value needs a next argument for its value
             return nil if _peek_next.nil?
-            @matched_options[name] = _peek_next
+
+            @matched_options[option.name] = _peek_next
             _skip_next
           else
-            @matched_options[name] = true
+            option_value! option
           end
         end
 
-        if is_short then
-          if name.size == 1 and option.is_value then
+        if is_short
+          if name.size == 1 && option.is_value
             # is_value needs a next argument for its value
             return nil if _peek_next.nil?
-            @matched_options[name] = _peek_next
+
+            @matched_options[option.name] = _peek_next
             _skip_next
           else
             # for every character (short option) increment the option value
@@ -128,17 +133,30 @@ module Consoler
               short_option = @options.get n
               return nil if short_option.nil?
 
-              if @matched_options[n].nil? then
-                @matched_options[n] = 0
-              end
-
-              @matched_options[n] += 1
+              option_value! short_option
             end
           end
         end
       end
 
-      return true
+      true
+    end
+
+    # Set the value of an option
+    #
+    # Long or short option needed
+    #
+    # @param [Consoler::Option]
+    def option_value!(option)
+      if option.is_short
+        if @matched_options[option.name].nil?
+          @matched_options[option.name] = 0
+        end
+
+        @matched_options[option.name] += 1
+      else
+        @matched_options[option.name] = true
+      end
     end
 
     # Loop through the arguments
@@ -151,7 +169,7 @@ module Consoler
 
       # use an incrementing index, to be able to peek to the next in the list
       # and to skip an item
-      while @index < size do
+      while @index < size
         yield @arguments.args[@index]
 
         _skip_next
@@ -197,7 +215,7 @@ module Consoler
         # arguments supplied (info available from optionals map)
         optionals.each do |_, optional|
           optional.each do |before|
-            if before[:included] then
+            if before[:included]
               @matched_options[before[:name]] = @argument_values[argument_values_index]
               argument_values_index += 1
             end
@@ -205,7 +223,7 @@ module Consoler
         end
 
         # only fill mandatory argument if its not the :REMAINING key
-        if mandatory_arg_name != :REMAINING then
+        if mandatory_arg_name != :REMAINING
           @matched_options[mandatory_arg_name] = @argument_values[argument_values_index]
           argument_values_index += 1
         end
@@ -214,7 +232,7 @@ module Consoler
       remaining = []
 
       # left over arguments
-      while argument_values_index < @argument_values.size do
+      while argument_values_index < @argument_values.size
         remaining.push @argument_values[argument_values_index]
         argument_values_index += 1
       end
@@ -229,18 +247,18 @@ module Consoler
       @optionals_before = {}
       tracker = {}
 
-      @options.each do |option, key|
+      @options.each do |option, _key|
         next unless option.is_argument
 
-        if option.is_optional then
+        if option.is_optional
           # setup tracker for optional group
           tracker[option.is_optional] = [] if tracker[option.is_optional].nil?
 
           # mark all optionals as not-included
-          tracker[option.is_optional].push({
+          tracker[option.is_optional].push(
             included: false,
             name: option.name,
-          })
+          )
         else
           @optionals_before[option.name] = tracker
           tracker = {}
@@ -248,7 +266,7 @@ module Consoler
       end
 
       # make sure all optionals are accounted for in the map
-      if tracker != {} then
+      if tracker != {}
         # use a special key so we can handle it differently in the filling process
         @optionals_before[:REMAINING] = tracker
         @optionals_before_has_remaining = true
@@ -267,7 +285,7 @@ module Consoler
       mandatories_matched = @optionals_before.size
 
       # there are optionals at the end of the options, don't match the void
-      if @optionals_before_has_remaining then
+      if @optionals_before_has_remaining
         mandatories_matched -= 1
       end
 
@@ -276,11 +294,11 @@ module Consoler
       # loop through optional map
       _each_optional_before_sorted do |before|
         # are there enough arguments left to fill this optional group
-        if (total + before.size + mandatories_matched) <= @argument_values.size then
+        if (total + before.size + mandatories_matched) <= @argument_values.size
           total += before.size
 
           before.each do |val|
-            val[:included] = true;
+            val[:included] = true
           end
         end
       end
@@ -293,10 +311,10 @@ module Consoler
     # @return [Consoler::Matcher]
     def _fill_defaults
       @options.each do |option|
-        if option.is_optional then
-          unless @matched_options.has_key? option.name then
-            @matched_options[option.name] = option.default_value
-          end
+        next unless option.is_optional
+
+        unless @matched_options.key? option.name
+          @matched_options[option.name] = option.default_value
         end
       end
 
@@ -312,10 +330,10 @@ module Consoler
       @optionals_before.each do |_, optionals|
         tmp = []
         optionals.each do |optional_index, before|
-          tmp.push({
+          tmp.push(
             count: before.size,
             index: optional_index,
-          })
+          )
         end
 
         tmp.sort! { |a, b| b[:count] - a[:count] }.each do |item|

data/lib/consoler/option.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Consoler
-
   # Represents an option
   #
   # @attr_reader [String] name Name of the options
@@ -10,6 +9,7 @@ module Consoler
   # @attr_reader [Boolean] is_argument Is the option an argument
   # @attr_reader [Boolean] is_value Does the option need a value (<tt>--option=</tt>)
   # @attr_reader [Integer] is_optional Is the option optional (> 0) (<tt>[option]</tt>)
+  # @attr_reader [Array] aliases List of aliases of option (<tt>-v|--verbose</tt>)
   class Option
     attr_reader :name
     attr_reader :is_long
@@ -17,6 +17,7 @@ module Consoler
     attr_reader :is_argument
     attr_reader :is_value
     attr_reader :is_optional
+    attr_reader :aliases
 
     # Create a option
     #
@@ -28,13 +29,13 @@ module Consoler
       option = Option.new option_def, tracker
 
       # split short options with more than 1 char in multiple options
-      if option.is_short and option.name.size > 1 then
+      if option.is_short && option.name.size > 1
         # remember state
         old_tracking = tracker.is_tracking
         old_is_value = option.is_value
 
         # if the complete option is optional, fake the tracker
-        if option.is_optional then
+        if option.is_optional
           tracker.is_tracking = true
         end
 
@@ -44,7 +45,7 @@ module Consoler
           new_name = "-#{name}"
 
           # if the short option should have a value, this only counts for the last option
-          if old_is_value and i == names.count - 1 then
+          if old_is_value && i == names.count - 1
             new_name = "#{new_name}="
           end
 
@@ -67,14 +68,20 @@ module Consoler
     def to_definition
       definition = name
 
-      if is_long then
+      if is_long
         definition = "--#{definition}"
-      elsif is_short then
+      elsif is_short
         definition = "-#{definition}"
       end
 
-      if is_value then
+      if is_value
         definition = "#{definition}="
+      elsif is_argument
+        definition = "<#{definition}>"
+      end
+
+      aliases.each do |alias_|
+        definition = "#{definition}|#{alias_.to_definition}"
       end
 
       definition
@@ -88,7 +95,7 @@ module Consoler
       return 0 if is_short
       return false if is_long
 
-      return nil
+      nil
     end
 
     protected
@@ -103,19 +110,33 @@ module Consoler
       # Check for multiple attributes in the option definition till we got the
       # final name and all of its attributes
 
-      option, @is_optional = _is_optional option_def, tracker
+      # make sure we don't wrongly process any alias
+      alias_defs = option_def.split '|'
+      option = alias_defs.shift || ''
+
+      option, @is_optional = _is_optional option, tracker
       option, @is_long = _is_long option
       option, @is_short = _is_short option
-      @is_argument = (not @is_long and not @is_short)
+      @is_argument = (!@is_long && !@is_short)
       option, @is_value = _value option, @is_argument
+      option, @aliases = _aliases option, alias_defs, tracker
+
+      if option[0] == '<'
+        raise 'Invalid <, missing >' if option[-1] != '>'
+        raise 'Only arguments support <, > around name' unless @is_argument
+
+        option = option[1..-2]
+      end
+
+      raise 'Missing starting <' if option[-1] == '>'
 
       @name = option
 
-      if @name.empty? then
+      if @name.empty?
         raise 'Option must have a name'
       end
 
-      if @is_long and @is_short
+      if @is_long && @is_short
         raise 'Option can not be a long and a short option'
       end
     end
@@ -135,8 +156,8 @@ module Consoler
     # @raise [RuntimeError] if you try to close an unopened optional
     # @return [(String, Integer|nil)] Remaining option definition, and, optional group if available
     def _is_optional(option, tracker)
-      if option[0] == '[' then
-        if !tracker.is_tracking then
+      if option[0] == '['
+        if !tracker.is_tracking
           # mark tracker as tracking
           tracker.is_tracking = true
           tracker.index += 1
@@ -147,14 +168,12 @@ module Consoler
       end
 
       # get optional group index from tracking, if tracking
-      optional = if tracker.is_tracking then
+      optional = if tracker.is_tracking
                    tracker.index
-                 else
-                   nil
                  end
 
-      if option[-1] == ']' then
-        if tracker.is_tracking then
+      if option[-1] == ']'
+        if tracker.is_tracking
           # mark tracker as non-tracking
           tracker.is_tracking = false
           option = option[0..-2]
@@ -163,7 +182,7 @@ module Consoler
         end
       end
 
-      return option, optional
+      [option, optional]
     end
 
     # Check long definition
@@ -171,14 +190,14 @@ module Consoler
     # @param [String] option Option definition
     # @return [(String, Boolean)]
     def _is_long(option)
-      if option[0..1] == '--' then
+      if option[0..1] == '--'
         long = true
         option = option[2..-1]
       else
         long = false
       end
 
-      return option, long
+      [option, long]
     end
 
     # Check short definition
@@ -186,14 +205,14 @@ module Consoler
     # @param [String] option Option definition
     # @return [(String, Boolean)]
     def _is_short(option)
-      if option[0] == '-' then
+      if option[0] == '-'
         short = true
         option = option[1..-1]
       else
         short = false
       end
 
-      return option, short
+      [option, short]
     end
 
     # Check value definition
@@ -202,8 +221,8 @@ module Consoler
     # @raise [RuntimeError] if you try to assign a value to an argument
     # @return [(String, Boolean)]
     def _value(option, argument)
-      if option[-1] == '=' then
-        if argument then
+      if option[-1] == '='
+        if argument
           raise 'Arguments can\'t have a value'
         end
 
@@ -213,7 +232,36 @@ module Consoler
         value = false
       end
 
-      return option, value
+      [option, value]
+    end
+
+    # Parse all possible aliases
+    #
+    # @param [String] option Option definition
+    # @param [Consoler::Tracker] tracker Optional tracker
+    # @raise [RuntimeError] On all kinds of occasions
+    # @return [(String, Array)] Remaining option definition, and, aliases if available
+    def _aliases(option, alias_defs, tracker)
+      return option, [] if alias_defs.empty?
+
+      raise 'Argument can\'t have aliases' if is_argument
+      raise 'Aliases are not allowed for multiple short options' if is_short && option.size > 1
+
+      aliases_ = []
+      alias_names = []
+
+      while (alias_def = alias_defs.shift)
+        Consoler::Option.create alias_def, tracker do |alias_|
+          raise "Duplicate alias name: #{alias_.name}" if alias_names.include? alias_.name
+          raise "Alias must have a value: #{alias_.name}" if is_value && !alias_.is_value
+          raise "Alias can't have a value: #{alias_.name}" if !is_value && alias_.is_value
+
+          aliases_.push alias_
+          alias_names.push alias_.name
+        end
+      end
+
+      [option, aliases_]
     end
   end
 end

data/lib/consoler/options.rb

@@ -3,7 +3,6 @@
 require_relative 'option'
 
 module Consoler
-
   # List of options
   #
   # @attr_reader [String] description Description of the options
@@ -21,7 +20,7 @@ module Consoler
       return if options_def.nil?
 
       # strip the description
-      if match = /(^|\s+)-- (?<description>.*)$/.match(options_def) then
+      if (match = /(^|\s+)-- (?<description>.*)$/.match(options_def))
         @description = match[:description]
         options_def = options_def[0...-match[0].size]
       end
@@ -31,28 +30,50 @@ module Consoler
 
       option_names = []
 
-      while option_def = options.shift do
+      while (option_def = options.shift)
         Consoler::Option.create option_def, tracker do |option|
           raise "Duplicate option name: #{option.name}" if option_names.include? option.name
 
-          @options.push option
           option_names.push option.name
+
+          option.aliases.each do |alias_|
+            raise "Duplicate alias name: #{alias_.name}" if option_names.include? alias_.name
+
+            option_names.push alias_.name
+          end
+
+          @options.push option
         end
       end
     end
 
-    # Get a options by its name
+    # Get a option by its name
+    #
+    # May be matched by one of its aliases
     #
     # @param name [String] Name of the option
     # @return [Consoler::Option, nil]
     def get(name)
+      option, = get_with_alias name
+      option
+    end
+
+    # Get a option by its name, with matched alias
+    #
+    # @param name [String] Name of the option
+    # @return [[(Consoler::Option, nil), (Consoler::Option, nil)]]
+    def get_with_alias(name)
       each do |option, _|
-        if option.name == name then
-          return option
+        if option.name == name
+          return option, option
+        end
+
+        option.aliases.each do |alias_|
+          return option, alias_ if alias_.name == name
         end
       end
 
-      return nil
+      [nil, nil]
     end
 
     # Loop through all options
@@ -84,19 +105,17 @@ module Consoler
       each do |option, i|
         definition += ' '
 
-        if optional.nil? and option.is_optional then
+        if optional.nil? && option.is_optional
           definition += '['
           optional = option.is_optional
         end
 
         definition += option.to_definition
 
-        if option.is_optional then
-          # only close when the next option is not optional, or another optional group
-          if @options[i + 1].nil? or optional != @options[i + 1].is_optional then
-            definition += ']'
-            optional = nil
-          end
+        # only close when the next option is not optional, or another optional group
+        if option.is_optional && (@options[i + 1].nil? || optional != @options[i + 1].is_optional)
+          definition += ']'
+          optional = nil
         end
       end
 
@@ -104,8 +123,6 @@ module Consoler
     end
   end
 
-  private
-
   # Optionals tracker
   #
   # @attr [Boolean] is_tracking Is inside optional options

data/lib/consoler/version.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Consoler
-
   # Current version number
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consoler
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 5.11.3
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.15.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.9.12
 description: Sinatra-like application builder for the console
 email: me@justim.net
 executables: []
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -116,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Consoler