eac_cli 0.20.4 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac084c510379ffad8feceff82e7bb5f8526663a8eec785432283a2c8a567797a
-  data.tar.gz: 5efaada363d342f60d2aa55cc3823f39f84e64d9c422c4dabc4feb6be379decf
+  metadata.gz: d77b174dd680d497c168311008da5096a1de24d0feb6ce1edaf37728141e4224
+  data.tar.gz: 530c92c167b11544b064bf2cf6084f1871bd9a2371df0328bf0d932d489df568
 SHA512:
-  metadata.gz: 8e23f76ed8257b2285858741963451934c3de72f7d4de00d302e2c4cb6b8780d162455aad9a40831eb98402eec28673de8b55e69594a026214543a9b093b8ec5
-  data.tar.gz: f7c3e55370d73d0d9910ecdbb2c231245895862e33b84831496afe626e87e66d2f70c8863b153ad5f03e3bc1dae14663571947d91dfd3f3dba48035fc5ef1625
+  metadata.gz: d08a25c365ec9902ef08092e94b5550c2252f2c2463c1b4dabbc80557e3485da9424b2900554f33d1dca83fa898b10e7287b7df7e61f3d73d4bd7c9e86971c91
+  data.tar.gz: 752d67c71f2eab73ed4f7d420dc7f8319d35f46a1f1296b05a62bf674490540cf48100a87664f04d3f679873a77e8d008bd287dfc88cec7e85f26685340d5d08

data/lib/eac_cli/definition/help_formatter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'eac_cli/runner_with/help/builder/alternative'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
@@ -27,7 +28,7 @@ module EacCli
 
       def positional_argument(positional)
         if positional.subcommand?
-          ::EacCli::DocoptRunner::SUBCOMMANDS_MACRO
+          ::EacCli::RunnerWith::Help::Builder::Alternative::SUBCOMMANDS_MACRO
         else
           r = "<#{positional.name}>"
           r += '...' if positional.repeat?
@@ -52,7 +53,7 @@ module EacCli
       end
 
       def self_usage_arguments
-        [::EacCli::DocoptRunner::PROGRAM_MACRO] +
+        [::EacCli::RunnerWith::Help::Builder::Alternative::PROGRAM_MACRO] +
           definition.options_argument.if_present([]) { |_v| ['[options]'] } +
           self_usage_arguments_options +
           self_usage_arguments_positional

data/lib/eac_cli/runner.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'eac_cli/definition'
-require 'eac_cli/docopt/runner_extension'
 require 'eac_cli/parser'
 require 'eac_ruby_utils/core_ext'
 
@@ -43,7 +42,6 @@ module EacCli
 
       extend AfterClassMethods
       include InstanceMethods
-      ::EacCli::Docopt::RunnerExtension.check(self)
       include ActiveSupport::Callbacks
       define_callbacks :run
     end

data/lib/eac_cli/runner_with/help.rb

@@ -6,6 +6,7 @@ require 'eac_ruby_utils/core_ext'
 module EacCli
   module RunnerWith
     module Help
+      require_sub __FILE__
       common_concern do
         include ::EacCli::Runner
 
@@ -27,7 +28,7 @@ module EacCli
       end
 
       def help_text
-        r = ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
+        r = ::EacCli::RunnerWith::Help::Builder.new(self.class.runner_definition).to_s
         r += help_extra_text if respond_to?(:help_extra_text)
         r
       end

