hammer_cli 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e73236442681ea0de600a7331e2d07f94c672269
-  data.tar.gz: 212fc6f1528868af2162ddacaa47cf1a0e0d57a2
+  metadata.gz: fb545eaee547129bde4d51c6ff709f7af30c61bd
+  data.tar.gz: 23f8915e5e2c306a2e194ebd7d42162d2f183b95
 SHA512:
-  metadata.gz: 6640289dfa481f0bd1061cf14be8a345277887b991476b07177ed8ebe7ebc59811edd45304ebe9e9def94c1c1ace7324bbb2e025ff07b11fc42d6095b00d591f
-  data.tar.gz: fcbb4cb0d83bdb7d77ef995843c5a83de6bb9f4da34424157ee94ddb5807d0c335832ad5fa2f36d04b522004b143d03a0aaf5e5a4f9497223e0bf1aa8ec77c05
+  metadata.gz: 3c9f22f4c7b10e0282f96be42317f0ac2514dba8ad4c2881d46eedeb6ceb01361ba6139c57b51ab382ac255d6a5bc527bde0880ee06d332dc938b7f08317ce4d
+  data.tar.gz: cba3583a4dff8bf01a9bf1835eb9393ea99eae965e3156a9bb14dafbb8412e49bd59f2b13b717a24453080ff3faeb2c8151f79a4c91e14f1124e9a0b92c1601d

data/doc/release_notes.md

@@ -1,7 +1,10 @@
 Release notes
 =============
