eac_cli 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b98571e3ddcf2aadd402f64e364a7d7d3bfc189711b5ff1e696398d1e90457b
-  data.tar.gz: 86698287a397dc5b8ef798dbbe9aca96247cf68033114bdd2c71e002e6afc8de
+  metadata.gz: 1853322785755d21efac308e25451d06916d45c48ea74707a0f9429c29c27746
+  data.tar.gz: 13fcaa983d84cc271567eae554552fa71449051b3250429158576ac0e7ab53e9
 SHA512:
-  metadata.gz: 006fa8fb408649d4654e05cde6cff39ef0ac30664761688cf3daf458d27dfee36e70f89abcaee26fe9154a4308b2ca53f190cb53a8af1d4275f74f693428a940
-  data.tar.gz: '096ff1ae52b3765fa5f976489d41ef7b47f646b9c5bd18e0f7c891b95bb5c05283eb21c83e93cd516af2e1514877a52f22971f87b185261193192f3f61b885b2'
+  metadata.gz: 1ac522fbc5d345d5dbf135a07cc934a6f88158ff0470fee2e61667e82b84728c03b1902b995fbb201b7e20f1eae5aa5cab35367edc43ee1a614f603d35cd8777
+  data.tar.gz: 4db03e5ba8a565abfd066f33e57a86bdffc97e0ecbf70e0234246d1e048fb6e0e8dc83824325687d724b64e03adae31cb9407c0319500df763ec05be23972fd8

data/lib/eac_cli/definition.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/argument_option'
+require 'eac_cli/definition/boolean_option'
+require 'eac_cli/definition/positional_argument'
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Definition
+    require_sub __FILE__
+    attr_accessor :description
+    attr_accessor :options_argument
+
+    def initialize
+      self.description = '-- NO DESCRIPTION SET --'
+      self.options_argument = true
+    end
+
+    def alt(&block)
+      r = ::EacCli::Definition.new
+      r.instance_eval(&block)
+      alternatives << r
+      r
+    end
+
+    def alternatives
+      @alternatives ||= []
+    end
+
+    def arg_opt(short, long, description, option_options = {})
+      options << ::EacCli::Definition::ArgumentOption.new(
+        short, long, description, option_options
+      )
+    end
+
+    def bool_opt(short, long, description, option_options = {})
+      options << ::EacCli::Definition::BooleanOption.new(short, long, description, option_options)
+    end
+
+    def desc(description)
+      self.description = description
+    end
+
+    def options_arg(options_argument)
+      self.options_argument = options_argument
+    end
+
+    def options
+      @options ||= []
+    end
+
+    def pos_arg(name, arg_options = {})
+      positional << ::EacCli::Definition::PositionalArgument.new(name, arg_options)
+    end
+
+    def positional
+      @positional ||= []
+    end
+
+    def subcommands
+      positional << ::EacCli::Definition::PositionalArgument.new('subcommand', subcommand: true)
+    end
+
+    def options_first(enable = true)
+      @options_first = enable
+    end
+
+    def options_first?
+      @options_first ? true : false
+    end
+  end
+end

data/lib/eac_cli/definition/argument_option.rb

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

data/lib/eac_cli/{runner → definition}/base_option.rb

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
-  module Runner
+  class Definition
     class BaseOption
       attr_reader :short, :long, :description, :options
 
@@ -14,6 +14,10 @@ module EacCli
         @options = options.with_indifferent_access
       end
 
+      def identifier
+        long.to_s.variableize.to_sym
+      end
+
       def show_on_usage?
         options[:usage]
       end

data/lib/eac_cli/definition/boolean_option.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_cli/definition/base_option'
+
+module EacCli
+  class Definition
+    class BooleanOption < ::EacCli::Definition::BaseOption
+      def argument?
+        false
+      end
+    end
+  end
+end

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

@@ -3,13 +3,25 @@
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
-  module Runner
+  class Definition
     class PositionalArgument
       common_constructor :name, :options, default: [{}]
 
+      def identifier
+        name.to_s.variableize.to_sym
+      end
+
+      def optional?
+        options[:optional]
+      end
+
       def repeat?
         options[:repeat]
       end
+
+      def subcommand?
+        options[:subcommand]
+      end
     end
   end
 end

data/lib/eac_cli/{runner/docopt_doc.rb → docopt/doc_builder.rb}

@@ -4,8 +4,8 @@ require 'eac_ruby_utils/core_ext'
 require 'eac_ruby_utils/console/docopt_runner'
 
 module EacCli
-  module Runner
-    class DocoptDoc
+  module Docopt
+    class DocBuilder
       common_constructor :definition
 
       SEP = ' '
@@ -13,9 +13,14 @@ module EacCli
       OPTION_DESC_SEP = IDENT * 2
 
       def positional_argument(positional)
