hammer_cli 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 230906bc19a41759805ad05e51cee6244938cc5e
-  data.tar.gz: 7e4389026de508ce212c3af34823bc1606b6851e
+  metadata.gz: f466081646f301304855a180aec480a3c90e1653
+  data.tar.gz: b33e6d9d98d4746890ffd72080cd6f3bf272dd3b
 SHA512:
-  metadata.gz: 55c6841e58e1645e48eb83e147d662abc847cf99f18df1f5636b6fb9a09be79e133d99429fa626c3e6ca2456003091e7e74f2813ac43dc22ee163c0f2862b54d
-  data.tar.gz: ddeec7d17a560050722bddc473bbc2ff8bba5e967c3cf3f7772249fcf300ca38d03db2f5d8d75df0be5e1b10025eafeef257bf4b8ca5280d71720537ea0e6a0f
+  metadata.gz: 659186808832cd2531ef847a046eded3270789a73a052c8565c0cadbde7de977fe3b3d18bfb2d362ed2458dc4dd8f4ce826a828f78eafceb2815f727b5ee2395
+  data.tar.gz: dceeed449044ee96e0fe969bdf4ed2906c6b27b6de91988f70a83ec72a65d218d7e3ef720ced4195420a5697ca9369e1786afc992bac6020d9f7fae597295297

data/doc/installation_deb.md

@@ -21,7 +21,7 @@ echo "deb http://deb.theforeman.org/ squeeze nightly" > /etc/apt/sources.list.d/
 and update the keys
 
 ```bash
-wget -q http://deb.theforeman.org/foreman.asc -O- | apt-key add -
+wget -q https://deb.theforeman.org/foreman.asc -O- | apt-key add -
 ```
 
 #### Step 2: install hammer core

data/doc/release_notes.md

@@ -1,12 +1,17 @@
 Release notes
 =============
 
