hammer_cli 0.1.1 → 0.1.2

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

@@ -12,28 +12,152 @@ module HammerCLI::Output::Adapter
 
   class CSValues < Abstract
 
+    class Cell
+      attr_accessor :field_wrapper, :data
+
+      def initialize(field_wrapper, data, formatters)
+        @field_wrapper = field_wrapper
+        @data = data
+        @formatters = formatters
+      end
+
+      def self.create_cells(field_wrappers, data, formatters)
+        results = []
+        field_wrappers.each do |field_wrapper|
+          field = field_wrapper.field
+          if field.is_a? Fields::Collection
+            results = results + expand_collection(field, data, formatters)
+          elsif field.is_a?(Fields::ContainerField)
+            results = results + expand_container(field, data, formatters)
+          else
+            results << Cell.new(field_wrapper, data, formatters)
+          end
+        end
+        return results
+      end
+
+      def formatted_value
+        formatter = @formatters.formatter_for_type(@field_wrapper.field.class)
+        formatter ? formatter.format(value) : value.to_s
+      end
+
+      def self.values(headers, cells)
+        headers.map do |header|
+          cell = cells.find { |cell| cell.in_column?(header) }
+          cell ? cell.formatted_value : ''
+        end
+      end
+
+      def self.headers(cells, context)
+        cells.map(&:field_wrapper).select { |fw| ! fw.is_id? ||
+          context[:show_ids] }.map(&:display_name)
+      end
+
+      def in_column?(header)
+        self.field_wrapper.display_name == header
+      end
+
+      private
+
+      def self.expand_collection(field, data, formatters)
+        results = []
+        collection_data = data_for_field(field, data) || []
+        collection_data.each_with_index do |child_data, i|
+          field.fields.each do |child_field|
+            child_field_wrapper = FieldWrapper.new(child_field)
+            child_field_wrapper.append_prefix(field.label)
+            child_field_wrapper.append_suffix((i + 1).to_s)
+            results << Cell.new(child_field_wrapper, collection_data[i] || {}, formatters)
+          end
+        end
+        results
+      end
+
+      def self.expand_container(field, data, formatters)
+        child_fields = FieldWrapper.wrap(field.fields)
+        child_fields.each{ |child| child.append_prefix(field.label) }
+        create_cells(child_fields, data_for_field(field, data), formatters)
+      end
+
+      def self.data_for_field(field, data)
+        HammerCLI::Output::Adapter::CSValues.data_for_field(field, data)
+      end
+
+      def value
+        Cell.data_for_field(@field_wrapper.field, data)
+      end
+    end
+
+    class FieldWrapper
+      attr_accessor :name, :field
+
+      def self.wrap(fields)
+        fields.map{ |f| FieldWrapper.new(f) }
+      end
+
+      def initialize(field)
+        @field = field
+        @name = nil
+        @prefixes = []
+        @suffixes = []
+        @data
+      end
+
+      def append_suffix(suffix)
+        @suffixes << suffix
+      end
+
+      def append_prefix(prefix)
+        @prefixes << prefix
+      end
+
+      def prefix
+        @prefixes.join("::")
+      end
+
+      def suffix
+        @suffixes.join("::")
+      end
+
+      def display_name
+        names = []
+        names << prefix unless prefix.empty?
+        names << @field.label if @field.label
+        names << suffix unless suffix.empty?
+        names.join("::")
+      end
+
+      def is_id?
+        self.field.class <= Fields::Id
+      end
+    end
+
     def tags
       [:flat]
     end
 
+    def row_data(fields, collection)
+      result = []
+      collection.each do |data|
+        result << Cell.create_cells(FieldWrapper.wrap(fields), data, @formatters)
+      end
+      result
+    end
+
     def print_record(fields, record)
       print_collection(fields, [record].flatten(1))
     end
 
     def print_collection(fields, collection)
+      rows = row_data(fields, collection)
+      # get headers using columns heuristic
+      headers = rows.map{ |r| Cell.headers(r, @context) }.max_by{ |headers| headers.size }
+      # or use headers from output definition
+      headers ||= default_headers(fields)
       csv_string = generate do |csv|
-        # labels
-        csv << fields.select{ |f| !(f.class <= Fields::Id) || @context[:show_ids] }.map { |f| f.label }
-        # data
-        collection.each do |d|
-          csv << fields.inject([]) do |row, f|
-            unless f.class <= Fields::Id && !@context[:show_ids]
-              value = data_for_field(f, d)
-              formatter = @formatters.formatter_for_type(f.class)
-              row << ((formatter ? formatter.format(value) : value) || '')
-            end
-            row
-          end
+        csv << headers if headers
+        rows.each do |row|
+          csv << Cell.values(headers, row)
         end
       end
       puts csv_string
