hammer_cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9027b34462e30b995c85afac2a0c61eb4dee544f
-  data.tar.gz: 51aeab33dc28f1242992eccc6feca4a5a5895411
+  metadata.gz: 7da6a9e45a6760f38b354282567dcddad5b4d004
+  data.tar.gz: 7bda2b5e6eb146a1b747b83101a9b536645f23d1
 SHA512:
-  metadata.gz: 61d84ed050de0079e88d80ae2f4a4b94e136f061d1a041c631ebe043ec4ff776b4a63713ce415ebd2b15d87aaf86a243a895610baa0d04c89d8385c625b59e44
-  data.tar.gz: 42882c180f2e21aad6cf99a8a784d8e9be6439caa6a82e77dc7007227861c95fae4715cdbe52de2dfdae46c54b4e9cc56aa7d3419f6bcde505c2ff770b302759
+  metadata.gz: 5f0ae742b4500cd823de4d92be2b6b95149dd4e281adfcb232ef68111817e7b9dab27267799a562b32910b038389f64dc2922a62c609fd8ef8ce619cd82c5543
+  data.tar.gz: 1c9619bd4fc7f3bc8b6b83aba7b8550f567226569afc2407e55493211afa27087b6f3a93b2e2aa287a5402482bcf39bdfd6637e8c323574ed186c971da0596bc

data/bin/hammer

@@ -9,19 +9,26 @@ HighLine.color_scheme = HighLine::SampleColorScheme.new
 require 'hammer_cli/i18n'
 
 require 'hammer_cli/options/normalizers'
-# create fake command instance to use some global args before we start
+# Create fake command instance to use some global args before we start.
+# Option descriptions are never displayed and thus do not require translation.
 class PreParser < Clamp::Command