-        r = "<#{positional.name}>"
-        r += '...' if positional.repeat?
-        r
+        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)
@@ -46,15 +51,22 @@ module EacCli
       end
 
       def self_usage
-        b = IDENT + ::EacRubyUtils::Console::DocoptRunner::PROGRAM_MACRO
-        b += "#{SEP}[options]" if definition.options_argument
-        b + self_usage_arguments
+        IDENT + self_usage_arguments.join(SEP)
       end
 
       def self_usage_arguments
-        definition.options.select(&:show_on_usage?)
-                  .map { |option| "#{SEP}#{option_argument(option)}" }.join +
-          definition.positional.map { |p| "#{SEP}#{positional_argument(p)}" }.join
+        [::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
 
       def to_s

data/lib/eac_cli/docopt/runner_extension.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_cli/docopt/doc_builder'
+require 'eac_ruby_utils/console/docopt_runner'
+
+module EacCli
+  module Docopt
+    module RunnerExtension
+      extend ::ActiveSupport::Concern
+
+      included do
+        singleton_class.prepend ClassMethods
+        prepend InstanceMethods
+      end
+
+      class << self
+        def check(klass)
+          return unless klass < ::EacRubyUtils::Console::DocoptRunner
+
+          klass.include(self)
+        end
+      end
+
+      module ClassMethods
+        def create(*context_args)
+          r = new(*context_args)
+          r.runner_context = ::EacCli::Runner::Context.new(*context_args)
+          r
+        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
+      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/parser.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    require_sub __FILE__
+    common_constructor :definition
+
+    def parse(argv)
+      ::EacCli::Parser::ParseResult.new(definition, argv).result
+    end
+  end
+end

data/lib/eac_cli/parser/collector.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/struct'
+
+module EacCli
+  class Parser
+    class Collector
+      class << self
+        def to_data(definition)
+          collector = new(definition)
+          yield(collector)
+          collector.to_data
+        end
+      end
+
+      common_constructor :definition do
+        default_values
+      end
+
+      # @return [OpenStruct]
+      def to_data
+        ::EacRubyUtils::Struct.new(data.transform_keys(&:identifier))
+      end
+
+      def collect(option, value)
+        if data[option].is_a?(::Array)
+          data[option] << value
+        else
+          data[option] = value
+        end
+      end
+
+      private
+
+      def data
+        @data ||= {}
+      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
+      end
+    end
+  end
+end

data/lib/eac_cli/parser/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    class Error < ::StandardError
+      def initialize(definition, argv, message)
+        @definition = definition
+        @argv = argv
+        super(message)
+      end
+    end
+  end
+end

data/lib/eac_cli/parser/options_collection.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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
+
+      private
+
+      def collect
+        build_banner
+        build_options
+        @arguments = option_parser.parse(argv)
+      end
+
+      def option_parser_uncached
+        ::OptionParser.new
+      end
+
+      def build_banner
+        option_parser.banner = "#{definition.description}\n\n#{section('usage')}"
+      end
+
+      def build_options
+        definition.options.each do |option|
+          build_option(option)
+        end
+      end
+
+      def build_option(option)
+        option_parser.on(
+          *[option_short(option), 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/parser/parse_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  class Parser
+    class ParseResult
+      common_constructor :definition, :argv
+
+      def result
+        ::EacCli::Parser::Collector.to_data(definition) do |collector|
+          ::EacCli::Parser::PositionalCollection.new(
+            definition,
+            ::EacCli::Parser::OptionsCollection.new(definition, argv, collector).arguments,
+            collector
+          )
+        end
+      end
+    end
+  end
+end

data/lib/eac_cli/parser/positional_collection.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_cli/parser/error'
+
+module EacCli
+  class Parser
+    class PositionalCollection
+      common_constructor(:definition, :argv, :collector) { collect }
+
+      private
+
+      def collected
+        @collected ||= ::Set.new
+      end
+
+      def collect
+        argv.each { |argv_value| colect_argv_value(argv_value) }
+        return unless pending_required_positional?
+
+        raise ::EacCli::Parser::Error.new(
+          definition, argv, 'No value for required positional ' \
+            "\"#{current_positional.identifier}\""
+        )
+      end
+
+      def colect_argv_value(argv_value)
+        collector.collect(current_positional, argv_value)
+        collected << current_positional
+        positional_enumerator.next unless current_positional.repeat?
+      end
+
+      def pending_required_positional?
+        !(current_positional.blank? || current_positional.optional? ||
+            collected.include?(current_positional))
+      end
+
+      def positional_enumerator
+        @positional_enumerator ||= definition.positional.each
+      end
+
+      def current_positional
+        positional_enumerator.peek
+      rescue ::StopIteration
+        nil
+      end
+    end
+  end
+end

data/lib/eac_cli/runner.rb

@@ -1,29 +1,56 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner/definition'
-require 'eac_cli/runner/docopt_doc'
+require 'eac_cli/definition'
+require 'eac_cli/docopt/runner_extension'
+require 'eac_cli/parser'
 require 'eac_ruby_utils/core_ext'
 
 module EacCli
   module Runner
+    require_sub __FILE__
     extend ::ActiveSupport::Concern
 
     included do
       extend ClassMethods
       include InstanceMethods
+      ::EacCli::Docopt::RunnerExtension.check(self)
     end
 
     module ClassMethods
+      def create(*runner_context_args)
+        r = new
+        r.runner_context = ::EacCli::Runner::Context.new(*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 ||= ::EacCli::Runner::Definition.new
+        @runner_definition ||= ::EacCli::Definition.new
         @runner_definition.instance_eval(&block) if block
         @runner_definition
       end
     end
 
     module InstanceMethods
-      def doc
-        ::EacCli::Runner::DocoptDoc.new(self.class.runner_definition).to_s
+      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).parse(runner_context.argv)
       end
     end
   end

data/lib/eac_cli/runner/context.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacCli
+  module Runner
+    class Context
+      attr_reader :argv, :parent, :program_name
+
+      def initialize(*context_args)
+        options = context_args.extract_options!
+        @argv = (context_args[0] || options.delete(:argv) || ARGV).dup.freeze
+        @parent = context_args[1] || options.delete(:parent)
+        @program_name = options.delete(:program_name)
+      end
+    end
+  end
+end

data/lib/eac_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-09-22 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.23'
+        version: '0.45'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: 
 email: 
 executables: []
@@ -47,13 +53,21 @@ files:
 - Gemfile
 - lib/eac_cli.rb
 - lib/eac_cli/default_runner.rb
+- lib/eac_cli/definition.rb
+- 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/positional_argument.rb
+- lib/eac_cli/docopt/doc_builder.rb
+- lib/eac_cli/docopt/runner_extension.rb
+- lib/eac_cli/parser.rb
+- lib/eac_cli/parser/collector.rb
+- lib/eac_cli/parser/error.rb
+- lib/eac_cli/parser/options_collection.rb
+- lib/eac_cli/parser/parse_result.rb
+- lib/eac_cli/parser/positional_collection.rb
 - lib/eac_cli/runner.rb
-- lib/eac_cli/runner/argument_option.rb
-- lib/eac_cli/runner/base_option.rb
-- lib/eac_cli/runner/boolean_option.rb
-- lib/eac_cli/runner/definition.rb
-- lib/eac_cli/runner/docopt_doc.rb
-- lib/eac_cli/runner/positional_argument.rb
+- lib/eac_cli/runner/context.rb
 - lib/eac_cli/version.rb
 homepage: 
 licenses: []
@@ -73,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Utilities to build CLI applications with Ruby.

data/lib/eac_cli/runner/argument_option.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/runner/base_option'
-
-module EacCli
-  module Runner
-    class ArgumentOption < ::EacCli::Runner::BaseOption
-      def argument?
-        true
-      end
-    end
-  end
-end

data/lib/eac_cli/runner/boolean_option.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/runner/base_option'
-
-module EacCli
-  module Runner
-    class BooleanOption < ::EacCli::Runner::BaseOption
-      def argument?
-        false
-      end
-    end
-  end
-end

data/lib/eac_cli/runner/definition.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_cli/runner/argument_option'
-require 'eac_cli/runner/boolean_option'
-require 'eac_cli/runner/positional_argument'
-require 'eac_ruby_utils/core_ext'
-
-module EacCli
-  module Runner
-    class Definition
-      require_sub __FILE__
-      attr_accessor :description
-      attr_accessor :options_argument
-
-      def initialize
-        self.description = '-- NO DESCRIPTION SET --'
-        self.options_argument = true
-      end
-
-      def alt(&block)
-        r = ::EacCli::Runner::Definition.new
-        r.instance_eval(&block)
-        alternatives << r
-        r
-      end
-
-      def alternatives
-        @alternatives ||= []
-      end
-
-      def arg_opt(short, long, description, option_options = {})
-        options << ArgumentOption.new(short, long, description, option_options)
-      end
-
-      def bool_opt(short, long, description, option_options = {})
-        options << BooleanOption.new(short, long, description, option_options)
-      end
-
-      def desc(description)
-        self.description = description
-      end
-
-      def options_arg(options_argument)
-        self.options_argument = options_argument
-      end
-
-      def options
-        @options ||= []
-      end
-
-      def pos_arg(name, arg_options = {})
-        positional << PositionalArgument.new(name, arg_options)
-      end
-
-      def positional
-        @positional ||= []
-      end
-    end
-  end
-end