data/lib/eac_cli/runner_with/help/builder.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      class Builder
+        require_sub __FILE__
+        common_constructor :definition
+
+        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
+
+          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)
+          self.class.option_usage_full(option) + option.description.if_present('') do |v|
+            OPTION_DESC_SEP + v
+          end
+        end
+
+        def section(header, include_header = true)
+          b = include_header ? "#{header.humanize}:\n" : ''
+          b += send("self_#{header}") + "\n"
+          definition.alternatives.each do |alternative|
+            b += IDENT + ::EacCli::RunnerWith::Help::Builder::Alternative.new(alternative).to_s +
+                 "\n"
+          end
+          b
+        end
+
+        def options_section
+          "Options:\n" +
+            definition.alternatives.flat_map(&:options)
+                      .map { |option| IDENT + option_definition(option) + "\n" }.join
+        end
+
+        def usage_section
+          "Usage:\n" +
+            definition.alternatives.map do |alternative|
+              IDENT + ::EacCli::RunnerWith::Help::Builder::Alternative.new(alternative).to_s + "\n"
+            end.join
+        end
+
+        def to_s
+          "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/runner_with/help/builder/alternative.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module RunnerWith
+    module Help
+      class Builder
+        class Alternative
+          PROGRAM_MACRO = '__PROGRAM__'
+          SUBCOMMANDS_MACRO = '__SUBCOMMANDS__'
+
+          common_constructor :alternative
+
+          def to_s
+            (
+              [PROGRAM_MACRO] +
+                alternative.options_argument?.if_present([]) { |_v| ['[options]'] } +
+                options +
+                positionals
+            ).join(::EacCli::RunnerWith::Help::Builder::SEP)
+          end
+
+          def options
+            alternative.options.select(&:show_on_usage?).map do |option|
+              ::EacCli::RunnerWith::Help::Builder.option_long(option)
+            end
+          end
+
+          def option_argument(option)
+            b = option.long
+            b += '=<value>' if option.argument?
+            b
+          end
+
+          def positionals
+            alternative.positional.map { |p| positional(p) }.reject(&:blank?)
+          end
+
+          def positional(positional)
+            return unless positional.visible?
+
+            if positional.subcommand?
+              SUBCOMMANDS_MACRO
+            else
+              r = "<#{positional.name}>"
+              r += '...' if positional.repeat?
+              r = "[#{r}]" if positional.optional?
+              r
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/runner_with/subcommands.rb

@@ -10,9 +10,7 @@ module EacCli
 
       class << self
         def runner?(object)
-          ::EacCli::Runner.runner?(object) || (
-            object.is_a?(::Class) && object < ::EacCli::DocoptRunner
-          )
+          ::EacCli::Runner.runner?(object)
         end
       end
 

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.20.4
+  version: 0.21.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-- !ruby/object:Gem::Dependency
-  name: docopt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: eac_config
   requirement: !ruby/object:Gem::Requirement
@@ -102,16 +88,6 @@ files:
 - 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/docopt_runner.rb
-- lib/eac_cli/docopt_runner/_doc.rb
-- lib/eac_cli/docopt_runner/_settings.rb
-- lib/eac_cli/docopt_runner/_subcommands.rb
-- lib/eac_cli/docopt_runner/class_methods.rb
-- lib/eac_cli/docopt_runner/context.rb
 - lib/eac_cli/old_configs.rb
 - lib/eac_cli/old_configs/entry_reader.rb
 - lib/eac_cli/old_configs/password_entry_reader.rb
@@ -139,6 +115,8 @@ files:
 - 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/help/builder.rb
+- lib/eac_cli/runner_with/help/builder/alternative.rb
 - lib/eac_cli/runner_with/subcommands.rb
 - lib/eac_cli/runner_with/subcommands/definition_concern.rb
 - lib/eac_cli/runner_with_set.rb

data/lib/eac_cli/docopt/doc_builder.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'eac_cli/docopt_runner'
-
-module EacCli
-  module Docopt
-    class DocBuilder
-      require_sub __FILE__
-      common_constructor :definition
-
-      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
-
-        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)
-        self.class.option_usage_full(option) + option.description.if_present('') do |v|
-          OPTION_DESC_SEP + v
-        end
-      end
-
-      def section(header, include_header = true)
-        b = include_header ? "#{header.humanize}:\n" : ''
-        b += send("self_#{header}") + "\n"
-        definition.alternatives.each do |alternative|
-          b += IDENT + ::EacCli::Docopt::DocBuilder::Alternative.new(alternative).to_s + "\n"
-        end
-        b
-      end
-
-      def options_section
-        "Options:\n" +
-          definition.alternatives.flat_map(&:options)
-                    .map { |option| IDENT + option_definition(option) + "\n" }.join
-      end
-
-      def usage_section
-        "Usage:\n" +
-          definition.alternatives.map do |alternative|
-            IDENT + ::EacCli::Docopt::DocBuilder::Alternative.new(alternative).to_s + "\n"
-          end.join
-      end
-
-      def to_s
-        "#{definition.description}\n\n#{usage_section}\n#{options_section}\n"
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt/doc_builder/alternative.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'eac_cli/docopt_runner'
-
-module EacCli
-  module Docopt
-    class DocBuilder
-      class Alternative
-        common_constructor :alternative
-
-        def to_s
-          (
-            [::EacCli::DocoptRunner::PROGRAM_MACRO] +
-              alternative.options_argument?.if_present([]) { |_v| ['[options]'] } +
-              options +
-              positionals
-          ).join(::EacCli::Docopt::DocBuilder::SEP)
-        end
-
-        def options
-          alternative.options.select(&:show_on_usage?).map do |option|
-            ::EacCli::Docopt::DocBuilder.option_long(option)
-          end
-        end
-
-        def option_argument(option)
-          b = option.long
-          b += '=<value>' if option.argument?
-          b
-        end
-
-        def positionals
-          alternative.positional.map { |p| positional(p) }.reject(&:blank?)
-        end
-
-        def positional(positional)
-          return unless positional.visible?
-
-          if positional.subcommand?
-            ::EacCli::DocoptRunner::SUBCOMMANDS_MACRO
-          else
-            r = "<#{positional.name}>"
-            r += '...' if positional.repeat?
-            r = "[#{r}]" if positional.optional?
-            r
-          end
-        end
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt/runner_context_replacement.rb

