hammer_cli 0.15.1 → 0.16.0

data/test/unit/output/adapter/base_test.rb

@@ -241,6 +241,11 @@ describe HammerCLI::Output::Adapter::Base do
 
     end
 
+    context 'print_message' do
+      it 'should print message with nil params' do
+        proc { adapter.print_message('MESSAGE', nil) }.must_output(/.*MESSAGE.*/, '')
+      end
+    end
   end
 
 end

data/test/unit/output/adapter/csv_test.rb

@@ -257,6 +257,9 @@ describe HammerCLI::Output::Adapter::CSValues do
       }.must_output("Message,Id,Name\nSOME MESSAGE,83,new_record\n", "")
     end
 
+    it 'should print message with nil params' do
+      proc { adapter.print_message('MESSAGE', nil) }.must_output("Message\nMESSAGE\n", '')
+    end
   end
 
 end

data/test/unit/output/adapter/json_test.rb

@@ -37,6 +37,18 @@ describe HammerCLI::Output::Adapter::Json do
 
       proc { adapter.print_message(msg, params) }.must_output(expected_output)
     end
+
+    it 'prints the message with nil params' do
+      params = nil
+      msg = 'MESSAGE'
+      expected_output = [
+        '{',
+        '  "message": "MESSAGE"',
+        '}',
+        ''
+      ].join("\n")
+      proc { adapter.print_message(msg, params) }.must_output(expected_output)
+    end
   end
 
   context "print_collection" do

data/test/unit/output/adapter/table_test.rb

@@ -410,6 +410,11 @@ describe HammerCLI::Output::Adapter::Table do
 
     end
 
+    context 'print_message' do
+      it 'should print message with nil params' do
+        proc { adapter.print_message('MESSAGE', nil) }.must_output(/.*MESSAGE.*/, '')
+      end
+    end
   end
 
 end

data/test/unit/output/adapter/yaml_test.rb

@@ -35,6 +35,17 @@ describe HammerCLI::Output::Adapter::Yaml do
 
       proc { adapter.print_message(msg, params) }.must_output(expected_output)
     end
+
+    it 'prints the message with nil params' do
+      params = nil
+      msg = 'MESSAGE'
+      expected_output = [
+        '---',
+        ':message: MESSAGE',
+        ''
+      ].join("\n")
+      proc { adapter.print_message(msg, params) }.must_output(expected_output)
+    end
   end
 
   context "print_collection" do

data/test/unit/output/definition_test.rb

@@ -7,6 +7,10 @@ describe HammerCLI::Output::Definition do
   let(:definition) { HammerCLI::Output::Definition.new }
   let(:last_field) { definition.fields[-1] }
   let(:field_count) { definition.fields.length }
+  let(:new_field) { Fields::Field.new(label: 'newfield', id: :new_id) }
+  let(:label_field) { Fields::Label.new(label: 'labelfield') }
+  let(:cont_field) { Fields::ContainerField.new(id: :id1) }
+
 
   describe "empty?" do
 
@@ -36,5 +40,221 @@ describe HammerCLI::Output::Definition do
     definition.fields.must_equal another_def.fields
   end
 
-end
+  it 'clear should delete all fields' do
+    definition.fields << Fields::Field.new
+    definition.clear
+    definition.empty?.must_equal true
+  end
+
+  describe 'insert' do
+    let(:new_fields) { [new_field, new_field] }
+
+    describe 'before' do
+      it 'should not insert field if output definition is empty' do
+        definition.clear
+        assert_raises ArgumentError do
+          definition.insert(:before, :id1, new_field)
+        end
+
+        field_count.must_equal 0
+      end
+
+      it 'should insert new specified field before the old one' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:before, :id1, new_field)
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 2
+      end
+
+      it 'should insert before field with few new specified' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:before, :id1, new_fields)
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 3
+      end
+
+      it 'should accept block with new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:before, :id1) do
+          field nil, 'newfield'
+          field nil, 'newfield2'
+        end
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 3
+      end
+
+      it 'should accept both block and new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:before, :id1, new_fields) do
+          field nil, 'newfield3'
+          field nil, 'newfield4'
+        end
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 5
+      end
 
