consoler 1.0.1 → 1.2.1

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
@@ -13,13 +12,15 @@ module Consoler
     # Create a list of option based on a string definition
     #
     # @param options_def [String] A string definition of the desired options
+    # @raise [RuntimeError] if you try to use a duplicate name
     def initialize(options_def)
       @options = []
       @description = nil
 
       return if options_def.nil?
 
-      if match = /(^|\s+)-- (?<description>.*)$/.match(options_def) then
+      # strip the description
+      if (match = /(^|\s+)-- (?<description>.*)$/.match(options_def))
         @description = match[:description]
         options_def = options_def[0...-match[0].size]
       end
@@ -29,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)
-      each do |option|
-        if option.name == name then
-          return option
+      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
+          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
@@ -72,6 +95,9 @@ module Consoler
       @options.size
     end
 
+    # Get the definition for these options
+    #
+    # @return [String] Options definition
     def to_definition
       definition = ''
       optional = nil
@@ -79,18 +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
-          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
 
@@ -98,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.1'
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consoler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Tim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !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.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.16.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: []
@@ -87,8 +87,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/tests.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -115,15 +117,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Consoler

data/.travis.yml

@@ -1,11 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-cache:
-  - bundler
-script:
-  - bundle exec rake