@@ -1,19 +0,0 @@
-# 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
-
-      def program_name
-        runner.settings[:program_name] || $PROGRAM_NAME
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt/runner_extension.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/docopt/doc_builder'
-require 'eac_cli/docopt/runner_context_replacement'
-require 'eac_cli/runner'
-require 'eac_cli/docopt_runner'
-
-module EacCli
-  module Docopt
-    module RunnerExtension
-      extend ::ActiveSupport::Concern
-
-      included do
-        prepend InstanceMethods
-      end
-
-      class << self
-        def check(klass)
-          return unless klass < ::EacCli::DocoptRunner
-
-          ::EacCli::Runner.alias_runner_class_methods(klass, '', 'eac_cli')
-          ::EacCli::Runner.alias_runner_class_methods(klass, 'original', '')
-
-          klass.include(self)
-        end
-      end
-
-      module InstanceMethods
-        def doc
-          ::EacCli::Docopt::DocBuilder.new(self.class.runner_definition).to_s
-        end
-
-        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
-        self.class.constants
-            .map { |name| self.class.const_get(name) }
-            .select { |c| c.instance_of? Class }
-            .select { |c| c.included_modules.include?(::EacCli::Runner) }
-            .map { |c| c.name.demodulize.underscore.dasherize }
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt_runner.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'docopt'
-
-module EacCli
-  class DocoptRunner
-    require_sub __FILE__
-    extend ::EacCli::DocoptRunner::ClassMethods
-    include ::EacCli::DocoptRunner::Context
-
-    class << self
-      def create(settings = {})
-        new(settings)
-      end
-    end
-
-    attr_reader :settings
-
-    def initialize(settings = {})
-      @settings = settings.with_indifferent_access.freeze
-      check_subcommands
-    end
-
-    def options
-      @options ||= ::Docopt.docopt(target_doc, docopt_options)
-    end
-
-    def parent
-      settings[:parent]
-    end
-
-    protected
-
-    def docopt_options
-      settings.slice(:version, :argv, :help, :options_first).to_sym_keys_hash
-    end
-  end
-end

data/lib/eac_cli/docopt_runner/_doc.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module EacCli
-  class DocoptRunner
-    PROGRAM_MACRO = '__PROGRAM__'
-
-    def source_doc
-      setting_value(:doc)
-    end
-
-    def target_doc
-      source_doc.gsub(PROGRAM_MACRO, target_program_name).strip + "\n"
-    end
-
-    def source_program_name
-      setting_value(:program_name, false)
-    end
-
-    def target_program_name
-      [source_program_name, ENV['PROGRAM_NAME'], $PROGRAM_NAME].find(&:present?)
-    end
-  end
-end

data/lib/eac_cli/docopt_runner/_settings.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/settings_provider'
-
-module EacCli
-  class DocoptRunner
-    include ::EacRubyUtils::SettingsProvider
-
-    attr_reader :settings
-
-    private
-
-    def setting_value(key, required = true)
-      super(key, required: required, order: %w[method settings_object constant])
-    end
-  end
-end

