hammer_cli 0.11.0 → 0.12.0

data/lib/hammer_cli/options/normalizers.rb

@@ -5,7 +5,6 @@ module HammerCLI
   module Options
     module Normalizers
 
-
       class AbstractNormalizer
         def description
           ""
@@ -20,6 +19,11 @@ module HammerCLI
         end
       end
 
+      class Default < AbstractNormalizer
+        def format(value)
+          value
+        end
+      end
 
       class KeyValueList < AbstractNormalizer
 
@@ -27,7 +31,7 @@ module HammerCLI
         FULL_RE = "^((%s)[,]?)+$" % PAIR_RE
 
         def description
-          _("Comma-separated list of key=value.")
+          _("Comma-separated list of key=value")
         end
 
         def format(val)
@@ -41,7 +45,7 @@ module HammerCLI
               formatter = JSONInput.new
               formatter.format(val)
             rescue ArgumentError
-              raise ArgumentError, _("value must be defined as a comma-separated list of key=value or valid JSON")
+              raise ArgumentError, _("Value must be defined as a comma-separated list of key=value or valid JSON.")
             end
           end
         end
@@ -97,7 +101,7 @@ module HammerCLI
           if numeric?(val)
             val.to_i
           else
-            raise ArgumentError, _("numeric value is required")
+            raise ArgumentError, _("Numeric value is required.")
           end
         end
 
@@ -111,7 +115,7 @@ module HammerCLI
       class Bool < AbstractNormalizer
 
         def description
-          _("One of true/false, yes/no, 1/0.")
+          _("One of true/false, yes/no, 1/0")
         end
 
         def format(bool)
@@ -121,7 +125,7 @@ module HammerCLI
           elsif bool.downcase.match(/^(false|f|no|n|0)$/i)
             return false
           else
-            raise ArgumentError, _("value must be one of true/false, yes/no, 1/0")
+            raise ArgumentError, _("Value must be one of true/false, yes/no, 1/0.")
           end
         end
 
@@ -160,7 +164,7 @@ module HammerCLI
           ::JSON.parse(json_string)
 
         rescue ::JSON::ParserError => e
-          raise ArgumentError, _("Unable to parse JSON input")
+          raise ArgumentError, _("Unable to parse JSON input.")
         end
 
       end
@@ -182,9 +186,9 @@ module HammerCLI
             value
           else
             if allowed_values.count == 1
-              msg = _("value must be %s") % quoted_values
+              msg = _("Value must be %s.") % quoted_values
             else
-              msg = _("value must be one of %s") % quoted_values
+              msg = _("Value must be one of %s.") % quoted_values
             end
             raise ArgumentError, msg
           end
@@ -212,7 +216,7 @@ module HammerCLI
           raise ArgumentError unless date
           ::DateTime.parse(date).to_s
         rescue ArgumentError
-          raise ArgumentError, _("'%s' is not a valid date") % date
+          raise ArgumentError, _("'%s' is not a valid date.") % date
         end
       end
 
@@ -243,7 +247,7 @@ module HammerCLI
         def parse(arr)
           arr.split(",").uniq.tap do |values|
             unless values.inject(true) { |acc, cur| acc & (@allowed_values.include? cur) }
-              raise ArgumentError, _("value must be a combination of '%s'") % quoted_values
+              raise ArgumentError, _("Value must be a combination of '%s'.") % quoted_values
             end
           end
         end

data/lib/hammer_cli/options/option_collector.rb

@@ -8,14 +8,28 @@ module HammerCLI
         @option_sources = option_sources
       end
 
-      def all_options
-        @all_options ||= @option_sources.inject({}) do |all_options, source|
+      def all_options_raw
+        @all_options_raw ||= @option_sources.inject({}) do |all_options, source|
           source.get_options(@recognised_options, all_options)
         end
       end
 
+      def all_options
+        @all_options ||= translate_nils(all_options_raw)
+      end
+
       def options
-        @options ||= all_options.reject {|key, value| value.nil? }
+        @options ||= all_options.reject { |key, value| value.nil? && all_options_raw[key].nil? }
+      end
+      
+      private
+      
+      def translate_nils(opts)
+        Hash[ opts.map { |k,v| [k, translate_nil(v)] } ]
+      end
+      
+      def translate_nil(value)
+        value == HammerCLI::NilValue ? nil : value
       end
     end
   end

