eac_cli 0.38.0 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e016c3cb10caefe2fcc4f81d73dbdf76cff97a0e11ecb49f4b8378be238b7a
-  data.tar.gz: 676cf803931311818d97ea9a5421e360e16a36495e93a2cf90a938afdb526562
+  metadata.gz: 8a58c5ccac3080dd986b2727ce365a7979a801f059016faa0f7fe8dd8b86e1d3
+  data.tar.gz: 06cb591e776e862bfcbe048fb524f05a8bd06b3e85a86a14c28df40654355eba
 SHA512:
-  metadata.gz: 9902444b9eb020f42bf0b33c2c7afe5c8dae6651ad7ae2f6a0b57a563424715eed55058ca48f4b50d572a1284a62d0c4e0246ecbb0b15f907c10b12254a6f7b3
-  data.tar.gz: d62d638adea120b7dd203cafff53646a40ef011659bb952216e130d49988d06ceb151f85caf5832301092448c95ef46ffe82223ba550f6a9c6bb2b298bf21e3e
+  metadata.gz: 3ebf30f86ad003589e75880af90d75058a55c9e76ed386f0a1972c175ed22c2ea8c135c765ff2cf1d7476591126eac66ea680b6f38c96a95a800069a140060fd
+  data.tar.gz: 1d2ea1f751023f5a11e2ef8465bab272429e29088e27123830fae2cb041d7ce4524c931c08a2088597664edc638bf6eb775c7a8e2b6ede1af05e09fe02bc7d7f

data/lib/eac_cli/config/entry.rb

@@ -22,8 +22,9 @@ module EacCli
         root_node
       end
 
+      # @return [Object, nil]
       def value
-        value!
+        sub_entry.found? ? sub_value_to_return : nil
       end
 
       def value!

data/lib/eac_cli/definition/alternative.rb

@@ -2,7 +2,7 @@
 
 require 'eac_cli/definition/argument_option'
 require 'eac_cli/definition/boolean_option'
-require 'eac_cli/definition/positional_argument'
+require 'eac_cli/definition/positional'
 
 module EacCli
   class Definition
@@ -54,7 +54,7 @@ module EacCli
       end
 
       def pos_arg(name, arg_options = {})
-        new_pos_arg = ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+        new_pos_arg = ::EacCli::Definition::Positional.new(name, arg_options)
         check_positional_blocked(new_pos_arg)
         pos_set << new_pos_arg
       end
@@ -76,8 +76,8 @@ module EacCli
 
       def subcommands
         pos_arg(SUBCOMMAND_NAME_ARG, subcommand: true)
-        pos_set << ::EacCli::Definition::PositionalArgument.new(SUBCOMMAND_ARGS_ARG,
-                                                                optional: true, repeat: true)
+        pos_set << ::EacCli::Definition::Positional.new(SUBCOMMAND_ARGS_ARG,
+                                                        optional: true, repeat: true)
       end
 
       def subcommands?

data/lib/eac_cli/definition/argument_option.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'eac_cli/definition/base_option'
+require 'eac_cli/definition/option'
 
 module EacCli
   class Definition
-    class ArgumentOption < ::EacCli::Definition::BaseOption
+    class ArgumentOption < ::EacCli::Definition::Option
       def argument?
         true
       end

data/lib/eac_cli/definition/boolean_option.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'eac_cli/definition/base_option'
+require 'eac_cli/definition/option'
 
 module EacCli
   class Definition
-    class BooleanOption < ::EacCli::Definition::BaseOption
+    class BooleanOption < ::EacCli::Definition::Option
       def argument?
         false
       end
@@ -16,8 +16,7 @@ module EacCli
       def default_value
         return super unless default_value?
 
-        raise(::EacCli::Definition::Error,
-              "Unallowed default value for boolean options (Option: #{self})")
+        raise("Unallowed default value for boolean options (Option: #{self})")
       end
 
       def default_default_value

data/lib/eac_cli/definition/{base_option → option}/initialize_args_parser.rb

@@ -2,7 +2,7 @@
 
 module EacCli
   class Definition
-    class BaseOption
+    class Option
       class InitializeArgsParser
         PROPERTIES = %i[short long description options].freeze
         attr_reader(*PROPERTIES)

