cli-ui 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8dec5198cdbbb3a6060fc448a9a03b5bc6eca461b94a62ead0f128664bb0ee2
-  data.tar.gz: bed02e7e27771141c08859c11d7e01f690438bb46d4022f5225d8cb42e39efe4
+  metadata.gz: eb23f8ab0044a484b7f6f8dcb57240d5b5ba9a3db6caedb6090186c3d7a55143
+  data.tar.gz: 9c3e0d024f05ed428a0afa190fbc440008e58d8f58cf244c452259722883dd50
 SHA512:
-  metadata.gz: 6944f7c1b8492e69bd078b2ca0d9901d26694e4542976cb07729efff2cb59438cbc2ec61692b75ccf178ffcec896a297264be5734520695f9bc11779f2698ead
-  data.tar.gz: c9795b1749d3db7cb57bccca815495ed9b2e8ee02092fe95b46bf451f2993e65c33f8b48e9f6520b2984b7278db64cb9e92bb1fe58a761691a9b313dab6ef464
+  metadata.gz: 36dccad36f8cc8eeff6bc9ad2e7deb2e37427ccf5887fb543d27485ff5cfc8e441355edc9cb92f954eef9e1a45fb5d2d78e8b84b510dec12809e3e1df2071cea
+  data.tar.gz: 31c99ff115d4061d4f9441063177784f9f6656cafee9bd6b85fc6d48e30ab855e4cf83138d8f305fb86542edd4fbe2226db26cf448e70b3b8677bf18ce4a388c

data/README.md

@@ -175,6 +175,12 @@ end
 
 ---
 
+## Sorbet
+
+We make use of [Sorbet](https://sorbet.org/) in cli-ui. We provide stubs for Sorbet so that you can use this gem even
+if you aren't using Sorbet. We activate these stubs if `T` is undefined when the gem is loaded. For this reason, if you
+would like to use this gem and your project _does_ use Sorbet, ensure you load Sorbet _before_ loading cli-ui.
+
 ## Example Usage
 
 The following code makes use of nested-framing, multi-threaded spinners, formatted text, and more.

data/lib/cli/ui/spinner/spin_group.rb

@@ -11,7 +11,7 @@ module CLI
         #
         # ==== Options
         #
-        # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+        # * +:auto_debrief+ - Automatically debrief exceptions or through success_debrief? Default to true
         #
         # ==== Example Usage
         #
@@ -273,6 +273,16 @@ module CLI
           @failure_debrief = block
         end
 
+        # Provide a debriefing for successful tasks
+        sig do
+          params(
+            block: T.proc.params(title: String, out: String, err: String).void,
+          ).void
+        end
+        def success_debrief(&block)
+          @success_debrief = block
+        end
+
         sig { returns(T::Boolean) }
         def all_succeeded?
           @m.synchronize do
@@ -286,13 +296,15 @@ module CLI
         def debrief
           @m.synchronize do
             @tasks.each do |task|
-              next if task.success
-
               title = task.title
-              e = task.exception
               out = task.stdout
               err = task.stderr
 
+              if task.success
+                next @success_debrief&.call(title, out, err)
+              end
+
+              e = task.exception
               next @failure_debrief.call(title, e, out, err) if @failure_debrief
 
               CLI::UI::Frame.open('Task Failed: ' + title, color: :red, timing: Time.new - @start) do

data/lib/cli/ui/spinner.rb

@@ -61,7 +61,7 @@ module CLI
         #
         # ==== Options
         #
-        # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+        # * +:auto_debrief+ - Automatically debrief exceptions or through success_debrief? Default to true
         #
         # ==== Block
         #

data/lib/cli/ui/version.rb

@@ -2,6 +2,6 @@
 
 module CLI
   module UI
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Burke Libbey
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest