hammer_cli 2.5.0 → 3.1.0

data/lib/hammer_cli/help/builder.rb

@@ -29,7 +29,11 @@ module HammerCLI
 
         label_width = DEFAULT_LABEL_INDENT
         items.each do |item|
-          label = item.help.first
+          label = if !HammerCLI.context[:full_help] && item.respond_to?(:family) && item.family && !item.child?
+                    item.family.help.first
+                  else
+                    item.help.first
+                  end
           label_width = label.size if label.size > label_width
         end
 
@@ -38,11 +42,11 @@ module HammerCLI
             next unless HammerCLI.context[:full_help]
           end
           label, description = if !HammerCLI.context[:full_help] && item.respond_to?(:family) && item.family
-            [item.family.switch, item.family.description || item.help[1]]
-          else
-            item.help
-          end
-          description.gsub(/^(.)/) { Unicode::capitalize($1) }.each_line do |line|
+                                 item.family.help
+                               else
+                                 item.help
+                               end
+          description.gsub(/^(.)/) { Unicode.capitalize(Regexp.last_match(1)) }.wrap.each_line do |line|
             puts " %-#{label_width}s %s" % [label, line]
             label = ''
           end

data/lib/hammer_cli/options/normalizers.rb

@@ -4,8 +4,28 @@ require 'hammer_cli/csv_parser'
 module HammerCLI
   module Options
     module Normalizers
+      def self.available
+        AbstractNormalizer.available
+      end
 
       class AbstractNormalizer
+        class << self
+          attr_reader :available
+
+          def inherited(subclass)
+            @available ||= []
+            @available << subclass
+          end
+
+          def completion_type
+            :value
+          end
+
+          def common_description
+            _("Value described in the option's description. Mostly simple string")
+          end
+        end
+
         def description
           ""
         end
@@ -17,6 +37,10 @@ module HammerCLI
         def complete(val)
           []
         end
+
+        def completion_type
+          { type: self.class.completion_type }
+        end
       end
 
       class Default < AbstractNormalizer
@@ -30,9 +54,15 @@ module HammerCLI
         PAIR_RE = '([^,=]+)=([^,\{\[]+|[\{\[][^\{\}\[\]]*[\}\]])'
         FULL_RE = "^((%s)[,]?)+$" % PAIR_RE
 
-        def description
-          _("Comma-separated list of key=value.") + "\n" +
-          _("JSON is acceptable and preferred way for complex parameters")
+        class << self
+          def completion_type
+            :key_value_list
+          end
+
+          def common_description
+            _('Comma-separated list of key=value.') + "\n" +
+              _('JSON is acceptable and preferred way for such parameters')
+          end
         end
 
         def format(val)
@@ -94,9 +124,16 @@ module HammerCLI
 
 
       class List < AbstractNormalizer
-        def description
-          _("Comma separated list of values. Values containing comma should be quoted or escaped with backslash.") + "\n" +
-          _("JSON is acceptable and preferred way for complex parameters")
+        class << self
+          def completion_type
+            :list
+          end
+
+          def common_description
+            _('Comma separated list of values. Values containing comma should be quoted or escaped with backslash.') +
+              "\n" +
+              _('JSON is acceptable and preferred way for such parameters')
+          end
         end
 
         def format(val)
@@ -110,6 +147,18 @@ module HammerCLI
       end
 
       class ListNested < AbstractNormalizer
+        class << self
+          def completion_type
+            :schema
+          end
+
+          def common_description
+            _('Comma separated list of values defined by a schema.') +
+              "\n" +
+              _('JSON is acceptable and preferred way for such parameters')
+          end
+        end
+
         class Schema < Array
           def description(richtext: true)
             '"' + reduce([]) do |schema, nested_param|
@@ -135,11 +184,6 @@ module HammerCLI
           @schema = Schema.new(schema)
         end
 
-        def description
-          _("Comma separated list of values defined by a schema. See Option details section below.") + "\n" +
-          _("JSON is acceptable and preferred way for complex parameters")
-        end
-
         def format(val)
           return [] unless val.is_a?(String) && !val.empty?
           begin
