MuranoCLI 3.2.0.beta.1 → 3.2.0.beta.5

data/lib/MrMurano/commands/exchange.rb

@@ -6,6 +6,7 @@
 # Unauthorized copying of this file is strictly prohibited.
 
 require 'highline'
+require 'MrMurano/makePretty'
 require 'MrMurano/verbosing'
 require 'MrMurano/Exchange'
 require 'MrMurano/ReCommander'
@@ -14,261 +15,267 @@ require 'MrMurano/commands/business'
 # *** Business commands: Exchange Elements
 # ----------------------------------------
 
-command :exchange do |c|
-  c.syntax = %(murano exchange)
-  c.summary = %(About IOT Exchange)
-  c.description = %(
-Commands for working with IOT Exchange.
-  ).strip
-  c.project_not_required = true
-  c.subcmdgrouphelp = true
-
-  c.action do |_args, _options|
-    ::Commander::UI.enable_paging unless $cfg['tool.no-page']
-    say MrMurano::SubCmdGroupHelp.new(c).get_help
+class ExchangeCmd
+  include MrMurano::Verbose
+
+  def command_exchange_help(cmd)
+    cmd.syntax = %(murano exchange)
+    cmd.summary = %(IoT Marketplace Exchange commands)
+    cmd.description = %(
+      Commands for working with IoT Marketplace.
+    ).strip
+    cmd.project_not_required = true
+    cmd.subcmdgrouphelp = true
+
+    cmd.action do |_args, _options|
+      ::Commander::UI.enable_paging unless $cfg['tool.no-page']
+      say MrMurano::SubCmdGroupHelp.new(cmd).get_help
+    end
   end
-end
 
-command 'exchange list' do |c|
-  c.syntax = %(murano exchange list [--options] [<name-or-ID>])
-  c.summary = %(List Exchange Elements)
-  c.description = %(
+  def command_exchange_list(cmd)
+    cmd.syntax = %(murano exchange list [--options] [<name-or-ID>])
+    cmd.summary = %(List Exchange Elements)
+    cmd.description = %(
 List Exchange Elements, either all of them, or those that are purchased or available.
 
 Each Exchange Element is identified by an Element ID and a name.
 
 Element status:
 
-- added       An Element that has been added to and enabled for your Business
+  - added       An Element that has been added to and enabled for your Business
 
-- available   An Element that can be added to and enabled for your Business
+  - available   An Element that can be added to and enabled for your Business
 
-- available*  An Element that you can use if you upgrade your Business tier
+  - available*  An Element that you can use if you upgrade your Business tier
 
-  ).strip
-  c.project_not_required = true
+    ).strip
+    cmd.project_not_required = true
 
-  cmd_table_output_add_options(c)
+    cmd_table_output_add_options(cmd)
 
-  c.option '--[no-]added', 'Only show Elements that have been added to the Application'
-  c.option '--[no-]full', 'Show all fields'
-  c.option '--[no-]other', 'Show other fields: like type, tiers, tags, and action, and apiServiceName'
+    cmd.option '--[no-]added', 'Only show Elements that have been added to the Business'
+    cmd.option '--[no-]elem-type', 'Show element "type"'
+    cmd.option '--[no-]full', 'Show all fields'
+    cmd.option '--[no-]other', 'Show other fields: like type, tiers, tags, and action, and apiServiceName'
 
-  # Add --id and --name options.
-  cmd_options_add_id_and_name(c)
+    # Add --id and --name options.
+    cmd_options_add_id_and_name(cmd)
 
-  c.action do |args, options|
-    c.verify_arg_count!(args, 1)
-    cmd_defaults_id_and_name(options)
+    cmd.action do |args, options|
+      cmd.verify_arg_count!(args, 1)
+      cmd_defaults_id_and_name(options)
 
-    xchg = MrMurano::Exchange.new
-    xchg.must_business_id!
+      xchg = MrMurano::Exchange.new
+      xchg.must_business_id!
 
-    elems, available, purchased = find_elements(xchg, options, args[0])
-    if options.added.nil?
-      show = elems
-    elsif options.added
-      show = purchased
-    else
-      show = available
-    end
+      show = filter_elements(xchg, options, args[0])
+      sorted = sort_elements(show)
 
