hammer_cli 0.19.1 → 2.2.0

data/test/unit/exception_handler_test.rb

@@ -55,4 +55,48 @@ describe HammerCLI::ExceptionHandler do
     assert_match /ERROR  Exception : (Resource )?Not Found/, @log_output.readline.strip
   end
 
+  it "should print default prompts for standard missing arguments" do
+    params = %w[login mail]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--login', '--mail'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print right prompts for nested missing arguments" do
+    params = %w[user[login] user[mail]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--login', '--mail'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print simple prompts for even more nested arguments" do
+    params = %w[user[address][city] user[address][street]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--address'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print simple prompts for even more different nested arguments" do
+    params = %w[user[address][city] user[address][street] user[nested][par1]]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--address', '--nested'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
+
+  it "should print default prompts for standard missing arguments" do
+    params = %w[opt_abc opt_a_b-c]
+    heading = 'Could not create user:'
+    body = "Missing arguments for '--opt-abc', '--opt-a-b-c'."
+    ex = ApipieBindings::MissingArgumentsError.new(params)
+    output.expects(:print_error).with(heading, body)
+    handler.handle_exception(ex, heading: heading)
+  end
 end

data/test/unit/help/builder_test.rb

@@ -69,4 +69,26 @@ describe HammerCLI::Help::Builder do
       help.string.strip.must_equal expected_output
     end
   end
+
+  describe 'option family' do
+    let(:family) { Class.new(HammerCLI::Options::OptionFamily) }
+
+    it 'prints option families' do
+      fm1 = family.new
+      fm1.parent(['--option-zzz'], 'OPT', 'Some description')
+      fm1.child(['--option-aaa'], 'OPT', 'Some description')
+      fm2 = family.new
+      fm2.parent(['--option-bbb'], 'OPT', 'Some description')
+      fm2.child(['--option-yyy'], 'OPT', 'Some description')
+
+      options = fm1.all + fm2.all
+      help.add_list('Options', options)
+
+      help.string.strip.must_equal [
+        'Options:',
+        ' --option[-yyy|-bbb]           Some description',
+        ' --option[-aaa|-zzz]           Some description',
+      ].join("\n")
+    end
+  end
 end

data/test/unit/options/option_family_test.rb

@@ -0,0 +1,48 @@
+require_relative '../test_helper'
+
+describe HammerCLI::Options::OptionFamily do
+  let(:family) do
+    HammerCLI::Options::OptionFamily.new(
+      deprecated: { '--test-one' => 'Use --test-two instead' }
+    )
+  end
+  let(:first_option) { HammerCLI::Apipie::OptionDefinition.new("--test-one", '', '') }
+  let(:second_option) { HammerCLI::Apipie::OptionDefinition.new("--test-two", '', '') }
+  let(:third_option) { HammerCLI::Apipie::OptionDefinition.new("--test-three", '', '') }
+  let(:full_family) do
+    family.parent('--test-one', '', 'Test').family.child('--test-two', '', '').family
+  end
+
+  describe 'switch' do
+    it 'returns nil if family is empty' do
+      family.switch.must_be_nil
+    end
+
+    it 'returns parent switch if family has no children' do
+      family.parent('--test-one', '', '')
+      family.switch.must_equal '--test-one'
+    end
+
+    it 'returns switch based on members' do
+      full_family.switch.must_equal '--test[-two|-one]'
+    end
+  end
+
+  describe 'description' do
+    it 'returns parent description if nothing passed to initializer' do
+      full_family.description.must_equal full_family.head.help[1]
+    end
+
+    it 'returns description with deprecation message' do
+      full_family.description.must_equal 'Test (--test-one is deprecated: Use --test-two instead)'
+    end
+  end
+
+  describe 'adopt' do
+    it 'appends an option to children' do
+      full_family.adopt(third_option)
+      full_family.children.size.must_equal 2
+      third_option.family.must_equal full_family
+    end
+  end
+end

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

@@ -199,6 +199,64 @@ describe HammerCLI::Output::Adapter::Base do
       proc { adapter.print_collection(fields, data) }.must_output(expected_output)
     end
 
+    context 'printing by chunks' do
+      let(:context) { { show_ids: true } }
+      let(:collection_count) { 30 }
+      let(:collection_data) do
+        collection = collection_count.times.each_with_object([]) do |t, r|
+          r << { id: t, name: "John #{t}"}
+        end
+        HammerCLI::Output::RecordCollection.new(collection)
+      end
+      let(:fields) { [id, name] }
+
+      it 'prints single chunk' do
+        expected_output = collection_count.times.each_with_object([]) do |t, r|
+          r << ["Id:   #{t}", "Name: John #{t}", "\n"].join("\n")
+        end.flatten(1).join
+
+        proc do
+          adapter.print_collection(fields, collection_data)
+        end.must_output(expected_output)
+      end
+
+      it 'prints first chunk' do
+        expected_output = 10.times.each_with_object([]) do |t, r|
+          r << ["Id:   #{t}", "Name: John #{t}", "\n"].join("\n")
+        end.flatten(1).join
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[0...10], current_chunk: :first
+          )
+        end.must_output(expected_output)
+      end
+
+      it 'prints another chunk' do
+        expected_output = (10...20).each_with_object([]) do |t, r|
+          r << ["Id:   #{t}", "Name: John #{t}", "\n"].join("\n")
+        end.flatten(1).join
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[10...20], current_chunk: :another
+          )
+        end.must_output(expected_output)
+      end
+
+      it 'prints last chunk' do
+        expected_output = (20...30).each_with_object([]) do |t, r|
+          r << ["Id:   #{t}", "Name: John #{t}", "\n"].join("\n")
+        end.flatten(1).join
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[20...30], current_chunk: :last
+          )
+        end.must_output(expected_output)
+      end
+    end
+
     context "show ids" do
 
       let(:context) { {:show_ids => true} }

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

