eac_cli 0.12.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd062e7481cd022e3706681b1fccae579efc2ecab9378cca76871008d75d89f
-  data.tar.gz: b33f0432da0acd199ff02df511708a9eb56423d5b3fbc2a784b340a8eace9748
+  metadata.gz: 8ca942fefac703528e400de1a095cad1dd85d648895eabf7cfdf51ac430b34fe
+  data.tar.gz: 73f8e8c595e7669756b134d35576a1a3f873b67dfda1def674ea02d4a60173a7
 SHA512:
-  metadata.gz: 60b05d12fb2ea5c787193575a10fac4bead0f9177a75cf39e9dcbefe230d033412b58e2f164112eea1b2add9a95b55f8caf8f7d74831f79e0aa09f6c6889dcb8
-  data.tar.gz: c4b0d9cf8829b9c18a2d67e7986f187e1797fd7bc6448435534218b9bfa9be3e574adc6a1b3d278a016dc6194b8cbaf569a35f6025f2c0a036cd69ec4b54a420
+  metadata.gz: 95cbcedfb77ca5d9fd3a3ffe2f818d9a8866d6774cc25bf3964f0a0fa1c81a3014afb6f3a26cb32393fd84fe76e56e159a5be22f0780e5d916b1d66f90a08961
+  data.tar.gz: 4a9cf2040a0cdae39543379f3da011931d11bbc22c15aca1a0c88838a592215d80c6fd413b034f66c991487d7f6a5b32eecc9b9d29530c787aba09c3f48c4daa

data/lib/eac_cli/definition/alternative.rb

@@ -10,15 +10,12 @@ module EacCli
       SUBCOMMAND_NAME_ARG = :subcommand
       SUBCOMMAND_ARGS_ARG = :subcommand_args
 
-      def arg_opt(short, long, description, option_options = {})
-        options_set << ::EacCli::Definition::ArgumentOption.new(
-          short, long, description, option_options
-        )
+      def arg_opt(*args)
+        options_set << ::EacCli::Definition::ArgumentOption.from_args(args)
       end
 
-      def bool_opt(short, long, description, option_options = {})
-        options_set << ::EacCli::Definition::BooleanOption.new(short, long, description,
-                                                               option_options)
+      def bool_opt(*args)
+        options_set << ::EacCli::Definition::BooleanOption.from_args(args)
       end
 
       def options

data/lib/eac_cli/definition/argument_option.rb

@@ -8,6 +8,14 @@ module EacCli
       def argument?
         true
       end
+
+      def build_value(new_value, previous_value)
+        repeat? ? previous_value + [new_value] : new_value
+      end
+
+      def default_value
+        repeat? ? [] : nil
+      end
     end
   end
 end

data/lib/eac_cli/definition/base_option.rb

@@ -5,24 +5,36 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   class Definition
     class BaseOption
+      require_sub __FILE__
+
+      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
-      lists.add_symbol :option, :optional, :usage, :required
-      attr_reader :short, :long, :description, :options
-
-      def initialize(short, long, description, options = {})
-        @short = short
-        @long = long
-        @description = description
-        @options = options.symbolize_keys
-        @options.assert_valid_keys(::EacCli::Definition::BaseOption.lists.option.values)
+      enable_abstract_methods :build_value, :default_value
+      lists.add_symbol :option, :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 identifier
         long.to_s.variableize.to_sym
       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)

data/lib/eac_cli/definition/base_option/initialize_args_parser.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Definition
+    class BaseOption
+      class InitializeArgsParser
+        PROPERTIES = %i[short long description options].freeze
+        attr_reader(*PROPERTIES)
+
+        def initialize(args)
+          self.options = args.extract_options!.freeze
+          args.each { |arg| absorb_arg(arg) }
+        end
+
+        private
+
+        attr_writer(*PROPERTIES)
+
+        def absorb_arg(arg)
+          arg_ext = ArgumentParser.new(arg)
+          send("#{arg_ext.type}=", arg_ext.value)
+        end
+
+        class ArgumentParser
+          TYPES = %i[short long description].freeze
+          common_constructor :value
+
+          def type
+            TYPES.find { |type| send("#{type}?") } || raise("Unknown type for \"#{value}\"")
+          end
+
+          def short?
+            value.start_with?('-') && !long?
+          end
+
+          def long?
+            value.start_with?('--')
+          end
+
+          def description?
+            !short? || !long?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/definition/boolean_option.rb

@@ -8,6 +8,14 @@ module EacCli
       def argument?
         false
       end
+
+      def build_value(_new_value, previous_value)
+        repeat? ? previous_value + 1 : true
+      end
+
+      def default_value
+        repeat? ? 0 : false
+      end
     end
   end
 end

