cli-ui 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cafdb9c85ec15ecd6a745f73d8b65379e20f9961b74be9a8dd8790b2162c6580
-  data.tar.gz: 825406bad23758d820de77588e4b2fa227e0aab72ba7ddb8fe6486bd9ffbffb7
+  metadata.gz: ff323415fd623b745426ec805bffd7f768556bf90036b16e5a59159fe288e04a
+  data.tar.gz: 1af5e6bbffc30826a8180078e1c0bc66d0de832396d5f1efb9487535693d6bee
 SHA512:
-  metadata.gz: b27c798109a9e573dd3a126ea65768ccc444bd065eff36da13abfb64617cd5ef31c0904a4b6d81e1d7ddf586e66c9a55dec3a38aba350e2d2e1a27d9a3185444
-  data.tar.gz: f25439683ba4ed81b09166f47d622fc5d21ae84e7a836169657b0db116bafe9480407ddf30b0e0f689da4a0c6d102e923fb473be59f3276e69977aa3ed861584
+  metadata.gz: db97a7a85a062661707953c1049abc0fb5289846260032edadf81beac799b2d81f22fba1289f89dc22a2e8aa99ccfbeffb1dfb14d348cc74b4c4ef85cb6d5031
+  data.tar.gz: 013f02c7461aad82f5242a051a1fbe0f95687338109e40fcf38c4525b37f4c522fa8714a37d417bff98f0718bec5ea607598183a38154265240974e638c300bc

data/lib/cli/ui/ansi.rb

@@ -6,21 +6,17 @@ require 'cli/ui'
 module CLI
   module UI
     module ANSI
-      extend T::Sig
-
       ESC = "\x1b"
 
       class << self
-        extend T::Sig
-
         # ANSI escape sequences (like \x1b[31m) have zero width.
         # when calculating the padding width, we must exclude them.
         # This also implements a basic version of utf8 character width calculation like
         # we could get for real from something like utf8proc.
         #
-        sig { params(str: String).returns(Integer) }
+        #: (String str) -> Integer
         def printing_width(str)
-          zwj = T.let(false, T::Boolean)
+          zwj = false #: bool
           strip_codes(str).codepoints.reduce(0) do |acc, cp|
             if zwj
               zwj = false
@@ -44,7 +40,7 @@ module CLI
         #
         # - +str+ - The string from which to strip codes
         #
-        sig { params(str: String).returns(String) }
+        #: (String str) -> String
         def strip_codes(str)
           str.gsub(/\x1b\[[\d;]+[A-Za-z]|\x1b\][\d;]+.*?\x1b\\|\r/, '')
         end
@@ -56,13 +52,13 @@ module CLI
         # - +args+ - Argument to pass to the ANSI control sequence
         # - +cmd+ - ANSI control sequence Command
         #
-        sig { params(args: String, cmd: String).returns(String) }
+        #: (String args, String cmd) -> String
         def control(args, cmd)
           ESC + '[' + args + cmd
         end
 
         # https://en.wikipedia.org/wiki/ANSI_escape_code#graphics
-        sig { params(params: String).returns(String) }
+        #: (String params) -> String
         def sgr(params)
           control(params, 'm')
         end
@@ -75,7 +71,7 @@ module CLI
         #
         # * +n+ - number of lines by which to move the cursor up
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def cursor_up(n = 1)
           return '' if n.zero?
 
@@ -88,7 +84,7 @@ module CLI
         #
         # * +n+ - number of lines by which to move the cursor down
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def cursor_down(n = 1)
           return '' if n.zero?
 
@@ -101,7 +97,7 @@ module CLI
         #
         # * +n+ - number of columns by which to move the cursor forward
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def cursor_forward(n = 1)
           return '' if n.zero?
 
@@ -114,7 +110,7 @@ module CLI
         #
         # * +n+ - number of columns by which to move the cursor back
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def cursor_back(n = 1)
           return '' if n.zero?
 
@@ -127,66 +123,66 @@ module CLI
         #
         # * +n+ - The column to move to
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def cursor_horizontal_absolute(n = 1)
           cmd = control(n.to_s, 'G')
           cmd += cursor_back if CLI::UI::OS.current.shift_cursor_back_on_horizontal_absolute?
           cmd
         end
 
-        sig { returns(String) }
+        #: -> String
         def enter_alternate_screen
           control('?1049', 'h')
         end
 
-        sig { returns(String) }
+        #: -> String
         def exit_alternate_screen
           control('?1049', 'l')
         end
 
-        sig { returns(Regexp) }
+        #: -> Regexp
         def match_alternate_screen
           /#{Regexp.escape(control("?1049", ""))}[hl]/
         end
 
         # Show the cursor
         #
-        sig { returns(String) }
+        #: -> String
         def show_cursor
           control('', '?25h')
         end
 
         # Hide the cursor
         #