data/lib/eac_cli/docopt_runner/_subcommands.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string/inflections'
-require 'shellwords'
-
-module EacCli
-  class DocoptRunner
-    SUBCOMMAND_ARG = '<subcommand>'
-    SUBCOMMAND_ARGS_ARG = '<subcommand-args>'
-    SUBCOMMANDS_MACRO = '__SUBCOMMANDS__'
-
-    def subcommands?
-      source_doc.include?(SUBCOMMANDS_MACRO)
-    end
-
-    def check_subcommands
-      return unless subcommands?
-
-      singleton_class.include(SubcommandsSupport)
-      check_subcommands_arg
-      return if singleton_class.method_defined?(:run)
-
-      singleton_class.send(:alias_method, :run, :run_with_subcommand)
-    end
-
-    module SubcommandsSupport
-      EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME = :extra_available_subcommands
-
-      def check_subcommands_arg
-        if subcommand_arg_as_list?
-          singleton_class.include(SubcommandsSupport::SubcommandArgAsList)
-        else
-          singleton_class.include(SubcommandsSupport::SubcommandArgAsArg)
-        end
-      end
-
-      def run_with_subcommand
-        if subcommand_name
-          check_valid_subcommand
-          subcommand_run
-        else
-          run_without_subcommand
-        end
-      end
-
-      def subcommand
-        @subcommand ||= subcommand_class_name(subcommand_name).constantize.create(
-          argv: subcommand_args,
-          program_name: subcommand_program,
-          parent: self
-        )
-      end
-
-      def subcommand_run
-        if !subcommand.is_a?(::EacCli::DocoptRunner) &&
-           subcommand.respond_to?(:run_run)
-          subcommand.run_run
-        else
-          subcommand.run
-        end
-      end
-
-      def target_doc
-        super.gsub(SUBCOMMANDS_MACRO,
-                   "#{target_doc_subcommand_arg} [#{SUBCOMMAND_ARGS_ARG}...]") +
-          "\n" + subcommands_target_doc
-      end
-
-      def docopt_options
-        super.merge(options_first: true)
-      end
-
-      def subcommand_class_name(subcommand)
-        "#{self.class.name}::#{subcommand.underscore.camelize}"
-      end
-
-      def subcommand_arg_as_list?
-        setting_value(:subcommand_arg_as_list, false) || false
-      end
-
-      def subcommand_args
-        options.fetch(SUBCOMMAND_ARGS_ARG)
-      end
-
-      def subcommand_program
-        subcommand_name
-      end
-
-      def available_subcommands
-        r = ::Set.new(setting_value(:subcommands, false) || auto_available_subcommands)
-        if respond_to?(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME, true)
-          r += send(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME)
-        end
-        r.sort
-      end
-
-      def auto_available_subcommands
-        self.class.constants
-            .map { |name| self.class.const_get(name) }
-            .select { |c| c.instance_of? Class }
-            .select { |c| c < ::EacCli::DocoptRunner }
-            .map { |c| c.name.demodulize.underscore.dasherize }
-      end
-
-      def run_without_subcommand
-        "Method #{__method__} should be overrided in #{self.class.name}"
-      end
-
-      protected
-
-      def check_valid_subcommand
-        return if available_subcommands.include?(subcommand_name)
-
-        raise ::Docopt::Exit, "\"#{subcommand_name}\" is not a valid subcommand" \
-          " (Valid: #{available_subcommands.join(', ')})"
-      end
-
-      module SubcommandArgAsArg
-        def target_doc_subcommand_arg
-          SUBCOMMAND_ARG
-        end
-
-        def subcommand_name
-          options.fetch(SUBCOMMAND_ARG)
-        end
-
-        def subcommands_target_doc
-          available_subcommands.inject("Subcommands:\n") do |a, e|
-            a + "  #{e}\n"
-          end
-        end
-      end
-
-      module SubcommandArgAsList
-        def target_doc_subcommand_arg
-          '(' + available_subcommands.join('|') + ')'
-        end
-
-        def subcommand_name
-          available_subcommands.each do |subcommand|
-            return subcommand if options.fetch(subcommand)
-          end
-          nil
-        end
-
-        def subcommands_target_doc
-          "\n"
-        end
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt_runner/class_methods.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'docopt'
-
-module EacCli
-  class DocoptRunner
-    module ClassMethods
-      DOCOPT_ERROR_EXIT_CODE = 0xC0
-
-      def run(options = {})
-        create(options).send(:run)
-      rescue ::Docopt::Exit => e
-        STDERR.write(e.message + "\n")
-        ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE)
-      end
-    end
-  end
-end

data/lib/eac_cli/docopt_runner/context.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module EacCli
-  class DocoptRunner
-    # Provides the method context which search and call a method in self and ancestor objects.
-    module Context
-      def context(method)
-        current = self
-        while current
-          return current.send(method) if current.respond_to?(method)
-
-          current = current.respond_to?(:parent) ? current.parent : nil
-        end
-        raise "Context method \"#{method}\" not found for #{self.class}"
-      end
-    end
-  end
-end