dev-ui 0.0.1

data/lib/dev/ui/progress.rb

@@ -0,0 +1,65 @@
+require 'dev/ui'
+
+module Dev
+  module UI
+    class Progress
+      FILLED_BAR = Dev::UI::Glyph.new("◾", 0x2588, Color::CYAN)
+      UNFILLED_BAR = Dev::UI::Glyph.new("◽", 0x2588, Color::WHITE)
+
+      # Set the percent to X
+      # Dev::UI::Progress.progress do |bar|
+      #   bar.tick(set_percent: percent)
+      # end
+      #
+      # Increase the percent by 1
+      # Dev::UI::Progress.progress do |bar|
+      #   bar.tick
+      # end
+      #
+      # Increase the percent by X
+      # Dev::UI::Progress.progress do |bar|
+      #   bar.tick(percent: 5)
+      # end
+      def self.progress
+        bar = Progress.new
+        print Dev::UI::ANSI.hide_cursor
+        yield(bar)
+      ensure
+        puts bar.to_s
+        Dev::UI.raw do
+          print(ANSI.show_cursor)
+          puts(ANSI.previous_line + ANSI.end_of_line)
+        end
+      end
+
+      def initialize(width: Terminal.width)
+        @percent_done = 0
+        @max_width = width
+      end
+
+      def tick(percent: 0.01, set_percent: nil)
+        raise ArgumentError, 'percent and set_percent cannot both be specified' if percent != 0.01 && set_percent
+        @percent_done += percent
+        @percent_done = set_percent if set_percent
+        @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
+
+        print to_s
+        print Dev::UI::ANSI.previous_line
+        print Dev::UI::ANSI.end_of_line + "\n"
+      end
+
+      def to_s
+        suffix = " #{(@percent_done * 100).round(2)}%"
+        workable_width = @max_width - Frame.prefix_width - suffix.size
+        filled = (@percent_done * workable_width.to_f).ceil
+        unfilled = workable_width - filled
+
+        Dev::UI.resolve_text [
+          (FILLED_BAR.to_s * filled),
+          (UNFILLED_BAR.to_s * unfilled),
+          suffix
+        ].join
+      end
+    end
+  end
+end

data/lib/dev/ui/prompt.rb

@@ -0,0 +1,88 @@
+require 'dev/ui'
+require 'readline'
+
+module Dev
+  module UI
+    module Prompt
+      class << self
+        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true)
+          if (default && !allow_empty) || (options && (default || is_file))
+            raise(ArgumentError, 'conflicting arguments')
+          end
+
+          if default
+            puts_question("#{question} (empty = #{default})")
+          elsif options
+            puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
+          else
+            puts_question(question)
+          end
+
+          return InteractivePrompt.call(options) if options
+
+          loop do
+            line = readline(is_file: is_file)
+
+            if line.empty? && default
+              write_default_over_empty_input(default)
+              return default
+            end
+
+            if !line.empty? || allow_empty
+              return line
+            end
+          end
+        end
+
+        def confirm(question)
+          puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
+          InteractivePrompt.call(%w(yes no)) == 'yes'
+        end
+
+        private
+
+        def write_default_over_empty_input(default)
+          Dev::UI.raw do
+            STDERR.puts(
+              Dev::UI::ANSI.cursor_up(1) +
+              "\r" +
+              Dev::UI::ANSI.cursor_forward(4) + # TODO: width
+              default +
+              Dev::UI::Color::RESET.code
+            )
+          end
+        end
+
+        def puts_question(str)
+          Dev::UI.with_frame_color(:blue) do
+            STDOUT.puts(Dev::UI.fmt('{{?}} ' + str))
+          end
+        end
+
+        def readline(is_file: false)
+          if is_file
+            Readline.completion_proc = Readline::FILENAME_COMPLETION_PROC
+            Readline.completion_append_character = ""
+          else
+            Readline.completion_proc = proc { |*| nil }
+            Readline.completion_append_character = " "
+          end
+
+          # because Readline is a C library, Dev::UI's hooks into $stdout don't
+          # work. We could work around this by having Dev::UI use a pipe and a
+          # thread to manage output, but the current strategy feels like a
+          # better tradeoff.
+          prefix = Dev::UI.with_frame_color(:blue) { Dev::UI::Frame.prefix }
+          prompt = prefix + Dev::UI.fmt('{{blue:> }}{{yellow:')
+
+          begin
+            Readline.readline(prompt, true).chomp
+          rescue Interrupt
+            Dev::UI.raw { STDERR.puts('^C' + Dev::UI::Color::RESET.code) }
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev/ui/spinner.rb

@@ -0,0 +1,168 @@
+require 'dev/ui'
+
+module Dev
+  module UI
+    module Spinner
+      PERIOD = 0.1 # seconds
+
+      begin
+        runes = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+        colors = [Dev::UI::Color::CYAN.code] * 5 + [Dev::UI::Color::MAGENTA.code] * 5
+        raise unless runes.size == colors.size
+        GLYPHS = colors.zip(runes).map(&:join)
+      end
+
+      def self.spin(title, &block)
+        sg = SpinGroup.new
+        sg.add(title, &block)
+        sg.wait
+      end
+
+      class SpinGroup
+        def initialize
+          @m = Mutex.new
+          @consumed_lines = 0
+          @tasks = []
+        end
+
+        class Task
+          attr_reader :title, :exception, :success, :stdout, :stderr
+
+          def initialize(title, &block)
+            @title = title
+            @thread = Thread.new do
+              cap = Dev::UI::StdoutRouter::Capture.new(with_frame_inset: false, &block)
+              begin
+                cap.run
+              ensure
+                @stdout = cap.stdout
+                @stderr = cap.stderr
+              end
+            end
+
+            @done      = false
+            @exception = nil
+            @success   = false
+          end
+
+          def check
+            return true if @done
+            return false if @thread.alive?
+
+            @done = true
+            begin
+              status = @thread.join.status
+              @success = (status == false)
+            rescue => exc
+              @exception = exc
+              @success = false
+            end
+
+            @done
+          end
+
+          def render(index, force = true)
+            return full_render(index) if force
+            partial_render(index)
+          end
+
+          private
+
+          def full_render(index)
+            inset + glyph(index) + Dev::UI::Color::RESET.code + ' ' + Dev::UI.resolve_text(title)
+          end
+
+          def partial_render(index)
+            Dev::UI::ANSI.cursor_forward(inset_width) + glyph(index) + Dev::UI::Color::RESET.code
+          end
+
+          def glyph(index)
+            if @done
+              @success ? Dev::UI::Glyph::CHECK.to_s : Dev::UI::Glyph::X.to_s
+            else
+              GLYPHS[index]
+            end
+          end
+
+          def inset
+            @inset ||= Dev::UI::Frame.prefix
+          end
+
+          def inset_width
+            @inset_width ||= Dev::UI::ANSI.printing_width(inset)
+          end
+        end
+
+        def add(title, &block)
+          @m.synchronize do
+            @tasks << Task.new(title, &block)
+          end
+        end
+
+        def wait
+          idx = 0
+
+          loop do
+            all_done = true
+
+            @m.synchronize do
+              Dev::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   = Dev::UI::ANSI.cursor_up(offset) + "\r"
+                    move_from = "\r" + Dev::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
+        end
+
+        def debrief
+          @m.synchronize do
+            @tasks.each do |task|
+              next if task.success
+
+              e = task.exception
+              out = task.stdout
+              err = task.stderr
+
+              Dev::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
+
+                Dev::UI::Frame.divider('STDOUT')
+                out = "(empty)" if out.strip.empty?
+                puts out
+
+                Dev::UI::Frame.divider('STDERR')
+                err = "(empty)" if err.strip.empty?
+                puts err
+              end
+            end
+            @tasks.all?(&:success)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev/ui/stdout_router.rb

@@ -0,0 +1,189 @@
+require 'dev/ui'
+require 'stringio'
+
+module Dev
+  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, Dev::UI::Frame.prefix)
+            args[0] = str
+          else
+            @pending_newline = false
+          end
+
+          hook = Thread.current[:devui_output_hook]
+          # hook return of false suppresses output.
+          if !hook || hook.call(args.first, @name) != false
+            args.first
+            @stream.write_without_dev_ui(*args)
+            if dup = StdoutRouter.duplicate_output_to
+              dup.write(*args)
+            end
+          end
+        end
+
+        private
+
+        def auto_frame_inset?
+          !Thread.current[:no_devui_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(with_frame_inset: true, &block)
+          @with_frame_inset = with_frame_inset
+          @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_devui_frame_inset]
+          prev_hook = Thread.current[:devui_output_hook]
+
+          self.class.with_stdin_masked do
+            Thread.current[:no_devui_frame_inset] = !@with_frame_inset
+            Thread.current[:devui_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
+            ensure
+              @stdout = out.string
+              @stderr = err.string
+            end
+          end
+        ensure
+          Thread.current[:devui_output_hook] = prev_hook
+          Thread.current[:no_devui_frame_inset] = prev_frame_inset
+        end
+      end
+
+      class << self
+        WRITE_WITHOUT_DEV_UI = :write_without_dev_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_DEV_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_DEV_UI)
+        end
+
+        def activate(stream, streamname)
+          writer = StdoutRouter::Writer.new(stream, streamname)
+
+          raise if stream.respond_to?(WRITE_WITHOUT_DEV_UI)
+          stream.singleton_class.send(:alias_method, WRITE_WITHOUT_DEV_UI, :write)
+          stream.define_singleton_method(:write) do |*args|
+            writer.write(*args)
+          end
+        end
+      end
+    end
+  end
+end
+
+Dev::UI::StdoutRouter.enable