+      it 'should work with labels' do
+        label_field.output_definition.fields << new_field
+        definition.fields << label_field
+        definition.insert(:before, label_field.label, new_fields)
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 3
+      end
+    end
+
+    describe 'after' do
+      it 'should not insert field if output definition is empty' do
+        definition.clear
+        assert_raises ArgumentError do
+          definition.insert(:after, :id1, new_field)
+        end
+
+        field_count.must_equal 0
+      end
+
+      it 'should insert new specified field after the old one' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:after, :id1, new_field)
+
+        definition.fields.first.label.must_equal 'oldfield'
+        field_count.must_equal 2
+      end
+
+      it 'should insert after field with few new specified' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:after, :id1, new_fields)
+
+        definition.fields.first.label.must_equal 'oldfield'
+        field_count.must_equal 3
+      end
+
+      it 'should accept block with new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:after, :id1) do
+          field nil, 'newfield'
+          field nil, 'newfield2'
+        end
+
+        definition.fields.first.label.must_equal 'oldfield'
+        field_count.must_equal 3
+      end
+
+      it 'should accept both block and new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:after, :id1, new_fields) do
+          field nil, 'newfield3'
+          field nil, 'newfield4'
+        end
+
+        definition.fields.first.label.must_equal 'oldfield'
+        field_count.must_equal 5
+      end
+
+      it 'should work with labels' do
+        label_field.output_definition.fields << new_field
+        definition.fields << label_field
+        definition.insert(:after, label_field.label, new_fields)
+
+        definition.fields.first.label.must_equal label_field.label
+        field_count.must_equal 3
+      end
+    end
+
+    describe 'replace' do
+      it 'should not replace field if output definition is empty' do
+        definition.clear
+        assert_raises ArgumentError do
+          definition.insert(:replace, :id1, new_field)
+        end
+
+        field_count.must_equal 0
+      end
+
+      it 'should replace field with new specified' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:replace, :id1, new_field)
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 1
+      end
+
+      it 'should replace field with few new specified' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:replace, :id1, new_fields)
+
+        definition.fields.first.label.must_equal new_field.label
+        field_count.must_equal 2
+      end
+
+      it 'should accept block with new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:replace, :id1) do
+          field nil, 'newfield'
+          field nil, 'newfield2'
+        end
+
+        definition.fields.first.label.must_equal new_field.label
+      end
+
+      it 'should accept both block and new fields' do
+        definition.fields << Fields::Field.new(id: :id1, label: 'oldfield')
+        definition.insert(:replace, :id1, new_fields) do
+          field nil, 'newfield3'
+          field nil, 'newfield4'
+        end
+
+        field_count.must_equal 4
+      end
+
+      it 'should work with labels' do
+        label_field.output_definition.fields << new_field
+        definition.fields << label_field
+        definition.insert(:replace, label_field.label, new_fields)
+
+        field_count.must_equal 2
+      end
+    end
+  end
+
+  describe 'find_field' do
+    it 'should find a field' do
+      definition.fields += [new_field, label_field]
+      definition.find_field(:new_id).must_equal new_field
+    end
+
+    it 'should find a field in field output definition' do
+      definition.fields += [label_field, cont_field]
+      nested_definition = definition.find_field(:id1).output_definition
+      nested_definition.fields << new_field
+      nested_definition.find_field(:new_id).must_equal new_field
+    end
+  end
+
+  describe 'at' do
+    it 'should return self if no specified path or empty' do
+      definition.at.must_equal definition
+      definition.at([]).must_equal definition
+    end
+
+    it 'should return output definition of specified field with path' do
+      cont_field.output_definition.fields << new_field
+      definition.fields << cont_field
+      path = [cont_field.id]
+
+      definition.at(path).must_equal cont_field.output_definition
+    end
+
+    it 'should work with labels' do
+      label_field.output_definition.fields << new_field
+      definition.fields << label_field
+      path = ['labelfield']
+
+      definition.at(path).must_equal label_field.output_definition
+    end
+  end
+end

data/test/unit/utils_test.rb

@@ -169,4 +169,27 @@ describe HammerCLI do
     end
   end
 
+  describe 'insert_relative' do
+    let(:arr) { [:a, :b, :c] }
+
+    it 'appends' do
+      HammerCLI.insert_relative(arr, :append, nil, 1, 2, 3)
+      assert_equal(arr, [:a, :b, :c, 1, 2, 3])
+    end
+
+    it 'prepends' do
+      HammerCLI.insert_relative(arr, :prepend, nil, 1, 2, 3)
+      assert_equal(arr, [1, 2, 3, :a, :b, :c])
+    end
+
+    it 'inserts after index' do
+      HammerCLI.insert_relative(arr, :after, 1, 1, 2, 3)
+      assert_equal(arr, [:a, :b, 1, 2, 3, :c])
+    end
+
+    it 'inserts before index' do
+      HammerCLI.insert_relative(arr, :before, 1, 1, 2, 3)
+      assert_equal(arr, [:a, 1, 2, 3, :b, :c])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -154,6 +154,7 @@ extra_rdoc_files:
 - doc/design.png
 - doc/option_normalizers.md
 - doc/release_notes.md
+- doc/commands_modification.md
 - doc/creating_commands.md
 - doc/development_tips.md
 - doc/developer_docs.md
@@ -162,6 +163,7 @@ extra_rdoc_files:
 - doc/installation_rpm.md
 - doc/i18n.md
 - doc/installation.md
+- doc/help_modification.md
 - doc/installation_source.md
 - doc/design.uml
 - doc/installation_gem.md
@@ -176,12 +178,14 @@ files:
 - bin/hammer
 - config/cli.modules.d/module_config_template.yml
 - config/cli_config.template.yml