@@ -152,9 +196,22 @@ module HammerCLI
             end
           end
         end
+
+        def completion_type
+          super.merge({ schema: schema.description(richtext: false) })
+        end
       end
 
       class Number < AbstractNormalizer
+        class << self
+          def completion_type
+            :number
+          end
+
+          def common_description
+            _('Numeric value. Integer')
+          end
+        end
 
         def format(val)
           if numeric?(val)
@@ -167,17 +224,22 @@ module HammerCLI
         def numeric?(val)
           Integer(val) != nil rescue false
         end
-
       end
 
 
       class Bool < AbstractNormalizer
-        def allowed_values
-          ['yes', 'no', 'true', 'false', '1', '0']
+        class << self
+          def completion_type
+            :boolean
+          end
+
+          def common_description
+            _('One of %s') % ['true/false', 'yes/no', '1/0'].join(', ')
+          end
         end
 
-        def description
-          _('One of %s.') % ['true/false', 'yes/no', '1/0'].join(', ')
+        def allowed_values
+          ['yes', 'no', 'true', 'false', '1', '0']
         end
 
         def format(bool)
@@ -194,10 +256,23 @@ module HammerCLI
         def complete(value)
           allowed_values.map { |v| v + ' ' }
         end
+
+        def completion_type
+          super.merge({ values: allowed_values })
+        end
       end
 
 
       class File < AbstractNormalizer
+        class << self
+          def completion_type
+            :file
+          end
+
+          def common_description
+            _('Path to a file')
+          end
+        end
 
         def format(path)
           ::File.read(::File.expand_path(path))
@@ -233,6 +308,16 @@ module HammerCLI
 
 
       class Enum < AbstractNormalizer
+        class << self
+          def completion_type
+            :enum
+          end
+
+          def common_description
+            _("Possible values are described in the option's description")
+          end
+        end
+
         attr_reader :allowed_values
 
         def initialize(allowed_values)
@@ -260,6 +345,10 @@ module HammerCLI
           Completer::finalize_completions(@allowed_values)
         end
 
+        def completion_type
+          super.merge({ values: allowed_values })
+        end
+
         private
 
         def quoted_values
@@ -269,9 +358,14 @@ module HammerCLI
 
 
       class DateTime < AbstractNormalizer
+        class << self
+          def completion_type
+            :datetime
+          end
 
-        def description
-          _("Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format")
+          def common_description
+            _('Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format')
+          end
         end
 
         def format(date)
@@ -283,6 +377,16 @@ module HammerCLI
       end
 
       class EnumList < AbstractNormalizer
+        class << self
+          def completion_type
+            :multienum
+          end
+
+          def common_description
+            _("Any combination of possible values described in the option's description")
+          end
+        end
+
         attr_reader :allowed_values
 
         def initialize(allowed_values)
@@ -301,6 +405,10 @@ module HammerCLI
           Completer::finalize_completions(@allowed_values)
         end
 
+        def completion_type
+          super.merge({ values: allowed_values })
+        end
+
         private
 
         def quoted_values

data/lib/hammer_cli/options/option_definition.rb

@@ -22,12 +22,14 @@ module HammerCLI
 
     class OptionDefinition < Clamp::Option::Definition
 
-      attr_accessor :value_formatter, :context_target, :deprecated_switches
+      attr_accessor :value_formatter, :context_target, :deprecated_switches,
+                    :family
 
       def initialize(switches, type, description, options = {})
         @value_formatter = options[:format] || HammerCLI::Options::Normalizers::Default.new
         @context_target = options[:context_target]
         @deprecated_switches = options[:deprecated]
+        @family = options[:family]
         super
       end
 
@@ -36,7 +38,9 @@ module HammerCLI
       end
 
       def help_lhs
-        super
+        lhs = switches.join(', ')
+        lhs += " #{completion_type[:type]}".upcase unless flag?
+        lhs
       end
 
       def help_rhs
@@ -50,14 +54,14 @@ module HammerCLI
         rhs.empty? ? " " : rhs
       end
 