-        sig { returns(String) }
+        #: -> String
         def hide_cursor
           control('', '?25l')
         end
 
         # Save the cursor position
         #
-        sig { returns(String) }
+        #: -> String
         def cursor_save
           control('', 's')
         end
 
         # Restore the saved cursor position
         #
-        sig { returns(String) }
+        #: -> String
         def cursor_restore
           control('', 'u')
         end
 
         # Move to the next line
         #
-        sig { returns(String) }
+        #: -> String
         def next_line
           cursor_down + cursor_horizontal_absolute
         end
 
         # Move to the previous line
         #
-        sig { returns(String) }
+        #: -> String
         def previous_line
           previous_lines(1)
         end
@@ -197,22 +193,22 @@ module CLI
         #
         # * +n+ - number of lines by which to move the cursor up
         #
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def previous_lines(n = 1)
           cursor_up(n) + cursor_horizontal_absolute
         end
 
-        sig { returns(String) }
+        #: -> String
         def clear_to_end_of_line
           control('', 'K')
         end
 
-        sig { returns(String) }
+        #: -> String
         def insert_line
           insert_lines(1)
         end
 
-        sig { params(n: Integer).returns(String) }
+        #: (?Integer n) -> String
         def insert_lines(n = 1)
           control(n.to_s, 'L')
         end

data/lib/cli/ui/color.rb

@@ -6,12 +6,10 @@ require 'cli/ui'
 module CLI
   module UI
     class Color
-      extend T::Sig
-
-      sig { returns(String) }
+      #: String
       attr_reader :sgr, :code
 
-      sig { returns(Symbol) }
+      #: Symbol
       attr_reader :name
 
       # Creates a new color mapping
@@ -23,7 +21,7 @@ module CLI
       # * +sgr+ - The color signature
       # * +name+ - The name of the color
       #
-      sig { params(sgr: String, name: Symbol).void }
+      #: (String sgr, Symbol name) -> void
       def initialize(sgr, name)
         @sgr  = sgr
         @code = CLI::UI::ANSI.sgr(sgr)
@@ -60,15 +58,13 @@ module CLI
       }.freeze
 
       class InvalidColorName < ArgumentError
-        extend T::Sig
-
-        sig { params(name: Symbol).void }
+        #: (Symbol name) -> void
         def initialize(name)
           super
           @name = name
         end
 
-        sig { returns(String) }
+        #: -> String
         def message
           keys = Color.available.map(&:inspect).join(',')
           "invalid color: #{@name.inspect} " \
@@ -77,8 +73,6 @@ module CLI
       end
 
       class << self
-        extend T::Sig
-
         # Looks up a color code by name
         #
         # ==== Raises
@@ -88,7 +82,7 @@ module CLI
         # ==== Returns
         # Returns a color code
         #
-        sig { params(name: T.any(Symbol, String)).returns(Color) }
+        #: ((Symbol | String) name) -> Color
         def lookup(name)
           MAP.fetch(name.to_sym)
         rescue KeyError
@@ -97,7 +91,7 @@ module CLI
 
         # All available colors by name
         #
-        sig { returns(T::Array[Symbol]) }
+        #: -> Array[Symbol]
         def available
           MAP.keys
         end

data/lib/cli/ui/formatter.rb

@@ -7,8 +7,6 @@ require('strscan')
 module CLI
   module UI
     class Formatter
-      extend T::Sig
-
       # Available mappings of formattings
       # To use any of them, you can use {{<key>:<string>}}
       # There are presentational (colours and formatters)
@@ -59,18 +57,16 @@ module CLI
 
       LITERAL_BRACES = Class.new
 
-      Stack = T.type_alias { T::Array[T.any(String, LITERAL_BRACES)] }
+      #: type stack = Array[String | LITERAL_BRACES]
 
       class FormatError < StandardError
-        extend T::Sig
-
-        sig { returns(String) }
+        #: String
         attr_accessor :input
 
-        sig { returns(Integer) }
+        #: Integer
         attr_accessor :index
 
-        sig { params(message: String, input: String, index: Integer).void }
+        #: (String message, String input, Integer index) -> void
         def initialize(message, input, index)
           super(message)
           @input = input
@@ -84,10 +80,10 @@ module CLI
       #
       # * +text+ - the text to format
       #
-      sig { params(text: String).void }
+      #: (String text) -> void
       def initialize(text)
         @text = text
-        @nodes = T.let([], T::Array[[String, Stack]])
+        @nodes = [] #: Array[[String, stack]]
       end
 
       # Format the text using a map.
@@ -100,11 +96,11 @@ module CLI
       #
       # * +:enable_color+ - enable color output? Default is true unless output is redirected
       #