-### 0.13.1 (2018-08-15)
-* restore help building ([PR #280](https://github.com/theforeman/hammer-cli/pull/280)) ([#24488](http://projects.theforeman.org/issues/24488))
+### 0.14.0 (2018-08-27)
+* Restore help building ([PR #280](https://github.com/theforeman/hammer-cli/pull/280)) ([#24488](http://projects.theforeman.org/issues/24488))
+* Shouldn't translate the bool values in description ([#21381](http://projects.theforeman.org/issues/21381))
+* Allow hiding fields which are missing from api output ([#20607](http://projects.theforeman.org/issues/20607))
+* Add not found error type ([PR #274](https://github.com/theforeman/hammer-cli/pull/274)) ([#20538](http://projects.theforeman.org/issues/20538))
 
 ### 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))

data/lib/hammer_cli/options/normalizers.rb

@@ -115,7 +115,7 @@ module HammerCLI
       class Bool < AbstractNormalizer
 
         def description
-          _("One of true/false, yes/no, 1/0")
+          _('One of %s.') % ['true/false', 'yes/no', '1/0'].join(', ')
         end
 
         def format(bool)
@@ -125,7 +125,7 @@ module HammerCLI
           elsif bool.downcase.match(/^(false|f|no|n|0)$/i)
             return false
           else
-            raise ArgumentError, _("Value must be one of true/false, yes/no, 1/0.")
+            raise ArgumentError, _('Value must be one of %s.') % ['true/false', 'yes/no', '1/0'].join(', ')
           end
         end
 

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

@@ -50,12 +50,13 @@ module HammerCLI::Output::Adapter
       path = field.path
 
       path.inject(record) do |record, path_key|
-        if record && record.kind_of?(Hash) && record.has_key?(path_key.to_sym)
+        return nil unless record && record.is_a?(Hash)
+        if record.key?(path_key.to_sym)
           record[path_key.to_sym]
-        elsif record && record.kind_of?(Hash) && record.has_key?(path_key.to_s)
+        elsif record.key?(path_key.to_s)
           record[path_key.to_s]
         else
-          return nil
+          HammerCLI::Output::DataMissing.new
         end
       end
     end
@@ -69,6 +70,17 @@ module HammerCLI::Output::Adapter
       $stdout
     end
 
+    def displayable_fields(fields, record, compact_only: false)
+      fields.select do |field|
+        field_data = data_for_field(field, record)
+        if compact_only && !field_data.is_a?(HammerCLI::Output::DataMissing)
+          true
+        else
+          field.display?(field_data)
+        end
+      end
+    end
+
     private
 
     def filter_formatters(formatters_map)

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

@@ -27,17 +27,11 @@ module HammerCLI::Output::Adapter
       HammerCLI::Output::FieldFilter.new(filtered)
     end
 
-    def filter_fields(fields, data)
-      field_filter.filter(fields).reject do |field|
-        field_data = data_for_field(field, data)
-        not field.display?(field_data)
-      end
-    end
-
     def render_fields(fields, data)
       output = ""
 
-      fields = filter_fields(fields, data)
+      fields = field_filter.filter(fields)
+      fields = displayable_fields(fields, data)
 
       label_width = label_width(fields)
 

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

@@ -157,6 +157,7 @@ module HammerCLI::Output::Adapter
     end
 
     def print_collection(fields, collection)
+      fields = displayable_fields(fields, collection.first, compact_only: true)
       rows = row_data(fields, collection)
       # get headers using columns heuristic
       headers = rows.map{ |r| Cell.headers(r, @context) }.max_by{ |headers| headers.size }

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

@@ -22,6 +22,7 @@ module HammerCLI::Output::Adapter
 
     def print_collection(all_fields, collection)
       fields = field_filter.filter(all_fields)
+      fields = displayable_fields(fields, collection.first, compact_only: true)
 
       formatted_collection = format_values(fields, collection)
       # calculate hash of column widths (label -> width)
@@ -52,7 +53,7 @@ module HammerCLI::Output::Adapter
       # and there is no --no-headers option
       output_stream.puts line unless formatted_collection.empty? || @context[:no_headers]
 
-      if collection.meta.pagination_set? && collection.count < collection.meta.subtotal
+      if collection.respond_to?(:meta) && collection.meta.pagination_set? && collection.count < collection.meta.subtotal
         pages = (collection.meta.subtotal.to_f/collection.meta.per_page).ceil
         puts _("Page %{page} of %{total} (use --page and --per-page for navigation).") % {:page => collection.meta.page, :total => pages}
       end

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

@@ -13,22 +13,16 @@ module HammerCLI::Output::Adapter
     end
 
     protected
+
     def field_filter
       filtered = []
       filtered << Fields::Id unless @context[:show_ids]
       HammerCLI::Output::FieldFilter.new(filtered)
     end
 
-    def filter_fields(fields, data)
-      field_filter.filter(fields).reject do |field|
-        field_data = data_for_field(field, data)
-        not field.display?(field_data)
-      end
-    end
-
     def render_fields(fields, data)
-      fields = filter_fields(fields, data)
-
+      fields = field_filter.filter(fields)
+      fields = displayable_fields(fields, data)
       fields.reduce({}) do |hash, field|
         field_data = data_for_field(field, data)
         next unless field.display?(field_data)

data/lib/hammer_cli/output/fields.rb

@@ -9,6 +9,7 @@ module Fields
 
     def initialize(options={})
       @hide_blank = options[:hide_blank].nil? ? false : options[:hide_blank]
+      @hide_missing = options[:hide_missing].nil? ? true : options[:hide_missing]
       @path = options[:path] || []
       @label = options[:label]
       @options = options
@@ -18,11 +19,15 @@ module Fields
       @hide_blank
     end
 
+    def hide_missing?
+      @hide_missing
+    end
+
     def display?(value)
-      if not hide_blank?
-        true
+      if value.is_a?(HammerCLI::Output::DataMissing)
+        !hide_missing?
       elsif value.nil?
-        false
+        !hide_blank?
       else
         true
       end
@@ -55,10 +60,10 @@ module Fields
     end
 
     def display?(value)
-      if not hide_blank?
-        true
+      if value.is_a?(HammerCLI::Output::DataMissing)
+        !hide_missing?
       elsif value.nil? || value.empty?
-        false
+        !hide_blank?
       else
         true
       end
@@ -83,6 +88,7 @@ module Fields
   class Label < ContainerField
 
     def display?(value)
+      return false if value.is_a?(HammerCLI::Output::DataMissing) && hide_missing?
       return true if not hide_blank?
 
       !(value.nil? || value.empty?) && fields.any? do |f|

data/lib/hammer_cli/output/output.rb

@@ -1,4 +1,10 @@
 module HammerCLI::Output
+  class DataMissing
+    def to_s
+      ''
+    end
+  end
+
   class Output
 
     def initialize(context={}, options={})

data/lib/hammer_cli/testing/command_assertions.rb

@@ -108,6 +108,13 @@ module HammerCLI
         expected_result
       end
 
+      def not_found_error_result(command, message, heading=nil)
+        expected_result = CommandExpectation.new
+        expected_result.expected_err = common_error(command, message, heading)
+        expected_result.expected_exit_code = HammerCLI::EX_NOT_FOUND
+        expected_result
+      end
+
       def success_result(message)
         CommandExpectation.new(message)
       end

data/lib/hammer_cli/version.rb

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

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

@@ -110,9 +110,9 @@ describe HammerCLI::Output::Adapter::Abstract do
       assert_nil adapter.send(:data_for_field, field, record)
     end
 
-    it "returns nil, if the data does not exist for the field" do
+    it "returns DataMissing instance, if the data does not exist for the field" do
       record = { :field2 => :value2 }
-      assert_nil adapter.send(:data_for_field, field, record)
+      assert_instance_of HammerCLI::Output::DataMissing, adapter.send(:data_for_field, field, record)
     end
 
     it "returns the value, if data exists for the field" do

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

@@ -26,6 +26,8 @@ describe HammerCLI::Output::Adapter::Base do
     let(:params_collection) { Fields::Collection.new(:path => [:params], :label => "Parameters") }
     let(:param)             { Fields::KeyValue.new(:path => nil, :label => nil) }
     let(:blank)             { Fields::Field.new(:path => [:blank], :label => "Blank", :hide_blank => true) }
+    let(:login)             { Fields::Field.new(:path => [:login], :label => "Login") }
+    let(:missing)           { Fields::Field.new(:path => [:login], :label => "Missing", :hide_missing => false) }
 
     let(:data) { HammerCLI::Output::RecordCollection.new [{
       :id => 112,
@@ -164,6 +166,25 @@ describe HammerCLI::Output::Adapter::Base do
       proc { adapter.print_collection(fields, data) }.must_output(expected_output)
     end
 
+    it "does not print fields which data are missing from api by default" do
+      fields = [name, login]
+      expected_output = [
+        "Name: John",
+        "\n"
+      ].join("\n")
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
+    it "prints fields which data are missing from api when field has hide_missing flag set to false" do
+      fields = [name, missing]
+      expected_output = [
+        "Name:    John",
+        "Missing:",
+        "\n"
+      ].join("\n")
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
     it "should print key -> value" do
       params_collection.output_definition.append [param]
       fields = [params_collection]

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

@@ -12,6 +12,8 @@ describe HammerCLI::Output::Adapter::CSValues do
 
     let(:field_name) { Fields::Field.new(:path => [:name], :label => "Name") }
     let(:field_started_at) { Fields::Field.new(:path => [:started_at], :label => "Started At") }
+    let(:field_login) { Fields::Field.new(:path => [:login], :label => "Login") }
+    let(:field_missing) { Fields::Field.new(:path => [:missing], :label => "Missing", :hide_missing => false) }
     let(:fields) {
       [field_name, field_started_at]
     }
@@ -32,6 +34,20 @@ describe HammerCLI::Output::Adapter::CSValues do
       err.must_match //
     end
 
+    it "does not print fields which data are missing from api by default" do
+      fields << field_login
+      out, err = capture_io { adapter.print_collection(fields, data) }
+      out.wont_match /.*Login.*/
+      err.must_match //
+    end
+
+    it "prints fields which data are missing from api when field has hide_missing flag set to false" do
+      fields << field_missing
+      out, err = capture_io { adapter.print_collection(fields, data) }
+      out.must_match /.*Missing.*/
+      err.must_match //
+    end
+
     context "handle ids" do
       let(:field_id) { Fields::Id.new(:path => [:some_id], :label => "Id") }
       let(:fields) {

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

@@ -58,6 +58,8 @@ describe HammerCLI::Output::Adapter::Json do
     let(:params_collection) { Fields::Collection.new(:path => [:params], :label => "Parameters") }
     let(:param)             { Fields::KeyValue.new(:path => nil, :label => nil) }
     let(:blank)             { Fields::Field.new(:path => [:blank], :label => "Blank", :hide_blank => true) }
+    let(:login)             { Fields::Field.new(:path => [:login], :label => "Login") }
+    let(:missing)           { Fields::Field.new(:path => [:missing], :label => "Missing", :hide_missing => false) }
 
     let(:data) { HammerCLI::Output::RecordCollection.new [{
       :id => 112,
@@ -206,6 +208,22 @@ describe HammerCLI::Output::Adapter::Json do
       proc { adapter.print_collection(fields, data) }.must_output(expected_output)
     end
 
+    it "does not print fields which data are missing from api by default" do
+      fields = [surname, login]
+      hash = [{ 'Surname' => 'Doe' }]
+      expected_output = JSON.pretty_generate(hash) + "\n"
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
+    it "prints fields which data are missing from api when field has hide_missing flag set to false" do
+      fields = [surname, missing]
+      hash = [{ 'Surname' => 'Doe', 'Missing' => '' }]
+      expected_output = JSON.pretty_generate(hash) + "\n"
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
     it "should print key -> value" do
       params_collection.output_definition.append [param]
       fields = [params_collection]

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

@@ -14,6 +14,8 @@ describe HammerCLI::Output::Adapter::Table do
     let(:field_firstname) { Fields::Field.new(:path => [:firstname], :label => "Firstname") }
     let(:field_lastname) { Fields::Field.new(:path => [:lastname], :label => "Lastname") }
     let(:field_long) { Fields::Field.new(:path => [:long], :label => "Full") }
+    let(:field_login) { Fields::Field.new(:path => [:login], :label => "Login") }
+    let(:field_missing) { Fields::Field.new(:path => [:missing], :label => "Missing", :hide_missing => false) }
 
     let(:fields) {
       [field_name]
@@ -45,6 +47,34 @@ describe HammerCLI::Output::Adapter::Table do
       proc { adapter.print_collection(fields, data) }.must_output(/.*John Doe.*/, "")
     end
 
+    it "does not print fields which data are missing from api by default" do
+      fields << field_login
+      expected_output = [
+        '--------',
+        'NAME    ',
+        '--------',
+        'John Doe',
+        '--------',
+        ''
+      ].join("\n")
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
+    it "prints fields which data are missing from api when field has hide_missing flag set to false" do
+      fields << field_missing
+      expected_output = [
+        '---------|--------',
+        'NAME     | MISSING',
+        '---------|--------',
+        'John Doe |        ',
+        '---------|--------',
+        ''
+      ].join("\n")
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
     context "pagination" do
       it "should print pagination info if data are not complete" do
         data = HammerCLI::Output::RecordCollection.new([record], { :total => 2, :page => 1, :per_page => 1, :subtotal => 2 })
@@ -58,7 +88,7 @@ describe HammerCLI::Output::Adapter::Table do
     end
 
     context "handle ids" do
-      let(:field_id) { Fields::Id.new(:path => [:some_id], :label => "Id") }
+      let(:field_id) { Fields::Id.new(:path => [:some_id], :label => "Id", :hide_missing => false) }
       let(:fields) {
         [field_name, field_id]
       }

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

@@ -56,6 +56,8 @@ describe HammerCLI::Output::Adapter::Yaml do
     let(:params_collection) { Fields::Collection.new(:path => [:params], :label => "Parameters") }
     let(:param)             { Fields::KeyValue.new(:path => nil, :label => nil) }
     let(:blank)             { Fields::Field.new(:path => [:blank], :label => "Blank", :hide_blank => true) }
+    let(:login)           { Fields::Field.new(:path => [:login], :label => "Login") }
+    let(:missing)           { Fields::Field.new(:path => [:missing], :label => "Missing", :hide_missing => false) }
 
     let(:data) { HammerCLI::Output::RecordCollection.new [{
       :id => 112,
@@ -203,6 +205,22 @@ describe HammerCLI::Output::Adapter::Yaml do
       proc { adapter.print_collection(fields, data) }.must_output(expected_output)
     end
 
+    it "does not print fields which data are missing from api by default" do
+      fields = [surname, login]
+      hash = [{ 'Surname' => 'Doe' }]
+      expected_output = YAML.dump(hash)
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
+    it "prints fields which data are missing from api when field has hide_missing flag set to false" do
+      fields = [surname, missing]
+      hash = [{ 'Surname' => 'Doe', 'Missing' => HammerCLI::Output::DataMissing.new }]
+      expected_output = YAML.dump(hash)
+
+      proc { adapter.print_collection(fields, data) }.must_output(expected_output)
+    end
+
     it "should print key -> value" do
       params_collection.output_definition.append [param]
       fields = [params_collection]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp