wavefront-cli 4.2.1 → 4.3.0

data/lib/wavefront-cli/dashboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require_relative 'command_mixins/tag'
 require_relative 'command_mixins/acl'
@@ -12,6 +14,7 @@ module WavefrontCli
 
     def list_filter(list)
       return list unless options[:nosystem]
+
       list.tap { |l| l.response.items.delete_if { |d| d[:systemOwned] } }
     end
 

data/lib/wavefront-cli/derivedmetric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require_relative 'command_mixins/tag'
 
@@ -25,20 +27,19 @@ module WavefrontCli
     end
 
     def do_create
-      wf.create(build_body)
+      wf.create(create_body)
     end
 
     # rubocop:disable Metrics/AbcSize
-    def build_body
-      ret = { query:                  options[:'<query>'],
-              name:                   options[:'<name>'],
-              minutes:                options[:range].to_i,
-              includeObsoleteMetrics: options[:obsolete],
-              processRateMinutes:     options[:interval].to_i }
-
-      ret[:additionalInformation] = options[:desc] if options[:desc]
-      ret[:tags] = options[:ctag] if valid_tags?
-      ret
+    def create_body
+      { query: options[:'<query>'],
+        name: options[:'<name>'],
+        minutes: options[:range].to_i,
+        includeObsoleteMetrics: options[:obsolete],
+        processRateMinutes: options[:interval].to_i }.tap do |b|
+          b[:additionalInformation] = options[:desc] if options[:desc]
+          b[:tags] = options[:ctag] if valid_tags?
+        end
     end
     # rubocop:enable Metrics/AbcSize
 

data/lib/wavefront-cli/display/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay
@@ -52,13 +54,14 @@ module WavefrontDisplay
       puts data.max
     end
 
-    # rubocop:disable Metrics/AbcSize
     def do_summary
       kw = data.keys.map(&:size).max + 2
-      data.delete_if { |_k, v| v.zero? } unless options[:all]
-      data.sort.each { |k, v| puts format("%-#{kw}s%s", k, v) }
+      data.sort.each do |k, v|
+        next if v.zero? && !options[:all]
+
+        puts format("%-#{kw}<key>s%<value>s", key: k, value: v)
+      end
     end
-    # rubocop:enable Metrics/AbcSize
 
     def do_queries
       if options[:brief]

data/lib/wavefront-cli/display/apitoken.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../constants'
 
 module WavefrontDisplay
@@ -36,6 +38,7 @@ module WavefrontDisplay
     # find the correct method to deal with the output of the user's
     # command.
     #
+    # rubocop:disable Metrics/MethodLength
     def run(method)
       if method == 'do_list'
         run_list
@@ -49,6 +52,7 @@ module WavefrontDisplay
         long_output
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Choose the correct list handler. The user can specifiy a long
     # listing with the --long options.
@@ -91,6 +95,7 @@ module WavefrontDisplay
     #
     def run_error(method)
       return unless respond_to?(method)
+
       send(method)
       exit 1
     end
@@ -104,6 +109,7 @@ module WavefrontDisplay
 
     def prioritize_keys(data, keys)
       return _prioritize_keys(data, keys) unless data.is_a?(Array)
+
       data.map { |e| _prioritize_keys(e, keys) }
     end
 
@@ -115,6 +121,7 @@ module WavefrontDisplay
     def _prioritize_keys(data, keys)
       keys.each.with_object(data.is_a?(Map) ? Map.new : {}) do |k, a|
         next unless data.key?(k)
+
         a[k] = data[k]
         data.delete(k)
       end.merge(data)
@@ -150,17 +157,22 @@ module WavefrontDisplay
 
     # if this is a section of a larger dataset, say so
     #
-    # rubocop:disable Metrics/AbcSize
     def pagination_line
       return unless raw.respond_to?(:moreItems) && raw.moreItems == true
 
