hammer_cli 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 009e7aa80bff80abe875cff5efe57e351b27901e
-  data.tar.gz: 0efeda00147b71a2a90be95c3cd2c6aa0f37a5d5
+  metadata.gz: 367645958584805f4e59145418616c507fd9144a
+  data.tar.gz: d89c9715a3b0b66dacb21708d878c12e9c542e84
 SHA512:
-  metadata.gz: 4af2dc0f31f5dd8e2335b99d0600d209192b81d26feaa11bd68d0e5cac1745378b357e9612ae13723edb789aa288212780e304b15bffad3c938bc3b22c7591fe
-  data.tar.gz: 02e6d0e3e9613c9252f75c96db03f20936b2250cd040da01c9ce824569d99bedcb8c3a9a40a58345316b9c5347d13ddc25679703b858949409c7fc582a8e3d68
+  metadata.gz: 0eb7b32bc92e6d4ebedf52c8e9334ba2acab69808967b02a6e6b92110f936fccc9ede2febfb20e970eaa994c1b05582f83b46b964aef4c2307c2f6f01d4f75d3
+  data.tar.gz: 28164cbd24f5a912b4de8e97e10c917a2690378750ccfd6125f1e4104ff43bea883408f2fca13b70bcbd6abda325f4470b8607b1c4626303b50d7f9bfec0f4d8

data/config/cli_config.template.yml

@@ -10,6 +10,8 @@
 # :watch_plain: true disables color output of logger.watch in Clamp commands
 :watch_plain: false
 
+
 #:log_dir: '/var/log/foreman'
 :log_dir: '~/.foreman/log'
 :log_level: 'error'
+:log_api_calls: false

data/lib/hammer_cli/abstract.rb

@@ -122,8 +122,12 @@ module HammerCLI
 
     protected
 
-    def print_records(definition, records)
-      output.print_records(definition, records)
+    def print_record(definition, record)
+      output.print_record(definition, record)
+    end
+
+    def print_collection(definition, collection)
+      output.print_collection(definition, collection)
     end
 
     def print_message(msg, msg_params={})

data/lib/hammer_cli/apipie/read_command.rb

@@ -6,7 +6,7 @@ module HammerCLI::Apipie
 
       def execute
         d = retrieve_data
-        logger.watch "Retrieved data: ", d
+        logger.debug "Retrieved data: " + d.ai(:raw => true) if HammerCLI::Settings.get(:log_api_calls)
         print_data d
         return HammerCLI::EX_OK
       end
@@ -18,7 +18,7 @@ module HammerCLI::Apipie
       end
 
       def print_data(records)
-        print_records(output_definition, records)
+        print_collection(output_definition, records)
       end
 
       def request_params

data/lib/hammer_cli/apipie/resource.rb

@@ -34,7 +34,10 @@ module HammerCLI::Apipie
     end
 
     def call(method_name, params=nil)
-      instance.send(method_name, params)
+      Logging.logger[resource_class.name].debug "Calling '#{method_name}' with params #{params.ai}" if HammerCLI::Settings.get(:log_api_calls)
+      result = instance.send(method_name, params)
+      Logging.logger[resource_class.name].debug "Method '#{method_name}' responded with #{result[0].ai}" if HammerCLI::Settings.get(:log_api_calls)
+      result
     end
 
     private

data/lib/hammer_cli/apipie/write_command.rb

@@ -7,9 +7,7 @@ module HammerCLI::Apipie
     include HammerCLI::Messages
 
     def execute
-      response = send_request
-      logger.watch "Retrieved data: ", response
-      print_success_message(response)
+      print_success_message(send_request)
       return HammerCLI::EX_OK
     end
 

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

@@ -27,7 +27,11 @@ module HammerCLI::Output::Adapter
       $stderr.puts msg.format(msg_params)
     end
 
-    def print_records(fields, data)
+    def print_record(fields, record)
+      raise NotImplementedError
+    end
+
+    def print_collection(fields, collection)
       raise NotImplementedError
     end
 

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