-    headers, pruned = cmd_exchange_header_and_elems(show, options)
+      headers, pruned = cmd_exchange_header_and_elems(sorted, options)
 
-    io = File.open(options.output, 'w') if options.output
-    xchg.outf(pruned, io) do |item, ios|
-      if options.idonly
-        ios.puts item
+      io = File.open(options.output, 'w') if options.output
+      xchg.outf(pruned, io) do |item, ios|
+        if options.idonly
+          ios.puts item
+        else
+          ios.puts "Found #{pruned.length} elements."
+          xchg.tabularize(
+            {
+              headers: headers.map(&:to_s),
+              rows: item,
+            },
+            ios,
+          )
+        end
+      end
+      io.close unless io.nil?
+    end
+  end
+
+  def find_elements(xchg, options, term, skip_purchased: false)
+    filter_id = nil
+    filter_name = nil
+    filter_fuzzy = nil
+    if term
+      if options.id
+        filter_id = term
+      elsif options.name
+        filter_name = term
       else
-        ios.puts "Found #{pruned.length} elements."
-        xchg.tabularize(
-          {
-            headers: headers.map(&:to_s),
-            rows: item,
-          },
-          ios,
-        )
+        filter_fuzzy = term
       end
     end
-    io.close unless io.nil?
+    xchg.elements(
+      filter_id: filter_id,
+      filter_name: filter_name,
+      filter_fuzzy: filter_fuzzy,
+      skip_purchased: skip_purchased,
+    )
   end
-end
-alias_command 'exchange list available', 'exchange list', '--no-added'
-alias_command 'exchange list purchased', 'exchange list', '--added'
-
-def find_elements(xchg, options, term)
-  filter_id = nil
-  filter_name = nil
-  filter_fuzzy = nil
-  if term
-    if options.id
-      filter_id = term
-    elsif options.name
-      filter_name = term
+
+  def filter_elements(xchg, options, term)
+    elems, available, purchased = find_elements(xchg, options, term)
+    if options.added.nil?
+      elems
+    elsif options.added
+      purchased
     else
-      filter_fuzzy = term
+      available
     end
   end
-  xchg.elements(filter_id: filter_id, filter_name: filter_name, filter_fuzzy: filter_fuzzy)
-end
 
-def cmd_exchange_header_and_elems(elems, options)
-  # MAYBE/2017-08-31: If you `-c outformat=json`, each Element is a
-  # list of values, rather than a dictionary. Wouldn't the JSON be
-  # easier to consume if each Element was a dict, rather than list?
-  if options.idonly
-    headers = %i[elementId]
-    elems = elems.map(&:elementId)
-  elsif options.brief
-    headers = %i[elementId name]
-    headers += [:status] unless options.added
-    #elems = elems.map { |elem| [elem.elementId, elem.name] }
-    elems = elems.map { |elem| headers.map { |key| elem.send(key) } }
-  elsif options.full
-    headers = %i[elementId name status type apiServiceName tiers tags actions markdown]
-    all_hdrs = (elems[0] && elems[0].meta.keys) || []
-    all_hdrs.each do |chk|
-      headers.push(chk) unless headers.include?(chk)
+  STATUSABLE_RANK = %i[added available upgrade].freeze
+
+  def sort_elements(elems)
+    elems.sort do |lhs, rhs|
+      if lhs.statusable != rhs.statusable
+        next(
+          STATUSABLE_RANK.index(lhs.statusable) <=> STATUSABLE_RANK.index(rhs.statusable)
+        )
+      end
+      lhs.name <=> rhs.name
     end