@@ -73,6 +197,10 @@ module HammerCLI::Output::Adapter
       )
     end
 
+    def default_headers(fields)
+      fields.select{ |f| !(f.class <= Fields::Id) || @context[:show_ids] }.map { |f| f.label }
+    end
+
   end
 
   HammerCLI::Output::Output.register_adapter(:csv, CSValues)

data/lib/hammer_cli/shell.rb

@@ -28,7 +28,7 @@ module HammerCLI
 
     def self.load_commands(main_cls)
       cmds = main_cls.recognised_subcommands.select do |sub_cmd|
-        !(sub_cmd.subcommand_class <= HammerCLI::ShellCommand)
+        !sub_cmd.is_called?("shell")
       end
       self.recognised_subcommands.push(*cmds)
     end
@@ -103,11 +103,11 @@ module HammerCLI
           line = HammerCLI::CompleterLine.new(line)
           ShellMainCommand.run('', line, context) unless line.empty?
         end
-      rescue Interrupt => e
-        puts
-        system('stty', stty_save) # Restore
-        exit
-      end
+      rescue Interrupt; end
+
+      puts
+      system('stty', stty_save) # Restore
+      HammerCLI::EX_OK
     end
 
     private

data/lib/hammer_cli/subcommand.rb

@@ -0,0 +1,82 @@
+
+module HammerCLI
+
+  module Subcommand
+
+    class LazyDefinition < Clamp::Subcommand::Definition
+
+      def initialize(names, description, subcommand_class_name, path)
+        @names = Array(names)
+        @description = description
+        @subcommand_class_name = subcommand_class_name
+        @path = path
+        @loaded = false
+      end
+
+      def loaded?
+        @loaded
+      end
+
+      def subcommand_class
+        if !@loaded
+          require @path
+          @loaded = true
+          @constantized_class = @subcommand_class_name.constantize
+        end
+        @constantized_class
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def 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 subcommand!(name, description, subcommand_class = self, &block)
+        remove_subcommand(name)
+        subcommand(name, description, subcommand_class, &block)
+        logger.info "subcommand #{name} (#{subcommand_class}) was created."
+      end
+
+      def subcommand(name, description, subcommand_class = self, &block)
+        existing = find_subcommand(name)
+        if existing
+          raise HammerCLI::CommandConflict, _("can't replace subcommand %<name>s (%<existing_class>s) with %<name>s (%<new_class>s)") % {
+            :name => name,
+            :existing_class => existing.subcommand_class,
+            :new_class => subcommand_class
+          }
+        end
+        super
+      end
+
+      def lazy_subcommand(name, description, subcommand_class, path)
+        # call original subcommand to ensure command's parameters are set correctly
+        # (hammer command SUBCOMMAND [ARGS] ...)
+        subcommand(name, description, Class)
+        # replace last subcommand definition with correct lazy-loaded one
+        recognised_subcommands[-1] = LazyDefinition.new(name, description, subcommand_class, path)
+      end
+
+      def lazy_subcommand!(name, description, subcommand_class, path)
+        remove_subcommand(name)
+        self.lazy_subcommand(name, description, subcommand_class, path)
+        logger.info "subcommand #{name} (#{subcommand_class}) was created."
+      end
+
+    end
+
+  end
+end

data/lib/hammer_cli/utils.rb

@@ -24,6 +24,11 @@ class String
     gsub(/^/, indent_str)
   end
 
+  def constantize
+    raise NameError, "Can't constantize empty string" if self.empty?
+    HammerCLI.constant_path(self)[-1]
+  end
+
 end
 
 module HammerCLI
@@ -34,4 +39,12 @@ module HammerCLI
     HammerCLI::Settings.get(:ui, :interactive) != false
   end
 
+  def self.constant_path(name)
+    path = name.to_s.split('::').inject([Object]) do |mod, class_name|
+      mod << mod[-1].const_get(class_name)
+    end
+    path.shift
+    path
+  end
+
 end

data/lib/hammer_cli/version.rb

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

data/locale/Makefile

@@ -7,6 +7,7 @@
 # make clean - clean everything
 #
 DOMAIN = hammer-cli
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load("../hammer_cli.gemspec");puts spec.version')
 POTFILE = $(DOMAIN).pot
 MOFILE = $(DOMAIN).mo
 POFILES = $(shell find . -name '*.po')