@@ -8,10 +8,14 @@ module HammerCLI::Output::Adapter
       [:flat, :screen]
     end
 
-    def print_records(fields, data)
+    def print_record(fields, record)
+      print_collection(fields, [record].flatten(1))
+    end
+
+    def print_collection(fields, collection)
       self.fields = fields
 
-      data.each do |d|
+      collection.each do |d|
         fields.collect do |f|
           render_field(f, d)
         end

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

@@ -16,12 +16,16 @@ module HammerCLI::Output::Adapter
       [:flat]
     end
 
-    def print_records(fields, data)
+    def print_record(fields, record)
+      print_collection(fields, [record].flatten(1))
+    end
+
+    def print_collection(fields, collection)
       csv_string = generate do |csv|
         # labels
         csv << fields.select{ |f| !(f.class <= Fields::Id) || @context[:show_ids] }.map { |f| f.label }
         # data
-        data.each do |d|
+        collection.each do |d|
           csv << fields.inject([]) do |row, f|
             unless f.class <= Fields::Id && !@context[:show_ids]
               value = (f.get_value(d) || '')

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

@@ -9,7 +9,10 @@ module HammerCLI::Output::Adapter
     def print_error(msg, details=[], msg_params={})
     end
 
-    def print_records(fields, data)
+    def print_record(fields, record)
+    end
+
+    def print_collection(fields, collection)
     end
 
   end

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

@@ -8,11 +8,16 @@ module HammerCLI::Output::Adapter
       [:screen, :flat]
     end
 
-    def print_records(fields, data)
+    def print_record(fields, record)
+      print_collection(fields, [record].flatten(1))
+    end
+
+    def print_collection(fields, collection)
 
-      rows = data.collect do |d|
+      rows = collection.collect do |d|
         row = {}
         fields.each do |f|
+
           row[f.label.to_sym] = f.get_value(d) || ""
         end
         row

data/lib/hammer_cli/output/output.rb

@@ -16,8 +16,15 @@ module HammerCLI::Output
       adapter.print_error(msg.to_s, details, msg_params)
     end
 
-    def print_records(definition, records)
-      adapter.print_records(definition.fields, [records].flatten(1))
+    def print_record(definition, record)
+      adapter.print_record(definition.fields, record)
+    end
+
+    def print_collection(definition, collection)
+      unless collection.class <= HammerCLI::Output::RecordCollection
+        collection = HammerCLI::Output::RecordCollection.new([collection].flatten(1))
+      end
+      adapter.print_collection(definition.fields, collection)
     end
 
     def adapter

data/lib/hammer_cli/output/record_collection.rb

@@ -0,0 +1,35 @@
+module HammerCLI::Output
+
+
+  class MetaData
+
+    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]
+      @search = options[:search]
+      @sort_by = options[:sort_by]
+      @sort_order = options[:sort_order]
+    end
+
+  end
+
+
+  class RecordCollection < Array
+
+    attr_accessor :meta
+
+    def initialize(data, options={})
+      super [data].flatten(1)
+      if options.has_key?(:meta) && options[:meta].class <= MetaData
+        @meta = options[:meta]
+      else
+        @meta = MetaData.new(options)
+      end
+    end
+
+  end
+end

data/lib/hammer_cli/output.rb

@@ -4,4 +4,5 @@ require File.join(File.dirname(__FILE__), 'output/formatters')
 require File.join(File.dirname(__FILE__), 'output/adapter')
 require File.join(File.dirname(__FILE__), 'output/definition')
 require File.join(File.dirname(__FILE__), 'output/dsl')
+require File.join(File.dirname(__FILE__), 'output/record_collection')
 

data/lib/hammer_cli/version.rb

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

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

@@ -57,8 +57,8 @@ describe HammerCLI::Output::Adapter::Abstract do
 
   end
 
-  it "should raise not implemented on print_records" do
-    proc { adapter.print_records([], []) }.must_raise NotImplementedError
+  it "should raise not implemented on print_collection" do
+    proc { adapter.print_collection([], HammerCLI::Output::RecordCollection.new([])) }.must_raise NotImplementedError
   end
 
   context "error messages" do

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

