cli-ui 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9933dc93d8bd52dd2cd910ecc126476fabe857f44d2ceb411d75ba1db5b6eec6
-  data.tar.gz: 4eba28b0b33f775b0e941109529946b1c14b5bebeb09084d6ee69ea0663635c4
+  metadata.gz: cafdb9c85ec15ecd6a745f73d8b65379e20f9961b74be9a8dd8790b2162c6580
+  data.tar.gz: 825406bad23758d820de77588e4b2fa227e0aab72ba7ddb8fe6486bd9ffbffb7
 SHA512:
-  metadata.gz: 50b7afe928e8d18e2159864cd646a0d5be3df82f456506682b061027e5bb047246e97dc22f04610cc2dc06091cb437e0b3bff713b4b3f4244f4b106df0cc6194
-  data.tar.gz: 8f4d5c54bdb5dff79d6d588f9082455913a2c6081d9b6ebb8e575839375c05ecb0560d15a3b6b305cda5cdd10e22d0a2fe37772c4a7c67ac507fc0162509f756
+  metadata.gz: b27c798109a9e573dd3a126ea65768ccc444bd065eff36da13abfb64617cd5ef31c0904a4b6d81e1d7ddf586e66c9a55dec3a38aba350e2d2e1a27d9a3185444
+  data.tar.gz: f25439683ba4ed81b09166f47d622fc5d21ae84e7a836169657b0db116bafe9480407ddf30b0e0f689da4a0c6d102e923fb473be59f3276e69977aa3ed861584

data/lib/cli/ui/color.rb

@@ -56,6 +56,7 @@ module CLI
         reset: RESET,
         bold: BOLD,
         gray: GRAY,
+        orange: ORANGE,
       }.freeze
 
       class InvalidColorName < ArgumentError

data/lib/cli/ui/formatter.rb

@@ -24,6 +24,7 @@ module CLI
         'magenta' => '35',
         'cyan' => '36',
         'gray' => '38;5;244',
+        'orange' => '38;5;214',
         'white' => '97',
         'bold' => '1',
         'italic' => '3',

data/lib/cli/ui/os.rb

@@ -46,6 +46,8 @@ module CLI
             MAC
           when /linux/
             LINUX
+          when /freebsd/
+            FREEBSD
           else
             if RUBY_PLATFORM !~ /cygwin/ && ENV['OS'] == 'Windows_NT'
               WINDOWS
@@ -58,6 +60,7 @@ module CLI
 
       MAC = OS.new
       LINUX = OS.new
+      FREEBSD = OS.new
       WINDOWS = OS.new(emoji: false, color_prompt: false, arrow_keys: false, shift_cursor: true)
     end
   end

data/lib/cli/ui/prompt/interactive_options.rb

@@ -214,10 +214,45 @@ module CLI
           @redraw = true
         end
 
+        sig { void }
+        def first_option
+          @active = @filtered_options.first&.last || -1
+          @redraw = true
+        end
+
+        sig { void }
+        def last_option
+          @active = @filtered_options.last&.last || -1
+          @redraw = true
+        end
+
+        sig { void }
+        def next_page
+          active_index = @filtered_options.index { |_, num| num == @active } || 0
+
+          previous_visible = @filtered_options[active_index + max_lines]
+          previous_visible ||= @filtered_options.last
+
+          @active = previous_visible ? previous_visible.last : -1
+          @redraw = true
+        end
+
+        sig { void }
+        def previous_page
+          active_index = @filtered_options.index { |_, num| num == @active } || 0
+
+          # do not jump into the end of the options if the subtraction result is non-positive
+          previous_visible = @filtered_options[active_index - max_lines] if active_index - max_lines >= 0
+          previous_visible ||= @filtered_options.first
+
+          @active = previous_visible ? previous_visible.last : -1
+          @redraw = true
+        end
+
         # n is 1-indexed selection
         # n == 0 if "Done" was selected in @multiple mode
-        sig { params(n: Integer).void }
-        def select_n(n)
+        sig { params(n: Integer, final: T::Boolean).void }
+        def select_n(n, final: false)
           if @multiple
             if n == 0
               @answer = []
@@ -230,6 +265,12 @@ module CLI
             end
           elsif n == 0
             # Ignore pressing "0" when not in multiple mode
+          elsif !final && should_enter_select_mode?(n)
+            # When we have more than 9 options, we need to enter select mode
+            # to avoid pre-selecting (e.g) 1 when the user wanted 10.
+            # This also applies to 2 and 20+ options, 3/30+, etc.
+            start_line_select
+            @active = n
           else
             @active = n
             @answer = n
@@ -237,6 +278,20 @@ module CLI
           @redraw = true
         end
 
+        sig { params(n: Integer).returns(T::Boolean) }
+        def should_enter_select_mode?(n)
+          # If we have less than 10 options, we don't need to enter select mode
+          # and we can just select the option directly. This just keeps the code easier
+          # by making the cases simpler to understand
+          return false if @options.length <= 9
+
+          # At this point we have 10+ options so always need to check if we should run.
+          # This can be simplified to checking if the length of options is >= to the option selected * 10:
+          # n == 1 && options.length >= 10 (1 * 10), n == 2 && options.length >= 20 (2 * 10), etc.
+          # which can be further simplified to just:
+          @options.length >= (n * 10)
+        end
+
         sig { params(char: String).void }
         def select_bool(char)
           return unless (@options - ['yes', 'no']).empty?
@@ -282,7 +337,7 @@ module CLI
           # Prevent selection of invisible options
           return unless presented_options.any? { |_, num| num == @active }
 
-          select_n(@active)
+          select_n(@active, final: true)
         end
 
         sig { void }
@@ -343,6 +398,11 @@ module CLI
             when 'B'      ; down
             when 'C'      ; # Ignore right key
             when 'D'      ; # Ignore left key
+            when '3'      ; print("\a")
+            when '5'      ; previous_page
+            when '6'      ; next_page
+            when 'H'      ; first_option
+            when 'F'      ; last_option
             else          ; raise Interrupt # unhandled escape sequence.
             end
           end

data/lib/cli/ui/sorbet_runtime_stub.rb

@@ -94,7 +94,6 @@ module T
       def log_info_handler=(value); end
       def scalar_types; end
       def scalar_types=(values); end
-      # rubocop:disable Naming/InclusiveLanguage
       def sealed_violation_whitelist; end
       def sealed_violation_whitelist=(sealed_violation_whitelist); end
       # rubocop:enable Naming/InclusiveLanguage

data/lib/cli/ui/version.rb

@@ -3,6 +3,6 @@
 
 module CLI
   module UI
-    VERSION = '2.3.0'
+    VERSION = '2.4.0'
   end
 end

data/lib/cli/ui.rb

@@ -404,10 +404,10 @@ module CLI
       end
     end
 
-    self.enable_color = $stdout.tty?
+    self.enable_color = T.must($stdout.tty? && ENV['TERM'] != 'dumb')
 
     # Shopify's CI system supports color, but not cursor control
-    self.enable_cursor = T.must($stdout.tty? && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil?)
+    self.enable_cursor = T.must($stdout.tty? && ENV['TERM'] != 'dumb' && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil?)
   end
 end
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Burke Libbey
 - Julian Nadeau
 - Lisa Ugray
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -86,7 +85,6 @@ homepage: https://github.com/shopify/cli-ui
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Terminal UI framework
 test_files: []