hammer_cli 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aa589ebe2589ead222c05b6b8a1de324f3efdb5
-  data.tar.gz: 1068b381dbe8685c2a1d7bc0168513f5e48ccce9
+  metadata.gz: 4a07530fca2559a9ab75f4e287a46ede2a38d3cd
+  data.tar.gz: '0088bd037fda97450755a19d7479e6994549dc96'
 SHA512:
-  metadata.gz: c7153a9ebaab813ef8ea1061461efd60c1e357f5445187762203aed5055bb1e38eac86d787f4bec013e5cc78e84afd40fbb3ac81cef8a3b1844732356a7f864f
-  data.tar.gz: ff4d24d0067d7e500ee573bfb82531637c67f557d1ef9745d4b2587ed31e9edbac0aa6d47eb79778e97658627495f3327b5cac0626d56ea04dfd8a27c7c1b8ba
+  metadata.gz: 1b0853ed83f5ceb835fed41d833de7d2abbb789a31ed5b3fff8d35a96c82327bc5d3b2746088d3eb895a61f93ac7da22fc254cf4dfc934455fd3b533a60c62c1
+  data.tar.gz: 5c87348a2eebc66ccd5207c0c5aeaa43dbb3c6277a0d977a5e3c8f043e798cee71f2a3a81f57a3af77c6a408fcbe75e63335121402c5de65dd610a76c188f03a

data/bin/hammer

@@ -30,6 +30,7 @@ class PreParser < Clamp::Command
   option ["--csv"], :flag, "Output as CSV (same as --output=csv)"
   option ["--output"], "ADAPTER", "Set output format"
   option ["--no-headers"], :flag, "Hide headers from output"
+  option ["--output-file"], "OUTPUT_FILE", "Path to custom output file"
   option ["--csv-separator"], "SEPARATOR", "Character to separate the values"
   option ["--autocomplete"], "LINE", "Get list of possible endings"
   option ["--verify-ssl"], "VERIFY_SSL", "Configure SSL verification of remote system" do |value|

data/doc/release_notes.md

@@ -1,5 +1,10 @@
 Release notes
 =============