-### 0.10.2 (2017-05-05)
+### 0.11.0 (2017-08-01)
+* Add full-help command ([#20181](http://projects.theforeman.org/issues/20181))
+* Replace CSV parser in List Normalizer ([#17135](http://projects.theforeman.org/issues/17135))
+* Make sure assert_match is called in correct context ([#19573](http://projects.theforeman.org/issues/19573))
+* Fix merging .edit.po into .po files ([#17671](http://projects.theforeman.org/issues/17671))
+* Error strings with % in them break messages ([#11178](http://projects.theforeman.org/issues/11178))
+* Log what exception handler is used ([#19470](http://projects.theforeman.org/issues/19470))
+* Interpolate variables in translations correctly ([#19083](http://projects.theforeman.org/issues/19083))
 * Retry command on session expiry ([#19431](http://projects.theforeman.org/issues/19431))
 * Prevent fetching of non-CA certificates ([#19391](http://projects.theforeman.org/issues/19391))
 * Use local ca cert store instead of ssl_ca_path ([#19390](http://projects.theforeman.org/issues/19390))
-
-### 0.10.1 (2017-04-24)
 * Require apipie-bindings >= 0.2.0 ([#19083](http://projects.theforeman.org/issues/19083))
 * Install server CA cert without root access ([#19083](http://projects.theforeman.org/issues/19083))
 

data/lib/hammer_cli/csv_parser.rb

@@ -0,0 +1,80 @@
+module HammerCLI
+  class CSVParser
+
+    def initialize
+      reset_parser
+    end
+
+    def parse(data)
+      return [] if data.nil?
+      reset_parser
+      data.each_char do |char|
+        handle_escape(char) || handle_quoting(char) || handle_comma(char) || add_to_buffer(char)
+      end
+      raise ArgumentError.new(_("Illegal quoting in %{buffer}") % { :buffer => @raw_buffer }) unless @last_quote.nil?
+      clean_buffer
+      @value
+    end
+
+    private
+
+    def handle_comma(char)
+      if char == ','
+        clean_buffer
+        true
+      else
+        false
+      end
+    end
+
+    def handle_quoting(char)
+      if @last_quote.nil? && ["'", '"'].include?(char)
+        @last_quote = char
+        @raw_buffer += char
+        true
+      elsif @last_quote == char
+        @last_quote = nil
+        @raw_buffer += char
+        true
+      elsif @last_quote
+        add_to_buffer(char)
+        true
+      else
+        false
+      end
+    end
+
+    def handle_escape(char)
+      if @escape
+        add_to_buffer(char)
+        @escape = false
+        true
+      elsif char == '\\'
+        @escape = true
+        @raw_buffer += char
+        true
+      else
+        false
+      end
+    end
+
+    def add_to_buffer(char)
+      @buffer += char
+      @raw_buffer += char
+    end
+
+    def reset_parser
+      @value = []
+      @buffer = ''
+      @raw_buffer = ''
+      @escape = false
+      @last_quote = nil
+    end
+
+    def clean_buffer
+      @value << @buffer
+      @raw_buffer = ''
+      @buffer = ''
+    end
+  end
+end

data/lib/hammer_cli/exception_handler.rb

@@ -27,6 +27,7 @@ module HammerCLI
     def handle_exception(e, options={})
       @options = options
       handler = mappings.reverse.find { |m| e.class.respond_to?(:"<=") ? e.class <= m[0] : false }
+      @logger.debug "Using exception handler #{self.class}##{handler[1]}"
       return send(handler[1], e) if handler
       raise e
     end

data/lib/hammer_cli/full_help.rb

@@ -0,0 +1,84 @@
+require 'hammer_cli/abstract'
+
+module HammerCLI
+  class FullHelpCommand < HammerCLI::AbstractCommand
+    option "--md", :flag, _("Format output in markdown")
+
+    def execute
+      @adapter = option_md? ? MDAdapter.new : TxtAdapter.new
+      print_heading
+      print_help
+      HammerCLI::EX_OK
+    end
+
+    private
+
+    def print_heading
+      @adapter.print_heading(_('Hammer CLI help'))
+      @adapter.print_toc(HammerCLI::MainCommand)
+    end
+
+    def print_help(name='hammer', command=HammerCLI::MainCommand, desc='')
+      @adapter.print_command(name, desc, command.new(name).help)
+
+      command.recognised_subcommands.each do |sub_cmd|
+        print_help(@adapter.command_name(name, sub_cmd.names.first), sub_cmd.subcommand_class, sub_cmd.description)
+      end
+    end
+
+    class MDAdapter
+      def command_name(parent, command_name)
+        "#{parent} #{command_name}"
+      end
+
+      def print_command(name, description, help)
+        print_heading(name, name.split.length)
+        puts description
+        puts
+        puts "```"
+        puts help
+        puts "```"
+        puts
+      end
+
+      def print_toc(cmd)
+        names = cmd.recognised_subcommands.collect do |sub_cmd|
+          sub_cmd.names[0]
+        end
+        names.sort.each do |name|
+          puts "- [%s](#hammer-%s)" % [name, name.gsub(' ', '-')]
+        end
+        puts
+      end
+
+      def print_heading(text, level=1)
+        puts '#'*level + ' ' + text
+      end
+    end
+
+    class TxtAdapter
+      def command_name(parent, command_name)
+        "#{parent} > #{command_name}"
+      end
+
+      def print_command(name, description, help)
+        print_heading(name, 2)
+        puts description
+        puts
+        puts help
+        puts
+      end
+
+      def print_toc(cmd)
+      end
+
+      def print_heading(text, level=1)
+        ch = (level > 1) ? '-' : '='
+        puts text
+        puts ch * text.length
+      end
+    end
+  end
+
+  HammerCLI::MainCommand.subcommand "full-help", _("Print help for all hammer commands"), HammerCLI::FullHelpCommand
+end

data/lib/hammer_cli/options/normalizers.rb

@@ -1,5 +1,5 @@
 require 'json'
-require 'csv'
+require 'hammer_cli/csv_parser'
 
 module HammerCLI
   module Options
@@ -79,25 +79,14 @@ module HammerCLI
         end
       end
 
-      CSV_ERROR_MESSAGES = {
-        /Missing or stray quote/ => _('Missing or stray quote.'),
-        /Unquoted fields do not allow/ => _('Unquoted fields do not allow \r or \n.'),
-        /Illegal quoting/ => _('Illegal quoting.'),
-        /Unclosed quoted field/ => _('Unclosed quoted field.'),
-        /Field size exceeded/ => _('Field size exceeded.')
-      }
 
       class List < AbstractNormalizer
-
         def description
-          _("Comma separated list of values. Values containing comma should be double quoted")
+          _("Comma separated list of values. Values containing comma should be quoted or escaped with backslash")
         end
 
         def format(val)
-          (val.is_a?(String) && !val.empty?) ? CSV.parse_line(val) : []
-        rescue CSV::MalformedCSVError => e
-          message = CSV_ERROR_MESSAGES.find { |pattern,| pattern.match e.message } || [e.message]
-          raise ArgumentError.new(message.last)
+          (val.is_a?(String) && !val.empty?) ? HammerCLI::CSVParser.new.parse(val) : []
         end
       end
 

data/lib/hammer_cli/testing/command_assertions.rb

@@ -2,8 +2,6 @@ module HammerCLI
   module Testing
     module CommandAssertions
       class CommandExpectation
-        include MiniTest::Assertions
-
         attr_accessor :expected_out, :expected_err, :expected_exit_code
 
         def initialize(expected_out="", expected_err="", expected_exit_code=0)
@@ -12,10 +10,10 @@ module HammerCLI
           @expected_exit_code = expected_exit_code
         end
 
-        def assert_match(actual_result)
-          assert_equal_or_match @expected_err, actual_result.err
-          assert_equal_or_match @expected_out, actual_result.out
-          assert_exit_code_equal @expected_exit_code, actual_result.exit_code
+        def assert_match(test_ctx, actual_result)
+          test_ctx.assert_equal_or_match @expected_err, actual_result.err
+          test_ctx.assert_equal_or_match @expected_out, actual_result.out
+          test_ctx.assert_exit_code_equal @expected_exit_code, actual_result.exit_code
         end
       end
 
@@ -54,15 +52,14 @@ module HammerCLI
       end
 
       def assert_cmd(expectation, actual_result)
-        expectation.assert_match(actual_result)
+        expectation.assert_match(self, actual_result)
       end
 
       def assert_equal_or_match(expected, actual)
-        case expected
-        when String
+        if expected.is_a? String
           assert_equal(expected, actual)
-        when MatcherBase
-          expected.assert_match(actual)
+        elsif expected.respond_to? :assert_match
+          expected.assert_match(self, actual)
         else
           msg = actual
           assert_match(expected, actual, msg)

data/lib/hammer_cli/testing/output_matchers.rb

@@ -8,8 +8,8 @@ module HammerCLI
           @expected = expected
         end
 
-        def assert_match(actual)
-          assert_equal(@expected, actual)
+        def assert_match(test_ctx, actual)
+          test_ctx.assert_equal(@expected, actual)
         end
       end
 
@@ -18,9 +18,9 @@ module HammerCLI
           @expected = FieldMatcher.matcher(label, value)
         end
 
-        def assert_match(actual)
+        def assert_match(test_ctx, actual)
           message = "Regex /#{@expected.source}/ didn't match the output:\n#{actual}"
-          assert(@expected =~ actual, message)
+          test_ctx.assert(@expected =~ actual, message)
         end
 
         def self.matcher(label, value)
@@ -36,7 +36,7 @@ module HammerCLI
           @ignore_whitespace = options.fetch(:ignore_whitespace, true)
         end
 
-        def assert_match(actual)
+        def assert_match(test_ctx, actual)
           if @ignore_whitespace
             expected_lines = strip_lines(@expected_lines)
             actual = strip_lines(actual.split("\n")).join("\n")
@@ -46,7 +46,7 @@ module HammerCLI
           expected_lines = expected_lines.join("\n")
 
           message = "Output didn't contain expected lines:\n" + diff(expected_lines, actual)
-          assert(actual.include?(expected_lines), message)
+          test_ctx.assert(actual.include?(expected_lines), message)
         end
 
         protected
@@ -64,9 +64,9 @@ module HammerCLI
           end
         end
 
-        def assert_match(actual)
+        def assert_match(test_ctx, actual)
           @line_matchers.each do |matcher|
-            matcher.assert_match(actual)
+            matcher.assert_match(test_ctx, actual)
           end
         end
       end
@@ -76,7 +76,7 @@ module HammerCLI
           @expected_values = expected
         end
 
-        def assert_match(actual)
+        def assert_match(test_ctx, actual)
           message = [
             "Regex didn't match the output.",
             "Expected regex:",
@@ -87,7 +87,7 @@ module HammerCLI
             actual
           ].join("\n")
 
-          assert(line_regexp =~ actual, message)
+          test_ctx.assert(line_regexp =~ actual, message)
         end
 
         protected

data/lib/hammer_cli/utils.rb

@@ -8,10 +8,11 @@ class String
         name = name[0]
         params[name.to_s] || params[name.to_sym]
       end
-
-      self.gsub(/%[<]([^>]*)[>]/, '%').gsub(/%[{]([^}]*)[}]/, '%s') % array_params
+      self.gsub(/%[<]([^>]*)[>]/, '%')
+          .gsub(/%[{]([^}]*)[}]/, '%s')
+          .gsub(/\%(\W?[^bBdiouxXeEfgGaAcps])/, '%%\1') % array_params
     else
-      self % params
+      self.gsub(/\%(\W?[^bBdiouxXeEfgGaAcps])/, '%%\1') % params
     end
   end
 

data/lib/hammer_cli/version.rb

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

data/lib/hammer_cli.rb

@@ -21,4 +21,4 @@ require 'hammer_cli/apipie'
 # extend MainCommand
 require 'hammer_cli/shell'
 require 'hammer_cli/defaults'
-
+require 'hammer_cli/full_help'

data/test/unit/csv_parser_test.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require 'hammer_cli/csv_parser'
+
+describe HammerCLI::CSVParser do
+
+  describe 'parse' do
+    let(:parser) { HammerCLI::CSVParser.new }
+
+    it "parses nil" do
+      parser.parse(nil).must_equal []
+    end
+
+    it "parses empty string" do
+      parser.parse('').must_equal ['']
+    end
+
+    it "parses single value" do
+      parser.parse('a').must_equal ['a']
+    end
+
+    it "parses a dquoted string" do
+      parser.parse('\"a').must_equal ['"a']
+    end
+
+    it "parses a quoted string" do
+      parser.parse("Mary\\'s").must_equal ["Mary's"]
+    end
+
+    it "should parse a comma separated string" do
+      parser.parse("a,b,c").must_equal ['a', 'b', 'c']
+    end
+
+    it "parses a string with escaped comma" do
+      parser.parse('a\,b,c').must_equal ['a,b', 'c']
+    end
+
+    it "should parse a comma separated string with quotes" do
+      parser.parse('a,b,\\"c\\"').must_equal ['a', 'b', '"c"']
+    end
+
+    it "parses a comma separated string with values including comma" do
+      parser.parse('a,b,"c,d"').must_equal ['a', 'b', 'c,d']
+    end
+
+    it "parses a comma separated string with values including comma (dquotes)" do
+      parser.parse("a,b,'c,d'").must_equal ['a', 'b', 'c,d']
+    end
+
+    it "raises quoting error" do
+      err = proc { parser.parse('1,"3,4""s') }.must_raise ArgumentError
+      err.message.must_equal "Illegal quoting in \"3,4\"\"s"
+    end
+  end
+end

data/test/unit/exception_handler_test.rb

@@ -51,7 +51,8 @@ describe HammerCLI::ExceptionHandler do
     ex = RestClient::ResourceNotFound.new
     output.default_adapter = :silent
     handler.handle_exception(ex)
-    @log_output.readline.strip.must_match /ERROR  Exception : (Resource )?Not Found/
+    assert_match /Using exception handler HammerCLI::ExceptionHandler#handle_not_found/, @log_output.readline.strip
+    assert_match /ERROR  Exception : (Resource )?Not Found/, @log_output.readline.strip
   end
 
 end

data/test/unit/options/normalizers_test.rb

@@ -38,8 +38,12 @@ describe HammerCLI::Options::Normalizers do
       formatter.format('a,b,"c,d"').must_equal ['a', 'b', 'c,d']
     end
 
+    it "should parse a comma separated string with values including comma (doublequotes)" do
+      formatter.format("a,b,'c,d'").must_equal ['a', 'b', 'c,d']
+    end
+
     it "should parse a comma separated string containig double quotes" do
-      formatter.format('a,b,""c""').must_equal ['a', 'b', '"c"']
+      formatter.format('a,b,\"c\"').must_equal ['a', 'b', '"c"']
     end
 
     it "should catch quoting errors" do

data/test/unit/utils_test.rb

@@ -15,6 +15,7 @@ describe String do
     let(:str) { "AA%<a>s BB%<b>s" }
     let(:curly_str) { "AA%{a} BB%{b}" }
     let(:pos_str) { "AA%s BB%s" }
+    let(:str_with_percent) { "Error: AA%<a>s BB%<b>s <%# template error %> verify this %>" }
 
     it "should not fail without expected parameters" do
       str.format({}).must_equal 'AA BB'
@@ -36,6 +37,10 @@ describe String do
       curly_str.format(:a => 'A', :b => 'B').must_equal 'AAA BBB'
     end
 
+    it "should not fail due to presence of percent chars in string" do
+      str_with_percent.format({}).must_equal 'Error: AA BB <%# template error %> verify this %>'
+    end
+
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -188,11 +188,13 @@ files:
 - lib/hammer_cli/completer.rb
 - lib/hammer_cli/connection.rb
 - lib/hammer_cli/context.rb
+- lib/hammer_cli/csv_parser.rb
 - lib/hammer_cli/defaults.rb
 - lib/hammer_cli/defaults_commands.rb
 - lib/hammer_cli/exception_handler.rb
 - lib/hammer_cli/exceptions.rb
 - lib/hammer_cli/exit_codes.rb
+- lib/hammer_cli/full_help.rb
 - lib/hammer_cli/help/builder.rb
 - lib/hammer_cli/help/text_builder.rb
 - lib/hammer_cli/i18n.rb
@@ -263,6 +265,7 @@ files:
 - test/unit/ca_cert_manager_test.rb
 - test/unit/completer_test.rb
 - test/unit/connection_test.rb
+- test/unit/csv_parser_test.rb
 - test/unit/defaults_test.rb
 - test/unit/exception_handler_test.rb
 - test/unit/fixtures/apipie/architectures.json
@@ -329,16 +332,16 @@ signing_key:
 specification_version: 4
 summary: Universal command-line interface
 test_files:
-- test/unit/apipie/command_test.rb
 - test/unit/apipie/option_builder_test.rb
 - test/unit/apipie/option_definition_test.rb
 - test/unit/apipie/api_connection_test.rb
+- test/unit/apipie/command_test.rb
 - test/unit/options/matcher_test.rb
-- test/unit/options/normalizers_test.rb
 - test/unit/options/option_collector_test.rb
 - test/unit/options/option_definition_test.rb
 - test/unit/options/sources/command_line_test.rb
 - test/unit/options/sources/saved_defaults_test.rb
+- test/unit/options/normalizers_test.rb
 - test/unit/output/adapter/abstract_test.rb
 - test/unit/output/adapter/base_test.rb
 - test/unit/output/adapter/csv_test.rb
@@ -346,16 +349,14 @@ test_files:
 - test/unit/output/adapter/table_test.rb
 - test/unit/output/adapter/yaml_test.rb
 - test/unit/output/definition_test.rb
-- test/unit/output/dsl_test.rb
 - test/unit/output/field_filter_test.rb
 - test/unit/output/fields_test.rb
 - test/unit/output/formatters_test.rb
 - test/unit/output/output_test.rb
 - test/unit/output/record_collection_test.rb
+- test/unit/output/dsl_test.rb
 - test/unit/abstract_test.rb
 - test/unit/completer_test.rb
-- test/unit/connection_test.rb
-- test/unit/defaults_test.rb
 - test/unit/fixtures/apipie/architectures.json
 - test/unit/fixtures/apipie/documented.json
 - test/unit/fixtures/defaults/defaults.yml
@@ -374,10 +375,13 @@ test_files:
 - test/unit/option_builder_test.rb
 - test/unit/settings_test.rb
 - test/unit/test_helper.rb
-- test/unit/utils_test.rb
+- test/unit/ca_cert_manager_test.rb
 - test/unit/validator_test.rb
+- test/unit/connection_test.rb
+- test/unit/defaults_test.rb
+- test/unit/csv_parser_test.rb
 - test/unit/exception_handler_test.rb
-- test/unit/ca_cert_manager_test.rb
+- test/unit/utils_test.rb
 - test/functional/defaults_test.rb
 - test/functional/help_test.rb
 - test/functional/test_helper.rb