interactive-logger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72a04135369c640aab4c63048eafb80e669ed895
-  data.tar.gz: 8b983336a11ced1edbd6ff4624505c90e3801c32
+  metadata.gz: 0c5636a0534a2b4c303e9b6b3f83cdb0e1791dc6
+  data.tar.gz: f11583fe28d1b0757f8a73edeb82d52d0d8b8bf6
 SHA512:
-  metadata.gz: 87f61383fff19a07ec26acaa805b3f05cfc10c283bdc9d68fdd85710f7c6a08b3760d0106724c280cdb423eeb0d36cbccece45ce759403f3b89df030f4a1ec4e
-  data.tar.gz: 60fa6e6384f7d20ee5dde568723b90cb5a3102aaa5a942dc094ac0c7505ef736956ee4562db33eccc8e80e925cf677546aa3b6612cff170184c2809c9157625c
+  metadata.gz: 3156898ce2975d594b9799bcfe0abef48d68db309e7cc2b07345e61306c97994314e890ecb3ad72dcc447ef0e1df499525cf9ca21efc3b5e0e6730389ac5cc33
+  data.tar.gz: 4136d190ac320d7e5f9d60100d1ad84a9783fba4c7c053fcc5ba6c43499533e538c6e7ef8c54db4114b6de45079195e4de7451f45dc19c156943e6ed0b9c4a57

data/lib/interactive-logger.rb

@@ -1,62 +1,99 @@
 # coding: utf-8
 require 'colorize'
 require 'ruby-duration'
+require 'thread'
 
 # A logger that shows activity for each step without spamming to stdout.
 class InteractiveLogger
-  class Step
-    PROGRESS_SYMBOLS = %w(- \\ | /)
-    FAILURE_SYMBOL = '✗'.red
-    SUCCESS_SYMBOL = '✓'.green
-    LB = '['.light_black
-    RB = ']'.light_black
-
-    def initialize(str, show_time: true)
-      @orig_str = str
-      @start = Time.now
-      @show_time = show_time
-      @pos = 0
-      print_msg(in_progress_prefix << str)
-    end
+  require_relative 'interactive_logger/step'
+  require_relative 'interactive_logger/threaded_step_interface'
 
-    def continue(str = nil)
-      @pos += 1
-      print_msg("\r" << in_progress_prefix << (str || @orig_str))
-    end
+  def initialize(debug: false)
+    @debug = debug
+    @current_step = nil
+  end
 
-    def failure(str = nil)
-      print_msg("\r" << prefix(FAILURE_SYMBOL) << (str || @orig_str))
-    end
+  def debug?; @debug == true end
 
-    def success(str = nil)
-      print_msg("\r" << prefix(SUCCESS_SYMBOL) << (str || @orig_str))
-    end
+  # Start a step.
+  def start(str)
+    @current_step = Step.new(str)
+    yield @current_step
+    print "\n"
+  rescue => e
+    @current_step.failure "Error while performing step: #{str}\n  #{e.class}: #{e.message}"
+    print "\n"
+    raise
+  ensure
+    @current_step = nil
+  end
 
-    private
+  # Use a threaded interface, to keep the UI updated even on a long-running
+  # process.
+  def start_threaded(str)
+    @current_step = Step.new(str)
+    queue = Queue.new
 
-    def in_progress_prefix
-      prefix(PROGRESS_SYMBOLS[@pos % PROGRESS_SYMBOLS.size].yellow)
+    Thread.abort_on_exception = true
+    child = Thread.new do
+      yield ThreadedStepInterface.new(queue)
     end
 
-    def prefix(str)
-      show_time = ''
-      if @show_time
-        show_time = Duration.new(Time.now.to_i - @start.to_i)
-                            .format(" #{LB} %tmm %ss #{RB}")
+    loop do
+      if queue.empty?
+        @current_step.continue # Keep the UI updating regardless of actual process.
+      else
+        until queue.empty?
+          msg = queue.pop
+          @current_step.send(msg.shift, *msg)
+        end
       end
-      "#{LB} #{str} #{RB}#{show_time} "
-    end
 