@@ -9,7 +9,7 @@ describe HammerCLI::Output::Adapter::CSValues do
   end
 
   context "print_collection" do
-
+    let(:field_id) { Fields::Id.new(:path => [:id], :label => "Id") }
     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") }
@@ -220,6 +220,68 @@ describe HammerCLI::Output::Adapter::CSValues do
       end
     end
 
+    context 'printing by chunks' do
+      let(:adapter) { HammerCLI::Output::Adapter::CSValues.new(show_ids: true) }
+      let(:collection_count) { 30 }
+      let(:collection_data) do
+        collection = collection_count.times.each_with_object([]) do |t, r|
+          r << { id: t, name: "John #{t}"}
+        end
+        HammerCLI::Output::RecordCollection.new(collection)
+      end
+      let(:fields) { [field_id, field_name] }
+
+      it 'prints single chunk' do
+        expected_output = collection_count.times.each_with_object([]) do |t, r|
+          r << ["#{t}", "John #{t}"].join(',')
+        end.flatten(1).unshift('Id,Name').join("\n") + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(fields, collection_data)
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints first chunk' do
+        expected_output = 10.times.each_with_object([]) do |t, r|
+          r << ["#{t}", "John #{t}"].join(',')
+        end.flatten(1).unshift('Id,Name').join("\n") + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[0...10], current_chunk: :first
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints another chunk' do
+        expected_output = (10...20).each_with_object([]) do |t, r|
+          r << ["#{t}", "John #{t}"].join(',')
+        end.flatten(1).join("\n") + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[10...20], current_chunk: :another
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints last chunk' do
+        expected_output = (20...30).each_with_object([]) do |t, r|
+          r << ["#{t}", "John #{t}"].join(',')
+        end.flatten(1).join("\n") + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[20...30], current_chunk: :last
+          )
+        end
+        out.must_equal(expected_output)
+      end
+    end
+
     context "output_stream" do
 
       let(:tempfile) { Tempfile.new("output_stream_csv_test_temp") }

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

@@ -316,6 +316,67 @@ describe HammerCLI::Output::Adapter::Json do
       end
     end
 
+    context 'printing by chunks' do
+      let(:settings) { HammerCLI::Settings }
+      let(:context) { { show_ids: true, capitalization: HammerCLI.capitalization } }
+      let(:collection_count) { 30 }
+      let(:collection) do
+        collection_count.times.each_with_object([]) do |t, r|
+          r << { id: t, name: "John #{t}"}
+        end
+      end
+      let(:collection_data) do
+        HammerCLI::Output::RecordCollection.new(collection)
+      end
+      let(:fields) { [id, name] }
+
+      before do
+        settings.load(ui: { capitalization: :downcase })
+      end
+
+      it 'prints single chunk' do
+        expected_output = JSON.pretty_generate(collection) + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(fields, collection_data)
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints first chunk' do
+        expected_output = JSON.pretty_generate(collection[0...10])[0...-2] + ",\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[0...10], current_chunk: :first
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints another chunk' do
+        expected_output = JSON.pretty_generate(collection[10...20])[2...-2] + ",\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[10...20], current_chunk: :another
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints last chunk' do
+        expected_output = JSON.pretty_generate(collection[20...30])[2..-1] + "\n"
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[20...30], current_chunk: :last
+          )
+        end
+        out.must_equal(expected_output)
+      end
+    end
+
     context "show ids" do
 
       let(:context) { {:show_ids => true} }

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

