hammer_cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f291ac84923a7a842e1464948770660d9eda7bc9
-  data.tar.gz: 593e26e92e365344b6b5e2f319266e7a842a10d6
+  metadata.gz: dfc3de6a7599c2ab526183074b333b1c3ad55970
+  data.tar.gz: 0c5a264582fdd5dc5fcfcdbfe4f20cb1ccb8f3f0
 SHA512:
-  metadata.gz: 8ecca4d5ca8efe937fa4194f807f555078b7c494fbf33c78b88dbd7cbdae2a21d41835d255e1bbebcfdba5fd9ebef01e9b3c55a678413c4ac41026ba188318c8
-  data.tar.gz: 263225f32a3c48c8a4de9748436f3129ebca50f0d2ce3a41c25188c77370125e9c22766870e038a82ca9a2af490935aa95548226b34681fa3ee16f926817afae
+  metadata.gz: 75df4210b14e233c11f681e06d2045518e9fb39233094b5283012ebd4ff59e341edc74a077f986c8da14770b5c507a0ed0e6d623098357a7e74ca70fae345594
+  data.tar.gz: 06045bbf7c133b0b826a6822faa9df3f215f19895b2d3b76f73e9bbaefe9f4d4b0a3e3a91c97ee7a7a59aae0a70728a7c10bc93dcd27af2762227dbdc0747524

data/bin/hammer

@@ -17,6 +17,7 @@ class PreParser < Clamp::Command
   option ["-u", "--username"], "USERNAME", _("username to access the remote system")
   option ["-p", "--password"], "PASSWORD", _("password to access the remote system")
   option ["-s", "--server"], "SERVER", _("remote system address")
+  option ["-r", "--reload-cache"], :flag, _("force reload of Apipie cache")
   option ["--interactive"], "INTERACTIVE", _("Explicitly turn interactive mode on/off") do |value|
     bool_normalizer = HammerCLI::Options::Normalizers::Bool.new
     bool_normalizer.format(value)
@@ -57,7 +58,8 @@ HammerCLI::Settings.load({
     :password => preparser.password,
     :host => preparser.server,
     :interactive => preparser.interactive,
-    :verbose => preparser.verbose? || preparser.debug?
+    :verbose => preparser.verbose? || preparser.debug?,
+    :reload_cache => preparser.reload_cache?
   }})
 
 if HammerCLI::Settings.get(:mark_translated)

data/config/cli_config.template.yml

@@ -11,6 +11,9 @@
 # Enable/disable color output of logger in Clamp commands
 :watch_plain: false
 
+# Forece relaod of Apipie cache with every Hammer invocation
+:reload_cache: false
+
 # Directory where the logs are stored. The default is /var/log/hammer/ and the log file is named hammer.log
 :log_dir: '~/.hammer/log'
 

data/doc/creating_commands.md

@@ -572,5 +572,5 @@ There are more ways where to place your config file for hammer.
 The best practice is to place module's configuration into a separate file named by
 the module. In this example it would be `~/.hammer/cli.modules.d/hello_world.yml`.
 
-Read more in [the settings howto](https://github.com/theforeman/hammer-cli#configuration).
+Read more about configuration locations in [the settings howto](installation.md#configuration).
 

data/doc/installation.md

@@ -29,10 +29,10 @@ Configuration is by default looked for in the following directories, loaded in t
  - custom location (file or directory) specified on command line - ```-c CONF_FILE_PATH```
 
 In each of these directories hammer is trying to load ```cli_config.yml``` and anything in
-the ```cli.modules.d``` subdirectory which is place for specific configuration of hammer modules.
+the ```cli.modules.d``` subdirectory which is place for specific configuration of hammer modules a.k.a. plugins.
 
 Later directories and files have precedence if they redefine the same option. Files from ```cli.modules.d```
-are loaded in alphabetical order.
+are loaded in alphabetical order. The modules are loaded in alphabetical order which can be overriden with explicit requirement of dependences in the modules.
 
 ### Manual installation
 The packaged version of hammer copies the template to `/etc/hammer` for you.
@@ -70,6 +70,7 @@ in ```~/.hammer/cli.modules.d/foreman.yml``` should look as follows:
     :password: 'changeme'
 ```
 
+
 Use the hammer
 --------------
 

data/doc/release_notes.md

@@ -1,6 +1,23 @@
 Release notes
 =============
 
+### 0.1.4 (2014-12-10)
+* hammer-cli CSV formatter doesn't properly format values with custom formatters, moving to correct implementation ([#8569](http://projects.theforeman.org/issues/8569))
+* added support for dependeces among modules ([#7566](http://projects.theforeman.org/issues/7566))
+* Add option forcing apipie cache reload ([#8430](http://projects.theforeman.org/issues/8430))
+* Missing search options error message ([#5556](http://projects.theforeman.org/issues/5556))
+* Adds YAML and JSON output adapters (BZ1122650) ([#6754](http://projects.theforeman.org/issues/6754))
+* Credentials interface definition moved to ApipieBindings ([#7408](http://projects.theforeman.org/issues/7408))
+* Catching apipie-bindings' MissingArgumentsError ([#6820](http://projects.theforeman.org/issues/6820))
+* Prints table headers when no data ([#7001](http://projects.theforeman.org/issues/7001))
+* i18n - add zh_CN language
+* i18n - add de, it, pt_BR, zh_TW, ru, ja, ko languages
+* Readable help for long options ([#5417](http://projects.theforeman.org/issues/5417))
+* Give usage information for boolean types ([#7284](http://projects.theforeman.org/issues/7284))
+* Minor updates in devel docs ([#5052](http://projects.theforeman.org/issues/5052))
+* Avoid locale domain name conflict ([#7262](http://projects.theforeman.org/issues/7262))
+
+
 ### 0.1.3
 * Fixed detection of list type options  ([#7144](http://projects.theforeman.org/issues/7144))
 * Key-value normalizer accepts arrays ([#7133](http://projects.theforeman.org/issues/7133))

data/doc/writing_a_plugin.md

@@ -59,7 +59,7 @@ $ gem build ./hammer_cli_hello.gemspec
 $ gem install hammer_cli_hello-0.0.1.gem
 ```
 
-Place your module's config file into `~/.hammer/cli.modules.d/`.
+Place your module's config file into `~/.hammer/cli.modules.d/hello_world.yml`.
 ```yaml
 :hello:
   :enable_module: true

data/lib/hammer_cli/abstract.rb

@@ -3,6 +3,7 @@ require 'hammer_cli/logger_watch'
 require 'hammer_cli/options/option_definition'
 require 'hammer_cli/clamp'
 require 'hammer_cli/subcommand'
+require 'hammer_cli/options/matcher'
 require 'logging'
 
 module HammerCLI
@@ -63,11 +64,29 @@ module HammerCLI
     end
 
     class SortedBuilder < Clamp::Help::Builder
+
+      DEFAULT_LABEL_INDENT = 29
+
       def add_list(heading, items)
         items.sort! do |a, b|
           a.help[0] <=> b.help[0]
         end
-        super(heading, items)
+
+        puts "\n#{heading}:"
+
+        label_width = DEFAULT_LABEL_INDENT
+        items.each do |item|
+          label, description = item.help
+          label_width = label.size if label.size > label_width
+        end
+
+        items.each do |item|
+          label, description = item.help
+          description.each_line do |line|
+            puts " %-#{label_width}s %s" % [label, line]
+            label = ''
+          end
+        end
       end
     end
 
@@ -90,14 +109,6 @@ module HammerCLI
       self.class.output_definition
     end
 
-    def self.inherited_output_definition
-      od = nil
-      if superclass.respond_to? :output_definition
-        od_super = superclass.output_definition
-        od = od_super.dup unless od_super.nil?
-      end
-      od
-    end
 
     def self.output_definition
       @output_definition = @output_definition || inherited_output_definition || HammerCLI::Output::Definition.new
@@ -129,6 +140,20 @@ module HammerCLI
 
     protected
 
+    def self.find_options(switch_filter, other_filters={})
+      filters = other_filters
+      if switch_filter.is_a? Hash
+        filters.merge!(switch_filter)
+      else
+        filters[:long_switch] = switch_filter
+      end
+
+      m = HammerCLI::Options::Matcher.new(filters)
+      recognised_options.find_all do |opt|
+        m.matches? opt
+      end
+    end
+
     def self.create_option_builder
       OptionBuilderContainer.new
     end
@@ -217,5 +242,17 @@ module HammerCLI
     def options
       all_options.reject {|key, value| value.nil? }
     end
+
+    private
+
+    def self.inherited_output_definition
+      od = nil
+      if superclass.respond_to? :output_definition
+        od_super = superclass.output_definition
+        od = od_super.dup unless od_super.nil?
+      end
+      od
+    end
+
   end
 end

data/lib/hammer_cli/apipie/command.rb

@@ -1,6 +1,7 @@
 require File.join(File.dirname(__FILE__), '../abstract')
 require File.join(File.dirname(__FILE__), '../messages')
 require File.join(File.dirname(__FILE__), 'options')
+require File.join(File.dirname(__FILE__), 'option_definition')
 require File.join(File.dirname(__FILE__), 'resource')
 
 module HammerCLI::Apipie
@@ -20,7 +21,7 @@ module HammerCLI::Apipie
     def self.create_option_builder
       builder = super
       builder.builders += [
-        OptionBuilder.new(resource.action(action), :require_options => false)
+        OptionBuilder.new(resource, resource.action(action), :require_options => false)
       ] if resource_defined?
       builder
     end
@@ -73,5 +74,13 @@ module HammerCLI::Apipie
       )
     end
 
+    def self.option(switches, type, description, opts = {}, &block)
+      HammerCLI::Apipie::OptionDefinition.new(switches, type, description, opts).tap do |option|
+        declared_options << option
+        block ||= option.default_conversion_block
+        define_accessors_for(option, &block)
+      end
+    end
+
   end
 end

data/lib/hammer_cli/apipie/option_builder.rb

@@ -3,8 +3,9 @@ module HammerCLI::Apipie
 
   class OptionBuilder < HammerCLI::AbstractOptionBuilder
 
-    def initialize(action, options={})
+    def initialize(resource, action, options={})
       @action = action
+      @resource = resource
       @require_options = options[:require_options].nil? ? true : options[:require_options]
     end
 
@@ -22,6 +23,10 @@ module HammerCLI::Apipie
 
     protected
 
+    def option(*args)
+      HammerCLI::Apipie::OptionDefinition.new(*args)
+    end
+
     def options_for_params(params, filter, resource_name_map)
       opts = []
       params.each do |p|
@@ -45,11 +50,11 @@ module HammerCLI::Apipie
     end
 
     def option_switch(param, resource_name_map)
-      '--' + optionamize(aliased(param.name, resource_name_map))
+      '--' + optionamize(aliased(param, resource_name_map))
     end
 
     def option_type(param, resource_name_map)
-      aliased(param.name, resource_name_map).upcase.gsub('-', '_')
+      aliased(param, resource_name_map).upcase.gsub('-', '_')
     end
 
     def option_desc(param)
@@ -61,20 +66,33 @@ module HammerCLI::Apipie
       opts[:required] = true if (param.required? and require_options?)
       if param.expected_type == :array || param.validator =~ /Array/i
         opts[:format] = HammerCLI::Options::Normalizers::List.new
+      elsif param.expected_type == 'boolean' || param.validator =~ /Boolean/i
+        opts[:format] = HammerCLI::Options::Normalizers::Bool.new
       end
       opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)
+      opts[:referenced_resource] = resource_name(param)
+
       return opts
     end
 
-    def aliased(name, resource_name_map)
-      resource_name = name.gsub(/_id[s]?$/, "")
-      resource_name = resource_name_map[resource_name.to_s] || resource_name_map[resource_name.to_sym] || resource_name
-      if name.end_with?("_id")
-        return "#{resource_name}_id"
-      elsif name.end_with?("_ids")
-        return "#{resource_name}_ids"
+    def aliased(param, resource_name_map)
+      resource_name = resource_name(param)
+
+      if resource_name.nil?
+        return param.name
+      else
+        aliased_name = resource_name_map[resource_name.to_s] || resource_name_map[resource_name.to_sym] || resource_name
+        return param.name.gsub(resource_name, aliased_name.to_s)
+      end
+    end
+
+    def resource_name(param)
+      if (param.name =~ /^id[s]?$/)
+        @resource.singular_name
+      elsif(param.name =~ /_id[s]?$/)
+        param.name.to_s.gsub(/_id[s]?$/, "")
       else
-        return name
+        nil
       end
     end
 

data/lib/hammer_cli/apipie/option_definition.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'options')
+
+module HammerCLI::Apipie
+
+  class OptionDefinition < HammerCLI::Options::OptionDefinition
+
+    attr_accessor :referenced_resource
+
+    def initialize(switches, type, description, options = {})
+      if options.has_key? :referenced_resource
+        self.referenced_resource = options.delete(:referenced_resource).to_s if options[:referenced_resource]
+      end
+      super
+    end
+
+  end
+
+end

data/lib/hammer_cli/apipie/resource.rb

@@ -1,36 +1,18 @@
 require 'apipie_bindings'
 module HammerCLI::Apipie
 
-  class AbstractCredentials
-
-    def to_params
-      {}
-    end
-
-    private
-
-    def ask_user(prompt, silent=false)
-      if silent
-        ask(prompt) {|q| q.echo = false}
-      else
-        ask(prompt)
-      end
-    end
-
-  end
-
 
   class ApipieConnector < HammerCLI::AbstractConnector
 
     attr_reader :api
 
     def initialize(params)
-      credentials = params.delete(:credentials)
-      params.merge!(credentials.to_params) if credentials
-
       @api = ApipieBindings::API.new(params)
+      if HammerCLI::Settings.get(:_params, :reload_cache) || HammerCLI::Settings.get(:reload_cache)
+        @api.clean_cache
+        Logging.logger['Init'].debug 'Apipie cache was cleared'
+      end
     end
-
   end
 
 

data/lib/hammer_cli/exception_handler.rb

@@ -17,6 +17,8 @@ module HammerCLI
         [RestClient::ResourceNotFound, :handle_not_found],
         [RestClient::Unauthorized, :handle_unauthorized],
         [ApipieBindings::DocLoadingError, :handle_apipie_docloading_error],
+        [ApipieBindings::MissingArgumentsError, :handle_apipie_missing_arguments_error],
+        [HammerCLI::ModuleDisabledButRequired, :handle_generic_config_error]
       ]
     end
 
@@ -48,10 +50,10 @@ module HammerCLI
       output.print_message(msg)
     end
 
-    def log_full_error(e)
+    def log_full_error(e, message = e.message)
       backtrace = e.backtrace || []
-      error = "\n\n#{e.class} (#{e.message}):\n    " +
-        backtrace.join("\n    ")
+      error = "\n\n#{e.class} (#{message}):\n    " +
+        backtrace.join("\n    ") +
         "\n\n"
       @logger.error error
     end
@@ -95,8 +97,18 @@ module HammerCLI
       HammerCLI::EX_CONFIG
     end
 
-  end
-end
-
+    def handle_apipie_missing_arguments_error(e)
+      message = _("Missing arguments for %s") % "'#{e.params.join("', '")}'"
+      print_error message
+      log_full_error e, message
+      HammerCLI::EX_USAGE
+    end
 
+    def handle_generic_config_error(e)
+      print_error e.message
+      log_full_error e
+      HammerCLI::EX_CONFIG
+    end
 
+  end
+end

data/lib/hammer_cli/exceptions.rb

@@ -3,5 +3,6 @@ module HammerCLI
   class CommandConflict < StandardError; end
   class OperationNotSupportedError < StandardError; end
   class ModuleLoadingError < StandardError; end
+  class ModuleDisabledButRequired < StandardError; end
 
 end

data/lib/hammer_cli/i18n.rb

@@ -108,6 +108,10 @@ module HammerCLI
         '/usr/share/locale'
       end
 
+      def domain_name
+        "#{super}@system"
+      end
+
     end
 
 

data/lib/hammer_cli/main.rb

@@ -6,6 +6,8 @@ module HammerCLI
 
     option ["-v", "--verbose"], :flag, _("be verbose"), :context_target => :verbose
     option ["-d", "--debug"], :flag, _("show debugging output "), :context_target => :debug
+    option ["-r", "--reload-cache"], :flag, _("force reload of Apipie cache")
+
     option ["-c", "--config"], "CFG_FILE", _("path to custom config file")
 
     option ["-u", "--username"], "USERNAME", _("username to access the remote system"),

data/lib/hammer_cli/modules.rb

@@ -1,16 +1,18 @@
-
 module HammerCLI
 
   class Modules
 
     def self.names
+      enabled_modules.sort
+    end
 
+    def self.enabled_modules
       # legacy modules config
       modules = HammerCLI::Settings.get(:modules) || []
       logger.warn _("Legacy configuration of modules detected. Check section about configuration in user manual") unless modules.empty?
 
       HammerCLI::Settings.dump.inject(modules) do |names, (mod_name, mod_config)|
-        if mod_config.kind_of?(Hash) && !mod_config[:enable_module].nil?
+        if is_module_config?(mod_config)
           mod = ["hammer_cli_#{mod_name}"]
           if mod_config[:enable_module]
             names += mod
@@ -22,6 +24,22 @@ module HammerCLI
       end
     end
 
+    def self.disabled_modules
+      HammerCLI::Settings.dump.inject([]) do |names, (mod_name, mod_config)|
+        if is_module_config?(mod_config)
+          mod = "hammer_cli_#{mod_name}"
+          names << mod unless mod_config[:enable_module]
+        end
+        names
+      end
+    end
+
+    def self.loaded_modules
+      Object.constants. \
+        select{ |c| c.to_s =~ /\AHammerCLI[A-Z]./ && Object.const_get(c).class == Module }. \
+        map{ |m| m.to_s.underscore }
+    end
+
     def self.find_by_name(name)
       possible_names = [
         name.camelize,
@@ -64,9 +82,19 @@ module HammerCLI
       HammerCLI::Modules.names.each do |m|
         Modules.load(m)
       end
+      loaded_for_deps = loaded_modules & disabled_modules
+      unless loaded_for_deps.empty?
+        message = _("Error: Some of the required modules are disabled in configuration: %s ") % loaded_for_deps.join(', ')
+        raise HammerCLI::ModuleDisabledButRequired.new(message)
+      end
     end
 
     protected
+
+    def self.is_module_config?(config)
+      config.kind_of?(Hash) && !config[:enable_module].nil?
+    end
+
     def self.logger
       Logging.logger['Modules']
     end