hammer_cli 0.19.2 → 2.0.0

data/lib/hammer_cli/bash/prebuild_command.rb

@@ -0,0 +1,21 @@
+module HammerCLI
+  module Bash
+    class PrebuildCompletionCommand < HammerCLI::AbstractCommand
+      def execute
+        map = HammerCLI::MainCommand.completion_map
+        cache_file = HammerCLI::Settings.get(:completion_cache_file)
+        cache_dir = File.dirname(cache_file)
+        FileUtils.mkdir_p(cache_dir) unless File.directory?(cache_dir)
+        File.write(File.expand_path(cache_file), map.to_json)
+
+        HammerCLI::EX_OK
+      end
+    end
+  end
+
+  HammerCLI::MainCommand.subcommand(
+    'prebuild-bash-completion',
+    _('Prepare map of options and subcommands for Bash completion'),
+    HammerCLI::Bash::PrebuildCompletionCommand
+  )
+end

data/lib/hammer_cli/connection.rb

@@ -35,6 +35,10 @@ module HammerCLI
       connections[name]
     end
 
+    def available
+      connections.select { |k, v| !v.nil? }.values.first
+    end
+
     private
 
     def connections

data/lib/hammer_cli/exception_handler.rb

@@ -138,7 +138,16 @@ module HammerCLI
     end
 
     def handle_apipie_missing_arguments_error(e)
-      message = _("Missing arguments for %s") % "'#{e.params.join("', '")}'"
+      params = e.params.map do |p|
+        param = p[/\[.+\]/]
+        param = if param.nil?
+                  p.tr('_', '-')
+                else
+                  p.scan(/\[[^\[\]]+\]/).first[1...-1].tr('_', '-')
+                end
+        "--#{param}"
+      end
+      message = _("Missing arguments for %s.") % "'#{params.uniq.join("', '")}'"
       print_error message
       log_full_error e, message
       HammerCLI::EX_USAGE

data/lib/hammer_cli/main.rb

@@ -47,9 +47,11 @@ module HammerCLI
       :context_target => :interactive
     option ["--no-headers"], :flag, _("Hide headers from output")
     option ["--csv"], :flag, _("Output as CSV (same as --output=csv)")
-    option ["--output"], "ADAPTER", _("Set output format"),
-           format: HammerCLI::Options::Normalizers::Enum.new(HammerCLI::Output::Output.adapters.keys.map(&:to_s)),
-      :context_target => :adapter
+    option ['--output'], 'ADAPTER', _('Set output format'),
+           format: HammerCLI::Options::Normalizers::Enum.new(
+             HammerCLI::Output::Output.adapters.keys.map(&:to_s)
+           ),
+           context_target: :adapter
     option ["--output-file"], "OUTPUT_FILE", _("Path to custom output file") do |filename|
       begin
         context[:output_file] = File.new(filename, 'w')

data/lib/hammer_cli/options/normalizers.rb

@@ -111,10 +111,10 @@ module HammerCLI
 
       class ListNested < AbstractNormalizer
         class Schema < Array
-          def description
+          def description(richtext: true)
             '"' + reduce([]) do |schema, nested_param|
               name = nested_param.name
-              name = HighLine.color(name, :bold) if nested_param.required?
+              name = HighLine.color(name, :bold) if nested_param.required? && richtext
               values = nested_param.validator.scan(/<[^>]+>[\w]+<\/?[^>]+>/)
               value_pattern = if values.empty?
                                 "<#{nested_param.expected_type.downcase}>"
@@ -172,6 +172,9 @@ module HammerCLI
 
 
       class Bool < AbstractNormalizer
+        def allowed_values
+          ['yes', 'no', 'true', 'false', '1', '0']
+        end
 
         def description
           _('One of %s.') % ['true/false', 'yes/no', '1/0'].join(', ')
@@ -189,7 +192,7 @@ module HammerCLI
         end
 
         def complete(value)
-          ["yes ", "no "]
+          allowed_values.map { |v| v + ' ' }
         end
       end
 
@@ -280,6 +283,7 @@ module HammerCLI
       end
 
       class EnumList < AbstractNormalizer
