@shopify/cli-kit 3.69.3 → 3.70.0

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/frame.rb

@@ -1,269 +0,0 @@
-# coding: utf-8
-require 'cli/ui'
-require 'cli/ui/frame/frame_stack'
-require 'cli/ui/frame/frame_style'
-
-module CLI
-  module UI
-    module Frame
-      class UnnestedFrameException < StandardError; end
-      class << self
-        DEFAULT_FRAME_COLOR = CLI::UI.resolve_color(:cyan)
-
-        def frame_style
-          @frame_style ||= FrameStyle::Box
-        end
-
-        # Set the default frame style.
-        #
-        # Raises ArgumentError if +frame_style+ is not valid
-        #
-        # ==== Attributes
-        #
-        # * +symbol+ or +FrameStyle+ - the default frame style to use for frames
-        #
-        def frame_style=(frame_style)
-          @frame_style = CLI::UI.resolve_style(frame_style)
-        end
-
-        # Opens a new frame. Can be nested
-        # Can be invoked in two ways: block and blockless
-        # * In block form, the frame is closed automatically when the block returns
-        # * In blockless form, caller MUST call +Frame.close+ when the frame is logically done
-        # * Blockless form is strongly discouraged in cases where block form can be made to work
-        #
-        # https://user-images.githubusercontent.com/3074765/33799861-cb5dcb5c-dd01-11e7-977e-6fad38cee08c.png
-        #
-        # The return value of the block determines if the block is a "success" or a "failure"
-        #
-        # ==== Attributes
-        #
-        # * +text+ - (required) the text/title to output in the frame
-        #
-        # ==== Options
-        #
-        # * +:color+ - The color of the frame. Defaults to +DEFAULT_FRAME_COLOR+
-        # * +:failure_text+ - If the block failed, what do we output? Defaults to nil
-        # * +:success_text+ - If the block succeeds, what do we output? Defaults to nil
-        # * +:timing+ - How long did the frame content take? Invalid for blockless. Defaults to true for the block form
-        # * +frame_style+ - The frame style to use for this frame
-        #
-        # ==== Example
-        #
-        # ===== Block Form (Assumes +CLI::UI::StdoutRouter.enable+ has been called)
-        #
-        #   CLI::UI::Frame.open('Open') { puts 'hi' }
-        #
-        # Default Output:
-        #   ┏━━ Open ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #   ┃ hi
-        #   ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ (0.0s) ━━
-        #
-        # ===== Blockless Form
-        #
-        #   CLI::UI::Frame.open('Open')
-        #
-        # Default Output:
-        #   ┏━━ Open ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #
-        #
-        def open(
-          text,
-          color: DEFAULT_FRAME_COLOR,
-          failure_text: nil,
-          success_text: nil,
-          timing:       nil,
-          frame_style:  self.frame_style
-        )
-          frame_style = CLI::UI.resolve_style(frame_style)
-          color = CLI::UI.resolve_color(color)
-
-          unless block_given?
-            if failure_text
-              raise ArgumentError, "failure_text is not compatible with blockless invocation"
-            elsif success_text
-              raise ArgumentError, "success_text is not compatible with blockless invocation"
-            elsif timing
-              raise ArgumentError, "timing is not compatible with blockless invocation"
-            end
-          end
-
-          t_start = Time.now
-          CLI::UI.raw do
-            print(prefix.chop)
-            puts frame_style.open(text, color: color)
-          end
-          FrameStack.push(color: color, style: frame_style)
-
-          return unless block_given?
-
-          closed = false
-          begin
-            success = false
-            success = yield
-          rescue
-            closed = true
-            t_diff = elasped(t_start, timing)
-            close(failure_text, color: :red, elapsed: t_diff)
-            raise
-          else
-            success
-          ensure
-            unless closed
-              t_diff = elasped(t_start, timing)
-              if success != false
-                close(success_text, color: color, elapsed: t_diff)
-              else
-                close(failure_text, color: :red, elapsed: t_diff)
-              end
-            end
-          end
-        end
-
-        # Adds a divider in a frame
-        # Used to separate information within a single frame
-        #
-        # ==== Attributes
-        #
-        # * +text+ - (required) the text/title to output in the frame
-        #
-        # ==== Options
-        #
-        # * +:color+ - The color of the frame. Defaults to +DEFAULT_FRAME_COLOR+
-        # * +frame_style+ - The frame style to use for this frame
-        #
-        # ==== Example
-        #
-        #   CLI::UI::Frame.open('Open') { CLI::UI::Frame.divider('Divider') }
-        #
-        # Default Output:
-        #   ┏━━ Open ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #   ┣━━ Divider ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #   ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #
-        # ==== Raises
-        #
-        # MUST be inside an open frame or it raises a +UnnestedFrameException+
-        #
-        def divider(text, color: nil, frame_style: nil)
-          fs_item = FrameStack.pop
-          raise UnnestedFrameException, "No frame nesting to unnest" unless fs_item
-
-          color = CLI::UI.resolve_color(color) || fs_item.color
-          frame_style = CLI::UI.resolve_style(frame_style) || fs_item.frame_style
-
-          CLI::UI.raw do
-            print(prefix.chop)
-            puts frame_style.divider(text, color: color)
-          end
-
-          FrameStack.push(fs_item)
-        end
-
-        # Closes a frame
-        # Automatically called for a block-form +open+
-        #
-        # ==== Attributes
-        #
-        # * +text+ - (required) the text/title to output in the frame
-        #
-        # ==== Options
-        #
-        # * +:color+ - The color of the frame. Defaults to nil
-        # * +:elapsed+ - How long did the frame take? Defaults to nil
-        # * +frame_style+ - The frame style to use for this frame.  Defaults to nil
-        #
-        # ==== Example
-        #
-        #   CLI::UI::Frame.close('Close')
-        #
-        # Default Output:
-        #   ┗━━ Close ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-        #
-        # ==== Raises
-        #
-        # MUST be inside an open frame or it raises a +UnnestedFrameException+
-        #
-        def close(text, color: nil, elapsed: nil, frame_style: nil)
-          fs_item = FrameStack.pop
-          raise UnnestedFrameException, "No frame nesting to unnest" unless fs_item
-
-          color = CLI::UI.resolve_color(color) || fs_item.color
-          frame_style = CLI::UI.resolve_style(frame_style) || fs_item.frame_style
-
-          kwargs = {}
-          if elapsed
-            kwargs[:right_text] = "(#{elapsed.round(2)}s)"
-          end
-
-          CLI::UI.raw do
-            print(prefix.chop)
-            puts frame_style.close(text, color: color, **kwargs)
-          end
-        end
-
-        # Determines the prefix of a frame entry taking multi-nested frames into account
-        #
-        # ==== Options
-        #
-        # * +:color+ - The color of the prefix. Defaults to +Thread.current[:cliui_frame_color_override]+
-        #
-        def prefix(color: Thread.current[:cliui_frame_color_override])
-          +''.tap do |output|
-            items = FrameStack.items
-
-            items[0..-2].each do |item|
-              output << item.color.code << item.frame_style.prefix
-            end
-
-            if (item = items.last)
-              final_color = color || item.color
-              output << CLI::UI.resolve_color(final_color).code \
-                << item.frame_style.prefix \
-                << ' ' \
-                << CLI::UI::Color::RESET.code
-            end
-          end
-        end
-
-        # The width of a prefix given the number of Frames in the stack
-        def prefix_width
-          w = FrameStack.items.reduce(0) do |width, item|
-            width + item.frame_style.prefix_width
-          end
-
-          w.zero? ? w : w + 1
-        end
-
-        # Override a color for a given thread.
-        #
-        # ==== Attributes
-        #
-        # * +color+ - The color to override to
-        #
-        def with_frame_color_override(color)
-          prev = Thread.current[:cliui_frame_color_override]
-          Thread.current[:cliui_frame_color_override] = color
-          yield
-        ensure
-          Thread.current[:cliui_frame_color_override] = prev
-        end
-
-        private
-
-        # If timing is:
-        #   Numeric: return it
-        #   false: return nil
-        #   true or nil: defaults to Time.new
-        #   Time: return the difference with start
-        def elasped(start, timing)
-          return timing if timing.is_a?(Numeric)
-          return if timing.is_a?(FalseClass)
-
-          timing = Time.new if timing.is_a?(TrueClass) || timing.nil?
-          timing - start
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/glyph.rb

