cli-ui 0.1.2

data/lib/cli/ui/spinner.rb

@@ -0,0 +1,48 @@
+require 'cli/ui'
+
+module CLI
+  module UI
+    module Spinner
+      autoload :Async,      'cli/ui/spinner/async'
+      autoload :SpinGroup,  'cli/ui/spinner/spin_group'
+
+      PERIOD = 0.1 # seconds
+      TASK_FAILED = :task_failed
+
+      begin
+        runes = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+        colors = [CLI::UI::Color::CYAN.code] * 5 + [CLI::UI::Color::MAGENTA.code] * 5
+        raise unless runes.size == colors.size
+        GLYPHS = colors.zip(runes).map(&:join)
+      end
+
+      # Adds a single spinner
+      # Uses an interactive session to allow the user to pick an answer
+      # Can use arrows, y/n, numbers (1/2), and vim bindings to control
+      #
+      # https://user-images.githubusercontent.com/3074765/33798295-d94fd822-dce3-11e7-819b-43e5502d490e.gif
+      #
+      # ==== Attributes
+      #
+      # * +title+ - Title of the spinner to use
+      #
+      # ==== Options
+      #
+      # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+      #
+      # ==== Block
+      #
+      # * *spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
+      #
+      # ==== Example Usage:
+      #
+      #   CLI::UI::Spinner.spin('Title') { sleep 1.0 }
+      #
+      def self.spin(title, auto_debrief: true, &block)
+        sg = SpinGroup.new(auto_debrief: auto_debrief)
+        sg.add(title, &block)
+        sg.wait
+      end
+    end
+  end
+end

data/lib/cli/ui/spinner/async.rb

@@ -0,0 +1,40 @@
+module CLI
+  module UI
+    module Spinner
+      class Async
+        # Convenience method for +initialize+
+        #
+        def self.start(title)
+          new(title)
+        end
+
+        # Initializes a new asynchronous spinner with no specific end.
+        # Must call +.stop+ to end the spinner
+        #
+        # ==== Attributes
+        #
+        # * +title+ - Title of the spinner to use
+        #
+        # ==== Example Usage:
+        #
+        #   CLI::UI::Spinner::Async.new('Title')
+        #
+        def initialize(title)
+          require 'thread'
+          sg = CLI::UI::Spinner::SpinGroup.new
+          @m = Mutex.new
+          @cv = ConditionVariable.new
+          sg.add(title) { @m.synchronize { @cv.wait(@m) } }
+          @t = Thread.new { sg.wait }
+        end
+
+        # Stops an asynchronous spinner
+        #
+        def stop
+          @m.synchronize { @cv.signal }
+          @t.value
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/spinner/spin_group.rb

