fluid_cli 0.1.2

data/vendor/deps/cli-ui/lib/cli/ui.rb

@@ -0,0 +1,359 @@
+# typed: true
+# frozen_string_literal: true
+
+module CLI
+  module UI
+    autoload :ANSI,             'cli/ui/ansi'
+    autoload :Glyph,            'cli/ui/glyph'
+    autoload :Color,            'cli/ui/color'
+    autoload :Frame,            'cli/ui/frame'
+    autoload :OS,               'cli/ui/os'
+    autoload :Printer,          'cli/ui/printer'
+    autoload :Progress,         'cli/ui/progress'
+    autoload :ProgressReporter, 'cli/ui/progress_reporter'
+    autoload :Prompt,           'cli/ui/prompt'
+    autoload :Table,            'cli/ui/table'
+    autoload :Terminal,         'cli/ui/terminal'
+    autoload :Truncater,        'cli/ui/truncater'
+    autoload :Formatter,        'cli/ui/formatter'
+    autoload :Spinner,          'cli/ui/spinner'
+    autoload :Widgets,          'cli/ui/widgets'
+    autoload :Wrap,             'cli/ui/wrap'
+
+    # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
+    SpinGroup = Spinner::SpinGroup
+
+    #: type colorable = Symbol | String | CLI::UI::Color
+    #: type frame_stylable = Symbol | String | CLI::UI::Frame::FrameStyle
+    #: type io_like = IO | StringIO
+
+    class << self
+      # Glyph resolution using +CLI::UI::Glyph.lookup+
+      # Look at the method signature for +Glyph.lookup+ for more details
+      #
+      # ==== Attributes
+      #
+      # * +handle+ - handle of the glyph to resolve
+      #
+      #: (String handle) -> Glyph
+      def glyph(handle)
+        CLI::UI::Glyph.lookup(handle)
+      end
+
+      # Color resolution using +CLI::UI::Color.lookup+
+      # Will lookup using +Color.lookup+ unless it's already a CLI::UI::Color (or nil)
+      #
+      # ==== Attributes
+      #
+      # * +input+ - color to resolve
+      #
+      #: (colorable input) -> CLI::UI::Color
+      def resolve_color(input)
+        case input
+        when CLI::UI::Color
+          input
+        else
+          CLI::UI::Color.lookup(input)
+        end
+      end
+
+      # Frame style resolution using +CLI::UI::Frame::FrameStyle.lookup+.
+      # Will lookup using +FrameStyle.lookup+ unless it's already a CLI::UI::Frame::FrameStyle(or nil)
+      #
+      # ==== Attributes
+      #
+      # * +input+ - frame style to resolve
+      #: (frame_stylable input) -> CLI::UI::Frame::FrameStyle
+      def resolve_style(input)
+        case input
+        when CLI::UI::Frame::FrameStyle
+          input
+        else
+          CLI::UI::Frame::FrameStyle.lookup(input.to_s)
+        end
+      end
+
+      # Convenience Method for +CLI::UI::Prompt.confirm+
+      #
+      # ==== Attributes
+      #
+      # * +question+ - question to confirm
+      #
+      #: (String question, ?default: bool) -> bool
+      def confirm(question, default: true)
+        CLI::UI::Prompt.confirm(question, default: default)
+      end
+
+      # Convenience Method for +CLI::UI::Prompt.any_key+
+      #
+      # ==== Attributes
+      #
+      # * +prompt+ - prompt to present
+      #
+      #: (?String prompt) -> String?
+      def any_key(prompt = 'Press any key to continue')
+        CLI::UI::Prompt.any_key(prompt)
+      end
+
+      # Convenience Method for +CLI::UI::Prompt.ask+
+      #: (String question, ?options: Array[String]?, ?default: (String | Array[String])?, ?is_file: bool, ?allow_empty: bool, ?multiple: bool, ?filter_ui: bool, ?select_ui: bool) ?{ (Prompt::OptionsHandler handler) -> void } -> (String | Array[String])
+      def ask(
+        question,
+        options: nil,
+        default: nil,
+        is_file: false,
+        allow_empty: true,
+        multiple: false,
+        filter_ui: true,
+        select_ui: true,
+        &options_proc
+      )
+        CLI::UI::Prompt.ask(
+          question,
+          options: options,
+          default: default,
+          is_file: is_file,
+          allow_empty: allow_empty,
+          multiple: multiple,
+          filter_ui: filter_ui,
+          select_ui: select_ui,
+          &options_proc
+        )
+      end
+
+      # Convenience Method to resolve text using +CLI::UI::Formatter.format+
+      # Check +CLI::UI::Formatter::SGR_MAP+ for available formatting options
+      #
+      # ==== Attributes
+      #
+      # * +input+ - input to format
+      # * +truncate_to+ - number of characters to truncate the string to (or nil)
+      # * +enable_color+ - should color be used? default to true unless output is redirected.
+      #
+      #: (String input, ?truncate_to: Integer?, ?enable_color: bool) -> String
+      def resolve_text(input, truncate_to: nil, enable_color: enable_color?)
+        formatted = CLI::UI::Formatter.new(input).format(enable_color: enable_color)
+        return formatted unless truncate_to
+
+        CLI::UI::Truncater.call(formatted, truncate_to)
+      end
+
+      # Convenience Method to format text using +CLI::UI::Formatter.format+
+      # Check +CLI::UI::Formatter::SGR_MAP+ for available formatting options
+      #
+      # https://user-images.githubusercontent.com/3074765/33799827-6d0721a2-dd01-11e7-9ab5-c3d455264afe.png
+      # https://user-images.githubusercontent.com/3074765/33799847-9ec03fd0-dd01-11e7-93f7-5f5cc540e61e.png
+      #
+      # ==== Attributes
+      #
+      # * +input+ - input to format
+      #
+      # ==== Options
+      #
+      # * +enable_color+ - should color be used? default to true unless output is redirected.
+      #
+      #: (String input, ?enable_color: bool) -> String
+      def fmt(input, enable_color: enable_color?)
+        CLI::UI::Formatter.new(input).format(enable_color: enable_color)
+      end
+
+      #: (String input) -> String
+      def wrap(input)
+        CLI::UI::Wrap.new(input).wrap
+      end
+
+      # Convenience Method for +CLI::UI::Printer.puts+
+      #
+      # ==== Attributes
+      #
+      # * +msg+ - Message to print
+      # * +kwargs+ - keyword arguments for +Printer.puts+
+      #
+      #: (String msg, ?frame_color: colorable?, ?to: io_like, ?encoding: Encoding, ?format: bool, ?graceful: bool, ?wrap: bool) -> void
+      def puts(
+        msg,
+        frame_color: nil,
+        to: $stdout,
+        encoding: Encoding::UTF_8,
+        format: true,
+        graceful: true,
+        wrap: true
+      )
+        CLI::UI::Printer.puts(
+          msg,
+          frame_color: frame_color,
+          to: to,
+          encoding: encoding,
+          format: format,
+          graceful: graceful,
+          wrap: wrap,
+        )
+      end
+
+      # Convenience Method for +CLI::UI::Frame.open+
+      #
+      # ==== Attributes
+      #
+      # * +args+ - arguments for +Frame.open+
+      # * +block+ - block for +Frame.open+
+      #
+      #: [T] (String text, ?color: colorable?, ?failure_text: String?, ?success_text: String?, ?timing: (Numeric | bool), ?frame_style: frame_stylable, ?to: io_like) ?{ -> T } -> T?
+      def frame(
+        text,
+        color: Frame::DEFAULT_FRAME_COLOR,
+        failure_text: nil,
+        success_text: nil,
+        timing: block_given?,
+        frame_style: Frame.frame_style,
+        to: $stdout,
+        &block
+      )
+        CLI::UI::Frame.open(
+          text,
+          color: color,
+          failure_text: failure_text,
+          success_text: success_text,
+          timing: timing,
+          frame_style: frame_style,
+          to: to,
+          &block
+        )
+      end
+
+      # Convenience Method for +CLI::UI::Spinner.spin+
+      #
+      # ==== Attributes
+      #
+      # * +args+ - arguments for +Spinner.open+
+      # * +block+ - block for +Spinner.open+
+      #
+      #: (String title, ?auto_debrief: bool, ?to: io_like) { (Spinner::SpinGroup::Task task) -> void } -> bool
+      def spinner(title, auto_debrief: true, to: $stdout, &block)
+        CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief, to: to, &block)
+      end
+
+      # Convenience Method to override frame color using +CLI::UI::Frame.with_frame_color+
+      #
+      # ==== Attributes
+      #
+      # * +color+ - color to override to
+      # * +block+ - block for +Frame.with_frame_color_override+
+      #
+      #: [T] (colorable color) { -> T } -> T
+      def with_frame_color(color, &block)
+        CLI::UI::Frame.with_frame_color_override(color, &block)
+      end
+
+      # Duplicate output to a file path
+      #
+      # ==== Attributes
+      #
+      # * +path+ - path to duplicate output to
+      #
+      #: [T] (String path) { -> T } -> T
+      def log_output_to(path, &block)
+        if CLI::UI::StdoutRouter.duplicate_output_to
+          raise 'multiple logs not allowed'
+        end
+
+        CLI::UI::StdoutRouter.duplicate_output_to = File.open(path, 'w')
+        yield
+      ensure
+        if (file_descriptor = CLI::UI::StdoutRouter.duplicate_output_to)
+          begin
+            file_descriptor.close
+          rescue IOError
+            nil
+          end
+          CLI::UI::StdoutRouter.duplicate_output_to = nil
+        end
+      end
+
+      # Disable all framing within a block
+      #
+      # ==== Attributes
+      #
+      # * +block+ - block in which to disable frames
+      #
+      #: [T] { -> T } -> T
+      def raw(&block)
+        prev = Thread.current[:no_cliui_frame_inset]
+        Thread.current[:no_cliui_frame_inset] = true
+        yield
+      ensure
+        Thread.current[:no_cliui_frame_inset] = prev
+      end
+
+      # Check whether colour is enabled in Formatter, Frame, and Spinner output.
+      # By default, colour is enabled when STDOUT is a TTY; that is, when output
+      # has not been directed to another program or to a file.
+      #
+      #: -> bool
+      def enable_color?
+        @enable_color
+      end
+
+      # Turn colour in Formatter, Frame, and Spinner output on or off.
+      #
+      # ==== Attributes
+      #
+      # * +bool+ - true or false; enable or disable colour.
+      #
+      #: (bool bool) -> void
+      def enable_color=(bool)
+        @enable_color = !!bool
+      end
+
+      # Check whether cursor control is enabled in Formatter, Frame, and Spinner output.
+      # By default, cursor control is enabled when STDOUT is a TTY; that is, when output
+      # has not been directed to another program or to a file.
+      #
+      #: -> bool
+      def enable_cursor?
+        @enable_cursor
+      end
+
+      # Turn cursor control in Formatter, Frame, and Spinner output on or off.
+      #
+      # ==== Attributes
+      #
+      # * +bool+ - true or false; enable or disable cursor control.
+      #
+      #: (bool bool) -> void
+      def enable_cursor=(bool)
+        @enable_cursor = !!bool
+      end
+
+      # Set the default frame style.
+      # Convenience method for setting the default frame style with +CLI::UI::Frame.frame_style=+
+      #
+      # Raises ArgumentError if +frame_style+ is not valid
+      #
+      # ==== Attributes
+      #
+      # * +symbol+ - the default frame style to use for frames
+      #
+      #: (frame_stylable frame_style) -> void
+      def frame_style=(frame_style)
+        Frame.frame_style = frame_style
+      end
+
+      # Create a terminal link
+      #: (String url, String text, ?format: bool, ?blue_underline: bool) -> String
+      def link(url, text, format: true, blue_underline: format)
+        raise 'cannot use blue_underline without format' if blue_underline && !format
+
+        text = "{{blue:{{underline:#{text}}}}}" if blue_underline
+        text = CLI::UI.fmt(text) if format
+        "\x1b]8;;#{url}\x1b\\#{text}\x1b]8;;\x1b\\"
+      end
+    end
+
+    self.enable_color = $stdout.tty? && ENV['TERM'] != 'dumb' #: as !nil
+
+    # Shopify's CI system supports color, but not cursor control
+    self.enable_cursor = $stdout.tty? && ENV['TERM'] != 'dumb' && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil? #: as !nil
+  end
+end
+
+require 'cli/ui/stdout_router'

data/vendor/deps/cli-ui/vendor/reentrant_mutex.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2014 Boris Bera
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Sourced from https://github.com/dotboris/reentrant_mutex
+module CLI
+  module UI
+    class ReentrantMutex < Mutex
+      def initialize
+        @count_mutex = Mutex.new
+        @counts = Hash.new(0)
+
+        super
+      end
+
+      def synchronize
+        raise ThreadError, 'Must be called with a block' unless block_given?
+
+        begin
+          lock
+          yield
+        ensure
+          unlock
+        end
+      end
+
+      def lock
+        c = increase_count Thread.current
+        super if c <= 1
+      end
+
+      def unlock
+        c = decrease_count Thread.current
+        if c <= 0
+          super
+          delete_count Thread.current
+        end
+      end
+
+      def count
+        @count_mutex.synchronize { @counts[Thread.current] }
+      end
+
+      private
+
+      def increase_count(thread)
+        @count_mutex.synchronize { @counts[thread] += 1 }
+      end
+
+      def decrease_count(thread)
+        @count_mutex.synchronize { @counts[thread] -= 1 }
+      end
+
+      def delete_count(thread)
+        @count_mutex.synchronize { @counts.delete(thread) }
+      end
+    end
+  end
+end