-      enditem = raw.limit.positive? ? raw.offset + raw.limit - 1 : 0
-      puts format('List shows items %d to %d. Use -o and -L for more.',
-                  raw.offset, enditem)
+      puts format('List shows items %<first>d to %<last>d. ' \
+                  'Use -o and -L for more.',
+                  first: raw.offset,
+                  last: index_of_final_item)
     rescue StandardError
       puts 'List shows paginated output. Use -o and -L for more.'
     end
-    # rubocop:enable Metrics/AbcSize
+
+    # Return the offset of the final item in view.
+    #
+    def index_of_final_item
+      raw.limit.positive? ? raw.offset + raw.limit - 1 : 0
+    end
 
     # Give it a key-value hash, and it will return the size of the first
     # column to use when formatting that data.
@@ -171,6 +183,7 @@ module WavefrontDisplay
     #
     def key_width(hash = {}, pad = 2)
       return 0 if hash.keys.empty?
+
       hash.keys.map(&:size).max + pad
     end
 
@@ -254,11 +267,18 @@ module WavefrontDisplay
     end
 
     def search_display_keys
-      ([:id] + options[:'<condition>'].map do |c|
+      ([search_identifier_key] + options[:'<condition>'].map do |c|
         c.split(SEARCH_SPLIT, 2).first.to_sym
       end).uniq
     end
 
+    # Most objects refer to themselves by 'id'. Some, like accounts, don't.
+    # Override here.
+    #
+    def search_identifier_key
+      :id
+    end
+
     def do_search
       if data.empty?
         puts 'No matches.'
@@ -360,9 +380,8 @@ module WavefrontDisplay
 
       str = time.to_s
       fmt, out_fmt = time_formats(str)
-      # rubocop:disable Style/DateTime
       ret = DateTime.strptime(str, fmt).to_time
-      # rubocop:enable Style/DateTime
+
       ret = force_utc ? ret.utc : ret.localtime
       ret.strftime(out_fmt)
     end
@@ -380,5 +399,12 @@ module WavefrontDisplay
         raise ArgumentError
       end
     end
+
+    # @param things [Array[String]]
+    # @return [String] all "things", strong-quoted and comma-separated
+    #
+    def quoted(things)
+      things.map { |item| "'#{item}'" }.join(', ')
+    end
   end
 end

data/lib/wavefront-cli/display/cloudintegration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay
@@ -16,11 +18,11 @@ module WavefrontDisplay
     end
 
     def do_enable
-      puts "Enabled #{options[:'<id>']}."
+      puts "Enabled '#{options[:'<id>']}'."
     end
 
     def do_disable
-      puts "Disabled #{options[:'<id>']}."
+      puts "Disabled '#{options[:'<id>']}'."
     end
   end
 end

data/lib/wavefront-cli/display/dashboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/derivedmetric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/distribution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'write'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require_relative 'base'
 

data/lib/wavefront-cli/display/externallink.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/integration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/maintenancewindow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay

data/lib/wavefront-cli/display/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay
@@ -10,7 +12,7 @@ module WavefrontDisplay
     end
 
     def do_read
-      abort 'Message not found.' if data.empty?
+      abort 'Message not found.' unless data && !data.empty?
 
       puts message_title, data.content.fold(TW, 0), message_sender
     end
@@ -18,11 +20,13 @@ module WavefrontDisplay
     private
 
     def message_title
-      format("\n%s\n%s\n", data.title, '-' * data.title.length)
+      format("\n%<title>s\n%<underline>s\n",
+             title: data.title,
+             underline: '-' * data.title.length)
     end
 
     def message_sender
-      format("\n%#{TW - 2}s\n", data.source)
+      format("\n%#{TW - 2}<sender>s\n", sender: data.source)
     end
   end
 end

data/lib/wavefront-cli/display/metric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay
@@ -22,7 +24,7 @@ module WavefrontDisplay
     end
 
     def bail_out
-      puts 'No matches.'
+      puts "Did not find metric '#{options[:'<metric>']}'."
       exit
     end
   end

data/lib/wavefront-cli/display/notificant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontDisplay
@@ -15,7 +17,7 @@ module WavefrontDisplay
     end
 
     def do_test
-      puts 'Testing notification.'
+      puts "Testing notificant '#{options[:'<id>']}'."
     end
   end
 end

data/lib/wavefront-cli/display/printer/long.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../../stdlib/string'
+
 module WavefrontDisplayPrinter
   #
   # Print the long indented descriptions of things
@@ -26,10 +30,10 @@ module WavefrontDisplayPrinter
     # initializer options hash.
     #
     def default_opts
-      { indent:    2,
-        padding:   2,
+      { indent: 2,
+        padding: 2,
         separator: true,
-        none:      true }
+        none: true }
     end
 
     # @param data [Hash] raw data
@@ -39,6 +43,7 @@ module WavefrontDisplayPrinter
     #
     def preened_data(data, fields = nil)
       return data if fields.nil?
+
       data.map { |d| d.select { |k| fields.include?(k.to_sym) }.to_h }
     end
 
@@ -49,6 +54,7 @@ module WavefrontDisplayPrinter
     #
     def preened_value(value)
       return value unless value.is_a?(String) && value =~ /<.*>/
+
       value.gsub(%r{<\/?[^>]*>}, '').delete("\n")
     end
 
@@ -94,16 +100,22 @@ module WavefrontDisplayPrinter
     # Turn the list made by #make_list into user output
     # @return [String]
     #
-    # rubocop:disable Metrics/AbcSize
     def to_s
-      list.map do |e|
-        indent = ' ' * opts[:indent] * e.last
-        key_str = (indent + e.first.to_s + '  ' * kw)[0..kw]
-        val = e[1] == :separator ? '-' * (TW - key_str.length) : e[1]
-        line(key_str, val)
+      list.map do |item|
+        stringify_line(item)
       end.join("\n")
     end
-    # rubocop:enable Metrics/AbcSize
+
+    # @param item [Array] of the form [key, value, indent_level]
+    #
+    def stringify_line(item)
+      key_str = format('%<indent>s%<key>s%<gutter>s',
+                       indent: padding(item[2]),
+                       key: item[0].to_s,
+                       gutter: '  ' * kw)[0..kw]
+      line(key_str,
+           item[1] == :separator ? separator_line(key_str.size) : item[1])
+    end
 
     def line(key, val)
       line_length = key.to_s.size + val.to_s.size
@@ -112,11 +124,24 @@ module WavefrontDisplayPrinter
         val = val.value_fold(key.to_s.size)
       end
 
-      format('%s%s', key, val).rstrip
+      format('%<padded_key>s%<value>s', padded_key: key, value: val).rstrip
     end
 
     private
 
+    # @return [String] correctly sized separator line
+    #
+    def separator_line(width)
+      '-' * (TW - width)
+    end
+
+    # @return [String] the correct amount of whitespace indentation for the
+    #   given indent level
+    #
+    def padding(level)
+      ' ' * opts[:indent] * level
+    end
+
     # Part of the #make_list recursion. Deals with a hash.
     #
     # @param data [Hash]

data/lib/wavefront-cli/display/printer/sparkline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The Unicode characters which we use to make a sparkline
 #
 BLOCKS = [' ', "\u2581", "\u2582", "\u2583", "\u2585", "\u2586",
@@ -35,6 +37,7 @@ class WavefrontSparkline
   #
   def make_fit(vals)
     return vals if vals.size < SPARK_WIDTH
+
     vals.<< vals.last if vals.size.odd?
     ret = vals.each_slice(2).with_object([]) { |s, a| a.<< s.inject(:+) / 2 }
     make_fit(ret)

data/lib/wavefront-cli/display/printer/terse.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'map'
 require_relative '../../stdlib/array'
 
 module WavefrontDisplayPrinter
@@ -34,7 +37,9 @@ module WavefrontDisplayPrinter
     end
 
     def map_to_string(value)
-      format('%s=%s', value.keys[0], value.values.join(','))
+      format('%<key>s=%<value>s',
+             key: value.keys[0],
+             value: value.values.join(','))
     end
 
     def to_s