data/lib/hammer_cli/options/option_definition.rb

@@ -2,6 +2,8 @@ require 'clamp'
 
 module HammerCLI
 
+  class NilValue; end
+
   def self.option_accessor_name(*name)
     if name.length > 1
       name.map { |n| _option_accessor_name(n) }
@@ -16,6 +18,8 @@ module HammerCLI
 
   module Options
 
+    NIL_SUBST = 'NIL'
+
     class OptionDefinition < Clamp::Option::Definition
 
       attr_accessor :value_formatter
@@ -23,18 +27,14 @@ module HammerCLI
       attr_accessor :deprecated_switches
 
       def initialize(switches, type, description, options = {})
-        self.value_formatter = options.delete(:format)
+        self.value_formatter = options.delete(:format) || HammerCLI::Options::Normalizers::Default.new
         self.context_target = options.delete(:context_target)
         self.deprecated_switches = options.delete(:deprecated)
         super
       end
 
       def complete(value)
-        if value_formatter.nil?
-          []
-        else
-          value_formatter.complete(value)
-        end
+        value_formatter.complete(value)
       end
 
       def help_lhs
@@ -84,11 +84,7 @@ module HammerCLI
       end
 
       def format_description
-        if value_formatter.nil?
-          ""
-        else
-          value_formatter.description
-        end
+        value_formatter.description
       end
 
       def value_description
@@ -98,26 +94,45 @@ module HammerCLI
         ].compact
 
         str = ""
-        str += _("Can be specified multiple times. ") if multivalued?
-        str += _("Default: ") + default_sources.join(_(", or ")) unless default_sources.empty?
+        if multivalued?
+          str += _("Can be specified multiple times.")
+          str += " "
+        end
+        unless default_sources.empty?
+          sep = _(", or")
+          sep += " "
+          str += _("Default:")
+          str += " "
+          str += default_sources.join(sep)
+        end
         str
       end
 
       def default_conversion_block
-        if !value_formatter.nil?
-          value_formatter.method(:format)
-        elsif flag?
+        if flag?
           Clamp.method(:truthy?)
+        else
+          self.method(:format_value)
+        end
+      end
+
+      def format_value(value)
+        if value == nil_subst
+          HammerCLI::NilValue
+        else
+          value_formatter.format(value)
         end
       end
 
+      def nil_subst
+        nil_subst = ENV['HAMMER_NIL'] || HammerCLI::Options::NIL_SUBST
+        raise _('Environment variable HAMMER_NIL can not be empty.') if nil_subst.empty?
+        nil_subst
+      end
+
       def default_value
         if defined?(@default_value)
-          if value_formatter
-            value_formatter.format(@default_value)
-          else
-            @default_value
-          end
+          value_formatter.format(@default_value)
         elsif multivalued?
           []
         end

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

@@ -163,7 +163,7 @@ module HammerCLI::Output::Adapter
       # or use headers from output definition
       headers ||= default_headers(fields)
       csv_string = generate do |csv|
-        csv << headers if headers
+        csv << headers if headers && !@context[:no_headers]
         rows.each do |row|
           csv << Cell.values(headers, row)
         end

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

@@ -35,10 +35,11 @@ module HammerCLI::Output::Adapter
       end
 
       line = hline_bits.join(LINE_SEPARATOR)
-
-      puts line
-      puts header_bits.join(COLUMN_SEPARATOR)
-      puts line
+      unless @context[:no_headers]
+        puts line
+        puts header_bits.join(COLUMN_SEPARATOR)
+        puts line
+      end
 
       formatted_collection.collect do |row|
         row_bits = fields.map do |f|
@@ -48,11 +49,12 @@ module HammerCLI::Output::Adapter
       end
 
       # print closing line only when the table isn't empty
-      puts line unless formatted_collection.empty?
+      # and there is no --no-headers option
+      puts line unless formatted_collection.empty? || @context[:no_headers]
 
       if collection.meta.pagination_set? && 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}