+- doc/commands_modification.md
 - doc/creating_apipie_commands.md
 - doc/creating_commands.md
 - doc/design.png
 - doc/design.uml
 - doc/developer_docs.md
 - doc/development_tips.md
+- doc/help_modification.md
 - doc/i18n.md
 - doc/installation.md
 - doc/installation_deb.md
@@ -216,6 +220,11 @@ files:
 - lib/hammer_cli/exit_codes.rb
 - lib/hammer_cli/full_help.rb
 - lib/hammer_cli/help/builder.rb
+- lib/hammer_cli/help/definition.rb
+- lib/hammer_cli/help/definition/abstract_item.rb
+- lib/hammer_cli/help/definition/list.rb
+- lib/hammer_cli/help/definition/section.rb
+- lib/hammer_cli/help/definition/text.rb
 - lib/hammer_cli/help/text_builder.rb
 - lib/hammer_cli/i18n.rb
 - lib/hammer_cli/i18n/find_task.rb
@@ -229,8 +238,14 @@ files:
 - lib/hammer_cli/options/normalizers.rb
 - lib/hammer_cli/options/option_collector.rb
 - lib/hammer_cli/options/option_definition.rb
+- lib/hammer_cli/options/option_processor.rb
+- lib/hammer_cli/options/processor_list.rb
+- lib/hammer_cli/options/sources/base.rb
 - lib/hammer_cli/options/sources/command_line.rb
 - lib/hammer_cli/options/sources/saved_defaults.rb
+- lib/hammer_cli/options/validators/base.rb
+- lib/hammer_cli/options/validators/dsl.rb
+- lib/hammer_cli/options/validators/dsl_block_validator.rb
 - lib/hammer_cli/output.rb
 - lib/hammer_cli/output/adapter.rb
 - lib/hammer_cli/output/adapter/abstract.rb
@@ -259,7 +274,6 @@ files:
 - lib/hammer_cli/testing/messages.rb
 - lib/hammer_cli/testing/output_matchers.rb
 - lib/hammer_cli/utils.rb
-- lib/hammer_cli/validator.rb
 - lib/hammer_cli/verbosity.rb
 - lib/hammer_cli/version.rb
 - locale/ca/LC_MESSAGES/hammer-cli.mo
@@ -439,6 +453,11 @@ files:
 - test/unit/fixtures/json_input/invalid.json
 - test/unit/fixtures/json_input/valid.json
 - test/unit/help/builder_test.rb
+- test/unit/help/definition/abstract_item_test.rb
+- test/unit/help/definition/list_test.rb
+- test/unit/help/definition/section_test.rb
+- test/unit/help/definition/text_test.rb
+- test/unit/help/definition_test.rb
 - test/unit/help/text_builder_test.rb
 - test/unit/history_test.rb
 - test/unit/i18n_test.rb
@@ -451,8 +470,10 @@ files:
 - test/unit/options/normalizers_test.rb
 - test/unit/options/option_collector_test.rb
 - test/unit/options/option_definition_test.rb
+- test/unit/options/processor_list_test.rb
 - test/unit/options/sources/command_line_test.rb
 - test/unit/options/sources/saved_defaults_test.rb
+- test/unit/options/validators/dsl_test.rb
 - test/unit/output/adapter/abstract_test.rb
 - test/unit/output/adapter/base_test.rb
 - test/unit/output/adapter/csv_test.rb
@@ -469,7 +490,6 @@ files:
 - test/unit/settings_test.rb
 - test/unit/test_helper.rb
 - test/unit/utils_test.rb
-- test/unit/validator_test.rb
 homepage: https://github.com/theforeman/hammer-cli
 licenses:
 - GPL-3.0
@@ -635,8 +655,13 @@ test_files:
 - test/unit/utils_test.rb
 - test/unit/settings_test.rb
 - test/unit/modules_test.rb
+- test/unit/help/definition/abstract_item_test.rb
+- test/unit/help/definition/list_test.rb
+- test/unit/help/definition/text_test.rb
+- test/unit/help/definition/section_test.rb
 - test/unit/help/builder_test.rb
 - test/unit/help/text_builder_test.rb
+- test/unit/help/definition_test.rb
 - test/unit/abstract_test.rb
 - test/unit/i18n_test.rb
 - test/unit/logger_test.rb
@@ -664,12 +689,13 @@ test_files:
 - test/unit/apipie/command_test.rb
 - test/unit/apipie/option_builder_test.rb
 - test/unit/apipie/test_helper.rb
-- test/unit/validator_test.rb
 - test/unit/options/option_collector_test.rb
 - test/unit/options/sources/saved_defaults_test.rb
 - test/unit/options/sources/command_line_test.rb
 - test/unit/options/normalizers_test.rb
+- test/unit/options/validators/dsl_test.rb
 - test/unit/options/option_definition_test.rb
+- test/unit/options/processor_list_test.rb
 - test/unit/options/matcher_test.rb
 - test/unit/option_builder_test.rb
 - test/unit/fixtures/certs/non_ca_cert.pem