-    def print_msg(str)
-      @max_str = [str.uncolorize.size, @max_str || 0].max
-      str << ' ' * (@max_str - str.uncolorize.size)
-      print str
+      break unless child.alive?
+      sleep 0.5
     end
+
+    puts
+    child.join
+
+    @current_step.nil?
+  rescue => e
+    @current_step.failure "Error while performing step: #{str}\n  #{e.class}: #{e.message}"
+    print "\n"
+    raise
+  ensure
+    @current_step = nil
   end
 
-  # Start a step.
-  def start(str)
-    yield Step.new(str)
+  # Post a debug message above the current step output, if debugging is enabled.
+  def debug(str)
+    return unless debug?
+
+    @current_step.blank if @current_step
+    print '--> '.yellow
+    puts str
+    @current_step.repaint if @current_step
+  end
+  # Post an informative message above the current step output.
+  def info(str)
+    @current_step.blank if @current_step
+    print '--> '.green
+    puts str
+    @current_step.repaint if @current_step
+  end
+
+  # Post an error message above the current step output.
+  def error(str)
+    @current_step.blank if @current_step
+    print '--> '.red
+    puts str
+    @current_step.repaint if @current_step
+  end
+
+  # Post a single message, without any progress tracking.
+  def msg(str)
+    c = Step.new(str)
+    c.success
     print "\n"
   end
 end

data/lib/interactive_logger/step.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+class InteractiveLogger
+  class Step
+    PROGRESS_SYMBOLS = %w(- \\ | /)
+    FAILURE_SYMBOL = '✗'.red
+    SUCCESS_SYMBOL = '✓'.green
+    LB = '['.light_black
+    RB = ']'.light_black
+
+    def initialize(str, show_time: true)
+      @last_str = str
+      @start = Time.now
+      @show_time = show_time
+      @pos = 0
+      print_msg(in_progress_prefix << str)
+    end
+
+    def continue(str = nil)
+      @pos += 1
+      @last_str = str if str
+      print_msg(in_progress_prefix << @last_str)
+    end
+
+    def failure(str = nil)
+      @last_str = str if str
+      print_msg(prefix(FAILURE_SYMBOL) << @last_str)
+    end
+
+    def success(str = nil)
+      @last_str = str if str
+      print_msg(prefix(SUCCESS_SYMBOL) << @last_str)
+    end
+
+    # Blank out the current line.
+    def blank
+      print "\r"
+      if @last_print_msg
+        print ' ' * @last_print_msg.uncolorize.size
+      end
+      print "\r"
+    end
+
+    def repaint
+      print @last_print_msg
+    end
+
+    private
+
+    def in_progress_prefix
+      prefix(PROGRESS_SYMBOLS[@pos % PROGRESS_SYMBOLS.size].yellow)
+    end
+
+    def prefix(str)
+      show_time = ''
+      if @show_time
+        show_time = Duration.new(Time.now.to_i - @start.to_i)
+                            .format(" #{LB} %tmm %ss #{RB}")
+      end
+      "#{LB} #{str} #{RB}#{show_time} "
+    end
+
+    def print_msg(str)
+      blank
+      @last_print_msg = str
+      print str
+    end
+  end
+end

data/lib/interactive_logger/threaded_step_interface.rb

@@ -0,0 +1,23 @@
+require 'thread'
+
+class InteractiveLogger
+  # A interface-match for Step, but used simply to communicate with the main
+  # thread, which actually manipulates the Step.
+  class ThreadedStepInterface
+    def initialize(queue)
+      @queue = queue
+    end
+
+    def continue(str = nil)
+      @queue.push([:continue, str])
+    end
+
+    def failure(str = nil)
+      @queue.push([:failure, str])
+    end
+
+    def success(str = nil)
+      @queue.push([:success, str])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interactive-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kyle Smith <askreet@gmail.com>
@@ -51,6 +51,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/interactive-logger.rb
+- lib/interactive_logger/step.rb
+- lib/interactive_logger/threaded_step_interface.rb
 homepage: https://github.com/askreet/interactive-logger
 licenses:
 - MIT