hammer_cli 2.5.0 → 3.1.0

data/test/unit/help/builder_test.rb

@@ -21,6 +21,24 @@ describe HammerCLI::Help::Builder do
         ' --zzz-option OPT_Z            Some description'
       ].join("\n")
     end
+
+    it 'prints long option descriptions aligned' do
+      opt_a_desc = 'AAAAAAA ' * 20
+      opt_b_desc = 'BBBBBBB ' * 20
+      options = [
+        Clamp::Option::Definition.new(['--aaa-option'], 'OPT_A', opt_a_desc),
+        Clamp::Option::Definition.new(['--bbb-option'], 'OPT_B', opt_b_desc)
+      ]
+      help.add_list('Options', options)
+
+      help.string.strip.must_equal [
+        'Options:',
+        ' --aaa-option OPT_A            %s' % ('AAAAAAA ' * 10).strip,
+        '                               %s' % ('AAAAAAA ' * 10).strip,
+        ' --bbb-option OPT_B            %s' % ('BBBBBBB ' * 10).strip,
+        '                               %s' % ('BBBBBBB ' * 10).strip
+      ].join("\n")
+    end
   end
 
   describe 'adding an option with lower case description' do
@@ -86,8 +104,8 @@ describe HammerCLI::Help::Builder do
 
       help.string.strip.must_equal [
         'Options:',
-        ' --option[-yyy|-bbb]           Some description',
-        ' --option[-aaa|-zzz]           Some description',
+        ' --option[-yyy|-bbb] VALUE     Some description',
+        ' --option[-aaa|-zzz] VALUE     Some description'
       ].join("\n")
     end
   end

data/test/unit/options/option_definition_test.rb

@@ -25,6 +25,10 @@ describe HammerCLI::Options::OptionDefinition do
     option "--another-deprecated", "OLD_OPTION", "Test old option",
       :context_target => :old_option,
       :deprecated => "It is going to be removed"
+
+    def find_option(switch)
+      super(switch)
+    end
   end
 
   def opt_with_deprecation(deprecation)
@@ -73,6 +77,14 @@ describe HammerCLI::Options::OptionDefinition do
       context[:test_option].must_equal "VALUE"
     end
 
+    it "doesn't print deprecation warning if the option is not used" do
+      context = {}
+      cmd = TestDeprecatedOptionCmd.new('', context)
+      cmd.find_option('--deprecated')
+      _out, err = capture_io { cmd.run([]) }
+      err.must_equal ''
+    end
+
     it 'shows depracated message in help' do
       opt = opt_with_deprecation("Use --better-switch instead")
       opt.description.must_equal "Test option (Deprecated: Use --better-switch instead)"
@@ -98,4 +110,3 @@ describe HammerCLI::Options::OptionDefinition do
     end
   end
 end
-

data/test/unit/output/definition_test.rb

@@ -269,9 +269,9 @@ describe HammerCLI::Output::Definition do
       sets_table = "---------|-----|---------|----\n" \
                    "FIELDS   | ALL | DEFAULT | SET\n" \
                    "---------|-----|---------|----\n" \
-                   "newfield | x   | x       |    \n" \
-                   "cf/abc   |     |         | x  \n" \
-                   "cf/bca   |     |         | x  \n" \
+                   "Newfield | x   | x       |    \n" \
+                   "Cf/abc   |     |         | x  \n" \
+                   "Cf/bca   |     |         | x  \n" \
                    "---------|-----|---------|----\n"
 
       definition.sets_table.must_equal sets_table

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -152,30 +152,30 @@ executables:
 - hammer-complete
 extensions: []
 extra_rdoc_files:
-- doc/commands_modification.md
 - doc/creating_apipie_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_deb.md
 - doc/installation_gem.md
 - doc/option_builders.md
 - doc/option_normalizers.md
-- doc/output.md
-- doc/review_checklist.md
 - doc/writing_a_plugin.md
-- doc/commands_extension.md
-- doc/creating_commands.md
-- doc/installation_rpm.md
 - doc/installation_source.md
-- doc/installation.md
 - doc/release_notes.md
+- doc/commands_extension.md
+- doc/commands_modification.md
+- doc/developer_docs.md
+- doc/help_modification.md
+- doc/installation.md
+- doc/installation_rpm.md
+- doc/output.md
+- doc/review_checklist.md
+- doc/creating_commands.md
 - config/cli.modules.d/module_config_template.yml
-- config/hammer.completion
 - config/cli_config.template.yml
+- config/hammer.completion
 - README.md
 files:
 - LICENSE
@@ -394,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Universal command-line interface
@@ -404,18 +404,16 @@ test_files:
 - test/functional/nil_values_test.rb
 - test/functional/test_helper.rb
 - test/test_helper.rb
-- test/unit/apipie/api_connection_test.rb
 - test/unit/apipie/command_test.rb
 - test/unit/apipie/option_definition_test.rb
 - test/unit/apipie/test_helper.rb
+- test/unit/apipie/api_connection_test.rb
 - test/unit/apipie/option_builder_test.rb
-- test/unit/bash_test.rb
 - test/unit/ca_cert_manager_test.rb
 - test/unit/completer_test.rb
 - test/unit/connection_test.rb
 - test/unit/csv_parser_test.rb
 - test/unit/defaults_test.rb
-- test/unit/exception_handler_test.rb
 - test/unit/fixtures/apipie/architectures.json
 - test/unit/fixtures/apipie/documented.json
 - test/unit/fixtures/certs/ca_cert.pem
@@ -425,9 +423,9 @@ test_files:
 - test/unit/fixtures/json_input/invalid.json
 - test/unit/fixtures/json_input/valid.json
 - test/unit/help/definition/abstract_item_test.rb
+- test/unit/help/definition/section_test.rb
 - test/unit/help/definition/list_test.rb
 - test/unit/help/definition/note_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
@@ -440,14 +438,14 @@ test_files:
 - test/unit/modules_test.rb
 - test/unit/option_builder_test.rb
 - test/unit/options/matcher_test.rb
-- 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/options/normalizers_test.rb
 - test/unit/options/option_family_test.rb
+- test/unit/options/option_definition_test.rb
 - test/unit/output/adapter/abstract_test.rb
 - test/unit/output/adapter/base_test.rb
 - test/unit/output/adapter/csv_test.rb
@@ -455,14 +453,16 @@ test_files:
 - test/unit/output/adapter/table_test.rb
 - test/unit/output/adapter/yaml_test.rb
 - test/unit/output/dsl_test.rb
-- test/unit/output/field_filter_test.rb
 - test/unit/output/fields_test.rb
-- test/unit/output/formatters_test.rb
-- test/unit/output/output_test.rb
 - test/unit/output/record_collection_test.rb
 - test/unit/output/definition_test.rb
+- test/unit/output/field_filter_test.rb
+- test/unit/output/formatters_test.rb
+- test/unit/output/output_test.rb
 - test/unit/settings_test.rb
 - test/unit/test_helper.rb
 - test/unit/utils_test.rb
+- test/unit/bash_test.rb
+- test/unit/exception_handler_test.rb
 - test/unit/abstract_test.rb
 - test/unit/command_extensions_test.rb