+### 0.13.0 (2018-05-09)
+* Hammer CSV output saved as a file ([PR #254](https://github.com/theforeman/hammer-cli/pull/254)) ([#11586](http://projects.theforeman.org/issues/11586))
+* correct parsing of enum types ([PR #272](https://github.com/theforeman/hammer-cli/pull/272)) ([#22752](http://projects.theforeman.org/issues/22752))
+* require logger ([PR #273](https://github.com/theforeman/hammer-cli/pull/273)) ([#22906](http://projects.theforeman.org/issues/22906))
+* Better help for unsupported hammer commands ([PR #257](https://github.com/theforeman/hammer-cli/pull/257)) ([#18532](http://projects.theforeman.org/issues/18532))
 
 ### 0.12.0 (2018-02-19)
 * Tests for message formats ([PR #266](https://github.com/theforeman/hammer-cli/pull/266)) ([#7451](http://projects.theforeman.org/issues/7451))

data/lib/hammer_cli.rb

@@ -5,6 +5,7 @@ require 'hammer_cli/version'
 require 'hammer_cli/modules'
 require 'hammer_cli/exit_codes'
 require 'hammer_cli/settings'
+require 'hammer_cli/logger'
 require 'hammer_cli/ca_cert_manager'
 require 'hammer_cli/connection'
 require 'hammer_cli/validator'

data/lib/hammer_cli/apipie/command.rb

@@ -36,6 +36,14 @@ module HammerCLI::Apipie
       return HammerCLI::EX_OK
     end
 
+    def help
+      help_str = super
+      if !resource || (!action.nil? && !resource.has_action?(action))
+        help_str << "\n" + _("Unfortunately the server does not support such operation.") + "\n"
+      end
+      help_str
+    end
+
     protected
 
     def send_request

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.to_s == 'array' || param.validator =~ /Array/i
+      if param.expected_type.to_s == 'array'
         opts[:format] = HammerCLI::Options::Normalizers::List.new
-      elsif param.expected_type.to_s == 'boolean' || param.validator =~ /Boolean/i
+      elsif param.expected_type.to_s == 'boolean' || param.validator.to_s == 'boolean'
         opts[:format] = HammerCLI::Options::Normalizers::Bool.new
-      elsif param.validator =~ /Must be one of: (.*)\./
+      elsif param.expected_type.to_s == 'string' && 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.to_s == 'numeric' || param.validator =~ /Number/i || param.validator =~ /Integer/i
+      elsif param.expected_type.to_s == 'numeric'
         opts[:format] = HammerCLI::Options::Normalizers::Number.new
       end
       opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)

data/lib/hammer_cli/main.rb

@@ -44,6 +44,13 @@ module HammerCLI
     option ["--output"], "ADAPTER", _("Set output format. One of [%s]") %
       HammerCLI::Output::Output.adapters.keys.join(', '),
       :context_target => :adapter
+    option ["--output-file"], "OUTPUT_FILE", _("Path to custom output file") do |filename|
+      begin
+        context[:output_file] = File.new(filename, 'w')
+      rescue SystemCallError, IOError => e
+        raise ArgumentError, e
+      end
+    end
     option ["--csv-separator"], "SEPARATOR", _("Character to separate the values"),
       :context_target => :csv_separator
 

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

@@ -64,6 +64,11 @@ module HammerCLI::Output::Adapter
       Abstract.data_for_field(field, record)
     end
 
+    def output_stream
+      return @context[:output_file] if @context.has_key?(:output_file)
+      $stdout
+    end
+
     private
 
     def filter_formatters(formatters_map)

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

@@ -14,8 +14,8 @@ module HammerCLI::Output::Adapter
 
     def print_collection(fields, collection)
       collection.each do |data|
-        puts render_fields(fields, data)
-        puts
+        output_stream.puts render_fields(fields, data)
+        output_stream.puts
       end
     end
 

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

@@ -168,7 +168,7 @@ module HammerCLI::Output::Adapter
           csv << Cell.values(headers, row)
         end
       end
-      puts csv_string
+      output_stream.puts csv_string
     end
 
     def print_message(msg, msg_params={})

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

@@ -3,12 +3,12 @@ module HammerCLI::Output::Adapter
 
     def print_record(fields, record)
       result = prepare_collection(fields, [record].flatten(1))
-      puts JSON.pretty_generate(result.first)
+      output_stream.puts JSON.pretty_generate(result.first)
     end
 
     def print_collection(fields, collection)
       result = prepare_collection(fields, collection)
-      puts JSON.pretty_generate(result)
+      output_stream.puts JSON.pretty_generate(result)
     end
 
     def print_message(msg, msg_params={})

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

@@ -36,21 +36,21 @@ module HammerCLI::Output::Adapter
 
       line = hline_bits.join(LINE_SEPARATOR)
       unless @context[:no_headers]
-        puts line
-        puts header_bits.join(COLUMN_SEPARATOR)
-        puts line
+        output_stream.puts line
+        output_stream.puts header_bits.join(COLUMN_SEPARATOR)
+        output_stream.puts line
       end
 
       formatted_collection.collect do |row|
         row_bits = fields.map do |f|
           normalize_column(widths[f.label], row[f.label] || "")
         end
-        puts row_bits.join(COLUMN_SEPARATOR)
+        output_stream.puts row_bits.join(COLUMN_SEPARATOR)
       end
 
       # print closing line only when the table isn't empty
       # and there is no --no-headers option
-      puts line unless formatted_collection.empty? || @context[:no_headers]
+      output_stream.puts line unless formatted_collection.empty? || @context[:no_headers]
 
       if collection.meta.pagination_set? && collection.count < collection.meta.subtotal
         pages = (collection.meta.subtotal.to_f/collection.meta.per_page).ceil

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

@@ -3,12 +3,12 @@ module HammerCLI::Output::Adapter
 
     def print_record(fields, record)
       result = prepare_collection(fields, [record].flatten(1))
-      puts YAML.dump(result.first)
+      output_stream.puts YAML.dump(result.first)
     end
 
     def print_collection(fields, collection)
       result = prepare_collection(fields, collection)
-      puts YAML.dump(result)
+      output_stream.puts YAML.dump(result)
     end
 
     def print_message(msg, msg_params={})

data/lib/hammer_cli/version.rb

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

data/test/unit/apipie/command_test.rb

@@ -29,11 +29,24 @@ describe HammerCLI::Apipie::Command do
   class CommandC < CommandA
   end
 
+  class CommandUnsupp < HammerCLI::Apipie::Command
+    resource :architectures, :unsupptest
+  end
+
   let(:ctx) { { :adapter => :silent, :interactive => false } }
   let(:cmd_class) { HammerCLI::Apipie::Command.dup }
   let(:cmd) { cmd_class.new("", ctx) }
   let(:cmd_run) { cmd.run([]) }
 
+  context "unsupported commands" do
+    let(:cmd_class) { CommandUnsupp.dup }
+    let(:cmd) { cmd_class.new("unsupported", ctx) }
+    it "should print help for unsupported command" do
+      assert_match /.*Unfortunately the server does not support such operation.*/, cmd.help
+    end
+
+  end
+
   context "setting resources" do
 
     it "should set resource and action together" do

data/test/unit/apipie/option_builder_test.rb

@@ -90,7 +90,12 @@ describe HammerCLI::Apipie::OptionBuilder do
     it "should set enum normalizer and handle coded values" do
       enum_option = options.find {|o| o.attribute_name == HammerCLI.option_accessor_name("coded_enum_param") }
       enum_option.value_formatter.class.must_equal HammerCLI::Options::Normalizers::Enum
-      enum_option.value_formatter.allowed_values.sort.must_equal ["tomas", "tereza"].sort
+      enum_option.value_formatter.allowed_values.sort.must_equal ["array", "boolean", "hash", "integer", "json", "real", "string", "yaml"].sort
+    end
+
+    it "should set list normalizer for array of nested elements" do
+      array_option = options.find {|o| o.attribute_name == HammerCLI.option_accessor_name("nested_elements_param") }
+      array_option.value_formatter.class.must_equal HammerCLI::Options::Normalizers::List
     end
 
     it "should set number normalizer" do

data/test/unit/fixtures/apipie/documented.json

@@ -148,11 +148,20 @@
                                 "description": "",
                                 "required": false
                             },
+                            {
+                                "name": "nested_elements_param",
+                                "full_name": "documented[nested_elements_param]",
+                                "allow_nil": true,
+                                "validator": "Must be an Array of nested elements",
+                                "expected_type": "array",
+                                "description": "",
+                                "required": false
+                            },
                             {
                                 "name": "coded_enum_param",
                                 "full_name": "documented[coded_enum_param]",
                                 "allow_nil": true,
-                                "validator": "Must be one of: <code>tomas</code>, <code>tereza</code>.",
+                                "validator": "Must be one of: <code>string</code>, <code>boolean</code>, <code>integer</code>, <code>real</code>, <code>array</code>, <code>hash</code>, <code>yaml</code>, <code>json</code>.",
                                 "expected_type": "string",
                                 "description": "",
                                 "required": false

data/test/unit/output/adapter/base_test.rb

@@ -195,6 +195,31 @@ describe HammerCLI::Output::Adapter::Base do
 
     end
 
+    context "output_stream" do
+
+      let(:tempfile) { Tempfile.new("output_stream_base_test_temp") }
+      let(:context) { {:output_file => tempfile} }
+
+      it "should not print to stdout when --output-file is set" do
+        fields = [name]
+
+        proc { adapter.print_collection(fields, data) }.must_output("")
+      end
+
+      it "should print to file if --output-file is set" do
+        fields = [name]
+        expected_output = [
+          "Name: John",
+          "\n"
+        ].join("\n")
+
+        adapter.print_collection(fields, data)
+        tempfile.close
+        IO.read(tempfile.path).must_equal(expected_output)
+      end
+
+    end
+
   end
 
 end

data/test/unit/output/adapter/csv_test.rb

@@ -203,6 +203,30 @@ describe HammerCLI::Output::Adapter::CSValues do
         out.must_match(/.*NIL.*/)
       end
     end
+
+    context "output_stream" do
+
+      let(:tempfile) { Tempfile.new("output_stream_csv_test_temp") }
+      let(:context) { {:output_file => tempfile} }
+      let(:adapter) { HammerCLI::Output::Adapter::CSValues.new(context, HammerCLI::Output::Output.formatters) }
+
+      it "should not print to stdout when --output-file is set" do
+        fields = [field_name]
+
+        proc { adapter.print_collection(fields, data) }.must_output("")
+      end
+
+      it "should print to file if --output-file is set" do
+        fields = [field_name]
+        expected_output = "Name\nJohn Doe\n"
+
+        adapter.print_collection(fields, data)
+        tempfile.close
+        IO.read(tempfile.path).must_equal(expected_output)
+      end
+
+    end
+
   end
 
   context "print message" do

data/test/unit/output/adapter/json_test.rb

@@ -243,6 +243,31 @@ describe HammerCLI::Output::Adapter::Json do
 
     end
 
+    context "output_stream" do
+
+      let(:tempfile) { Tempfile.new("output_stream_json_test_temp") }
+      let(:context) { {:output_file => tempfile} }
+
+      it "should not print to stdout when --output-file is set" do
+        fields = [name]
+
+        proc { adapter.print_collection(fields, data) }.must_output("")
+      end
+
+      it "should print to file if --output-file is set" do
+        fields = [name]
+        hash = [{
+                  'Name' => 'John'
+                }]
+        expected_output = JSON.pretty_generate(hash) + "\n"
+
+        adapter.print_collection(fields, data)
+        tempfile.close
+        IO.read(tempfile.path).must_equal(expected_output)
+      end
+
+    end
+
   end
 
 end

data/test/unit/output/adapter/table_test.rb

@@ -349,6 +349,37 @@ describe HammerCLI::Output::Adapter::Table do
       end
 
     end
+
+    context "output_stream" do
+
+      let(:tempfile) { Tempfile.new("output_stream_table_test_temp") }
+      let(:context) { {:output_file => tempfile} }
+      let(:adapter) { HammerCLI::Output::Adapter::Table.new(context, HammerCLI::Output::Output.formatters) }
+
+      it "should not print to stdout when --output-file is set" do
+        fields = [field_firstname]
+
+        proc { adapter.print_collection(fields, data) }.must_output("")
+      end
+
+      it "should print to file if --output-file is set" do
+        fields = [field_firstname]
+        expected_output = [
+          "---------",
+          "FIRSTNAME",
+          "---------",
+          "John     ",
+          "---------",
+          ""
+        ].join("\n")
+
+        adapter.print_collection(fields, data)
+        tempfile.close
+        IO.read(tempfile.path).must_equal(expected_output)
+      end
+
+    end
+
   end
 
 end

data/test/unit/output/adapter/yaml_test.rb

@@ -240,6 +240,31 @@ describe HammerCLI::Output::Adapter::Yaml do
 
     end
 
+    context "output_stream" do
+
+      let(:tempfile) { Tempfile.new("output_stream_yaml_test_temp") }
+      let(:context) { {:output_file => tempfile} }
+
+      it "should not print to stdout when --output-file is set" do
+        fields = [name]
+
+        proc { adapter.print_collection(fields, data) }.must_output("")
+      end
+
+      it "should print to file if --output-file is set" do
+        fields = [name]
+        hash = [{
+                  'Name' => 'John'
+                }]
+        expected_output = YAML.dump(hash)
+
+        adapter.print_collection(fields, data)
+        tempfile.close
+        IO.read(tempfile.path).must_equal(expected_output)
+      end
+
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -488,7 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Universal command-line interface