-      sig { params(sgr_map: T::Hash[String, String], enable_color: T::Boolean).returns(String) }
+      #: (?Hash[String, String] sgr_map, ?enable_color: bool) -> String
       def format(sgr_map = SGR_MAP, enable_color: CLI::UI.enable_color?)
         @nodes.replace([])
         stack = parse_body(StringScanner.new(@text))
-        prev_fmt = T.let(nil, T.nilable(Stack))
+        prev_fmt = nil #: stack?
         content = @nodes.each_with_object(+'') do |(text, fmt), str|
           if prev_fmt != fmt && enable_color
             text = apply_format(text, fmt, sgr_map)
@@ -118,7 +114,8 @@ module CLI
         return content unless enable_color
         return content if stack == prev_fmt
 
-        unless stack.empty? && (@nodes.empty? || T.must(@nodes.last)[1].empty?)
+        last_node = @nodes.last #: as !nil
+        unless stack.empty? && (@nodes.empty? || last_node[1].empty?)
           content << apply_format('', stack, sgr_map)
         end
         content
@@ -126,7 +123,7 @@ module CLI
 
       private
 
-      sig { params(text: String, fmt: Stack, sgr_map: T::Hash[String, String]).returns(String) }
+      #: (String text, stack fmt, Hash[String, String] sgr_map) -> String
       def apply_format(text, fmt, sgr_map)
         sgr = fmt.each_with_object(+'0') do |name, str|
           next if name.is_a?(LITERAL_BRACES)
@@ -144,10 +141,10 @@ module CLI
         CLI::UI::ANSI.sgr(sgr) + text
       end
 
-      sig { params(sc: StringScanner, stack: Stack).returns(Stack) }
+      #: (StringScanner sc, stack stack) -> stack
       def parse_expr(sc, stack)
         if (match = sc.scan(SCAN_GLYPH))
-          glyph_handle = T.must(match[0])
+          glyph_handle = match[0] #: as !nil
           begin
             glyph = Glyph.lookup(glyph_handle)
             emit(glyph.char, [glyph.color.name.to_s])
@@ -160,11 +157,12 @@ module CLI
             )
           end
         elsif (match = sc.scan(SCAN_WIDGET))
-          match_data = T.must(SCAN_WIDGET.match(match)) # Regexp.last_match doesn't work here
-          widget_handle = T.must(match_data['handle'])
+          match_data = SCAN_WIDGET.match(match) #: as !nil # Regexp.last_match doesn't work here
+          widget_handle = match_data['handle'] #: as !nil
           begin
             widget = Widgets.lookup(widget_handle)
