MuranoCLI 2.2.4 → 3.0.0

data/lib/MrMurano/progress.rb

@@ -0,0 +1,138 @@
+# Last Modified: 2017.08.02 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
+require 'highline'
+require 'inflecto'
+require 'singleton'
+require 'whirly'
+
+module MrMurano
+  # Progress is a singleton (evil!) that implements a terminal progress bar.
+  class Progress
+    include Singleton
+
+    def initialize
+      @whirly_msg = ''
+      @whirly_time = nil
+      @whirly_users = 0
+      @whirly_cols = 0
+      @whirly_pauses = 0
+    end
+
+    EXO_QUADRANTS = [
+      '▚',
+      '▘',
+      '▝',
+      '▞',
+      '▖',
+      '▗',
+    ].freeze
+
+    def whirly_start(msg)
+      if $cfg['tool.verbose']
+        whirly_pause if @whirly_users > 0
+        say msg
+        whirly_unpause if @whirly_users > 0
+      end
+      return if $cfg['tool.no-progress']
+      # Count the number of calls to whirly_start, so that the
+      # first call to whirly_start is the message that gets
+      # printed. This way, methods can define a default message
+      # to use, but then callers of those methods can choose to
+      # display a different message.
+      @whirly_users += 1
+      # The first Whirly message is the one we show.
+      return if @whirly_users > 1
+      @whirly_msg = msg
+      whirly_stop
+      whirly_show
+    end
+
+    def whirly_show
+      Whirly.start(
+        spinner: EXO_QUADRANTS,
+        status: @whirly_msg,
+        append_newline: false,
+        #remove_after_stop: false,
+        #stream: $stderr,
+      )
+      @whirly_time = Time.now
+      # The whitespace we add ends up getting picked up if you copy
+      # from the terminal. [lb] not sure if we can fix that... but
+      # we can at least minimize the amount of it to the longest
+      # message, rather than the terminal column width.
+      #@whirly_cols, _rows = HighLine::SystemExtensions.terminal_size
+      # Note that Whirly adds '...', so add its length, too.
+      # rubocop:disable Performance/FixedSize
+      #   Do not compute the size of statically sized objects.
+      @whirly_cols = @whirly_msg.length + '...'.length
+    end
+
+    def whirly_stop(force: false)
+      return if $cfg['tool.no-progress'] || @whirly_time.nil?
+      if force
+        @whirly_users = 0
+      else
+        @whirly_users -= 1
+      end
+      return unless @whirly_users.zero?
+      whirly_linger
+      whirly_clear
+    end
+
+    def whirly_clear
+      Whirly.stop
+      # The progress indicator is always overwritten.
+      return unless @whirly_cols
+      $stdout.print((' ' * @whirly_cols) + "\r")
+      $stdout.flush
+    end
+
+    def whirly_linger
+      return if $cfg['tool.no-progress'] || @whirly_time.nil?
+      not_so_fast = 0.55 - (Time.now - @whirly_time)
+      @whirly_time = nil
+      sleep(not_so_fast) if not_so_fast > 0
+    end
+
+    def whirly_msg(msg)
+      return if $cfg['tool.no-progress']
+      if @whirly_time.nil?
+        whirly_start msg
+      else
+        @whirly_msg = msg
+        #self.whirly_linger
+        # Clear the line.
+        Whirly.configure(status: ' ' * @whirly_cols)
+        Whirly.configure(status: @whirly_msg)
+        @whirly_cols = @whirly_msg.length + '...'.length
+      end
+    end
+
+    def whirly_pause
+      @whirly_pauses += 1
+      return if @whirly_pauses > 1
+      return if @whirly_users.zero?
+      whirly_clear
+    end
+
+    def whirly_unpause
+      @whirly_pauses -= 1
+      raise 'Whirly unpaused once too many' if @whirly_pauses < 0
+      return unless @whirly_pauses == 0
+      return if @whirly_users.zero?
+      whirly_show
+    end
+
+    def whirly_interject
+      whirly_pause
+      yield
+      whirly_unpause
+    end
+  end
+end
+

data/lib/MrMurano/schema/resource-v1.0.0.yaml

@@ -0,0 +1,32 @@
+---
+type: object
+description: Map of the Resources allowed on Devices in this project.
+patternProperties:
+  "[a-z]+":
+    type: object
+    description: Name of a resource with info
+    properties:
+      format:
+        type: string
+        pattern: "(string|boolean|number)"
+        description: The type of data stored in aliases for this resource.
+      unit:
+        type: string
+        description: Helpful unit description for the alias.
+      settable:
+        type: boolean
+        description: True if the cloud can write to this
+      allowed:
+        type: array
+        description: |-
+          Simple data format validations.
+
+          Any set of values that matches the format.  Although for number format,
+          you can also use a string that represents a range. eg. [1,3,"9-11",21]
+
+          Or for string string format eg. ["on", "off"].
+
+          Boolean is implied [true, false] and not needed.
+
+#  vim: set et sw=2 ts=2 :
+

data/lib/MrMurano/template/projectFile.murano.erb

