ehbrs-tools 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a216d21cdcdb218151fbfd96d21d4b378ae35c4071d222707178c48a6f4ad69
-  data.tar.gz: dec260f1e8ffceb7eaa91fb4052b136d8222525c473e348abd897e86d0ba4e00
+  metadata.gz: 9692fcad0f7b1e05f59f98e17e1d1e5042efa22f1bd1e8ada8a2b5b2d4909e66
+  data.tar.gz: 606f3be03e5b0f54564aaa78b466e89ed498cf4a7d316e187cb6432b34cd46f6
 SHA512:
-  metadata.gz: 000fb54ab3abd785846e2d05802a7d12752109be7a2ac2314ea7804bcc90a4f98f3ee443dd693c6cba1687333c32d2832387f17acc9e32e44a6fb1cb22e23954
-  data.tar.gz: 8b060bb61da97a62b3fd1648060fb667ea9ed074fd719c194806d15469bae413031f663df10877b0099d109a4d78544f8e3148b842d36841e68f0140daa99b15
+  metadata.gz: 4fc3d4a8dc042274ca49de459c5a18d8179cd0b2f1846016c9fcff06d909b5583aa282e645205bc502698b447ae2a8aab3bf53bfc9646e71eea23a9949c5b272
+  data.tar.gz: 48d655fe4a28192181f2e40d3f2f9041d7c3f4a41a80168446ee15ec176d54c2f5c0c4428d41fc0a5c3248f5dc3471b408c8f8d58b7ffecd5131d9040e7ef0ce

data/lib/ehbrs/runner.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'eac_cli/default_runner'
 require 'eac_ruby_utils/core_ext'
 require 'eac_ruby_utils/console/docopt_runner'
 require 'ehbrs/tools/version'
@@ -7,20 +8,15 @@ require 'ehbrs/tools/version'
 module Ehbrs
   class Runner < ::EacRubyUtils::Console::DocoptRunner
     require_sub __FILE__
-    enable_console_speaker
+    include ::EacCli::DefaultRunner
 
-    DOC = <<~DOCOPT
-      Tools for EHB/RS.
-
-      Usage:
-        __PROGRAM__ [options] __SUBCOMMANDS__
-        __PROGRAM__ --version
-        __PROGRAM__ -h | --help
-
-      Options:
-        -h --help             Show this screen.
-        -V --version          Show version.
-    DOCOPT
+    runner_definition do
+      desc 'Tools for EHB/RS.'
+      subcommands
+      alt do
+        bool_opt '-V', '--version', 'Show version.'
+      end
+    end
 
     def run
       if options.fetch('--version')

data/lib/ehbrs/runner/fs/used_space.rb

@@ -6,7 +6,7 @@ require 'filesize'
 module Ehbrs
   class Runner < ::EacRubyUtils::Console::DocoptRunner
     class Fs < ::EacRubyUtils::Console::DocoptRunner
-      class UsedSpace < ::EacRubyUtils::Console::DocoptRunner
+      class UsedSpace
         include ::EacCli::DefaultRunner
 
         runner_definition do
@@ -22,7 +22,7 @@ module Ehbrs
         end
 
         def check?
-          options.fetch('--check')
+          parsed.check
         end
 
         private
@@ -40,11 +40,11 @@ module Ehbrs
         end
 
         def paths_uncached
-          options.fetch('<paths>').map { |path| path_class.new(self, path) }
+          parsed.paths.map { |path| path_class.new(self, path) }
         end
 
         def verbose?
-          options.fetch('--verbose')
+          parsed.verbose
         end
 
         class PathBase

data/lib/ehbrs/tools/version.rb

@@ -2,6 +2,6 @@
 
 module Ehbrs
   module Tools
-    VERSION = '0.13.0'
+    VERSION = '0.13.1'
   end
 end

data/vendor/eac_cli/eac_cli.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*', 'Gemfile']
 
-  s.add_dependency 'eac_ruby_utils', '~> 0.23
-  '
-  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.1'
+  s.add_dependency 'eac_ruby_utils', '~> 0.45'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.1', '>= 0.1.2'
 end

data/vendor/eac_cli/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/vendor/eac_cli/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/vendor/eac_cli/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/vendor/eac_cli/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/vendor/eac_cli/lib/eac_cli/{runner → definition}/positional_argument.rb

@@ -3,10 +3,14 @@
 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

data/vendor/eac_cli/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 = ' '
@@ -51,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/vendor/eac_cli/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.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/vendor/eac_cli/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/vendor/eac_cli/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/vendor/eac_cli/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/vendor/eac_cli/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