@@ -1,84 +0,0 @@
-require 'cli/ui'
-
-module CLI
-  module UI
-    class Glyph
-      class InvalidGlyphHandle < ArgumentError
-        def initialize(handle)
-          super
-          @handle = handle
-        end
-
-        def message
-          keys = Glyph.available.join(',')
-          "invalid glyph handle: #{@handle} " \
-            "-- must be one of CLI::UI::Glyph.available (#{keys})"
-        end
-      end
-
-      attr_reader :handle, :codepoint, :color, :to_s, :fmt
-
-      # Creates a new glyph
-      #
-      # ==== Attributes
-      #
-      # * +handle+ - The handle in the +MAP+ constant
-      # * +codepoint+ - The codepoint used to create the glyph (e.g. +0x2717+ for a ballot X)
-      # * +plain+ - A fallback plain string to be used in case glyphs are disabled
-      # * +color+ - What color to output the glyph. Check +CLI::UI::Color+ for options.
-      #
-      def initialize(handle, codepoint, plain, color)
-        @handle    = handle
-        @codepoint = codepoint
-        @color     = color
-        @plain     = plain
-        @char      = Array(codepoint).pack('U*')
-        @to_s      = color.code + char + Color::RESET.code
-        @fmt       = "{{#{color.name}:#{char}}}"
-
-        MAP[handle] = self
-      end
-
-      # Fetches the actual character(s) to be displayed for a glyph, based on the current OS support
-      #
-      # ==== Returns
-      # Returns the glyph string
-      def char
-        CLI::UI::OS.current.supports_emoji? ? @char : @plain
-      end
-
-      # Mapping of glyphs to terminal output
-      MAP = {}
-      STAR      = new('*', 0x2b51,           '*', Color::YELLOW) # YELLOW SMALL STAR (⭑)
-      INFO      = new('i', 0x1d4be,          'i', Color::BLUE)   # BLUE MATHEMATICAL SCRIPT SMALL i (𝒾)
-      QUESTION  = new('?', 0x003f,           '?', Color::BLUE)   # BLUE QUESTION MARK (?)
-      CHECK     = new('v', 0x2713,           '√', Color::GREEN)  # GREEN CHECK MARK (✓)
-      X         = new('x', 0x2717,           'X', Color::RED)    # RED BALLOT X (✗)
-      BUG       = new('b', 0x1f41b,          '!', Color::WHITE)  # Bug emoji (🐛)
-      CHEVRON   = new('>', 0xbb,             '»', Color::GRAY)   # RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK (»)
-      HOURGLASS = new('H', [0x231b, 0xfe0e], 'H', Color::BLUE)   # HOURGLASS + VARIATION SELECTOR 15 (⌛︎)
-      WARNING   = new('!', [0x26a0, 0xfe0f], '!', Color::YELLOW) # WARNING SIGN + VARIATION SELECTOR 16 (⚠️ )
-
-      # Looks up a glyph by name
-      #
-      # ==== Raises
-      # Raises a InvalidGlyphHandle if the glyph is not available
-      # You likely need to create it with +.new+ or you made a typo
-      #
-      # ==== Returns
-      # Returns a terminal output-capable string
-      #
-      def self.lookup(name)
-        MAP.fetch(name.to_s)
-      rescue KeyError
-        raise InvalidGlyphHandle, name
-      end
-
-      # All available glyphs by name
-      #
-      def self.available
-        MAP.keys
-      end
-    end
-  end
-end

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/os.rb

