eac_cli 0.12.1 → 0.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c53ada4b4424ae6524aa6da440544f272018b710e14ebba991c996b4d65e2cc
-  data.tar.gz: f18ae2d075696710f1b8322aeab9eca055cf0ff38ba57a3aeab86af32f7bf370
+  metadata.gz: e9465f0f0d648395bb6616a208f830034405eaed91e6d186f8235cd2b0ea28a6
+  data.tar.gz: efd2ab2ad3737f7f12577908cc3c0bda2fbead8ddaa99ae671c72162a3f63bb3
 SHA512:
-  metadata.gz: 617c16d42f00d801b0ddcea18719a9d4c898158641a597d66510f068119b76264520b7393d897d105bf21ddcff0691bb0030090daec589af547935c205685a69
-  data.tar.gz: 64e942e6118081a385f4df9374edcf5770005f463837ffaa9d00024ab21568ab63bfdcd5740183dfd9dcffbec636fbd814ac839618540a10d8d15559154c0e18
+  metadata.gz: 88e58527420ebd47d4de3684bdd6d2c18eb6b5b1be87c33043b0d3951d924265d44b9108feed7f3c0cd236ef11546ecf188c2a1c0de0ab73e0b4740c2df63287
+  data.tar.gz: 45fb719847efcade7e5c56b015ebd8aefce718d109f11aebb97f7645a681ec5ed53358a3a7beebc63019b77e3847b2be69421e1b9b8bcaacbf7682ecaafdec20

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.rb

@@ -12,12 +12,14 @@ module EacCli
 
     def parsed_uncached
       raise 'Definition has no alternatives' if alternatives.empty?
+      raise first_error unless alternatives.select(&:success?).any?
 
-      alternatives.each do |alt_parser|
-        return alt_parser.parsed unless alt_parser.error?
-      end
+      alternatives_parsed(true).merge(alternatives_parsed(false))
+    end
 
-      raise first_error
+    def alternatives_parsed(error)
+      alternatives.select { |a| error == a.error? }.map(&:parsed).reverse
+                  .inject(::EacRubyUtils::Struct.new) { |a, e| a.merge(e) }
     end
 
     def alternatives_uncached

data/lib/eac_cli/parser/alternative.rb

@@ -22,6 +22,10 @@ module EacCli
         error.present?
       end
 
+      def success?
+        !error?
+      end
+
       def parsed
         @parsed ||= collector.to_data.freeze
       end
@@ -31,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/runner.rb

@@ -44,48 +44,8 @@ module EacCli
       extend AfterClassMethods
       include InstanceMethods
       ::EacCli::Docopt::RunnerExtension.check(self)
-    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.parsed
-        r.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 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
+      include ActiveSupport::Callbacks
+      define_callbacks :run
     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/exit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EacCli
+  module Runner
+    class Exit < ::StandardError
+      attr_reader :status
+
+      def initialize(status = true)
+        @status = status
+      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

@@ -13,6 +13,23 @@ module EacCli
           options_argument false
           bool_opt '-h', '--help', 'Show help.', usage: true
         end
+
+        set_callback :run, :before do
+          help_run
+        end
+      end
+
+      def help_run
+        return unless parsed.help?
+
+        puts help_text
+        raise ::EacCli::Runner::Exit
+      end
+
+      def help_text
+        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/output_file.rb

@@ -2,12 +2,16 @@
 
 require 'eac_cli/runner'
 require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/abstract_methods'
 
 module EacCli
   module RunnerWith
     module OutputFile
       common_concern do
         include ::EacCli::Runner
+        include ::EacRubyUtils::AbstractMethods
+
+        abstract_methods :output_content
 
         runner_definition do
           arg_opt '-o', '--output-file', 'Output to file.'
@@ -18,7 +22,7 @@ module EacCli
         if parsed.output_file.present?
           ::File.write(parsed.output_file, output_content)
         else
-          out output_content
+          $stdout.write(output_content)
         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
+          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.1'
+  VERSION = '0.12.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.6
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.55'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.55'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -63,20 +63,27 @@ files:
 - 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