@@ -45,20 +46,20 @@ uniq-po:
 
 tx-pull:
 	tx pull -f
+	for f in $(POFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
 	-git commit -a -m "i18n - extracting new, pulling from tx"
 
 extract-strings:
-	bundle exec rake locale:find DOMAIN=$(DOMAIN) SKIP_MODEL=1
+	bundle exec rake gettext:find
 
-tx-update: tx-pull extract-strings
-	# merging po files is unnecessary when using transifex.com (amend that)
+reset-po:
+	# merging po files is unnecessary when using transifex.com
 	git checkout -- ../locale/*/*po
+
+tx-update: tx-pull extract-strings reset-po $(MOFILES)
+	# amend mo files
+	git add ../locale/*/LC_MESSAGES
 	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/README.md

@@ -0,0 +1,18 @@
+Updating the translations
+-------------------------
+
+  1. Check if there are any new languages with progress more than 50% on [transifex](https://www.transifex.com/projects/p/foreman/resource/hammer-cli/). If so, do the following for each of the new languages:
+
+  ```
+    mkdir locale/<lang>
+    cp locale/hammer-cli.pot locale/<lang>/hammer-cli.po
+  ```
+  2. Make sure you have `transifex-client` installed
+
+  3. Update the translations. From GIT repo root directory run:
+
+  ```
+    make -C locale tx-update
+  ```
+
+  It will download translations from transifex, generates `mo` files, updates strings in `pot` file and wraps all the changes in a new commit. Transifex automatically updates its strings when the commit is pushed to Github.

data/locale/en/hammer-cli.po

@@ -0,0 +1,227 @@
+# 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.1.2\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-05-09 16:07-0400\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"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: 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/output/formatters.rb:154
+msgid "no"
+msgstr ""
+
+#: lib/hammer_cli/output/formatters.rb:154
+msgid "yes"
+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/exception_handler.rb:60
+msgid "Error: %s"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:66
+msgid "Error: %{message}\\n\\nSee: '%{path} --help'"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:83
+msgid "Invalid username or password"
+msgstr ""
+
+#: lib/hammer_cli/exception_handler.rb:90
+msgid ""
+"Could not load API description from the server\\n  - is your server down?\\n"
+"\\\\n          \"  - was \\\"#{rake_command}\\\" run on the server when "
+"using apipie cache? (typical production settings))\\n\""
+msgstr ""
+
+#: lib/hammer_cli/logger.rb:28
+msgid "No permissions to create log dir %s"
+msgstr ""
+
+#: lib/hammer_cli/logger.rb:43
+msgid "File %s not writeable, won't log anything to the file!"
+msgstr ""
+
+#: lib/hammer_cli/modules.rb:10
+msgid ""
+"Legacy configuration of modules detected. Check section about configuration "
+"in user manual"
+msgstr ""
+
+#: lib/hammer_cli/modules.rb:42
+msgid "Warning: An error occured while loading module %s"
+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:120
+msgid "Welcome to the hammer interactive shell"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:121
+msgid "Type 'help' for usage information"
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:122
+msgid ""
+"Command completion is disabled on ruby < 1.9 due to compatibility problems."
+msgstr ""
+
+#: lib/hammer_cli/shell.rb:138
+msgid "Interactive shell"
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:68
+msgid "Can be specified multiple times. "
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:69
+msgid "Default: "
+msgstr ""
+
+#: lib/hammer_cli/options/option_definition.rb:69
+msgid ", or "
+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/main.rb:7
+msgid "be verbose"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:8
+msgid "show debugging output "
+msgstr ""
+
+#: lib/hammer_cli/main.rb:9
+msgid "path to custom config file"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:11
+msgid "username to access the remote system"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:13
+msgid "password to access the remote system"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:16
+msgid "show version"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:25
+msgid "Show ids of associated resources"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:27
+msgid "Explicitly turn interactive mode on/off"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:31
+msgid "Output as CSV (same as --output=csv)"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:32
+msgid "Set output format. One of [%s]"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:35
+msgid "Character to separate the values"
+msgstr ""
+
+#: lib/hammer_cli/main.rb:39
+msgid "Get list of possible endings"
+msgstr ""
+
+#: lib/hammer_cli/settings.rb:28
+msgid ""
+"Warning: location hammer.modules.d is deprecated, move your module "
+"configurations to cli.modules.d"
+msgstr ""