data/lib/eac_cli/definition/positional_argument.rb

@@ -13,6 +13,18 @@ module EacCli
         options.assert_valid_keys(self.class.lists.option.values)
       end
 
+      def build_value(new_value, previous_value)
+        if previous_value.is_a?(::Array)
+          previous_value + [new_value]
+        else
+          new_value
+        end
+      end
+
+      def default_value
+        repeat? ? [] : nil
+      end
+
       def identifier
         name.to_s.variableize.to_sym
       end

data/lib/eac_cli/docopt/doc_builder.rb

@@ -19,10 +19,24 @@ module EacCli
           b += '=<value>' if option.argument?
           b
         end
+
+        def option_short(option)
+          b = option.short
+          b += '=<value>' if option.argument?
+          b
+        end
+
+        def option_usage_full(option)
+          if option.long.present?
+            [option.short, option_long(option)].reject(&:blank?).join(SEP)
+          else
+            option_short(option)
+          end
+        end
       end
 
       def option_definition(option)
-        option.short + SEP + self.class.option_long(option) + OPTION_DESC_SEP + option.description
+        self.class.option_usage_full(option) + OPTION_DESC_SEP + option.description
       end
 
       def section(header, include_header = true)

data/lib/eac_cli/docopt/runner_context_replacement.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module Docopt
+    class RunnerContextReplacement
+      common_constructor :runner
+
+      def argv
+        runner.settings[:argv] || ARGV
+      end
+    end
+  end
+end

data/lib/eac_cli/docopt/runner_extension.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'eac_cli/docopt/doc_builder'
+require 'eac_cli/docopt/runner_context_replacement'
 require 'eac_cli/runner'
 require 'eac_ruby_utils/console/docopt_runner'
 
@@ -32,6 +33,10 @@ module EacCli
         def docopt_options
           super.merge(options_first: self.class.runner_definition.options_first?)
         end
+
+        def runner_context
+          @runner_context ||= ::EacCli::Docopt::RunnerContextReplacement.new(self)
+        end
       end
 
       def extra_available_subcommands

data/lib/eac_cli/parser/alternative.rb

@@ -35,11 +35,11 @@ module EacCli
       attr_accessor :phase
 
       def any_collect_argv_value
-        if argv_current_option?
-          option_collect_argv_value
-        else
-          positional_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}?")
         end