-      def handles?(switch)
+      def extract_value(switch, arguments)
         message = _("Warning: Option %{option} is deprecated. %{message}")
         if deprecated_switches.class <= String && switches.include?(switch)
-          warn(message % { :option => switch, :message => deprecated_switches })
+          warn(message % { option: switch, message: deprecated_switches })
         elsif deprecated_switches.class <= Hash && deprecated_switches.keys.include?(switch)
-          warn(message % { :option => switch, :message => deprecated_switches[switch] })
+          warn(message % { option: switch, message: deprecated_switches[switch] })
         end
-        super(switch)
+        super(switch, arguments)
       end
 
       def deprecation_message(switch)
@@ -140,22 +144,13 @@ module HammerCLI
         return { type: :flag } if @type == :flag
 
         formatter ||= value_formatter
-        completion_type = case formatter
-                          when HammerCLI::Options::Normalizers::Bool,
-                               HammerCLI::Options::Normalizers::Enum
-                            { type: :enum, values: value_formatter.allowed_values }
-                          when HammerCLI::Options::Normalizers::EnumList
-                            { type: :multienum, values: value_formatter.allowed_values }
-                          when HammerCLI::Options::Normalizers::ListNested
-                            { type: :schema, schema: value_formatter.schema.description(richtext: false) }
-                          when HammerCLI::Options::Normalizers::List
-                            { type: :list }
-                          when HammerCLI::Options::Normalizers::KeyValueList
-                            { type: :key_value_list }
-                          when HammerCLI::Options::Normalizers::File
-                            { type: :file }
-                          end
-        completion_type || { type: :value }
+        formatter.completion_type
+      end
+
+      def child?
+        return unless @family
+
+        @family.children.include?(self)
       end
 
       private

data/lib/hammer_cli/options/option_family.rb

@@ -2,25 +2,33 @@
 
 module HammerCLI
   module Options
+    class OptionFamilyRegistry < Array
+      # rubocop:disable Style/Alias
+      alias_method :register, :push
+      alias_method :unregister, :delete
+      # rubocop:enable Style/Alias
+    end
+
     class OptionFamily
       attr_reader :children
 
-      IDS_REGEX = /(\A[Ii][Dd][s]?)|\s([Ii][Dd][s]?)\W|([Ii][Dd][s]?\Z)/
+      IDS_REGEX = /(\A[Ii][Dd][s]?)|\s([Ii][Dd][s]?)\W|([Ii][Dd][s]?\Z)|(numeric identifier|identifier)/.freeze
 
       def initialize(options = {})
         @all = []
         @children = []
         @options = options
-        @creator = options[:creator] || Class.new(HammerCLI::Apipie::Command)
+        @creator = options[:creator] || self
         @prefix = options[:prefix]
         @root = options[:root] || options[:aliased_resource] || options[:referenced_resource]
+        @creator.family_registry.register(self) if @creator != self
       end
 
       def description
         types = all.map(&:type).map { |s| s.split('_').last.to_s }
                    .map(&:downcase).join('/')
-        parent_desc = @parent.help[1].gsub(IDS_REGEX) { |w| w.gsub(/\w+/, types) }
-        desc = parent_desc.strip.empty? ? @options[:description] : parent_desc
+        parent_desc = @parent.help[1].gsub(IDS_REGEX) { |w| w.gsub(/\b.+\b/, types) }
+        desc = @options[:description] || parent_desc.strip.empty? ? @options[:description] : parent_desc
         if @options[:deprecation].class <= String
           format_deprecation_msg(desc, _('Deprecated: %{deprecated_msg}') % { deprecated_msg: @options[:deprecation] })
         elsif @options[:deprecation].class <= Hash
@@ -33,6 +41,21 @@ module HammerCLI
         end
       end
 
+      def help
+        [help_lhs, help_rhs]
+      end
+
+      def help_lhs
+        return @parent&.help_lhs if @children.empty?
+
+        types = all.map(&:value_formatter).map { |f| f.completion_type[:type].to_s.upcase }
+        switch + ' ' + types.uniq.join('/')
+      end
+
+      def help_rhs
+        description || @parent.help[1]
+      end
+
       def formats
         return [@options[:format].class] if @options[:format]
 