@@ -0,0 +1,223 @@
+module CLI
+  module UI
+    module Spinner
+      class SpinGroup
+        # Initializes a new spin group
+        # This lets you add +Task+ objects to the group to multi-thread work
+        #
+        # ==== Options
+        #
+        # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+        #
+        # ==== Example Usage
+        #
+        #  spin_group = CLI::UI::SpinGroup.new
+        #  spin_group.add('Title')   { |spinner| sleep 3.0 }
+        #  spin_group.add('Title 2') { |spinner| sleep 3.0; spinner.update_title('New Title'); sleep 3.0 }
+        #  spin_group.wait
+        #
+        # Output:
+        #
+        # https://user-images.githubusercontent.com/3074765/33798558-c452fa26-dce8-11e7-9e90-b4b34df21a46.gif
+        #
+        def initialize(auto_debrief: true)
+          @m = Mutex.new
+          @consumed_lines = 0
+          @tasks = []
+          @auto_debrief = auto_debrief
+        end
+
+        class Task
+          attr_reader :title, :exception, :success, :stdout, :stderr
+
+          # Initializes a new Task
+          # This is managed entirely internally by +SpinGroup+
+          #
+          # ==== Attributes
+          #
+          # * +title+ - Title of the task
+          # * +block+ - Block for the task, will be provided with an instance of the spinner
+          #
+          def initialize(title, &block)
+            @title = title
+            @thread = Thread.new do
+              cap = CLI::UI::StdoutRouter::Capture.new(self, with_frame_inset: false, &block)
+              begin
+                cap.run
+              ensure
+                @stdout = cap.stdout
+                @stderr = cap.stderr
+              end
+            end
+
+            @force_full_render = false
+            @done      = false
+            @exception = nil
+            @success   = false
+          end
+
+          # Checks if a task is finished
+          #
+          def check
+            return true if @done
+            return false if @thread.alive?
+
+            @done = true
+            begin
+              status = @thread.join.status
+              @success = (status == false)
+              @success = false if @thread.value == TASK_FAILED
+            rescue => exc
+              @exception = exc
+              @success = false
+            end
+
+            @done
+          end
+
+          # Re-renders the task if required
+          #
+          # ==== Attributes
+          #
+          # * +index+ - index of the task
+          # * +force+ - force rerender of the task
+          #
+          def render(index, force = true)
+            return full_render(index) if force || @force_full_render
+            partial_render(index)
+          ensure
+            @force_full_render = false
+          end
+
+          # Update the spinner title
+          #
+          # ==== Attributes
+          #
+          # * +title+ - title to change the spinner to
+          #
+          def update_title(new_title)
+            @title = new_title
+            @force_full_render = true
+          end
+
+          private
+
+          def full_render(index)
+            inset + glyph(index) + CLI::UI::Color::RESET.code + ' ' + CLI::UI.resolve_text(title) + "\e[K"
+          end
+
+          def partial_render(index)
+            CLI::UI::ANSI.cursor_forward(inset_width) + glyph(index) + CLI::UI::Color::RESET.code
+          end
+
+          def glyph(index)
+            if @done
+              @success ? CLI::UI::Glyph::CHECK.to_s : CLI::UI::Glyph::X.to_s
+            else
+              GLYPHS[index]
+            end
+          end
+
+          def inset
+            @inset ||= CLI::UI::Frame.prefix
+          end
+
+          def inset_width
+            @inset_width ||= CLI::UI::ANSI.printing_width(inset)
+          end
+        end
+
+        # Add a new task
+        #
+        # ==== Attributes
+        #
+        # * +title+ - Title of the task
+        # * +block+ - Block for the task, will be provided with an instance of the spinner
+        #
+        # ==== Example Usage:
+        #   spin_group = CLI::UI::SpinGroup.new
+        #   spin_group.add('Title') { |spinner| sleep 1.0 }
+        #   spin_group.wait
+        #
+        def add(title, &block)
+          @m.synchronize do
+            @tasks << Task.new(title, &block)
+          end
+        end
+
+        # Tells the group you're done adding tasks and to wait for all of them to finish
+        #
+        # ==== Example Usage:
+        #   spin_group = CLI::UI::SpinGroup.new
+        #   spin_group.add('Title') { |spinner| sleep 1.0 }
+        #   spin_group.wait
+        #
+        def wait
+          idx = 0
+
+          loop do
+            all_done = true
+
+            @m.synchronize do
+              CLI::UI.raw do
+                @tasks.each.with_index do |task, int_index|
+                  nat_index = int_index + 1
+                  task_done = task.check
+                  all_done = false unless task_done
+
+                  if nat_index > @consumed_lines
+                    print(task.render(idx, true) + "\n")
+                    @consumed_lines += 1
+                  else
+                    offset = @consumed_lines - int_index
+                    move_to   = CLI::UI::ANSI.cursor_up(offset) + "\r"
+                    move_from = "\r" + CLI::UI::ANSI.cursor_down(offset)
+
+                    print(move_to + task.render(idx, idx.zero?) + move_from)
+                  end
+                end
+              end
+            end
+
+            break if all_done
+
+            idx = (idx + 1) % GLYPHS.size
+            sleep(PERIOD)
+          end
+
+          debrief if @auto_debrief
+        end
+
+        # Debriefs failed tasks is +auto_debrief+ is true
+        #
+        def debrief
+          @m.synchronize do
+            @tasks.each do |task|
+              next if task.success
+
+              e = task.exception
+              out = task.stdout
+              err = task.stderr
+
+              CLI::UI::Frame.open('Task Failed: ' + task.title, color: :red) do
+                if e
+                  puts "#{e.class}: #{e.message}"
+                  puts "\tfrom #{e.backtrace.join("\n\tfrom ")}"
+                end
+
+                CLI::UI::Frame.divider('STDOUT')
+                out = "(empty)" if out.nil? || out.strip.empty?
+                puts out
+
+                CLI::UI::Frame.divider('STDERR')
+                err = "(empty)" if err.nil? || err.strip.empty?
+                puts err
+              end
+            end
+            @tasks.all?(&:success)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/stdout_router.rb