+        puts _("Page %{page} of %{total} (use --page and --per-page for navigation).") % {:page => collection.meta.page, :total => pages}
       end
     end
 

data/lib/hammer_cli/settings.rb

@@ -23,11 +23,6 @@ module HammerCLI
           Dir.glob(File.join(full_path, 'cli.modules.d/*.yml')).sort.each do |f|
             load_from_file(f)
           end
-          Dir.glob(File.join(full_path, 'hammer.modules.d/*.yml')).sort.each do |f|
-            warn _("Warning: location hammer.modules.d is deprecated, move your module configurations to cli.modules.d")
-            warn "    #{f} -> #{f.gsub('hammer.modules.d', 'cli.modules.d')}"
-            load_from_file(f)
-          end
         end
       end
     end
@@ -41,7 +36,7 @@ module HammerCLI
             path_history << file_path
           end
         rescue Exception => e
-          warn _("Warning: Couldn't load configuration file %{path}: %{message}") % { path: file_path, message: e.message }
+          warn _("Warning: Couldn't load configuration file %{path}: %{message}.") % { path: file_path, message: e.message }
         end
       end
     end

data/lib/hammer_cli/shell.rb

@@ -113,8 +113,8 @@ module HammerCLI
     end
 
     def print_welcome_message
-      print_message(_("Welcome to the hammer interactive shell"))
-      print_message(_("Type 'help' for usage information"))
+      print_message(_("Welcome to the hammer interactive shell."))
+      print_message(_("Type 'help' for usage information."))
     end
 
     def common_prefix(results)

data/lib/hammer_cli/ssloptions.rb

@@ -55,11 +55,11 @@ module HammerCLI
         options
       elsif options[:ssl_client_cert] || options[:ssl_client_key]
         if options[:ssl_client_cert]
-          warn _("SSL client certificate is set but the key is not")
+          warn _("SSL client certificate is set but the key is not.")
         elsif options[:ssl_client_key]
-          warn _("SSL client key is set but the certificate is not")
+          warn _("SSL client key is set but the certificate is not.")
         end
-        warn _("SSL client authentication disabled")
+        warn _("SSL client authentication disabled.")
         {}
       else
         {}
@@ -69,13 +69,13 @@ module HammerCLI
     def read_certificate(path)
       OpenSSL::X509::Certificate.new(File.read(path)) unless path.nil?
     rescue SystemCallError => e
-      warn _("Could't read SSL client certificate %s") % path
+      warn _("Could't read SSL client certificate %s.") % path
     end
 
     def read_key(path)
       OpenSSL::PKey::RSA.new(File.read(path)) unless path.nil?
     rescue SystemCallError => e
-      warn _("Could't read SSL client key %s") % path
+      warn _("Could't read SSL client key %s.") % path
     end
   end
 end

data/lib/hammer_cli/subcommand.rb

@@ -3,14 +3,34 @@ module HammerCLI
 
   module Subcommand
 
-    class LazyDefinition < Clamp::Subcommand::Definition
+    class Definition < Clamp::Subcommand::Definition
 
-      def initialize(names, description, subcommand_class_name, path)
+      def initialize(names, description, subcommand_class, options = {})
         @names = Array(names)
         @description = description
-        @subcommand_class_name = subcommand_class_name
-        @path = path
+        @subcommand_class = subcommand_class
+        @hidden = options[:hidden]
+        @warning = options[:warning]
+      end
+
+      def hidden?
+        @hidden
+      end
+
+      def subcommand_class
+        warn(@warning) if @warning
+        @subcommand_class
+      end
+
+      attr_reader :warning
+    end
+
+    class LazyDefinition < Definition
+
+      def initialize(names, description, subcommand_class_name, path, options = {})
+        super(names, description, subcommand_class_name, options)
         @loaded = false
+        @path = path
       end
 
       def loaded?
@@ -18,20 +38,22 @@ module HammerCLI
       end
 
       def subcommand_class
+        warn(@warning) if @warning
         if !@loaded
           require @path
           @loaded = true
-          @constantized_class = @subcommand_class_name.constantize
+          @constantized_class = @subcommand_class.constantize
         end
         @constantized_class
       end
