eac_cli 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607e900ac4f5c7b6e7531c4ce9f9f6cfc8fd8ffce30f7b4d2a22ff91cdfd99bb
-  data.tar.gz: 0f49af96a89a527390ba34d2e6ecc17d2942aea7200bebbab1ba1f540398f413
+  metadata.gz: 6bfbec2f4b3875640397fa352c5edde397fc335614d7e95a9200472ae8688819
+  data.tar.gz: fcf67763d91ea9674b8355b7e5dd587d6d6b3a9e05ae387eea045d364658481c
 SHA512:
-  metadata.gz: 1e2a23e42fb5df31819b499f8dc1448f6ecc9d095fc22c9a0ceabe1acadf9ba6398a62d04a09943b233feeeb5e07325f62069ee883fb388b29424e7656ebe500
-  data.tar.gz: 1fefcf204e43d2ccfcf45c8507be13be885d46da72f0d6eda2ea3c3e6b7b845592e3ed989fc29b8c687a3727b795f8ea3a2d2a6526c3cda61bbf6b6f7da8df86
+  metadata.gz: ff15edf91a76df0af27aff006f85071f8ff1b4ae5c70930ad5daf8ae129d372e976742d47a817f142b8fa747d8d5e285806619002eab8602d760e40e83ff89d6
+  data.tar.gz: 6ff1ae990f460832abf8cfc50136a28cf09d317c85835e384562640b0b48cff4f63fcb794efcad45784bd168b2872f46403dc658cd4bafeab8cceed37bddf2a8

data/lib/eac_cli/definition.rb

@@ -45,6 +45,10 @@ module EacCli
       self.description = description
     end
 
+    def help_formatter
+      @help_formatter ||= ::EacCli::Definition::HelpFormatter.new(self)
+    end
+
     def options_arg(options_argument)
       self.options_argument = options_argument
     end
@@ -54,17 +58,23 @@ module EacCli
     end
 
     def pos_arg(name, arg_options = {})
-      raise 'Positional arguments are blocked' if positional_arguments_blocked?
+      new_pos_arg = ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+      raise 'Positional arguments are blocked' if positional_arguments_blocked?(new_pos_arg)
 
-      pos_set << ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+      pos_set << new_pos_arg
     end
 
     def positional
       pos_set.to_a
     end
 
-    def positional_arguments_blocked?
-      pos_set.any? { |e| e.optional? || e.repeat? }
+    def positional_arguments_blocked?(new_pos_arg)
+      last = pos_set.last
+      return false unless last
+      return true if last.repeat?
+      return true if last.optional? && new_pos_arg.required?
+
+      false
     end
 
     def subcommands

data/lib/eac_cli/definition/help_formatter.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    class HelpFormatter
+      SEP = ' '
+      IDENT = SEP * 2
+      OPTION_DESC_SEP = IDENT * 2
+
+      class << self
+        def option_long(option)
+          b = option.long
+          b += '=VALUE' if option.argument?
+          b
+        end
+
+        def option_short(option)
+          b = option.short
+          b += 'VALUE' if option.argument?
+          b
+        end
+      end
+
+      common_constructor :definition
+
+      def option_argument(option)
+        b = option.long
+        b += '=VALUE' if option.argument?
+        b
+      end
+
+      def positional_argument(positional)
+        if positional.subcommand?
+          ::EacRubyUtils::Console::DocoptRunner::SUBCOMMANDS_MACRO
+        else
+          r = "<#{positional.name}>"
+          r += '...' if positional.repeat?
+          r = "[#{r}]" if positional.optional?
+          r
+        end
+      end
+
+      def section(header, include_header = true)
+        b = include_header ? "#{header.humanize}:\n" : ''
+        b += send("self_#{header}") + "\n"
+        # TO-DO: implement alternatives
+        b
+      end
+
+      def self_options
+        definition.options.map { |option| IDENT + option_definition(option) }.join("\n")
+      end
+
+      def self_usage
+        IDENT + self_usage_arguments.join(SEP)
+      end
+
+      def self_usage_arguments
+        [::EacRubyUtils::Console::DocoptRunner::PROGRAM_MACRO] +
+          definition.options_argument.if_present([]) { |_v| ['[options]'] } +
+          self_usage_arguments_options +
+          self_usage_arguments_positional
+      end
+
+      def self_usage_arguments_options
+        definition.options.select(&:show_on_usage?).map do |option|
+          self.class.option_argument(option)
+        end
+      end
+
+      def self_usage_arguments_positional
+        definition.positional.map { |p| positional_argument(p) }
+      end
+
+      def to_banner
+        "#{definition.description}\n\n#{section('usage')}"
+      end
+    end
+  end
+end

data/lib/eac_cli/definition/positional_argument.rb

@@ -5,8 +5,10 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   class Definition
     class PositionalArgument
+      DEFAULT_REQUIRED = true
+
       enable_listable
-      lists.add_symbol :option, :optional, :repeat, :subcommand
+      lists.add_symbol :option, :optional, :repeat, :required, :subcommand
       common_constructor :name, :options, default: [{}] do
         options.assert_valid_keys(self.class.lists.option.values)
       end
@@ -16,13 +18,20 @@ module EacCli
       end
 
       def optional?
-        options[OPTION_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
+
       def subcommand?
         options[OPTION_SUBCOMMAND]
       end

data/lib/eac_cli/parser/options_collection.rb

@@ -6,10 +6,6 @@ require 'optparse'
 module EacCli
   class Parser
     class OptionsCollection
-      SEP = ' '
-      IDENT = SEP * 2
-      OPTION_DESC_SEP = IDENT * 2
-
       enable_simple_cache
       common_constructor(:definition, :argv, :collector) { collect }
       attr_reader :arguments
@@ -49,7 +45,7 @@ module EacCli
       end
 
       def build_banner
-        option_parser.banner = "#{definition.description}\n\n#{section('usage')}"
+        option_parser.banner = definition.help_formatter.to_banner
       end
 
       def build_options
@@ -60,68 +56,13 @@ module EacCli
 
       def build_option(option)
         option_parser.on(
-          *[option_short(option), option_long(option), option.description].reject(&:blank?)
+          *[::EacCli::Definition::HelpFormatter.option_short(option),
+            ::EacCli::Definition::HelpFormatter.option_long(option),
+            option.description].reject(&:blank?)
         ) do |value|
           collector.collect(option, value)
         end
       end
-
-      def positional_argument(positional)
-        if positional.subcommand?
-          ::EacRubyUtils::Console::DocoptRunner::SUBCOMMANDS_MACRO
-        else
-          r = "<#{positional.name}>"
-          r += '...' if positional.repeat?
-          r = "[#{r}]" if positional.optional?
-          r
-        end
-      end
-
-      def option_argument(option)
-        option_long(option)
-      end
-
-      def option_long(option)
-        b = option.long
-        b += '=VALUE' if option.argument?
-        b
-      end
-
-      def option_short(option)
-        b = option.short
-        b += 'VALUE' if option.argument?
-        b
-      end
-
-      def section(header, include_header = true)
-        b = include_header ? "#{header.humanize}:\n" : ''
-        b += send("self_#{header}") + "\n"
-        # TO-DO: implement alternatives
-        b
-      end
-
-      def self_options
-        definition.options.map { |option| IDENT + option_definition(option) }.join("\n")
-      end
-
-      def self_usage
-        IDENT + self_usage_arguments.join(SEP)
-      end
-
-      def self_usage_arguments
-        [::EacRubyUtils::Console::DocoptRunner::PROGRAM_MACRO] +
-          definition.options_argument.if_present([]) { |_v| ['[options]'] } +
-          self_usage_arguments_options +
-          self_usage_arguments_positional
-      end
-
-      def self_usage_arguments_options
-        definition.options.select(&:show_on_usage?).map { |option| option_argument(option) }
-      end
-
-      def self_usage_arguments_positional
-        definition.positional.map { |p| positional_argument(p) }
-      end
     end
   end
 end

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
@@ -58,6 +58,7 @@ files:
 - lib/eac_cli/definition/argument_option.rb
 - lib/eac_cli/definition/base_option.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/runner_extension.rb