@@ -1,73 +0,0 @@
-module CLI
-  module UI
-    module OS
-      # Determines which OS is currently running the UI, to make it easier to
-      # adapt its behaviour to the features of the OS.
-      def self.current
-        @current_os ||= case RbConfig::CONFIG['host_os']
-        when /darwin/
-          Mac
-        when /linux/
-          Linux
-        else
-          if RUBY_PLATFORM !~ /cygwin/ && ENV['OS'] == 'Windows_NT'
-            Windows
-          else
-            raise "Could not determine OS from host_os #{RbConfig::CONFIG["host_os"]}"
-          end
-        end
-      end
-
-      class Mac
-        class << self
-          def supports_emoji?
-            true
-          end
-
-          def supports_color_prompt?
-            true
-          end
-
-          def supports_arrow_keys?
-            true
-          end
-
-          def shift_cursor_on_line_reset?
-            false
-          end
-
-          def path_separator
-            ":"
-          end
-        end
-      end
-
-      class Linux < Mac
-      end
-
-      class Windows
-        class << self
-          def supports_emoji?
-            false
-          end
-
-          def supports_color_prompt?
-            false
-          end
-
-          def supports_arrow_keys?
-            false
-          end
-
-          def shift_cursor_on_line_reset?
-            true
-          end
-
-          def path_separator
-            ";"
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/printer.rb