-    #elems = elems.map { |elem| headers.map { |key| elem.meta[key] } }
-    elems = elems.map { |elem| headers.map { |key| elem.send(key) || '' } }
-  elsif options.other
-    # NOTE: Showing columns not displayed when --other not specified,
-    #   except not showing :markdown, ever.
-    headers = %i[elementId type apiServiceName tiers tags actions]
-    #headers = %i[elementId type apiServiceName tiers tags actions markdown]
-    #elems = elems.map { |elem| headers.map { |key| elem.send(key) } }
-    elems = elems.map do |elem|
+  end
+
+  def cmd_exchange_header_and_elems_others(elems)
+    elems.map do |elem|
+      elem_actions = elem.actions.nil? && [] || elem.actions.map do |action|
+        action.map { |key, val| "#{key}: #{val}" }.join("\n")
+      end
       [
         elem.elementId,
         elem.type,
         elem.apiServiceName,
-        #elem.tiers,
-        #elem.tiers.join(' | '),
         elem.tiers.join("\n"),
-        #elem.tags,
-        #elem.tags.join(' | '),
         elem.tags.join("\n"),
-        #elem.actions,
-        elem.actions.map { |actn| actn.map { |key, val| "#{key}: #{val}" }.join("\n") }.join("\n"),
-        #elem.markdown.gsub("\n", '\\n'),
+        elem_actions.join("\n"),
       ]
     end
-  else
-    # 2017-08-28: There are 9 keys, and one of them -- :markdown -- is a
-    # lot of text, so rather than, e.g., elems[0].meta.keys, be selective.
-    headers = %i[elementId name]
-    headers += [:status] unless options.added
-    headers += [:description]
-    if $stdout.tty?
-      # Calculate how much room (how many characters) are left for the
-      # description column.
-      width_taken = 0
-      # rubocop:disable Performance/FixedSize
-      #   "Do not compute the size of statically sized objects."
-      width_taken += '| '.length
-      # Calculate the width of each column except the last (:description).
-      headers[0..-2].each do |key|
-        elem_with_max = elems.max { |a, b| a.send(key).length <=> b.send(key).length }
-        width_taken += elem_with_max.send(key).length unless elem_with_max.nil?
-        width_taken += ' | '.length
+  end
+
+  def cmd_exchange_header_and_elems_default(headers, elems, width_avail)
+    elems.map do |elem|
+      headers.map do |key|
+        full = elem.send(key)
+        next(full) if width_avail.nil? || key != :description || full.empty?
+        MrMurano::Pretties.split_text_on_whitespace(full, width_avail)
+      end
+    end
+  end
+
+  def cmd_exchange_header_and_elems(elems, options)
+    # MAYBE/2017-08-31: If you `-c outformat=json`, each Element is a
+    # list of values, rather than a dictionary. Wouldn't the JSON be
+    # easier to consume if each Element was a dict, rather than list?
+    if options.idonly
+      headers = %i[elementId]
+      elems = elems.map(&:elementId)
+    elsif options.brief
+      headers = %i[elementId name]
+      headers += [:status] unless options.added
+      elems = elems.map { |elem| headers.map { |key| elem.send(key) } }
+    elsif options.full
+      headers = %i[elementId name status type apiServiceName tiers tags actions markdown]
+      all_hdrs = (elems[0] && elems[0].meta.keys) || []
+      all_hdrs.each do |chk|
+        headers.push(chk) unless headers.include?(chk)
       end
-      width_taken += ' | '.length
-      term_width, _rows = HighLine::SystemExtensions.terminal_size
-      width_avail = term_width - width_taken
-      # MAGIC_NUMBER: Tweak/change this if you want. 20 char min feels
-      # about right: don't wrap if column would be narrow or negative.
-      width_avail = nil if width_avail < 20
+      elems = elems.map { |elem| headers.map { |key| elem.send(key) || '' } }
+    elsif options.other
+      # NOTE: Showing columns not displayed when --other not specified,
+      #   except not showing :markdown, ever.
+      headers = %i[elementId type apiServiceName tiers tags actions]
+      elems = cmd_exchange_header_and_elems_others(elems)
     else
-      width_avail = nil
+      # 2017-08-28: There are 9 keys, and one of them -- :markdown -- is a
+      # lot of text, so rather than, e.g., elems[0].meta.keys, be selective.
+      headers = %i[elementId name]
+      headers += [:type] if options.elem_type
+      headers += [:status] unless options.added
+      headers += [:description]
+      width_avail = MrMurano::Pretties.width_last_column(headers, elems)
+      elems = cmd_exchange_header_and_elems_default(headers, elems, width_avail)
     end