@@ -41,7 +64,7 @@ module HammerCLI
 
       def switch
         return if @parent.nil? && @children.empty?
-        return @parent.help_lhs.strip if @children.empty?
+        return @parent.switches.join(', ').strip if @children.empty?
 
         switch_start = main_switch.each_char
                                   .zip(*all.map(&:switches).flatten.map(&:each_char))
@@ -68,6 +91,8 @@ module HammerCLI
 
       def child(switches, type, description, opts = {}, &block)
         child = new_member(switches, type, description, opts, &block)
+        return unless child
+
         @children << child
         child
       end
@@ -80,6 +105,18 @@ module HammerCLI
         @children << child
       end
 
+      def root
+        @root || @parent&.aliased_resource || @parent&.referenced_resource || common_root
+      end
+
+      def option(*args)
+        HammerCLI::Apipie::OptionDefinition.new(*args)
+      end
+
+      def find_option(switch)
+        all.find { |m| m.handles?(switch) }
+      end
+
       private
 
       def format_deprecation_msg(option_desc, deprecation_msg)
@@ -90,18 +127,17 @@ module HammerCLI
         opts = opts.merge(@options)
         opts[:family] = self
         if opts[:deprecated]
-          handles = [switches].flatten
+          handles = Array(switches)
           opts[:deprecated] = opts[:deprecated].select do |switch, _msg|
             handles.include?(switch)
           end
         end
         @creator.instance_eval do
-          option(switches, type, description, opts, &block)
+          option(switches, type, description, opts, &block) unless Array(switches).any? { |s| find_option(s) }
         end
       end
 
       def main_switch
-        root = @root || @parent.aliased_resource || @parent.referenced_resource || common_root
         "--#{@prefix}#{root}".tr('_', '-')
       end
 

data/lib/hammer_cli/output/adapter/abstract.rb

@@ -97,6 +97,12 @@ module HammerCLI::Output::Adapter
       @context[:fields] || ['DEFAULT']
     end
 
+    def context_for_fields
+      {
+        show_ids: @context[:show_ids]
+      }
+    end
+
     private
 
     def filter_formatters(formatters_map)

data/lib/hammer_cli/output/adapter/base.rb

@@ -76,7 +76,7 @@ module HammerCLI::Output::Adapter
     def render_value(field, data)
       formatter = @formatters.formatter_for_type(field.class)
       parameters = field.parameters
-      parameters[:context] = @context
+      parameters[:context] = context_for_fields
       data = formatter.format(data, field.parameters) if formatter
       data.to_s
     end

data/lib/hammer_cli/output/adapter/tree_structure.rb

@@ -55,7 +55,7 @@ module HammerCLI::Output::Adapter
       else
         formatter = @formatters.formatter_for_type(field.class)
         parameters = field.parameters
-        parameters[:context] = @context
+        parameters[:context] = context_for_fields
         if formatter
           data = formatter.format(data, field.parameters)
         end

data/lib/hammer_cli/output/definition.rb

@@ -73,7 +73,7 @@ module HammerCLI::Output
 
         data << sets.each_with_object({}) do |set, res|
           mark = field.sets.include?(set) ? 'x' : ''
-          value = set == sets.first ? field.full_label : mark
+          value = set == sets.first ? field.full_label.capitalize : mark
           res.update(set => value)
         end
       end

data/lib/hammer_cli/output/field_filter.rb

@@ -11,7 +11,7 @@ module HammerCLI::Output
 
     def fields=(fields)
       @fields = fields || []
-      @filtered_fields = @fields.dup
+      @filtered_fields = Marshal.load(Marshal.dump(@fields))
     end
 
     def filter_by_classes(classes = nil)
@@ -66,7 +66,7 @@ module HammerCLI::Output
 
     def include_by_label?(labels, label)
       labels.any? do |l|