@@ -0,0 +1,188 @@
+require 'cli/ui'
+require 'stringio'
+
+module CLI
+  module UI
+    module StdoutRouter
+      class << self
+        attr_accessor :duplicate_output_to
+      end
+
+      class Writer
+        def initialize(stream, name)
+          @stream = stream
+          @name = name
+        end
+
+        def write(*args)
+          if auto_frame_inset?
+            str = args[0].dup # unfreeze
+            str = str.force_encoding(Encoding::UTF_8)
+            str = apply_line_prefix(str, CLI::UI::Frame.prefix)
+            args[0] = str
+          else
+            @pending_newline = false
+          end
+
+          hook = Thread.current[:cliui_output_hook]
+          # hook return of false suppresses output.
+          if !hook || hook.call(args.first, @name) != false
+            args.first
+            @stream.write_without_cli_ui(*args)
+            if dup = StdoutRouter.duplicate_output_to
+              dup.write(*args)
+            end
+          end
+        end
+
+        private
+
+        def auto_frame_inset?
+          !Thread.current[:no_cliui_frame_inset]
+        end
+
+        def apply_line_prefix(str, prefix)
+          return '' if str.empty?
+          prefixed = String.new
+          str.force_encoding(Encoding::UTF_8).lines.each do |line|
+            if @pending_newline
+              prefixed << line
+              @pending_newline = false
+            else
+              prefixed << prefix << line
+            end
+          end
+          @pending_newline = !str.end_with?("\n")
+          prefixed
+        end
+      end
+
+      class Capture
+        @m = Mutex.new
+        @active_captures = 0
+        @saved_stdin = nil
+
+        def self.with_stdin_masked
+          @m.synchronize do
+            if @active_captures.zero?
+              @saved_stdin = $stdin
+              $stdin, w = IO.pipe
+              $stdin.close
+              w.close
+            end
+            @active_captures += 1
+          end
+
+          yield
+        ensure
+          @m.synchronize do
+            @active_captures -= 1
+            if @active_captures.zero?
+              $stdin = @saved_stdin
+            end
+          end
+        end
+
+        def initialize(*block_args, with_frame_inset: true, &block)
+          @with_frame_inset = with_frame_inset
+          @block_args = block_args
+          @block = block
+        end
+
+        attr_reader :stdout, :stderr
+
+        def run
+          require 'stringio'
+
+          StdoutRouter.assert_enabled!
+
+          out = StringIO.new
+          err = StringIO.new
+
+          prev_frame_inset = Thread.current[:no_cliui_frame_inset]
+          prev_hook = Thread.current[:cliui_output_hook]
+
+          self.class.with_stdin_masked do
+            Thread.current[:no_cliui_frame_inset] = !@with_frame_inset
+            Thread.current[:cliui_output_hook] = ->(data, stream) do
+              case stream
+              when :stdout then out.write(data)
+              when :stderr then err.write(data)
+              else raise
+              end
+              false # suppress writing to terminal
+            end
+
+            begin
+              @block.call(*@block_args)
+            ensure
+              @stdout = out.string
+              @stderr = err.string
+            end
+          end
+        ensure
+          Thread.current[:cliui_output_hook] = prev_hook
+          Thread.current[:no_cliui_frame_inset] = prev_frame_inset
+        end
+      end
+
+      class << self
+        WRITE_WITHOUT_CLI_UI = :write_without_cli_ui
+
+        NotEnabled = Class.new(StandardError)
+
+        def assert_enabled!
+          raise NotEnabled unless enabled?
+        end
+
+        def with_enabled
+          enable
+          yield
+        ensure
+          disable
+        end
+
+        # TODO: remove this
+        def ensure_activated
+          enable unless enabled?
+        end
+
+        def enable
+          return false if enabled?($stdout) || enabled?($stderr)
+          activate($stdout, :stdout)
+          activate($stderr, :stderr)
+          true
+        end
+
+        def enabled?(stream = $stdout)
+          stream.respond_to?(WRITE_WITHOUT_CLI_UI)
+        end
+
+        def disable
+          return false unless enabled?($stdout) && enabled?($stderr)
+          deactivate($stdout)
+          deactivate($stderr)
+          true
+        end
+
+        private
+
+        def deactivate(stream)
+          sc = stream.singleton_class
+          sc.send(:remove_method, :write)
+          sc.send(:alias_method, :write, WRITE_WITHOUT_CLI_UI)
+        end
+
+        def activate(stream, streamname)
+          writer = StdoutRouter::Writer.new(stream, streamname)
+
+          raise if stream.respond_to?(WRITE_WITHOUT_CLI_UI)
+          stream.singleton_class.send(:alias_method, WRITE_WITHOUT_CLI_UI, :write)
+          stream.define_singleton_method(:write) do |*args|
+            writer.write(*args)
+          end
+        end
+      end
+    end
+  end
+end