hammer_cli 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 661dfeefa7e66df9be867455ff63a7c13b6f5d6d
-  data.tar.gz: 52b417a7c11d721824b54881e9e5d1f9bb0e6463
+  metadata.gz: b39b8afbf9c00645ca1591288ec35f790efba222
+  data.tar.gz: b1b69c66682a9a1b38d2799f15c11da797990ca5
 SHA512:
-  metadata.gz: 4a5b06fd20a0b605d63d41f2c2ed94a157e1672fed6e03a54dc3dff4d2d612c103f0d81c5606fe553a06b5e2b60be2b969fc5fb89e85fd1e0cb7b756c05d4ec6
-  data.tar.gz: 3a2c18fe41a8d4ec4fbd584a52041b1cf148c6a2a59b6d9b1d958b083d52a482e6e754f753e7df39a37be1f47454716bcff2286059850ee9c36a0cfe01641d66
+  metadata.gz: 403d600bba083967627d060ac6a6ae9620418fce83ac27ad0bd4b44821f42928fcdb0021e45166000b78f28988a7d1dca04344a1ad0d33216300b8475cba57ec
+  data.tar.gz: a572704192a70b48c30df2d2d6e2496a992034c3053300d772bd9a1ea51a5c3e40ba4dfba814f5ce20e03df40185f79166df3746db52b860429b8211e2f16722

data/config/cli_config.template.yml

@@ -3,7 +3,7 @@
   # Enable interactive queries?
   :interactive: true
   # Number of records listed per page
-  :per_page: 20
+  # :per_page: 20
   # Location of shell history file
   :history_file: '~/.hammer/history'
 
@@ -26,5 +26,8 @@
 # Maximum log size in bytes. Log rotates when the value gets exceeded
 #:log_size: 5 #in MB
 
+# 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/development_tips.md

@@ -2,7 +2,7 @@ Development Tips
 ----------------
 
 ### Local gem modifications
-If you want to modify the gems setup for development needs, create a file `Gemfile.local` in the root of your hammer-cli checkout. You can override the setup from `Gemfile` there. This file is git-ignored so you can easily keep your custom tuning.
+If you want to modify the gems setup for development needs, create a file `Gemfile.local.rb` in the root of your hammer-cli checkout. You can override the setup from `Gemfile` there. This file is git-ignored so you can easily keep your custom tuning.
 
 Typical usage is for linking plugins from local checkouts:
 ```ruby
@@ -13,7 +13,7 @@ gem 'hammer_cli_foreman', :path => '../hammer-cli-foreman'
 [Pry](https://github.com/pry/pry) is a runtime developer console for ruby.
 It allows debugging when [Pry Debugger](https://github.com/nixme/pry-debugger) is installed alongside.
 
-For basic usage, add following the lines to your `Gemfile.local`:
+For basic usage, add following the lines to your `Gemfile.local.rb`:
 
 ```ruby
 gem 'pry'

data/doc/release_notes.md

@@ -1,7 +1,19 @@
 Release notes
 =============
 
-### 0.6.1 (2016-03-15)
+### 0.7.0 (2016-06-14)
+* Let print adapters decide whether to paginate ([#15257](http://projects.theforeman.org/issues/15257))
+* Add support for testing values in option  validation ([#13832](http://projects.theforeman.org/issues/13832))
+* Add one_of constraint for option validator ([#13832](http://projects.theforeman.org/issues/13832))
+* Descriptions from Apipie will not contain unescaped HTML ([#14598](http://projects.theforeman.org/issues/14598))
+* Allow param names to contain dashes ([#8015](http://projects.theforeman.org/issues/8015))
+* Add Catalan language ([#14947](http://projects.theforeman.org/issues/14947))
+* Add support for Gemfile.local.rb ([#14466](http://projects.theforeman.org/issues/14466))
+* Introduced log format setting ([#14591](http://projects.theforeman.org/issues/14591))
+* Add pagination info when incomplete data are received (http://projects.theforeman.org/issues/14530)
+* Array is merged across YAML settings ([#14590](http://projects.theforeman.org/issues/14590))
+* Now hammer recognizes when to create defaults file correctly ([#14311](http://projects.theforeman.org/issues/14311))
+* Enable json for key=value parameters ([#12869](http://projects.theforeman.org/issues/12869))
 * Fix coded options for apipie 0.3.6 ([#13960](http://projects.theforeman.org/issues/13960))
 
 ### 0.6.0 (2016-02-25)

data/lib/hammer_cli/apipie/option_definition.rb

@@ -11,6 +11,9 @@ module HammerCLI::Apipie
         self.referenced_resource = options.delete(:referenced_resource).to_s if options[:referenced_resource]
       end
       super
+      # Apipie currently sends descriptions as escaped HTML once this is changed this should be removed.
+      # See #15198 on Redmine.
+      @description = CGI::unescapeHTML(description)
     end
 
   end

data/lib/hammer_cli/defaults.rb

@@ -23,32 +23,37 @@ module HammerCLI
     end
 
     def delete_default_from_conf(param)
-      conf_file = YAML.load_file(path)
-      conf_file[:defaults].delete(param)
-      write_to_file conf_file
-      conf_file
+      update_defaults_file do |defaults|
+        defaults.delete_if { |k,| defaults_match?(k, param) }
+      end
     end
 
     def add_defaults_to_conf(default_options, provider)
-      create_default_file if defaults_settings.nil?
-      defaults = YAML.load_file(path)
-      defaults[:defaults] ||= {}
-      default_options.each do |key, value|
-        key = key.to_sym
-        defaults[:defaults][key] = value ? {:value => value,} : {:provider => provider}
+      create_default_file if defaults_settings.empty?
+      update_defaults_file do |defaults|
+        default_options.each do |key, value|
+          key = key.to_sym
+          defaults.delete_if { |k,| defaults_match?(k, key) }
+          defaults[key] = (value ? {:value => value,} : {:provider => provider})
+        end
       end
-      write_to_file defaults
-      defaults
+    end
+
+    def defaults_set?(param)
+      defaults_settings.keys.any? { |k| defaults_match?(k, param) }
     end
 
     def get_defaults(opt)
       option = opt
       option = opt.gsub("option_",'') if opt.include? "option_"
-      unless defaults_settings.nil? || defaults_settings[option.to_sym].nil?
-        if defaults_settings[option.to_sym][:provider]
-          providers[defaults_settings[option.to_sym][:provider]].get_defaults(option.to_sym)
+      unless defaults_settings.nil?
+        option_key = defaults_settings[option.to_sym].nil? ? option.gsub('_','-').to_sym : option.to_sym
+        return nil if defaults_settings[option_key].nil?
+
+        if defaults_settings[option_key][:provider]
+          providers[defaults_settings[option_key][:provider]].get_defaults(option.to_sym)
         else
-          defaults_settings[option.to_sym][:value]
+          defaults_settings[option_key][:value]
         end
       end
     end
@@ -72,6 +77,20 @@ module HammerCLI
         raise DefaultsPathError.new(_("Couldn't create %s please create the path before defaults are enabled.") % path)
       end
     end
+
+    def update_defaults_file
+      conf_file = YAML.load_file(@path)
+      conf_file[:defaults] ||= {}
+      yield conf_file[:defaults]
+      write_to_file conf_file
+      conf_file
+    end
+
+    private
+
+    def defaults_match?(default_a, default_b)
+      default_a.to_s.gsub('-','_') == default_b.to_s.gsub('-','_')
+    end
   end
 
   def self.defaults

data/lib/hammer_cli/defaults_commands.rb

@@ -87,7 +87,7 @@ module HammerCLI
       option "--param-name", "OPTION_NAME", _("The name of the default option"), :required => true
 
       def execute
-        if context[:defaults].defaults_settings && context[:defaults].defaults_settings[option_param_name.to_sym]
+        if context[:defaults] && context[:defaults].defaults_set?(option_param_name)
           context[:defaults].delete_default_from_conf(option_param_name.to_sym)
           param_deleted(option_param_name)
         else
@@ -115,7 +115,7 @@ module HammerCLI
             if !context[:defaults].providers.key?(namespace)
               provider_prob_message(namespace)
               return HammerCLI::EX_USAGE
-            elsif !context[:defaults].providers[namespace].param_supported?(option_param_name)
+            elsif !context[:defaults].providers[namespace].param_supported?(option_param_name.gsub('-','_'))
               defaults_not_supported_by_provider
               return HammerCLI::EX_CONFIG
             end

data/lib/hammer_cli/logger.rb

@@ -45,7 +45,7 @@ module HammerCLI
                          :file   => :yellow,
                          :method => :yellow)
 
-    pattern         = "[%5l %d %c] %m\n"
+    pattern         = "#{HammerCLI::Settings.get(:log_pattern) || '[%5l %d %c] %m'}\n"
     COLOR_LAYOUT    = Logging::Layouts::Pattern.new(:pattern => pattern, :color_scheme => 'bright')
     NOCOLOR_LAYOUT  = Logging::Layouts::Pattern.new(:pattern => pattern, :color_scheme => nil)
     DEFAULT_LOG_DIR = '/var/log/hammer'

data/lib/hammer_cli/options/normalizers.rb

@@ -22,6 +22,9 @@ module HammerCLI
 
       class KeyValueList < AbstractNormalizer
 
+        PAIR_RE = '([^,=]+)=([^,\[]+|\[[^\[\]]*\])'
+        FULL_RE = "^((%s)[,]?)+$" % PAIR_RE
+
         def description
           _("Comma-separated list of key=value.")
         end
@@ -30,26 +33,35 @@ module HammerCLI
           return {} unless val.is_a?(String)
           return {} if val.empty?
 
-          result = {}
+          if valid_key_value?(val)
+            parse_key_value(val)
+          else
+            begin
+              formatter = JSONInput.new
+              formatter.format(val)
+            rescue ArgumentError
+              raise ArgumentError, _("value must be defined as a comma-separated list of key=value or valid JSON")
+            end
+          end
+        end
 
-          pair_re = '([^,=]+)=([^,\[]+|\[[^\[\]]*\])'
-          full_re = "^((%s)[,]?)+$" % pair_re
+        private
 
-          unless Regexp.new(full_re).match(val)
-            raise ArgumentError, _("value must be defined as a comma-separated list of key=value")
-          end
+        def valid_key_value?(val)
+          Regexp.new(FULL_RE).match(val)
+        end
 
-          val.scan(Regexp.new(pair_re)) do |key, value|
+        def parse_key_value(val)
+          result = {}
+          val.scan(Regexp.new(PAIR_RE)) do |key, value|
             value = value.strip
             value = value.scan(/[^,\[\]]+/) if value.start_with?('[')
 
             result[key.strip] = strip_value(value)
           end
-          return result
+          result
         end
 
-        private
-
         def strip_value(value)
           if value.is_a? Array
             value.map do |item|

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

@@ -9,6 +9,11 @@ module HammerCLI::Output::Adapter
     def initialize(context={}, formatters={})
       @context = context
       @formatters = HammerCLI::Output::Formatters::FormatterLibrary.new(filter_formatters(formatters))
+      @paginate_by_default = true
+    end
+
+    def paginate_by_default?
+      !!@paginate_by_default
     end
 
     def print_message(msg, msg_params={})

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

@@ -135,6 +135,11 @@ module HammerCLI::Output::Adapter
       end
     end
 
+    def initialize(context={}, formatters={})
+      super
+      @paginate_by_default = false
+    end
+
     def tags
       [:flat]
     end

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

@@ -57,6 +57,11 @@ module HammerCLI::Output::Adapter
       puts dashes[1] if dashes
       puts output
       puts dashes[1] if dashes
+
+      if collection.meta.pagination_set? && collection.count < collection.meta.subtotal
+        pages = (collection.meta.subtotal.to_f/collection.meta.per_page).ceil
+        puts _("Page #{collection.meta.page} of #{pages} (use --page and --per-page for navigation)")
+      end
     end
 
     protected

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

@@ -1,6 +1,11 @@
 module HammerCLI::Output::Adapter
   class TreeStructure < Abstract
 
+    def initialize(context={}, formatters={})
+      super
+      @paginate_by_default = false
+    end
+
     def prepare_collection(fields, collection)
       collection.map do |element|
         render_fields(fields, element)

data/lib/hammer_cli/output/output.rb

@@ -66,7 +66,7 @@ module HammerCLI::Output
 
     def init_adapter(adapter_name)
       raise NameError unless self.class.adapters.has_key? adapter_name
-      self.class.adapters[adapter_name].new(context, self.class.formatters)
+      @adapter ||= self.class.adapters[adapter_name].new(context, self.class.formatters)
     end
 
   end

data/lib/hammer_cli/output/record_collection.rb

@@ -6,15 +6,19 @@ module HammerCLI::Output
     attr_accessor :total, :subtotal, :page, :per_page, :search, :sort_by, :sort_order
 
     def initialize(options={})
-      @total = options[:total]
-      @subtotal = options[:subtotal]
-      @page = options[:page]
-      @per_page = options[:per_page]
+      @total = options[:total].to_i if options[:total]
+      @subtotal = options[:subtotal].to_i if options[:subtotal]
+      @page = options[:page].to_i if options[:page]
+      @per_page = options[:per_page].to_i if options[:per_page]
       @search = options[:search]
       @sort_by = options[:sort_by]
       @sort_order = options[:sort_order]
     end
 
+    def pagination_set?
+      !(@total.nil? || @subtotal.nil? || @page.nil? || @per_page.nil?)
+    end
+
   end
 
 

data/lib/hammer_cli/settings.rb

@@ -72,6 +72,8 @@ module HammerCLI
       h.merge!(other_h) do |key, old_val, new_val|
         if old_val.is_a? Hash and new_val.is_a? Hash
           deep_merge!(old_val, new_val)
+        elsif old_val.is_a? Array and new_val.is_a? Array
+          old_val += new_val
         else
           new_val
         end

data/lib/hammer_cli/validator.rb

@@ -71,6 +71,17 @@ module HammerCLI
       end
     end
 
+    class OneOptionConstraint < AllConstraint
+      def initialize(options, to_check)
+        super(options, [to_check])
+        @rejected_msg = _("You can't set option %s")
+        @required_msg = _("Option %s is required")
+      end
+
+      def value
+        get_option(@to_check[0]).get
+      end
+    end
 
     class AnyConstraint < BaseConstraint
 
@@ -89,6 +100,39 @@ module HammerCLI
     end
 
 
+    class OneOfConstraint < BaseConstraint
+      def initialize(options, to_check)
+        raise 'Set at least one expected option' if to_check.empty?
+        super(options, to_check)
+      end
+
+      def rejected
+        raise NotImplementedError, '#rejected is unsupported for OneOfConstraint'
+      end
+
+      def required_msg
+        case count_present_options
+        when 0
+          _("One of options %s is required")
+        when 1
+          ''
+        else
+          _("Only one of options %s can be set")
+        end
+      end
+
+      def exist?
+        return count_present_options == 1
+      end
+
+      protected
+      def count_present_options
+        @to_check.count do |opt|
+          option_passed?(opt)
+        end
+      end
+    end
+
     def initialize(options)
       @options = options
     end
@@ -98,13 +142,17 @@ module HammerCLI
     end
 
     def option(to_check)
-      all(to_check)
+      OneOptionConstraint.new(@options, to_check)
     end
 
     def any(*to_check)
       AnyConstraint.new(@options, to_check.flatten(1))
     end
 
+    def one_of(*to_check)
+      OneOfConstraint.new(@options, to_check.flatten(1))
+    end
+
     def run(&block)
       self.instance_eval &block
     end

data/lib/hammer_cli/version.rb

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