@@ -9,7 +9,7 @@ describe HammerCLI::Output::Adapter::Table do
   end
 
   context "print_collection" do
-
+    let(:field_id) { Fields::Id.new(:path => [:id], :label => "Id") }
     let(:field_name) { Fields::Field.new(:path => [:fullname], :label => "Name") }
     let(:field_firstname) { Fields::Field.new(:path => [:firstname], :label => "Firstname") }
     let(:field_lastname) { Fields::Field.new(:path => [:lastname], :label => "Lastname") }
@@ -380,6 +380,75 @@ describe HammerCLI::Output::Adapter::Table do
 
     end
 
+    context 'printing by chunks' do
+      let(:adapter) { HammerCLI::Output::Adapter::Table.new(show_ids: true) }
+      let(:collection_count) { 30 }
+      let(:collection_data) do
+        collection = collection_count.times.each_with_object([]) do |t, r|
+          r << { id: t, fullname: "John Doe #{t}"}
+        end
+        HammerCLI::Output::RecordCollection.new(collection)
+      end
+      let(:fields) { [field_id, field_name] }
+
+      it 'prints single chunk' do
+        expected_output = collection_count.times.each_with_object([]) do |t, r|
+          sp = t < 10 ? ' ' : ''
+          r << ["#{t} #{sp}| John Doe #{t}#{sp}"]
+        end.flatten(1).unshift(
+          '---|------------',
+          'ID | NAME       ',
+          "---|------------",
+        ).join("\n") + "\n---|------------\n"
+
+        proc do
+          adapter.print_collection(fields, collection_data)
+        end.must_output(expected_output)
+      end
+
+      it 'prints first chunk' do
+        expected_output = (0...10).each_with_object([]) do |t, r|
+          r << [
+            "#{t}  | John Doe #{t}"
+          ]
+        end.flatten(1).unshift(
+          '---|-----------',
+          'ID | NAME      ',
+          "---|-----------",
+        ).join("\n") + "\n"
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[0...10], current_chunk: :first
+          )
+        end.must_output(expected_output)
+      end
+
+      it 'prints another chunk' do
+        expected_output = (10...20).each_with_object([]) do |t, r|
+          r << ["#{t} | John Doe #{t}"]
+        end.flatten(1).join("\n") + "\n"
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[10...20], current_chunk: :another
+          )
+        end.must_output(expected_output)
+      end
+      #
+      it 'prints last chunk' do
+        expected_output = (20...30).each_with_object([]) do |t, r|
+          r << ["#{t} | John Doe #{t}"]
+        end.flatten(1).join("\n") + "\n---|------------\n"
+
+        proc do
+          adapter.print_collection(
+            fields, collection_data[20...30], current_chunk: :last
+          )
+        end.must_output(expected_output)
+      end
+    end
+
     context "output_stream" do
 
       let(:tempfile) { Tempfile.new("output_stream_table_test_temp") }

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

@@ -312,6 +312,65 @@ describe HammerCLI::Output::Adapter::Yaml do
       end
     end
 
+    context 'printing by chunks' do
+      let(:context) { { show_ids: true } }
+      let(:collection_count) { 30 }
+      let(:collection) do
+        collection_count.times.each_with_object([]) do |t, r|
+          r << { id: t, name: "John #{t}"}
+        end
+      end
+      let(:prepared_collection) do
+        collection.map { |i| i.transform_keys { |k| k.to_s.capitalize } }
+      end
+      let(:collection_data) do
+        HammerCLI::Output::RecordCollection.new(collection)
+      end
+      let(:fields) { [id, name] }
+
+      it 'prints single chunk' do
+        expected_output = YAML.dump(prepared_collection)
+
+        out, _err = capture_io do
+          adapter.print_collection(fields, collection_data)
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints first chunk' do
+        expected_output = YAML.dump(prepared_collection[0...10])
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[0...10], current_chunk: :first
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints another chunk' do
+        expected_output = YAML.dump(prepared_collection[10...20])[4..-1]
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[10...20], current_chunk: :another
+          )
+        end
+        out.must_equal(expected_output)
+      end
+
+      it 'prints last chunk' do
+        expected_output = YAML.dump(prepared_collection[20...30])[4..-1]
+
+        out, _err = capture_io do
+          adapter.print_collection(
+            fields, collection_data[20...30], current_chunk: :last
+          )
+        end
+        out.must_equal(expected_output)
+      end
+    end
+
     context "show ids" do
 
       let(:context) { {:show_ids => true} }