-    #elems = elems.map { |elem| headers.map { |key| elem.send(key) } }
-    elems = elems.map do |elem|
-      headers.map do |key|
-        if !width_avail.nil? && key == :description
-          #elem.meta[key].scan(/.{1,#{width_avail}}/).join("\n")
-          full = elem.send(key)
-          parts = []
-          until full.empty?
-            # Split the description on a space before the max width.
-            # FIXME/2017-08-28: Need to test really long desc with no space.
-            part = full[0..width_avail]
-            full = full[(width_avail + 1)..-1] || ''
-            leftover = ''
-            part, _space, leftover = part.rpartition(' ') unless full.empty?
-            if part.empty?
-              part = leftover.to_s
-              leftover = ''
-            else
-              full = leftover.to_s + full
-              full = full
-            end
-            parts.push(part.strip)
-          end
-          parts.join("\n")
-        else
-          elem.send(key)
-        end
+    headers.delete(:type) if options.elem_type == false
+    [headers, elems]
+  end
+
+  def command_exchange_purchase(cmd)
+    cmd.syntax = %(murano exchange purchase [--options] <name-or-ID>)
+    cmd.summary = %(Add an Exchange Element to your Business)
+    cmd.description = %(
+      Add an Exchange Element to your Business.
+    ).strip
+    # It feels a little weird to not require a project, but all
+    # we need is the Business ID; this action does not apply to
+    # solutions.
+    cmd.project_not_required = true
+
+    # Add --id and --name options.
+    cmd_options_add_id_and_name(cmd)
+
+    cmd.action do |args, options|
+      cmd.verify_arg_count!(args, 1, ['Missing Element name or ID'])
+      cmd_defaults_id_and_name(options)
+
+      xchg = MrMurano::Exchange.new
+      xchg.must_business_id!
+
+      # If the user specifies filter_id, we could try to fetch that Element
+      # directly (e.g., by calling exchange/<bizId>/element/<elemId>),
+      # but the response doesn't specify if the Element is purchased or not.
+      # So we grab everything from /element/ and /purchase/.
+
+      elems, _available, purchased = find_elements(xchg, options, args[0])
+
+      elems_must_found_one!(elems, xchg)
+      if purchased.length == 1
+        # I.e., elems.status == :added
+        xchg.warning(
+          'The specified element has already been purchased: ' \
+          "#{xchg.fancy_ticks(purchased[0].name)} (#{purchased[0].elementId})"
+        )
+        exit 2
+      elsif elems.first.status == :upgrade
+        xchg.warning('Please upgrade your Business to add this Element. Visit:')
+        xchg.warning('  https://www.exosite.io/business/settings/upgrade')
+        exit 2
       end
+
+      xchg.purchase(elems.first.elementId)
     end
   end
-  [headers, elems]
-end
 
-command 'exchange purchase' do |c|
-  c.syntax = %(murano exchange purchase [--options] <name-or-ID>)
-  c.summary = %(Add an Exchange Element to your Business)
-  c.description = %(
-Add an Exchange Element to your Business.
-  ).strip
-  # It feels a little weird to not require a project, but all
-  # we need is the Business ID; this action does not apply to
-  # solutions.
-  c.project_not_required = true
-
-  # Add --id and --name options.
-  cmd_options_add_id_and_name(c)
-
-  c.action do |args, options|
-    c.verify_arg_count!(args, 1, ['Missing Element name or ID'])
-    cmd_defaults_id_and_name(options)
-
-    xchg = MrMurano::Exchange.new
-    xchg.must_business_id!
-
-    # If the user specifies filter_id, we could try to fetch that Element
-    # directly (e.g., by calling exchange/<bizId>/element/<elemId>),
-    # but the response doesn't specify if the Element is purchased or not.
-    # So we grab everything from /element/ and /purchase/.
-
-    elems, _available, purchased = find_elements(xchg, options, args[0])
+  def elems_must_found_one!(elems, xchg)
     if elems.length > 1