-
     end
 
     def self.included(base)
       base.extend(ClassMethods)
     end
 
+
+
     module ClassMethods
       def remove_subcommand(name)
         self.recognised_subcommands.delete_if do |sc|
@@ -44,38 +66,41 @@ module HammerCLI
         end
       end
 
-      def subcommand!(name, description, subcommand_class = self, &block)
+      def subcommand!(name, description, subcommand_class = self, options = {}, &block)
         remove_subcommand(name)
-        subcommand(name, description, subcommand_class, &block)
+        subcommand(name, description, subcommand_class, options, &block)
         logger.info "subcommand #{name} (#{subcommand_class}) was created."
       end
 
-      def subcommand(name, description, subcommand_class = self, &block)
+      def subcommand(name, description, subcommand_class = self, options = {}, &block)
+        definition = Definition.new(name, description, subcommand_class, options)
+        define_subcommand(name, subcommand_class, definition, &block)
+      end
+
+      def lazy_subcommand(name, description, subcommand_class_name, path, options = {})
+        definition = LazyDefinition.new(name, description, subcommand_class_name, path, options)
+        define_subcommand(name, Class, definition)
+      end
+
+      def lazy_subcommand!(name, description, subcommand_class_name, path, options = {})
+        remove_subcommand(name)
+        self.lazy_subcommand(name, description, subcommand_class_name, path, options)
+        logger.info "subcommand #{name} (#{subcommand_class_name}) was created."
+      end
+
+      def define_subcommand(name, subcommand_class, definition, &block)
         existing = find_subcommand(name)
         if existing