data/lib/eac_cli/definition/option.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/option_or_positional'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    # @abstract
+    class Option < ::EacCli::Definition::OptionOrPositional
+      require_sub __FILE__
+
+      class << self
+        # @param args [Enumerable<String>]
+        # @return [EacCli::Definition::Option]
+        def from_args(args)
+          p = ::EacCli::Definition::Option::InitializeArgsParser.new(args)
+          new(p.short, p.long, p.description, p.options)
+        end
+      end
+
+      DEFAULT_REQUIRED = false
+
+      enable_abstract_methods
+      lists.add_symbol :option, *OPTION_LIST, :default, :usage
+
+      # @!method initialize(short, long, description, options = {})
+      # @param short [String]
+      # @param long [String]
+      # @param description [String]
+      # @param options [Hash<Symbol, Object>]
+      # @raise [EacCli::Definition::Error]
+      common_constructor :short, :long, :description, :options, default: [{}] do
+        validate
+        self.options = ::EacCli::Definition::Option.lists.option.hash_keys_validate!(
+          options.symbolize_keys
+        )
+      end
+
+      # @return [Object]
+      def default_value
+        default_value? ? options[OPTION_DEFAULT] : default_default_value
+      end
+
+      # @return [Boolean]
+      def default_value?
+        options.key?(OPTION_DEFAULT)
+      end
+
+      # @return [Symbol]
+      # @raise [EacCli::Definition::Error] If no short or long option is provided.
+      def identifier
+        [long, short].each do |v|
+          v.to_s.if_present { |vv| return vv.variableize.to_sym }
+        end
+
+        raise('No short or long option to build identifier')
+      end
+
+      # @return [Boolean]
+      def show_on_usage?
+        options[:usage]
+      end
+
+      private
+
+      # @return [void]
+      # @raise [EacCli::Definition::Error]
+      def validate
+        raise 'Nor short neither long selector was set' if short.blank? && long.blank?
+      end
+    end
+  end
+end

data/lib/eac_cli/definition/option_or_positional.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    # @abstract
+    class OptionOrPositional
+      acts_as_abstract :build_value, :default_value, :identifier, :options
+      enable_listable
+
+      OPTION_LIST = %i[optional repeat required].freeze
+
+      # @return [Boolean]
+      def optional?
+        !required?
+      end
+
+      # @raise [EacCli::Definition::Error]
+      def raise(*args)
+        ::Kernel.raise ::EacCli::Definition::Error, *args
+      end
+
+      # @return [Boolean]
+      def repeat?
+        options[:repeat] ? true : false
+      end
+
+      # @return [Boolean]
+      def required?
+        return true if options.key?(:required) && options.fetch(:required)
+        return false if options.key?(:optional) && options.fetch(:optional)
+
+        self.class.const_get('DEFAULT_REQUIRED')
+      end
+
+      # @return [String]
+      def to_s
+        "#{self.class.name.demodulize}[#{identifier}]"
+      end
+    end
+  end
+end

data/lib/eac_cli/definition/{positional_argument.rb → positional.rb}

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
+require 'eac_cli/definition/option_or_positional'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
   class Definition
-    class PositionalArgument
+    class Positional < ::EacCli::Definition::OptionOrPositional
       DEFAULT_REQUIRED = true
       DEFAULT_VISIBLE = true
 
-      enable_listable
-      lists.add_symbol :option, :optional, :repeat, :required, :subcommand, :visible
+      lists.add_symbol :option, *OPTION_LIST, :subcommand, :visible
+
+      # @!method initialize(name, options = {})
+      # @param name [String]
+      # @param options [Hash<Symbol, Object>]
       common_constructor :name, :options, default: [{}] do
         options.assert_valid_keys(self.class.lists.option.values)
       end
 
+      # @param new_value [Array, Object]
+      # @param previous_value [Array, Object]
+      # @return [Array]
       def build_value(new_value, previous_value)
         if previous_value.is_a?(::Array)
           previous_value + [new_value]
@@ -22,37 +29,22 @@ module EacCli
         end
       end
 
+      # @return [Object]
       def default_value
         repeat? ? [] : nil
       end
 
