hammer_cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 290f41e5f2227f4e71ffbaf977f02ba0cf8b1601
-  data.tar.gz: 14502a8f77396925e426d8e1384f73e77fd6288a
+  metadata.gz: 9e93c3909bae5e1ce10cef180e409f5046ac7207
+  data.tar.gz: 23865ff20011788a464be2f5e61775311f787aa2
 SHA512:
-  metadata.gz: 05159163a04fb707dbdfcd1292bd2d9b845742643b3d39fde9d422a060dab9cd4d8d8a3cd82b957427c01ca7629444eee63834d8afff2c649d917509acb12105
-  data.tar.gz: 238d88468d9fc4e74c209d991a6b1cde091eb14f5cb0f31e7c5ad7e5932a8f2a5d9f6e67999eb982b2b40ac81e22ff38c85e495e42be42190f4ed5b25331ec02
+  metadata.gz: 5d3984b23d9f786da504884d19b1ce39b1043c36bb9c340b7ecdeebd11c3f2567213c7fbed67c661627374d5f76f9c2aeaef9451c9c6609c6c2bda51604a16a8
+  data.tar.gz: 907a881b80c1269b0cbcb87ee70dab37865a29ab14b2304f9d642413d42901eb88b96bdbf8e49372dae34b1548492e4a4ad155fd4527dc6b404fb9c0bf94c378

data/README.md

@@ -12,10 +12,11 @@ Available plugins are currently:
 
 You also can easily add custom commands for your specific use, such as bulk actions or admin tasks.
 
+Check out the [release notes](doc/release_notes.md#release-notes) to see what's new in the latest version.
 
 Installation
 ------------
-We build rpms, debs and gems. Alternatively you can install hammer form a git checkout.
+We build rpms, debs and gems. Alternatively you can install hammer from a git checkout.
 See our [installation and configuration instuctions](doc/installation.md#installation).
 
 
@@ -25,7 +26,7 @@ If one of hammer commands doesn't work as you would expect, you can run `hammer
 full debug output from the loggers. It should give you an idea what went wrong.
 
 If you have questions, don't hesitate to contact us on `foreman-users@googlegroups.com` or
-`FreeNode#foreman` irc channel.
+the `Freenode#theforeman` IRC channel.
 
 
 Further reading

data/bin/hammer

@@ -16,6 +16,7 @@ class PreParser < Clamp::Command
   option ["-c", "--config"], "CFG_FILE", _("path to custom config file")
   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 ["--interactive"], "INTERACTIVE", _("Explicitly turn interactive mode on/off") do |value|
     bool_normalizer = HammerCLI::Options::Normalizers::Bool.new
     bool_normalizer.format(value)
@@ -54,10 +55,15 @@ HammerCLI::Settings.load({
   :_params => {
     :username => preparser.username,
     :password => preparser.password,
+    :host => preparser.server,
     :interactive => preparser.interactive,
     :verbose => preparser.verbose? || preparser.debug?
   }})
 
+if HammerCLI::Settings.get(:mark_translated)
+  include HammerCLI::I18n::Debug
+end
+
 # setup logging
 require 'hammer_cli/logger'
 logger = Logging.logger['Init']

data/config/cli_config.template.yml

@@ -22,3 +22,6 @@
 
 # Maximum log size in bytes. Log rotates when the value gets exceeded
 #:log_size: 5 #in MB
+
+# Mark translated strings with X characters (for developers)
+#:mark_translated: false

data/doc/creating_commands.md

@@ -319,6 +319,25 @@ If your plugin needs to disable an existing subcommand, you can use `remove_subc
 Call to this action is automatically logged.
 
 
+### Lazy-loaded subcommands
+In some cases it's beneficial to load the command classes lazily at the time when they
+are really needed. It can save some time in CLIs containing many commands with time-consuming
+initialization.
+
+Such commands have to be placed in a separate file (`hammer_cli_hello/say.rb` in our case).
+Following construct registers the command as lazy-loaded. CLI then requires the file
+when it needs the command class for the first time.
+
+```ruby
+HammerCLI::MainCommand.lazy_subcommand(
+  'say',                        # command's name
+  'Say something',              # description
+  'HammerCLIHello::SayCommand', # command's class in a string
+  'hammer_cli_hello/say'        # require path of the file
+)
+```
+
+
 ### Printing some output
 We've mentioned above that it's not recommended practice to print output
 directly with `puts` in Hammer. The reason is we separate definition

data/doc/i18n.md

@@ -83,3 +83,18 @@ puts _("Hello %s, it is %s" % [name, day])
 # CORRECT
 puts _("Hello %{name}, it is %{day}") % {:name => name, :day => day}
 ```
+
+
+3) Don't use newlines in the gettext function. Strings with newlines are not extracted correctly.
+```ruby
+# WRONG
+puts _("TODO: \n - make dishes\n - do shopping")
+# CORRECT
+puts _("TODO:") +
+     "\n - " + _("make dishes") +
+     "\n - " + _("do shopping")
+```
+
+
+4) Try setting `:mark_translated: true` to identify gaps in your translations.
+This will wrap all translated strings with angle brackets '>message<'.