@@ -1,59 +0,0 @@
-require 'cli/ui'
-
-module CLI
-  module UI
-    class Printer
-      # Print a message to a stream with common utilities.
-      # Allows overriding the color, encoding, and target stream.
-      # By default, it formats the string using CLI:UI and rescues common stream errors.
-      #
-      # ==== Attributes
-      #
-      # * +msg+ - (required) the string to output. Can be frozen.
-      #
-      # ==== Options
-      #
-      # * +:frame_color+ - Override the frame color. Defaults to nil.
-      # * +:to+ - Target stream, like $stdout or $stderr. Can be anything with a puts method. Defaults to $stdout.
-      # * +:encoding+ - Force the output to be in a certain encoding. Defaults to UTF-8.
-      # * +:format+ - Whether to format the string using CLI::UI.fmt. Defaults to true.
-      # * +:graceful+ - Whether to gracefully ignore common I/O errors. Defaults to true.
-      # * +:wrap+ - Whether to wrap text at word boundaries to terminal width. Defaults to true.
-      #
-      # ==== Returns
-      # Returns whether the message was successfully printed,
-      # which can be useful if +:graceful+ is set to true.
-      #
-      # ==== Example
-      #
-      #   CLI::UI::Printer.puts('{{x}} Ouch', to: $stderr)
-      #
-      def self.puts(
-        msg,
-        frame_color:
-        nil,
-        to:
-        $stdout,
-        encoding: Encoding::UTF_8,
-        format: true,
-        graceful: true,
-        wrap: true
-      )
-        msg = (+msg).force_encoding(encoding) if encoding
-        msg = CLI::UI.fmt(msg) if format
-        msg = CLI::UI.wrap(msg) if wrap
-
-        if frame_color
-          CLI::UI::Frame.with_frame_color_override(frame_color) { to.puts(msg) }
-        else
-          to.puts(msg)
-        end
-
-        true
-      rescue Errno::EIO, Errno::EPIPE, IOError => e
-        raise(e) unless graceful
-        false
-      end
-    end
-  end
-end

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/progress.rb