+      # @return [Symbol]
       def identifier
         name.to_s.variableize.to_sym
       end
 
-      def optional?
-        !required?
-      end
-
-      def repeat?
-        options[OPTION_REPEAT]
-      end
-
-      def required?
-        return true if options.key?(OPTION_REQUIRED) && options.fetch(OPTION_REQUIRED)
-        return false if options.key?(OPTION_OPTIONAL) && options.fetch(OPTION_OPTIONAL)
-
-        DEFAULT_REQUIRED
-      end
-
+      # @return [Boolean]
       def subcommand?
         options[OPTION_SUBCOMMAND]
       end
 
-      def to_s
-        "#{self.class.name.demodulize}[#{identifier}]"
-      end
-
+      # @return [Boolean]
       def visible?
         options.key?(OPTION_VISIBLE) ? options.fetch(OPTION_VISIBLE) : DEFAULT_VISIBLE
       end

data/lib/eac_cli/definition.rb

@@ -2,7 +2,7 @@
 
 require 'eac_cli/definition/argument_option'
 require 'eac_cli/definition/boolean_option'
-require 'eac_cli/definition/positional_argument'
+require 'eac_cli/definition/positional'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
@@ -13,6 +13,7 @@ module EacCli
     SUBCOMMAND_NAME_ARG = 'subcommand'
     SUBCOMMAND_ARGS_ARG = 'subcommand_args'
 
+    # @return [String, nil]
     attr_accessor :description
 
     def initialize
@@ -20,25 +21,35 @@ module EacCli
       alternatives_set[MAIN_ALTERNATIVE_KEY] = main_alternative
     end
 
-    def alt(&block)
+    # @return [EacCli::Definition::Alternative]
+    def alt(key = nil, &block)
+      key ||= new_alternative_key
+      raise(::EacCli::Definition::Error, "A alternative with key=\"#{key}\" already exists") if
+        key.present? && alternatives_set.key?(key)
+
       r = ::EacCli::Definition::Alternative.new
       r.instance_eval(&block)
-      alternatives_set[new_alternative_key] = r
+      alternatives_set[key] = r
       r
     end
 
+    # @return [Enumerable<EacCli::Definition::Alternative>]
     def alternatives
       alternatives_set.values
     end
 
+    # @return [EacCli::Definition::Alternative]
+    # @raise [KeyError] If there is not a alternative with provided key.
     def alternative(key)
       alternatives_set.fetch(key)
     end
 
+    # Same as {#description=}.
     def desc(description)
       self.description = description
     end
 
+    # @return [EacCli::Definition::Alternative]
     def main_alternative
       @main_alternative ||= begin
         r = ::EacCli::Definition::Alternative.new
@@ -47,10 +58,13 @@ module EacCli
       end
     end
 
+    # Same as {#options_argument=}.
+    # @param options_argument [Boolean]
     def options_arg(options_argument)
       self.options_argument = options_argument
     end
 
+    # @return [Boolean]
     def options_argument
       main_alternative.options_argument?
     end

data/lib/eac_cli/parser/alternative/argv.rb

@@ -4,10 +4,12 @@ module EacCli
   class Parser
     class Alternative
       module Argv
+        # @return [Enumerator<String>]
         def argv_enum
           @argv_enum ||= argv.each
         end
 
+        # @return [Boolean]
         def argv_pending?
           argv_enum.ongoing?
         end

data/lib/eac_cli/parser/alternative/short_options.rb

@@ -5,23 +5,29 @@ module EacCli
     class Alternative
       module ShortOptions
         SHORT_OPTION_PREFIX = '-'
+        SHORT_OPTION_CHAR_PATTERN = /\A[0-9a-zA-Z]\z/.freeze
 
         private
 
+        # @return [Boolean]
         def argv_current_short_option?
           phase == PHASE_ANY && argv_enum.peek.start_with?(SHORT_OPTION_PREFIX) &&
             !argv_current_long_option?
         end
 
+        # @para char [String]
+        # @return [EacCli::Definition::Option, nil]
         def find_short_option(char)
           alternative.options.find do |option|
             short_without_prefix(option.short).if_present(false) { |v| v == char }
           end
         end
 
+        # @return [void]
         def short_option_collect_argv_value
           last_option = nil
           short_without_prefix(argv_enum.peek).each_char do |char|
+            raise_error "Invalid option: \"#{char}\"" unless SHORT_OPTION_CHAR_PATTERN.match?(char)
             raise_error "Option \"#{last_option}\" requires a argument not provided" if
             last_option.present?
 
@@ -30,12 +36,15 @@ module EacCli
           end
         end
 
-        # @return [EacCli::Definition::BaseOption] The option collected.
+        # @param char [String]
+        # @return [EacCli::Definition::Option] The option collected.
         def short_option_collect_char(char)
           option = find_short_option(char)
           option ? option_collect_option(option) : any_option_collect_option
         end
 
+        # @param short [String]
+        # @return [String]
         def short_without_prefix(short)
           short.to_s.gsub(/\A#{::Regexp.quote(SHORT_OPTION_PREFIX)}/, '')
         end

data/lib/eac_cli/parser/alternative.rb

@@ -10,30 +10,40 @@ module EacCli
       require_sub __FILE__, include_modules: true
       enable_listable
       lists.add_symbol :phase, :any, :option_argument, :positional
+
+      # @return [EacCli::Parser::Error, nil]
       attr_reader :error
 
+      # @!method initialize(alternative, argv)
+      # @param alternative [EacCli::Definition::Alternative]
+      # @param argv [Array<String>]
       common_constructor :alternative, :argv do
         alternative.assert_argument(::EacCli::Definition::Alternative, :alternative)
         self.phase = PHASE_ANY
         collect
       end
 
+      # @return [Boolean]
       def error?
         error.present?
       end
 
+      # @return [Boolean]
       def success?
         !error?
       end
 
+      # @return [EacRubyUtils::Struct]
       def parsed
         @parsed ||= collector.to_data.freeze
       end
 
       private
 
+      # @return [Symbol]
       attr_accessor :phase
 
+      # @return [void]
       def any_collect_argv_value
         %w[double_dash long_option short_option].each do |arg_type|
           return send("#{arg_type}_collect_argv_value") if send("argv_current_#{arg_type}?")
@@ -42,10 +52,12 @@ module EacCli
         positional_collect_argv_value
       end
 
+      # @return [EacCli::Parser::Collector]
       def collector
         @collector ||= ::EacCli::Parser::Collector.new(alternative)
       end
 
+      # @return [void]
       def collect
         loop do
           break unless argv_pending?
@@ -57,21 +69,29 @@ module EacCli
         @error = e
       end
 
+      # @return [void]
       def collect_argv_value
         send("#{phase}_collect_argv_value")
         argv_enum.next
       end
 
+      # @param message [String]
+      # @raise [EacCli::Parser::Error] Always.
       def raise_error(message)
         raise ::EacCli::Parser::Error.new(alternative, argv, message)
       end
 
+      # @return [void]
+      # @raise [EacCli::Parser::Error] If options where not properly supplied.
       def validate
         (alternative.options + alternative.positional).each do |option|
           validate_option(option)
         end
       end
 
+      # @param option [EacCli::Definition::Option, EacCli::Definition::Positional]
+      # @return [void]
+      # @raise [EacCli::Parser::Error] If option was not properly supplied.
       def validate_option(option)
         return unless option.required?
         return if collector.supplied?(option)

data/lib/eac_cli/parser/collector.rb

@@ -14,29 +14,38 @@ module EacCli
         end
       end
 
+      # @!method initialize(definition)
+      # @param definition [EacCli::Definition]
       common_constructor :definition do
         default_values
       end
 
-      # @return [OpenStruct]
+      # @return [EacRubyUtils::Struct]
       def to_data
         ::EacRubyUtils::Struct.new(data.transform_keys(&:identifier))
       end
 
+      # @param option [EacCli::Definition::Option]
+      # @param value [String]
+      # @return [void]
       def collect(option, value)
         data[option] = option.build_value(value, data[option])
       end
 
+      # @param option [EacCli::Definition::Option]
+      # @return [Boolean]
       def supplied?(option)
         data[option].present?
       end
 
       private
 
+      # @return [Hash]
       def data
         @data ||= {}
       end
 
+      # @return [void]
       def default_values
         definition.options.each { |option| data[option] = option.default_value }
         definition.positional.each { |positional| data[positional] = positional.default_value }

data/lib/eac_cli/rspec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'eac_ruby_utils/core_exts'
+require 'eac_ruby_utils/core_ext'
 
 module EacCli
   module Rspec

data/lib/eac_cli/runner/class_runner.rb

@@ -29,7 +29,7 @@ module EacCli
 
       def run_parser_error(runner_instance, error)
         $stderr.write("#{runner_instance.program_name}: #{error}\n")
-        ::Kernel.exit(PARSER_ERROR_EXIT_CODE) # rubocop:disable Rails/Exit
+        ::Kernel.exit(PARSER_ERROR_EXIT_CODE)
       end
     end
   end

data/lib/eac_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacCli
-  VERSION = '0.38.0'
+  VERSION = '0.38.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.38.1
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +76,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.9'
 description: 
 email: 
 executables: []
@@ -95,12 +101,12 @@ files:
 - lib/eac_cli/definition.rb
 - lib/eac_cli/definition/alternative.rb
 - lib/eac_cli/definition/argument_option.rb
-- lib/eac_cli/definition/base_option.rb
-- lib/eac_cli/definition/base_option/initialize_args_parser.rb
 - lib/eac_cli/definition/boolean_option.rb
-- lib/eac_cli/definition/default_value.rb
 - lib/eac_cli/definition/error.rb
-- lib/eac_cli/definition/positional_argument.rb
+- lib/eac_cli/definition/option.rb
+- lib/eac_cli/definition/option/initialize_args_parser.rb
+- lib/eac_cli/definition/option_or_positional.rb
+- lib/eac_cli/definition/positional.rb
 - lib/eac_cli/enum.rb
 - lib/eac_cli/old_configs.rb
 - lib/eac_cli/old_configs/entry_reader.rb

data/lib/eac_cli/definition/base_option.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/definition/default_value'
-require 'eac_ruby_utils/core_ext'
-
-module EacCli
-  class Definition
-    class BaseOption
-      require_sub __FILE__
-      include ::EacCli::Definition::DefaultValue
-
-      class << self
-        def from_args(args)
-          p = ::EacCli::Definition::BaseOption::InitializeArgsParser.new(args)
-          new(p.short, p.long, p.description, p.options)
-        end
-      end
-
-      DEFAULT_REQUIRED = false
-
-      enable_listable
-      enable_abstract_methods :build_value
-      lists.add_symbol :option, :default, :optional, :usage, :repeat, :required
-      common_constructor :short, :long, :description, :options, default: [{}] do
-        raise 'Nor short neither long selector was set' if short.blank? && long.blank?
-
-        self.options = ::EacCli::Definition::BaseOption.lists.option.hash_keys_validate!(
-          options.symbolize_keys
-        )
-      end
-
-      def default_value
-        default_value? ? options[OPTION_DEFAULT] : default_default_value
-      end
-
-      def default_value?
-        options.key?(OPTION_DEFAULT)
-      end
-
-      def identifier
-        [long, short].each do |v|
-          v.to_s.if_present { |vv| return vv.variableize.to_sym }
-        end
-
-        raise(::EacCli::Definition::Error, 'No short or long option to build identifier')
-      end
-
-      def repeat?
-        options[OPTION_REPEAT]
-      end
-
-      def required?
-        return true if options.key?(:required) && options.fetch(:required)
-        return false if options.key?(:optional) && options.fetch(:optional)
-
-        DEFAULT_REQUIRED
-      end
-
-      def to_s
-        "#{self.class.name.demodulize}[#{identifier}]"
-      end
-
-      def show_on_usage?
-        options[:usage]
-      end
-    end
-  end
-end

data/lib/eac_cli/definition/default_value.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module EacCli
-  class Definition
-    module DefaultValue
-      def default_value
-        default_value? ? options[OPTION_DEFAULT] : default_default_value
-      end
-
-      def default_value?
-        options.key?(OPTION_DEFAULT)
-      end
-    end
-  end
-end