@@ -30,28 +30,31 @@ info:
 #
 #
 #routes:
-#  #Start off with the directory name we want to keep everything in.
+#  # Start off with the directory name we want to keep everything in.
 #  location: routes
 #
-#  #Then use globs to find all of the files that can contain route code.
-#  #If using single glob, then can be just the string.
+#  # Then use globs to find all of the files that can contain route code.
+#  # If using single glob, then can be just the string.
 #  include: ['{,../endpoints}/*.lua', '{,../endpoints}/*/*.lua']
+#  # HINT: A single asterisk glob, like */*.lua, only searches top-level
+#  #  directories. A double asterkisk, like **/*.lua, recursively searches
+#  #  all sub-directories.
 #  #include: '**/*.lua'
 #
-#  #Then remove all that match these globs. Again, if a single, can drop the array.
-#  #If not excluding, use empty array [], or empty node.
+#  # Then remove all that match these globs. Again, if a single, can drop the array.
+#  # If not excluding, use empty array [], or empty node.
 #  exclude: ['*_test.lua', '*_spec.lua', '**/.*']
 #
-#  #That leaves a list of files with API routes in them.  Each Route file can
-#  #contain one or more actual routes that are synced with Murano.
+#  # That leaves a list of files with API routes in them.  Each Route file can
+#  # contain one or more actual routes that are synced with Murano.
 #
 #
-#  #If you are hosting your website somewhere other than on Murano, and you want to
-#  #tighten up what Cross Origin calls are allowed, you can set that here.
+#  # If you are hosting your website somewhere other than on Murano, and you want to
+#  # tighten up what Cross Origin calls are allowed, you can set that here.
 #
-#  #Either point to a YAML file
+#  # Either point to a YAML file
 #  cors: "cors.yaml"
-#  #Or include it directly
+#  # Or include it directly
 #  cors: {"origin":true,"methods":["HEAD","GET","POST","PUT","DELETE","OPTIONS","PATCH"],"headers":["Content-Type","Cookie","Authorization"],"credentials":true}
 #
 #assets:
@@ -62,8 +65,8 @@ info:
 #
 #modules:
 #  location: modules
-#  include: ['*.lua', '*/*.lua']
-#  exclude: ['*_test.lua', '*_spec.lua', '**/.*']
+#  include: ['*.lua', '**/*.lua']
+#  exclude: ['*_test.lua', '*_spec.lua']
 #
 #services:
 #  location: services

data/lib/MrMurano/verbosing.rb

@@ -1,62 +1,96 @@
+# Last Modified: 2017.08.17 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
+require 'csv'
 require 'highline'
-require 'yaml'
+require 'inflecto'
 require 'json'
+require 'paint'
 require 'pp'
-require 'csv'
 require 'terminal-table'
+require 'whirly'
+require 'yaml'
+require 'MrMurano/progress'
 
 module MrMurano
+  # Verbose is a mixin for various terminal output features.
   module Verbose
     def verbose(msg)
-      if $cfg['tool.verbose'] then
-        say msg
-      end
+      MrMurano::Verbose.verbose(msg)
+    end
+
+    def self.verbose(msg)
+      whirly_interject { say msg } if $cfg['tool.verbose']
     end
 
     def debug(msg)
-      if $cfg['tool.debug'] then
-        say msg
-      end
+      MrMurano::Verbose.debug(msg)
+    end
+
+    def self.debug(msg)
+      whirly_interject { say msg } if $cfg['tool.debug']
     end
 
     def warning(msg)
-      $stderr.puts HighLine.color(msg, :yellow)
+      MrMurano::Verbose.warning(msg)
+    end
+
+    def self.warning(msg)
+      whirly_interject { $stderr.puts(HighLine.color(msg, :yellow)) }
     end
 
     def error(msg)
-      $stderr.puts HighLine.color(msg, :red)
+      MrMurano::Verbose.error(msg)
+    end
+
+    def self.error(msg)
+      # See also Commander::say_error
+      whirly_interject { $stderr.puts(HighLine.color(msg, :red)) }
     end
 
     ## Output tabular data
     # +data+:: Data to write. Preferably a Hash with :headers and :rows
     # +ios+:: Output stream to write to, if nil, then use $stdout
     # Output is either a nice visual table or CSV.
+
+    TABULARIZE_DATA_FORMAT_ERROR = 'Unexpected data format: do not know how to tabularize.'
+
     def tabularize(data, ios=nil)
+      MrMurano::Verbose.tabularize(data, ios)
+    end
+
+    def self.tabularize(data, ios=nil)
       fmt = $cfg['tool.outformat']
       ios = $stdout if ios.nil?
       cols = nil
       rows = nil
       title = nil
-      if data.kind_of?(Hash) then
-        cols = data[:headers] if data.has_key?(:headers)
-        rows = data[:rows] if data.has_key?(:rows)
+      if data.is_a?(Hash)
+        cols = data[:headers] if data.key?(:headers)
+        rows = data[:rows] if data.key?(:rows)
         title = data[:title]
-      elsif data.kind_of?(Array) then
+      elsif data.is_a?(Array)
         rows = data