-  option ["-v", "--verbose"], :flag, _("be verbose")
-  option ["-d", "--debug"], :flag, _("show debugging output")
-  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 ["-r", "--reload-cache"], :flag, _("force reload of Apipie cache")
-  option ["--interactive"], "INTERACTIVE", _("Explicitly turn interactive mode on/off") do |value|
+  option ["-v", "--verbose"], :flag, "be verbose"
+  option ["-d", "--debug"], :flag, "show debugging output"
+  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 ["-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)
   end
+  option ["--version"], :flag, "show version"
+  option ["--show-ids"], :flag, "Show ids of associated resources"
+  option ["--csv"], :flag, "Output as CSV (same as --output=csv)"
+  option ["--output"], "ADAPTER", "Set output format"
+  option ["--csv-separator"], "SEPARATOR", "Character to separate the values"
+  option ["--autocomplete"], "LINE", "Get list of possible endings"
 end
 
 preparser = PreParser.new File.basename($0), {}

data/doc/creating_commands.md

@@ -129,6 +129,26 @@ $ hammer hello --name 'Foreman'
 Hello Foreman!
 ```
 
+#### Deprecated options
+To mark an option as deprecated use the `:deprecated` option as follows:
+```ruby
+  option '--name', "NAME", "Name of the person you want to greet",
+    :deprecated => _('Use --alias instead')
+```
+It will ensure user is warned when deprecated option is used:
+```
+$ hammer hello --name 'Foreman'
+Warning: Option --name is deprecated. Use --alias instead
+Hello Foreman!
+```
+
+In cases when you want to deprecate just one of more possible switches use the extended syntax:
+```ruby
+  option ['--alias','--name'], "NAME", "Name of the person you want to greet",
+    :deprecated => { '--name' => _('Use --alias instead') }
+```
+
+
 ### Option builders
 Hammer commands offer option builders that can be used for automatic option generation.
 See [documentation page](option_builders.md#option-builders) dedicated to this topic for more details.

data/doc/release_notes.md

@@ -1,6 +1,13 @@
 Release notes
 =============
 
+### 0.3.0 (2015-07-29)
+* Add normalizer converting id parameter values to numbers ([#11137](http://projects.theforeman.org/issues/11137))
+* Set Enum normalizer on enumerated values ([#11033](http://projects.theforeman.org/issues/11033))
+* Add missing options to preparser ([#10902](http://projects.theforeman.org/issues/10902))
+* Added support for deprecated options ([#10564](http://projects.theforeman.org/issues/10564))
+
+
 ### 0.2.0 (2015-04-23)
 * Rubygem locale pined to version >= 2.0.6 ([#10154](http://projects.theforeman.org/issues/10154))
 * Restricted logging version as in 2.0.0 ruby 1.8.7 support was dropped

data/lib/hammer_cli/apipie/option_builder.rb

@@ -68,6 +68,10 @@ module HammerCLI::Apipie
         opts[:format] = HammerCLI::Options::Normalizers::List.new
       elsif param.expected_type == 'boolean' || param.validator =~ /Boolean/i
         opts[:format] = HammerCLI::Options::Normalizers::Bool.new
+      elsif param.validator =~ /Must be one of: (.*)\./
+        opts[:format] = HammerCLI::Options::Normalizers::Enum.new($1.split(/,\ ?/))
+      elsif param.expected_type == 'number' || param.validator =~ /Number/i
+        opts[:format] = HammerCLI::Options::Normalizers::Number.new
       end
       opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)
       opts[:referenced_resource] = resource_name(param)

data/lib/hammer_cli/options/normalizers.rb

@@ -79,6 +79,23 @@ module HammerCLI
       end
 
 
+      class Number < AbstractNormalizer
+
+        def format(val)
+          if numeric?(val)
+            val.to_i
+          else
+            raise ArgumentError, _("numeric value is required")
+          end
+        end
+
+        def numeric?(val)
+          Integer(val) != nil rescue false
+        end
+
+      end
+
+
       class Bool < AbstractNormalizer
 
         def description
@@ -138,20 +155,26 @@ module HammerCLI
 
 
       class Enum < AbstractNormalizer
+        attr_reader :allowed_values
 
         def initialize(allowed_values)
           @allowed_values = allowed_values
         end
 
         def description
-          _("One of %s") % quoted_values
+          _("Possible value(s): %s") % quoted_values
         end
 
         def format(value)
           if @allowed_values.include? value
             value
           else
-            raise ArgumentError, _("value must be one of '%s'") % quoted_values
+            if allowed_values.count == 1
+              msg = _("value must be %s") % quoted_values
+            else
+              msg = _("value must be one of %s") % quoted_values
+            end
+            raise ArgumentError, msg
           end
         end
 

data/lib/hammer_cli/options/option_definition.rb

@@ -20,10 +20,12 @@ module HammerCLI
 
       attr_accessor :value_formatter
       attr_accessor :context_target
+      attr_accessor :deprecated_switches
 
       def initialize(switches, type, description, options = {})
         self.value_formatter = options.delete(:format)
         self.context_target = options.delete(:context_target)
+        self.deprecated_switches = options.delete(:deprecated)
         super
       end
 
@@ -50,6 +52,16 @@ module HammerCLI
         rhs.empty? ? " " : rhs
       end
 
+      def handles?(switch)
+        message = _("Warning: Option #{switch} is deprecated. %s")
+        if deprecated_switches.class <= String && switches.include?(switch)
+          warn(message % deprecated_switches)
+        elsif deprecated_switches.class <= Hash && deprecated_switches.keys.include?(switch)
+          warn(message % deprecated_switches[switch])
+        end
+        super(switch)
+      end
+
       def format_description
         if value_formatter.nil?
           ""

data/lib/hammer_cli/version.rb

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

data/locale/de/hammer-cli.edit.po

@@ -3,6 +3,7 @@
 # This file is distributed under the same license as the hammer-cli package.
 # 
 # Translators:
+# Christina Gurski <Gurski_christina@yahoo.de>, 2015
 # Dominic Cleal <dcleal@redhat.com>, 2014
 # Ettore Atalan <atalanttore@googlemail.com>, 2014
 # simon11 <simon.stieger.98@live.de>, 2014
@@ -13,8 +14,8 @@ msgstr ""
 "Project-Id-Version: Foreman\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2014-12-10 13:50+0100\n"
-"PO-Revision-Date: 2015-03-09 14:42+0000\n"
-"Last-Translator: Lukáš Zapletal\n"
+"PO-Revision-Date: 2015-06-27 20:10+0000\n"
+"Last-Translator: Christina Gurski <Gurski_christina@yahoo.de>\n"
 "Language-Team: German (http://www.transifex.com/projects/p/foreman/language/de/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -136,7 +137,7 @@ msgstr "Debugausgabe anzeigen"
 
 #: lib/hammer_cli/main.rb:9
 msgid "force reload of Apipie cache"
-msgstr ""
+msgstr "Neuladen des Apipie-Caches erzwingen"
 
 #: lib/hammer_cli/main.rb:11
 msgid "path to custom config file"
@@ -200,7 +201,7 @@ msgstr "Warnung: Beim Laden von Modul %s ist ein Fehler aufgetreten"
 
 #: lib/hammer_cli/modules.rb:87
 msgid "Error: Some of the required modules are disabled in configuration: %s "
-msgstr ""
+msgstr "Fehler: Einige der erforderlichen Module sind in der Konfiguration deaktiviert: %s"
 
 #: lib/hammer_cli/exception_handler.rb:62
 msgid "Error: %s"
@@ -230,11 +231,11 @@ msgstr "ist der Server nicht verfügbar?"
 msgid ""
 "was '%s' run on the server when using apipie cache? (typical production "
 "settings)"
-msgstr ""
+msgstr "Wurde '%s' auf dem Server ausgeführt, während Apipe-Cache in Verwendung war? (typische Produktionseinstellungen)"
 
 #: lib/hammer_cli/exception_handler.rb:101
 msgid "Missing arguments for %s"
-msgstr ""
+msgstr "Argumente für %s nicht vorhanden"
 
 #: lib/hammer_cli/validator.rb:41
 msgid "Unknown option name '%s'"
@@ -300,4 +301,4 @@ msgstr "Interaktive Shell"
 msgid ""
 "can't replace subcommand %<name>s (%<existing_class>s) with %<name>s "
 "(%<new_class>s)"
-msgstr ""
+msgstr "Unterbefehl %<name>s (%<existing_class>s) kann nicht durch %<name>s (%<new_class>s) ersetzt werden"

data/locale/de/hammer-cli.po

@@ -10,7 +10,7 @@
 # Ulrich Habel <rhaen@pkgbox.de>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli 0.2.0\n"
+"Project-Id-Version: hammer-cli 0.3.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2014-09-16 16:54+0000\n"
 "Last-Translator: Dominic Cleal <dcleal@redhat.com>\n"
@@ -105,6 +105,10 @@ msgstr "Adresse des entfernten Systems"
 msgid "show version"
 msgstr "Version anzeigen"
 
+#, fuzzy
+msgid "unknown version"
+msgstr "Version anzeigen"
+
 msgid "Show ids of associated resources"
 msgstr "IDs zugehöriger Ressourcen anzeigen"
 
@@ -145,6 +149,9 @@ msgstr "Wert muss als kommagetrennte Liste mit Schlüssel-Wert-Paaren definiert
 msgid "Comma separated list of values."
 msgstr "Kommagetrennte Liste von Werten."
 
+msgid "numeric value is required"
+msgstr ""
+
 msgid "One of true/false, yes/no, 1/0."
 msgstr "Eines von true/false, yes/no, 1/0."
 
@@ -154,10 +161,15 @@ msgstr "Gültige Werte sind true/false, yes/no, 1/0"
 msgid "Unable to parse JSON input"
 msgstr "JSON Eingabe nicht lesbar"
 
-msgid "One of %s"
-msgstr "Einer von %s"
+msgid "Possible value(s): %s"
+msgstr ""
 
-msgid "value must be one of '%s'"
+#, fuzzy
+msgid "value must be %s"
+msgstr "Gültige Werte sind \"%s\""
+
+#, fuzzy
+msgid "value must be one of %s"
 msgstr "Gültige Werte sind \"%s\""
 
 msgid "Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format"
@@ -172,6 +184,9 @@ msgstr "Eine Kombination (kommagetrennte Liste) aus \"%s\""
 msgid "value must be a combination of '%s'"
 msgstr "Wert muss eine Kombination aus \"%s\" sein"
 
+msgid "\"Warning: Option #{switch} is deprecated. %s\""
+msgstr ""
+
 msgid "Can be specified multiple times. "
 msgstr "Kann mehrfach angegeben werden."