hammer_cli 0.0.18 → 0.1.0

data/lib/hammer_cli/output/formatters.rb

@@ -109,10 +109,48 @@ module HammerCLI::Output
       end
     end
 
+    class KeyValueFormatter < FieldFormatter
+
+      def tags
+        [:screen, :flat]
+      end
+
+      def format(params)
+        if params.is_a? Hash
+          name = params[:name] || params["name"]
+          value = params[:value] || params["value"]
+          "#{name} => #{value}"
+        else
+          ""
+        end
+      end
+    end
+
+    class LongTextFormatter < FieldFormatter
+
+      INDENT = "  "
+
+      def initialize(options = {})
+        @indent = options[:indent].nil? ? true : options[:indent]
+      end
+
+      def tags
+        [:screen]
+      end
+
+      def format(text)
+        text = text.to_s.indent_with(INDENT) if @indent
+        "\n#{text}"
+      end
+    end
+
     HammerCLI::Output::Output.register_formatter(DateFormatter.new, :Date)
     HammerCLI::Output::Output.register_formatter(ListFormatter.new, :List)
+    HammerCLI::Output::Output.register_formatter(KeyValueFormatter.new, :KeyValue)
+    HammerCLI::Output::Output.register_formatter(LongTextFormatter.new, :LongText)
 
   end
 end
 
 
+

data/lib/hammer_cli/settings.rb

@@ -12,19 +12,37 @@ module HammerCLI
       end
     end
 
-    def self.load_from_file(files)
+    def self.load_from_paths(files)
       files.reverse.each do |path|
         full_path = File.expand_path path
-        if File.exists? full_path
-          config = YAML::load(File.open(full_path))
-          if config
-            load(config)
-            path_history << full_path
+        if File.file? full_path
+          load_from_file(full_path)
+        elsif File.directory? full_path
+          # check for cli_config.yml
+          load_from_file(File.join(full_path, 'cli_config.yml'))
+          # load config for modules
+          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
 
+    def self.load_from_file(file_path)
+      if File.file? file_path
+        config = YAML::load(File.open(file_path))
+        if config
+          load(config)
+          path_history << file_path
+        end
+      end
+    end
+
     def self.load(settings_hash)
       deep_merge!(settings, settings_hash)
     end
@@ -34,6 +52,10 @@ module HammerCLI
       path_history.clear
     end
 
+    def self.dump
+      settings
+    end
+
     def self.path_history
       @path_history ||= []
       @path_history

data/lib/hammer_cli/shell.rb

@@ -7,7 +7,7 @@ module HammerCLI
 
     class HelpCommand < AbstractCommand
       command_name "help"
-      desc "Print help for commands"
+      desc _("Print help for commands")
 
       parameter "[COMMAND] ...", "command"
 
@@ -19,89 +19,89 @@ module HammerCLI
 
     class ExitCommand < AbstractCommand
       command_name "exit"
-      desc "Exit interactive shell"
+      desc _("Exit interactive shell")
 
       def execute
         exit HammerCLI::EX_OK
       end
     end
 
-    class AuthCommand < AbstractCommand
-      command_name "auth"
-      desc "Login and logout actions"
+    def self.load_commands(main_cls)
+      cmds = main_cls.recognised_subcommands.select do |sub_cmd|
+        !(sub_cmd.subcommand_class <= HammerCLI::ShellCommand)
+      end
+      self.recognised_subcommands.push(*cmds)
+    end
+
+    autoload_subcommands
+  end
 
-      class LoginCommand < AbstractCommand
-        command_name "login"
-        desc "Set credentials"
 
-        def execute
-          context[:username] = ask_username
-          context[:password] = ask_password
-          HammerCLI::EX_OK
-        end
-      end
+  class ShellHistory
 
-      class LogoutCommand < AbstractCommand
-        command_name "logout"
-        desc "Wipe your credentials"
-
-        def execute
-          context[:username] = nil
-          context[:password] = nil
-
-          if username(false)
-            print_message("Credentials deleted, using defaults now.")
-            print_message("You are logged in as [ %s ]." % username(false))
-          else
-            print_message("Credentials deleted.")
-          end
-          HammerCLI::EX_OK
-        end
-      end
+    def initialize(history_file_path)
+      @file_path = history_file_path
+      load
+    end
 
-      class InfoCommand < AbstractCommand
-        command_name "status"
-        desc "Information about current user"
-
-        def execute
-          if username(false)
-            print_message("You are logged in as [ %s ]." % username(false))
-          else
-            print_message("You are currently not logged in.\nUse 'auth login' to set credentials.")
-          end
-          HammerCLI::EX_OK
-        end
+    def push(line)
+      line.strip!
+      return if line.empty? or ingonred_commands.include?(line)
+
+      Readline::HISTORY.push(line)
+      File.open(file_path, "a") do |f|
+        f.puts(line)
       end
+    end
 
-      autoload_subcommands
+    def ingonred_commands
+      ["exit"]
     end
 
+    protected
 
-    def self.load_commands(main_cls)
-      cmds = main_cls.recognised_subcommands.select do |sub_cmd|
-        !(sub_cmd.subcommand_class <= HammerCLI::ShellCommand)
+    def file_path
+      File.expand_path(@file_path)
+    end
+
+    def load
+      if File.exist?(file_path)
+        File.readlines(file_path).each do |line|
+          Readline::HISTORY.push(line.strip)
+        end
       end
-      self.recognised_subcommands.push(*cmds)
     end
 
-    autoload_subcommands
   end
 
+
   class ShellCommand < AbstractCommand
 
+    DEFAULT_HISTORY_FILE = "~/.hammer_history"
+
     def execute
       ShellMainCommand.load_commands(HammerCLI::MainCommand)
 
-      Readline.completion_append_character = ''
-      Readline.completer_word_break_characters = ' '
-      Readline.completion_proc = complete_proc
+      if RUBY_VERSION >= "1.9"
+        Readline.completion_append_character = ''
+        Readline.completer_word_break_characters = ' ='
+        Readline.completion_proc = complete_proc
+      else
+        Readline.completion_proc = lambda {}
+      end
 
       stty_save = `stty -g`.chomp
 
+      history = ShellHistory.new(Settings.get(:ui, :history_file) || DEFAULT_HISTORY_FILE)
+
       begin
         print_welcome_message
-        while line = Readline.readline(prompt, true)
-          ShellMainCommand.run('', line.split, context) unless line.start_with? 'shell' or line.strip.empty?
+        while line = Readline.readline(prompt)
+
+          history.push(line)
+
+          line = HammerCLI::CompleterLine.new(line)
+          ShellMainCommand.run('', line, context) unless line.empty?
         end
       rescue Interrupt => e
         puts
@@ -117,8 +117,9 @@ 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"))
+      print_message(_("Command completion is disabled on ruby < 1.9 due to compatibility problems.")) if RUBY_VERSION < "1.9"
     end
 
     def common_prefix(results)
@@ -134,5 +135,5 @@ module HammerCLI
 
   end
 
-  HammerCLI::MainCommand.subcommand "shell", "Interactive shell", HammerCLI::ShellCommand
+  HammerCLI::MainCommand.subcommand "shell", _("Interactive shell"), HammerCLI::ShellCommand
 end

data/lib/hammer_cli/utils.rb

@@ -20,4 +20,18 @@ class String
     split('_').map{|e| e.capitalize}.join
   end
 
+  def indent_with(indent_str)
+    gsub(/^/, indent_str)
+  end
+
+end
+
+module HammerCLI
+
+  def self.interactive?
+    return false unless STDOUT.tty?
+    return HammerCLI::Settings.get(:_params, :interactive) unless HammerCLI::Settings.get(:_params, :interactive).nil?
+    HammerCLI::Settings.get(:ui, :interactive) != false
+  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
 
@@ -59,8 +59,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?
@@ -76,8 +76,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?

data/lib/hammer_cli/version.rb

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

data/locale/Makefile

@@ -0,0 +1,64 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = hammer-cli
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '*.po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+check: $(POXFILES)
+	msgfmt -c ${POTFILE}
+
+# Merge PO files
+update-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msgmerge -N --backup=none -U $$f ${POTFILE} ; \
+	done
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull:
+	tx pull -f
+	-git commit -a -m "i18n - extracting new, pulling from tx"
+
+extract-strings:
+	bundle exec rake locale:find DOMAIN=$(DOMAIN) SKIP_MODEL=1
+
+tx-update: tx-pull extract-strings
+	# merging po files is unnecessary when using transifex.com (amend that)
+	git checkout -- ../locale/*/*po
+	git commit -a --amend -m "i18n - extracting new, pulling from tx"
+	-echo Changes commited!
+
+# Remove all MO files
+clean:
+	-rm -f messages.mo
+	find . \( -name "*.mo" -o -name "*.pox" \) -exec rm -f '{}' ';'
+	find . -path *LC_MESSAGES | xargs rm -rf
+

data/locale/hammer-cli.pot

@@ -0,0 +1,203 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the hammer-cli package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: hammer-cli 0.0.18\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-03-05 20:36+0000\n"
+"PO-Revision-Date: 2014-03-04 16:38+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: \n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: lib/hammer_cli/modules.rb:31
+msgid "Warning: An error occured while loading module %s"
+msgstr ""
+
+#: lib/hammer_cli/output/adapter/csv.rb:47
+msgid "Message"
+msgstr ""
+
+#: lib/hammer_cli/output/adapter/csv.rb:51
+msgid "Id"
+msgstr ""
+
+#: lib/hammer_cli/output/adapter/csv.rb:56
+msgid "Name"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:10
+msgid "Print help for commands"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:22
+msgid "Exit interactive shell"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:116
+msgid "Welcome to the hammer interactive shell"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:117
+msgid "Type 'help' for usage information"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:133
+msgid "Interactive shell"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:26
+msgid "Comma-separated list of key=value."
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:35
+msgid "value must be defined as a comma-separated list of key=value"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:46
+msgid "Comma separated list of values."
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:58
+msgid "One of true/false, yes/no, 1/0."
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:68
+msgid "value must be one of true/false, yes/no, 1/0"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:107
+msgid "Unable to parse JSON input"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:120
+msgid "One of %s"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:127
+msgid "value must be one of '%s'"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:146
+msgid "Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format"
+msgstr ""
+
+#: lib/hammer_cli/options/normalizers.rb:153
+msgid "'%s' is not a valid date"
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:62
+msgid "Can be specified multiple times. "
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:63
+msgid "Default: "
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:63
+msgid ", or "
+msgstr ""
+
+#: lib/hammer_cli/apipie/command.rb:68
+msgid "resource id"
+msgstr ""
+
+#: lib/hammer_cli/apipie/command.rb:69
+msgid "resource name"
+msgstr ""
+
+#: lib/hammer_cli/apipie/command.rb:70
+msgid "resource label"
+msgstr ""
+
+#: lib/hammer_cli/apipie/command.rb:94
+msgid "%{resource} with %{option} '%{value}' not found"
+msgstr ""
+
+#: lib/hammer_cli/apipie/command.rb:95
+msgid "%{resource} with %{option} '%{value}' found more than once"
+msgstr ""
+
+#: lib/hammer_cli/validator.rb:41
+msgid "Unknown option name '%s'"
+msgstr ""
+
+#: lib/hammer_cli/validator.rb:62
+msgid "You can't set all options %s at one time"
+msgstr ""
+
+#: lib/hammer_cli/validator.rb:63
+msgid "Options %s are required"
+msgstr ""
+
+#: lib/hammer_cli/validator.rb:79
+msgid "You can't set any of options %s"
+msgstr ""
+
+#: lib/hammer_cli/validator.rb:80
+msgid "At least one of options %s is required"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:7
+msgid "be verbose"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:8
+msgid "path to custom config file"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:10
+msgid "username to access the remote system"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:12
+msgid "password to access the remote system"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:15
+msgid "show version"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:24
+msgid "Show ids of associated resources"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:26
+msgid "Explicitly turn interactive mode on/off"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:30
+msgid "Output as CSV (same as --output=csv)"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:31
+msgid "Set output format. One of [%s]"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:34
+msgid "Character to separate the values"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:38
+msgid "Get list of possible endings"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:59
+msgid "Error: %s"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:65
+msgid "Error: %s\\n\\nSee: '%s --help'"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:82
+msgid "Invalid username or password"
+msgstr ""