-      elsif data.respond_to?(:to_a) then
+      elsif data.respond_to?(:to_a)
         rows = data.to_a
-      elsif data.respond_to?(:each) then
+      elsif data.respond_to?(:each)
         rows = []
-        data.each{|i| rows << i}
+        # MAYBE/2017-07-02: Does shover operator work on frozen string literals?
+        data.each { |i| rows << i }
       else
-        error "Don't know how to tabularize data."
+        error TABULARIZE_DATA_FORMAT_ERROR
         return
       end
-      if fmt =~ /csv/i then
+      if fmt =~ /csv/i
         cols = [] if cols.nil?
         rows = [[]] if rows.nil?
-        CSV(ios, :headers=>cols, :write_headers=>(not cols.empty?)) do |csv|
-          rows.each{|v| csv << v}
+        CSV(ios, headers: cols, write_headers: !cols.empty?) do |csv|
+          # MAYBE/2017-07-02: Does shover operator work on frozen string literals?
+          rows.each { |v| csv << v }
         end
       else
         # table.
@@ -70,7 +104,7 @@ module MrMurano
 
     ## Format and print the object
     # Handles many of the raw 'unpolished' formats.
-    def outf(obj, ios=nil, &block)
+    def outf(obj, ios=nil, &_block)
       fmt = $cfg['tool.outformat']
       ios = $stdout if ios.nil?
       case fmt
@@ -82,18 +116,121 @@ module MrMurano
         ios.puts obj.to_json
       else # aka best.
         # sometime ‘best’ is only know by the caller, so block.
-        if block_given? then
+        if block_given?
           yield obj, ios
+        elsif obj.is_a?(Array)
+          obj.each { |i| ios.puts i.to_s }
+        else
+          ios.puts obj.to_s
+        end
+      end
+    end
+
+    def self.ask_yes_no(question, default)
+      answer = default
+      whirly_interject do
+        confirm = ask(question)
+        if default
+          answer = !%w[n no].include?(confirm.downcase)
         else
-          if obj.kind_of?(Array) then
-            obj.each {|i| ios.puts i.to_s}
-          else
-            ios.puts obj.to_s
-          end
+          answer = %w[y ye yes].include?(confirm.downcase)
         end
       end
+      answer
+    end
+
+    def ask_yes_no(question, default)
+      MrMurano::Verbose.ask_yes_no(question, default)
+    end
+
+    def self.cmd_confirm_delete!(name, auto_yes, exit_msg)
+      if auto_yes
+        yield true if block_given?
+        return true
+      end
+      confirmed = MrMurano::Verbose.ask_yes_no(
+        "Really delete ‘#{name}’? [y/N] ", false
+      )
+      MrMurano::Verbose.warning(exit_msg) if !confirmed && exit_msg
+      if block_given?
+        yield confirmed
+      elsif !confirmed
+        exit 1
+      end
+      confirmed
+    end
+
+    def cmd_confirm_delete!(name, auto_yes, exit_msg)
+      MrMurano::Verbose.cmd_confirm_delete!(name, auto_yes, exit_msg)
     end
 
+    def self.pluralize?(word, count)
+      count == 1 && word || Inflecto.pluralize(word)
+    end
+
+    def pluralize?(word, count)
+      MrMurano::Verbose.pluralize?(word, count)
+    end
+
+    # 2017-07-01: Whirly wrappers. Maybe delete someday
+    #   (after replacing all MrMurano::Verbose.whirly_*
+    #   with MrMurano::Progress.whirly_*).
+
+    def whirly_start(msg)
+      MrMurano::Progress.instance.whirly_start(msg)
+    end
+
+    def whirly_stop(force: false)
+      MrMurano::Progress.instance.whirly_stop(force: force)
+    end
+
+    def whirly_linger
+      MrMurano::Progress.instance.whirly_linger
+    end
+
+    def whirly_msg(msg)
+      MrMurano::Progress.instance.whirly_msg(msg)
+    end
+
+    def whirly_pause
+      MrMurano::Progress.instance.whirly_pause
+    end
+
+    def whirly_unpause
+      MrMurano::Progress.instance.whirly_unpause
+    end
+
+    def whirly_interject(&block)
+      MrMurano::Progress.instance.whirly_interject(&block)
+    end
+
+    def self.whirly_start(msg)
+      MrMurano::Progress.instance.whirly_start(msg)
+    end
+
+    def self.whirly_stop(force: false)
+      MrMurano::Progress.instance.whirly_stop(force: force)
+    end
+
+    def self.whirly_linger
+      MrMurano::Progress.instance.whirly_linger
+    end
+
+    def self.whirly_msg(msg)
+      MrMurano::Progress.instance.whirly_msg(msg)
+    end
+
+    def self.whirly_pause
+      MrMurano::Progress.instance.whirly_pause
+    end
+
+    def self.whirly_unpause
+      MrMurano::Progress.instance.whirly_unpause
+    end
+
+    def self.whirly_interject(&block)
+      MrMurano::Progress.instance.whirly_interject(&block)
+    end
   end
 end
-#  vim: set ai et sw=2 ts=2 :
+