-          raise HammerCLI::CommandConflict, _("can't replace subcommand %<name>s (%<existing_class>s) with %<name>s (%<new_class>s)") % {
+          raise HammerCLI::CommandConflict, _("Can't replace subcommand %<name>s (%<existing_class>s) with %<name>s (%<new_class>s).") % {
             :name => name,
             :existing_class => existing.subcommand_class,
             :new_class => subcommand_class
           }
         end
-        super
+        subcommand_class = Class.new(subcommand_class, &block) if block
+        declare_subcommand_parameters unless has_subcommands?
+        recognised_subcommands << definition
       end
-
-      def lazy_subcommand(name, description, subcommand_class, path)
-        # call original subcommand to ensure command's parameters are set correctly
-        # (hammer command SUBCOMMAND [ARGS] ...)
-        subcommand(name, description, Class)
-        # replace last subcommand definition with correct lazy-loaded one
-        recognised_subcommands[-1] = LazyDefinition.new(name, description, subcommand_class, path)
-      end
-
-      def lazy_subcommand!(name, description, subcommand_class, path)
-        remove_subcommand(name)
-        self.lazy_subcommand(name, description, subcommand_class, path)
-        logger.info "subcommand #{name} (#{subcommand_class}) was created."
-      end
-
     end
 
   end

data/lib/hammer_cli/testing/command_assertions.rb

@@ -71,13 +71,13 @@ module HammerCLI
         if heading.nil?
           ["Error: #{message}",
            "",
-           "See: '#{command} --help'",
+           "See: '#{command} --help'.",
            ""].join("\n")
         else
           ["#{heading}:",
            "  Error: #{message}",
            "  ",
-           "  See: '#{command} --help'",
+           "  See: '#{command} --help'.",
            ""].join("\n")
         end
       end

data/lib/hammer_cli/testing/messages.rb

@@ -0,0 +1,54 @@
+module HammerCLI
+  module Testing
+    module Messages
+      def get_subcommands(cmd)
+        return [] unless cmd.respond_to? :recognised_subcommands
+        cmd.recognised_subcommands.map { |c| c.subcommand_class }
+      end
+
+      def all_subcommands(cmd, parent=HammerCLI::AbstractCommand)
+        result = []
+        get_subcommands(cmd).each do |klass|
+          if klass < parent
+            result << klass
+            result += all_subcommands(klass, parent)
+          end
+        end
+        result
+      end
+
+      def assert_msg_period(cmd, method_name)
+        if cmd.respond_to?(method_name) && !cmd.send(method_name).nil?
+          assert(cmd.send(method_name).end_with?('.'), "#{cmd}.#{method_name} doesn't end with '.'")
+        end
+      end
+
+      def refute_msg_period(cmd, method_name)
+        if cmd.respond_to?(method_name) && !cmd.send(method_name).nil?
+          refute(cmd.send(method_name).end_with?('.'), "#{cmd}.#{method_name} ends with '.'")
+        end
+      end
+
+      def check_option_description(cmd, opt)
+        refute opt.description.end_with?('.'), "Description for option #{opt.long_switch} in #{cmd} ends with '.'"
+      end
+
+      def check_command_messages(cmd)
+        cmd.recognised_options.each do |opt|
+          check_option_description(cmd, opt)
+        end
+        refute_msg_period(cmd, :desc)
+        assert_msg_period(cmd, :success_message)
+        refute_msg_period(cmd, :failure_message)
+      end
+
+      def check_all_command_messages(main_cmd, parent=HammerCLI::AbstractCommand)
+        all_subcommands(main_cmd, parent).each do |cmd|
+          it "test messages of #{cmd}" do
+            check_command_messages(cmd)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli/validator.rb

@@ -38,7 +38,7 @@ module HammerCLI
 
       def get_option(name)
         name = name.to_s
-        raise _("Unknown option name '%s'") % name unless @options.has_key? name
+        raise _("Unknown option name '%s'.") % name unless @options.has_key? name
         @options[name]
       end
 
@@ -69,8 +69,8 @@ module HammerCLI
 
       def initialize(options, to_check)
         super(options, to_check)
-        @rejected_msg = _("You can't set all options %s at one time")
-        @required_msg = _("Options %s are required")
+        @rejected_msg = _("You can't set all options %s at one time.")
+        @required_msg = _("Options %s are required.")
       end
 
       def exist?
@@ -84,8 +84,8 @@ module HammerCLI
     class OneOptionConstraint < AllConstraint
       def initialize(options, to_check)
         super(options, [to_check])
-        @rejected_msg = _("You can't set option %s")
-        @required_msg = _("Option %s is required")
+        @rejected_msg = _("You can't set option %s.")
+        @required_msg = _("Option %s is required.")
       end
 
       def value
@@ -97,8 +97,8 @@ module HammerCLI
 
       def initialize(options, to_check)
         super(options, to_check)
-        @rejected_msg = _("You can't set any of options %s")
-        @required_msg = _("At least one of options %s is required")
+        @rejected_msg = _("You can't set any of options %s.")
+        @required_msg = _("At least one of options %s is required.")
       end
 
       def exist?
@@ -123,11 +123,11 @@ module HammerCLI
       def required_msg
         case count_present_options
         when 0
-          _("One of options %s is required")
+          _("One of options %s is required.")
         when 1
           ''
         else
-          _("Only one of options %s can be set")
+          _("Only one of options %s can be set.")
         end
       end
 

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new '0.11.0'
+    @version ||= Gem::Version.new '0.12.0'
   end
 end

data/test/functional/defaults_test.rb

@@ -15,18 +15,9 @@ describe 'commands' do
     end
   end
 
-  let(:defaults_path) { File.join(File.dirname(__FILE__), '../unit/fixtures/defaults/defaults.yml') }
-
   before do
-    settings = load_yaml(defaults_path)
-
-    @defaults = HammerCLI::Defaults.new(settings[:defaults], defaults_path)
-    @defaults.stubs(:write_to_file).returns true
-    @defaults.stubs(:providers).returns({ 'foreman' => TestProvider.new() })
-
-    @context = {
-      :defaults => @defaults
-    }
+    @defaults = defaults_mock({ 'foreman' => TestProvider.new() })
+    @context = { :defaults => @defaults }
   end
 
   describe 'defaults list' do
@@ -142,7 +133,7 @@ describe 'commands' do
     it 'reports missing parameter name' do
       options = ['--param-value=83']
 
-      expected_result = usage_error_result(cmd, "option '--param-name' is required")
+      expected_result = usage_error_result(cmd, "Option '--param-name' is required.")
 
       result = run_cmd(cmd + options, @context)
       assert_cmd(expected_result, result)