hammer_cli 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc560a54a8356574b61f94171e0f2f3eaba55be
-  data.tar.gz: baecee7550c67ddd53dd4fb41a75e8b917b7f430
+  metadata.gz: 9c28ad069fcd115c4b6f01ad2b5d0b2cdf8b3cbd
+  data.tar.gz: 2f9a543685a78f837bd1d1b657702c745c2ae0ba
 SHA512:
-  metadata.gz: a442abbc69a621586676c5a12999856bd1a470e15832f03cc5b5d59e1b7e9e12dd714b1e91faff6534222e68babd344ff340d392fbe4f01879431d1bd13fce4c
-  data.tar.gz: 812bc9348b53072052e49e5384dcbcacb46ce9553cf3bfd71dfa19a1aaeb276f9d3bed21d337f5bbdcb33951b14822664643ae9e2eabf6340289fad88336d283
+  metadata.gz: e641575e3077ce1a854ba6f6e7bfc96d9b03c634a56ee09dcb8d5d486db188aa2bd5f4e7856dcc4f30c08b9ab6630d73397e3a9726db833064d11fc8afdfeecb
+  data.tar.gz: 287e3b3f607305f302ff58d6c74c6cc871b46d627fd32e0392a2443a2f516561934344419ab9333f3083804a15996c4d9f4695b0eeb32357b8fb022416fdb2e3

data/config/cli_config.template.yml

@@ -6,6 +6,8 @@
   # :per_page: 20
   # Location of shell history file
   :history_file: '~/.hammer/history'
+  # Mark translated strings with X characters (for developers)
+  #:mark_translated: false
 
 
 # Enable/disable color output of logger in Clamp commands
@@ -29,5 +31,3 @@
 # Log record pattern (logging gem syntax)
 #:log_pattern: '[%5l %d %c] %m'
 
-# Mark translated strings with X characters (for developers)
-#:mark_translated: false

data/doc/release_notes.md

@@ -1,6 +1,21 @@
 Release notes
 =============
 