@@ -1,90 +0,0 @@
-require 'cli/ui'
-
-module CLI
-  module UI
-    class Progress
-      # A Cyan filled block
-      FILLED_BAR = "\e[46m"
-      # A bright white block
-      UNFILLED_BAR = "\e[1;47m"
-
-      # Add a progress bar to the terminal output
-      #
-      # https://user-images.githubusercontent.com/3074765/33799794-cc4c940e-dd00-11e7-9bdc-90f77ec9167c.gif
-      #
-      # ==== Example Usage:
-      #
-      # Set the percent to X
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick(set_percent: percent)
-      #   end
-      #
-      # Increase the percent by 1 percent
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick
-      #   end
-      #
-      # Increase the percent by X
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick(percent: 0.05)
-      #   end
-      def self.progress(width: Terminal.width)
-        bar = Progress.new(width: width)
-        print(CLI::UI::ANSI.hide_cursor)
-        yield(bar)
-      ensure
-        puts bar.to_s
-        CLI::UI.raw do
-          print(ANSI.show_cursor)
-        end
-      end
-
-      # Initialize a progress bar. Typically used in a +Progress.progress+ block
-      #
-      # ==== Options
-      # One of the follow can be used, but not both together
-      #
-      # * +:width+ - The width of the terminal
-      #
-      def initialize(width: Terminal.width)
-        @percent_done = 0
-        @max_width = width
-      end
-
-      # Set the progress of the bar. Typically used in a +Progress.progress+ block
-      #
-      # ==== Options
-      # One of the follow can be used, but not both together
-      #
-      # * +:percent+ - Increment progress by a specific percent amount
-      # * +:set_percent+ - Set progress to a specific percent
-      #
-      # *Note:* The +:percent+ and +:set_percent must be between 0.00 and 1.0
-      #
-      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(CLI::UI::ANSI.previous_line + "\n")
-      end
-
-      # Format the progress bar to be printed to terminal
-      #
-      def to_s
-        suffix = " #{(@percent_done * 100).floor}%".ljust(5)
-        workable_width = @max_width - Frame.prefix_width - suffix.size
-        filled = [(@percent_done * workable_width.to_f).ceil, 0].max
-        unfilled = [workable_width - filled, 0].max
-
-        CLI::UI.resolve_text([
-          FILLED_BAR + ' ' * filled,
-          UNFILLED_BAR + ' ' * unfilled,
-          CLI::UI::Color::RESET.code + suffix,
-        ].join)
-      end
-    end
-  end
-end

package/assets/cli-ruby/vendor/deps/cli-ui/lib/cli/ui/progress_plain.rb

@@ -1,50 +0,0 @@
-require 'cli/ui'
-
-module CLI
-  module UI
-    class ProgressPlain
-      # Add a plain progress bar to the terminal output
-      #
-      # ==== Example Usage:
-      #
-      # Set the percent to X
-      #   CLI::UI::ProgressPlain.progress do |bar|
-      #     bar.tick(set_percent: percent)
-      #   end
-      def self.progress(prefix: "")
-        bar = ProgressPlain.new(prefix: prefix)
-        yield(bar)
-      end
-
-      # Initialize a plain progress bar. Typically used in a +ProgressPlain.progress+ block
-      #
-      def initialize(prefix: "")
-        @percent_done = 0
-        @prefix = prefix
-      end
-
-      # Set the progress of the bar. Typically used in a +ProgressPlain.progress+ block
-      #
-      # ==== Options
-      # * +:set_percent+ - Set progress to a specific percent
-      #
-      # *Note:* The +:set_percent must be between 0.00 and 1.0
-      #
-      def tick(set_percent: nil)
-        return if @percent_done >= 1.0 # Don't print if we're already done
-        # Print only if we've moved up a whole 10% (e.g. 10%, 20%, 30%)q
-        return if (@percent_done * 100).floor != 0 && ((@percent_done * 100).floor / 10 == (set_percent * 100).floor / 10)
-        @percent_done = set_percent
-        @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
-
-        print("#{to_s}\n")
-      end
-
-      # Format the progress bar to be printed to terminal
-      #
-      def to_s
-        "#{@prefix} #{(@percent_done * 100).floor.to_s.rjust(5)}%"
-      end
-    end
-  end
-end