data/doc/installation.md

@@ -60,7 +60,7 @@ Plugins are disabled by default. To enable plugin create configuration file in `
 Plugin specific configuration must be nested under plugin's name (without the ```hammer_cli_``` prefix).
 
 In the example we assume the gem ```hammer_cli_foreman``` with the Foreman plugin is installed. Then the plugin configuration
-in ```~/.hammer/cli.plugins.d/foreman.yml``` should look as follows:
+in ```~/.hammer/cli.modules.d/foreman.yml``` should look as follows:
 
 ```yaml
 :foreman:

data/doc/release_notes.md

@@ -0,0 +1,61 @@
+Release notes
+=============
+
+### 0.1.2
+* Allow override of request options, e.g. :response => :raw
+* Lazy loaded subcommands ([#6761](http://projects.theforeman.org/issues/6761))
+* I18n - fixed error message + docs
+* I18n - fix apipie warning string to be properly extracted
+* I18n - add mark_translated to highlight extracted strings
+* I18n - add en_GB locale
+* I18n - extracting new, pulling from tx
+* Project-Id-Version is fixed after tx pull
+* Restrict ci_reporter gem to less than 2.0.0 to fix CI ([#6779](http://projects.theforeman.org/issues/6779))
+* Fixed dependency on simplecov
+* Parameters are not wrapped ([#6343](http://projects.theforeman.org/issues/6343))
+* Rest-client > 1.7 does not support ruby 1.8 ([#6534](http://projects.theforeman.org/issues/6534))
+* Exit cleanly when EOF/ctrl+d given in shell ([#6148](http://projects.theforeman.org/issues/6148))
+* Fix incorrect --server help text ([#6219](http://projects.theforeman.org/issues/6219))
+* Fixed wrong config file path in installation docs
+* Empty list in csv adapter does not work ([#6238](http://projects.theforeman.org/issues/6238))
+* Resource name mapping ([#6092](http://projects.theforeman.org/issues/6092))
+* Tests for EnumList normalizer, fixed missing quotes in description
+* ListEnum normalizer
+* Add --server cli option ([#6219](http://projects.theforeman.org/issues/6219))
+* CSV handles collection or container ([#5111](http://projects.theforeman.org/issues/5111))
+* build_options configurable with block ([#5747](http://projects.theforeman.org/issues/5747))
+* Add pkg:generate_source task to generate gem ([#5793](http://projects.theforeman.org/issues/5793))
+
+
+### 0.1.1
+* Removed `log_api_calls` setting
+* Updated documentation
+* String#format fixed to behave consistently with %
+* Fix for ignoring cases where output record is null ([#5605](http://projects.theforeman.org/issues/5605))
+* Messages for clamp translated ([#4475](http://projects.theforeman.org/issues/4475))
+* Read and write commands merged ([#4311](http://projects.theforeman.org/issues/4311))
+* Introduced option builders ([#4311](http://projects.theforeman.org/issues/4311))
+* Add support for boolean fields ([#5025](http://projects.theforeman.org/issues/5025))
+* Skip missing translation domains ([#4916](http://projects.theforeman.org/issues/4916))
+
+
+### 0.1.0
+* Updated documentation
+* Fixes command description issues ([#4791](http://projects.theforeman.org/issues/4791), [#4556](http://projects.theforeman.org/issues/4556))
+* Added option for debugging output ([#4861](http://projects.theforeman.org/issues/4861))
+* Runs with log level 'debug' in verbose ([#4835](http://projects.theforeman.org/issues/4835))
+* Loads configuration form /etc/hammer ([#4792](http://projects.theforeman.org/issues/4792))
+* Numbered collections in output ([#4676](http://projects.theforeman.org/issues/4676))
+* Dynamic API bindings ([#3897](http://projects.theforeman.org/issues/3897))
+* Fixes subnet info in csv mode errors out ([#4531](http://projects.theforeman.org/issues/4531))
+* i18n support ([#4472](http://projects.theforeman.org/issues/4472))
+* shell - temporarily disable command completion on ruby 1.8
+* Enable setting width to columns in table output adapter ([#4384](http://projects.theforeman.org/issues/4384))
+* Enable skipping blank values in base output adapter ([#4231](http://projects.theforeman.org/issues/4231))
+* Adds support for output fields containing multiline text
+* Fixes --interactive=false still prompts ([#4378](http://projects.theforeman.org/issues/4378))
+* Fixes completion of quoted values ([#4182](http://projects.theforeman.org/issues/4182))
+* Main commands are now sorted in the help output ([#4112](http://projects.theforeman.org/issues/4112))
+* Persistent history in shell ([#3883](http://projects.theforeman.org/issues/3883))
+* Stores option -v into context ([#3633](http://projects.theforeman.org/issues/3633))
+* Adds JSONInput formalizer ([#4246](http://projects.theforeman.org/issues/4246))

data/lib/hammer_cli/abstract.rb

@@ -2,13 +2,13 @@ require 'hammer_cli/exception_handler'
 require 'hammer_cli/logger_watch'
 require 'hammer_cli/options/option_definition'
 require 'hammer_cli/clamp'
+require 'hammer_cli/subcommand'
 require 'logging'
 
 module HammerCLI
 
-  class CommandConflict < StandardError; end
-
   class AbstractCommand < Clamp::Command
+    include HammerCLI::Subcommand
 
     class << self
       attr_accessor :validation_block
@@ -62,31 +62,6 @@ module HammerCLI
       context[:path][-2]
     end
 
-    def self.remove_subcommand(name)
-      self.recognised_subcommands.delete_if do |sc|
-        if sc.is_called?(name)
-          logger.info "subcommand #{name} (#{sc.subcommand_class}) was removed."
-          true
-        else
-          false
-        end
-      end
-    end
-
-    def self.subcommand!(name, description, subcommand_class = self, &block)
-      remove_subcommand(name)
-      self.subcommand(name, description, subcommand_class, &block)
-      logger.info "subcommand #{name} (#{subcommand_class}) was created."
-    end
-
-    def self.subcommand(name, description, subcommand_class = self, &block)
-      existing = find_subcommand(name)
-      if existing
-        raise HammerCLI::CommandConflict, "can't replace subcommand #{name} (#{existing.subcommand_class}) with #{name} (#{subcommand_class})"
-      end
-      super
-    end
-
     class SortedBuilder < Clamp::Help::Builder
       def add_list(heading, items)
         items.sort! do |a, b|
@@ -135,16 +110,13 @@ module HammerCLI
     end
 
     def self.option_builder
-      @option_builder ||= OptionBuilderContainer.new
-      @option_builder.builders = custom_option_builders
+      @option_builder ||= create_option_builder
       @option_builder
     end
 
-    def self.custom_option_builders
-      []
-    end
-
     def self.build_options(builder_params={})
+      builder_params = yield(builder_params) if block_given?
+
       option_builder.build(builder_params).each do |option|
         # skip switches that are already defined
         next if option.nil? or option.switches.any? {|s| find_option(s) }
@@ -157,6 +129,10 @@ module HammerCLI
 
     protected
 
+    def self.create_option_builder
+      OptionBuilderContainer.new
+    end
+
     def print_record(definition, record)
       output.print_record(definition, record)
     end
@@ -190,10 +166,7 @@ module HammerCLI
 
     def exception_handler_class
       #search for exception handler class in parent modules/classes
-      module_list = self.class.name.to_s.split('::').inject([Object]) do |mod, class_name|
-        mod << mod[-1].const_get(class_name)
-      end
-      module_list.reverse.each do |mod|
+      HammerCLI.constant_path(self.class.name.to_s).reverse.each do |mod|
         return mod.send(:exception_handler_class) if mod.respond_to? :exception_handler_class
       end
       return HammerCLI::ExceptionHandler

data/lib/hammer_cli/apipie/command.rb

@@ -17,12 +17,12 @@ module HammerCLI::Apipie
       " "
     end
 
-    def self.custom_option_builders
-      builders = super
-      builders += [
+    def self.create_option_builder
+      builder = super
+      builder.builders += [
         OptionBuilder.new(resource.action(action), :require_options => false)
       ] if resource_defined?
-      builders
+      builder
     end
 
     def self.apipie_options(*args)
@@ -39,7 +39,7 @@ module HammerCLI::Apipie
 
     def send_request
       if resource && resource.has_action?(action)
-        resource.call(action, request_params, request_headers)
+        resource.call(action, request_params, request_headers, request_options)
       else
         raise HammerCLI::OperationNotSupportedError, "The server does not support such operation."
       end
@@ -49,8 +49,12 @@ module HammerCLI::Apipie
       {}
     end
 
+    def request_options
+      {}
+    end
+
     def request_params
-      method_options
+      method_options(options)
     end
 
     def print_data(data)

data/lib/hammer_cli/apipie/option_builder.rb

@@ -1,7 +1,7 @@
 
 module HammerCLI::Apipie
 
-  class OptionBuilder
+  class OptionBuilder < HammerCLI::AbstractOptionBuilder
 
     def initialize(action, options={})
       @action = action
@@ -10,8 +10,9 @@ module HammerCLI::Apipie
 
     def build(builder_params={})
       filter = Array(builder_params[:without])
+      resource_name_map = builder_params[:resource_mapping] || {}
 
-      options_for_params(@action.params, filter)
+      options_for_params(@action.params, filter, resource_name_map)
     end
 
     attr_writer :require_options
@@ -21,34 +22,34 @@ module HammerCLI::Apipie
 
     protected
 
-    def options_for_params(params, filter)
+    def options_for_params(params, filter, resource_name_map)
       opts = []
       params.each do |p|
         next if filter.include?(p.name) || filter.include?(p.name.to_sym)
         if p.expected_type == :hash
-          opts += options_for_params(p.params, filter)
+          opts += options_for_params(p.params, filter, resource_name_map)
         else
-          opts << create_option(p)
+          opts << create_option(p, resource_name_map)
         end
       end
       opts
     end
 
-    def create_option(param)
-      HammerCLI::Options::OptionDefinition.new(
-        option_switch(param),
-        option_type(param),
+    def create_option(param, resource_name_map)
+      option(
+        option_switch(param, resource_name_map),
+        option_type(param, resource_name_map),
         option_desc(param),
         option_opts(param)
       )
     end
 
-    def option_switch(param)
-      '--' + param.name.gsub('_', '-')
+    def option_switch(param, resource_name_map)
+      '--' + optionamize(aliased(param.name, resource_name_map))
     end
 
-    def option_type(param)
-      param.name.upcase.gsub('-', '_')
+    def option_type(param, resource_name_map)
+      aliased(param.name, resource_name_map).upcase.gsub('-', '_')
     end
 
     def option_desc(param)
@@ -61,9 +62,21 @@ module HammerCLI::Apipie
       # FIXME: There is a bug in apipie, it does not produce correct expected type for Arrays
       # When it's fixed, we should test param["expected_type"] == "array"
       opts[:format] = HammerCLI::Options::Normalizers::List.new if param.validator.include? "Array"
+      opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)
       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"
+      else
+        return name
+      end
+    end
 
   end
 end

data/lib/hammer_cli/apipie/options.rb

@@ -2,25 +2,27 @@
 module HammerCLI::Apipie
   module Options
 
-    def all_method_options
-      method_options_for_params(resource.action(action).params, true)
+    def method_options(options)
+      method_options_for_params(resource.action(action).params, options)
     end
 
-    def method_options
-      method_options_for_params(resource.action(action).params, false)
-    end
-
-    def method_options_for_params(params, include_nil=true)
+    def method_options_for_params(params, options)
       opts = {}
+
       params.each do |p|
         if p.expected_type == :hash
-          opts[p.name] = method_options_for_params(p.params, include_nil)
+          opts[p.name] = method_options_for_params(p.params, options)
         else
-          opts[p.name] = get_option_value(p.name)
+          p_name = HammerCLI.option_accessor_name(p.name)
+          if options.has_key?(p_name)
+            opts[p.name] = options[p_name]
+          elsif respond_to?(p_name, true)
+            opt = send(p_name)
+            opts[p.name] = opt unless opt.nil?
+          end
         end
       end
 
-      opts.reject! {|key, value| value.nil? } unless include_nil
       opts
     end
 

data/lib/hammer_cli/completer.rb

@@ -189,7 +189,7 @@ module HammerCLI
         unless word.start_with?('-')
           break unless subcommands.has_key? word
 
-          cmd = subcommands[word]
+          cmd = subcommands[word].subcommand_class
           cmd_idx = idx+1
           subcommands = sub_command_map(cmd)
         end
@@ -229,7 +229,7 @@ module HammerCLI
     def sub_command_map(cmd_class)
       cmd_class.recognised_subcommands.inject({}) do |cmd_map, cmd|
         cmd.names.each do |name|
-          cmd_map.update(name => cmd.subcommand_class)
+          cmd_map.update(name => cmd)
         end
         cmd_map
       end

data/lib/hammer_cli/exception_handler.rb

@@ -63,7 +63,8 @@ module HammerCLI
     end
 
     def handle_usage_exception(e)
-      print_error _("Error: %{message}\n\nSee: '%{path} --help'") % {:message => e.message, :path => e.command.invocation_path}
+      print_error (_("Error: %{message}") + "\n\n" +
+                   _("See: '%{path} --help'")) % {:message => e.message, :path => e.command.invocation_path}
       log_full_error e
       HammerCLI::EX_USAGE
     end
@@ -87,9 +88,9 @@ module HammerCLI
 
     def handle_apipie_docloading_error(e)
       rake_command = "rake apipie:cache"
-      print_error _("Could not load API description from the server\n"\
-          "  - is your server down?\n"\
-          "  - was \"#{rake_command}\" run on the server when using apipie cache? (typical production settings))\n")
+      print_error _("Could not load the API description from the server") + "\n  - " +
+                  _("is the server down?") + "\n  - " +
+                  _("was '%s' run on the server when using apipie cache? (typical production settings)") % rake_command
       log_full_error e
       HammerCLI::EX_CONFIG
     end

data/lib/hammer_cli/exceptions.rb

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

data/lib/hammer_cli/i18n.rb

@@ -22,6 +22,47 @@ module HammerCLI
       end
     end
 
+    # include this module to see translations highlighted
+    module Debug
+      DL = '>'
+      DR = '<'
+
+      # slightly modified copy of fast_gettext D_* method
+      def _(key)
+        FastGettext.translation_repositories.each_key do |domain|
+          result = FastGettext::TranslationMultidomain.d_(domain, key) {nil}
+          return DL + result + DR unless result.nil?
+        end
+        DL + key + DR
+      end
+
+      # slightly modified copy of fast_gettext D_* method
+      def n_(*keys)
+        FastGettext.translation_repositories.each_key do |domain|
+          result = FastGettext::TranslationMultidomain.dn_(domain, *keys) {nil}
+          return DL + result + DR unless result.nil?
+        end
+        DL + keys[-3].split(keys[-2]||FastGettext::NAMESPACE_SEPARATOR).last + DR
+      end
+
+      # slightly modified copy of fast_gettext D_* method
+      def s_(key, separator=nil)
+        FastGettext.translation_repositories.each_key do |domain|
+          result = FastGettext::TranslationMultidomain.ds_(domain, key, separator) {nil}
+          return DL + result + DR unless result.nil?
+        end
+        DL + key.split(separator||FastGettext::NAMESPACE_SEPARATOR).last + DR
+      end
+
+      # slightly modified copy of fast_gettext D_* method
+      def ns_(*keys)
+        FastGettext.translation_repositories.each_key do |domain|
+          result = FastGettext::TranslationMultidomain.dns_(domain, *keys) {nil}
+          return DL + result + DR unless result.nil?
+        end
+        DL + keys[-2].split(FastGettext::NAMESPACE_SEPARATOR).last + DR
+      end
+    end
 
     class AbstractLocaleDomain
 

data/lib/hammer_cli/main.rb

@@ -12,6 +12,8 @@ module HammerCLI
       :context_target => :username
     option ["-p", "--password"], "PASSWORD", _("password to access the remote system"),
       :context_target => :password
+    option ["-s", "--server"], "SERVER", _("remote system address"),
+      :context_target => :uri
 
     option "--version", :flag, _("show version") do
       puts "hammer (%s)" % HammerCLI.version
@@ -53,6 +55,4 @@ module HammerCLI
 
 end
 
-# extend MainCommand
-require 'hammer_cli/shell'
 

data/lib/hammer_cli/options/normalizers.rb

@@ -154,7 +154,38 @@ module HammerCLI
         end
       end
 
+      class EnumList < AbstractNormalizer
 
+        def initialize(allowed_values)
+          @allowed_values = allowed_values
+        end
+
+        def description
+          _("Any combination (comma separated list) of '%s'") % quoted_values
+        end
+
+        def format(value)
+          value.is_a?(String) ? parse(value) : []
+        end
+
+        def complete(value)
+          Completer::finalize_completions(@allowed_values)
+        end
+
+        private
+
+        def quoted_values
+          @allowed_values.map { |v| "'#{v}'" }.join(', ')
+        end
+
+        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
+            end
+          end
+        end
+      end
     end
   end
 end

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

@@ -41,7 +41,7 @@ module HammerCLI::Output::Adapter
       HammerCLI::Output::FieldFilter.new
     end
 
-    def data_for_field(field, record)
+    def self.data_for_field(field, record)
       path = field.path
 
       path.inject(record) do |record, path_key|
@@ -55,6 +55,10 @@ module HammerCLI::Output::Adapter
       end
     end
 
+    def data_for_field(field, record)
+      Abstract.data_for_field(field, record)
+    end
+
     private
 
     def filter_formatters(formatters_map)