+
+        positional_collect_argv_value
       end
 
       def collector

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module LongOptions
+        LONG_OPTION_PREFIX = '--'
+        OPTION_WITH_ARGUMENT_PATTERN = /\A([^=]+)(?:=(.*))\z/.freeze
+
+        private
+
+        def argv_current_long_option?
+          phase == PHASE_ANY && argv_enum.peek.start_with?(LONG_OPTION_PREFIX) &&
+            !argv_current_double_dash?
+        end
+
+        def long_option_collect_argv_value
+          option_long, value = parse_option_current_argv
+          alternative.options.any? do |option|
+            next false unless option.long == option_long
+
+            if value.nil?
+              option_collect_option(option)
+            else
+              option_argument_collect(option, value)
+            end
+          end || raise_argv_current_invalid_option
+        end
+
+        def parse_option_current_argv
+          m = OPTION_WITH_ARGUMENT_PATTERN.match(argv_enum.peek)
+          m ? [m[1], m[2].if_present('')] : [argv_enum.peek, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module OptionArgument
+        private
+
+        attr_accessor :argument_option
+
+        def argument_option_collect_argv(option)
+          self.argument_option = option
+          self.phase = PHASE_OPTION_ARGUMENT
+        end
+
+        def option_argument_collect(option, value)
+          collector.collect(option, value)
+          self.argument_option = nil
+          self.phase = PHASE_ANY
+          option
+        end
+
+        def option_argument_collect_argv_value
+          option_argument_collect(argument_option, argv_enum.peek)
+        end
+      end
+    end
+  end
+end

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

@@ -4,49 +4,20 @@ module EacCli
   class Parser
     class Alternative
       module Options
-        DOUBLE_DASH = '--'
-
         private
 
-        attr_accessor :argument_option, :double_dash
-
-        def argument_option_collect_argv(option)
-          self.argument_option = option
-          self.phase = PHASE_OPTION_ARGUMENT
-        end
-
-        def argv_current_option?
-          phase == PHASE_ANY && argv_enum.peek.start_with?('-')
-        end
-
-        def argv_current_double_dash?
-          argv_enum.peek == DOUBLE_DASH && !double_dash
-        end
-
         def boolean_option_collect_argv(option)
           collector.collect(option, true)
         end
 
-        def option_argument_collect_argv_value
-          collector.collect(argument_option, argv_enum.peek)
-          self.argument_option = nil
-          self.phase = PHASE_ANY
-        end
-
-        def option_collect_argv_value
-          return double_dash_collect_argv_value if argv_current_double_dash?
-
-          alternative.options.any? do |option|
-            next false unless [option.short, option.long].include?(argv_enum.peek)
-
-            if option.argument?
-              argument_option_collect_argv(option)
-            else
-              boolean_option_collect_argv(option)
-            end
+        def option_collect_option(option)
+          if option.argument?
+            argument_option_collect_argv(option)
+          else
+            boolean_option_collect_argv(option)
+          end
 
-            true
-          end || raise_argv_current_invalid_option
+          option
         end
 
         def raise_argv_current_invalid_option

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module EacCli
+  class Parser
+    class Alternative
+      module ShortOptions
+        SHORT_OPTION_PREFIX = '-'
+
+        private
+
+        def argv_current_short_option?
+          phase == PHASE_ANY && argv_enum.peek.start_with?(SHORT_OPTION_PREFIX) &&
+            !argv_current_long_option?
+        end
+
+        def find_short_option(char)
+          alternative.options.find { |option| short_without_prefix(option.short) == char }
+        end
+
+        def short_option_collect_argv_value
+          last_option = nil
+          short_without_prefix(argv_enum.peek).each_char do |char|
+            raise_error "Option \"#{last_option}\" requires a argument not provided" if
+            last_option.present?
+
+            collected_option = short_option_collect_char(char)
+            last_option = collected_option if collected_option.argument?
+          end
+        end
+
+        # @return [EacCli::Definition::BaseOption] The option collected.
+        def short_option_collect_char(char)
+          option = find_short_option(char)
+          raise_error "Invalid short option \"#{char}\"" unless option
+
+          option_collect_option(option)
+        end
+
+        def short_without_prefix(short)
+          short.gsub(/\A#{::Regexp.quote(SHORT_OPTION_PREFIX)}/, '')
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/parser/collector.rb

@@ -24,11 +24,7 @@ module EacCli
       end
 
       def collect(option, value)
-        if data[option].is_a?(::Array)
-          data[option] << value
-        else
-          data[option] = value
-        end
+        data[option] = option.build_value(value, data[option])
       end
 
       def supplied?(option)
@@ -42,18 +38,8 @@ module EacCli
       end
 
       def default_values
-        definition.options.each { |option| data[option] = option_default_value(option) }
-        definition.positional.each do |positional|
-          data[positional] = positional_default_value(positional)
-        end
-      end
-
-      def option_default_value(option)
-        option.argument? ? nil : false
-      end
-
-      def positional_default_value(positional)
-        positional.repeat? ? [] : nil
+        definition.options.each { |option| data[option] = option.default_value }
+        definition.positional.each { |positional| data[positional] = positional.default_value }
       end
     end
   end

data/lib/eac_cli/runner.rb

@@ -47,53 +47,5 @@ module EacCli
       include ActiveSupport::Callbacks
       define_callbacks :run
     end
-
-    module AfterClassMethods
-      def create(*runner_context_args)
-        r = new
-        r.runner_context = ::EacCli::Runner::Context.new(r, *runner_context_args)
-        r
-      end
-
-      def run(*runner_context_args)
-        r = create(*runner_context_args)
-        r.run_run
-        r
-      end
-
-      def runner_definition(&block)
-        @runner_definition ||= super_runner_definition
-        @runner_definition.instance_eval(&block) if block
-        @runner_definition
-      end
-
-      def super_runner_definition
-        superclass.try(:runner_definition).if_present(&:dup) || ::EacCli::Definition.new
-      end
-    end
-
-    module InstanceMethods
-      def run_run
-        parsed
-        run_callbacks(:run) { run }
-      rescue ::EacCli::Runner::Exit # rubocop:disable Lint/SuppressedException
-        # Do nothing
-      end
-
-      def runner_context
-        return @runner_context if @runner_context
-
-        raise 'Context was required, but was not set yet'
-      end
-
-      def runner_context=(new_runner_context)
-        @runner_context = new_runner_context
-        @parsed = nil
-      end
-
-      def parsed
-        @parsed ||= ::EacCli::Parser.new(self.class.runner_definition, runner_context.argv).parsed
-      end
-    end
   end
 end

data/lib/eac_cli/runner/after_class_methods.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EacCli
+  module Runner
+    module AfterClassMethods
+      def create(*runner_context_args)
+        r = new
+        r.runner_context = ::EacCli::Runner::Context.new(r, *runner_context_args)
+        r
+      end
+
+      def run(*runner_context_args)
+        r = create(*runner_context_args)
+        r.run_run
+        r
+      end
+
+      def runner_definition(&block)
+        @runner_definition ||= super_runner_definition
+        @runner_definition.instance_eval(&block) if block
+        @runner_definition
+      end
+
+      def super_runner_definition
+        superclass.try(:runner_definition).if_present(&:dup) || ::EacCli::Definition.new
+      end
+    end
+  end
+end

data/lib/eac_cli/runner/instance_methods.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module EacCli
+  module Runner
+    module InstanceMethods
+      def run_run
+        parsed
+        run_callbacks(:run) { run }
+      rescue ::EacCli::Parser::Error => e
+        $stderr.write("#{e}\n")
+      rescue ::EacCli::Runner::Exit # rubocop:disable Lint/SuppressedException
+        # Do nothing
+      end
+
+      def runner_context
+        return @runner_context if @runner_context
+
+        raise 'Context was required, but was not set yet'
+      end
+
+      def runner_context=(new_runner_context)
+        @runner_context = new_runner_context
+        @parsed = nil
+      end
+
+      def parsed
+        @parsed ||= ::EacCli::Parser.new(self.class.runner_definition, runner_context.argv).parsed
+      end
+    end
+  end
+end

data/lib/eac_cli/runner_with/help.rb

@@ -27,7 +27,9 @@ module EacCli
       end
 
       def help_text
-        ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
+        r = ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
+        r += help_extra_text if respond_to?(:help_extra_text)
+        r
       end
     end
   end

data/lib/eac_cli/runner_with/subcommands.rb

@@ -6,6 +6,14 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   module RunnerWith
     module Subcommands
+      class << self
+        def runner?(object)
+          ::EacCli::Runner.runner?(object) || (
+            object.is_a?(::Class) && object < ::EacRubyUtils::Console::DocoptRunner
+          )
+        end
+      end
+
       common_concern do
         include ::EacCli::Runner
       end
@@ -19,7 +27,7 @@ module EacCli
       def available_subcommands_auto
         self.class.constants
             .map { |name| [name.to_s.underscore.gsub('_', '-'), self.class.const_get(name)] }
-            .select { |c| ::EacCli::Runner.runner?(c[1]) }
+            .select { |c| ::EacCli::RunnerWith::Subcommands.runner?(c[1]) }
             .to_h.with_indifferent_access
       end
 
@@ -31,6 +39,11 @@ module EacCli
         end
       end
 
+      def help_extra_text
+        (['Subcommands:'] + available_subcommands.keys.sort.map { |s| "  #{s}" })
+          .map { |v| "#{v}\n" }.join
+      end
+
       def method_missing(method_name, *arguments, &block)
         return run_with_subcommand(*arguments, &block) if
         run_with_subcommand_alias_run?(method_name)
@@ -44,7 +57,11 @@ module EacCli
 
       def run_with_subcommand
         if subcommand_name
-          subcommand_runner.run_run
+          if subcommand_runner.respond_to?(:run_run)
+            subcommand_runner.run_run
+          else
+            subcommand_runner.run
+          end
         else
           run_without_subcommand
         end

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
@@ -58,26 +58,33 @@ files:
 - 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/help_formatter.rb
 - lib/eac_cli/definition/positional_argument.rb
 - lib/eac_cli/docopt/doc_builder.rb
 - lib/eac_cli/docopt/doc_builder/alternative.rb
+- lib/eac_cli/docopt/runner_context_replacement.rb
 - lib/eac_cli/docopt/runner_extension.rb
 - lib/eac_cli/parser.rb
 - lib/eac_cli/parser/alternative.rb
 - lib/eac_cli/parser/alternative/argv.rb
 - lib/eac_cli/parser/alternative/double_dash.rb
+- lib/eac_cli/parser/alternative/long_options.rb
+- lib/eac_cli/parser/alternative/option_argument.rb
 - lib/eac_cli/parser/alternative/options.rb
 - lib/eac_cli/parser/alternative/positionals.rb
+- lib/eac_cli/parser/alternative/short_options.rb
 - lib/eac_cli/parser/collector.rb
 - lib/eac_cli/parser/error.rb
 - lib/eac_cli/patches.rb
 - lib/eac_cli/patches/object.rb
 - lib/eac_cli/patches/object/runner_with.rb
 - lib/eac_cli/runner.rb
+- lib/eac_cli/runner/after_class_methods.rb
 - lib/eac_cli/runner/context.rb
 - lib/eac_cli/runner/exit.rb
+- lib/eac_cli/runner/instance_methods.rb
 - lib/eac_cli/runner_with.rb
 - lib/eac_cli/runner_with/help.rb
 - lib/eac_cli/runner_with/output_file.rb