-      idents = elems.map { |elem| "#{xchg.fancy_ticks(elem.name)} (#{elem.elementId})" }
-      idents[-1] = 'and ' + idents[-1]
+      idents = elems.map { |elem| "#{elem.elementId}: #{xchg.fancy_ticks(elem.name)}" }
       xchg.warning(
-        'Please be more specific: More than one matching element was found: ' \
-        "#{idents.join(', ')}"
+        "Please be more specific: More than one matching element was found:\n  " \
+        "#{idents.join("\n  ")}"
       )
       exit 2
     elsif elems.empty?
       xchg.warning('No matching element was found.')
       exit 2
-    elsif purchased.length == 1
-      # I.e., elems.status == :added
-      xchg.warning(
-        'The specified element has already been purchased: ' \
-        "#{xchg.fancy_ticks(purchased[0].name)} (#{purchased[0].elementId})"
-      )
-      exit 2
-    elsif elems.first.status == :upgrade
-      xchg.warning('Please upgrade your Business to add this Element. Visit:')
-      xchg.warning('  https://www.exosite.io/business/settings/upgrade')
-      exit 2
     end
-
-    xchg.purchase(elems.first.elementId)
+    elems.first
   end
 end
-alias_command 'exchange add', 'exchange purchase'
-alias_command 'exchange buy', 'exchange purchase'
+
+def wire_cmd_exchange
+  exchange_cmd = ExchangeCmd.new
+
+  command(:exchange) { |cmd| exchange_cmd.command_exchange_help(cmd) }
+
+  command('exchange list') { |cmd| exchange_cmd.command_exchange_list(cmd) }
+  alias_command 'exchange list available', 'exchange list', '--no-added'
+  alias_command 'exchange list purchased', 'exchange list', '--added'
+
+  command('exchange purchase') { |cmd| exchange_cmd.command_exchange_purchase(cmd) }
+  alias_command 'exchange add', 'exchange purchase'
+  alias_command 'exchange buy', 'exchange purchase'
+end
+
+wire_cmd_exchange
 

data/lib/MrMurano/commands/gb.rb

@@ -6,6 +6,7 @@
 # Unauthorized copying of this file is strictly prohibited.
 
 require 'pp'
+require 'MrMurano/commands/solution_picker'
 
 # You don't need this.
 # To use this:

data/lib/MrMurano/commands/globals.rb

@@ -7,6 +7,7 @@
 
 require 'MrMurano/verbosing'
 require 'MrMurano/Config'
+require 'MrMurano/variegated/TruthyFalsey'
 
 global_option('--[no-]color', %(Disable fancy output)) do |value|
   HighLine.use_color = value
@@ -14,16 +15,20 @@ global_option('--[no-]color', %(Disable fancy output)) do |value|
 end
 
 global_option('-c', '--config KEY=VALUE', %(Set a single config key)) do |param|
+  # a=b :> ['a', 'b']
+  # a=  :> ['a', '']
+  # a   :> ['a', nil]
   key, value = param.split('=', 2)
-  # a=b :> ["a", "b"]
-  # a= :> ["a", ""]
-  # a :> ["a"]
   raise "Bad config '#{param}'" if key.nil?
-  if value.nil?
-    $cfg[key] = 'true'
-  else
-    $cfg[key] = value
+  section, ikey = key.split('.', 2)
+  if ikey.nil?
+    ikey = section
+    section = 'tool'
+    key = "#{section}.#{ikey}"
   end
+  # If existing config setting is a boolean, coerce value as such,
+  # rather than setting a string, e.g., false, not "false".
+  $cfg[key] = TruthyFalsey.coerce_boolean(value, $cfg[key])
 end
 
 global_option('-C', '--configfile FILE', %(Load additional configuration file)) do |file|
@@ -89,6 +94,11 @@ global_option('--debug', %(Show debug messages)) do
   $cfg['tool.debug'] = true
 end
 
+# 2018-04-24: (lb): Let's *not* advertise this, shall we?
+#   global_option('--developer', %(Enable developer mode)) do
+#     $cfg['tool.developer'] = true
+#   end
+
 global_option('--sid VALUE', %(Override application or product ID)) do |value|
   $cfg['application.id'] = value
   $cfg['product.id'] = value