+        attr_reader :allowed_values
 
         def initialize(allowed_values)
           @allowed_values = allowed_values

data/lib/hammer_cli/options/option_definition.rb

@@ -138,6 +138,28 @@ module HammerCLI
         end
       end
 
+      def completion_type(formatter = nil)
+        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 }
+      end
+
       private
 
       def format_deprecation_msg(option_desc, deprecation_msg)

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

@@ -44,14 +44,10 @@ module HammerCLI::Output::Adapter
       raise NotImplementedError
     end
 
-    def print_collection(fields, collection)
+    def print_collection(fields, collection, options = {})
       raise NotImplementedError
     end
 
-    def reset_context
-      @context.delete(:fields)
-    end
-
     protected
 
     def filter_fields(fields)

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

@@ -14,7 +14,7 @@ module HammerCLI::Output::Adapter
       print_collection(fields, [record].flatten(1))
     end
 
-    def print_collection(fields, collection)
+    def print_collection(fields, collection, options = {})
       collection.each do |data|
         output_stream.puts render_fields(fields, data)
         output_stream.puts

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

@@ -149,7 +149,8 @@ module HammerCLI::Output::Adapter
       print_collection(fields, [record].flatten(1))
     end
 
-    def print_collection(fields, collection)
+    def print_collection(fields, collection, options = {})
+      current_chunk = options[:current_chunk] || :single
       fields = filter_fields(fields).filter_by_classes
                                     .filter_by_sets
                                     .filter_by_data(collection.first,
@@ -161,7 +162,7 @@ module HammerCLI::Output::Adapter
       # or use headers from output definition
       headers ||= default_headers(fields)
       csv_string = generate do |csv|
-        csv << headers if headers && !@context[:no_headers]
+        csv << headers if headers && !@context[:no_headers] && %i[first single].include?(current_chunk)
         rows.each do |row|
           csv << Cell.values(headers, row)
         end

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

@@ -6,9 +6,20 @@ module HammerCLI::Output::Adapter
       output_stream.puts JSON.pretty_generate(result.first)
     end
 
-    def print_collection(fields, collection)
-      result = prepare_collection(fields, collection)
-      output_stream.puts JSON.pretty_generate(result)
+    def print_collection(fields, collection, options = {})
+      current_chunk = options[:current_chunk] || :single
+      prepared = prepare_collection(fields, collection)
+      result = JSON.pretty_generate(prepared)
+      if current_chunk != :single
+        result = if current_chunk == :first
+                   result[0...-2] + ','
+                 elsif current_chunk == :last
+                   result[2..-1]
+                 else
+                   result[2...-2] + ','
+                 end
+      end
+      output_stream.puts result
     end
 
     def print_message(msg, msg_params={})

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

@@ -12,7 +12,7 @@ module HammerCLI::Output::Adapter
     def print_record(fields, record)
     end
 
-    def print_collection(fields, collection)
+    def print_collection(fields, collection, options = {})
     end
 
   end

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

@@ -2,6 +2,11 @@ require File.join(File.dirname(__FILE__), 'wrapper_formatter')
 
 module HammerCLI::Output::Adapter
   class Table < Abstract
+    def initialize(context = {}, formatters = {}, filters = {})
+      super
+      @printed = 0
+    end
+
     def features
       return %i[rich_text serialized inline] if tags.empty?
 
@@ -12,7 +17,8 @@ module HammerCLI::Output::Adapter
       print_collection(fields, [record].flatten(1))
     end
 
-    def print_collection(all_fields, collection)
+    def print_collection(all_fields, collection, options = {})
+      current_chunk = options[:current_chunk] || :single
       fields = filter_fields(all_fields).filter_by_classes
                                         .filter_by_sets
                                         .filter_by_data(collection.first,
@@ -27,13 +33,26 @@ module HammerCLI::Output::Adapter
       table_gen = HammerCLI::Output::Generators::Table.new(
         columns, formatted_collection, no_headers: @context[:no_headers]
       )
-      output_stream.print(table_gen.result)
 
-      if collection.respond_to?(:meta) && collection.meta.pagination_set? &&
-         @context[:verbosity] >= collection.meta.pagination_verbosity &&
-         collection.count < collection.meta.subtotal
-        pages = (collection.meta.subtotal.to_f / collection.meta.per_page).ceil
-        puts _("Page %{page} of %{total} (use --page and --per-page for navigation).") % {:page => collection.meta.page, :total => pages}
+      meta = collection.respond_to?(:meta) ? collection.meta : nil
+
+      output_stream.print(table_gen.header) if %i[first single].include?(current_chunk)
+
+      output_stream.print(table_gen.body)
+
+      @printed += collection.count
+
+      # print closing line only after the last chunk
+      output_stream.print(table_gen.footer) if %i[last single].include?(current_chunk)
+
+      return unless meta && meta.pagination_set?
+
+      leftovers = %i[last single].include?(current_chunk) && @printed < meta.subtotal
+      if @context[:verbosity] >= meta.pagination_verbosity &&
+         collection.count < meta.subtotal &&
+         leftovers
+        pages = (meta.subtotal.to_f / meta.per_page).ceil
+        puts _("Page %{page} of %{total} (use --page and --per-page for navigation).") % {:page => meta.page, :total => pages}
       end
     end
 

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

@@ -6,9 +6,12 @@ module HammerCLI::Output::Adapter
       output_stream.puts YAML.dump(result.first)
     end
 
-    def print_collection(fields, collection)
-      result = prepare_collection(fields, collection)
-      output_stream.puts YAML.dump(result)
+    def print_collection(fields, collection, options = {})
+      current_chunk = options[:current_chunk] || :single
+      prepared = prepare_collection(fields, collection)
+      result = YAML.dump(prepared)
+      result = result[4..-1] unless %i[first single].include?(current_chunk)
+      output_stream.puts result
     end
 
     def print_message(msg, msg_params={})

data/lib/hammer_cli/output/output.rb

@@ -25,15 +25,13 @@ module HammerCLI::Output
 
     def print_record(definition, record)
       adapter.print_record(definition.fields, record) if appropriate_verbosity?(:record)
-      adapter.reset_context
     end
 
-    def print_collection(definition, collection)
+    def print_collection(definition, collection, options = {})
       unless collection.class <= HammerCLI::Output::RecordCollection
         collection = HammerCLI::Output::RecordCollection.new([collection].flatten(1))
       end
-      adapter.print_collection(definition.fields, collection) if appropriate_verbosity?(:collection)
-      adapter.reset_context
+      adapter.print_collection(definition.fields, collection, options) if appropriate_verbosity?(:collection)
     end
 
     def adapter

data/lib/hammer_cli/settings.rb

@@ -66,7 +66,8 @@ module HammerCLI
 
     def self.default_settings
       {
-        :use_defaults => true
+        :use_defaults => true,
+        :completion_cache_file => '~/.cache/hammer_completion.yml'
       }
     end
 

data/lib/hammer_cli/utils.rb

@@ -60,6 +60,11 @@ module HammerCLI
     STDOUT.tty?
   end
 
+  def self.clear_cache
+    cache_file = File.expand_path(HammerCLI::Settings.get(:completion_cache_file))
+    File.delete(cache_file) if File.exist?(cache_file)
+  end
+
   def self.interactive?
     return HammerCLI::Settings.get(:_params, :interactive) unless HammerCLI::Settings.get(:_params, :interactive).nil?
     HammerCLI::Settings.get(:ui, :interactive) != false

data/lib/hammer_cli/version.rb

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

data/test/unit/apipie/api_connection_test.rb

@@ -30,6 +30,7 @@ describe HammerCLI::Apipie::ApiConnection do
       it "logs message when logger is available" do
         logger = stub()
         logger.expects(:debug).with('Apipie cache was cleared')
+        logger.expects(:debug).with('Completion cache was cleared')
 
         api_stub.expects(:clean_cache)
         HammerCLI::Apipie::ApiConnection.new(empty_params, :reload_cache => true, :logger => logger)

data/test/unit/bash_test.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe HammerCLI::Bash::Completion do
+  describe '#complete' do
+    let(:dict) do
+      {
+        'host' => {
+          'create' => {
+            '--installed-products-attributes' => { type: :schema, schema: '"product_id=string\,product_name=string\,arch=string\,version=string, ... "' },
+            '--help' => { type: :flag },
+            '--build' => { type: :flag },
+            '--managed' => { type: :enum, values: %w[yes no] },
+            '--volume' => { type: :multienum, values: %w[first second third] },
+            '--config-group-ids' => { type: :list },
+            '--params' => { type: :key_value_list },
+            '--log' => { type: :file, filter: '.*\.log$' },
+            '--pool' => { type: :directory },
+            '-t' => { type: :value },
+            :params => [{ type: :directory }, { type: :value }, { type: :file }]
+          },
+          '--dry' => { type: :flag },
+          '--help' => { type: :flag },
+        },
+        '--interactive' => { type: :enum, values: %w[yes no] },
+        '--help' => { type: :flag },
+        '-h' => { type: :flag }
+      }
+    end
+
+    subject do
+      HammerCLI::Bash::Completion.new(JSON.load(dict.to_json))
+    end
+
+    it 'returns options when no input given' do
+      result = subject.complete('').sort
+      result.must_equal ['host ', '--interactive ', '--help ', '-h '].sort
+    end
+
+    it 'returns filtered options when partial input is given' do
+      result = subject.complete('-').sort
+      result.must_equal ['--help ', '-h ', '--interactive '].sort
+    end
+
+    it 'returns filtered options when partial input is given' do
+      result = subject.complete('host')
+      result.must_equal ['host ']
+    end
+
+    it 'returns options when subcommand is given' do
+      result = subject.complete('host ').sort
+      result.must_equal ['create ', '--help ', '--dry '].sort
+    end
+
+    it 'returns no options when subcommand is wrong' do
+      result = subject.complete('unknown -h')
+      result.must_equal []
+    end
+
+    it 'returns no options when there are no other params allowed' do
+      result = subject.complete('host create /tmp some /tmp extra')
+      result.must_equal []
+    end
+
+    it 'return hint for option-value pair without value' do
+      result = subject.complete('host create -t ')
+      result.must_equal ['--->', 'Add option <value>']
+    end
+
+    it 'return no options for option-value pair without complete value' do
+      result = subject.complete('host create -t x')
+      result.must_equal []
+    end
+
+    # multiple options in one subcommand
+    it 'allows mutiple options of the same subcommand' do
+      result = subject.complete('host create --build --he')
+      result.must_equal ['--help ']
+    end
+
+    # multiple options with values in one subcommand
+    it 'allows mutiple options with values of the same subcommand' do
+      result = subject.complete('host create -t value --he')
+      result.must_equal ['--help ']
+    end
+
+    # subcommand after options
+    it 'allows subcommand after options' do
+      result = subject.complete('host --dry crea')
+      result.must_equal ['create ']
+    end
+
+    describe 'completion by type' do
+      it 'completes :value' do
+        result = subject.complete('host create -t ')
+        result.must_equal ['--->', 'Add option <value>']
+      end
+
+      it 'completes :flag' do
+        result = subject.complete('host --h')
+        result.must_equal ['--help ']
+      end
+
+      it 'completes :schema' do
+        result = subject.complete('host create --installed-products-attributes ')
+        result.must_equal ["--->", 'Add value by following schema: "product_id=string\,product_name=string\,arch=string\,version=string, ... "']
+      end
+
+      it 'completes :enum' do
+        result = subject.complete('host create --managed ')
+        result.must_equal ['yes ', 'no ']
+      end
+
+      it 'completes :multienum' do
+        result = subject.complete('host create --volume ')
+        result.must_equal ['first', 'second', 'third']
+
+        result = subject.complete('host create --volume fir')
+        result.must_equal ['first']
+
+        result = subject.complete('host create --volume first,')
+        result.must_equal ['second', 'third']
+
+        result = subject.complete('host create --volume first,se')
+        result.must_equal ['first,second']
+      end
+
+      it 'completes :list' do
+        result = subject.complete('host create --config-group-ids ')
+        result.must_equal ['--->', 'Add comma-separated list of values']
+      end
+
+      it 'completes :key_value_list' do
+        result = subject.complete('host create --params ')
+        result.must_equal ['--->', 'Add comma-separated list of key=value']
+      end
+    end
+  end
+end