-        l.start_with?("#{label}/") || label.match(%r{^#{l.gsub(/\*/, '.*')}(|\/.*)$})
+        l.start_with?("#{label}/") || label.match(%r{^#{l.gsub(/\*/, '.*')}(|\/.*)$}) || l == label
       end
     end
 

data/lib/hammer_cli/utils.rb

@@ -40,6 +40,12 @@ class String
     HammerCLI.constant_path(self)[-1]
   end
 
+  # Rails implementation: https://github.com/rails/rails/blob/main/actionview/lib/action_view/helpers/text_helper.rb#L260
+  def wrap(line_width: 80, break_sequence: "\n")
+    split("\n").collect! do |line|
+      line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
+    end * break_sequence
+  end
 end
 
 class Hash

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new "2.5.0"
+    @version ||= Gem::Version.new "3.1.0"
   end
 end

data/test/unit/abstract_test.rb

@@ -308,6 +308,13 @@ describe HammerCLI::AbstractCommand do
       opt = TestOptionCmd.find_option('--fields')
       opt.is_a?(HammerCLI::Options::OptionDefinition).must_equal true
     end
+
+    it 'should add option type and accepted value' do
+      help_str = TestOptionCmd.help('')
+      help_str.must_match(
+        /LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash./
+      )
+    end
   end
 
   describe "#options" do

data/test/unit/apipie/option_builder_test.rb

@@ -17,7 +17,7 @@ describe HammerCLI::Apipie::OptionBuilder do
   let(:resource) {api.resource(:documented)}
   let(:action) {resource.action(:index)}
   let(:builder) { HammerCLI::Apipie::OptionBuilder.new(resource, action) }
-  let(:builder_options) { {} }
+  let(:builder_options) { { command: Class.new(HammerCLI::Apipie::Command) } }
   let(:options) { builder.build(builder_options) }
 
   context "with one simple param" do
@@ -51,7 +51,7 @@ describe HammerCLI::Apipie::OptionBuilder do
   context "required options" do
 
     let(:action) {resource.action(:create)}
-    let(:required_options) { builder.build.reject{|opt| !opt.required?} }
+    let(:required_options) { builder.build(builder_options).reject{|opt| !opt.required?} }
 
     it "should set required flag for the required options" do
       required_options.map(&:attribute_name).sort.must_equal [HammerCLI.option_accessor_name("array_param")]
@@ -146,7 +146,12 @@ describe HammerCLI::Apipie::OptionBuilder do
 
   context "aliasing resources" do
     let(:action) {resource.action(:action_with_ids)}
-    let(:builder_options) { {:resource_mapping => {:organization => 'company', 'compute_resource' => :compute_provider}} }
+    let(:builder_options) do
+      {
+        resource_mapping: { organization: 'company', 'compute_resource' => :compute_provider },
+        command: Class.new(HammerCLI::Apipie::Command)
+      }
+    end
 
     it "renames options" do
       # builder_options[:resource_mapping] = {:organization => 'company', 'compute_resource' => :compute_provider}

data/test/unit/command_extensions_test.rb

@@ -118,7 +118,7 @@ describe HammerCLI::CommandExtensions do
     it 'should extend option family only' do
       cmd.extend_with(CmdExtensions.new(only: :option_family))
       cmd.output_definition.empty?.must_equal true
-      cmd.recognised_options.map(&:switches).flatten.must_equal ['--test-one', '--test-two', '-h', '--help']
+      cmd.recognised_options.map(&:switches).flatten.must_equal ['-h', '--help', '--test-one', '--test-two']
     end
   end
 
@@ -203,5 +203,13 @@ describe HammerCLI::CommandExtensions do
     end
   end
 
-
+  context 'associate family' do
+    it 'should associate option family' do
+      cmd.extend_with(CmdExtensions.new(only: :option_family))
+      cmd.option_family associate: 'test' do
+        child '--test-three', '', ''
+      end
+      cmd.recognised_options.map(&:switches).flatten.must_equal ['-h', '--help', '--test-one', '--test-two', '--test-three']
+    end
+  end
 end