Merge pull request #48 from chef/mp/add-configurable-spinner-element

Make plain-text spinner element avaialble via config

Merging this, but will add a card to move the logging up the next time we want to pick up minor infra improvement .

.gitignore

@@ -1 +1,2 @@
 test_results/
+tags

components/chef-workstation/lib/chef-workstation/config.rb

@@ -26,6 +26,9 @@ class Config
     config_context :cache do
       default(:path, File.join(WS_BASE_PATH, "cache"))
     end
+    config_context :dev do
+      default(:spinner, "TTY::Spinner")
+    end
 
     class << self
       @custom_location = nil

components/chef-workstation/lib/chef-workstation/ui/plain_text_element.rb

@@ -0,0 +1,58 @@
+module ChefWorkstation
+  module UI
+    class PlainTextElement
+      def initialize(format, opts)
+        @orig_format = format
+        @format = format
+        @output = opts[:output]
+      end
+
+      def run(&block)
+        yield
+      end
+
+      def update(params)
+        # SOme of this is particular to our usage -
+        # prefix does not cause a text update, but does
+        # change the prefix for future messages.
+        if params.has_key?(:prefix)
+          @format = @orig_format.gsub(":prefix", params[:prefix])
+          return
+        end
+
+        if @succ
+          ind = "OK"
+          @succ = false
+          log_method = :info
+        elsif @err
+          ind = "ERR"
+          @err = false
+          log_method = :error
+        else
+          log_method = :debug
+          ind = " - "
+        end
+
+        # Since this is a generic type, we can replace any component
+        # name in this regex - but for now :spinner is the only component
+        # we're standing in for.
+        msg = @format.gsub(/:spinner/, ind)
+        params.each_pair do |k, v|
+          msg.gsub!(/:#{k}/, v)
+        end
+        ChefWorkstation::Log.send(log_method, msg)
+        @output.puts(msg)
+      end
+
+      def error
+        @err = true
+        @succ = false
+      end
+
+      def success
+        @succ = true
+        @err = false
+      end
+    end
+  end
+end

components/chef-workstation/lib/chef-workstation/ui/terminal.rb

@@ -1,5 +1,8 @@
-require "chef-workstation/status_reporter"
 require "tty-spinner"
+require "chef-workstation/status_reporter"
+require "chef-workstation/config"
+require "chef-workstation/log"
+require "chef-workstation/ui/plain_text_element"
 
 module ChefWorkstation
   module UI
@@ -12,17 +15,21 @@ def init(location = STDOUT)
           @location = location
         end
 
+        def write(msg)
+          @location.write(msg)
+        end
+
         def output(msg)
           @location.puts msg
         end
 
         def spinner(msg, prefix: "", &block)
-          spinner = TTY::Spinner.new("[:spinner] :prefix :status", output: @location)
+          klass = Object.const_get("ChefWorkstation::UI::#{ChefWorkstation::Config.dev.spinner}")
+          spinner = klass.new("[:spinner] :prefix :status", output: @location)
           reporter = StatusReporter.new(spinner, prefix: prefix, key: :status)
           reporter.update(msg)
           spinner.run { yield(reporter) }
         end
-
       end
     end
   end