hammer_cli 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c856eea7fbf8e0734d0d499654229d0eae1ecd69
-  data.tar.gz: 5c86eebfc85d5855f88770833fa4e95c98ee3660
+  metadata.gz: ed76c22f08106cd7634ad1fed540dcf36fd1c5df
+  data.tar.gz: 9940232f3680440d7e8b86d6f102d1d03c87c8ba
 SHA512:
-  metadata.gz: 11cf2b3b33444a8dabbd84e206b5eb6e57843aeea22a8bc210d6c6276682f5621e285561ba18eacd7be56201f9816dee467635db73c065bf628c405a033bbd8c
-  data.tar.gz: 4d6a8dc7c47be4b247cffb105dc21b36de4e5258385bac46b67d7eee9cfade4c5393be44197f948da0da1ed673af2109d965ef462cc6dc0c6cdddfabd0597b2a
+  metadata.gz: 5d48b14bfa16dc4ecbf0cc41e6acd97984597ac2ffca027220b9f01dd7139f35bb1c040b99a44669ecca0e229c90a4017513779150d9019c6d8e8d6383c8386e
+  data.tar.gz: d57b562879af67ef096b18e5010ca0ac158b6ee692275aeb4e26aaebfbdb5ec70ee46e82ec28f1e2f2e76754189d9946b032c4ce82211e8207c27d40e2870fc7

data/bin/hammer

@@ -122,4 +122,4 @@ HammerCLI::I18n.domains.each do |domain|
   logger.debug "'#{domain.type}' files for locale domain '#{domain.domain_name}' loaded from '#{File.expand_path(domain.locale_dir)}'"
 end
 
-exit HammerCLI::MainCommand.run || HammerCLI::EX_OK
+exit HammerCLI::MainCommand.run(File.basename($0), ARGV, HammerCLI.context) || HammerCLI::EX_OK

data/doc/release_notes.md

@@ -1,6 +1,15 @@
 Release notes
 =============
 