@@ -4,22 +4,22 @@ describe HammerCLI::Output::Adapter::Base do
 
   let(:adapter) { HammerCLI::Output::Adapter::Base.new }
 
-  context "print_records" do
+  context "print_collection" do
 
     let(:field_name) { Fields::DataField.new(:path => [:name], :label => "Name") }
     let(:fields) {
       [field_name]
     }
-    let(:data) {[{
+    let(:data) { HammerCLI::Output::RecordCollection.new [{
       :name => "John Doe"
     }]}
 
     it "should print field name" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*Name[ ]*:.*/, "")
+      proc { adapter.print_collection(fields, data) }.must_output(/.*Name[ ]*:.*/, "")
     end
 
     it "should print field value" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*John Doe.*/, "")
+      proc { adapter.print_collection(fields, data) }.must_output(/.*John Doe.*/, "")
     end
 
   end

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

@@ -4,24 +4,25 @@ describe HammerCLI::Output::Adapter::CSValues do
 
   let(:adapter) { HammerCLI::Output::Adapter::CSValues.new }
 
-  context "print_records" do
+  context "print_collection" do
 
     let(:field_name) { Fields::DataField.new(:path => [:name], :label => "Name") }
     let(:field_started_at) { Fields::DataField.new(:path => [:started_at], :label => "Started At") }
     let(:fields) {
       [field_name, field_started_at]
     }
-    let(:data) {[{
+    let(:data) { HammerCLI::Output::RecordCollection.new [{
       :name => "John Doe",
       :started_at => "2000"
     }]}
 
+
     it "should print column name" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*Name,Started At.*/, "")
+      proc { adapter.print_collection(fields, data) }.must_output(/.*Name,Started At.*/, "")
     end
 
     it "should print field value" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*John Doe.*/, "")
+      proc { adapter.print_collection(fields, data) }.must_output(/.*John Doe.*/, "")
     end
 
     context "handle ids" do
@@ -31,14 +32,14 @@ describe HammerCLI::Output::Adapter::CSValues do
       }
 
       it "should ommit column of type Id by default" do
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.wont_match(/.*Id.*/)
         out.wont_match(/.*John Doe,.*/)
       end
 
       it "should print column of type Id when --show-ids is set" do
         adapter = HammerCLI::Output::Adapter::CSValues.new( { :show_ids => true } )
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.must_match(/.*Id.*/)
       end
     end
@@ -52,7 +53,7 @@ describe HammerCLI::Output::Adapter::CSValues do
         end
 
         adapter = HammerCLI::Output::Adapter::CSValues.new({}, { :DataField => [ DotFormatter.new ]})
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.must_match(/.*-DOT-.*/)
       end
     end

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

@@ -4,22 +4,22 @@ describe HammerCLI::Output::Adapter::Table do
 
   let(:adapter) { HammerCLI::Output::Adapter::Table.new }
 
-  context "print_records" do
+  context "print_collection" do
 
     let(:field_name) { Fields::DataField.new(:path => [:name], :label => "Name") }
     let(:fields) {
       [field_name]
     }
-    let(:data) {[{
+    let(:data) { HammerCLI::Output::RecordCollection.new [{
       :name => "John Doe"
     }]}
 
-    it "should print column name" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*NAME.*/, "")
+    it "should print column name " do
+      proc { adapter.print_collection(fields, data) }.must_output(/.*NAME.*/, "")
     end
 
     it "should print field value" do
-      proc { adapter.print_records(fields, data) }.must_output(/.*John Doe.*/, "")
+      proc { adapter.print_collection(fields, data) }.must_output(/.*John Doe.*/, "")
     end
 
     context "handle ids" do
@@ -29,19 +29,19 @@ describe HammerCLI::Output::Adapter::Table do
       }
 
       it "should ommit column of type Id by default" do
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.wont_match(/.*ID.*/)
       end
 
       it "should print column of type Id when --show-ids is set" do
         adapter = HammerCLI::Output::Adapter::Table.new( { :show_ids => true } )
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.must_match(/.*ID.*/)
       end
     end
 
     context "formatters" do
-      it "should apply formatters" do 
+      it "should apply formatters" do
         class DotFormatter < HammerCLI::Output::Formatters::FieldFormatter
           def format(data)
             '-DOT-'
@@ -49,7 +49,7 @@ describe HammerCLI::Output::Adapter::Table do
         end
 
         adapter = HammerCLI::Output::Adapter::Table.new({}, { :DataField => [ DotFormatter.new ]})
-        out, err = capture_io { adapter.print_records(fields, data) }
+        out, err = capture_io { adapter.print_collection(fields, data) }
         out.must_match(/.*-DOT-.*/)
       end
     end

data/test/unit/output/output_test.rb

@@ -53,13 +53,25 @@ describe HammerCLI::Output::Output do
     let(:collection) { [item1, item2] }
 
     it "prints single resource" do
-      adapter.any_instance.expects(:print_records).with([], [{}])
-      out.print_records(definition, item1)
+      adapter.any_instance.expects(:print_record).with([], item1)
+      out.print_record(definition, item1)
     end
 
+    it "prints single resource as collection" do
+      adapter.any_instance.expects(:print_collection).with([], instance_of(HammerCLI::Output::RecordCollection))
+      out.print_collection(definition, item1)
+    end
+
+
     it "prints array of resources" do
-      adapter.any_instance.expects(:print_records).with([], collection)
-      out.print_records(definition, collection)
+      adapter.any_instance.expects(:print_collection).with([], instance_of(HammerCLI::Output::RecordCollection))
+      out.print_collection(definition, collection)
+    end
+
+    it "prints recordset" do
+      data = HammerCLI::Output::RecordCollection.new(collection)
+      adapter.any_instance.expects(:print_collection).with([], data)
+      out.print_collection(definition, data)
     end
 
   end

data/test/unit/output/record_collection_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+describe HammerCLI::Output::RecordCollection do
+  let(:data) { [1, 2, 3] }
+  let(:meta) { { :total => 6, :page => 2, :per_page => 3, :subtotal => 5,
+          :search => 'name~=xx', :sort_by => 'name', :sort_order => 'ASC' } }
+  let(:set) { HammerCLI::Output::RecordCollection.new(data, meta) }
+
+  it "should keep records and its meta data" do
+    set.must_equal data
+    set.meta.total.must_equal 6
+    set.meta.subtotal.must_equal 5
+    set.meta.total.must_equal 6
+    set.meta.page.must_equal 2
+    set.meta.per_page.must_equal 3
+    set.meta.search.must_equal 'name~=xx'
+    set.meta.sort_by.must_equal 'name'
+    set.meta.sort_order.must_equal 'ASC'
+  end
+
+  it "should wrap the data into list" do
+    record = { :key => :value, :key2 => :value }
+    rs = HammerCLI::Output::RecordCollection.new(record)
+    rs.must_be_kind_of Array
+  end
+
+  it "sould accept MetaData as option" do
+    metadata = HammerCLI::Output::MetaData.new(meta)
+    set = HammerCLI::Output::RecordCollection.new(data, :meta => metadata)
+    set.meta.must_equal metadata
+    set.meta.total.must_equal 6
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -181,6 +181,7 @@ files:
 - lib/hammer_cli/output/fields.rb
 - lib/hammer_cli/output/formatters.rb
 - lib/hammer_cli/output/output.rb
+- lib/hammer_cli/output/record_collection.rb
 - lib/hammer_cli/settings.rb
 - lib/hammer_cli/shell.rb
 - lib/hammer_cli/utils.rb
@@ -204,6 +205,7 @@ files:
 - 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/settings_test.rb
 - test/unit/test_helper.rb
 - test/unit/utils_test.rb
@@ -228,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.8
+rubygems_version: 2.0.13
 signing_key: 
 specification_version: 4
 summary: Universal command-line interface
@@ -251,6 +253,7 @@ test_files:
 - 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/settings_test.rb
 - test/unit/test_helper.rb
 - test/unit/utils_test.rb