+### 0.9.0 (2016-12-15)
+* Double quotes in list type params ([#17180](http://projects.theforeman.org/issues/17180))
+* API connection moved to context ([PR #227](https://github.com/theforeman/hammer-cli/pull/227)) ([#8016](http://projects.theforeman.org/issues/8016))
+* Log related error messages to stderr ([#17508](http://projects.theforeman.org/issues/17508))
+* Respect special chars width ([#3520](http://projects.theforeman.org/issues/3520))
+* Properly detect booleans ([#17021](http://projects.theforeman.org/issues/17021))
+* Support for additional text in help ([PR #222](https://github.com/theforeman/hammer-cli/pull/222)) ([#16408](http://projects.theforeman.org/issues/16408))
+* Permit clamp 1.1 and higher, compatibility restored ([PR #224](https://github.com/theforeman/hammer-cli/pull/224)) ([#16973](http://projects.theforeman.org/issues/16973))
+* Pin clamp to 1.0.x ([PR #223](https://github.com/theforeman/hammer-cli/pull/223)) ([#16973](http://projects.theforeman.org/issues/16973))
+* Allow multiple opt validation blocks ([#16811](http://projects.theforeman.org/issues/16811))
+* Check for nil default values ([PR #221](https://github.com/theforeman/hammer-cli/pull/221)) ([#16822](http://projects.theforeman.org/issues/16822))
+* Use defaults in validators ([#16631](http://projects.theforeman.org/issues/16631))
+* Boolean formatter prints "no" for 0 ([PR #219](https://github.com/theforeman/hammer-cli/pull/219)) ([#16406](http://projects.theforeman.org/issues/16406))
+* Fix mark_translated in cli_config ([PR #216](https://github.com/theforeman/hammer-cli/pull/216)) ([#16470](http://projects.theforeman.org/issues/16470))
+
 ### 0.8.0 (2016-09-01)
 * Fix tests with rest-client >= 2.0.0 ([#16404](http://projects.theforeman.org/issues/16404))
 * Add missing apostrophe in error message ([#16316](http://projects.theforeman.org/issues/16316))

data/lib/hammer_cli/abstract.rb

@@ -4,6 +4,8 @@ require 'hammer_cli/options/option_definition'
 require 'hammer_cli/clamp'
 require 'hammer_cli/subcommand'
 require 'hammer_cli/options/matcher'
+require 'hammer_cli/help/builder'
+require 'hammer_cli/help/text_builder'
 require 'logging'
 module HammerCLI
 
@@ -11,7 +13,7 @@ module HammerCLI
     include HammerCLI::Subcommand
 
     class << self
-      attr_accessor :validation_block
+      attr_accessor :validation_blocks
     end
 
     def adapter
@@ -39,11 +41,14 @@ module HammerCLI
     end
 
     def self.validate_options(&block)
-      self.validation_block = block
+      self.validation_blocks ||= []
+      self.validation_blocks << block
     end
 
     def validate_options
-      validator.run &self.class.validation_block if self.class.validation_block
+      if self.class.validation_blocks && self.class.validation_blocks.any?
+        self.class.validation_blocks.each { |validation_block| validator.run(&validation_block) }
+      end
     end
 
     def exception_handler
@@ -60,38 +65,24 @@ module HammerCLI
       context[:path][-2]
     end
 
-    class SortedBuilder < Clamp::Help::Builder
-
-      def default_label_indent
-        29
-      end
-
-      def add_list(heading, items)
-        items.sort! do |a, b|
-          a.help[0] <=> b.help[0]
-        end
-        items.reject! {|item| item.respond_to?(:hidden?) && item.hidden?}
-
-        puts "\n#{heading}:"
+    def help
+      self.class.help(invocation_path, HammerCLI::Help::Builder.new(context[:is_tty?]))
+    end
 
-        label_width = default_label_indent
-        items.each do |item|
-          label, description = item.help
-          label_width = label.size if label.size > label_width
-        end
+    def self.help(invocation_path, builder = HammerCLI::Help::Builder.new)
+      super(invocation_path, builder)
 
-        items.each do |item|
-          label, description = item.help
-          description.each_line do |line|
-            puts " %-#{label_width}s %s" % [label, line]
-            label = ''
-          end
-        end
+      if @help_extension_block
+        help_extension = HammerCLI::Help::TextBuilder.new(builder.richtext)
+        @help_extension_block.call(help_extension)
+        builder.add_text(help_extension.string)
       end
+      builder.string
     end
 
-    def help
-      self.class.help(invocation_path, SortedBuilder.new)
+    def self.extend_help(&block)
+      # We save the block for execution on object level, where we can access command's context and check :is_tty? flag
+      @help_extension_block = block
     end
 
     def self.output(definition=nil, &block)
@@ -254,7 +245,7 @@ module HammerCLI
         value
       end
     end
-    
+
     def self.inherited_output_definition
       od = nil
       if superclass.respond_to? :output_definition

data/lib/hammer_cli/apipie.rb

@@ -1,2 +1,3 @@
 require File.join(File.dirname(__FILE__), './apipie/option_builder')
+require File.join(File.dirname(__FILE__), './apipie/api_connection')
 require File.join(File.dirname(__FILE__), './apipie/command')

data/lib/hammer_cli/apipie/api_connection.rb

@@ -0,0 +1,27 @@
+require 'apipie_bindings'
+module HammerCLI::Apipie
+  class ApiConnection < HammerCLI::AbstractConnector
+    attr_reader :api
+
+    def initialize(params, options = {})
+      @logger = options[:logger]
+      @api = ApipieBindings::API.new(params)
+      if options[:reload_cache]
+        @api.clean_cache
+        @logger.debug 'Apipie cache was cleared' unless @logger.nil?
+      end
+    end
+
+    def resources
+      @api.resources
+    end
+
+    def resource(resource_name)
+      @api.resource(resource_name)
+    end
+
+    def has_resource?(resource_name)
+      @api.has_resource?(resource_name)
+    end
+  end
+end

data/lib/hammer_cli/apipie/option_builder.rb

@@ -64,14 +64,14 @@ module HammerCLI::Apipie
     def option_opts(param)
       opts = {}
       opts[:required] = true if (param.required? and require_options?)
-      if param.expected_type == :array || param.validator =~ /Array/i
+      if param.expected_type.to_s == 'array' || param.validator =~ /Array/i
         opts[:format] = HammerCLI::Options::Normalizers::List.new
-      elsif param.expected_type == 'boolean' || param.validator =~ /Boolean/i
+      elsif param.expected_type.to_s == 'boolean' || param.validator =~ /Boolean/i
         opts[:format] = HammerCLI::Options::Normalizers::Bool.new
       elsif param.validator =~ /Must be one of: (.*)\./
         allowed = $1.split(/,\ ?/).map { |val| val.gsub(/<[^>]*>/i,'') }
         opts[:format] = HammerCLI::Options::Normalizers::Enum.new(allowed)
-      elsif param.expected_type == 'number' || param.validator =~ /Number/i
+      elsif param.expected_type.to_s == 'number' || param.validator =~ /Number/i
         opts[:format] = HammerCLI::Options::Normalizers::Number.new
       end
       opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)

data/lib/hammer_cli/apipie/resource.rb

@@ -1,21 +1,5 @@
 require 'apipie_bindings'
 module HammerCLI::Apipie
-
-
-  class ApipieConnector < HammerCLI::AbstractConnector
-
-    attr_reader :api
-
-    def initialize(params)
-      @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
-
-
   module Resource
 
     def self.included(base)
@@ -44,12 +28,6 @@ module HammerCLI::Apipie
         {}
       end
 
-      def connection_options
-        {
-          :connector => HammerCLI::Apipie::ApipieConnector
-        }
-      end
-
       def connection_name(resource_class)
         :apipie
       end
@@ -70,10 +48,7 @@ module HammerCLI::Apipie
 
       def resource(resource=nil, action=nil)
         unless resource.nil?
-          api = HammerCLI::Connection.create(
-            connection_name(resource),
-            resource_config,
-            connection_options).api
+          api = HammerCLI.context[:api_connection].get(connection_name(resource))
           if api.has_resource?(resource)
             @api_resource = api.resource(resource)
           else

data/lib/hammer_cli/connection.rb

@@ -6,39 +6,40 @@ module HammerCLI
   end
 
   class Connection
+    def initialize(logger = nil)
+      @logger = logger
+    end
 
-    def self.drop(name)
+    def drop(name)
       connections.delete(name)
     end
 
-    def self.drop_all()
+    def drop_all()
       connections.keys.each { |c| drop(c) }
     end
 
-    def self.create(name, conector_params={}, options={})
+    def create(name, &create_connector_block)
       unless connections[name]
-        Logging.logger['Connection'].debug "Registered: #{name}"
-        connector = options[:connector] || AbstractConnector
-
-        connections[name] = connector.new(conector_params)
+        connector = yield
+        @logger.debug("Registered: #{name}") if @logger
+        connections[name] = connector
       end
       connections[name]
     end
 
-    def self.exist?(name)
+    def exist?(name)
       !get(name).nil?
     end
 
-    def self.get(name)
+    def get(name)
       connections[name]
     end
 
     private
 
-    def self.connections
+    def connections
       @connections_hash ||= {}
       @connections_hash
     end
-
   end
 end

data/lib/hammer_cli/context.rb

@@ -3,8 +3,10 @@ require 'hammer_cli/defaults'
 module HammerCLI
 
   def self.context
-    {
-      :defaults => HammerCLI.defaults
+    @context ||= {
+      :defaults => HammerCLI.defaults,
+      :is_tty? => HammerCLI.tty?,
+      :api_connection => HammerCLI::Connection.new(Logging.logger['Connection'])
     }
   end
 

data/lib/hammer_cli/exception_handler.rb

@@ -83,7 +83,7 @@ module HammerCLI
     end
 
     def handle_unauthorized(e)
-      print_error _("Invalid username or password")
+      print_error e.message
       log_full_error e
       HammerCLI::EX_UNAUTHORIZED
     end

data/lib/hammer_cli/help/builder.rb

@@ -0,0 +1,58 @@
+module HammerCLI
+  module Help
+    class Builder < Clamp::Help::Builder
+      DEFAULT_LABEL_INDENT = 29
+
+      attr_reader :richtext
+
+      def initialize(richtext = false)
+        super()
+        @richtext = richtext
+      end
+
+      def add_usage(invocation_path, usage_descriptions)
+        heading(Clamp.message(:usage_heading))
+        usage_descriptions.each do |usage|
+          puts "    #{invocation_path} #{usage}".rstrip
+        end
+      end
+
+      def add_list(heading, items)
+        items.sort! do |a, b|
+          a.help[0] <=> b.help[0]
+        end
+        items.reject! {|item| item.respond_to?(:hidden?) && item.hidden?}
+
+        puts
+        heading(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
+
+      def add_text(content)
+        puts
+        puts content
+      end
+
+      protected
+
+      def heading(label)
+        label = "#{label}:"
+        label = HighLine.color(label, :bold) if @richtext
+        puts label
+      end
+    end
+  end
+end

data/lib/hammer_cli/help/text_builder.rb

@@ -0,0 +1,79 @@
+module HammerCLI
+  module Help
+    class TextBuilder
+      INDENT_STEP = 2
+      LIST_INDENT = 20
+
+      def initialize(richtext = false)
+        @out = StringIO.new
+        @richtext = richtext
+      end
+
+      def string
+        @out.string
+      end
+
+      def text(content)
+        puts unless first_print?
+        puts content
+      end
+
+      def list(items)
+        return if items.empty?
+
+        items = normalize_list(items)
+        max_len = items.map { |i| i[0].to_s.length }.max
+        indent_size = (max_len + INDENT_STEP > LIST_INDENT) ? (max_len + INDENT_STEP) : LIST_INDENT
+
+        puts unless first_print?
+        items.each do |col1, col2|
+          # handle multiple lines in the second column
+          col2 = indent(col2.to_s, ' ' * indent_size).lstrip
+
+          line = "%-#{indent_size}s%s" % [col1, col2]
+          line.strip!
+          puts line
+        end
+      end
+
+      def section(label, &block)
+        puts unless first_print?
+        heading(label)
+
+        sub_builder = TextBuilder.new(@richtext)
+        yield(sub_builder) if block_given?
+        puts indent(sub_builder.string)
+      end
+
+      def indent(content, indentation = nil)
+        indentation ||= " " * INDENT_STEP
+        content = content.split("\n") unless content.is_a? Array
+        content.map do |line|
+          (indentation + line).rstrip
+        end.join("\n")
+      end
+
+      protected
+
+      def heading(label)
+        label = "#{label}:"
+        label = HighLine.color(label, :bold) if @richtext
+        puts label
+      end
+
+      def puts(*args)
+        @out.puts(*args)
+      end
+
+      def first_print?
+        @out.size == 0
+      end
+
+      def normalize_list(items)
+        items.map do |i|
+          i.is_a?(Array) ? i : [i]
+        end
+      end
+    end
+  end
+end