+### 0.5.1 (2015-12-15)
+* Minor release to fix wrongly packaged gem
+
+### 0.5.0 (2015-12-14)
+* Added defaults options in hammer cli ([#8015](http://projects.theforeman.org/issues/8015))
+* Do not display hidden options in --help ([#12693](http://projects.theforeman.org/issues/12693))
+* Refs #10564 - interpolate option in i18n string correctly ([#10564](http://projects.theforeman.org/issues/10564))
+* Json and yaml formatting for messages ([#11355](http://projects.theforeman.org/issues/11355))
+
 ### 0.4.0 (2015-09-21)
 * Pull in the downstream translations ([#11184](http://projects.theforeman.org/issues/11184))
 * Abort when custom config file is not found ([#11158](http://projects.theforeman.org/issues/11158))

data/lib/hammer_cli/abstract.rb

@@ -5,7 +5,6 @@ require 'hammer_cli/clamp'
 require 'hammer_cli/subcommand'
 require 'hammer_cli/options/matcher'
 require 'logging'
-
 module HammerCLI
 
   class AbstractCommand < Clamp::Command
@@ -71,6 +70,7 @@ module HammerCLI
         items.sort! do |a, b|
           a.help[0] <=> b.help[0]
         end
+        items.reject! {|item| item.respond_to?(:hidden?) && item.hidden?}
 
         puts "\n#{heading}:"
 
@@ -233,10 +233,12 @@ module HammerCLI
     end
 
     def all_options
-      self.class.recognised_options.inject({}) do |h, opt|
-        h[opt.attribute_name] = send(opt.read_method)
-        h
+      @all_options ||= self.class.recognised_options.inject({}) do |hash, opt|
+        hash[opt.attribute_name] = send(opt.read_method)
+        hash[opt.attribute_name] = add_custom_defaults(opt.attribute_name) if hash[opt.attribute_name].nil?
+        hash
       end
+      @all_options
     end
 
     def options
@@ -245,6 +247,14 @@ module HammerCLI
 
     private
 
+    def add_custom_defaults(attr)
+      if context[:defaults]
+        value = context[:defaults].get_defaults(attr)
+        logger.info("Custom default value #{value} was used for attribute #{attr}") if value
+        value
+      end
+    end
+    
     def self.inherited_output_definition
       od = nil
       if superclass.respond_to? :output_definition

data/lib/hammer_cli/context.rb

@@ -0,0 +1,13 @@
+require 'hammer_cli/defaults'
+
+module HammerCLI
+
+  def self.context
+    {
+      :defaults => HammerCLI.defaults
+    }
+  end
+
+end
+
+

data/lib/hammer_cli/defaults.rb

@@ -0,0 +1,83 @@
+require 'hammer_cli/defaults_commands'
+module HammerCLI
+  DEFAULT_FILE = "#{Dir.home}/.hammer/defaults.yml"
+
+  class Defaults
+    class DefaultsError < StandardError; end
+    class DefaultsPathError < DefaultsError; end
+
+    attr_reader :defaults_settings
+
+    def initialize(settings, file_path = nil)
+
+      @defaults_settings = settings || {}
+      @path = file_path || DEFAULT_FILE
+    end
+
+    def register_provider(provider)
+      providers[provider.provider_name.to_s] = provider
+    end
+
+    def providers
+      @providers ||= {}
+    end
+
+    def delete_default_from_conf(param)
+      conf_file = YAML.load_file(path)
+      conf_file[:defaults].delete(param)
+      write_to_file conf_file
+      conf_file
+    end
+
+    def add_defaults_to_conf(default_options, provider)
+      create_default_file if defaults_settings.nil?
+      defaults = YAML.load_file(path)
+      defaults[:defaults] ||= {}
+      default_options.each do |key, value|
+        key = key.to_sym
+        defaults[:defaults][key] = value ? {:value => value,} : {:provider => provider}
+      end
+      write_to_file defaults
+      defaults
+    end
+
+    def get_defaults(opt)
+      option = opt
+      option = opt.gsub("option_",'') if opt.include? "option_"
+      unless defaults_settings.nil? || defaults_settings[option.to_sym].nil?
+        if defaults_settings[option.to_sym][:provider]
+          providers[defaults_settings[option.to_sym][:provider]].get_defaults(option.to_sym)
+        else
+          defaults_settings[option.to_sym][:value]
+        end
+      end
+    end
+
+    def write_to_file(defaults)
+      File.open(path,'w') do |h|
+        h.write defaults.to_yaml
+      end
+    end
+
+    protected
+
+    attr_reader :path
+
+    def create_default_file
+      if Dir.exist?(File.dirname(@path))
+        new_file = File.new(path, "w")
+        new_file.write ":defaults:"
+        new_file.close
+      else
+        raise DefaultsPathError.new(_("Couldn't create %s please create the path before defaults are enabled.") % path)
+      end
+    end
+  end
+
+  def self.defaults
+    @defaults ||= Defaults.new(HammerCLI::Settings.settings[:defaults])
+
+  end
+
+  HammerCLI::MainCommand.subcommand "defaults", _("Defaults management"), HammerCLI::DefaultsCommand
+end

data/lib/hammer_cli/defaults_commands.rb

@@ -0,0 +1,160 @@
+require 'hammer_cli'
+require 'yaml'
+module HammerCLI
+  class BaseDefaultsProvider
+    attr_reader :provider_name, :supported_defaults, :description
+
+    def initialize
+      @provider_name = nil
+      @supported_defaults = nil
+      @description = 'Abstract provider'
+    end
+
+    def param_supported?(param)
+      @supported_defaults.nil? || @supported_defaults.any? {|s| s.to_s == param}
+    end
+
+    def get_defaults
+      raise NotImplementedError
+    end
+  end
+
+  class DefaultsCommand < HammerCLI::AbstractCommand
+    class ProvidersDefaultsCommand < HammerCLI::DefaultsCommand
+      command_name 'providers'
+      desc _('List all the providers')
+
+      def execute
+        data = context[:defaults].providers.map do |key, val|
+          {
+            :provider => key.to_s,
+            :defaults => (val.supported_defaults || ['*']).map(&:to_s),
+            :description => val.description
+          }
+        end
+
+        fields = HammerCLI::Output::Dsl.new.build do
+          field :provider, _('Provider')
+          field :defaults, _('Supported defaults'), Fields::List
+          field :description, _('Description')
+        end
+
+        definition = HammerCLI::Output::Definition.new
+        definition.append(fields)
+
+        print_collection(definition, data)
+        HammerCLI::EX_OK
+      end
+
+      def adapter
+        @context[:adapter] || :table
+      end
+    end
+
+    class ListDefaultsCommand < HammerCLI::DefaultsCommand
+      command_name 'list'
+      desc _('List all the default parameters')
+
+      def execute
+        data = context[:defaults].defaults_settings.map do |key, val|
+          {
+            :parameter => key.to_s,
+            :value     => val[:provider] ? "Provided by: " + val[:provider].to_s.capitalize : val[:value]
+          }
+        end
+
+        fields = HammerCLI::Output::Dsl.new.build do
+          field :parameter, _('Parameter')
+          field :value, _('Value'), Fields::List
+        end
+
+        definition = HammerCLI::Output::Definition.new
+        definition.append(fields)
+
+        print_collection(definition, data)
+        HammerCLI::EX_OK
+      end
+
+      def adapter
+        @context[:adapter] || :table
+      end
+    end
+
+    class DeleteDefaultsCommand < HammerCLI::DefaultsCommand
+      command_name 'delete'
+
+      desc _('Delete a default param')
+      option "--param-name", "OPTION_NAME", _("The name of the default option"), :required => true
+
+      def execute
+        if context[:defaults].defaults_settings && context[:defaults].defaults_settings[option_param_name.to_sym]
+          context[:defaults].delete_default_from_conf(option_param_name.to_sym)
+          param_deleted(option_param_name)
+        else
+          variable_not_found
+        end
+        HammerCLI::EX_OK
+      end
+    end
+
+    class AddDefaultsCommand < HammerCLI::DefaultsCommand
+      command_name 'add'
+
+      desc _('Add a default parameter to config')
+      option "--param-name", "OPTION_NAME", _("The name of the default option (e.g. organization_id)."), :required => true
+      option "--param-value", "OPTION_VALUE", _("The value for the default option")
+      option "--provider", "OPTION_PROVIDER", _("The name of the provider providing the value. For list available providers see `hammer defaults providers`.")
+
+      def execute
+        if option_provider.nil? && option_param_value.nil? || !option_provider.nil? && !option_param_value.nil?
+          bad_input
+          HammerCLI::EX_USAGE
+        else
+          if option_provider
+            namespace = option_provider
+            if !context[:defaults].providers.key?(namespace)
+              provider_prob_message(namespace)
+              return HammerCLI::EX_USAGE
+            elsif !context[:defaults].providers[namespace].param_supported?(option_param_name)
+              defaults_not_supported_by_provider
+              return HammerCLI::EX_CONFIG
+            end
+          end
+          context[:defaults].add_defaults_to_conf({option_param_name => option_param_value}, namespace)
+          added_default_message(option_param_name.to_s, option_param_value)
+          HammerCLI::EX_OK
+        end
+      rescue Defaults::DefaultsError, SystemCallError => e
+        print_message(e.message)
+        HammerCLI::EX_CONFIG
+      end
+    end
+
+    def added_default_message(key, value)
+      print_message(_("Added %{key_val} default-option with value that will be generated from the server.") % {:key_val => key.to_s}) if value.nil?
+      print_message(_("Added %{key_val} default-option with value %{val_val}.") % {:key_val => key.to_s, :val_val => value.to_s}) unless value.nil?
+    end
+
+    def provider_prob_message(namespace)
+      print_message(_("Provider #{namespace} was not found. See `hammer defaults providers` for available providers."))
+    end
+
+    def defaults_not_supported_by_provider
+      print_message(_("The param name is not supported by provider. See `hammer defaults providers` for supported params."))
+    end
+
+    def param_deleted(param)
+      print_message(_("%{param} was deleted successfully.") % {:param => param.to_s})
+    end
+
+    def bad_input
+      print_message(_("You must specify value or a provider name, cant specify both."))
+    end
+
+    def variable_not_found
+      print_message(_("Couldn't find the requested param in %s.") % context[:defaults].send(:path))
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli/options/option_definition.rb

@@ -53,11 +53,11 @@ module HammerCLI
       end
 
       def handles?(switch)
-        message = _("Warning: Option #{switch} is deprecated. %s")
+        message = _("Warning: Option %{option} is deprecated. %{message}")
         if deprecated_switches.class <= String && switches.include?(switch)
-          warn(message % deprecated_switches)
+          warn(message % { :option => switch, :message => deprecated_switches })
         elsif deprecated_switches.class <= Hash && deprecated_switches.keys.include?(switch)
-          warn(message % deprecated_switches[switch])
+          warn(message % { :option => switch, :message => deprecated_switches[switch] })
         end
         super(switch)
       end

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

@@ -11,6 +11,19 @@ module HammerCLI::Output::Adapter
       puts JSON.pretty_generate(result)
     end
 
+    def print_message(msg, msg_params={})
+      id = msg_params["id"] || msg_params[:id]
+      name = msg_params["name"] || msg_params[:name]
+
+      data = {
+        :message => msg.format(msg_params)
+      }
+      data[:id] = id unless id.nil?
+      data[:name] = name unless name.nil?
+
+      puts JSON.pretty_generate(data)
+    end
+
   end
 
   HammerCLI::Output::Output.register_adapter(:json, Json)

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

@@ -11,6 +11,19 @@ module HammerCLI::Output::Adapter
       puts YAML.dump(result)
     end
 
+    def print_message(msg, msg_params={})
+      id = msg_params["id"] || msg_params[:id]
+      name = msg_params["name"] || msg_params[:name]
+
+      data = {
+        :message => msg.format(msg_params)
+      }
+      data[:id] = id unless id.nil?
+      data[:name] = name unless name.nil?
+
+      puts YAML.dump(data)
+    end
+
   end
   HammerCLI::Output::Output.register_adapter(:yaml, Yaml)
 end

data/lib/hammer_cli/settings.rb

@@ -18,6 +18,7 @@ module HammerCLI
         if File.directory? full_path
           # check for cli_config.yml
           load_from_file(File.join(full_path, 'cli_config.yml'))
+          load_from_file(File.join(full_path, 'defaults.yml'))
           # load config for modules
           Dir.glob(File.join(full_path, 'cli.modules.d/*.yml')).sort.each do |f|
             load_from_file(f)

data/lib/hammer_cli/version.rb

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

data/lib/hammer_cli.rb

@@ -13,9 +13,11 @@ require 'hammer_cli/completer'
 require 'hammer_cli/option_builder'
 require 'hammer_cli/abstract'
 require 'hammer_cli/main'
+require 'hammer_cli/context'
 
 require 'hammer_cli/apipie'
 
 # extend MainCommand
 require 'hammer_cli/shell'
+require 'hammer_cli/defaults'