-            emit(widget.call(T.must(match_data['args'])), stack)
+            args = match_data['args'] #: as !nil
+            emit(widget.call(args), stack)
           rescue Widgets::InvalidWidgetHandle
             index = sc.pos - 2 # rewind past '}}'
             raise(FormatError.new(
@@ -188,14 +186,16 @@ module CLI
         stack
       end
 
-      sig { params(sc: StringScanner, stack: Stack).returns(Stack) }
+      #: (StringScanner sc, ?stack stack) -> stack
       def parse_body(sc, stack = [])
         match = sc.scan(SCAN_BODY)
         if match&.end_with?(BEGIN_EXPR)
-          emit(T.must(match[DISCARD_BRACES]), stack)
+          text = match[DISCARD_BRACES] #: as !nil
+          emit(text, stack)
           parse_expr(sc, stack)
         elsif match&.end_with?(END_EXPR)
-          emit(T.must(match[DISCARD_BRACES]), stack)
+          text = match[DISCARD_BRACES] #: as !nil
+          emit(text, stack)
           if stack.pop.is_a?(LITERAL_BRACES)
             emit('}}', stack)
           end
@@ -208,7 +208,7 @@ module CLI
         stack
       end
 
-      sig { params(text: String, stack: Stack).void }
+      #: (String text, stack stack) -> void
       def emit(text, stack)
         return if text.empty?
 

data/lib/cli/ui/frame/frame_stack.rb

@@ -6,18 +6,13 @@ module CLI
     module Frame
       module FrameStack
         class StackItem
-          extend T::Sig
-
-          sig { returns(CLI::UI::Color) }
+          #: CLI::UI::Color
           attr_reader :color
 
-          sig { returns(CLI::UI::Frame::FrameStyle) }
+          #: CLI::UI::Frame::FrameStyle
           attr_reader :frame_style
 
-          sig do
-            params(color_name: CLI::UI::Colorable, style_name: FrameStylable)
-              .void
-          end
+          #: (CLI::UI::colorable color_name, frame_stylable style_name) -> void
           def initialize(color_name, style_name)
             @color = CLI::UI.resolve_color(color_name)
             @frame_style = CLI::UI.resolve_style(style_name)
@@ -25,10 +20,8 @@ module CLI
         end
 
         class << self
-          extend T::Sig
-
           # Fetch all items off the frame stack
-          sig { returns(T::Array[StackItem]) }
+          #: -> Array[StackItem]
           def items
             Thread.current[:cliui_frame_stack] ||= []
           end
@@ -51,24 +44,19 @@ module CLI
           # If both an item and a color/style pair are given, raises an +ArgumentError+
           # If the given item is not a +StackItem+, raises an +ArgumentError+
           #
-          sig do
-            params(
-              item: T.nilable(StackItem),
-              color: T.nilable(CLI::UI::Color),
-              style: T.nilable(CLI::UI::Frame::FrameStyle),
-            )
-              .void
-          end
+          #: (?StackItem? item, ?color: CLI::UI::Color?, ?style: CLI::UI::Frame::FrameStyle?) -> void
           def push(item = nil, color: nil, style: nil)
             if color.nil? != style.nil? || item.nil? == color.nil?
               raise ArgumentError, 'Must give one of item or color: and style:'
             end
 
-            items.push(item || StackItem.new(T.must(color), T.must(style)))
+            c = color #: as !nil
+            s = style #: as !nil
+            items.push(item || StackItem.new(c, s))
           end
 
           # Removes and returns the last stack item off the stack
-          sig { returns(T.nilable(StackItem)) }
+          #: -> StackItem?
           def pop
             items.pop
           end

data/lib/cli/ui/frame/frame_style/box.rb

@@ -15,14 +15,14 @@ module CLI
           BOTTOM_LEFT = '┗'
 
           class << self
-            extend T::Sig
-
-            sig { override.returns(Symbol) }
+            # @override
+            #: -> Symbol
             def style_name
               :box
             end
 
-            sig { override.returns(String) }
+            # @override
+            #: -> String
             def prefix
               VERTICAL
             end
@@ -41,7 +41,8 @@ module CLI
             #
             #   ┏━━ Open ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
             #
-            sig { override.params(text: String, color: CLI::UI::Color).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color) -> String
             def start(text, color:)
               edge(text, color: color, first: TOP_LEFT)
             end
@@ -60,7 +61,8 @@ module CLI
             #
             #   ┣━━ Divider ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
             #
-            sig { override.params(text: String, color: CLI::UI::Color).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color) -> String
             def divider(text, color:)
               edge(text, color: color, first: DIVIDER)
             end
@@ -80,16 +82,15 @@ module CLI
             #
             #   ┗━━ Close ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
             #
-            sig { override.params(text: String, color: CLI::UI::Color, right_text: T.nilable(String)).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color, ?right_text: String?) -> String
             def close(text, color:, right_text: nil)
               edge(text, color: color, right_text: right_text, first: BOTTOM_LEFT)
             end
 
             private
 
-            sig do
-              params(text: String, color: CLI::UI::Color, first: String, right_text: T.nilable(String)).returns(String)
-            end
+            #: (String text, color: CLI::UI::Color, first: String, ?right_text: String?) -> String
             def edge(text, color:, first:, right_text: nil)
               color = CLI::UI.resolve_color(color)
 

data/lib/cli/ui/frame/frame_style/bracket.rb

@@ -15,14 +15,14 @@ module CLI
           BOTTOM_LEFT = '┗'
 
           class << self
-            extend T::Sig
-
-            sig { override.returns(Symbol) }
+            # @override
+            #: -> Symbol
             def style_name
               :bracket
             end
 
-            sig { override.returns(String) }
+            # @override
+            #: -> String
             def prefix
               VERTICAL
             end
@@ -41,7 +41,8 @@ module CLI
             #
             #   ┏━━ Open
             #
-            sig { override.params(text: String, color: CLI::UI::Color).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color) -> String
             def start(text, color:)
               edge(text, color: color, first: TOP_LEFT)
             end
@@ -60,7 +61,8 @@ module CLI
             #
             #   ┣━━ Divider
             #
-            sig { override.params(text: String, color: CLI::UI::Color).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color) -> String
             def divider(text, color:)
               edge(text, color: color, first: DIVIDER)
             end
@@ -80,16 +82,15 @@ module CLI
             #
             #   ┗━━ Close
             #
-            sig { override.params(text: String, color: CLI::UI::Color, right_text: T.nilable(String)).returns(String) }
+            # @override
+            #: (String text, color: CLI::UI::Color, ?right_text: String?) -> String
             def close(text, color:, right_text: nil)
               edge(text, color: color, right_text: right_text, first: BOTTOM_LEFT)
             end
 
             private
 
-            sig do
-              params(text: String, color: CLI::UI::Color, first: String, right_text: T.nilable(String)).returns(String)
-            end
+            #: (String text, color: CLI::UI::Color, first: String, ?right_text: String?) -> String
             def edge(text, color:, first:, right_text: nil)
               color = CLI::UI.resolve_color(color)